├── .gitignore ├── README.md ├── pom.xml ├── src ├── main │ └── java │ │ └── org │ │ └── elasticsearch │ │ └── enforcer │ │ └── rules │ │ └── BannedAttachedArtifacts.java └── test │ └── java │ └── org │ └── elasticsearch │ └── enforcer │ └── rules │ └── BannedAttachedArtifactsTests.java └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | *.iml 3 | target/ 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Attached Artifact Enforcer 2 | This project provides a rule for the [maven enforcer plugin](http://maven.apache.org/components/enforcer/) that allows 3 | for matching on attached artifacts and failing the build if banned artifacts are found. 4 | 5 | ## Usage 6 | One example is if you do not wish to publish the test jar, then this plugin can check for the test jar being attached 7 | based on filename pattern matching. 8 | 9 | In your pom.xml add the following: 10 | 11 | 12 | 13 | 14 | org.apache.maven.plugins 15 | maven-enforcer-plugin 16 | 17 | 18 | org.elasticsearch.maven 19 | attached-artifact-enforcer 20 | 1.0.0 21 | 22 | 23 | 24 | 25 | check-attached-artifacts 26 | verify 27 | 28 | enforce 29 | 30 | 31 | 32 | 33 | 34 | .*-tests\.jar 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | The above snippet adds the custom rules as a dependency of the enforcer plugin and then adds an execution that bans files 46 | that end in `-tests.jar` from being attached to the project. 47 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | 8 | org.sonatype.oss 9 | oss-parent 10 | 7 11 | 12 | 13 | org.elasticsearch.maven 14 | attached-artifact-enforcer 15 | 1.1.0-SNAPSHOT 16 | 17 | Attached Artifact Enforcer 18 | Enforcer rule for artifacts attached in a Maven project 19 | 20 | 21 | 1.4 22 | 2.2.1 23 | 1.7 24 | 1.7 25 | 26 | 27 | 28 | 29 | org.apache.maven.enforcer 30 | enforcer-api 31 | ${api.version} 32 | 33 | 34 | org.apache.maven 35 | maven-project 36 | ${maven.version} 37 | 38 | 39 | org.apache.maven 40 | maven-core 41 | ${maven.version} 42 | 43 | 44 | org.apache.maven 45 | maven-artifact 46 | ${maven.version} 47 | 48 | 49 | org.apache.maven 50 | maven-plugin-api 51 | ${maven.version} 52 | 53 | 54 | org.codehaus.plexus 55 | plexus-container-default 56 | 1.0-alpha-9 57 | 58 | 59 | 60 | junit 61 | junit 62 | 4.11 63 | test 64 | 65 | 66 | org.mockito 67 | mockito-all 68 | 1.10.19 69 | test 70 | 71 | 72 | 73 | 74 | 75 | 76 | org.apache.maven.plugins 77 | maven-surefire-plugin 78 | 2.18.1 79 | 80 | 81 | **/*Tests.java 82 | 83 | 84 | 85 | 86 | 87 | 88 | -------------------------------------------------------------------------------- /src/main/java/org/elasticsearch/enforcer/rules/BannedAttachedArtifacts.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to Elasticsearch under one or more contributor 3 | * license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright 5 | * ownership. Elasticsearch licenses this file to you under 6 | * the Apache License, Version 2.0 (the "License"); you may 7 | * not use this file except in compliance with the License. 8 | * You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | package org.elasticsearch.enforcer.rules; 21 | 22 | import org.apache.maven.artifact.Artifact; 23 | import org.apache.maven.enforcer.rule.api.EnforcerRule; 24 | import org.apache.maven.enforcer.rule.api.EnforcerRuleException; 25 | import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper; 26 | import org.apache.maven.plugin.logging.Log; 27 | import org.apache.maven.project.MavenProject; 28 | import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException; 29 | 30 | import java.util.ArrayList; 31 | import java.util.Collections; 32 | import java.util.List; 33 | import java.util.regex.Pattern; 34 | 35 | public class BannedAttachedArtifacts implements EnforcerRule { 36 | 37 | private List excludes = Collections.emptyList(); 38 | 39 | public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException { 40 | Log log = helper.getLog(); 41 | 42 | List excludedPatterns = new ArrayList(excludes.size()); 43 | for (String exclude : excludes) { 44 | excludedPatterns.add(Pattern.compile(exclude)); 45 | } 46 | 47 | try { 48 | MavenProject project = (MavenProject) helper.evaluate("${project}"); 49 | List artifactList = project.getAttachedArtifacts(); 50 | for (Artifact artifact : artifactList) { 51 | String artifactFileName = artifact.getFile().getName(); 52 | log.debug("evaluating artifact [" + artifactFileName + "]"); 53 | for (Pattern pattern : excludedPatterns) { 54 | if (pattern.matcher(artifactFileName).matches()) { 55 | throw new EnforcerRuleException("found banned attached artifact: artifact [" + artifactFileName + "] matched exclude pattern [" + pattern.toString() + "]"); 56 | } 57 | } 58 | } 59 | 60 | } catch (ExpressionEvaluationException e) { 61 | throw new EnforcerRuleException("Unable to lookup expression", e); 62 | } 63 | 64 | } 65 | 66 | public boolean isCacheable() { 67 | return false; 68 | } 69 | 70 | public boolean isResultValid(EnforcerRule enforcerRule) { 71 | return false; 72 | } 73 | 74 | public String getCacheId() { 75 | return null; 76 | } 77 | 78 | public List getExcludes() { 79 | return excludes; 80 | } 81 | 82 | public void setExcludes(List excludes) { 83 | this.excludes = excludes; 84 | } 85 | } 86 | -------------------------------------------------------------------------------- /src/test/java/org/elasticsearch/enforcer/rules/BannedAttachedArtifactsTests.java: -------------------------------------------------------------------------------- 1 | package org.elasticsearch.enforcer.rules;/* 2 | * Licensed to Elasticsearch under one or more contributor 3 | * license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright 5 | * ownership. Elasticsearch licenses this file to you under 6 | * the Apache License, Version 2.0 (the "License"); you may 7 | * not use this file except in compliance with the License. 8 | * You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | import org.apache.maven.artifact.Artifact; 21 | import org.apache.maven.enforcer.rule.api.EnforcerRuleException; 22 | import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper; 23 | import org.apache.maven.plugin.logging.Log; 24 | import org.apache.maven.project.MavenProject; 25 | import org.junit.Before; 26 | import org.junit.Test; 27 | 28 | import java.nio.file.Files; 29 | import java.util.ArrayList; 30 | import java.util.Collections; 31 | import java.util.List; 32 | 33 | import static org.junit.Assert.*; 34 | import static org.hamcrest.CoreMatchers.containsString; 35 | import static org.mockito.Mockito.mock; 36 | import static org.mockito.Mockito.when; 37 | 38 | 39 | public class BannedAttachedArtifactsTests { 40 | 41 | BannedAttachedArtifacts enforcer; 42 | EnforcerRuleHelper helper; 43 | 44 | @Before 45 | public void setup() throws Exception { 46 | enforcer = new BannedAttachedArtifacts(); 47 | helper = mock(EnforcerRuleHelper.class); 48 | when(helper.getLog()).thenReturn(mock(Log.class)); 49 | MavenProject project = mock(MavenProject.class); 50 | when(helper.evaluate("${project}")).thenReturn(project); 51 | 52 | // add some artifacts 53 | List artifacts = new ArrayList<>(); 54 | Artifact zip = mock(Artifact.class); 55 | when(zip.getFile()).thenReturn(Files.createTempFile("banned-artifacts", ".zip").toFile()); 56 | artifacts.add(zip); 57 | Artifact foo = mock(Artifact.class); 58 | when(foo.getFile()).thenReturn(Files.createTempFile("good", ".foo").toFile()); 59 | artifacts.add(foo); 60 | when(project.getAttachedArtifacts()).thenReturn(artifacts); 61 | } 62 | 63 | @Test 64 | public void testNoRules() throws Exception { 65 | enforcer.execute(helper); 66 | } 67 | 68 | @Test 69 | public void testNonMatchingRule() throws Exception { 70 | enforcer.setExcludes(Collections.singletonList(".*jar")); 71 | enforcer.execute(helper); 72 | } 73 | 74 | @Test 75 | public void testMatchingRule() { 76 | enforcer.setExcludes(Collections.singletonList(".*zip")); 77 | try { 78 | enforcer.execute(helper); 79 | fail("an exception should have been thrown"); 80 | } catch (EnforcerRuleException e) { 81 | assertThat(e.getMessage(), containsString("found banned attached artifact")); 82 | } 83 | } 84 | 85 | @Test 86 | public void testMatchingAndNonMatchingRule() { 87 | List rules = new ArrayList<>(); 88 | rules.add(".*jar"); 89 | rules.add(".*zip"); 90 | Collections.shuffle(rules); 91 | 92 | enforcer.setExcludes(rules); 93 | try { 94 | enforcer.execute(helper); 95 | fail("an exception should have been thrown"); 96 | } catch (EnforcerRuleException e) { 97 | assertThat(e.getMessage(), containsString("found banned attached artifact")); 98 | } 99 | } 100 | } 101 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------