New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[MENFORCER-500] New rule to enforce that Maven coordinates match given #309
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
110 changes: 110 additions & 0 deletions
110
enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireMatchingCoordinates.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.maven.enforcer.rules; | ||
|
|
||
| import javax.inject.Inject; | ||
| import javax.inject.Named; | ||
|
|
||
| import java.util.Objects; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import org.apache.maven.enforcer.rule.api.EnforcerRuleException; | ||
| import org.apache.maven.project.MavenProject; | ||
|
|
||
| /** | ||
| * This rule checks that the Maven coordinates (i.e. the project's {@code groupId} and {@code artifactId}) each match a given pattern. | ||
| * @since 3.5.0 | ||
| */ | ||
| @Named("requireMatchingCoordinates") | ||
| public final class RequireMatchingCoordinates extends AbstractStandardEnforcerRule { | ||
|
|
||
| private Pattern groupIdPattern; | ||
|
|
||
| private Pattern artifactIdPattern; | ||
|
|
||
| private boolean moduleNameMustMatchArtifactId; | ||
|
|
||
| private final MavenProject project; | ||
|
|
||
| @Inject | ||
| public RequireMatchingCoordinates(MavenProject project) { | ||
| this.project = Objects.requireNonNull(project); | ||
| } | ||
|
|
||
| @Override | ||
| public void execute() throws EnforcerRuleException { | ||
| StringBuilder msgBuilder = new StringBuilder(); | ||
| if (groupIdPattern != null | ||
| && !groupIdPattern.matcher(project.getGroupId()).matches()) { | ||
| msgBuilder | ||
| .append("Group ID must match pattern \"") | ||
| .append(groupIdPattern) | ||
| .append("\" but is \"") | ||
| .append(project.getGroupId()) | ||
| .append("\""); | ||
| } | ||
| if (artifactIdPattern != null | ||
| && !artifactIdPattern.matcher(project.getArtifactId()).matches()) { | ||
| if (msgBuilder.length() > 0) { | ||
| msgBuilder.append(System.lineSeparator()); | ||
| } | ||
| msgBuilder | ||
| .append("Artifact ID must match pattern \"") | ||
| .append(artifactIdPattern) | ||
| .append("\" but is \"") | ||
| .append(project.getArtifactId()) | ||
| .append("\""); | ||
| } | ||
| if (moduleNameMustMatchArtifactId | ||
| && !project.isExecutionRoot() | ||
| && !project.getBasedir().getName().equals(project.getArtifactId())) { | ||
| if (msgBuilder.length() > 0) { | ||
| msgBuilder.append(System.lineSeparator()); | ||
| } | ||
| msgBuilder | ||
| .append("Module directory name must be equal to its artifact ID \"") | ||
| .append(project.getArtifactId()) | ||
| .append("\" but is \"") | ||
| .append(project.getBasedir().getName()) | ||
| .append("\""); | ||
| } | ||
| if (msgBuilder.length() > 0) { | ||
| throw new EnforcerRuleException(msgBuilder.toString()); | ||
| } | ||
| } | ||
|
|
||
| public void setGroupIdPattern(String groupIdPattern) { | ||
| this.groupIdPattern = Pattern.compile(groupIdPattern); | ||
| } | ||
|
|
||
| public void setArtifactIdPattern(String artifactIdPattern) { | ||
| this.artifactIdPattern = Pattern.compile(artifactIdPattern); | ||
| } | ||
|
|
||
| public void setModuleNameMustMatchArtifactId(boolean moduleNameMustMatchArtifactId) { | ||
| this.moduleNameMustMatchArtifactId = moduleNameMustMatchArtifactId; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return String.format( | ||
| "requireMatchingCoordinates[groupIdPattern=%s, artifactIdPattern=%s, moduleNameMustMatchArtifactId=%b]", | ||
| groupIdPattern, artifactIdPattern, moduleNameMustMatchArtifactId); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
75 changes: 75 additions & 0 deletions
75
enforcer-rules/src/site/apt/requireMatchingCoordinates.apt.vm
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| ~~ Licensed to the Apache Software Foundation (ASF) under one | ||
| ~~ or more contributor license agreements. See the NOTICE file | ||
| ~~ distributed with this work for additional information | ||
| ~~ regarding copyright ownership. The ASF licenses this file | ||
| ~~ to you under the Apache License, Version 2.0 (the | ||
| ~~ "License"); you may not use this file except in compliance | ||
| ~~ with the License. You may obtain a copy of the License at | ||
| ~~ | ||
| ~~ http://www.apache.org/licenses/LICENSE-2.0 | ||
| ~~ | ||
| ~~ Unless required by applicable law or agreed to in writing, | ||
| ~~ software distributed under the License is distributed on an | ||
| ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| ~~ KIND, either express or implied. See the License for the | ||
| ~~ specific language governing permissions and limitations | ||
| ~~ under the License. | ||
|
|
||
| ------ | ||
| Require Matching Coordinates | ||
| ------ | ||
| Konrad Windszus | ||
| ------ | ||
| 2024-03-22 | ||
| ------ | ||
|
|
||
| Require Matching Coordinates | ||
|
|
||
| This rule checks that the Maven coordinates (i.e. the project's <<<groupId>>> and <<<artifactId>>>) each match a given pattern. | ||
| Optionally one can also enforce that in a multi-module build the module directory name is always equal to the module's <<<artifactId>>>. | ||
|
|
||
| The following parameters are supported by this rule: | ||
|
|
||
| * <<message>> - an optional message to the user if the rule fails. If not set a default message will be used. | ||
|
|
||
| * <<groupIdPattern>> - an optional {{{https://docs.oracle.com/javase/tutorial/essential/regex/}regular expression}}, which must match the project's <<<groupId>>>. If not set there is no check on the <<<groupId>>>. | ||
|
|
||
| * <<artifactIdPattern>> - an optional {{{https://docs.oracle.com/javase/tutorial/essential/regex/}regular expression}}, which must match the project's <<<artifactId>>>. If not set there is no check on the <<<artifactId>>>. | ||
|
|
||
| * <<moduleNameMustMatchArtifactId>> - boolean flag to enforce that the the module's directory name is always equal to the module's <<<artifactId>>>. By default <<<false>>>. | ||
|
|
||
| [] | ||
|
|
||
|
|
||
| Sample Plugin Configuration: | ||
|
|
||
| +---+ | ||
| <project> | ||
| [...] | ||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-enforcer-plugin</artifactId> | ||
| <version>${project.version}</version> | ||
| <executions> | ||
| <execution> | ||
| <id>enforce-group-id</id> | ||
| <goals> | ||
| <goal>enforce</goal> | ||
| </goals> | ||
| <configuration> | ||
| <rules> | ||
| <requireMatchingCoordinates> | ||
| <groupIdPattern>com\.example.\namespace\..*</groupIdPattern> | ||
| </requireTextFileChecksum> | ||
| </rules> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
| [...] | ||
| </project> | ||
| +---+ |
43 changes: 43 additions & 0 deletions
43
maven-enforcer-plugin/src/it/projects/require-matching-coordinates/mod2/pom.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
|
|
||
| <!-- | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| --> | ||
|
|
||
| <project> | ||
| <modelVersion>4.0.0</modelVersion> | ||
|
|
||
| <parent> | ||
| <groupId>org.apache.maven.its.enforcer</groupId> | ||
| <artifactId>test-multimodule-project</artifactId> | ||
| <version>1.0</version> | ||
| </parent> | ||
|
|
||
| <artifactId>invalid-test-multimodule-mod2</artifactId> | ||
|
|
||
| <description> | ||
| </description> | ||
|
|
||
| <dependencies> | ||
| <dependency> | ||
| <groupId>${project.groupId}</groupId> | ||
| <artifactId>test-multimodule-mod1</artifactId> | ||
| </dependency> | ||
| </dependencies> | ||
|
|
||
| </project> |
75 changes: 75 additions & 0 deletions
75
maven-enforcer-plugin/src/it/projects/require-matching-coordinates/pom.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
|
|
||
| <!-- | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| --> | ||
|
|
||
| <project> | ||
| <modelVersion>4.0.0</modelVersion> | ||
|
|
||
| <groupId>org.apache.maven.its.enforcer</groupId> | ||
| <artifactId>test-multimodule-project</artifactId> | ||
| <version>1.0</version> | ||
| <packaging>pom</packaging> | ||
|
|
||
| <description> | ||
| </description> | ||
|
|
||
| <modules> | ||
| <module>test-multimodule-mod1</module> | ||
| <module>mod2</module> | ||
| </modules> | ||
|
|
||
| <dependencyManagement> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>${project.groupId}</groupId> | ||
| <artifactId>test-multimodule-mod1</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
| </dependencies> | ||
| </dependencyManagement> | ||
|
|
||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-enforcer-plugin</artifactId> | ||
| <version>@project.version@</version> | ||
| <executions> | ||
| <execution> | ||
| <id>test</id> | ||
| <goals> | ||
| <goal>enforce</goal> | ||
| </goals> | ||
| <configuration> | ||
| <rules> | ||
| <requireMatchingCoordinates> | ||
| <groupIdPattern>org\.apache\.maven\.its\.enforcer\.somepackage</groupIdPattern> | ||
| <artifactIdPattern>test-.*</artifactIdPattern> | ||
| <moduleNameMustMatchArtifactId>true</moduleNameMustMatchArtifactId> | ||
| </requireMatchingCoordinates> | ||
| </rules> | ||
| <fail>false</fail> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
| </project> |
37 changes: 37 additions & 0 deletions
37
...nforcer-plugin/src/it/projects/require-matching-coordinates/test-multimodule-mod1/pom.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
|
|
||
| <!-- | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| --> | ||
|
|
||
| <project> | ||
| <modelVersion>4.0.0</modelVersion> | ||
|
|
||
| <parent> | ||
| <groupId>org.apache.maven.its.enforcer</groupId> | ||
| <artifactId>test-multimodule-project</artifactId> | ||
| <version>1.0</version> | ||
| </parent> | ||
|
|
||
| <groupId>org.apache.maven.its.enforcer.somepackage</groupId> | ||
| <artifactId>test-multimodule-mod1</artifactId> | ||
|
|
||
| <description> | ||
| </description> | ||
|
|
||
| </project> |
23 changes: 23 additions & 0 deletions
23
maven-enforcer-plugin/src/it/projects/require-matching-coordinates/verify.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| File buildLog = new File(basedir, 'build.log') | ||
| def log = buildLog.text.normalize() | ||
| assert log.contains('[WARNING] Rule 0: org.apache.maven.enforcer.rules.RequireMatchingCoordinates failed with message:\nGroup ID must match pattern "org\\.apache\\.maven\\.its\\.enforcer\\.somepackage" but is "org.apache.maven.its.enforcer"\n') | ||
| assert log.contains('[WARNING] Rule 0: org.apache.maven.enforcer.rules.RequireMatchingCoordinates failed with message:\nGroup ID must match pattern "org\\.apache\\.maven\\.its\\.enforcer\\.somepackage" but is "org.apache.maven.its.enforcer"\nArtifact ID must match pattern "test-.*" but is "invalid-test-multimodule-mod2"\nModule directory name must be equal to its artifact ID "invalid-test-multimodule-mod2" but is "mod2"\n') |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
setters methods are not required
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
slightly less reflection magic for setter injection: https://github.com/eclipse/sisu.plexus/blob/5e8587eac8c4c079566dcd0ccb0d5dba40cb4169/org.eclipse.sisu.plexus/src/main/java/org/eclipse/sisu/plexus/CompositeBeanHelper.java#L143-L226 :-)