diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/DependencyConvergence.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/DependencyConvergence.java index 21cac73e..13e22c6c 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/DependencyConvergence.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/DependencyConvergence.java @@ -22,6 +22,7 @@ import javax.inject.Named; import java.util.ArrayList; +import java.util.Arrays; import java.util.Collections; import java.util.List; import java.util.Objects; @@ -43,12 +44,18 @@ @Named("dependencyConvergence") public final class DependencyConvergence extends AbstractStandardEnforcerRule { + // parameters + private boolean uniqueVersions; private List includes; private List excludes; + private List excludedScopes = Arrays.asList(SCOPE_TEST, SCOPE_PROVIDED); + + // parameters - end + private DependencyVersionMap dependencyVersionMap; private final ResolveUtil resolveUtil; @@ -63,19 +70,17 @@ public void execute() throws EnforcerRuleException { DependencyNode node = resolveUtil.resolveTransitiveDependenciesVerbose( new AllLevelsOptionalDependencySelector(), - new AllLevelsScopeDependencySelector(SCOPE_TEST, SCOPE_PROVIDED), + new AllLevelsScopeDependencySelector(excludedScopes), new ExclusionDependencySelector()); dependencyVersionMap = new DependencyVersionMap().setUniqueVersions(uniqueVersions); node.accept(dependencyVersionMap); - List errorMsgs = new ArrayList<>( - getConvergenceErrorMsgs(dependencyVersionMap.getConflictedVersionNumbers(includes, excludes))); - for (CharSequence errorMsg : errorMsgs) { - getLog().warnOrError(errorMsg); - } - if (errorMsgs.size() > 0) { - throw new EnforcerRuleException( - "Failed while enforcing releasability. " + "See above detailed error message."); + List errorMsgs = + getConvergenceErrorMsgs(dependencyVersionMap.getConflictedVersionNumbers(includes, excludes)); + + if (!errorMsgs.isEmpty()) { + throw new EnforcerRuleException("Failed while enforcing releasability." + System.lineSeparator() + + String.join(System.lineSeparator(), errorMsgs)); } } diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/selector/AllLevelsScopeDependencySelector.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/selector/AllLevelsScopeDependencySelector.java index 7490edf8..ab59eac7 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/selector/AllLevelsScopeDependencySelector.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/selector/AllLevelsScopeDependencySelector.java @@ -21,6 +21,7 @@ import java.util.Arrays; import java.util.Collection; import java.util.Collections; +import java.util.List; import org.eclipse.aether.collection.DependencyCollectionContext; import org.eclipse.aether.collection.DependencySelector; @@ -34,10 +35,22 @@ public class AllLevelsScopeDependencySelector implements DependencySelector { private final Collection excluded; + /** + * A constructor for selector + * @param excluded list of excluded scopes + */ public AllLevelsScopeDependencySelector(String... excluded) { this.excluded = excluded != null ? Arrays.asList(excluded) : Collections.emptyList(); } + /** + * A constructor for selector + * @param excluded list of excluded scopes + */ + public AllLevelsScopeDependencySelector(List excluded) { + this.excluded = excluded; + } + @Override public boolean selectDependency(Dependency dependency) { return !excluded.contains(dependency.getScope()); diff --git a/enforcer-rules/src/site/apt/dependencyConvergence.apt.vm b/enforcer-rules/src/site/apt/dependencyConvergence.apt.vm index 805c7dfb..99f473d3 100644 --- a/enforcer-rules/src/site/apt/dependencyConvergence.apt.vm +++ b/enforcer-rules/src/site/apt/dependencyConvergence.apt.vm @@ -139,8 +139,8 @@ and * <> - A list of artifacts for which dependency convergence should not be enforced. These are exceptions to the includes. - * <> - A list of scopes of artifacts for which dependency convergence should be enforced. Not specifying - any scopes is interpreted as having the following scopes activated: compile, runtime, system. + * <> - A list of scopes of artifacts for which dependency convergence should not be enforced. + Not specifying any scopes is interpreted as having the following scopes excluded: <<>>, <<>>. [] @@ -150,10 +150,10 @@ and +--------------------------------------------- - + compile runtime - + org.slf4j org.apache.commons diff --git a/maven-enforcer-plugin/src/it/projects/dependency-convergence_excludedScopes/invoker.properties b/maven-enforcer-plugin/src/it/projects/dependency-convergence_excludedScopes/invoker.properties new file mode 100644 index 00000000..66b78c06 --- /dev/null +++ b/maven-enforcer-plugin/src/it/projects/dependency-convergence_excludedScopes/invoker.properties @@ -0,0 +1,18 @@ +# 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. + +invoker.buildResult=failure diff --git a/maven-enforcer-plugin/src/it/projects/dependency-convergence_excludedScopes/pom.xml b/maven-enforcer-plugin/src/it/projects/dependency-convergence_excludedScopes/pom.xml new file mode 100644 index 00000000..e09ea485 --- /dev/null +++ b/maven-enforcer-plugin/src/it/projects/dependency-convergence_excludedScopes/pom.xml @@ -0,0 +1,77 @@ + + + + + 4.0.0 + org.apache.maven.enforcer.its + dependency-convergence + 1.0.0 + jar + + + + org.slf4j + slf4j-log4j12 + 1.6.2 + + + org.slf4j + slf4j-jdk14 + 1.6.1 + provided + + + org.slf4j + slf4j-nop + 1.6.0 + test + + + + + + + org.apache.maven.plugins + maven-enforcer-plugin + @project.version@ + + + enforce + + + + + + test + + + + + + enforce + + + + + + + + diff --git a/maven-enforcer-plugin/src/it/projects/dependency-convergence_excludedScopes/verify.groovy b/maven-enforcer-plugin/src/it/projects/dependency-convergence_excludedScopes/verify.groovy new file mode 100644 index 00000000..d0e7395d --- /dev/null +++ b/maven-enforcer-plugin/src/it/projects/dependency-convergence_excludedScopes/verify.groovy @@ -0,0 +1,27 @@ +/* + * 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. + */ + +def buildLog = new File( basedir, 'build.log' ).text + +assert buildLog.contains( '[ERROR] Rule 0: org.apache.maven.enforcer.rules.dependency.DependencyConvergence failed with message' ) +assert buildLog.contains( 'Dependency convergence error for org.slf4j:slf4j-api:jar:1.6.2 paths to dependency are:' ) +assert buildLog.contains( '+-org.slf4j:slf4j-api:jar:1.6.2:compile' ) +assert buildLog.contains( '+-org.slf4j:slf4j-api:jar:1.6.1:provided' ) +assert !buildLog.contains( 'org.slf4j:slf4j-api:jar:1.6.0' ) +