Skip to content

Commit 42dacab

Browse files
slawekjaranowskislawekjaranowski
committed
[MENFORCER-476] Rename ResolveUtil to ResolverUtil
1 parent 5e0ca5a commit 42dacab

File tree

10 files changed

+71
-37
lines changed

10 files changed

+71
-37
lines changed

‎enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BanTransitiveDependencies.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,12 @@ public final class BanTransitiveDependencies extends AbstractStandardEnforcerRul
6868

6969
private final MavenSession session;
7070

71-
private final ResolveUtil resolveUtil;
71+
private final ResolverUtil resolverUtil;
7272

7373
@Inject
74-
public BanTransitiveDependencies(MavenSession session, ResolveUtil resolveUtil) {
74+
public BanTransitiveDependencies(MavenSession session, ResolverUtil resolverUtil) {
7575
this.session = Objects.requireNonNull(session);
76-
this.resolveUtil = Objects.requireNonNull(resolveUtil);
76+
this.resolverUtil = Objects.requireNonNull(resolverUtil);
7777
}
7878

7979
/**
@@ -147,7 +147,7 @@ public void execute() throws EnforcerRuleException {
147147
.map(d -> RepositoryUtils.toDependency(d, artifactTypeRegistry))
148148
.collect(Collectors.toSet());
149149

150-
DependencyNode rootNode = resolveUtil.resolveTransitiveDependencies();
150+
DependencyNode rootNode = resolverUtil.resolveTransitiveDependencies();
151151
StringBuilder generatedMessage = new StringBuilder();
152152
if (searchTree(rootNode, 0, exclusions, directDependencies, generatedMessage)) {
153153
throw new EnforcerRuleException(ofNullable(getMessage()).orElse(generatedMessage.toString()));

‎enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BannedDependencies.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@
3434
public final class BannedDependencies extends BannedDependenciesBase {
3535

3636
@Inject
37-
BannedDependencies(MavenSession session, ResolveUtil resolveUtil) {
38-
super(session, resolveUtil);
37+
BannedDependencies(MavenSession session, ResolverUtil resolverUtil) {
38+
super(session, resolverUtil);
3939
}
4040

4141
@Override

‎enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BannedDependenciesBase.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ abstract class BannedDependenciesBase extends AbstractStandardEnforcerRule {
6868

6969
private final MavenSession session;
7070

71-
private final ResolveUtil resolveUtil;
71+
private final ResolverUtil resolverUtil;
7272

73-
BannedDependenciesBase(MavenSession session, ResolveUtil resolveUtil) {
73+
BannedDependenciesBase(MavenSession session, ResolverUtil resolverUtil) {
7474
this.session = Objects.requireNonNull(session);
75-
this.resolveUtil = Objects.requireNonNull(resolveUtil);
75+
this.resolverUtil = Objects.requireNonNull(resolverUtil);
7676
}
7777

7878
protected MavenSession getSession() {
@@ -103,7 +103,7 @@ public void execute() throws EnforcerRuleException {
103103
}
104104
} else {
105105
StringBuilder messageBuilder = new StringBuilder();
106-
DependencyNode rootNode = resolveUtil.resolveTransitiveDependenciesVerbose(Collections.emptyList());
106+
DependencyNode rootNode = resolverUtil.resolveTransitiveDependenciesVerbose(Collections.emptyList());
107107
if (!validate(rootNode, 0, messageBuilder)) {
108108
String message = "";
109109
if (getMessage() != null) {

‎enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/DependencyConvergence.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,17 @@ public final class DependencyConvergence extends AbstractStandardEnforcerRule {
5555

5656
private DependencyVersionMap dependencyVersionMap;
5757

58-
private final ResolveUtil resolveUtil;
58+
private final ResolverUtil resolverUtil;
5959

6060
@Inject
61-
public DependencyConvergence(ResolveUtil resolveUtil) {
62-
this.resolveUtil = Objects.requireNonNull(resolveUtil);
61+
public DependencyConvergence(ResolverUtil resolverUtil) {
62+
this.resolverUtil = Objects.requireNonNull(resolverUtil);
6363
}
6464

6565
@Override
6666
public void execute() throws EnforcerRuleException {
6767

68-
DependencyNode node = resolveUtil.resolveTransitiveDependenciesVerbose(excludedScopes);
68+
DependencyNode node = resolverUtil.resolveTransitiveDependenciesVerbose(excludedScopes);
6969
dependencyVersionMap = new DependencyVersionMap().setUniqueVersions(uniqueVersions);
7070
node.accept(dependencyVersionMap);
7171

‎enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/RequireReleaseDeps.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ public final class RequireReleaseDeps extends BannedDependenciesBase {
5151
private boolean failWhenParentIsSnapshot = true;
5252

5353
@Inject
54-
public RequireReleaseDeps(MavenSession session, ResolveUtil resolveUtil) {
55-
super(session, resolveUtil);
54+
public RequireReleaseDeps(MavenSession session, ResolverUtil resolverUtil) {
55+
super(session, resolverUtil);
5656
}
5757

5858
// Override parent to allow optional ignore of this rule.

‎enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/RequireUpperBoundDeps.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,11 @@ public final class RequireUpperBoundDeps extends AbstractStandardEnforcerRule {
7575

7676
private RequireUpperBoundDepsVisitor upperBoundDepsVisitor;
7777

78-
private final ResolveUtil resolveUtil;
78+
private final ResolverUtil resolverUtil;
7979

8080
@Inject
81-
public RequireUpperBoundDeps(ResolveUtil resolveUtil) {
82-
this.resolveUtil = Objects.requireNonNull(resolveUtil);
81+
public RequireUpperBoundDeps(ResolverUtil resolverUtil) {
82+
this.resolverUtil = Objects.requireNonNull(resolverUtil);
8383
}
8484

8585
/**
@@ -102,7 +102,7 @@ public void setIncludes(List<String> includes) {
102102
@Override
103103
public void execute() throws EnforcerRuleException {
104104
DependencyNode node =
105-
resolveUtil.resolveTransitiveDependenciesVerbose(Arrays.asList(SCOPE_TEST, SCOPE_PROVIDED));
105+
resolverUtil.resolveTransitiveDependenciesVerbose(Arrays.asList(SCOPE_TEST, SCOPE_PROVIDED));
106106
upperBoundDepsVisitor = new RequireUpperBoundDepsVisitor()
107107
.setUniqueVersions(uniqueVersions)
108108
.setIncludes(includes);

‎enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/ResolveUtil.java renamed to ‎enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/ResolverUtil.java

+36-2
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,10 @@
3939
import org.eclipse.aether.collection.DependencyCollectionException;
4040
import org.eclipse.aether.graph.Dependency;
4141
import org.eclipse.aether.graph.DependencyNode;
42+
import org.eclipse.aether.graph.DependencyVisitor;
4243
import org.eclipse.aether.util.graph.manager.DependencyManagerUtils;
4344
import org.eclipse.aether.util.graph.transformer.ConflictResolver;
45+
import org.eclipse.aether.util.graph.visitor.TreeDependencyVisitor;
4446

4547
import static java.util.Optional.ofNullable;
4648
import static org.apache.maven.artifact.Artifact.SCOPE_PROVIDED;
@@ -50,7 +52,7 @@
5052
* Resolver helper class.
5153
*/
5254
@Named
53-
class ResolveUtil {
55+
class ResolverUtil {
5456

5557
private final RepositorySystem repositorySystem;
5658

@@ -60,7 +62,7 @@ class ResolveUtil {
6062
* Default constructor
6163
*/
6264
@Inject
63-
ResolveUtil(RepositorySystem repositorySystem, MavenSession session) {
65+
ResolverUtil(RepositorySystem repositorySystem, MavenSession session) {
6466
this.repositorySystem = Objects.requireNonNull(repositorySystem);
6567
this.session = Objects.requireNonNull(session);
6668
}
@@ -136,4 +138,36 @@ private DependencyNode resolveTransitiveDependencies(
136138
throw new EnforcerRuleException("Could not build dependency tree " + e.getLocalizedMessage(), e);
137139
}
138140
}
141+
142+
/**
143+
* Dump a {@link DependencyNode} as a tree.
144+
*
145+
* @param rootNode node to inspect
146+
* @return dependency tree as String
147+
*/
148+
public CharSequence dumpTree(DependencyNode rootNode) {
149+
StringBuilder result = new StringBuilder(System.lineSeparator());
150+
151+
rootNode.accept(new TreeDependencyVisitor(new DependencyVisitor() {
152+
String indent = "";
153+
154+
@Override
155+
public boolean visitEnter(org.eclipse.aether.graph.DependencyNode dependencyNode) {
156+
result.append(indent);
157+
result.append("Node: ").append(dependencyNode);
158+
result.append(" data map: ").append(dependencyNode.getData());
159+
result.append(System.lineSeparator());
160+
indent += " ";
161+
return true;
162+
}
163+
164+
@Override
165+
public boolean visitLeave(org.eclipse.aether.graph.DependencyNode dependencyNode) {
166+
indent = indent.substring(0, indent.length() - 2);
167+
return true;
168+
}
169+
}));
170+
171+
return result;
172+
}
139173
}

‎enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/dependency/BannedDependenciesTest.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class BannedDependenciesTest {
5252
private MavenSession session;
5353

5454
@Mock
55-
private ResolveUtil resolveUtil;
55+
private ResolverUtil resolverUtil;
5656

5757
@InjectMocks
5858
private BannedDependencies rule;
@@ -95,7 +95,7 @@ void excludesAndIncludesDoNotUseTransitiveDependencies() throws Exception {
9595
@Test
9696
void excludesUseTransitiveDependencies() throws Exception {
9797

98-
when(resolveUtil.resolveTransitiveDependenciesVerbose(anyList()))
98+
when(resolverUtil.resolveTransitiveDependenciesVerbose(anyList()))
9999
.thenReturn(new DependencyNodeBuilder()
100100
.withType(DependencyNodeBuilder.Type.POM)
101101
.withChildNode(new DependencyNodeBuilder()
@@ -128,7 +128,7 @@ void excludesUseTransitiveDependencies() throws Exception {
128128
@Test
129129
void excludesAndIncludesUseTransitiveDependencies() throws Exception {
130130

131-
when(resolveUtil.resolveTransitiveDependenciesVerbose(anyList()))
131+
when(resolverUtil.resolveTransitiveDependenciesVerbose(anyList()))
132132
.thenReturn(new DependencyNodeBuilder()
133133
.withType(DependencyNodeBuilder.Type.POM)
134134
.withChildNode(new DependencyNodeBuilder()

‎enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/dependency/RequireReleaseDepsTest.java

+10-10
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ class RequireReleaseDepsTest {
5757
private MavenSession session;
5858

5959
@Mock
60-
private ResolveUtil resolveUtil;
60+
private ResolverUtil resolverUtil;
6161

6262
@InjectMocks
6363
private RequireReleaseDeps rule;
@@ -76,12 +76,12 @@ void testSearchNonTransitive() throws IOException {
7676

7777
assertThatCode(rule::execute).doesNotThrowAnyException();
7878

79-
verifyNoInteractions(resolveUtil);
79+
verifyNoInteractions(resolverUtil);
8080
}
8181

8282
@Test
8383
void testSearchTransitiveMultipleFailures() throws Exception {
84-
when(resolveUtil.resolveTransitiveDependenciesVerbose(anyList()))
84+
when(resolverUtil.resolveTransitiveDependenciesVerbose(anyList()))
8585
.thenReturn(getDependencyNodeWithMultipleSnapshots());
8686
rule.setSearchTransitive(true);
8787

@@ -96,7 +96,7 @@ void testSearchTransitiveMultipleFailures() throws Exception {
9696
@Test
9797
void testSearchTransitiveNoFailures() throws Exception {
9898
when(session.getCurrentProject()).thenReturn(project);
99-
when(resolveUtil.resolveTransitiveDependenciesVerbose(anyList()))
99+
when(resolverUtil.resolveTransitiveDependenciesVerbose(anyList()))
100100
.thenReturn(new DependencyNodeBuilder().build());
101101

102102
rule.setSearchTransitive(true);
@@ -111,13 +111,13 @@ void testShouldFailOnlyWhenRelease() throws Exception {
111111

112112
assertThatCode(rule::execute).doesNotThrowAnyException();
113113

114-
verifyNoInteractions(resolveUtil);
114+
verifyNoInteractions(resolverUtil);
115115
}
116116

117117
@Test
118118
void testWildcardExcludeTests() throws Exception {
119119
when(session.getCurrentProject()).thenReturn(project);
120-
when(resolveUtil.resolveTransitiveDependenciesVerbose(anyList()))
120+
when(resolverUtil.resolveTransitiveDependenciesVerbose(anyList()))
121121
.thenReturn(getDependencyNodeWithMultipleTestSnapshots());
122122

123123
rule.setExcludes(Collections.singletonList("*:*:*:*:test"));
@@ -129,7 +129,7 @@ void testWildcardExcludeTests() throws Exception {
129129
@Test
130130
void testWildcardExcludeAll() throws Exception {
131131
when(session.getCurrentProject()).thenReturn(project);
132-
when(resolveUtil.resolveTransitiveDependenciesVerbose(anyList()))
132+
when(resolverUtil.resolveTransitiveDependenciesVerbose(anyList()))
133133
.thenReturn(getDependencyNodeWithMultipleTestSnapshots());
134134

135135
rule.setExcludes(Collections.singletonList("*"));
@@ -140,7 +140,7 @@ void testWildcardExcludeAll() throws Exception {
140140

141141
@Test
142142
void testExcludesAndIncludes() throws Exception {
143-
when(resolveUtil.resolveTransitiveDependenciesVerbose(anyList()))
143+
when(resolverUtil.resolveTransitiveDependenciesVerbose(anyList()))
144144
.thenReturn(getDependencyNodeWithMultipleTestSnapshots());
145145

146146
rule.setExcludes(Collections.singletonList("*"));
@@ -167,7 +167,7 @@ void testId() {
167167
void testFailWhenParentIsSnapshot() throws Exception {
168168
when(session.getCurrentProject()).thenReturn(project);
169169
when(project.getParentArtifact()).thenReturn(ARTIFACT_STUB_FACTORY.getSnapshotArtifact());
170-
when(resolveUtil.resolveTransitiveDependenciesVerbose(anyList()))
170+
when(resolverUtil.resolveTransitiveDependenciesVerbose(anyList()))
171171
.thenReturn(new DependencyNodeBuilder().build());
172172

173173
rule.setFailWhenParentIsSnapshot(true);
@@ -181,7 +181,7 @@ void testFailWhenParentIsSnapshot() throws Exception {
181181
void parentShouldBeExcluded() throws Exception {
182182
when(session.getCurrentProject()).thenReturn(project);
183183
when(project.getParentArtifact()).thenReturn(ARTIFACT_STUB_FACTORY.getSnapshotArtifact());
184-
when(resolveUtil.resolveTransitiveDependenciesVerbose(anyList()))
184+
when(resolverUtil.resolveTransitiveDependenciesVerbose(anyList()))
185185
.thenReturn(new DependencyNodeBuilder().build());
186186

187187
rule.setFailWhenParentIsSnapshot(true);

‎enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/dependency/RequireUpperBoundDepsTest.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@
3434
class RequireUpperBoundDepsTest {
3535

3636
@Mock
37-
private ResolveUtil resolveUtil;
37+
private ResolverUtil resolverUtil;
3838

3939
@InjectMocks
4040
private RequireUpperBoundDeps rule;
4141

4242
@Test
4343
void testRule() throws Exception {
4444

45-
when(resolveUtil.resolveTransitiveDependenciesVerbose(anyList()))
45+
when(resolverUtil.resolveTransitiveDependenciesVerbose(anyList()))
4646
.thenReturn(new DependencyNodeBuilder()
4747
.withType(DependencyNodeBuilder.Type.POM)
4848
.withChildNode(new DependencyNodeBuilder()

0 commit comments

Comments
 (0)