From bbbef2ebdb475830b76d825c8a4244be688ba21c Mon Sep 17 00:00:00 2001 From: Elias Lundell Date: Wed, 27 Nov 2024 14:52:07 +0100 Subject: [PATCH 1/7] Expose ConflictData on DependencyNode --- .../dependency/graph/{internal => }/ConflictData.java | 2 +- .../maven/shared/dependency/graph/DependencyNode.java | 7 +++++++ .../graph/internal/DefaultDependencyCollectorBuilder.java | 1 + .../dependency/graph/internal/DefaultDependencyNode.java | 6 ++++++ .../dependency/graph/internal/VerboseDependencyNode.java | 6 ++++++ 5 files changed, 21 insertions(+), 1 deletion(-) rename src/main/java/org/apache/maven/shared/dependency/graph/{internal => }/ConflictData.java (96%) diff --git a/src/main/java/org/apache/maven/shared/dependency/graph/internal/ConflictData.java b/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java similarity index 96% rename from src/main/java/org/apache/maven/shared/dependency/graph/internal/ConflictData.java rename to src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java index 1ee9f43..a7d8c19 100644 --- a/src/main/java/org/apache/maven/shared/dependency/graph/internal/ConflictData.java +++ b/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java @@ -16,7 +16,7 @@ * specific language governing permissions and limitations * under the License. */ -package org.apache.maven.shared.dependency.graph.internal; +package org.apache.maven.shared.dependency.graph; /** * Explicit subset of Aether's DependencyNode.getData(). diff --git a/src/main/java/org/apache/maven/shared/dependency/graph/DependencyNode.java b/src/main/java/org/apache/maven/shared/dependency/graph/DependencyNode.java index 1f925a5..0aba220 100644 --- a/src/main/java/org/apache/maven/shared/dependency/graph/DependencyNode.java +++ b/src/main/java/org/apache/maven/shared/dependency/graph/DependencyNode.java @@ -97,4 +97,11 @@ public interface DependencyNode { * @return the exclusions of the dependency */ List getExclusions(); + + /** + * If this is a verbose dependency node, this returns the conflict data. Otherwise, it returns null. + * + * @return the conflict data of verbose dependency node or null + */ + ConflictData getConflictData(); } diff --git a/src/main/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyCollectorBuilder.java b/src/main/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyCollectorBuilder.java index 3a436eb..03634bb 100644 --- a/src/main/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyCollectorBuilder.java +++ b/src/main/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyCollectorBuilder.java @@ -33,6 +33,7 @@ import org.apache.maven.model.Dependency; import org.apache.maven.project.MavenProject; import org.apache.maven.project.ProjectBuildingRequest; +import org.apache.maven.shared.dependency.graph.ConflictData; import org.apache.maven.shared.dependency.graph.DependencyCollectorBuilder; import org.apache.maven.shared.dependency.graph.DependencyCollectorBuilderException; import org.apache.maven.shared.dependency.graph.DependencyCollectorRequest; diff --git a/src/main/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNode.java b/src/main/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNode.java index bd33d09..c480fa7 100644 --- a/src/main/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNode.java +++ b/src/main/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNode.java @@ -22,6 +22,7 @@ import org.apache.maven.artifact.Artifact; import org.apache.maven.model.Exclusion; +import org.apache.maven.shared.dependency.graph.ConflictData; import org.apache.maven.shared.dependency.graph.DependencyNode; import org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor; @@ -177,4 +178,9 @@ public List getExclusions() { public String toNodeString() { return artifact + (Boolean.TRUE.equals(optional) ? " (optional)" : ""); } + + @Override + public ConflictData getConflictData() { + return null; + } } diff --git a/src/main/java/org/apache/maven/shared/dependency/graph/internal/VerboseDependencyNode.java b/src/main/java/org/apache/maven/shared/dependency/graph/internal/VerboseDependencyNode.java index b96d3e8..7f6cea8 100644 --- a/src/main/java/org/apache/maven/shared/dependency/graph/internal/VerboseDependencyNode.java +++ b/src/main/java/org/apache/maven/shared/dependency/graph/internal/VerboseDependencyNode.java @@ -22,6 +22,7 @@ import org.apache.maven.artifact.Artifact; import org.apache.maven.model.Exclusion; +import org.apache.maven.shared.dependency.graph.ConflictData; import org.apache.maven.shared.dependency.graph.DependencyNode; class VerboseDependencyNode extends DefaultDependencyNode { @@ -96,6 +97,11 @@ public String toNodeString() { return buffer.toString(); } + @Override + public ConflictData getConflictData() { + return data; + } + /** * Utility class to concatenate a number of parameters with separator tokens. */ From 4e67f0a17404136eaa86a875431dc4302e7150e0 Mon Sep 17 00:00:00 2001 From: Elias Lundell Date: Tue, 10 Dec 2024 11:24:46 +0100 Subject: [PATCH 2/7] Add tests --- .../internal/DefaultDependencyNodeTest.java | 8 ++++ .../internal/VerboseDependencyNodeTest.java | 42 +++++++++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 src/test/java/org/apache/maven/shared/dependency/graph/internal/VerboseDependencyNodeTest.java diff --git a/src/test/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNodeTest.java b/src/test/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNodeTest.java index da7afea..464b152 100644 --- a/src/test/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNodeTest.java +++ b/src/test/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNodeTest.java @@ -42,4 +42,12 @@ public void nodeString_for_mandatory_depenendency_does_not_contain_optional_info new DefaultDependencyNode(null, artifact, "1.0", "compile", "1.0", false, emptyList()); assertEquals("group:artifact:jar:1.2:compile", optionalNode.toNodeString()); } + + @Test + public void defaultDependencyNode_should_return_null_conflict_data() { + DefaultDependencyNode node = + new DefaultDependencyNode(null, artifact, "1.0", "compile", "1.0", false, emptyList()); + + assertEquals(node.getConflictData(), null); + } } diff --git a/src/test/java/org/apache/maven/shared/dependency/graph/internal/VerboseDependencyNodeTest.java b/src/test/java/org/apache/maven/shared/dependency/graph/internal/VerboseDependencyNodeTest.java new file mode 100644 index 0000000..d31e7c8 --- /dev/null +++ b/src/test/java/org/apache/maven/shared/dependency/graph/internal/VerboseDependencyNodeTest.java @@ -0,0 +1,42 @@ +/* + * 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.shared.dependency.graph.internal; + +import org.apache.maven.artifact.Artifact; +import org.apache.maven.artifact.DefaultArtifact; +import org.apache.maven.shared.dependency.graph.ConflictData; +import org.junit.jupiter.api.Test; + +import static java.util.Collections.emptyList; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class VerboseDependencyNodeTest { + + private final Artifact artifact = new DefaultArtifact("group", "artifact", "1.2", "compile", "jar", "", null); + + @Test + public void verboseDependencyNode_should_return_conflict_data() { + ConflictData conflictData = new ConflictData("winnerVersion", "ignoredScope"); + VerboseDependencyNode verboseDependencyNode = + new VerboseDependencyNode(null, artifact, "1.0", "compile", "1.0", false, emptyList(), conflictData); + + assertEquals(verboseDependencyNode.getConflictData().getWinnerVersion(), "winnerVersion"); + assertEquals(verboseDependencyNode.getConflictData().getIgnoredScope(), "ignoredScope"); + } +} From 575cd1a7f14d17cdc4507ca51ae9a21f17126e46 Mon Sep 17 00:00:00 2001 From: Elias Lundell Date: Wed, 8 Jan 2025 16:02:07 +0100 Subject: [PATCH 3/7] Use assertNull and put expected value first --- .../dependency/graph/internal/DefaultDependencyNodeTest.java | 3 ++- .../dependency/graph/internal/VerboseDependencyNodeTest.java | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/test/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNodeTest.java b/src/test/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNodeTest.java index 464b152..70923f3 100644 --- a/src/test/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNodeTest.java +++ b/src/test/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNodeTest.java @@ -24,6 +24,7 @@ import static java.util.Collections.emptyList; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNull; public class DefaultDependencyNodeTest { @@ -48,6 +49,6 @@ public void defaultDependencyNode_should_return_null_conflict_data() { DefaultDependencyNode node = new DefaultDependencyNode(null, artifact, "1.0", "compile", "1.0", false, emptyList()); - assertEquals(node.getConflictData(), null); + assertNull(node.getConflictData()); } } diff --git a/src/test/java/org/apache/maven/shared/dependency/graph/internal/VerboseDependencyNodeTest.java b/src/test/java/org/apache/maven/shared/dependency/graph/internal/VerboseDependencyNodeTest.java index d31e7c8..124da45 100644 --- a/src/test/java/org/apache/maven/shared/dependency/graph/internal/VerboseDependencyNodeTest.java +++ b/src/test/java/org/apache/maven/shared/dependency/graph/internal/VerboseDependencyNodeTest.java @@ -36,7 +36,7 @@ public void verboseDependencyNode_should_return_conflict_data() { VerboseDependencyNode verboseDependencyNode = new VerboseDependencyNode(null, artifact, "1.0", "compile", "1.0", false, emptyList(), conflictData); - assertEquals(verboseDependencyNode.getConflictData().getWinnerVersion(), "winnerVersion"); - assertEquals(verboseDependencyNode.getConflictData().getIgnoredScope(), "ignoredScope"); + assertEquals("winnerVersion", verboseDependencyNode.getConflictData().getWinnerVersion()); + assertEquals("ignoredScope", verboseDependencyNode.getConflictData().getIgnoredScope()); } } From d38f26d55904f4b1b574be1db7efc660642cd8e8 Mon Sep 17 00:00:00 2001 From: Elias Lundell Date: Wed, 8 Jan 2025 16:35:26 +0100 Subject: [PATCH 4/7] add javadoc strings --- .../shared/dependency/graph/ConflictData.java | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java b/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java index a7d8c19..1eb7541 100644 --- a/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java +++ b/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java @@ -32,31 +32,70 @@ public class ConflictData { private Boolean originaOptionality; + /** + * Construct ConflictData. Containing information about conflicts during dependency resolution. + * Either this node lost the conflict and winnerVersion is set with the versionwof the winnig node, + * or this node won and winnerVersion is @code{null}. + * If this node won ignoredScope can contain potential scopes that were ignored during conflict resolution. + * + * @param winnerVersion the version of the dependency that was selected. + * @param ignoredScope the scope + */ public ConflictData(String winnerVersion, String ignoredScope) { this.winnerVersion = winnerVersion; this.ignoredScope = ignoredScope; } + /** + * In case of a conflict, the version of the dependency that was selected. + * + * @return the version of the dependency node that was selected. + */ public String getWinnerVersion() { return winnerVersion; } + /** + * Original scope of a rejected dependency due to a conflict. + * + * @return the original scope of the dependency that was updated from. + */ public String getOriginalScope() { return originalScope; } + /** + * Set original scope of a rejected dependency due to a conflict. + * + * @param originalScope the original scope of the dependency that was updated from. + */ public void setOriginalScope(String originalScope) { this.originalScope = originalScope; } + /** + * Original optionality of a rejected dependency due to a conflict. + * + * @return the original optionality of the dependency. + */ public Boolean getOriginaOptionality() { return originaOptionality; } + /** + * Set original optionality of a rejected dependency due to a conflict. + * + * @param originaOptionality the original optionality of the dependency. + */ public void setOriginaOptionality(Boolean originaOptionality) { this.originaOptionality = originaOptionality; } + /** + * The scope of the dependency that was not updated to during dependency resolution. + * + * @return the scope of the dependency that was ignored and not updated to. + */ public String getIgnoredScope() { return ignoredScope; } From 65534ffdbedf8754776717a16c36278dd67fd081 Mon Sep 17 00:00:00 2001 From: Elias Lundell Date: Wed, 8 Jan 2025 18:05:45 +0100 Subject: [PATCH 5/7] rename test, remove dots, add docs for ignoredScope in constructor --- .../shared/dependency/graph/ConflictData.java | 28 +++++++++---------- .../internal/DefaultDependencyNodeTest.java | 2 +- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java b/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java index 1eb7541..f089907 100644 --- a/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java +++ b/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java @@ -30,16 +30,16 @@ public class ConflictData { private String ignoredScope; - private Boolean originaOptionality; + private Boolean originalOptionality; /** * Construct ConflictData. Containing information about conflicts during dependency resolution. - * Either this node lost the conflict and winnerVersion is set with the versionwof the winnig node, + * Either this node lost the conflict and winnerVersion is set with the version of the winnig node, * or this node won and winnerVersion is @code{null}. - * If this node won ignoredScope can contain potential scopes that were ignored during conflict resolution. + * If this node won, ignoredScope can contain potential scopes that were ignored during conflict resolution. * - * @param winnerVersion the version of the dependency that was selected. - * @param ignoredScope the scope + * @param winnerVersion the version of the dependency that was selected + * @param ignoredScope the scope of the dependency that was ignored and not updated to */ public ConflictData(String winnerVersion, String ignoredScope) { this.winnerVersion = winnerVersion; @@ -58,7 +58,7 @@ public String getWinnerVersion() { /** * Original scope of a rejected dependency due to a conflict. * - * @return the original scope of the dependency that was updated from. + * @return the original scope of the dependency that was updated from */ public String getOriginalScope() { return originalScope; @@ -67,7 +67,7 @@ public String getOriginalScope() { /** * Set original scope of a rejected dependency due to a conflict. * - * @param originalScope the original scope of the dependency that was updated from. + * @param originalScope the original scope of the dependency that was updated from */ public void setOriginalScope(String originalScope) { this.originalScope = originalScope; @@ -76,25 +76,25 @@ public void setOriginalScope(String originalScope) { /** * Original optionality of a rejected dependency due to a conflict. * - * @return the original optionality of the dependency. + * @return the original optionality of the dependency */ - public Boolean getOriginaOptionality() { - return originaOptionality; + public Boolean getOriginalOptionality() { + return originalOptionality; } /** * Set original optionality of a rejected dependency due to a conflict. * - * @param originaOptionality the original optionality of the dependency. + * @param originalOptionality the original optionality of the dependency */ - public void setOriginaOptionality(Boolean originaOptionality) { - this.originaOptionality = originaOptionality; + public void setOriginalOptionality(Boolean originalOptionality) { + this.originalOptionality = originalOptionality; } /** * The scope of the dependency that was not updated to during dependency resolution. * - * @return the scope of the dependency that was ignored and not updated to. + * @return the scope of the dependency that was ignored and not updated to */ public String getIgnoredScope() { return ignoredScope; diff --git a/src/test/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNodeTest.java b/src/test/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNodeTest.java index 70923f3..d3c7e3a 100644 --- a/src/test/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNodeTest.java +++ b/src/test/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNodeTest.java @@ -45,7 +45,7 @@ public void nodeString_for_mandatory_depenendency_does_not_contain_optional_info } @Test - public void defaultDependencyNode_should_return_null_conflict_data() { + public void defaultDependencyNodeHasNullConflictData() { DefaultDependencyNode node = new DefaultDependencyNode(null, artifact, "1.0", "compile", "1.0", false, emptyList()); From 1d0fe100ad613cd0ebd168a86d66b7689aadf410 Mon Sep 17 00:00:00 2001 From: Elias Lundell Date: Wed, 8 Jan 2025 18:12:00 +0100 Subject: [PATCH 6/7] Remove . --- .../org/apache/maven/shared/dependency/graph/ConflictData.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java b/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java index f089907..b0620c3 100644 --- a/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java +++ b/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java @@ -49,7 +49,7 @@ public ConflictData(String winnerVersion, String ignoredScope) { /** * In case of a conflict, the version of the dependency that was selected. * - * @return the version of the dependency node that was selected. + * @return the version of the dependency node that was selected */ public String getWinnerVersion() { return winnerVersion; From 3c54d66d6c55bfefdd4ce70ee516eefeeba473c3 Mon Sep 17 00:00:00 2001 From: Elias Lundell Date: Wed, 8 Jan 2025 18:20:27 +0100 Subject: [PATCH 7/7] Remove originalScope and originalOptionality --- .../shared/dependency/graph/ConflictData.java | 40 ------------------- .../graph/internal/VerboseDependencyNode.java | 4 -- 2 files changed, 44 deletions(-) diff --git a/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java b/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java index b0620c3..7b734ad 100644 --- a/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java +++ b/src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java @@ -26,12 +26,8 @@ public class ConflictData { private String winnerVersion; - private String originalScope; - private String ignoredScope; - private Boolean originalOptionality; - /** * Construct ConflictData. Containing information about conflicts during dependency resolution. * Either this node lost the conflict and winnerVersion is set with the version of the winnig node, @@ -55,42 +51,6 @@ public String getWinnerVersion() { return winnerVersion; } - /** - * Original scope of a rejected dependency due to a conflict. - * - * @return the original scope of the dependency that was updated from - */ - public String getOriginalScope() { - return originalScope; - } - - /** - * Set original scope of a rejected dependency due to a conflict. - * - * @param originalScope the original scope of the dependency that was updated from - */ - public void setOriginalScope(String originalScope) { - this.originalScope = originalScope; - } - - /** - * Original optionality of a rejected dependency due to a conflict. - * - * @return the original optionality of the dependency - */ - public Boolean getOriginalOptionality() { - return originalOptionality; - } - - /** - * Set original optionality of a rejected dependency due to a conflict. - * - * @param originalOptionality the original optionality of the dependency - */ - public void setOriginalOptionality(Boolean originalOptionality) { - this.originalOptionality = originalOptionality; - } - /** * The scope of the dependency that was not updated to during dependency resolution. * diff --git a/src/main/java/org/apache/maven/shared/dependency/graph/internal/VerboseDependencyNode.java b/src/main/java/org/apache/maven/shared/dependency/graph/internal/VerboseDependencyNode.java index 7f6cea8..a4a5953 100644 --- a/src/main/java/org/apache/maven/shared/dependency/graph/internal/VerboseDependencyNode.java +++ b/src/main/java/org/apache/maven/shared/dependency/graph/internal/VerboseDependencyNode.java @@ -65,10 +65,6 @@ public String toNodeString() { appender.append("scope managed from ", getPremanagedScope()); } - if (data.getOriginalScope() != null) { - appender.append("scope updated from ", data.getOriginalScope()); - } - if (data.getIgnoredScope() != null) { appender.append("scope not updated to ", data.getIgnoredScope()); }