- * will use the jvm chmod, this is available for user and all level group level will be ignored - *
- * since 2.6 is on by default - * - * @since 2.5.1 - */ - @Parameter(property = "dependency.useJvmChmod", defaultValue = "true") - private boolean useJvmChmod = true; - - /** - * ignore to set file permissions when unpacking a dependency - * - * @since 2.7 - */ - @Parameter(property = "dependency.ignorePermissions", defaultValue = "false") - private boolean ignorePermissions; - - /** - * POM - */ - @Parameter(defaultValue = "${project}", readonly = true, required = true) - private MavenProject project; - - /** - * Remote repositories which will be searched for artifacts. - */ - @Parameter(defaultValue = "${project.remoteArtifactRepositories}", readonly = true, required = true) - private List**/.xml,
- * **/*.properties
- * @param excludes Comma separated list of file patterns to exclude i.e. **/*.xml,
- * **/*.properties
- * @param encoding Encoding of artifact. Set {@code null} for default encoding.
- * @param fileMappers {@link FileMapper}s to be used for rewriting each target path, or {@code null} if no rewriting
- * shall happen.
- * @throws MojoExecutionException In case of errors.
- */
- protected void unpack(
- Artifact artifact,
- File location,
- String includes,
- String excludes,
- String encoding,
- FileMapper[] fileMappers)
- throws MojoExecutionException {
- unpack(artifact, artifact.getType(), location, includes, excludes, encoding, fileMappers);
- }
-
- /**
- * @param artifact {@link Artifact}
- * @param type The type.
- * @param location The location.
- * @param includes includes list.
- * @param excludes excludes list.
- * @param encoding the encoding.
- * @param fileMappers {@link FileMapper}s to be used for rewriting each target path, or {@code null} if no rewriting
- * shall happen.
- * @throws MojoExecutionException in case of an error.
- */
- protected void unpack(
- Artifact artifact,
- String type,
- File location,
- String includes,
- String excludes,
- String encoding,
- FileMapper[] fileMappers)
- throws MojoExecutionException {
- File file = artifact.getFile();
- try {
- logUnpack(file, location, includes, excludes);
-
- location.mkdirs();
- if (!location.exists()) {
- throw new MojoExecutionException(
- "Location to write unpacked files to could not be created: " + location);
- }
-
- if (file.isDirectory()) {
- // usual case is a future jar packaging, but there are special cases: classifier and other packaging
- throw new MojoExecutionException("Artifact has not been packaged yet. When used on reactor artifact, "
- + "unpack should be executed after packaging: see MDEP-98.");
- }
-
- UnArchiver unArchiver;
-
- try {
- unArchiver = archiverManager.getUnArchiver(type);
- getLog().debug("Found unArchiver by type: " + unArchiver);
- } catch (NoSuchArchiverException e) {
- unArchiver = archiverManager.getUnArchiver(file);
- getLog().debug("Found unArchiver by extension: " + unArchiver);
- }
-
- if (encoding != null && unArchiver instanceof ZipUnArchiver) {
- ((ZipUnArchiver) unArchiver).setEncoding(encoding);
- getLog().info("Unpacks '" + type + "' with encoding '" + encoding + "'.");
- }
-
- unArchiver.setIgnorePermissions(ignorePermissions);
-
- unArchiver.setSourceFile(file);
-
- unArchiver.setDestDirectory(location);
-
- if (StringUtils.isNotEmpty(excludes) || StringUtils.isNotEmpty(includes)) {
- // Create the selectors that will filter
- // based on include/exclude parameters
- // MDEP-47
- IncludeExcludeFileSelector[] selectors =
- new IncludeExcludeFileSelector[] {new IncludeExcludeFileSelector()};
-
- if (StringUtils.isNotEmpty(excludes)) {
- selectors[0].setExcludes(excludes.split(","));
- }
-
- if (StringUtils.isNotEmpty(includes)) {
- selectors[0].setIncludes(includes.split(","));
- }
-
- unArchiver.setFileSelectors(selectors);
- }
- if (this.silent) {
- silenceUnarchiver(unArchiver);
- }
-
- unArchiver.setFileMappers(fileMappers);
-
- unArchiver.extract();
- } catch (NoSuchArchiverException e) {
- throw new MojoExecutionException("Unknown archiver type", e);
- } catch (ArchiverException e) {
- throw new MojoExecutionException("Error unpacking file: " + file + " to: " + location, e);
- }
- buildContext.refresh(location);
- }
-
- private void silenceUnarchiver(UnArchiver unArchiver) {
- // dangerous but handle any errors. It's the only way to silence the unArchiver.
- try {
- Field field = ReflectionUtils.getFieldByNameIncludingSuperclasses("logger", unArchiver.getClass());
-
- field.setAccessible(true);
-
- field.set(unArchiver, this.getLog());
- } catch (Exception e) {
- // was a nice try. Don't bother logging because the log is silent.
- }
- }
-
- /**
- * @return Returns a new ProjectBuildingRequest populated from the current session and the current project remote
- * repositories, used to resolve artifacts.
- */
- public ProjectBuildingRequest newResolveArtifactProjectBuildingRequest() {
- return newProjectBuildingRequest(remoteRepositories);
- }
-
- /**
- * @return Returns a new ProjectBuildingRequest populated from the current session and the current project remote
- * repositories, used to resolve plugins.
- */
- protected ProjectBuildingRequest newResolvePluginProjectBuildingRequest() {
- return newProjectBuildingRequest(remotePluginRepositories);
- }
-
- private ProjectBuildingRequest newProjectBuildingRequest(List
+ * central::default::https://repo.maven.apache.org/maven2,myrepo::https://repo.acme.com,https://repo.acme2.com
+ *
+ *
+ * @since 3.1.3
*/
- @Parameter(property = "artifact")
- private String artifact;
-
- @Parameter(defaultValue = "${project.remoteArtifactRepositories}", readonly = true, required = true)
- private Listtrue if all projects in the reactor should be purged, false otherwise.
+ * @return true if all projects in the reactor should be purged, false otherwise
*/
private boolean shouldPurgeAllProjectsInReactor() {
Source source = mojoExecution.getSource();
@@ -330,9 +340,9 @@ private boolean shouldPurgeAllProjectsInReactor() {
/**
* Purges the local repository for the dependencies in the given Maven project.
*
- * @param theProject Maven project.
- * @param purgedArtifacts The artifacts that were already purged.
- * @throws MojoFailureException in case of errors during the purge.
+ * @param theProject maven project
+ * @param purgedArtifacts the artifacts that were already purged
+ * @throws MojoFailureException in case of errors during the purge
*/
private void purgeLocalRepository(MavenProject theProject, Set
* Non-test scoped list will be not affected.
*/
@Parameter(property = "ignoreNonCompile", defaultValue = "false")
private boolean ignoreNonCompile;
/**
- * Ignore Runtime scope for unused dependency analysis.
+ * Ignore runtime scope for unused dependency analysis.
*
* @since 3.2.0
*/
@@ -143,7 +129,7 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo implements Contex
private String scriptableFlag;
/**
- * Flag to use for scriptable output
+ * Flag to use for scriptable output.
*
* @since 2.0-alpha-5
*/
@@ -151,7 +137,7 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo implements Contex
private File baseDir;
/**
- * Target folder
+ * Target folder.
*
* @since 2.0-alpha-5
*/
@@ -215,7 +201,7 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo implements Contex
private String[] ignoredUsedUndeclaredDependencies = new String[0];
/**
- * List of dependencies that will be ignored if they are declared but unused. The filter syntax is:
+ * List of dependencies that are ignored if they are declared but unused. The filter syntax is:
*
*
* [groupId]:[artifactId]:[type]:[version]
@@ -224,17 +210,22 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo implements Contex
* where each pattern segment is optional and supports full and partial * wildcards. An empty pattern
* segment is treated as an implicit wildcard. *
*
- * For example, org.apache.* will match all artifacts whose group id starts with
- * org.apache., and :::*-SNAPSHOT will match all snapshot artifacts.
+ * For example, org.apache.* matches all artifacts whose group id starts with
+ * org.apache., and :::*-SNAPSHOT matches all snapshot artifacts.
*
*
+ * Certain dependencies that are known to be used and loaded by reflection
+ * are always ignored. This includes {@code org.slf4j:slf4j-simple::}.
+ *
* @since 2.10
*/
@Parameter
private String[] ignoredUnusedDeclaredDependencies = new String[0];
+ private String[] unconditionallyIgnoredDeclaredDependencies = {"org.slf4j:slf4j-simple::"};
+
/**
- * List of dependencies that will be ignored if they are in not test scope but are only used in test classes.
+ * List of dependencies that are ignored if they are in not test scope but are only used in test classes.
* The filter syntax is:
*
*
@@ -244,14 +235,14 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo implements Contex
* where each pattern segment is optional and supports full and partial * wildcards. An empty pattern
* segment is treated as an implicit wildcard. *
*
- * For example, org.apache.* will match all artifacts whose group id starts with
+ * For example, org.apache.* matched all artifacts whose group id starts with
* org.apache., and :::*-SNAPSHOT will match all snapshot artifacts.
*
*
* @since 3.3.0
*/
- @Parameter
- private String[] ignoredNonTestScopedDependencies = new String[0];
+ @Parameter(defaultValue = "org.slf4j:slf4j-simple::")
+ private String[] ignoredNonTestScopedDependencies;
/**
* List of project packaging that will be ignored.
@@ -260,10 +251,32 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo implements Contex
*
* @since 3.2.1
*/
- // defaultValue value on @Parameter - not work with Maven 3.2.5
- // When is set defaultValue always win, and there is no possibility to override by plugin configuration.
- @Parameter
- private List ignoredPackagings = Arrays.asList("pom", "ear");
+ @Parameter(defaultValue = "pom,ear")
+ private List ignoredPackagings;
+
+ /**
+ * List of class patterns excluded from analyze. Java regular expression pattern is applied to full class name.
+ *
+ * @since 3.7.0
+ */
+ @Parameter(property = "mdep.analyze.excludedClasses")
+ private Set excludedClasses;
+
+ /**
+ * The plexusContainer to look up the {@link ProjectDependencyAnalyzer} implementation depending on the mojo
+ * configuration.
+ */
+ private final PlexusContainer plexusContainer;
+
+ /**
+ * The Maven project to analyze.
+ */
+ private final MavenProject project;
+
+ protected AbstractAnalyzeMojo(PlexusContainer plexusContainer, MavenProject project) {
+ this.plexusContainer = plexusContainer;
+ this.project = project;
+ }
// Mojo methods -----------------------------------------------------------
@@ -296,23 +309,18 @@ public void execute() throws MojoExecutionException, MojoFailureException {
/**
* @return {@link ProjectDependencyAnalyzer}
- * @throws MojoExecutionException in case of an error.
+ * @throws MojoExecutionException in case of an error
*/
protected ProjectDependencyAnalyzer createProjectDependencyAnalyzer() throws MojoExecutionException {
+
try {
- final PlexusContainer container = (PlexusContainer) context.get(PlexusConstants.PLEXUS_KEY);
- return container.lookup(ProjectDependencyAnalyzer.class, analyzer);
- } catch (Exception exception) {
+ return plexusContainer.lookup(ProjectDependencyAnalyzer.class, analyzer);
+ } catch (ComponentLookupException exception) {
throw new MojoExecutionException(
"Failed to instantiate ProjectDependencyAnalyser" + " / role-hint " + analyzer, exception);
}
}
- @Override
- public void contextualize(Context theContext) {
- this.context = theContext;
- }
-
/**
* @return {@link #skip}
*/
@@ -325,7 +333,7 @@ protected final boolean isSkip() {
private boolean checkDependencies() throws MojoExecutionException {
ProjectDependencyAnalysis analysis;
try {
- analysis = createProjectDependencyAnalyzer().analyze(project);
+ analysis = createProjectDependencyAnalyzer().analyze(project, excludedClasses);
if (usedDependencies != null) {
analysis = analysis.forceDeclaredDependenciesUsage(usedDependencies);
@@ -358,6 +366,7 @@ private boolean checkDependencies() throws MojoExecutionException {
ignoredUnusedDeclared.addAll(filterDependencies(unusedDeclared, ignoredDependencies));
ignoredUnusedDeclared.addAll(filterDependencies(unusedDeclared, ignoredUnusedDeclaredDependencies));
+ ignoredUnusedDeclared.addAll(filterDependencies(unusedDeclared, unconditionallyIgnoredDeclaredDependencies));
if (ignoreAllNonTestScoped) {
ignoredNonTestScope.addAll(filterDependencies(nonTestScope, new String[] {"*"}));
@@ -380,7 +389,7 @@ private boolean checkDependencies() throws MojoExecutionException {
logDependencyWarning("Used undeclared dependencies found:");
if (verbose) {
- logArtifacts(usedUndeclaredWithClasses, true);
+ logArtifacts(usedUndeclaredWithClasses);
} else {
logArtifacts(usedUndeclaredWithClasses.keySet(), true);
}
@@ -461,7 +470,7 @@ private void logArtifacts(Set artifacts, boolean warn) {
}
}
- private void logArtifacts(Map> artifacts, boolean warn) {
+ private void logArtifacts(Map> artifacts) {
if (artifacts.isEmpty()) {
getLog().info(" None");
} else {
@@ -469,16 +478,9 @@ private void logArtifacts(Map> artifacts, boolean warn) {
// called because artifact will set the version to -SNAPSHOT only if I do this. MNG-2961
entry.getKey().isSnapshot();
- if (warn) {
- logDependencyWarning(" " + entry.getKey());
- for (String clazz : entry.getValue()) {
- logDependencyWarning(" class " + clazz);
- }
- } else {
- getLog().info(" " + entry.getKey());
- for (String clazz : entry.getValue()) {
- getLog().info(" class " + clazz);
- }
+ logDependencyWarning(" " + entry.getKey());
+ for (String clazz : entry.getValue()) {
+ logDependencyWarning(" class " + clazz);
}
}
}
@@ -500,9 +502,6 @@ private void writeDependencyXML(Set artifacts) {
PrettyPrintXMLWriter writer = new PrettyPrintXMLWriter(out);
for (Artifact artifact : artifacts) {
- // called because artifact will set the version to -SNAPSHOT only if I do this. MNG-2961
- artifact.isSnapshot();
-
writer.startElement("dependency");
writer.startElement("groupId");
writer.writeText(artifact.getGroupId());
@@ -513,7 +512,7 @@ private void writeDependencyXML(Set artifacts) {
writer.startElement("version");
writer.writeText(artifact.getBaseVersion());
String classifier = artifact.getClassifier();
- if (StringUtils.isNotBlank(classifier)) {
+ if (classifier != null && !classifier.trim().isEmpty()) {
writer.startElement("classifier");
writer.writeText(artifact.getClassifier());
writer.endElement();
diff --git a/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDepMgt.java b/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDepMgt.java
index afb52f999..1df1d74a4 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDepMgt.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDepMgt.java
@@ -18,6 +18,8 @@
*/
package org.apache.maven.plugins.dependency.analyze;
+import javax.inject.Inject;
+
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashSet;
@@ -25,6 +27,7 @@
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
+
import org.apache.maven.artifact.Artifact;
import org.apache.maven.model.Dependency;
import org.apache.maven.model.DependencyManagement;
@@ -36,7 +39,6 @@
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;
-import org.codehaus.plexus.util.StringUtils;
/**
* This mojo looks at the dependencies after final resolution and looks for mismatches in your dependencyManagement
@@ -50,11 +52,7 @@
public class AnalyzeDepMgt extends AbstractMojo {
// fields -----------------------------------------------------------------
- /**
- *
- */
- @Parameter(defaultValue = "${project}", readonly = true, required = true)
- private MavenProject project;
+ private final MavenProject project;
/**
* Fail the build if a problem is detected.
@@ -76,6 +74,11 @@ public class AnalyzeDepMgt extends AbstractMojo {
@Parameter(property = "mdep.analyze.skip", defaultValue = "false")
private boolean skip;
+ @Inject
+ public AnalyzeDepMgt(MavenProject project) {
+ this.project = project;
+ }
+
// Mojo methods -----------------------------------------------------------
/*
@@ -102,7 +105,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
/**
* Does the work of checking the DependencyManagement Section.
*
- * @return true if errors are found.
+ * @return true if errors are found
* @throws MojoExecutionException
*/
private boolean checkDependencyManagement() throws MojoExecutionException {
@@ -142,7 +145,7 @@ private boolean checkDependencyManagement() throws MojoExecutionException {
// log exclusion errors
List exclusionErrors = getExclusionErrors(exclusions, allDependencyArtifacts);
for (Artifact exclusion : exclusionErrors) {
- getLog().info(StringUtils.stripEnd(getArtifactManagementKey(exclusion), ":")
+ getLog().info(getArtifactManagementKey(exclusion)
+ " was excluded in DepMgt, but version " + exclusion.getVersion()
+ " has been found in the dependency tree.");
foundError = true;
@@ -167,8 +170,8 @@ private boolean checkDependencyManagement() throws MojoExecutionException {
/**
* Returns a map of the exclusions using the Dependency ManagementKey as the keyset.
*
- * @param exclusionList to be added to the map.
- * @return a map of the exclusions using the Dependency ManagementKey as the keyset.
+ * @param exclusionList to be added to the map
+ * @return a map of the exclusions using the Dependency ManagementKey as the keyset
*/
public Map addExclusions(List exclusionList) {
if (exclusionList != null) {
@@ -181,9 +184,9 @@ public Map addExclusions(List exclusionList) {
* Returns a List of the artifacts that should have been excluded, but were found in the dependency tree.
*
* @param exclusions a map of the DependencyManagement exclusions, with the ManagementKey as the key and Dependency
- * as the value.
- * @param allDependencyArtifacts resolved artifacts to be compared.
- * @return list of artifacts that should have been excluded.
+ * as the value
+ * @param allDependencyArtifacts resolved artifacts to be compared
+ * @return list of artifacts that should have been excluded
*/
public List getExclusionErrors(Map exclusions, Set allDependencyArtifacts) {
return allDependencyArtifacts.stream()
@@ -193,26 +196,26 @@ public List getExclusionErrors(Map exclusions, Set<
/**
* @param artifact {@link Artifact}
- * @return The resulting GA.
+ * @return the resulting GA
*/
public String getExclusionKey(Artifact artifact) {
return artifact.getGroupId() + ":" + artifact.getArtifactId();
}
/**
- * @param ex The exclusion key.
- * @return The resulting combination of groupId+artifactId.
+ * @param ex the exclusion key
+ * @return the resulting combination of groupId+artifactId
*/
public String getExclusionKey(Exclusion ex) {
return ex.getGroupId() + ":" + ex.getArtifactId();
}
/**
- * Calculate the mismatches between the DependencyManagement and resolved artifacts
+ * Calculate the mismatches between the DependencyManagement and resolved artifacts.
*
- * @param depMgtMap contains the Dependency.GetManagementKey as the keyset for quick lookup.
- * @param allDependencyArtifacts contains the set of all artifacts to compare.
- * @return a map containing the resolved artifact as the key and the listed dependency as the value.
+ * @param depMgtMap a keyset of the Dependency.GetManagementKey for quick lookup
+ * @param allDependencyArtifacts the set of all artifacts to compare
+ * @return a map containing the resolved artifact as the key and the listed dependency as the value
*/
public Map getMismatch(
Map depMgtMap, Set allDependencyArtifacts) {
@@ -221,9 +224,6 @@ public Map getMismatch(
for (Artifact dependencyArtifact : allDependencyArtifacts) {
Dependency depFromDepMgt = depMgtMap.get(getArtifactManagementKey(dependencyArtifact));
if (depFromDepMgt != null) {
- // workaround for MNG-2961
- dependencyArtifact.isSnapshot();
-
if (depFromDepMgt.getVersion() != null
&& !depFromDepMgt.getVersion().equals(dependencyArtifact.getBaseVersion())) {
mismatchMap.put(dependencyArtifact, depFromDepMgt);
@@ -237,9 +237,9 @@ public Map getMismatch(
* This function displays the log to the screen showing the versions and information about the artifacts that don't
* match.
*
- * @param dependencyArtifact the artifact that was resolved.
- * @param dependencyFromDepMgt the dependency listed in the DependencyManagement section.
- * @throws MojoExecutionException in case of errors.
+ * @param dependencyArtifact the artifact that was resolved
+ * @param dependencyFromDepMgt the dependency listed in the DependencyManagement section
+ * @throws MojoExecutionException in case of errors
*/
public void logMismatch(Artifact dependencyArtifact, Dependency dependencyFromDepMgt)
throws MojoExecutionException {
@@ -248,7 +248,7 @@ public void logMismatch(Artifact dependencyArtifact, Dependency dependencyFromDe
"Invalid params: Artifact: " + dependencyArtifact + " Dependency: " + dependencyFromDepMgt);
}
- getLog().info("\tDependency: " + StringUtils.stripEnd(dependencyFromDepMgt.getManagementKey(), ":"));
+ getLog().info("\tDependency: " + dependencyFromDepMgt.getManagementKey());
getLog().info("\t\tDepMgt : " + dependencyFromDepMgt.getVersion());
getLog().info("\t\tResolved: " + dependencyArtifact.getBaseVersion());
}
@@ -285,13 +285,6 @@ protected final MavenProject getProject() {
return this.project;
}
- /**
- * @param theProject the project to set
- */
- public void setProject(MavenProject theProject) {
- this.project = theProject;
- }
-
/**
* @return the ignoreDirect
*/
diff --git a/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDuplicateMojo.java b/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDuplicateMojo.java
index fe6aa8728..1d59ff8d6 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDuplicateMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDuplicateMojo.java
@@ -18,15 +18,18 @@
*/
package org.apache.maven.plugins.dependency.analyze;
+import javax.inject.Inject;
+
import java.io.IOException;
import java.io.Reader;
-import java.util.ArrayList;
import java.util.Collections;
+import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
-import org.apache.commons.collections4.CollectionUtils;
+import java.util.stream.Collectors;
+
import org.apache.maven.model.Dependency;
import org.apache.maven.model.Model;
import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
@@ -36,7 +39,7 @@
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
-import org.codehaus.plexus.util.ReaderFactory;
+import org.codehaus.plexus.util.xml.XmlStreamReader;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
/**
@@ -64,9 +67,13 @@ public class AnalyzeDuplicateMojo extends AbstractMojo {
/**
* The Maven project to analyze.
*/
- @Parameter(defaultValue = "${project}", readonly = true, required = true)
private MavenProject project;
+ @Inject
+ public AnalyzeDuplicateMojo(MavenProject project) {
+ this.project = project;
+ }
+
/**
* {@inheritDoc}
*/
@@ -79,7 +86,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
MavenXpp3Reader pomReader = new MavenXpp3Reader();
Model model;
- try (Reader reader = ReaderFactory.newXmlReader(project.getFile())) {
+ try (Reader reader = new XmlStreamReader(project.getFile())) {
model = pomReader.read(reader);
} catch (IOException | XmlPullParserException e) {
throw new MojoExecutionException("Exception: " + e.getMessage(), e);
@@ -115,7 +122,7 @@ private void createMessage(
Set duplicateDependencies, StringBuilder sb, String messageDuplicateDepInDependencies) {
if (!duplicateDependencies.isEmpty()) {
if (sb.length() > 0) {
- sb.append("\n");
+ sb.append(System.lineSeparator());
}
sb.append(messageDuplicateDepInDependencies);
for (Iterator it = duplicateDependencies.iterator(); it.hasNext(); ) {
@@ -123,21 +130,18 @@ private void createMessage(
sb.append("\to ").append(dup);
if (it.hasNext()) {
- sb.append("\n");
+ sb.append(System.lineSeparator());
}
}
}
}
private Set findDuplicateDependencies(List modelDependencies) {
- List modelDependencies2 = new ArrayList<>();
- for (Dependency dep : modelDependencies) {
- modelDependencies2.add(dep.getManagementKey());
- }
-
- // @formatter:off
- return new LinkedHashSet<>(
- CollectionUtils.disjunction(modelDependencies2, new LinkedHashSet<>(modelDependencies2)));
- // @formatter:on
+ List modelDependencies2 =
+ modelDependencies.stream().map(Dependency::getManagementKey).collect(Collectors.toList());
+ // remove one instance of each element from the list
+ modelDependencies2.removeIf(new HashSet<>(modelDependencies2)::remove);
+ // keep a single instance of each duplicate
+ return new LinkedHashSet<>(modelDependencies2);
}
}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeMojo.java b/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeMojo.java
index 84907bb60..1cab87532 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeMojo.java
@@ -18,17 +18,21 @@
*/
package org.apache.maven.plugins.dependency.analyze;
+import javax.inject.Inject;
+
import org.apache.maven.plugins.annotations.Execute;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.ResolutionScope;
+import org.apache.maven.project.MavenProject;
+import org.codehaus.plexus.PlexusContainer;
/**
* Analyzes the dependencies of this project and determines which are: used and declared; used and undeclared; unused
- * and declared. This goal is intended to be used standalone, thus it always executes the test-compile
- * phase - use the dependency:analyze-only goal instead when participating in the build lifecycle.
+ * and declared. This goal is intended to be used standalone. Thus, it always executes the test-compile
+ * phase. Use the dependency:analyze-only goal instead when participating in the build lifecycle.
*
- * By default, maven-dependency-analyzer is used
+ * By default, maven-dependency-analyzer is used
* to perform the analysis, with limitations due to the fact that it works at bytecode level, but any analyzer can be
* plugged in through analyzer parameter.
*
@@ -41,4 +45,9 @@
@Execute(phase = LifecyclePhase.TEST_COMPILE)
public class AnalyzeMojo extends AbstractAnalyzeMojo {
// subclassed to provide annotations
+
+ @Inject
+ public AnalyzeMojo(PlexusContainer plexusContainer, MavenProject project) {
+ super(plexusContainer, project);
+ }
}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeOnlyMojo.java b/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeOnlyMojo.java
index 43d1e3021..ba7d0ddd9 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeOnlyMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeOnlyMojo.java
@@ -18,9 +18,13 @@
*/
package org.apache.maven.plugins.dependency.analyze;
+import javax.inject.Inject;
+
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.ResolutionScope;
+import org.apache.maven.project.MavenProject;
+import org.codehaus.plexus.PlexusContainer;
/**
* Analyzes the dependencies of this project and determines which are: used and declared; used and undeclared; unused
@@ -28,7 +32,7 @@
* test-compile phase has been executed - use the dependency:analyze goal instead when running
* standalone.
*
- * By default, maven-dependency-analyzer is used
+ * By default, maven-dependency-analyzer is used
* to perform the analysis, with limitations due to the fact that it works at bytecode level, but any analyzer can be
* plugged in through analyzer parameter.
*
@@ -46,4 +50,9 @@
// @formatter:on
public class AnalyzeOnlyMojo extends AbstractAnalyzeMojo {
// subclassed to provide annotations
+
+ @Inject
+ public AnalyzeOnlyMojo(PlexusContainer plexusContainer, MavenProject project) {
+ super(plexusContainer, project);
+ }
}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportMojo.java b/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReport.java
similarity index 75%
rename from src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportMojo.java
rename to src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReport.java
index 5e3e40fa3..038a1fdac 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReport.java
@@ -18,10 +18,11 @@
*/
package org.apache.maven.plugins.dependency.analyze;
+import javax.inject.Inject;
+
import java.util.Locale;
-import java.util.ResourceBundle;
-import org.apache.maven.doxia.sink.Sink;
-import org.apache.maven.plugins.annotations.Component;
+import java.util.Set;
+
import org.apache.maven.plugins.annotations.Execute;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
@@ -32,6 +33,7 @@
import org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalysis;
import org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalyzer;
import org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalyzerException;
+import org.codehaus.plexus.i18n.I18N;
/**
* Analyzes the dependencies of this project and produces a report that summarizes which are: used and declared; used
@@ -41,17 +43,21 @@
*/
@Mojo(name = "analyze-report", requiresDependencyResolution = ResolutionScope.TEST, threadSafe = true)
@Execute(phase = LifecyclePhase.TEST_COMPILE)
-public class AnalyzeReportMojo extends AbstractMavenReport {
+public class AnalyzeReport extends AbstractMavenReport {
// fields -----------------------------------------------------------------
/**
* The Maven project dependency analyzer to use.
*/
- @Component
- private ProjectDependencyAnalyzer analyzer;
+ private final ProjectDependencyAnalyzer analyzer;
+
+ /**
+ * Internationalization component.
+ */
+ private final I18N i18n;
/**
- * Ignore Runtime/Provided/Test/System scopes for unused dependency analysis
+ * Ignore Runtime/Provided/Test/System scopes for unused dependency analysis.
*
* @since 2.2
*/
@@ -75,6 +81,20 @@ public class AnalyzeReportMojo extends AbstractMavenReport {
@Parameter(property = "mdep.analyze.skip", defaultValue = "false")
private boolean skip;
+ /**
+ * List Excluded classes patterns from analyze. Java regular expression pattern is applied to full class name.
+ *
+ * @since 3.7.0
+ */
+ @Parameter(property = "mdep.analyze.excludedClasses")
+ private Set excludedClasses;
+
+ @Inject
+ public AnalyzeReport(ProjectDependencyAnalyzer analyzer, I18N i18n) {
+ this.analyzer = analyzer;
+ this.i18n = i18n;
+ }
+
// Mojo methods -----------------------------------------------------------
/*
@@ -85,7 +105,7 @@ public void executeReport(Locale locale) throws MavenReportException {
// Step 1: Analyze the project
ProjectDependencyAnalysis analysis;
try {
- analysis = analyzer.analyze(project);
+ analysis = analyzer.analyze(project, excludedClasses);
if (usedDependencies != null) {
analysis = analysis.forceDeclaredDependenciesUsage(usedDependencies);
@@ -99,13 +119,9 @@ public void executeReport(Locale locale) throws MavenReportException {
analysis = analysis.ignoreNonCompile();
}
- // Step 2: Create sink and bundle
- Sink sink = getSink();
- ResourceBundle bundle = getBundle(locale);
-
// Step 3: Generate the report
- AnalyzeReportView analyzethis = new AnalyzeReportView();
- analyzethis.generateReport(analysis, sink, bundle);
+ AnalyzeReportRenderer r = new AnalyzeReportRenderer(getSink(), i18n, locale, analysis);
+ r.render();
}
// MavenReport methods ----------------------------------------------------
@@ -113,51 +129,49 @@ public void executeReport(Locale locale) throws MavenReportException {
@Override
public boolean canGenerateReport() {
if (skip) {
- getLog().info("Skipping plugin execution");
return false;
}
// Step 0: Checking pom availability
if ("pom".equals(project.getPackaging())) {
- getLog().info("Skipping pom project");
return false;
}
return true;
}
- /*
- * @see org.apache.maven.reporting.AbstractMavenReport#getOutputName()
+ /**
+ * {@inheritDoc}
*/
@Override
public String getOutputName() {
return "dependency-analysis";
}
- /*
- * @see org.apache.maven.reporting.AbstractMavenReport#getName(java.util.Locale)
+ /**
+ * {@inheritDoc}
*/
@Override
public String getName(Locale locale) {
- return getBundle(locale).getString("analyze.report.name");
+ return getI18nString(locale, "name");
}
- /*
- * @see org.apache.maven.reporting.AbstractMavenReport#getDescription(java.util.Locale)
+ /**
+ * {@inheritDoc}
*/
@Override
public String getDescription(Locale locale) {
- return getBundle(locale).getString("analyze.report.description");
+ return getI18nString(locale, "description");
}
// protected methods ------------------------------------------------------
/**
- * @param locale the current locale
- * @return The resource bundle {@link ResourceBundle}
+ * @param locale the locale
+ * @param key the key to search for
+ * @return the text appropriate for the locale
*/
- protected ResourceBundle getBundle(Locale locale) {
- return ResourceBundle.getBundle(
- "analyze-report", locale, this.getClass().getClassLoader());
+ protected String getI18nString(Locale locale, String key) {
+ return i18n.getString("analyze-report", locale, "report.analyze." + key);
}
}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportRenderer.java b/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportRenderer.java
new file mode 100644
index 000000000..af46a1b6e
--- /dev/null
+++ b/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportRenderer.java
@@ -0,0 +1,125 @@
+/*
+ * 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.plugins.dependency.analyze;
+
+import java.util.Collection;
+import java.util.Locale;
+
+import org.apache.maven.artifact.Artifact;
+import org.apache.maven.doxia.sink.Sink;
+import org.apache.maven.reporting.AbstractMavenReportRenderer;
+import org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalysis;
+import org.codehaus.plexus.i18n.I18N;
+
+/**
+ * This is the view part of the analyze-report mojo. It generates the HTML report for the project website. The HTML
+ * output is same as the CLI output.
+ */
+public class AnalyzeReportRenderer extends AbstractMavenReportRenderer {
+ private final I18N i18n;
+
+ private final Locale locale;
+
+ private final ProjectDependencyAnalysis analysis;
+
+ public AnalyzeReportRenderer(Sink sink, I18N i18n, Locale locale, ProjectDependencyAnalysis analysis) {
+ super(sink);
+ this.i18n = i18n;
+ this.locale = locale;
+ this.analysis = analysis;
+ }
+
+ @Override
+ public String getTitle() {
+ return getI18nString("title");
+ }
+
+ /**
+ * @param key the key
+ * @return the translated string
+ */
+ private String getI18nString(String key) {
+ return i18n.getString("analyze-report", locale, "report.analyze." + key);
+ }
+
+ protected void renderBody() {
+ startSection(getTitle());
+
+ boolean reported = false;
+
+ // Generate Used Declared dependencies:
+ if (!analysis.getUsedDeclaredArtifacts().isEmpty()) {
+ startSection(getI18nString("UsedDeclaredDependencies"));
+ renderDependenciesTable(sink, analysis.getUsedDeclaredArtifacts());
+ endSection();
+ reported = true;
+ }
+
+ // Generate Used Undeclared dependencies:
+
+ if (!analysis.getUsedUndeclaredArtifacts().isEmpty()) {
+ startSection(getI18nString("UsedUndeclaredDependencies"));
+ renderDependenciesTable(sink, analysis.getUsedUndeclaredArtifacts());
+ endSection();
+ reported = true;
+ }
+
+ // Generate Unused declared dependencies:
+ if (!analysis.getUnusedDeclaredArtifacts().isEmpty()) {
+ startSection(getI18nString("UnusedDeclaredDependencies"));
+ renderDependenciesTable(sink, analysis.getUnusedDeclaredArtifacts());
+ endSection();
+ reported = true;
+ }
+
+ // Generate Non-Test Scoped Test Dependencies:
+ if (!analysis.getTestArtifactsWithNonTestScope().isEmpty()) {
+ startSection(getI18nString("CompileScopeTestOnlyDependencies"));
+ renderDependenciesTable(sink, analysis.getTestArtifactsWithNonTestScope());
+ endSection();
+ reported = true;
+ }
+
+ if (!reported) {
+ text(getI18nString("noDependencyProblems"));
+ }
+
+ endSection();
+ }
+
+ private void renderDependenciesTable(Sink sink, Collection artifacts) {
+ startTable();
+
+ tableHeader(new String[] {"GroupId", "ArtifactId", "Version", "Scope", "Classifier", "Type", "Optional"});
+
+ for (Artifact artifact : artifacts) {
+ tableRow(new String[] {
+ artifact.getGroupId(),
+ artifact.getArtifactId(),
+ artifact.getVersion(),
+ artifact.getScope(),
+ artifact.getClassifier(),
+ artifact.getType(),
+ artifact.isOptional() ? "" : "false"
+ });
+ }
+
+ endTable();
+ }
+}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportView.java b/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportView.java
deleted file mode 100644
index c36cb4e38..000000000
--- a/src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportView.java
+++ /dev/null
@@ -1,215 +0,0 @@
-/*
- * 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.plugins.dependency.analyze;
-
-import java.util.Iterator;
-import java.util.ResourceBundle;
-import org.apache.maven.artifact.Artifact;
-import org.apache.maven.doxia.sink.Sink;
-import org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalysis;
-
-/**
- * This is the view part of the analyze-report mojo. It generates the HTML report for the project website. The HTML
- * output is same as the CLI output.
- */
-public class AnalyzeReportView {
- /**
- * Generates the HTML report.
- *
- * @param analysis {@link ProjectDependencyAnalysis}
- * @param sink {@link Sink}
- * @param bundle {@link ResourceBundle}
- */
- public void generateReport(ProjectDependencyAnalysis analysis, Sink sink, ResourceBundle bundle) {
- sink.head();
- sink.title();
- sink.text(bundle.getString("analyze.report.header"));
- sink.title_();
- sink.head_();
- sink.body();
-
- // Generate title
- sink.section1();
- sink.sectionTitle1();
- sink.text(bundle.getString("analyze.report.mainTitle"));
- sink.sectionTitle1_();
-
- // Generate Used Declared dependencies:
- sink.section2();
- sink.sectionTitle2();
- sink.text(bundle.getString("analyze.report.UsedDeclaredDependencies"));
- sink.sectionTitle2_();
- if (analysis.getUsedDeclaredArtifacts().isEmpty()) {
- sink.paragraph();
- sink.text(bundle.getString("analyze.report.noDependency"));
- sink.paragraph_();
- sink.horizontalRule();
- } else {
- generateDependenciesTable(sink, analysis.getUsedDeclaredArtifacts().iterator());
- }
- sink.section2_();
-
- // Generate Used Undeclared dependencies:
- sink.section2();
- sink.sectionTitle2();
- sink.text(bundle.getString("analyze.report.UsedUndeclaredDependencies"));
- sink.sectionTitle2_();
- if (analysis.getUsedUndeclaredArtifacts().isEmpty()) {
- sink.paragraph();
- sink.text(bundle.getString("analyze.report.noDependency"));
- sink.paragraph_();
- sink.horizontalRule();
- } else {
- generateDependenciesTable(
- sink, analysis.getUsedUndeclaredArtifacts().iterator());
- }
- sink.section2_();
-
- // Generate Unused declared dependencies:
- sink.section2();
- sink.sectionTitle2();
- sink.text(bundle.getString("analyze.report.UnusedDeclaredDependencies"));
- sink.sectionTitle2_();
- if (analysis.getUnusedDeclaredArtifacts().isEmpty()) {
- sink.paragraph();
- sink.text(bundle.getString("analyze.report.noDependency"));
- sink.paragraph_();
- sink.horizontalRule();
- } else {
- generateDependenciesTable(
- sink, analysis.getUnusedDeclaredArtifacts().iterator());
- }
- sink.section2_();
-
- // Generate Non-Test Scoped Test Dependencies:
- sink.section2();
- sink.sectionTitle2();
- sink.text("Compile Scoped Test Dependencies");
- sink.sectionTitle2_();
- if (analysis.getTestArtifactsWithNonTestScope().isEmpty()) {
- sink.paragraph();
- sink.text("None");
- sink.paragraph_();
- sink.horizontalRule();
- } else {
- generateDependenciesTable(
- sink, analysis.getTestArtifactsWithNonTestScope().iterator());
- }
- sink.section2_();
-
- sink.section1_();
-
- // Closing the report
- sink.body_();
- sink.flush();
- sink.close();
- }
-
- /**
- * Generate a table for the given dependencies iterator.
- *
- * @param sink {@link Sink}
- * @param iter {@link Artifact}
- */
- public void generateDependenciesTable(Sink sink, Iterator iter) {
- sink.table();
- sink.tableRows(null, false);
-
- sink.tableRow();
- sink.tableCell();
- sink.bold();
- sink.text("GroupId");
- sink.bold_();
- sink.tableCell_();
-
- sink.tableCell();
- sink.bold();
- sink.text("ArtifactId");
- sink.bold_();
- sink.tableCell_();
-
- sink.tableCell();
- sink.bold();
- sink.text("Version");
- sink.bold_();
- sink.tableCell_();
-
- sink.tableCell();
- sink.bold();
- sink.text("Scope");
- sink.bold_();
- sink.tableCell_();
-
- sink.tableCell();
- sink.bold();
- sink.text("Classifier");
- sink.bold_();
- sink.tableCell_();
-
- sink.tableCell();
- sink.bold();
- sink.text("Type");
- sink.bold_();
- sink.tableCell_();
-
- sink.tableCell();
- sink.bold();
- sink.text("Optional");
- sink.bold_();
- sink.tableCell_();
-
- sink.tableRow_();
- while (iter.hasNext()) {
- Artifact artifact = iter.next();
-
- sink.tableRow();
- sink.tableCell();
- sink.text(artifact.getGroupId());
- sink.tableCell_();
- sink.tableCell();
- sink.text(artifact.getArtifactId());
- sink.tableCell_();
- sink.tableCell();
- sink.text(artifact.getVersion());
- sink.tableCell_();
- sink.tableCell();
- sink.text(artifact.getScope());
- sink.tableCell_();
- sink.tableCell();
- sink.text(artifact.getClassifier());
- sink.tableCell_();
- sink.tableCell();
- sink.text(artifact.getType());
- sink.tableCell_();
- sink.tableCell();
- if (artifact.isOptional()) {
- sink.text("");
- } else {
- sink.text("false");
- }
-
- sink.tableCell_();
- sink.tableRow_();
- }
-
- sink.tableRows_();
- sink.table_();
- sink.horizontalRule();
- }
-}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/exclusion/AnalyzeExclusionsMojo.java b/src/main/java/org/apache/maven/plugins/dependency/exclusion/AnalyzeExclusionsMojo.java
new file mode 100644
index 000000000..e45c76c4e
--- /dev/null
+++ b/src/main/java/org/apache/maven/plugins/dependency/exclusion/AnalyzeExclusionsMojo.java
@@ -0,0 +1,187 @@
+/*
+ * 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.plugins.dependency.exclusion;
+
+import javax.inject.Inject;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.function.Consumer;
+
+import org.apache.maven.RepositoryUtils;
+import org.apache.maven.execution.MavenSession;
+import org.apache.maven.model.Dependency;
+import org.apache.maven.model.Exclusion;
+import org.apache.maven.plugin.AbstractMojo;
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.plugins.annotations.ResolutionScope;
+import org.apache.maven.plugins.dependency.utils.ResolverUtil;
+import org.apache.maven.project.MavenProject;
+import org.eclipse.aether.artifact.ArtifactTypeRegistry;
+import org.eclipse.aether.collection.DependencyCollectionException;
+
+import static java.util.stream.Collectors.toList;
+import static java.util.stream.Collectors.toSet;
+import static org.apache.maven.plugins.dependency.exclusion.Coordinates.coordinates;
+
+/**
+ * Analyzes the exclusions defined on dependencies in this project and reports if any of them are unneeded.
+ *
+ * Relevant use case is when an artifact in a later version has removed usage of a dependency, making the exclusion no
+ * longer necessary.
+ *
+ *
+ * @since 3.7.0
+ */
+@Mojo(name = "analyze-exclusions", requiresDependencyCollection = ResolutionScope.TEST, threadSafe = true)
+public class AnalyzeExclusionsMojo extends AbstractMojo {
+
+ private final MavenProject project;
+
+ private final ResolverUtil resolverUtil;
+
+ private final MavenSession session;
+
+ @Inject
+ public AnalyzeExclusionsMojo(MavenProject project, ResolverUtil resolverUtil, MavenSession session) {
+ this.project = project;
+ this.resolverUtil = resolverUtil;
+ this.session = session;
+ }
+
+ /**
+ * Whether to fail the build if invalid exclusions is found.
+ *
+ * @since 3.7.0
+ */
+ @Parameter(property = "mdep.exclusion.fail", defaultValue = "false")
+ private boolean exclusionFail;
+
+ /**
+ * Skip plugin execution completely.
+ *
+ * @since 3.7.0
+ */
+ @Parameter(property = "mdep.skip", defaultValue = "false")
+ private boolean skip;
+
+ /**
+ * Current project modelId.
+ */
+ private String projectModelId;
+
+ @Override
+ public void execute() throws MojoExecutionException {
+ if (skip) {
+ getLog().debug("Skipping execution");
+ return;
+ }
+
+ projectModelId = project.getGroupId() + ":" + project.getArtifactId() + ":" + project.getVersion();
+
+ Map> dependenciesWithExclusions = new HashMap<>();
+
+ project.getDependencyManagement().getDependencies().forEach(dependency -> {
+ Collection exclusions = getExclusionsForDependency(dependency);
+ if (!exclusions.isEmpty()) {
+ dependenciesWithExclusions
+ .computeIfAbsent(coordinates(dependency), d -> new ArrayList<>())
+ .addAll(exclusions);
+ }
+ });
+
+ project.getDependencies().forEach(dependency -> {
+ Collection exclusions = getExclusionsForDependency(dependency);
+ if (!exclusions.isEmpty()) {
+ dependenciesWithExclusions
+ .computeIfAbsent(coordinates(dependency), d -> new ArrayList<>())
+ .addAll(exclusions);
+ }
+ });
+
+ if (dependenciesWithExclusions.isEmpty()) {
+ getLog().debug("No dependencies defined with exclusions - exiting");
+ return;
+ }
+
+ ExclusionChecker checker = new ExclusionChecker();
+
+ ArtifactTypeRegistry artifactTypeRegistry =
+ session.getRepositorySession().getArtifactTypeRegistry();
+ for (Map.Entry> entry : dependenciesWithExclusions.entrySet()) {
+
+ Coordinates currentCoordinates = entry.getKey();
+
+ Collection actualDependencies;
+ try {
+ actualDependencies = resolverUtil.collectDependencies(
+ RepositoryUtils.toDependency(currentCoordinates.getDependency(), artifactTypeRegistry)
+ .setExclusions(null));
+ } catch (DependencyCollectionException e) {
+ throw new MojoExecutionException(e.getMessage(), e);
+ }
+
+ Set actualCoordinates = actualDependencies.stream()
+ .map(org.eclipse.aether.graph.Dependency::getArtifact)
+ .map(a -> coordinates(a.getGroupId(), a.getArtifactId()))
+ .collect(toSet());
+
+ Set exclusions =
+ entry.getValue().stream().map(Coordinates::coordinates).collect(toSet());
+
+ checker.check(currentCoordinates, exclusions, actualCoordinates);
+ }
+
+ if (!checker.getViolations().isEmpty()) {
+ if (exclusionFail) {
+ logViolations(project.getName(), checker.getViolations(), value -> getLog().error(value));
+ throw new MojoExecutionException("Invalid exclusions found");
+ } else {
+ logViolations(project.getName(), checker.getViolations(), value -> getLog().warn(value));
+ }
+ } else {
+ getLog().info("No problems with dependencies exclusions");
+ }
+ }
+
+ private Collection getExclusionsForDependency(Dependency dependency) {
+ return dependency.getExclusions().stream()
+ .filter(this::isExclusionInProject)
+ .collect(toList());
+ }
+
+ private boolean isExclusionInProject(Exclusion exclusion) {
+ String modelId = exclusion.getLocation("").getSource().getModelId();
+ return projectModelId.equals(modelId);
+ }
+
+ private void logViolations(String name, Map> violations, Consumer logger) {
+ logger.accept(name + " defines following unnecessary excludes");
+ violations.forEach((dependency, invalidExclusions) -> {
+ logger.accept(" " + dependency);
+ invalidExclusions.forEach(invalidExclusion -> logger.accept(" - " + invalidExclusion));
+ });
+ }
+}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/exclusion/Coordinates.java b/src/main/java/org/apache/maven/plugins/dependency/exclusion/Coordinates.java
new file mode 100644
index 000000000..d81f7b37b
--- /dev/null
+++ b/src/main/java/org/apache/maven/plugins/dependency/exclusion/Coordinates.java
@@ -0,0 +1,145 @@
+/*
+ * 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.plugins.dependency.exclusion;
+
+import java.lang.reflect.Proxy;
+import java.nio.file.FileSystems;
+import java.nio.file.Path;
+import java.nio.file.PathMatcher;
+import java.util.Objects;
+import java.util.function.Predicate;
+
+import org.apache.maven.model.Dependency;
+import org.apache.maven.model.Exclusion;
+import org.apache.maven.model.InputLocation;
+
+/**
+ * Simple "record" to hold the coordinates of the dependency which is excluded.
+ *
+ * When dealing with exclusions the version is not important. Only groupId and artifactId is used.
+ *
+ */
+class Coordinates implements Comparable {
+
+ private final String groupId;
+
+ private final String artifactId;
+
+ private final Dependency dependency;
+
+ private final InputLocation location;
+
+ private Coordinates(String groupId, String artifactId, Dependency dependency, InputLocation location) {
+ this.groupId = groupId;
+ this.artifactId = artifactId;
+ this.dependency = dependency;
+ this.location = location;
+ }
+
+ public static Coordinates coordinates(String groupId, String artifactId) {
+ return new Coordinates(groupId, artifactId, null, null);
+ }
+
+ public static Coordinates coordinates(Dependency dependency) {
+ return new Coordinates(dependency.getGroupId(), dependency.getArtifactId(), dependency, null);
+ }
+
+ public static Coordinates coordinates(Exclusion exclusion) {
+ return new Coordinates(exclusion.getGroupId(), exclusion.getArtifactId(), null, exclusion.getLocation(""));
+ }
+
+ public String getGroupId() {
+ return groupId;
+ }
+
+ public String getArtifactId() {
+ return artifactId;
+ }
+
+ public Dependency getDependency() {
+ return dependency;
+ }
+
+ Predicate getExclusionPattern() {
+ PathMatcher groupId = FileSystems.getDefault().getPathMatcher("glob:" + getGroupId());
+ PathMatcher artifactId = FileSystems.getDefault().getPathMatcher("glob:" + getArtifactId());
+ Predicate predGroupId = a -> groupId.matches(createPathProxy(a.getGroupId()));
+ Predicate predArtifactId = a -> artifactId.matches(createPathProxy(a.getArtifactId()));
+
+ return predGroupId.and(predArtifactId);
+ }
+
+ /**
+ * In order to reuse the glob matcher from the filesystem, we need
+ * to create Path instances. Those are only used with the toString method.
+ * This hack works because the only system-dependent thing is the path
+ * separator which should not be part of the groupId or artifactId.
+ */
+ private static Path createPathProxy(String value) {
+ return (Path) Proxy.newProxyInstance(
+ Coordinates.class.getClassLoader(), new Class[] {Path.class}, (proxy1, method, args) -> {
+ if ("toString".equals(method.getName())) {
+ return value;
+ }
+ throw new UnsupportedOperationException();
+ });
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }
+ Coordinates that = (Coordinates) o;
+ return Objects.equals(groupId, that.groupId)
+ && Objects.equals(artifactId, that.artifactId)
+ && Objects.equals(location, that.location);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(groupId, artifactId, location);
+ }
+
+ @Override
+ public int compareTo(Coordinates that) {
+
+ if (location != null && that.location != null) {
+ return location.getLineNumber() - that.location.getLineNumber();
+ }
+
+ return toString().compareTo(that.toString());
+ }
+
+ @Override
+ public String toString() {
+ String version = "";
+ if (dependency != null) {
+ version = ":" + dependency.getVersion();
+ }
+ String line = "";
+ if (location != null) {
+ line = " @ line: " + location.getLineNumber();
+ }
+ return groupId + ":" + artifactId + version + line;
+ }
+}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/exclusion/ExclusionChecker.java b/src/main/java/org/apache/maven/plugins/dependency/exclusion/ExclusionChecker.java
new file mode 100644
index 000000000..1340461b7
--- /dev/null
+++ b/src/main/java/org/apache/maven/plugins/dependency/exclusion/ExclusionChecker.java
@@ -0,0 +1,46 @@
+/*
+ * 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.plugins.dependency.exclusion;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.TreeMap;
+
+import static java.util.stream.Collectors.toList;
+
+class ExclusionChecker {
+
+ private final Map> violations = new TreeMap<>();
+
+ Map> getViolations() {
+ return violations;
+ }
+
+ void check(Coordinates artifact, Set excludes, Set actualDependencies) {
+ List invalidExclusions = excludes.stream()
+ .filter(exclude -> actualDependencies.stream().noneMatch(exclude.getExclusionPattern()))
+ .sorted()
+ .collect(toList());
+
+ if (!invalidExclusions.isEmpty()) {
+ violations.put(artifact, invalidExclusions);
+ }
+ }
+}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java
index 6e6dd5271..88914298e 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java
@@ -22,29 +22,37 @@
import java.util.Collections;
import java.util.List;
import java.util.Objects;
+
+import org.apache.commons.lang3.StringUtils;
+import org.apache.maven.RepositoryUtils;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.handler.ArtifactHandler;
import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
import org.apache.maven.model.Dependency;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
-import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.dependency.AbstractDependencyMojo;
import org.apache.maven.plugins.dependency.utils.DependencyUtil;
import org.apache.maven.plugins.dependency.utils.filters.ArtifactItemFilter;
import org.apache.maven.project.MavenProject;
-import org.apache.maven.project.ProjectBuildingRequest;
import org.apache.maven.shared.artifact.filter.collection.ArtifactFilterException;
-import org.apache.maven.shared.transfer.artifact.DefaultArtifactCoordinate;
-import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver;
-import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolverException;
-import org.apache.maven.shared.transfer.repository.RepositoryManager;
-import org.codehaus.plexus.util.StringUtils;
+import org.eclipse.aether.DefaultRepositoryCache;
+import org.eclipse.aether.DefaultRepositorySystemSession;
+import org.eclipse.aether.RepositorySystem;
+import org.eclipse.aether.RepositorySystemSession;
+import org.eclipse.aether.artifact.DefaultArtifact;
+import org.eclipse.aether.repository.LocalRepository;
+import org.eclipse.aether.repository.LocalRepositoryManager;
+import org.eclipse.aether.resolution.ArtifactRequest;
+import org.eclipse.aether.resolution.ArtifactResolutionException;
+import org.eclipse.aether.resolution.ArtifactResult;
+import org.sonatype.plexus.build.incremental.BuildContext;
/**
* Abstract parent class used by mojos that get Artifact information from the plugin configuration as an ArrayList of
- * ArtifactItems
+ * ArtifactItems.
*
* @author Brian Fox
* @see ArtifactItem
@@ -59,7 +67,7 @@ public abstract class AbstractFromConfigurationMojo extends AbstractDependencyMo
private File outputDirectory;
/**
- * Overwrite release artifacts
+ * Overwrite release artifacts.
*
* @since 1.0
*/
@@ -67,7 +75,7 @@ public abstract class AbstractFromConfigurationMojo extends AbstractDependencyMo
private boolean overWriteReleases;
/**
- * Overwrite snapshot artifacts
+ * Overwrite snapshot artifacts.
*
* @since 1.0
*/
@@ -75,11 +83,21 @@ public abstract class AbstractFromConfigurationMojo extends AbstractDependencyMo
private boolean overWriteSnapshots;
/**
- * Overwrite if newer
+ * Overwrite if newer.
*
* @since 2.0
+ * @deprecated use 'overWriteIfNewer' or 'mdep.overWriteIfNewer' as this does nothing now
*/
+ @Deprecated
@Parameter(property = "mdep.overIfNewer", defaultValue = "true")
+ private boolean overIfNewer;
+
+ /**
+ * Overwrite if newer.
+ *
+ * @since 3.7.0
+ */
+ @Parameter(property = "mdep.overWriteIfNewer", defaultValue = "true")
private boolean overWriteIfNewer;
/**
@@ -93,28 +111,34 @@ public abstract class AbstractFromConfigurationMojo extends AbstractDependencyMo
/**
* Path to override default local repository during plugin's execution. To remove all downloaded artifacts as part
- * of the build, set this value to a location under your project's target directory
+ * of the build, set this value to a location under your project's target directory.
*
* @since 2.2
*/
@Parameter
private File localRepositoryDirectory;
- @Component
- private ArtifactResolver artifactResolver;
+ private final ArtifactHandlerManager artifactHandlerManager;
- @Component
- private RepositoryManager repositoryManager;
+ private final RepositorySystem repositorySystem;
- @Component
- private ArtifactHandlerManager artifactHandlerManager;
+ protected AbstractFromConfigurationMojo(
+ MavenSession session,
+ BuildContext buildContext,
+ MavenProject project,
+ ArtifactHandlerManager artifactHandlerManager,
+ RepositorySystem repositorySystem) {
+ super(session, buildContext, project);
+ this.artifactHandlerManager = artifactHandlerManager;
+ this.repositorySystem = repositorySystem;
+ }
abstract ArtifactItemFilter getMarkedArtifactFilter(ArtifactItem item);
/**
- * artifactItems is filled by either field injection or by setArtifact().
+ * ArtifactItems is filled by either field injection or by setArtifact().
*
- * @throws MojoFailureException in case of an error.
+ * @throws MojoFailureException in case of an error
*/
protected void verifyRequirements() throws MojoFailureException {
if (artifactItems == null || artifactItems.isEmpty()) {
@@ -127,25 +151,25 @@ protected void verifyRequirements() throws MojoFailureException {
* output Directory if it doesn't exist.
*
* @param processArtifactItemsRequest preprocessing instructions
- * @return An ArrayList of preprocessed ArtifactItems
- * @throws MojoExecutionException with a message if an error occurs.
+ * @return an ArrayList of preprocessed ArtifactItems
+ * @throws MojoExecutionException with a message if an error occurs
* @see ArtifactItem
*/
protected List getProcessedArtifactItems(ProcessArtifactItemsRequest processArtifactItemsRequest)
throws MojoExecutionException {
- boolean removeVersion = processArtifactItemsRequest.isRemoveVersion(),
- prependGroupId = processArtifactItemsRequest.isPrependGroupId(),
- useBaseVersion = processArtifactItemsRequest.isUseBaseVersion();
+ boolean removeVersion = processArtifactItemsRequest.isRemoveVersion();
+ boolean prependGroupId = processArtifactItemsRequest.isPrependGroupId();
+ boolean useBaseVersion = processArtifactItemsRequest.isUseBaseVersion();
boolean removeClassifier = processArtifactItemsRequest.isRemoveClassifier();
- if (artifactItems == null || artifactItems.size() < 1) {
+ if (artifactItems == null || artifactItems.isEmpty()) {
throw new MojoExecutionException("There are no artifactItems configured.");
}
for (ArtifactItem artifactItem : artifactItems) {
- this.getLog().info("Configured Artifact: " + artifactItem.toString());
+ this.getLog().debug("Configured Artifact: " + artifactItem.toString());
if (artifactItem.getOutputDirectory() == null) {
artifactItem.setOutputDirectory(this.outputDirectory);
@@ -153,13 +177,14 @@ protected List getProcessedArtifactItems(ProcessArtifactItemsReque
artifactItem.getOutputDirectory().mkdirs();
// make sure we have a version.
- if (StringUtils.isEmpty(artifactItem.getVersion())) {
+ if (artifactItem.getVersion() == null || artifactItem.getVersion().isEmpty()) {
fillMissingArtifactVersion(artifactItem);
}
artifactItem.setArtifact(this.getArtifact(artifactItem));
- if (StringUtils.isEmpty(artifactItem.getDestFileName())) {
+ if (artifactItem.getDestFileName() == null
+ || artifactItem.getDestFileName().isEmpty()) {
artifactItem.setDestFileName(DependencyUtil.getFormattedFileName(
artifactItem.getArtifact(), removeVersion, prependGroupId, useBaseVersion, removeClassifier));
}
@@ -173,64 +198,67 @@ protected List getProcessedArtifactItems(ProcessArtifactItemsReque
return artifactItems;
}
- private boolean checkIfProcessingNeeded(ArtifactItem item) throws MojoExecutionException, ArtifactFilterException {
- return StringUtils.equalsIgnoreCase(item.getOverWrite(), "true")
+ private boolean checkIfProcessingNeeded(ArtifactItem item) throws ArtifactFilterException {
+ return "true".equalsIgnoreCase(item.getOverWrite())
|| getMarkedArtifactFilter(item).isArtifactIncluded(item);
}
+ private RepositorySystemSession createSystemSessionForLocalRepo() {
+ RepositorySystemSession repositorySystemSession = session.getRepositorySession();
+ if (localRepositoryDirectory != null) {
+ // "clone" repository session and replace localRepository
+ DefaultRepositorySystemSession newSession =
+ new DefaultRepositorySystemSession(session.getRepositorySession());
+ // Clear cache, since we're using a new local repository
+ newSession.setCache(new DefaultRepositoryCache());
+ LocalRepositoryManager localRepositoryManager = repositorySystem.newLocalRepositoryManager(
+ newSession, new LocalRepository(localRepositoryDirectory));
+
+ newSession.setLocalRepositoryManager(localRepositoryManager);
+ repositorySystemSession = newSession;
+ getLog().debug("localRepoPath: "
+ + localRepositoryManager.getRepository().getBasedir());
+ }
+
+ return repositorySystemSession;
+ }
+
/**
* Resolves the Artifact from the remote repository if necessary. If no version is specified, it will be retrieved
* from the dependency list or from the DependencyManagement section of the pom.
*
- * @param artifactItem containing information about artifact from plugin configuration.
- * @return Artifact object representing the specified file.
- * @throws MojoExecutionException with a message if the version can't be found in DependencyManagement.
+ * @param artifactItem containing information about artifact from plugin configuration
+ * @return artifact object representing the specified file
+ * @throws MojoExecutionException if the version can't be found in DependencyManagement
*/
protected Artifact getArtifact(ArtifactItem artifactItem) throws MojoExecutionException {
- Artifact artifact;
try {
- // mdep-50 - rolledback for now because it's breaking some functionality.
- /*
- * List listeners = new ArrayList(); Set theSet = new HashSet(); theSet.add( artifact );
- * ArtifactResolutionResult artifactResolutionResult = artifactCollector.collect( theSet, project
- * .getArtifact(), managedVersions, this.local, project.getRemoteArtifactRepositories(),
- * artifactMetadataSource, null, listeners ); Iterator iter =
- * artifactResolutionResult.getArtifactResolutionNodes().iterator(); while ( iter.hasNext() ) {
- * ResolutionNode node = (ResolutionNode) iter.next(); artifact = node.getArtifact(); }
- */
-
- ProjectBuildingRequest buildingRequest = newResolveArtifactProjectBuildingRequest();
-
- if (localRepositoryDirectory != null) {
- buildingRequest =
- repositoryManager.setLocalRepositoryBasedir(buildingRequest, localRepositoryDirectory);
- }
-
- // Map dependency to artifact coordinate
- DefaultArtifactCoordinate coordinate = new DefaultArtifactCoordinate();
- coordinate.setGroupId(artifactItem.getGroupId());
- coordinate.setArtifactId(artifactItem.getArtifactId());
- coordinate.setVersion(artifactItem.getVersion());
- coordinate.setClassifier(artifactItem.getClassifier());
-
final String extension;
+
ArtifactHandler artifactHandler = artifactHandlerManager.getArtifactHandler(artifactItem.getType());
if (artifactHandler != null) {
extension = artifactHandler.getExtension();
} else {
extension = artifactItem.getType();
}
- coordinate.setExtension(extension);
- artifact = artifactResolver
- .resolveArtifact(buildingRequest, coordinate)
- .getArtifact();
- } catch (ArtifactResolverException e) {
+ DefaultArtifact artifact = new DefaultArtifact(
+ artifactItem.getGroupId(),
+ artifactItem.getArtifactId(),
+ artifactItem.getClassifier(),
+ extension,
+ artifactItem.getVersion());
+
+ RepositorySystemSession repositorySession = createSystemSessionForLocalRepo();
+
+ ArtifactRequest request = new ArtifactRequest(artifact, getProject().getRemoteProjectRepositories(), null);
+ ArtifactResult artifactResult = repositorySystem.resolveArtifact(repositorySession, request);
+ return RepositoryUtils.toArtifact(artifactResult.getArtifact());
+
+ } catch (ArtifactResolutionException e) {
throw new MojoExecutionException("Unable to find/resolve artifact.", e);
}
-
- return artifact;
}
/**
@@ -238,7 +266,7 @@ protected Artifact getArtifact(ArtifactItem artifactItem) throws MojoExecutionEx
* with the correct version. It will first look for an exact match on artifactId/groupId/classifier/type and if it
* doesn't find a match, it will try again looking for artifactId and groupId only.
*
- * @param artifact representing configured file.
+ * @param artifact representing configured file
* @throws MojoExecutionException
*/
private void fillMissingArtifactVersion(ArtifactItem artifact) throws MojoExecutionException {
@@ -261,8 +289,8 @@ private void fillMissingArtifactVersion(ArtifactItem artifact) throws MojoExecut
* Tries to find missing version from a list of dependencies. If found, the artifact is updated with the correct
* version.
*
- * @param artifact representing configured file.
- * @param dependencies list of dependencies to search.
+ * @param artifact representing configured file
+ * @param dependencies list of dependencies to search
* @param looseMatch only look at artifactId and groupId
* @return the found dependency
*/
@@ -282,70 +310,70 @@ private boolean findDependencyVersion(ArtifactItem artifact, List de
}
/**
- * @return Returns the artifactItems.
+ * @return returns the artifactItems
*/
public List getArtifactItems() {
return this.artifactItems;
}
/**
- * @param theArtifactItems The artifactItems to set.
+ * @param theArtifactItems the artifactItems to set
*/
public void setArtifactItems(List theArtifactItems) {
this.artifactItems = theArtifactItems;
}
/**
- * @return Returns the outputDirectory.
+ * @return returns the outputDirectory
*/
public File getOutputDirectory() {
return this.outputDirectory;
}
/**
- * @param theOutputDirectory The outputDirectory to set.
+ * @param theOutputDirectory the outputDirectory to set
*/
public void setOutputDirectory(File theOutputDirectory) {
this.outputDirectory = theOutputDirectory;
}
/**
- * @return Returns the overWriteIfNewer.
+ * @return returns the overWriteIfNewer
*/
public boolean isOverWriteIfNewer() {
return this.overWriteIfNewer;
}
/**
- * @param theOverWriteIfNewer The overWriteIfNewer to set.
+ * @param theOverWriteIfNewer the overWriteIfNewer to set
*/
public void setOverWriteIfNewer(boolean theOverWriteIfNewer) {
this.overWriteIfNewer = theOverWriteIfNewer;
}
/**
- * @return Returns the overWriteReleases.
+ * @return returns the overWriteReleases
*/
public boolean isOverWriteReleases() {
return this.overWriteReleases;
}
/**
- * @param theOverWriteReleases The overWriteReleases to set.
+ * @param theOverWriteReleases the overWriteReleases to set
*/
public void setOverWriteReleases(boolean theOverWriteReleases) {
this.overWriteReleases = theOverWriteReleases;
}
/**
- * @return Returns the overWriteSnapshots.
+ * @return returns the overWriteSnapshots
*/
public boolean isOverWriteSnapshots() {
return this.overWriteSnapshots;
}
/**
- * @param theOverWriteSnapshots The overWriteSnapshots to set.
+ * @param theOverWriteSnapshots the overWriteSnapshots to set
*/
public void setOverWriteSnapshots(boolean theOverWriteSnapshots) {
this.overWriteSnapshots = theOverWriteSnapshots;
@@ -359,8 +387,8 @@ public void setLocalRepositoryDirectory(File localRepositoryDirectory) {
}
/**
- * @param artifact The artifact.
- * @throws MojoFailureException in case of an error.
+ * @param artifact the artifact
+ * @throws MojoFailureException in case of an error
*/
public void setArtifact(String artifact) throws MojoFailureException {
if (artifact != null) {
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java
index 214ca924a..4fbea1c3f 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java
@@ -20,8 +20,10 @@
import java.io.File;
import java.util.Objects;
+
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.ArtifactUtils;
+import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.dependency.utils.DependencyUtil;
import org.apache.maven.shared.transfer.dependencies.DependableCoordinate;
import org.codehaus.plexus.components.io.filemappers.FileMapper;
@@ -29,81 +31,67 @@
/**
* ArtifactItem represents information specified in the plugin configuration section for each artifact.
*
- * @since 1.0
* @author Brian Fox
+ * @since 1.0
*/
public class ArtifactItem implements DependableCoordinate {
/**
- * Group Id of Artifact
- *
- * @parameter
- * @required
+ * Group ID of artifact.
*/
+ @Parameter(required = true)
private String groupId;
/**
- * Name of Artifact
- *
- * @parameter
- * @required
+ * Name of artifact.
*/
+ @Parameter(required = true)
private String artifactId;
/**
- * Version of Artifact
- *
- * @parameter
+ * Version of artifact.
*/
+ @Parameter
private String version = null;
/**
- * Type of Artifact (War,Jar,etc)
- *
- * @parameter
- * @required
+ * Type of artifact (War, Jar, etc.)
*/
+ @Parameter(required = true)
private String type = "jar";
/**
- * Classifier for Artifact (tests,sources,etc)
- *
- * @parameter
+ * Classifier for artifact (tests, sources, etc.)
*/
+ @Parameter
private String classifier;
/**
- * Location to use for this Artifact. Overrides default location.
- *
- * @parameter
+ * Location to use for this artifact. Overrides default location.
*/
+ @Parameter
private File outputDirectory;
/**
- * Provides ability to change destination file name
- *
- * @parameter
+ * Provides ability to change destination file name.
*/
+ @Parameter
private String destFileName;
/**
- * Force Overwrite..this is the one to set in pom
+ * Force Overwrite. This is the one to set in pom.
*/
private String overWrite;
/**
* Encoding of artifact. Overrides default encoding.
- *
- * @parameter
*/
+ @Parameter
private String encoding;
- /**
- *
- */
private boolean needsProcessing;
/**
- * Artifact Item
+ * Artifact Item.
*/
private Artifact artifact;
@@ -121,13 +109,12 @@ public class ArtifactItem implements DependableCoordinate {
* {@link FileMapper}s to be used for rewriting each target path, or {@code null} if no rewriting shall happen.
*
* @since 3.1.2
- *
- * @parameter
*/
+ @Parameter
private FileMapper[] fileMappers;
/**
- * Default ctor.
+ * Default constructor.
*/
public ArtifactItem() {
// default constructor
@@ -153,77 +140,82 @@ private String filterEmptyString(String in) {
}
/**
- * @return Returns the artifactId.
+ * @return returns the artifact ID
*/
+ @Override
public String getArtifactId() {
return artifactId;
}
/**
- * @param theArtifact The artifactId to set.
+ * @param theArtifact the artifact ID to set
*/
public void setArtifactId(String theArtifact) {
this.artifactId = filterEmptyString(theArtifact);
}
/**
- * @return Returns the groupId.
+ * @return returns the group ID
*/
+ @Override
public String getGroupId() {
return groupId;
}
/**
- * @param groupId The groupId to set.
+ * @param groupId the group ID to set
*/
public void setGroupId(String groupId) {
this.groupId = filterEmptyString(groupId);
}
/**
- * @return Returns the type.
+ * @return returns the type
*/
+ @Override
public String getType() {
return type;
}
/**
- * @param type The type to set.
+ * @param type the type to set
*/
public void setType(String type) {
this.type = filterEmptyString(type);
}
/**
- * @return Returns the version.
+ * @return returns the version
*/
+ @Override
public String getVersion() {
return version;
}
/**
- * @param version The version to set.
+ * @param version the version to set
*/
public void setVersion(String version) {
this.version = filterEmptyString(version);
}
/**
- * @return Returns the base version.
+ * @return teturns the base version
*/
public String getBaseVersion() {
return ArtifactUtils.toSnapshotVersion(version);
}
/**
- * @return Classifier.
+ * @return classifier
*/
+ @Override
public String getClassifier() {
return classifier;
}
/**
- * @param classifier Classifier.
+ * @param classifier classifier
*/
public void setClassifier(String classifier) {
this.classifier = filterEmptyString(classifier);
@@ -239,63 +231,63 @@ public String toString() {
}
/**
- * @return Returns the location.
+ * @return returns the location
*/
public File getOutputDirectory() {
return outputDirectory;
}
/**
- * @param outputDirectory The outputDirectory to set.
+ * @param outputDirectory the outputDirectory to set
*/
public void setOutputDirectory(File outputDirectory) {
this.outputDirectory = outputDirectory;
}
/**
- * @return Returns the location.
+ * @return returns the location
*/
public String getDestFileName() {
return destFileName;
}
/**
- * @param destFileName The destFileName to set.
+ * @param destFileName the destination file name to set
*/
public void setDestFileName(String destFileName) {
this.destFileName = filterEmptyString(destFileName);
}
/**
- * @return Returns the needsProcessing.
+ * @return returns the needsProcessing
*/
public boolean isNeedsProcessing() {
return this.needsProcessing;
}
/**
- * @param needsProcessing The needsProcessing to set.
+ * @param needsProcessing the needsProcessing to set
*/
public void setNeedsProcessing(boolean needsProcessing) {
this.needsProcessing = needsProcessing;
}
/**
- * @return Returns the overWriteSnapshots.
+ * @return teturns the overWriteSnapshots
*/
public String getOverWrite() {
return this.overWrite;
}
/**
- * @param overWrite The overWrite to set.
+ * @param overWrite the overWrite to set
*/
public void setOverWrite(String overWrite) {
this.overWrite = overWrite;
}
/**
- * @return Returns the encoding.
+ * @return returns the encoding
* @since 3.0
*/
public String getEncoding() {
@@ -303,7 +295,7 @@ public String getEncoding() {
}
/**
- * @param encoding The encoding to set.
+ * @param encoding the encoding to set
* @since 3.0
*/
public void setEncoding(String encoding) {
@@ -311,42 +303,42 @@ public void setEncoding(String encoding) {
}
/**
- * @return Returns the artifact.
+ * @return returns the artifact
*/
public Artifact getArtifact() {
return this.artifact;
}
/**
- * @param artifact The artifact to set.
+ * @param artifact the artifact to set
*/
public void setArtifact(Artifact artifact) {
this.artifact = artifact;
}
/**
- * @return Returns a comma separated list of excluded items
+ * @return returns a comma separated list of excluded items
*/
public String getExcludes() {
return DependencyUtil.cleanToBeTokenizedString(this.excludes);
}
/**
- * @param excludes A comma separated list of items to exclude i.e. **\/*.xml, **\/*.properties
+ * @param excludes a comma separated list of items to exclude; for example, **\/*.xml, **\/*.properties
*/
public void setExcludes(String excludes) {
this.excludes = excludes;
}
/**
- * @return Returns a comma separated list of included items
+ * @return returns a comma separated list of items to include
*/
public String getIncludes() {
return DependencyUtil.cleanToBeTokenizedString(this.includes);
}
/**
- * @param includes A comma separated list of items to include i.e. **\/*.xml, **\/*.properties
+ * @param includes comma separated list of items to include; for example, **\/*.xml, **\/*.properties
*/
public void setIncludes(String includes) {
this.includes = includes;
@@ -354,8 +346,7 @@ public void setIncludes(String includes) {
/**
* @return {@link FileMapper}s to be used for rewriting each target path, or {@code null} if no rewriting shall
- * happen.
- *
+ * happen
* @since 3.1.2
*/
public FileMapper[] getFileMappers() {
@@ -364,8 +355,7 @@ public FileMapper[] getFileMappers() {
/**
* @param fileMappers {@link FileMapper}s to be used for rewriting each target path, or {@code null} if no
- * rewriting shall happen.
- *
+ * rewriting shall happen
* @since 3.1.2
*/
public void setFileMappers(FileMapper[] fileMappers) {
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java
index b6ccb4807..dab686a50 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java
@@ -18,15 +18,26 @@
*/
package org.apache.maven.plugins.dependency.fromConfiguration;
+import javax.inject.Inject;
+
import java.io.File;
+import java.io.IOException;
import java.util.List;
+
+import org.apache.maven.artifact.Artifact;
+import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.plugins.dependency.utils.CopyUtil;
import org.apache.maven.plugins.dependency.utils.filters.ArtifactItemFilter;
import org.apache.maven.plugins.dependency.utils.filters.DestFileFilter;
+import org.apache.maven.project.MavenProject;
+import org.eclipse.aether.RepositorySystem;
+import org.sonatype.plexus.build.incremental.BuildContext;
/**
* Goal that copies a list of artifacts from the repository to defined locations.
@@ -37,20 +48,22 @@
@Mojo(name = "copy", defaultPhase = LifecyclePhase.PROCESS_SOURCES, requiresProject = false, threadSafe = true)
public class CopyMojo extends AbstractFromConfigurationMojo {
+ private final CopyUtil copyUtil;
+
/**
- * Strip artifact version during copy
+ * Strip artifact version during copy.
*/
@Parameter(property = "mdep.stripVersion", defaultValue = "false")
private boolean stripVersion = false;
/**
- * Strip artifact classifier during copy
+ * Strip artifact classifier during copy.
*/
@Parameter(property = "mdep.stripClassifier", defaultValue = "false")
private boolean stripClassifier = false;
/**
- * Prepend artifact groupId during copy
+ * Prepend artifact groupId during copy.
*
* @since 2.7
*/
@@ -58,7 +71,7 @@ public class CopyMojo extends AbstractFromConfigurationMojo {
private boolean prependGroupId = false;
/**
- * Use artifact baseVersion during copy
+ * Use artifact baseVersion during copy.
*
* @since 2.7
*/
@@ -73,23 +86,23 @@ public class CopyMojo extends AbstractFromConfigurationMojo {
@Parameter(property = "artifact")
private String artifact;
- /**
- * not used in this goal
- */
- @Parameter
- protected boolean useJvmChmod = true;
-
- /**
- * not used in this goal
- */
- @Parameter
- protected boolean ignorePermissions;
+ @Inject
+ public CopyMojo(
+ MavenSession session,
+ BuildContext buildContext,
+ MavenProject project,
+ ArtifactHandlerManager artifactHandlerManager,
+ CopyUtil copyUtil,
+ RepositorySystem repositorySystem) {
+ super(session, buildContext, project, artifactHandlerManager, repositorySystem);
+ this.copyUtil = copyUtil;
+ }
/**
* Main entry into mojo. This method gets the ArtifactItems and iterates through each one passing it to
* copyArtifact.
*
- * @throws MojoExecutionException with a message if an error occurs.
+ * @throws MojoExecutionException with a message if an error occurs
* @see ArtifactItem
* @see #getArtifactItems
* @see #copyArtifact(ArtifactItem)
@@ -100,11 +113,12 @@ protected void doExecute() throws MojoExecutionException, MojoFailureException {
List theArtifactItems = getProcessedArtifactItems(
new ProcessArtifactItemsRequest(stripVersion, prependGroupId, useBaseVersion, stripClassifier));
+
for (ArtifactItem artifactItem : theArtifactItems) {
if (artifactItem.isNeedsProcessing()) {
copyArtifact(artifactItem);
} else {
- this.getLog().info(artifactItem + " already exists in " + artifactItem.getOutputDirectory());
+ getLog().info(artifactItem + " already exists in " + artifactItem.getOutputDirectory());
}
}
}
@@ -112,14 +126,23 @@ protected void doExecute() throws MojoExecutionException, MojoFailureException {
/**
* Resolves the artifact from the repository and copies it to the specified location.
*
- * @param artifactItem containing the information about the Artifact to copy.
- * @throws MojoExecutionException with a message if an error occurs.
- * @see #copyFile(File, File)
+ * @param artifactItem containing the information about the artifact to copy
+ * @throws MojoExecutionException with a message if an error occurs
+ * @see CopyUtil#copyArtifactFile(Artifact, File)
*/
protected void copyArtifact(ArtifactItem artifactItem) throws MojoExecutionException {
File destFile = new File(artifactItem.getOutputDirectory(), artifactItem.getDestFileName());
-
- copyFile(artifactItem.getArtifact().getFile(), destFile);
+ if (destFile.exists()) {
+ getLog().warn("Overwriting " + destFile);
+ }
+ try {
+ copyUtil.copyArtifactFile(artifactItem.getArtifact(), destFile);
+ } catch (IOException e) {
+ throw new MojoExecutionException(
+ "Failed to copy artifact '" + artifactItem.getArtifact() + "' ("
+ + artifactItem.getArtifact().getFile() + ") to " + destFile,
+ e);
+ }
}
@Override
@@ -139,35 +162,35 @@ protected ArtifactItemFilter getMarkedArtifactFilter(ArtifactItem item) {
}
/**
- * @return Returns the stripVersion.
+ * @return returns the stripVersion
*/
public boolean isStripVersion() {
return this.stripVersion;
}
/**
- * @param stripVersion The stripVersion to set.
+ * @param stripVersion the stripVersion to set
*/
public void setStripVersion(boolean stripVersion) {
this.stripVersion = stripVersion;
}
/**
- * @return Returns the stripClassifier.
+ * @return returns the stripClassifier
*/
public boolean isStripClassifier() {
return this.stripClassifier;
}
/**
- * @param stripClassifier The stripClassifier to set.
+ * @param stripClassifier the stripClassifier to set
*/
public void setStripClassifier(boolean stripClassifier) {
this.stripClassifier = stripClassifier;
}
/**
- * @param useBaseVersion The useBaseVersion to set.
+ * @param useBaseVersion the useBaseVersion to set
*/
public void setUseBaseVersion(boolean useBaseVersion) {
this.useBaseVersion = useBaseVersion;
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ProcessArtifactItemsRequest.java b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ProcessArtifactItemsRequest.java
index e70897d5d..a2d9fa80f 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ProcessArtifactItemsRequest.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ProcessArtifactItemsRequest.java
@@ -24,22 +24,22 @@
*/
public class ProcessArtifactItemsRequest {
/**
- * remove the version from the filename.
+ * Remove the version from the filename.
*/
private boolean removeVersion;
/**
- * remove the classifier from the filename.
+ * Remove the classifier from the filename.
*/
private boolean removeClassifier;
/**
- * prepend the groupId to the filename.
+ * Prepend the groupId to the filename.
*/
private boolean prependGroupId;
/**
- * use the baseVersion of the artifact instead of version for the filename.
+ * Use the baseVersion of the artifact instead of version for the filename.
*/
private boolean useBaseVersion;
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java
index b76add1e0..e4854371c 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java
@@ -18,19 +18,27 @@
*/
package org.apache.maven.plugins.dependency.fromConfiguration;
+import javax.inject.Inject;
+
import java.io.File;
import java.util.List;
+
+import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.plugins.dependency.utils.UnpackUtil;
import org.apache.maven.plugins.dependency.utils.filters.ArtifactItemFilter;
import org.apache.maven.plugins.dependency.utils.filters.MarkerFileFilter;
import org.apache.maven.plugins.dependency.utils.markers.MarkerHandler;
import org.apache.maven.plugins.dependency.utils.markers.UnpackFileMarkerHandler;
+import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.components.io.filemappers.FileMapper;
-import org.codehaus.plexus.util.StringUtils;
+import org.eclipse.aether.RepositorySystem;
+import org.sonatype.plexus.build.incremental.BuildContext;
/**
* Goal that retrieves a list of artifacts from the repository and unpacks them in a defined location.
@@ -41,10 +49,14 @@
@Mojo(name = "unpack", defaultPhase = LifecyclePhase.PROCESS_SOURCES, requiresProject = false, threadSafe = true)
public class UnpackMojo extends AbstractFromConfigurationMojo {
+ private final UnpackUtil unpackUtil;
+
/**
- * Directory to store flag files after unpack
+ * Directory to store flag files after unpack.
*/
- @Parameter(defaultValue = "${project.build.directory}/dependency-maven-plugin-markers")
+ @Parameter(
+ property = "markersDirectory",
+ defaultValue = "${project.build.directory}/dependency-maven-plugin-markers")
private File markersDirectory;
/**
@@ -67,6 +79,14 @@ public class UnpackMojo extends AbstractFromConfigurationMojo {
@Parameter(property = "mdep.unpack.excludes")
private String excludes;
+ /**
+ * Ignore to set file permissions when unpacking a dependency.
+ *
+ * @since 2.7
+ */
+ @Parameter(property = "dependency.ignorePermissions", defaultValue = "false")
+ private boolean ignorePermissions;
+
/**
* {@link FileMapper} to be used for rewriting each target path, or {@code null} if no rewriting shall happen.
*
@@ -84,11 +104,23 @@ public class UnpackMojo extends AbstractFromConfigurationMojo {
@Parameter(property = "artifact")
private String artifact;
+ @Inject
+ public UnpackMojo(
+ MavenSession session,
+ BuildContext buildContext,
+ MavenProject project,
+ ArtifactHandlerManager artifactHandlerManager,
+ UnpackUtil unpackUtil,
+ RepositorySystem repositorySystem) {
+ super(session, buildContext, project, artifactHandlerManager, repositorySystem);
+ this.unpackUtil = unpackUtil;
+ }
+
/**
* Main entry into mojo. This method gets the ArtifactItems and iterates through each one passing it to
* unpackArtifact.
*
- * @throws MojoExecutionException with a message if an error occurs.
+ * @throws MojoExecutionException with a message if an error occurs
* @see ArtifactItem
* @see #getArtifactItems
* @see #unpackArtifact(ArtifactItem)
@@ -114,21 +146,23 @@ protected void doExecute() throws MojoExecutionException, MojoFailureException {
/**
* This method gets the Artifact object and calls DependencyUtil.unpackFile.
*
- * @param artifactItem containing the information about the Artifact to unpack.
- * @throws MojoExecutionException with a message if an error occurs.
+ * @param artifactItem containing the information about the Artifact to unpack
+ * @throws MojoExecutionException with a message if an error occurs
* @see #getArtifact
*/
private void unpackArtifact(ArtifactItem artifactItem) throws MojoExecutionException {
MarkerHandler handler = new UnpackFileMarkerHandler(artifactItem, this.markersDirectory);
- unpack(
- artifactItem.getArtifact(),
+ unpackUtil.unpack(
+ artifactItem.getArtifact().getFile(),
artifactItem.getType(),
artifactItem.getOutputDirectory(),
artifactItem.getIncludes(),
artifactItem.getExcludes(),
artifactItem.getEncoding(),
- artifactItem.getFileMappers());
+ ignorePermissions,
+ artifactItem.getFileMappers(),
+ getLog());
handler.setMarker();
}
@@ -141,18 +175,18 @@ ArtifactItemFilter getMarkedArtifactFilter(ArtifactItem item) {
}
/**
- * @param removeVersion removeVersion.
+ * @param removeVersion removeVersion
* @return list of {@link ArtifactItem}
- * @throws MojoExecutionException in case of an error.
+ * @throws MojoExecutionException in case of an error
*/
protected List getProcessedArtifactItems(boolean removeVersion) throws MojoExecutionException {
List items =
super.getProcessedArtifactItems(new ProcessArtifactItemsRequest(removeVersion, false, false, false));
for (ArtifactItem artifactItem : items) {
- if (StringUtils.isEmpty(artifactItem.getIncludes())) {
+ if (artifactItem.getIncludes().isEmpty()) {
artifactItem.setIncludes(getIncludes());
}
- if (StringUtils.isEmpty(artifactItem.getExcludes())) {
+ if (artifactItem.getExcludes().isEmpty()) {
artifactItem.setExcludes(getExcludes());
}
}
@@ -160,42 +194,42 @@ protected List getProcessedArtifactItems(boolean removeVersion) th
}
/**
- * @return Returns the markersDirectory.
+ * @return returns the markersDirectory
*/
public File getMarkersDirectory() {
return this.markersDirectory;
}
/**
- * @param theMarkersDirectory The markersDirectory to set.
+ * @param theMarkersDirectory the markersDirectory to set
*/
public void setMarkersDirectory(File theMarkersDirectory) {
this.markersDirectory = theMarkersDirectory;
}
/**
- * @return Returns a comma separated list of excluded items
+ * @return returns a comma separated list of excluded items
*/
public String getExcludes() {
return this.excludes;
}
/**
- * @param excludes A comma separated list of items to exclude i.e. **\/*.xml, **\/*.properties
+ * @param excludes a comma separated list of items to exclude i.e. **\/*.xml, **\/*.properties
*/
public void setExcludes(String excludes) {
this.excludes = excludes;
}
/**
- * @return Returns a comma separated list of included items
+ * @return returns a comma separated list of included items
*/
public String getIncludes() {
return this.includes;
}
/**
- * @param includes A comma separated list of items to include i.e. **\/*.xml, **\/*.properties
+ * @param includes a comma separated list of items to include i.e. **\/*.xml, **\/*.properties
*/
public void setIncludes(String includes) {
this.includes = includes;
@@ -203,8 +237,7 @@ public void setIncludes(String includes) {
/**
* @return {@link FileMapper}s to be used for rewriting each target path, or {@code null} if no rewriting shall
- * happen.
- *
+ * happen
* @since 3.1.2
*/
public FileMapper[] getFileMappers() {
@@ -213,8 +246,7 @@ public FileMapper[] getFileMappers() {
/**
* @param fileMappers {@link FileMapper}s to be used for rewriting each target path, or {@code null} if no
- * rewriting shall happen.
- *
+ * rewriting shall happen
* @since 3.1.2
*/
public void setFileMappers(FileMapper[] fileMappers) {
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java
index 7d1ab01a1..992807f98 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java
@@ -18,21 +18,27 @@
*/
package org.apache.maven.plugins.dependency.fromDependencies;
+import javax.inject.Inject;
+
import java.io.File;
import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedHashSet;
import java.util.Set;
+
+import org.apache.maven.RepositoryUtils;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.MojoExecutionException;
-import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.dependency.AbstractDependencyMojo;
import org.apache.maven.plugins.dependency.utils.DependencyStatusSets;
import org.apache.maven.plugins.dependency.utils.DependencyUtil;
+import org.apache.maven.plugins.dependency.utils.ResolverUtil;
import org.apache.maven.plugins.dependency.utils.translators.ArtifactTranslator;
import org.apache.maven.plugins.dependency.utils.translators.ClassifierTypeTranslator;
+import org.apache.maven.project.DefaultProjectBuildingRequest;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.ProjectBuilder;
import org.apache.maven.project.ProjectBuildingException;
@@ -46,31 +52,19 @@
import org.apache.maven.shared.artifact.filter.collection.ProjectTransitivityFilter;
import org.apache.maven.shared.artifact.filter.collection.ScopeFilter;
import org.apache.maven.shared.artifact.filter.collection.TypeFilter;
-import org.apache.maven.shared.transfer.artifact.ArtifactCoordinate;
-import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver;
-import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolverException;
-import org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver;
-import org.apache.maven.shared.transfer.repository.RepositoryManager;
-import org.codehaus.plexus.util.StringUtils;
+import org.eclipse.aether.resolution.ArtifactResolutionException;
+import org.sonatype.plexus.build.incremental.BuildContext;
/**
- * Class that encapsulates the plugin parameters, and contains methods that handle dependency filtering
+ * Class that encapsulates the plugin parameters, and contains methods that handle dependency filtering.
*
* @author Brian Fox
* @see org.apache.maven.plugins.dependency.AbstractDependencyMojo
*/
public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMojo {
- @Component
- private ArtifactResolver artifactResolver;
-
- @Component
- private DependencyResolver dependencyResolver;
-
- @Component
- private RepositoryManager repositoryManager;
/**
- * Overwrite release artifacts
+ * Overwrite release artifacts.
*
* @since 1.0
*/
@@ -78,7 +72,7 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
protected boolean overWriteReleases;
/**
- * Overwrite snapshot artifacts
+ * Overwrite snapshot artifacts.
*
* @since 1.0
*/
@@ -94,7 +88,7 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
protected boolean overWriteIfNewer;
/**
- * If we should exclude transitive dependencies
+ * If we should exclude transitive dependencies.
*
* @since 2.0
*/
@@ -102,7 +96,7 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
protected boolean excludeTransitive;
/**
- * Comma Separated list of Types to include. Empty String indicates include everything (default).
+ * Comma-separated list of Types to include. Empty String indicates include everything (default).
*
* @since 2.0
*/
@@ -110,7 +104,7 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
protected String includeTypes;
/**
- * Comma Separated list of Types to exclude. Empty String indicates don't exclude anything (default).
+ * Comma-separated list of Types to exclude. Empty String indicates don't exclude anything (default).
*
* @since 2.0
*/
@@ -136,7 +130,9 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
/**
* Scope threshold to exclude, if no value is defined for include.
- * An empty string indicates no dependencies (default).
+ * An empty string indicates no dependencies (default). Unlike the other
+ * exclusion parameters, this property does not support a comma-delimited
+ * list of scope exclusions. Just one scope may be excluded at a time.
* The scope threshold value being interpreted is the scope as
* Maven filters for creating a classpath, not as specified in the pom. In summary:
*
@@ -154,7 +150,7 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
protected String excludeScope;
/**
- * Comma Separated list of Classifiers to include. Empty String indicates include everything (default).
+ * Comma-separated list of Classifiers to include. Empty string indicates include everything (default).
*
* @since 2.0
*/
@@ -162,7 +158,7 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
protected String includeClassifiers;
/**
- * Comma Separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
+ * Comma-separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
*
* @since 2.0
*/
@@ -170,7 +166,7 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
protected String excludeClassifiers;
/**
- * Specify classifier to look for. Example: sources
+ * Specify classifier to look for. Example: sources.
*
* @since 2.0
*/
@@ -178,7 +174,7 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
protected String classifier;
/**
- * Specify type to look for when constructing artifact based on classifier. Example: java-source,jar,war
+ * Specify type to look for when constructing artifact based on classifier. Example: java-source,jar,war.
*
* @since 2.0
*/
@@ -186,7 +182,7 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
protected String type;
/**
- * Comma separated list of Artifact names to exclude.
+ * Comma-separated list of artifact IDs to exclude.
*
* @since 2.0
*/
@@ -194,7 +190,7 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
protected String excludeArtifactIds;
/**
- * Comma separated list of Artifact names to include. Empty String indicates include everything (default).
+ * Comma-separated list of artifact IDs to include. Empty String indicates include everything (default).
*
* @since 2.0
*/
@@ -202,7 +198,7 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
protected String includeArtifactIds;
/**
- * Comma separated list of GroupId Names to exclude.
+ * Comma-separated list of group IDs to exclude.
*
* @since 2.0
*/
@@ -210,7 +206,7 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
protected String excludeGroupIds;
/**
- * Comma separated list of GroupIds to include. Empty String indicates include everything (default).
+ * Comma-separated list of group IDs to include. Empty string indicates include everything (default).
*
* @since 2.0
*/
@@ -218,44 +214,56 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
protected String includeGroupIds;
/**
- * Directory to store flag files
+ * Directory to store flag files.
*
* @since 2.0
*/
- // CHECKSTYLE_OFF: LineLength
@Parameter(
property = "markersDirectory",
defaultValue = "${project.build.directory}/dependency-maven-plugin-markers")
- // CHECKSTYLE_ON: LineLength
protected File markersDirectory;
/**
- * Prepend the groupId during copy.
+ * Prepend the group ID during copy.
*
* @since 2.2
*/
@Parameter(property = "mdep.prependGroupId", defaultValue = "false")
protected boolean prependGroupId = false;
- @Component
- private ProjectBuilder projectBuilder;
+ private final ResolverUtil resolverUtil;
+
+ private final ProjectBuilder projectBuilder;
- @Component
- private ArtifactHandlerManager artifactHandlerManager;
+ private final ArtifactHandlerManager artifactHandlerManager;
+
+ @Inject
+ protected AbstractDependencyFilterMojo(
+ MavenSession session,
+ BuildContext buildContext,
+ MavenProject project,
+ ResolverUtil resolverUtil,
+ ProjectBuilder projectBuilder,
+ ArtifactHandlerManager artifactHandlerManager) {
+ super(session, buildContext, project);
+ this.resolverUtil = resolverUtil;
+ this.projectBuilder = projectBuilder;
+ this.artifactHandlerManager = artifactHandlerManager;
+ }
/**
* Return an {@link ArtifactsFilter} indicating which artifacts must be filtered out.
*
- * @return an {@link ArtifactsFilter} indicating which artifacts must be filtered out.
+ * @return an {@link ArtifactsFilter} indicating which artifacts must be filtered out
*/
protected abstract ArtifactsFilter getMarkedArtifactFilter();
/**
* Retrieves dependencies, either direct only or all including transitive.
*
- * @param stopOnFailure true to fail if resolution does not work or false not to fail.
- * @return A set of artifacts
- * @throws MojoExecutionException in case of errors.
+ * @param stopOnFailure true to fail if resolution does not work or false not to fail
+ * @return a set of artifacts
+ * @throws MojoExecutionException in case of errors
*/
protected Set getResolvedDependencies(boolean stopOnFailure) throws MojoExecutionException {
@@ -265,9 +273,9 @@ protected Set getResolvedDependencies(boolean stopOnFailure) throws Mo
}
/**
- * @param stopOnFailure true/false.
+ * @param stopOnFailure true/false
* @return {@link DependencyStatusSets}
- * @throws MojoExecutionException in case of an error.
+ * @throws MojoExecutionException in case of an error
*/
protected DependencyStatusSets getDependencySets(boolean stopOnFailure) throws MojoExecutionException {
return getDependencySets(stopOnFailure, false);
@@ -275,12 +283,12 @@ protected DependencyStatusSets getDependencySets(boolean stopOnFailure) throws M
/**
* Method creates filters and filters the projects dependencies. This method also transforms the dependencies if
- * classifier is set. The dependencies are filtered in least specific to most specific order
+ * classifier is set. The dependencies are filtered in least specific to most specific order.
*
- * @param stopOnFailure true to fail if artifacts can't be resolved false otherwise.
- * @param includeParents true if parents should be included or not false.
+ * @param stopOnFailure true to fail if artifacts can't be resolved false otherwise
+ * @param includeParents true if parents should be included or not false
* @return DependencyStatusSets - Bean of TreeSets that contains information on the projects dependencies
- * @throws MojoExecutionException in case of errors.
+ * @throws MojoExecutionException in case of errors
*/
protected DependencyStatusSets getDependencySets(boolean stopOnFailure, boolean includeParents)
throws MojoExecutionException {
@@ -336,7 +344,7 @@ protected DependencyStatusSets getDependencySets(boolean stopOnFailure, boolean
// transform artifacts if classifier is set
DependencyStatusSets status;
- if (StringUtils.isNotEmpty(classifier)) {
+ if (classifier != null && !classifier.isEmpty()) {
status = getClassifierTranslatedDependencies(artifacts, stopOnFailure);
} else {
status = filterMarkedDependencies(artifacts);
@@ -347,11 +355,12 @@ protected DependencyStatusSets getDependencySets(boolean stopOnFailure, boolean
private MavenProject buildProjectFromArtifact(Artifact artifact) throws MojoExecutionException {
try {
- return projectBuilder
- .build(artifact, session.getProjectBuildingRequest())
- .getProject();
+ ProjectBuildingRequest buildingRequest =
+ new DefaultProjectBuildingRequest(session.getProjectBuildingRequest());
+ buildingRequest.setProcessPlugins(false);
+ return projectBuilder.build(artifact, buildingRequest).getProject();
} catch (ProjectBuildingException e) {
- throw new MojoExecutionException(e.getMessage(), e);
+ throw new MojoExecutionException("Coud not build project for " + artifact.getId(), e);
}
}
@@ -364,28 +373,25 @@ private void addParentArtifacts(MavenProject project, Set artifacts) t
break;
}
try {
- ProjectBuildingRequest buildingRequest = newResolveArtifactProjectBuildingRequest();
-
- Artifact resolvedArtifact = artifactResolver
- .resolveArtifact(buildingRequest, project.getArtifact())
- .getArtifact();
+ org.eclipse.aether.artifact.Artifact resolvedArtifact = resolverUtil.resolveArtifact(
+ RepositoryUtils.toArtifact(project.getArtifact()), project.getRemoteProjectRepositories());
- artifacts.add(resolvedArtifact);
- } catch (ArtifactResolverException e) {
+ artifacts.add(RepositoryUtils.toArtifact(resolvedArtifact));
+ } catch (ArtifactResolutionException e) {
throw new MojoExecutionException(e.getMessage(), e);
}
}
}
/**
- * Transform artifacts
+ * Transform artifacts.
*
- * @param artifacts set of artifacts {@link Artifact}.
- * @param stopOnFailure true/false.
+ * @param artifacts set of artifacts {@link Artifact}
+ * @param stopOnFailure true/false
* @return DependencyStatusSets - Bean of TreeSets that contains information on the projects dependencies
- * @throws MojoExecutionException in case of an error.
+ * @throws MojoExecutionException in case of an error
*/
- protected DependencyStatusSets getClassifierTranslatedDependencies(Set artifacts, boolean stopOnFailure)
+ private DependencyStatusSets getClassifierTranslatedDependencies(Set artifacts, boolean stopOnFailure)
throws MojoExecutionException {
Set unResolvedArtifacts = new LinkedHashSet<>();
Set resolvedArtifacts = artifacts;
@@ -394,10 +400,10 @@ protected DependencyStatusSets getClassifierTranslatedDependencies(Set
// possibly translate artifacts into a new set of artifacts based on the
// classifier and type
// if this did something, we need to resolve the new artifacts
- if (StringUtils.isNotEmpty(classifier)) {
+ if (classifier != null && !classifier.isEmpty()) {
ArtifactTranslator translator =
new ClassifierTypeTranslator(artifactHandlerManager, this.classifier, this.type);
- Collection coordinates = translator.translate(artifacts, getLog());
+ Collection coordinates = translator.translate(artifacts, getLog());
status = filterMarkedDependencies(artifacts);
@@ -420,11 +426,11 @@ protected DependencyStatusSets getClassifierTranslatedDependencies(Set
}
/**
- * Filter the marked dependencies
+ * Filter the marked dependencies.
*
- * @param artifacts The artifacts set {@link Artifact}.
- * @return status set {@link DependencyStatusSets}.
- * @throws MojoExecutionException in case of an error.
+ * @param artifacts the artifacts set {@link Artifact}
+ * @return status set {@link DependencyStatusSets}
+ * @throws MojoExecutionException in case of an error
*/
protected DependencyStatusSets filterMarkedDependencies(Set artifacts) throws MojoExecutionException {
// remove files that have markers already
@@ -447,29 +453,26 @@ protected DependencyStatusSets filterMarkedDependencies(Set artifacts)
}
/**
- * @param coordinates The set of artifact coordinates{@link ArtifactCoordinate}.
+ * @param artifacts the set of artifacts
* @param stopOnFailure true if we should fail with exception if an artifact couldn't be resolved
- * false otherwise.
+ * false otherwise
* @return the resolved artifacts. {@link Artifact}.
- * @throws MojoExecutionException in case of error.
+ * @throws MojoExecutionException in case of error
*/
- protected Set resolve(Set coordinates, boolean stopOnFailure)
+ private Set resolve(Set artifacts, boolean stopOnFailure)
throws MojoExecutionException {
- ProjectBuildingRequest buildingRequest = newResolveArtifactProjectBuildingRequest();
Set resolvedArtifacts = new LinkedHashSet<>();
- for (ArtifactCoordinate coordinate : coordinates) {
+ for (org.eclipse.aether.artifact.Artifact artifact : artifacts) {
try {
- Artifact artifact = artifactResolver
- .resolveArtifact(buildingRequest, coordinate)
- .getArtifact();
- resolvedArtifacts.add(artifact);
- } catch (ArtifactResolverException ex) {
- // an error occurred during resolution, log it an continue
- getLog().debug("error resolving: " + coordinate);
- getLog().debug(ex);
+ org.eclipse.aether.artifact.Artifact resolveArtifact =
+ resolverUtil.resolveArtifact(artifact, getProject().getRemoteProjectRepositories());
+ resolvedArtifacts.add(RepositoryUtils.toArtifact(resolveArtifact));
+ } catch (ArtifactResolutionException ex) {
+ // an error occurred during resolution, log it and continue
+ getLog().debug("error resolving: " + artifact, ex);
if (stopOnFailure) {
- throw new MojoExecutionException("error resolving: " + coordinate, ex);
+ throw new MojoExecutionException("error resolving: " + artifact, ex);
}
}
}
@@ -477,14 +480,14 @@ protected Set resolve(Set coordinates, boolean sto
}
/**
- * @return Returns the markersDirectory.
+ * @return returns the markersDirectory
*/
public File getMarkersDirectory() {
return this.markersDirectory;
}
/**
- * @param theMarkersDirectory The markersDirectory to set.
+ * @param theMarkersDirectory the markersDirectory to set
*/
public void setMarkersDirectory(File theMarkersDirectory) {
this.markersDirectory = theMarkersDirectory;
@@ -493,37 +496,23 @@ public void setMarkersDirectory(File theMarkersDirectory) {
// TODO: Set marker files.
/**
- * @return true, if the groupId should be prepended to the filename.
+ * @return true, if the groupId should be prepended to the filename
*/
public boolean isPrependGroupId() {
return prependGroupId;
}
/**
- * @param prependGroupId - true if the groupId must be prepended during the copy.
+ * @param prependGroupId true if the groupId must be prepended during the copy
*/
public void setPrependGroupId(boolean prependGroupId) {
this.prependGroupId = prependGroupId;
}
/**
- * @return {@link #artifactResolver}
- */
- protected final ArtifactResolver getArtifactResolver() {
- return artifactResolver;
- }
-
- /**
- * @return {@link #dependencyResolver}
- */
- protected final DependencyResolver getDependencyResolver() {
- return dependencyResolver;
- }
-
- /**
- * @return {@link #repositoryManager}
+ * @return {@link #resolverUtil}
*/
- protected final RepositoryManager getRepositoryManager() {
- return repositoryManager;
+ protected final ResolverUtil getResolverUtil() {
+ return resolverUtil;
}
}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractFromDependenciesMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractFromDependenciesMojo.java
index 1226c8ada..19038fac4 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractFromDependenciesMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractFromDependenciesMojo.java
@@ -19,7 +19,14 @@
package org.apache.maven.plugins.dependency.fromDependencies;
import java.io.File;
+
+import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.plugins.dependency.utils.ResolverUtil;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.ProjectBuilder;
+import org.sonatype.plexus.build.incremental.BuildContext;
/**
* Abstract Parent class used by mojos that get Artifact information from the project dependencies.
@@ -36,13 +43,13 @@ public abstract class AbstractFromDependenciesMojo extends AbstractDependencyFil
protected File outputDirectory;
/**
- * Strip artifact version during copy
+ * Strip artifact version during copy.
*/
@Parameter(property = "mdep.stripVersion", defaultValue = "false")
protected boolean stripVersion = false;
/**
- * Strip artifact type during copy
+ * Strip artifact type during copy.
*
* @since 3.4.0
*/
@@ -50,7 +57,7 @@ public abstract class AbstractFromDependenciesMojo extends AbstractDependencyFil
protected boolean stripType = false;
/**
- * Strip artifact classifier during copy
+ * Strip artifact classifier during copy.
*/
@Parameter(property = "mdep.stripClassifier", defaultValue = "false")
protected boolean stripClassifier = false;
@@ -74,7 +81,7 @@ public abstract class AbstractFromDependenciesMojo extends AbstractDependencyFil
/**
* Place each type of file in a separate subdirectory. (example /outputDirectory/runtime /outputDirectory/provided
- * etc)
+ * etc.)
*
* @since 2.2
*/
@@ -82,7 +89,7 @@ public abstract class AbstractFromDependenciesMojo extends AbstractDependencyFil
protected boolean useSubDirectoryPerScope;
/**
- * Place each type of file in a separate subdirectory. (example /outputDirectory/jars /outputDirectory/wars etc)
+ * Place each type of file in a separate subdirectory. (example /outputDirectory/jars /outputDirectory/wars etc.)
*
* @since 2.0-alpha-1
*/
@@ -103,59 +110,69 @@ public abstract class AbstractFromDependenciesMojo extends AbstractDependencyFil
* @since 2.0-alpha-2
*/
@Parameter(property = "mdep.failOnMissingClassifierArtifact", defaultValue = "false")
- protected boolean failOnMissingClassifierArtifact = true;
+ protected boolean failOnMissingClassifierArtifact;
+
+ protected AbstractFromDependenciesMojo(
+ MavenSession session,
+ BuildContext buildContext,
+ MavenProject project,
+ ResolverUtil resolverUtil,
+ ProjectBuilder projectBuilder,
+ ArtifactHandlerManager artifactHandlerManager) {
+ super(session, buildContext, project, resolverUtil, projectBuilder, artifactHandlerManager);
+ }
/**
- * @return Returns the outputDirectory.
+ * @return returns the output directory
*/
public File getOutputDirectory() {
return this.outputDirectory;
}
/**
- * @param theOutputDirectory The outputDirectory to set.
+ * @param theOutputDirectory the outputDirectory to set
*/
public void setOutputDirectory(File theOutputDirectory) {
this.outputDirectory = theOutputDirectory;
}
/**
- * @return Returns the useSubDirectoryPerArtifact.
+ * @return returns the useSubDirectoryPerArtifact
*/
public boolean isUseSubDirectoryPerArtifact() {
return this.useSubDirectoryPerArtifact;
}
/**
- * @param theUseSubDirectoryPerArtifact The useSubDirectoryPerArtifact to set.
+ * @param theUseSubDirectoryPerArtifact the useSubDirectoryPerArtifact to set
*/
public void setUseSubDirectoryPerArtifact(boolean theUseSubDirectoryPerArtifact) {
this.useSubDirectoryPerArtifact = theUseSubDirectoryPerArtifact;
}
/**
- * @return Returns the useSubDirectoryPerScope
+ * @return returns the useSubDirectoryPerScope
*/
public boolean isUseSubDirectoryPerScope() {
return this.useSubDirectoryPerScope;
}
/**
- * @param theUseSubDirectoryPerScope The useSubDirectoryPerScope to set.
+ * @param theUseSubDirectoryPerScope the useSubDirectoryPerScope to set
*/
public void setUseSubDirectoryPerScope(boolean theUseSubDirectoryPerScope) {
this.useSubDirectoryPerScope = theUseSubDirectoryPerScope;
}
/**
- * @return Returns the useSubDirectoryPerType.
+ * @return returns the useSubDirectoryPerType
*/
public boolean isUseSubDirectoryPerType() {
return this.useSubDirectoryPerType;
}
/**
- * @param theUseSubDirectoryPerType The useSubDirectoryPerType to set.
+ * @param theUseSubDirectoryPerType the useSubDirectoryPerType to set
*/
public void setUseSubDirectoryPerType(boolean theUseSubDirectoryPerType) {
this.useSubDirectoryPerType = theUseSubDirectoryPerType;
@@ -211,7 +228,7 @@ public boolean isUseRepositoryLayout() {
}
/**
- * @param useRepositoryLayout - true if dependencies must be planted in a repository layout
+ * @param useRepositoryLayout true if dependencies must be planted in a repository layout
*/
public void setUseRepositoryLayout(boolean useRepositoryLayout) {
this.useRepositoryLayout = useRepositoryLayout;
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/BuildClasspathMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/BuildClasspathMojo.java
index 8424f7084..c0cc14f03 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/BuildClasspathMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/BuildClasspathMojo.java
@@ -18,15 +18,14 @@
*/
package org.apache.maven.plugins.dependency.fromDependencies;
-import java.io.BufferedReader;
-import java.io.BufferedWriter;
+import javax.inject.Inject;
+
import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileOutputStream;
import java.io.IOException;
-import java.io.InputStreamReader;
-import java.io.OutputStreamWriter;
import java.io.Writer;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.Iterator;
@@ -35,19 +34,25 @@
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import org.apache.commons.lang3.StringUtils;
import org.apache.maven.artifact.Artifact;
+import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.MojoExecutionException;
-import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.plugins.dependency.utils.DependencyUtil;
+import org.apache.maven.plugins.dependency.utils.ResolverUtil;
+import org.apache.maven.project.MavenProject;
import org.apache.maven.project.MavenProjectHelper;
-import org.apache.maven.project.ProjectBuildingRequest;
+import org.apache.maven.project.ProjectBuilder;
import org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter;
-import org.apache.maven.shared.transfer.repository.RepositoryManager;
-import org.codehaus.plexus.util.StringUtils;
+import org.sonatype.plexus.build.incremental.BuildContext;
/**
* This goal outputs a classpath string of dependencies from the local repository to a file or log.
@@ -55,13 +60,11 @@
* @author ankostis
* @since 2.0-alpha-2
*/
-// CHECKSTYLE_OFF: LineLength
@Mojo(
name = "build-classpath",
requiresDependencyResolution = ResolutionScope.TEST,
defaultPhase = LifecyclePhase.GENERATE_SOURCES,
threadSafe = true)
-// CHECKSTYLE_ON: LineLength
public class BuildClasspathMojo extends AbstractDependencyFilterMojo implements Comparator {
@Parameter(property = "outputEncoding", defaultValue = "${project.reporting.outputEncoding}")
@@ -87,7 +90,7 @@ public class BuildClasspathMojo extends AbstractDependencyFilterMojo implements
private String prefix;
/**
- * A property to set to the content of the classpath string.
+ * If defined, the name of a property to which the classpath string will be written.
*/
@Parameter(property = "mdep.outputProperty")
private String outputProperty;
@@ -107,7 +110,7 @@ public class BuildClasspathMojo extends AbstractDependencyFilterMojo implements
/**
* Override the char used between the paths. This field is initialized to contain the first character of the value
* of the system property file.separator. On UNIX systems the value of this field is '/'; on Microsoft Windows
- * systems it is '\'. The default is File.separator
+ * systems it is '\'. The default is File.separator.
*
* @since 2.0
*/
@@ -159,29 +162,35 @@ public class BuildClasspathMojo extends AbstractDependencyFilterMojo implements
@Parameter(property = "mdep.useBaseVersion", defaultValue = "true")
private boolean useBaseVersion = true;
- /**
- * Maven ProjectHelper
- */
- @Component
- private MavenProjectHelper projectHelper;
-
- @Component
- private RepositoryManager repositoryManager;
+ private final MavenProjectHelper projectHelper;
+
+ @Inject
+ protected BuildClasspathMojo(
+ MavenSession session,
+ BuildContext buildContext,
+ MavenProject project,
+ ResolverUtil resolverUtil,
+ ProjectBuilder projectBuilder,
+ ArtifactHandlerManager artifactHandlerManager,
+ MavenProjectHelper projectHelper) {
+ super(session, buildContext, project, resolverUtil, projectBuilder, artifactHandlerManager);
+ this.projectHelper = projectHelper;
+ }
/**
* Main entry into mojo. Gets the list of dependencies and iterates to create a classpath.
*
- * @throws MojoExecutionException with a message if an error occurs.
+ * @throws MojoExecutionException with a message if an error occurs
* @see #getResolvedDependencies(boolean)
*/
@Override
protected void doExecute() throws MojoExecutionException {
// initialize the separators.
- boolean isFileSepSet = StringUtils.isNotEmpty(fileSeparator);
- boolean isPathSepSet = StringUtils.isNotEmpty(pathSeparator);
+ boolean isFileSepSet = fileSeparator != null && !fileSeparator.isEmpty();
+ boolean isPathSepSet = pathSeparator != null && !pathSeparator.isEmpty();
// don't allow them to have absolute paths when they attach.
- if (attach && StringUtils.isEmpty(localRepoProperty)) {
+ if (attach && (localRepoProperty == null || localRepoProperty.isEmpty())) {
localRepoProperty = "${M2_REPO}";
}
@@ -243,8 +252,8 @@ protected void doExecute() throws MojoExecutionException {
}
/**
- * @param cpString The classpath.
- * @throws MojoExecutionException in case of an error.
+ * @param cpString the classpath
+ * @throws MojoExecutionException in case of an error
*/
protected void attachFile(String cpString) throws MojoExecutionException {
File attachedFile = new File(getProject().getBuild().getDirectory(), "classpath");
@@ -254,7 +263,7 @@ protected void attachFile(String cpString) throws MojoExecutionException {
}
/**
- * Appends the artifact path into the specified StringBuilder.
+ * Appends the artifact path to the specified StringBuilder.
*
* @param art {@link Artifact}
* @param sb {@link StringBuilder}
@@ -263,15 +272,13 @@ protected void appendArtifactPath(Artifact art, StringBuilder sb) {
if (prefix == null) {
String file = art.getFile().getPath();
// substitute the property for the local repo path to make the classpath file portable.
- if (StringUtils.isNotEmpty(localRepoProperty)) {
- ProjectBuildingRequest projectBuildingRequest = session.getProjectBuildingRequest();
- File localBasedir = repositoryManager.getLocalRepositoryBasedir(projectBuildingRequest);
-
+ if (localRepoProperty != null && !localRepoProperty.isEmpty()) {
+ File localBasedir =
+ session.getRepositorySession().getLocalRepository().getBasedir();
file = StringUtils.replace(file, localBasedir.getAbsolutePath(), localRepoProperty);
}
sb.append(file);
} else {
- // TODO: add param for prepending groupId and version.
sb.append(prefix);
sb.append(File.separator);
sb.append(DependencyUtil.getFormattedFileName(
@@ -283,7 +290,7 @@ protected void appendArtifactPath(Artifact art, StringBuilder sb) {
* Checks that new classpath differs from that found inside the old classpathFile.
*
* @return true if the specified classpath equals the one found inside the file, false otherwise (including when
- * file does not exist but new classpath does).
+ * file does not exist but new classpath does)
*/
private boolean isUpToDate(String cpString) {
try {
@@ -306,9 +313,8 @@ private void storeClasspathFile(String cpString, File out) throws MojoExecutionE
// make sure the parent path exists.
out.getParentFile().mkdirs();
- String encoding = Objects.toString(outputEncoding, "UTF-8");
-
- try (Writer w = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(out), encoding))) {
+ String encoding = Objects.toString(outputEncoding, StandardCharsets.UTF_8.name());
+ try (Writer w = Files.newBufferedWriter(out.toPath(), Charset.forName(encoding))) {
w.write(cpString);
getLog().info("Wrote classpath file '" + out + "'.");
} catch (IOException ex) {
@@ -332,15 +338,11 @@ protected String readClasspathFile() throws IOException {
if (!outputFile.isFile()) {
return null;
}
- StringBuilder sb = new StringBuilder();
- String encoding = Objects.toString(outputEncoding, "UTF-8");
- try (BufferedReader r = new BufferedReader(new InputStreamReader(new FileInputStream(outputFile), encoding))) {
- for (String line = r.readLine(); line != null; line = r.readLine()) {
- sb.append(line);
- }
+ String encoding = Objects.toString(outputEncoding, StandardCharsets.UTF_8.name());
- return sb.toString();
+ try (Stream lines = Files.lines(outputFile.toPath(), Charset.forName(encoding))) {
+ return lines.collect(Collectors.joining());
}
}
@@ -351,7 +353,7 @@ protected String readClasspathFile() throws IOException {
* @param art2 second object
* @return the value 0 if the argument string is equal to this string; a value less than 0
* if this string is lexicographically less than the string argument; and a value greater than
- * 0 if this string is lexicographically greater than the string argument.
+ * 0 if this string is lexicographically greater than the string argument
*/
@Override
public int compare(Artifact art1, Artifact art2) {
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/CopyDependenciesMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/CopyDependenciesMojo.java
index 31d2477d7..ece098283 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/CopyDependenciesMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/CopyDependenciesMojo.java
@@ -18,41 +18,54 @@
*/
package org.apache.maven.plugins.dependency.fromDependencies;
+import javax.inject.Inject;
+
import java.io.File;
+import java.io.IOException;
import java.util.Collections;
+import java.util.HashMap;
import java.util.Map;
import java.util.Set;
+
+import org.apache.maven.RepositoryUtils;
import org.apache.maven.artifact.Artifact;
-import org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout;
+import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.MojoExecutionException;
-import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
+import org.apache.maven.plugins.dependency.utils.CopyUtil;
import org.apache.maven.plugins.dependency.utils.DependencyStatusSets;
import org.apache.maven.plugins.dependency.utils.DependencyUtil;
+import org.apache.maven.plugins.dependency.utils.ResolverUtil;
import org.apache.maven.plugins.dependency.utils.filters.DestFileFilter;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.ProjectBuilder;
import org.apache.maven.project.ProjectBuildingRequest;
import org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter;
-import org.apache.maven.shared.transfer.artifact.DefaultArtifactCoordinate;
import org.apache.maven.shared.transfer.artifact.install.ArtifactInstaller;
import org.apache.maven.shared.transfer.artifact.install.ArtifactInstallerException;
-import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolverException;
+import org.apache.maven.shared.transfer.repository.RepositoryManager;
+import org.eclipse.aether.resolution.ArtifactResolutionException;
+import org.eclipse.aether.util.artifact.SubArtifact;
+import org.sonatype.plexus.build.incremental.BuildContext;
/**
- * Goal that copies the project dependencies from the repository to a defined location.
+ * Goal that copies the files for a project's dependencies from the repository to a directory.
+ * The default location to copy to is target/dependencies.
+ * Since all files are copied to the same directory by default, a dependency that
+ * has the same file name as another dependency will be overwritten.
*
* @author Brian Fox
* @since 1.0
*/
-// CHECKSTYLE_OFF: LineLength
@Mojo(
name = "copy-dependencies",
requiresDependencyResolution = ResolutionScope.TEST,
defaultPhase = LifecyclePhase.PROCESS_SOURCES,
threadSafe = true)
-// CHECKSTYLE_ON: LineLength
public class CopyDependenciesMojo extends AbstractFromDependenciesMojo {
/**
* Also copy the pom of each artifact.
@@ -60,19 +73,13 @@ public class CopyDependenciesMojo extends AbstractFromDependenciesMojo {
* @since 2.0
*/
@Parameter(property = "mdep.copyPom", defaultValue = "false")
- protected boolean copyPom = true;
+ protected boolean copyPom;
- /**
- *
- */
- @Component
- private ArtifactInstaller installer;
+ private final CopyUtil copyUtil;
- /**
- *
- */
- @Component(role = ArtifactRepositoryLayout.class)
- private Map repositoryLayouts;
+ private final ArtifactInstaller installer;
+
+ private final RepositoryManager repositoryManager;
/**
* Either append the artifact's baseVersion or uniqueVersion to the filename. Will only be used if
@@ -92,21 +99,35 @@ public class CopyDependenciesMojo extends AbstractFromDependenciesMojo {
protected boolean addParentPoms;
/**
- * not used in this goal
- */
- @Parameter
- protected boolean useJvmChmod = true;
-
- /**
- * not used in this goal
+ * Also copy the signature files (.asc) of each artifact.
+ *
+ * @since 3.2.0
*/
- @Parameter
- protected boolean ignorePermissions;
+ @Parameter(property = "mdep.copySignatures", defaultValue = "false")
+ protected boolean copySignatures;
+
+ @Inject
+ @SuppressWarnings("checkstyle:ParameterNumber")
+ public CopyDependenciesMojo(
+ MavenSession session,
+ BuildContext buildContext,
+ MavenProject project,
+ ResolverUtil resolverUtil,
+ RepositoryManager repositoryManager,
+ ProjectBuilder projectBuilder,
+ ArtifactHandlerManager artifactHandlerManager,
+ CopyUtil copyUtil,
+ ArtifactInstaller installer) {
+ super(session, buildContext, project, resolverUtil, projectBuilder, artifactHandlerManager);
+ this.copyUtil = copyUtil;
+ this.installer = installer;
+ this.repositoryManager = repositoryManager;
+ }
/**
* Main entry into mojo. Gets the list of dependencies and iterates through calling copyArtifact.
*
- * @throws MojoExecutionException with a message if an error occurs.
+ * @throws MojoExecutionException with a message if an error occurs
* @see #getDependencySets(boolean, boolean)
* @see #copyArtifact(Artifact, boolean, boolean, boolean, boolean)
*/
@@ -116,13 +137,28 @@ protected void doExecute() throws MojoExecutionException {
Set artifacts = dss.getResolvedDependencies();
if (!useRepositoryLayout) {
+ Map copies = new HashMap<>();
+ for (Artifact artifactItem : artifacts) {
+ String destFileName = DependencyUtil.getFormattedFileName(
+ artifactItem, stripVersion, prependGroupId, useBaseVersion, stripClassifier);
+ int numCopies = copies.getOrDefault(destFileName, 0);
+ copies.put(destFileName, numCopies + 1);
+ }
+ for (Map.Entry entry : copies.entrySet()) {
+ if (entry.getValue() > 1) {
+ getLog().warn("Multiple files with the name " + entry.getKey() + " in the dependency tree.");
+ getLog().warn(
+ "Not all JARs will be available. Consider using prependGroupId, useSubDirectoryPerArtifact, or useRepositoryLayout.");
+ }
+ }
+
for (Artifact artifact : artifacts) {
copyArtifact(
artifact, isStripVersion(), this.prependGroupId, this.useBaseVersion, this.stripClassifier);
}
} else {
- ProjectBuildingRequest buildingRequest = getRepositoryManager()
- .setLocalRepositoryBasedir(session.getProjectBuildingRequest(), outputDirectory);
+ ProjectBuildingRequest buildingRequest =
+ repositoryManager.setLocalRepositoryBasedir(session.getProjectBuildingRequest(), outputDirectory);
artifacts.forEach(artifact -> installArtifact(artifact, buildingRequest));
}
@@ -134,19 +170,13 @@ protected void doExecute() throws MojoExecutionException {
if (isCopyPom() && !useRepositoryLayout) {
copyPoms(getOutputDirectory(), artifacts, this.stripVersion);
- copyPoms(getOutputDirectory(), skippedArtifacts, this.stripVersion, this.stripClassifier); // Artifacts
- // that already
- // exist may
- // not yet have
- // poms
+ copyPoms(getOutputDirectory(), skippedArtifacts, this.stripVersion, this.stripClassifier);
+ // Artifacts that already exist may not yet have poms
}
}
/**
- * install the artifact and the corresponding pom if copyPoms=true
- *
- * @param artifact
- * @param buildingRequest
+ * Install the artifact and the corresponding pom if copyPoms=true.
*/
private void installArtifact(Artifact artifact, ProjectBuildingRequest buildingRequest) {
try {
@@ -184,11 +214,11 @@ private void installBaseSnapshot(Artifact artifact, ProjectBuildingRequest build
* Copies the Artifact after building the destination file name if overridden. This method also checks if the
* classifier is set and adds it to the destination file name if needed.
*
- * @param artifact representing the object to be copied.
- * @param removeVersion specifies if the version should be removed from the file name when copying.
- * @param prependGroupId specifies if the groupId should be prepend to the file while copying.
- * @param theUseBaseVersion specifies if the baseVersion of the artifact should be used instead of the version.
- * @throws MojoExecutionException with a message if an error occurs.
+ * @param artifact the object to be copied
+ * @param removeVersion specifies if the version should be removed from the file name when copying
+ * @param prependGroupId specifies if the group ID should be prefixed to the file while copying
+ * @param theUseBaseVersion specifies if the baseVersion of the artifact should be used instead of the version
+ * @throws MojoExecutionException with a message if an error occurs
* @see #copyArtifact(Artifact, boolean, boolean, boolean, boolean)
*/
protected void copyArtifact(
@@ -201,25 +231,27 @@ protected void copyArtifact(
* Copies the Artifact after building the destination file name if overridden. This method also checks if the
* classifier is set and adds it to the destination file name if needed.
*
- * @param artifact representing the object to be copied.
- * @param removeVersion specifies if the version should be removed from the file name when copying.
- * @param prependGroupId specifies if the groupId should be prepend to the file while copying.
- * @param theUseBaseVersion specifies if the baseVersion of the artifact should be used instead of the version.
- * @param removeClassifier specifies if the classifier should be removed from the file name when copying.
- * @throws MojoExecutionException with a message if an error occurs.
- * @see #copyFile(File, File)
+ * @param artifact the object to be copied
+ * @param removeVersion specifies if the version should be removed from the file name when copying
+ * @param prependGroupId specifies if the groupId should be prefixed to the file while copying
+ * @param useBaseVersion specifies if the baseVersion of the artifact should be used instead of the version
+ * @param removeClassifier specifies if the classifier should be removed from the file name when copying
+ * @throws MojoExecutionException with a message if an error occurs
+ * @see CopyUtil#copyArtifactFile(Artifact, File)
* @see DependencyUtil#getFormattedOutputDirectory(boolean, boolean, boolean, boolean, boolean, boolean, File, Artifact)
*/
+ private static final String SIGNATURE_EXTENSION = ".asc";
+
protected void copyArtifact(
Artifact artifact,
boolean removeVersion,
boolean prependGroupId,
- boolean theUseBaseVersion,
+ boolean useBaseVersion,
boolean removeClassifier)
throws MojoExecutionException {
String destFileName = DependencyUtil.getFormattedFileName(
- artifact, removeVersion, prependGroupId, theUseBaseVersion, removeClassifier);
+ artifact, removeVersion, prependGroupId, useBaseVersion, removeClassifier);
File destDir = DependencyUtil.getFormattedOutputDirectory(
useSubDirectoryPerScope,
@@ -231,17 +263,66 @@ protected void copyArtifact(
outputDirectory,
artifact);
File destFile = new File(destDir, destFileName);
+ if (destFile.exists()) {
+ getLog().warn("Overwriting " + destFile);
+ }
+ try {
+ copyUtil.copyArtifactFile(artifact, destFile);
+
+ // Copy the signature file if the copySignatures flag is true
+ if (copySignatures) {
+ copySignatureFile(artifact, destDir, destFileName);
+ }
+
+ } catch (IOException e) {
+ throw new MojoExecutionException(
+ "Failed to copy artifact '" + artifact + "' (" + artifact.getFile() + ") to " + destFile, e);
+ }
+ }
+
+ /**
+ * Copies the signature file of the artifact to the destination directory, if it exists or can be resolved.
+ * If the signature file does not exist and cannot be resolved, a warning is logged.
+ *
+ * @param artifact the artifact whose signature file should be copied
+ * @param destDir the destination directory
+ * @param destFileName the destination file name without the extension
+ */
+ private void copySignatureFile(Artifact artifact, File destDir, String destFileName) {
+ File signatureFile = new File(artifact.getFile().getAbsolutePath() + SIGNATURE_EXTENSION);
+
+ if (!signatureFile.exists()) {
+ try {
+ org.eclipse.aether.artifact.Artifact aArtifact = RepositoryUtils.toArtifact(artifact);
+ org.eclipse.aether.artifact.Artifact aSignatureArtifact =
+ new SubArtifact(aArtifact, null, "jar" + SIGNATURE_EXTENSION);
+ org.eclipse.aether.artifact.Artifact resolvedSignature = getResolverUtil()
+ .resolveArtifact(aSignatureArtifact, getProject().getRemoteProjectRepositories());
+ signatureFile = resolvedSignature.getFile();
+ } catch (ArtifactResolutionException e) {
+ getLog().warn("Failed to resolve signature file for artifact: " + artifact, e);
+ }
+ }
- copyFile(artifact.getFile(), destFile);
+ if (signatureFile != null && signatureFile.exists()) {
+ File signatureDestFile = new File(destDir, destFileName + SIGNATURE_EXTENSION);
+ try {
+ copyUtil.copyFile(signatureFile, signatureDestFile);
+ } catch (IOException e) {
+ getLog().warn("Failed to copy signature file: " + signatureFile, e);
+ }
+ } else {
+ getLog().warn("Signature file for artifact " + artifact + " not found and could not be resolved.");
+ }
}
/**
* Copy the pom files associated with the artifacts.
*
- * @param destDir The destination directory {@link File}.
- * @param artifacts The artifacts {@link Artifact}.
- * @param removeVersion remove version or not.
- * @throws MojoExecutionException in case of errors.
+ * @param destDir the destination directory {@link File}
+ * @param artifacts the artifacts {@link Artifact}
+ * @param removeVersion remove version or not
+ * @throws MojoExecutionException in case of errors
*/
public void copyPoms(File destDir, Set artifacts, boolean removeVersion) throws MojoExecutionException {
@@ -251,11 +332,11 @@ public void copyPoms(File destDir, Set artifacts, boolean removeVersio
/**
* Copy the pom files associated with the artifacts.
*
- * @param destDir The destination directory {@link File}.
- * @param artifacts The artifacts {@link Artifact}.
- * @param removeVersion remove version or not.
- * @param removeClassifier remove the classifier or not.
- * @throws MojoExecutionException in case of errors.
+ * @param destDir the destination directory {@link File}
+ * @param artifacts the artifacts {@link Artifact}
+ * @param removeVersion remove version or not
+ * @param removeClassifier remove the classifier or not
+ * @throws MojoExecutionException in case of errors
*/
public void copyPoms(File destDir, Set artifacts, boolean removeVersion, boolean removeClassifier)
throws MojoExecutionException {
@@ -272,7 +353,14 @@ public void copyPoms(File destDir, Set artifacts, boolean removeVersio
DependencyUtil.getFormattedFileName(
pomArtifact, removeVersion, prependGroupId, useBaseVersion, removeClassifier));
if (!pomDestFile.exists()) {
- copyFile(pomArtifact.getFile(), pomDestFile);
+ try {
+ copyUtil.copyArtifactFile(pomArtifact, pomDestFile);
+ } catch (IOException e) {
+ throw new MojoExecutionException(
+ "Failed to copy artifact '" + pomArtifact + "' (" + pomArtifact.getFile() + ") to "
+ + pomDestFile,
+ e);
+ }
}
}
}
@@ -283,21 +371,16 @@ public void copyPoms(File destDir, Set artifacts, boolean removeVersio
* @return {@link Artifact}
*/
protected Artifact getResolvedPomArtifact(Artifact artifact) {
- DefaultArtifactCoordinate coordinate = new DefaultArtifactCoordinate();
- coordinate.setGroupId(artifact.getGroupId());
- coordinate.setArtifactId(artifact.getArtifactId());
- coordinate.setVersion(artifact.getVersion());
- coordinate.setExtension("pom");
Artifact pomArtifact = null;
// Resolve the pom artifact using repos
try {
- ProjectBuildingRequest buildingRequest = newResolveArtifactProjectBuildingRequest();
-
- pomArtifact = getArtifactResolver()
- .resolveArtifact(buildingRequest, coordinate)
- .getArtifact();
- } catch (ArtifactResolverException e) {
+ org.eclipse.aether.artifact.Artifact aArtifact = RepositoryUtils.toArtifact(artifact);
+ org.eclipse.aether.artifact.Artifact aPomArtifact = new SubArtifact(aArtifact, null, "pom");
+ org.eclipse.aether.artifact.Artifact resolvedPom =
+ getResolverUtil().resolveArtifact(aPomArtifact, getProject().getRemoteProjectRepositories());
+ pomArtifact = RepositoryUtils.toArtifact(resolvedPom);
+ } catch (ArtifactResolutionException e) {
getLog().info(e.getMessage());
}
return pomArtifact;
@@ -327,7 +410,7 @@ public boolean isCopyPom() {
}
/**
- * @param copyPom - true if the pom of each artifact must be copied
+ * @param copyPom true if the pom of each artifact must be copied
*/
public void setCopyPom(boolean copyPom) {
this.copyPom = copyPom;
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/RenderDependenciesMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/RenderDependenciesMojo.java
new file mode 100644
index 000000000..6a4291480
--- /dev/null
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/RenderDependenciesMojo.java
@@ -0,0 +1,278 @@
+/*
+ * 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.plugins.dependency.fromDependencies;
+
+import javax.inject.Inject;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.StringWriter;
+import java.io.Writer;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.List;
+import java.util.Objects;
+import java.util.Properties;
+import java.util.function.Function;
+import java.util.stream.Collectors;
+
+import org.apache.maven.artifact.Artifact;
+import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugins.annotations.LifecyclePhase;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.plugins.annotations.ResolutionScope;
+import org.apache.maven.plugins.dependency.utils.ResolverUtil;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.MavenProjectHelper;
+import org.apache.maven.project.ProjectBuilder;
+import org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter;
+import org.apache.velocity.Template;
+import org.apache.velocity.VelocityContext;
+import org.apache.velocity.app.VelocityEngine;
+import org.apache.velocity.tools.generic.CollectionTool;
+import org.sonatype.plexus.build.incremental.BuildContext;
+
+import static java.util.Optional.ofNullable;
+
+/**
+ * This goal renders dependencies based on a velocity template.
+ *
+ * @since 3.9.0
+ */
+@Mojo(
+ name = "render-dependencies",
+ requiresDependencyResolution = ResolutionScope.TEST,
+ defaultPhase = LifecyclePhase.GENERATE_SOURCES,
+ threadSafe = true)
+public class RenderDependenciesMojo extends AbstractDependencyFilterMojo {
+ /**
+ * Encoding to write the rendered template.
+ * @since 3.9.0
+ */
+ @Parameter(property = "outputEncoding", defaultValue = "${project.reporting.outputEncoding}")
+ private String outputEncoding;
+
+ /**
+ * The file to write the rendered template string. If undefined, it just prints the classpath as [INFO].
+ * @since 3.9.0
+ */
+ @Parameter(property = "mdep.outputFile")
+ private File outputFile;
+
+ /**
+ * If not null or empty it will attach the artifact with this classifier.
+ * @since 3.9.0
+ */
+ @Parameter(property = "mdep.classifier", defaultValue = "template")
+ private String classifier;
+
+ /**
+ * Extension to use for the attached file if classifier is not null/empty.
+ * @since 3.9.0
+ */
+ @Parameter(property = "mdep.extension", defaultValue = "txt")
+ private String extension;
+
+ /**
+ * Velocity template to use to render the output file.
+ * It can be inline or a file path.
+ * @since 3.9.0
+ */
+ @Parameter(property = "mdep.template", required = true)
+ private String template;
+
+ private final MavenProjectHelper projectHelper;
+
+ @Inject
+ protected RenderDependenciesMojo(
+ MavenSession session,
+ BuildContext buildContext,
+ MavenProject project,
+ ResolverUtil resolverUtil,
+ ProjectBuilder projectBuilder,
+ ArtifactHandlerManager artifactHandlerManager,
+ MavenProjectHelper projectHelper) {
+ super(session, buildContext, project, resolverUtil, projectBuilder, artifactHandlerManager);
+ this.projectHelper = projectHelper;
+ }
+
+ /**
+ * Main entry into mojo.
+ *
+ * @throws MojoExecutionException with a message if an error occurs
+ */
+ @Override
+ protected void doExecute() throws MojoExecutionException {
+ // sort them to ease template work and ensure it is deterministic
+ final List artifacts =
+ ofNullable(getResolvedDependencies(true)).orElseGet(Collections::emptySet).stream()
+ .sorted(Comparator.comparing(Artifact::getGroupId)
+ .thenComparing(Artifact::getArtifactId)
+ .thenComparing(Artifact::getBaseVersion)
+ .thenComparing(orEmpty(Artifact::getClassifier))
+ .thenComparing(orEmpty(Artifact::getType)))
+ .collect(Collectors.toList());
+
+ if (artifacts.isEmpty()) {
+ getLog().warn("No dependencies found.");
+ }
+
+ final String rendered = render(artifacts);
+
+ if (outputFile == null) {
+ getLog().info(rendered);
+ } else {
+ store(rendered, outputFile);
+ }
+ if (classifier != null && !classifier.isEmpty()) {
+ attachFile(rendered);
+ }
+ }
+
+ /**
+ * Do render the template.
+ * @param artifacts input.
+ * @return the template rendered.
+ */
+ private String render(final List artifacts) {
+ final Path templatePath = getTemplatePath();
+ final boolean fromFile = templatePath != null && Files.exists(templatePath);
+
+ final Properties props = new Properties();
+ props.setProperty("runtime.strict_mode.enable", "true");
+ if (fromFile) {
+ props.setProperty(
+ "resource.loader.file.path",
+ templatePath.toAbsolutePath().getParent().toString());
+ }
+
+ final VelocityEngine ve = new VelocityEngine(props);
+ ve.init();
+
+ final VelocityContext context = new VelocityContext();
+ context.put("artifacts", artifacts);
+ context.put("sorter", new CollectionTool());
+
+ // Merge template + context
+ final StringWriter writer = new StringWriter();
+ try (StringWriter ignored = writer) {
+ if (fromFile) {
+ final Template template =
+ ve.getTemplate(templatePath.getFileName().toString());
+ template.merge(context, writer);
+ } else {
+ ve.evaluate(context, writer, "tpl-" + Math.abs(hashCode()), template);
+ }
+ } catch (final IOException e) {
+ // no-op, not possible
+ }
+
+ return writer.toString();
+ }
+
+ private Path getTemplatePath() {
+ try {
+ return Paths.get(template);
+ } catch (final RuntimeException re) {
+ return null;
+ }
+ }
+
+ /**
+ * Trivial null protection impl for comparing callback.
+ * @param getter nominal getter.
+ * @return a comparer of getter defaulting on empty if getter value is null.
+ */
+ private Comparator orEmpty(final Function getter) {
+ return Comparator.comparing(a -> ofNullable(getter.apply(a)).orElse(""));
+ }
+
+ /**
+ * @param content the rendered template
+ * @throws MojoExecutionException in case of an error
+ */
+ protected void attachFile(final String content) throws MojoExecutionException {
+ final File attachedFile;
+ if (outputFile == null) {
+ attachedFile = new File(getProject().getBuild().getDirectory(), classifier);
+ store(content, attachedFile);
+ } else { // already written
+ attachedFile = outputFile;
+ }
+ projectHelper.attachArtifact(getProject(), extension, classifier, attachedFile);
+ }
+
+ /**
+ * Stores the specified string into that file.
+ *
+ * @param content the string to write into the file
+ */
+ private void store(final String content, final File out) throws MojoExecutionException {
+ // make sure the parent path exists.
+ final Path parent = out.toPath().getParent();
+ if (parent != null) {
+ try {
+ Files.createDirectories(parent);
+ } catch (final IOException e) {
+ throw new MojoExecutionException(e);
+ }
+ }
+
+ final String encoding = Objects.toString(outputEncoding, StandardCharsets.UTF_8.name());
+ try (Writer w = Files.newBufferedWriter(out.toPath(), Charset.forName(encoding))) {
+ w.write(content);
+ getLog().info("Wrote file '" + out + "'.");
+ } catch (final IOException ex) {
+ throw new MojoExecutionException("Error while writing to file '" + out, ex);
+ }
+ }
+
+ @Override
+ protected ArtifactsFilter getMarkedArtifactFilter() {
+ return null;
+ }
+
+ public void setExtension(final String extension) {
+ this.extension = extension;
+ }
+
+ public void setOutputEncoding(final String outputEncoding) {
+ this.outputEncoding = outputEncoding;
+ }
+
+ public void setOutputFile(final File outputFile) {
+ this.outputFile = outputFile;
+ }
+
+ public void setClassifier(final String classifier) {
+ this.classifier = classifier;
+ }
+
+ public void setTemplate(final String template) {
+ this.template = template;
+ }
+}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/UnpackDependenciesMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/UnpackDependenciesMojo.java
index e7c812688..707178373 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/UnpackDependenciesMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/UnpackDependenciesMojo.java
@@ -18,8 +18,13 @@
*/
package org.apache.maven.plugins.dependency.fromDependencies;
+import javax.inject.Inject;
+
import java.io.File;
+
import org.apache.maven.artifact.Artifact;
+import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
@@ -27,10 +32,15 @@
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.plugins.dependency.utils.DependencyStatusSets;
import org.apache.maven.plugins.dependency.utils.DependencyUtil;
+import org.apache.maven.plugins.dependency.utils.ResolverUtil;
+import org.apache.maven.plugins.dependency.utils.UnpackUtil;
import org.apache.maven.plugins.dependency.utils.filters.MarkerFileFilter;
import org.apache.maven.plugins.dependency.utils.markers.DefaultFileMarkerHandler;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.ProjectBuilder;
import org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter;
import org.codehaus.plexus.components.io.filemappers.FileMapper;
+import org.sonatype.plexus.build.incremental.BuildContext;
/**
* Goal that unpacks the project dependencies from the repository to a defined location.
@@ -46,6 +56,7 @@
threadSafe = true)
// CHECKSTYLE_ON: LineLength
public class UnpackDependenciesMojo extends AbstractFromDependenciesMojo {
+
/**
* A comma separated list of file patterns to include when unpacking the artifact. i.e.
* **/*.xml,**/*.properties NOTE: Excludes patterns override the includes. (component code =
@@ -66,6 +77,14 @@ public class UnpackDependenciesMojo extends AbstractFromDependenciesMojo {
@Parameter(property = "mdep.unpack.excludes")
private String excludes;
+ /**
+ * Ignore to set file permissions when unpacking a dependency.
+ *
+ * @since 2.7
+ */
+ @Parameter(property = "dependency.ignorePermissions", defaultValue = "false")
+ private boolean ignorePermissions;
+
/**
* Encoding of artifacts.
*
@@ -82,13 +101,27 @@ public class UnpackDependenciesMojo extends AbstractFromDependenciesMojo {
@Parameter(property = "mdep.unpack.filemappers")
private FileMapper[] fileMappers;
+ private final UnpackUtil unpackUtil;
+
+ @Inject
+ public UnpackDependenciesMojo(
+ MavenSession session,
+ BuildContext buildContext,
+ MavenProject project,
+ ResolverUtil resolverUtil,
+ ProjectBuilder projectBuilder,
+ ArtifactHandlerManager artifactHandlerManager,
+ UnpackUtil unpackUtil) {
+ super(session, buildContext, project, resolverUtil, projectBuilder, artifactHandlerManager);
+ this.unpackUtil = unpackUtil;
+ }
+
/**
* Main entry into mojo. This method gets the dependencies and iterates through each one passing it to
* DependencyUtil.unpackFile().
*
- * @throws MojoExecutionException with a message if an error occurs.
+ * @throws MojoExecutionException with a message if an error occurs
* @see #getDependencySets(boolean)
- * @see #unpack(Artifact, File, String, FileMapper[])
*/
@Override
protected void doExecute() throws MojoExecutionException {
@@ -104,7 +137,16 @@ protected void doExecute() throws MojoExecutionException {
stripType,
outputDirectory,
artifact);
- unpack(artifact, destDir, getIncludes(), getExcludes(), getEncoding(), getFileMappers());
+ unpackUtil.unpack(
+ artifact.getFile(),
+ artifact.getType(),
+ destDir,
+ getIncludes(),
+ getExcludes(),
+ getEncoding(),
+ ignorePermissions,
+ getFileMappers(),
+ getLog());
DefaultFileMarkerHandler handler = new DefaultFileMarkerHandler(artifact, this.markersDirectory);
handler.setMarker();
}
@@ -124,35 +166,35 @@ protected ArtifactsFilter getMarkedArtifactFilter() {
}
/**
- * @return Returns a comma separated list of excluded items
+ * @return returns a comma separated list of excluded items
*/
public String getExcludes() {
return DependencyUtil.cleanToBeTokenizedString(this.excludes);
}
/**
- * @param excludes A comma separated list of items to exclude i.e. **\/*.xml, **\/*.properties
+ * @param excludes a comma separated list of items to exclude i.e. **\/*.xml, **\/*.properties
*/
public void setExcludes(String excludes) {
this.excludes = excludes;
}
/**
- * @return Returns a comma separated list of included items
+ * @return returns a comma separated list of included items
*/
public String getIncludes() {
return DependencyUtil.cleanToBeTokenizedString(this.includes);
}
/**
- * @param includes A comma separated list of items to include i.e. **\/*.xml, **\/*.properties
+ * @param includes a comma separated list of items to include i.e. **\/*.xml, **\/*.properties
*/
public void setIncludes(String includes) {
this.includes = includes;
}
/**
- * @param encoding The encoding to set.
+ * @param encoding the encoding to set
* @since 3.0
*/
public void setEncoding(String encoding) {
@@ -160,7 +202,7 @@ public void setEncoding(String encoding) {
}
/**
- * @return Returns the encoding.
+ * @return returns the encoding
* @since 3.0
*/
public String getEncoding() {
@@ -169,8 +211,7 @@ public String getEncoding() {
/**
* @return {@link FileMapper}s to be used for rewriting each target path, or {@code null} if no rewriting shall
- * happen.
- *
+ * happen
* @since 3.1.2
*/
public FileMapper[] getFileMappers() {
@@ -179,8 +220,7 @@ public FileMapper[] getFileMappers() {
/**
* @param fileMappers {@link FileMapper}s to be used for rewriting each target path, or {@code null} if no
- * rewriting shall happen.
- *
+ * rewriting shall happen
* @since 3.1.2
*/
public void setFileMappers(FileMapper[] fileMappers) {
diff --git a/src/main/java/org/apache/maven/plugins/dependency/resolvers/AbstractResolveMojo.java b/src/main/java/org/apache/maven/plugins/dependency/resolvers/AbstractResolveMojo.java
index 20f5a9b93..222af532e 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/resolvers/AbstractResolveMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/resolvers/AbstractResolveMojo.java
@@ -19,27 +19,21 @@
package org.apache.maven.plugins.dependency.resolvers;
import java.io.File;
-import java.util.LinkedHashSet;
-import java.util.Set;
-import org.apache.maven.artifact.Artifact;
+
+import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.dependency.fromDependencies.AbstractDependencyFilterMojo;
-import org.apache.maven.plugins.dependency.utils.DependencyUtil;
-import org.apache.maven.project.ProjectBuildingRequest;
-import org.apache.maven.shared.artifact.filter.collection.ArtifactIdFilter;
-import org.apache.maven.shared.artifact.filter.collection.ClassifierFilter;
-import org.apache.maven.shared.artifact.filter.collection.FilterArtifacts;
-import org.apache.maven.shared.artifact.filter.collection.GroupIdFilter;
-import org.apache.maven.shared.artifact.filter.collection.ScopeFilter;
-import org.apache.maven.shared.artifact.filter.collection.TypeFilter;
-import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResult;
-import org.apache.maven.shared.transfer.dependencies.DependableCoordinate;
-import org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolverException;
+import org.apache.maven.plugins.dependency.utils.ResolverUtil;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.ProjectBuilder;
+import org.sonatype.plexus.build.incremental.BuildContext;
/**
* @author Brian Fox
*/
public abstract class AbstractResolveMojo extends AbstractDependencyFilterMojo {
+
/**
* If specified, this parameter causes the dependencies to be written to the path specified instead of
* the console.
@@ -57,80 +51,13 @@ public abstract class AbstractResolveMojo extends AbstractDependencyFilterMojo {
@Parameter(property = "appendOutput", defaultValue = "false")
protected boolean appendOutput;
- /**
- * Don't resolve plugins that are in the current reactor.
- *
- * @since 2.7
- */
- @Parameter(property = "excludeReactor", defaultValue = "true")
- protected boolean excludeReactor;
-
- /**
- * not used in this goal
- */
- @Parameter
- protected boolean useJvmChmod = true;
-
- /**
- * not used in this goal
- */
- @Parameter
- protected boolean ignorePermissions;
-
- /**
- * @return {@link FilterArtifacts}
- */
- protected FilterArtifacts getArtifactsFilter() {
- final FilterArtifacts filter = new FilterArtifacts();
-
- if (excludeReactor) {
-
- filter.addFilter(new ExcludeReactorProjectsArtifactFilter(reactorProjects, getLog()));
- }
-
- filter.addFilter(new ScopeFilter(
- DependencyUtil.cleanToBeTokenizedString(this.includeScope),
- DependencyUtil.cleanToBeTokenizedString(this.excludeScope)));
-
- filter.addFilter(new TypeFilter(
- DependencyUtil.cleanToBeTokenizedString(this.includeTypes),
- DependencyUtil.cleanToBeTokenizedString(this.excludeTypes)));
-
- filter.addFilter(new ClassifierFilter(
- DependencyUtil.cleanToBeTokenizedString(this.includeClassifiers),
- DependencyUtil.cleanToBeTokenizedString(this.excludeClassifiers)));
-
- filter.addFilter(new GroupIdFilter(
- DependencyUtil.cleanToBeTokenizedString(this.includeGroupIds),
- DependencyUtil.cleanToBeTokenizedString(this.excludeGroupIds)));
-
- filter.addFilter(new ArtifactIdFilter(
- DependencyUtil.cleanToBeTokenizedString(this.includeArtifactIds),
- DependencyUtil.cleanToBeTokenizedString(this.excludeArtifactIds)));
-
- return filter;
- }
-
- /**
- * This method resolves all transitive dependencies of an artifact.
- *
- * @param artifact the artifact used to retrieve dependencies
- * @return resolved set of dependencies
- * @throws DependencyResolverException in case of error while resolving artifacts.
- */
- protected Set resolveArtifactDependencies(final DependableCoordinate artifact)
- throws DependencyResolverException {
- ProjectBuildingRequest buildingRequest = newResolveArtifactProjectBuildingRequest();
-
- Iterable artifactResults =
- getDependencyResolver().resolveDependencies(buildingRequest, artifact, null);
-
- Set artifacts = new LinkedHashSet<>();
-
- for (final ArtifactResult artifactResult : artifactResults) {
- artifacts.add(artifactResult.getArtifact());
- }
-
- return artifacts;
+ protected AbstractResolveMojo(
+ MavenSession session,
+ BuildContext buildContext,
+ MavenProject project,
+ ResolverUtil resolverUtil,
+ ProjectBuilder projectBuilder,
+ ArtifactHandlerManager artifactHandlerManager) {
+ super(session, buildContext, project, resolverUtil, projectBuilder, artifactHandlerManager);
}
}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/resolvers/CollectDependenciesMojo.java b/src/main/java/org/apache/maven/plugins/dependency/resolvers/CollectDependenciesMojo.java
index bc23a637d..bd8927586 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/resolvers/CollectDependenciesMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/resolvers/CollectDependenciesMojo.java
@@ -18,33 +18,51 @@
*/
package org.apache.maven.plugins.dependency.resolvers;
+import javax.inject.Inject;
+
+import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.ResolutionScope;
+import org.apache.maven.plugins.dependency.utils.ResolverUtil;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.ProjectBuilder;
+import org.sonatype.plexus.build.incremental.BuildContext;
/**
*
- * Goal that collects the project dependencies from the repository. This goal requires Maven 3.0 or higher to function
- * because it uses "requiresDependencyCollection". This means that it lists the groupId:artifactId:version information
+ * Goal that collects the project dependencies from the repository. This goal
+ * uses "requiresDependencyCollection" to list the groupId:artifactId:version information
* by downloading the pom files without downloading the actual artifacts such as jar files.
*
*
* This is very useful when full dependency resolution might fail due to projects which haven't been built yet.
*
*
- * It is identical to {@link ResolveDependenciesMojo} except for using the requiresDependencyCollection annotation
- * attribute instead of requiresDependencyResolution.
+ * It is identical to resolve
+ * except for using the requiresDependencyCollection annotation attribute instead of requiresDependencyResolution.
*
*
* @author Eric Pabst
* @author Brian Fox
* @since 3.0
*/
-// CHECKSTYLE_OFF: LineLength
@Mojo(
name = "collect",
requiresDependencyCollection = ResolutionScope.TEST,
defaultPhase = LifecyclePhase.GENERATE_SOURCES,
threadSafe = true)
-// CHECKSTYLE_ON: LineLength
-public class CollectDependenciesMojo extends ResolveDependenciesMojo {}
+public class CollectDependenciesMojo extends ResolveDependenciesMojo {
+
+ @Inject
+ protected CollectDependenciesMojo(
+ MavenSession session,
+ BuildContext buildContext,
+ MavenProject project,
+ ResolverUtil resolverUtil,
+ ProjectBuilder projectBuilder,
+ ArtifactHandlerManager artifactHandlerManager) {
+ super(session, buildContext, project, resolverUtil, projectBuilder, artifactHandlerManager);
+ }
+}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ExcludeReactorProjectsArtifactFilter.java b/src/main/java/org/apache/maven/plugins/dependency/resolvers/ExcludeReactorProjectsArtifactFilter.java
index 42e42fec3..a93ef2af7 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ExcludeReactorProjectsArtifactFilter.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/resolvers/ExcludeReactorProjectsArtifactFilter.java
@@ -22,6 +22,7 @@
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
+
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.ArtifactUtils;
import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
diff --git a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ExcludeReactorProjectsDependencyFilter.java b/src/main/java/org/apache/maven/plugins/dependency/resolvers/ExcludeReactorProjectsDependencyFilter.java
index 98a60bfda..ef82569fa 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ExcludeReactorProjectsDependencyFilter.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/resolvers/ExcludeReactorProjectsDependencyFilter.java
@@ -20,56 +20,39 @@
import java.util.List;
import java.util.Set;
+import java.util.function.Predicate;
import java.util.stream.Collectors;
+
import org.apache.maven.artifact.ArtifactUtils;
import org.apache.maven.model.Dependency;
-import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;
-import org.apache.maven.shared.artifact.filter.resolve.AbstractFilter;
-import org.apache.maven.shared.artifact.filter.resolve.Node;
-import org.apache.maven.shared.artifact.filter.resolve.TransformableFilter;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
/**
- * {@link TransformableFilter} implementation that excludes artifacts found in the Reactor.
+ * Filter implementation that excludes artifacts found in the Reactor.
*
* @author Maarten Mulders
*/
-public class ExcludeReactorProjectsDependencyFilter extends AbstractFilter {
- private final Log log;
+public class ExcludeReactorProjectsDependencyFilter implements Predicate {
+ private final Logger log = LoggerFactory.getLogger(ExcludeReactorProjectsDependencyFilter.class);
private final Set reactorArtifactKeys;
- public ExcludeReactorProjectsDependencyFilter(final List reactorProjects, final Log log) {
- this.log = log;
+ public ExcludeReactorProjectsDependencyFilter(final List reactorProjects) {
this.reactorArtifactKeys = reactorProjects.stream()
.map(project -> ArtifactUtils.key(project.getArtifact()))
.collect(Collectors.toSet());
}
@Override
- public boolean accept(final Node node, final List parents) {
- final Dependency dependency = node.getDependency();
- if (dependency != null) {
- final String dependencyArtifactKey =
- ArtifactUtils.key(dependency.getGroupId(), dependency.getArtifactId(), dependency.getVersion());
-
- final boolean result = isDependencyArtifactInReactor(dependencyArtifactKey);
-
- if (log.isDebugEnabled() && result) {
- log.debug("Skipped dependency " + dependencyArtifactKey + " because it is present in the reactor");
+ public boolean test(Dependency dependency) {
+ String key = ArtifactUtils.key(dependency.getGroupId(), dependency.getArtifactId(), dependency.getVersion());
+ if (reactorArtifactKeys.contains(key)) {
+ if (log.isDebugEnabled()) {
+ log.debug("Skipped dependency {} because it is present in the reactor", key);
}
-
- return !result;
+ return false;
}
return true;
}
-
- private boolean isDependencyArtifactInReactor(final String dependencyArtifactKey) {
- for (final String reactorArtifactKey : this.reactorArtifactKeys) {
- // This check only includes GAV. Should we take a look at the types, too?
- if (reactorArtifactKey.equals(dependencyArtifactKey)) {
- return true;
- }
- }
- return false;
- }
}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/resolvers/GoOfflineMojo.java b/src/main/java/org/apache/maven/plugins/dependency/resolvers/GoOfflineMojo.java
index a0f8e09ab..e86d0f832 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/resolvers/GoOfflineMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/resolvers/GoOfflineMojo.java
@@ -18,159 +18,277 @@
*/
package org.apache.maven.plugins.dependency.resolvers;
+import javax.inject.Inject;
+
+import java.util.Arrays;
import java.util.Collection;
+import java.util.Collections;
import java.util.HashSet;
-import java.util.LinkedHashSet;
+import java.util.List;
import java.util.Set;
+import java.util.function.Predicate;
import java.util.stream.Collectors;
+
+import org.apache.maven.RepositoryUtils;
import org.apache.maven.artifact.Artifact;
-import org.apache.maven.artifact.repository.ArtifactRepository;
+import org.apache.maven.artifact.DefaultArtifact;
+import org.apache.maven.artifact.handler.DefaultArtifactHandler;
+import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
import org.apache.maven.model.Dependency;
+import org.apache.maven.model.DependencyManagement;
+import org.apache.maven.model.Plugin;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.plugins.dependency.fromDependencies.AbstractDependencyFilterMojo;
import org.apache.maven.plugins.dependency.utils.DependencyUtil;
-import org.apache.maven.project.ProjectBuildingRequest;
+import org.apache.maven.plugins.dependency.utils.ResolverUtil;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.ProjectBuilder;
+import org.apache.maven.shared.artifact.filter.collection.ArtifactFilterException;
+import org.apache.maven.shared.artifact.filter.collection.ArtifactIdFilter;
import org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter;
-import org.apache.maven.shared.artifact.filter.resolve.TransformableFilter;
-import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResult;
-import org.apache.maven.shared.transfer.dependencies.DefaultDependableCoordinate;
-import org.apache.maven.shared.transfer.dependencies.DependableCoordinate;
-import org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolverException;
+import org.apache.maven.shared.artifact.filter.collection.ClassifierFilter;
+import org.apache.maven.shared.artifact.filter.collection.FilterArtifacts;
+import org.apache.maven.shared.artifact.filter.collection.GroupIdFilter;
+import org.apache.maven.shared.artifact.filter.collection.ScopeFilter;
+import org.apache.maven.shared.artifact.filter.collection.TypeFilter;
+import org.eclipse.aether.artifact.ArtifactTypeRegistry;
+import org.eclipse.aether.resolution.ArtifactResolutionException;
+import org.eclipse.aether.resolution.DependencyResolutionException;
+import org.sonatype.plexus.build.incremental.BuildContext;
+
+import static java.util.Optional.ofNullable;
/**
* Goal that resolves all project dependencies, including plugins and reports and their dependencies.
*
- * Brian Fox
+ * @author Brian Fox
* @author Maarten Mulders
+ * @author Lisa Hardy
* @since 2.0
*/
@Mojo(name = "go-offline", threadSafe = true)
-public class GoOfflineMojo extends AbstractResolveMojo {
+public class GoOfflineMojo extends AbstractDependencyFilterMojo {
+
+ /**
+ * Don't resolve plugins and artifacts that are in the current reactor.
+ *
+ * @since 2.7
+ */
+ @Parameter(property = "excludeReactor", defaultValue = "true")
+ protected boolean excludeReactor;
+
+ @Inject
+ // CHECKSTYLE_OFF: ParameterNumber
+ public GoOfflineMojo(
+ MavenSession session,
+ BuildContext buildContext,
+ MavenProject project,
+ ResolverUtil resolverUtil,
+ ProjectBuilder projectBuilder,
+ ArtifactHandlerManager artifactHandlerManager) {
+ super(session, buildContext, project, resolverUtil, projectBuilder, artifactHandlerManager);
+ }
+ // CHECKSTYLE_ON: ParameterNumber
+
/**
* Main entry into mojo. Gets the list of dependencies, resolves all that are not in the Reactor, and iterates
* through displaying the resolved versions.
*
- * @throws MojoExecutionException with a message if an error occurs.
+ * @throws MojoExecutionException with a message if an error occurs
*/
@Override
protected void doExecute() throws MojoExecutionException {
try {
- final Set plugins = resolvePluginArtifacts();
+ final Set plugins = getProjectPlugins();
- final Set dependencies = resolveDependencyArtifacts();
+ for (Plugin plugin : plugins) {
+ org.eclipse.aether.artifact.Artifact artifact =
+ getResolverUtil().resolvePlugin(plugin);
- if (!isSilent()) {
- for (Artifact artifact : plugins) {
- this.getLog().info("Resolved plugin: " + DependencyUtil.getFormattedFileName(artifact, false));
+ logMessage("Resolved plugin: "
+ + DependencyUtil.getFormattedFileName(RepositoryUtils.toArtifact(artifact), false));
+ if (!excludeTransitive) {
+ logMessage("Resolved plugin dependency:");
+ List artifacts =
+ getResolverUtil().resolveDependencies(plugin);
+ for (org.eclipse.aether.artifact.Artifact a : artifacts) {
+ logMessage(
+ " " + DependencyUtil.getFormattedFileName(RepositoryUtils.toArtifact(a), false));
+ }
}
+ }
- for (Artifact artifact : dependencies) {
- this.getLog().info("Resolved dependency: " + DependencyUtil.getFormattedFileName(artifact, false));
- }
+ final List dependencies = resolveDependencyArtifacts();
+
+ for (org.eclipse.aether.artifact.Artifact artifact : dependencies) {
+ logMessage("Resolved dependency: "
+ + DependencyUtil.getFormattedFileName(RepositoryUtils.toArtifact(artifact), false));
}
- } catch (DependencyResolverException e) {
+ } catch (ArtifactFilterException | ArtifactResolutionException | DependencyResolutionException e) {
throw new MojoExecutionException(e.getMessage(), e);
}
}
+ private void logMessage(String message) {
+ if (isSilent()) {
+ getLog().debug(message);
+ } else {
+ getLog().info(message);
+ }
+ }
+
/**
* This method resolves the dependency artifacts from the project.
*
- * @return set of resolved dependency artifacts.
- * @throws DependencyResolverException in case of an error while resolving the artifacts.
+ * @return lis of resolved dependency artifacts
+ * @throws ArtifactFilterException in case of an error while filtering the artifacts
+ * @throws DependencyResolutionException in case of an error while resolving the artifacts
*/
- protected Set resolveDependencyArtifacts() throws DependencyResolverException {
+ protected List resolveDependencyArtifacts()
+ throws ArtifactFilterException, DependencyResolutionException {
Collection dependencies = getProject().getDependencies();
- Set dependableCoordinates = dependencies.stream()
- .map(this::createDependendableCoordinateFromDependency)
- .collect(Collectors.toSet());
+ dependencies = filterDependencies(dependencies);
- ProjectBuildingRequest buildingRequest = newResolveArtifactProjectBuildingRequest();
+ Predicate excludeReactorProjectsDependencyFilter = d -> true;
+ if (this.excludeReactor) {
+ excludeReactorProjectsDependencyFilter = new ExcludeReactorProjectsDependencyFilter(this.reactorProjects);
+ }
- return resolveDependableCoordinate(buildingRequest, dependableCoordinates, "dependencies");
- }
+ ArtifactTypeRegistry artifactTypeRegistry =
+ session.getRepositorySession().getArtifactTypeRegistry();
- private Set resolveDependableCoordinate(
- final ProjectBuildingRequest buildingRequest,
- final Collection dependableCoordinates,
- final String type)
- throws DependencyResolverException {
- final TransformableFilter filter = getTransformableFilter();
+ List dependableCoordinates = dependencies.stream()
+ .filter(excludeReactorProjectsDependencyFilter)
+ .map(d -> RepositoryUtils.toDependency(d, artifactTypeRegistry))
+ .collect(Collectors.toList());
- this.getLog().debug("Resolving '" + type + "' with following repositories:");
- for (ArtifactRepository repo : buildingRequest.getRemoteRepositories()) {
- getLog().debug(repo.getId() + " (" + repo.getUrl() + ")");
- }
+ List managedDependencies = ofNullable(
+ getProject().getDependencyManagement())
+ .map(DependencyManagement::getDependencies)
+ .map(list -> list.stream()
+ .map(d -> RepositoryUtils.toDependency(d, artifactTypeRegistry))
+ .collect(Collectors.toList()))
+ .orElse(null);
- final Set results = new HashSet<>();
+ return getResolverUtil()
+ .resolveDependenciesForArtifact(
+ RepositoryUtils.toArtifact(getProject().getArtifact()),
+ dependableCoordinates,
+ managedDependencies,
+ getProject().getRemoteProjectRepositories());
+ }
- for (DependableCoordinate dependableCoordinate : dependableCoordinates) {
- final Iterable artifactResults =
- getDependencyResolver().resolveDependencies(buildingRequest, dependableCoordinate, filter);
+ /**
+ * This method retrieve plugins list from the project.
+ *
+ * @return set of plugin used in project
+ */
+ private Set getProjectPlugins() {
+ Predicate pluginsFilter = new PluginsIncludeExcludeFilter(
+ toList(includeGroupIds),
+ toList(excludeGroupIds),
+ toList(includeArtifactIds),
+ toList(excludeArtifactIds));
- for (final ArtifactResult artifactResult : artifactResults) {
- results.add(artifactResult.getArtifact());
- }
+ Predicate reactorExclusionFilter = plugin -> true;
+ if (excludeReactor) {
+ reactorExclusionFilter = new PluginsReactorExcludeFilter(session.getProjects());
}
- return results;
+ return getResolverUtil().getProjectPlugins(getProject()).stream()
+ .filter(reactorExclusionFilter)
+ .filter(pluginsFilter)
+ .collect(Collectors.toSet());
}
- private TransformableFilter getTransformableFilter() {
- if (this.excludeReactor) {
- return new ExcludeReactorProjectsDependencyFilter(this.reactorProjects, getLog());
- } else {
- return null;
+ private List toList(String list) {
+ if (list == null || list.isEmpty()) {
+ return Collections.emptyList();
}
+ return Arrays.asList(DependencyUtil.cleanToBeTokenizedString(list).split(","));
}
- /**
- * This method resolves the plugin artifacts from the project.
- *
- * @return set of resolved plugin artifacts.
- * @throws DependencyResolverException in case of an error while resolving the artifacts.
- */
- protected Set resolvePluginArtifacts() throws DependencyResolverException {
+ private Collection filterDependencies(Collection deps) throws ArtifactFilterException {
- Set plugins = getProject().getPluginArtifacts();
- Set reports = getProject().getReportArtifacts();
+ Set artifacts = createArtifactSetFromDependencies(deps);
- Set artifacts = new LinkedHashSet<>();
- artifacts.addAll(reports);
- artifacts.addAll(plugins);
+ final FilterArtifacts filter = getArtifactsFilter();
+ artifacts = filter.filter(artifacts);
- Set dependableCoordinates = artifacts.stream()
- .map(this::createDependendableCoordinateFromArtifact)
- .collect(Collectors.toSet());
-
- ProjectBuildingRequest buildingRequest = newResolvePluginProjectBuildingRequest();
+ return createDependencySetFromArtifacts(artifacts);
+ }
- return resolveDependableCoordinate(buildingRequest, dependableCoordinates, "plugins");
+ private Set createArtifactSetFromDependencies(Collection deps) {
+ Set artifacts = new HashSet<>();
+ for (Dependency dep : deps) {
+ DefaultArtifactHandler handler = new DefaultArtifactHandler(dep.getType());
+ artifacts.add(new DefaultArtifact(
+ dep.getGroupId(),
+ dep.getArtifactId(),
+ dep.getVersion(),
+ dep.getScope(),
+ dep.getType(),
+ dep.getClassifier(),
+ handler));
+ }
+ return artifacts;
}
- private DependableCoordinate createDependendableCoordinateFromArtifact(final Artifact artifact) {
- final DefaultDependableCoordinate result = new DefaultDependableCoordinate();
- result.setGroupId(artifact.getGroupId());
- result.setArtifactId(artifact.getArtifactId());
- result.setVersion(artifact.getVersion());
- result.setType(artifact.getType());
- result.setClassifier(artifact.getClassifier());
+ private Collection createDependencySetFromArtifacts(Set artifacts) {
+ Set dependencies = new HashSet<>();
+
+ for (Artifact artifact : artifacts) {
+ Dependency d = new Dependency();
+ d.setGroupId(artifact.getGroupId());
+ d.setArtifactId(artifact.getArtifactId());
+ d.setVersion(artifact.getVersion());
+ d.setType(artifact.getType());
+ d.setClassifier(artifact.getClassifier());
+ d.setScope(artifact.getScope());
+ dependencies.add(d);
+ }
- return result;
+ return dependencies;
}
- private DependableCoordinate createDependendableCoordinateFromDependency(final Dependency dependency) {
- final DefaultDependableCoordinate result = new DefaultDependableCoordinate();
- result.setGroupId(dependency.getGroupId());
- result.setArtifactId(dependency.getArtifactId());
- result.setVersion(dependency.getVersion());
- result.setType(dependency.getType());
- result.setClassifier(dependency.getClassifier());
+ /**
+ * @return {@link FilterArtifacts}
+ */
+ // TODO: refactor this to use Resolver API filters
+ protected FilterArtifacts getArtifactsFilter() {
+ final FilterArtifacts filter = new FilterArtifacts();
+
+ if (excludeReactor) {
+ filter.addFilter(new ExcludeReactorProjectsArtifactFilter(reactorProjects, getLog()));
+ }
+
+ filter.addFilter(new ScopeFilter(
+ DependencyUtil.cleanToBeTokenizedString(this.includeScope),
+ DependencyUtil.cleanToBeTokenizedString(this.excludeScope)));
+
+ filter.addFilter(new TypeFilter(
+ DependencyUtil.cleanToBeTokenizedString(this.includeTypes),
+ DependencyUtil.cleanToBeTokenizedString(this.excludeTypes)));
+
+ filter.addFilter(new ClassifierFilter(
+ DependencyUtil.cleanToBeTokenizedString(this.includeClassifiers),
+ DependencyUtil.cleanToBeTokenizedString(this.excludeClassifiers)));
+
+ filter.addFilter(new GroupIdFilter(
+ DependencyUtil.cleanToBeTokenizedString(this.includeGroupIds),
+ DependencyUtil.cleanToBeTokenizedString(this.excludeGroupIds)));
+
+ filter.addFilter(new ArtifactIdFilter(
+ DependencyUtil.cleanToBeTokenizedString(this.includeArtifactIds),
+ DependencyUtil.cleanToBeTokenizedString(this.excludeArtifactIds)));
- return result;
+ return filter;
}
@Override
diff --git a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ListMojo.java b/src/main/java/org/apache/maven/plugins/dependency/resolvers/ListMojo.java
index 54cb52c46..306b12d98 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ListMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/resolvers/ListMojo.java
@@ -18,8 +18,16 @@
*/
package org.apache.maven.plugins.dependency.resolvers;
+import javax.inject.Inject;
+
+import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.ResolutionScope;
+import org.apache.maven.plugins.dependency.utils.ResolverUtil;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.ProjectBuilder;
+import org.sonatype.plexus.build.incremental.BuildContext;
/**
* Displays the list of dependencies for this project.
@@ -29,5 +37,18 @@
*/
@Mojo(name = "list", requiresDependencyResolution = ResolutionScope.TEST, threadSafe = true)
public class ListMojo extends ResolveDependenciesMojo {
+
+ @Inject
+ // CHECKSTYLE_OFF: ParameterNumber
+ public ListMojo(
+ MavenSession session,
+ BuildContext buildContext,
+ MavenProject project,
+ ResolverUtil resolverUtil,
+ ProjectBuilder projectBuilder,
+ ArtifactHandlerManager artifactHandlerManager) {
+ super(session, buildContext, project, resolverUtil, projectBuilder, artifactHandlerManager);
+ }
+ // CHECKSTYLE_ON: ParameterNumber
// alias for dependency:resolve
}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ListRepositoriesMojo.java b/src/main/java/org/apache/maven/plugins/dependency/resolvers/ListRepositoriesMojo.java
deleted file mode 100644
index 59a785ce3..000000000
--- a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ListRepositoriesMojo.java
+++ /dev/null
@@ -1,66 +0,0 @@
-/*
- * 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.plugins.dependency.resolvers;
-
-import org.apache.maven.artifact.repository.ArtifactRepository;
-import org.apache.maven.plugin.MojoExecutionException;
-import org.apache.maven.plugins.annotations.Component;
-import org.apache.maven.plugins.annotations.Mojo;
-import org.apache.maven.plugins.annotations.ResolutionScope;
-import org.apache.maven.plugins.dependency.AbstractDependencyMojo;
-import org.apache.maven.shared.transfer.dependencies.collect.CollectorResult;
-import org.apache.maven.shared.transfer.dependencies.collect.DependencyCollector;
-import org.apache.maven.shared.transfer.dependencies.collect.DependencyCollectorException;
-
-/**
- * Goal that resolves all project dependencies and then lists the repositories used by the build and by the transitive
- * dependencies
- *
- * @author Brian Fox
- * @since 2.2
- */
-@Mojo(name = "list-repositories", requiresDependencyResolution = ResolutionScope.TEST, threadSafe = true)
-public class ListRepositoriesMojo extends AbstractDependencyMojo {
- /**
- * Dependency collector, needed to resolve dependencies.
- */
- @Component(role = DependencyCollector.class)
- private DependencyCollector dependencyCollector;
-
- /**
- * Displays a list of the repositories used by this build.
- *
- * @throws MojoExecutionException with a message if an error occurs.
- */
- @Override
- protected void doExecute() throws MojoExecutionException {
- try {
- CollectorResult collectResult = dependencyCollector.collectDependencies(
- session.getProjectBuildingRequest(), getProject().getModel());
-
- this.getLog().info("Repositories used by this build:");
-
- for (ArtifactRepository repo : collectResult.getRemoteRepositories()) {
- this.getLog().info(repo.toString());
- }
- } catch (DependencyCollectorException e) {
- throw new MojoExecutionException("Unable to resolve artifacts", e);
- }
- }
-}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/resolvers/OldResolveDependencySourcesMojo.java b/src/main/java/org/apache/maven/plugins/dependency/resolvers/OldResolveDependencySourcesMojo.java
new file mode 100644
index 000000000..866c1b84e
--- /dev/null
+++ b/src/main/java/org/apache/maven/plugins/dependency/resolvers/OldResolveDependencySourcesMojo.java
@@ -0,0 +1,60 @@
+/*
+ * 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.plugins.dependency.resolvers;
+
+import javax.inject.Inject;
+
+import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
+import org.apache.maven.plugins.annotations.LifecyclePhase;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.ResolutionScope;
+import org.apache.maven.plugins.dependency.utils.ResolverUtil;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.ProjectBuilder;
+import org.sonatype.plexus.build.incremental.BuildContext;
+
+/**
+ * Goal that resolves the project source dependencies from the repository.
+ *
+ * @author Brian Fox
+ * @since 2.0-alpha2
+ * @deprecated in favor of {@code resolve-sources} goal and will be removed in a future version
+ */
+@Mojo(
+ name = "sources",
+ defaultPhase = LifecyclePhase.GENERATE_SOURCES,
+ requiresDependencyResolution = ResolutionScope.TEST,
+ threadSafe = true)
+@Deprecated
+public class OldResolveDependencySourcesMojo extends ResolveDependencySourcesMojo {
+
+ @Inject
+ // CHECKSTYLE_OFF: ParameterNumber
+ public OldResolveDependencySourcesMojo(
+ MavenSession session,
+ BuildContext buildContext,
+ MavenProject project,
+ ResolverUtil resolverUtil,
+ ProjectBuilder projectBuilder,
+ ArtifactHandlerManager artifactHandlerManager) {
+ super(session, buildContext, project, resolverUtil, projectBuilder, artifactHandlerManager);
+ }
+ // CHECKSTYLE_ON: ParameterNumber
+}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/resolvers/PluginsIncludeExcludeFilter.java b/src/main/java/org/apache/maven/plugins/dependency/resolvers/PluginsIncludeExcludeFilter.java
new file mode 100644
index 000000000..7de7a7f44
--- /dev/null
+++ b/src/main/java/org/apache/maven/plugins/dependency/resolvers/PluginsIncludeExcludeFilter.java
@@ -0,0 +1,65 @@
+/*
+ * 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.plugins.dependency.resolvers;
+
+import java.util.List;
+import java.util.function.Predicate;
+
+import org.apache.maven.model.Plugin;
+
+/**
+ * A filter to include or exclude plugins.
+ */
+class PluginsIncludeExcludeFilter implements Predicate {
+ private final List includesGroupId;
+
+ private final List excludesGroupId;
+
+ private final List includesArtifactId;
+
+ private final List excludesArtifactId;
+
+ PluginsIncludeExcludeFilter(
+ List includeGroupIds,
+ List excludeGroupIds,
+ List includeArtifactIds,
+ List excludeArtifactIds) {
+ this.includesGroupId = includeGroupIds;
+ this.excludesGroupId = excludeGroupIds;
+ this.includesArtifactId = includeArtifactIds;
+ this.excludesArtifactId = excludeArtifactIds;
+ }
+
+ @Override
+ public boolean test(Plugin plugin) {
+ if (!includesGroupId.isEmpty() && !includesGroupId.contains(plugin.getGroupId())) {
+ return false;
+ }
+
+ if (excludesGroupId.contains(plugin.getGroupId())) {
+ return false;
+ }
+
+ if (!includesArtifactId.isEmpty() && !includesArtifactId.contains(plugin.getArtifactId())) {
+ return false;
+ }
+
+ return !excludesArtifactId.contains(plugin.getArtifactId());
+ }
+}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/resolvers/PluginsReactorExcludeFilter.java b/src/main/java/org/apache/maven/plugins/dependency/resolvers/PluginsReactorExcludeFilter.java
new file mode 100644
index 000000000..42c11c3ac
--- /dev/null
+++ b/src/main/java/org/apache/maven/plugins/dependency/resolvers/PluginsReactorExcludeFilter.java
@@ -0,0 +1,49 @@
+/*
+ * 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.plugins.dependency.resolvers;
+
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Set;
+import java.util.function.Predicate;
+
+import org.apache.maven.artifact.ArtifactUtils;
+import org.apache.maven.model.Plugin;
+import org.apache.maven.project.MavenProject;
+
+/**
+ * A filter to exclude plugins that are part of the current reactor build.
+ */
+class PluginsReactorExcludeFilter implements Predicate {
+
+ private final Set reactorArtifactKeys;
+
+ PluginsReactorExcludeFilter(List reactorProjects) {
+ this.reactorArtifactKeys = new LinkedHashSet<>(reactorProjects.size());
+ for (final MavenProject project : reactorProjects) {
+ this.reactorArtifactKeys.add(ArtifactUtils.key(project.getArtifact()));
+ }
+ }
+
+ @Override
+ public boolean test(Plugin plugin) {
+ String pluginKey = ArtifactUtils.key(plugin.getGroupId(), plugin.getArtifactId(), plugin.getVersion());
+ return !reactorArtifactKeys.contains(pluginKey);
+ }
+}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependenciesMojo.java b/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependenciesMojo.java
index be09c9afb..b9bf0fb5b 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependenciesMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependenciesMojo.java
@@ -18,6 +18,8 @@
*/
package org.apache.maven.plugins.dependency.resolvers;
+import javax.inject.Inject;
+
import java.io.File;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
@@ -30,7 +32,10 @@
import java.util.Set;
import java.util.jar.JarFile;
import java.util.jar.Manifest;
+
import org.apache.maven.artifact.Artifact;
+import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
@@ -38,33 +43,35 @@
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.plugins.dependency.utils.DependencyStatusSets;
import org.apache.maven.plugins.dependency.utils.DependencyUtil;
+import org.apache.maven.plugins.dependency.utils.ResolverUtil;
import org.apache.maven.plugins.dependency.utils.filters.ResolveFileFilter;
import org.apache.maven.plugins.dependency.utils.markers.SourcesFileMarkerHandler;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.ProjectBuilder;
import org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter;
import org.apache.maven.shared.utils.logging.MessageBuilder;
import org.apache.maven.shared.utils.logging.MessageUtils;
+import org.sonatype.plexus.build.incremental.BuildContext;
/**
- * Goal that resolves the project dependencies from the repository. When using this goal while running on Java 9 the
+ * Goal that resolves the project dependencies from the repository. When running on Java 9, the
* module names will be visible as well.
*
* @author Brian Fox
* @since 2.0
*/
-// CHECKSTYLE_OFF: LineLength
@Mojo(
name = "resolve",
requiresDependencyResolution = ResolutionScope.TEST,
defaultPhase = LifecyclePhase.GENERATE_SOURCES,
threadSafe = true)
-// CHECKSTYLE_ON: LineLength
public class ResolveDependenciesMojo extends AbstractResolveMojo {
@Parameter(property = "outputEncoding", defaultValue = "${project.reporting.outputEncoding}")
private String outputEncoding;
/**
- * If we should display the scope when resolving
+ * If we should display the scope when resolving.
*
* @since 2.0-alpha-2
*/
@@ -72,7 +79,15 @@ public class ResolveDependenciesMojo extends AbstractResolveMojo {
protected boolean outputScope;
/**
- * Only used to store results for integration test validation
+ * Output absolute filename for resolved artifacts.
+ *
+ * @since 2.0
+ */
+ @Parameter(property = "outputAbsoluteArtifactFilename", defaultValue = "false")
+ private boolean outputAbsoluteArtifactFilename;
+
+ /**
+ * Only used to store results for integration test validation.
*/
DependencyStatusSets results;
@@ -92,6 +107,19 @@ public class ResolveDependenciesMojo extends AbstractResolveMojo {
@Parameter(property = "includeParents", defaultValue = "false")
boolean includeParents;
+ @Inject
+ // CHECKSTYLE_OFF: ParameterNumber
+ public ResolveDependenciesMojo(
+ MavenSession session,
+ BuildContext buildContext,
+ MavenProject project,
+ ResolverUtil resolverUtil,
+ ProjectBuilder projectBuilder,
+ ArtifactHandlerManager artifactHandlerManager) {
+ super(session, buildContext, project, resolverUtil, projectBuilder, artifactHandlerManager);
+ }
+ // CHECKSTYLE_ON: ParameterNumber
+
/**
* Main entry into mojo. Gets the list of dependencies and iterates through displaying the resolved version.
*
@@ -135,7 +163,9 @@ protected ArtifactsFilter getMarkedArtifactFilter() {
*/
public String getOutput(boolean outputAbsoluteArtifactFilename, boolean theOutputScope, boolean theSort) {
StringBuilder sb = new StringBuilder();
- sb.append(System.lineSeparator());
+ if (outputFile == null) {
+ sb.append(System.lineSeparator());
+ }
sb.append("The following files have been resolved:");
sb.append(System.lineSeparator());
if (results.getResolvedDependencies() == null
@@ -175,9 +205,13 @@ private StringBuilder buildArtifactListOutput(
Set artifacts, boolean outputAbsoluteArtifactFilename, boolean theOutputScope, boolean theSort) {
StringBuilder sb = new StringBuilder();
List artifactStringList = new ArrayList<>();
+ /* if (outputFile != null) {
+ MessageUtils.setColorEnabled(false);
+ } else {
+ MessageUtils.setColorEnabled(true);
+ } */
for (Artifact artifact : artifacts) {
MessageBuilder messageBuilder = MessageUtils.buffer();
-
messageBuilder.a(" ");
if (theOutputScope) {
@@ -217,7 +251,7 @@ private StringBuilder buildArtifactListOutput(
}
}
}
- artifactStringList.add(messageBuilder + System.lineSeparator());
+ artifactStringList.add(messageBuilder.build() + System.lineSeparator());
}
if (theSort) {
Collections.sort(artifactStringList);
@@ -277,7 +311,7 @@ private ModuleDescriptor getModuleDescriptor(File artifactFile) {
} catch (ClassNotFoundException | SecurityException | IllegalAccessException | IllegalArgumentException e) {
// do nothing
} catch (NoSuchMethodException e) {
- e.printStackTrace();
+ getLog().warn(e);
} catch (InvocationTargetException e) {
Throwable cause = e.getCause();
while (cause.getCause() != null) {
@@ -288,7 +322,7 @@ private ModuleDescriptor getModuleDescriptor(File artifactFile) {
return moduleDescriptor;
}
- private class ModuleDescriptor {
+ private static class ModuleDescriptor {
String name;
boolean automatic = true;
diff --git a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependencySourcesMojo.java b/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependencySourcesMojo.java
index 21e8cce3b..24c7b7a67 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependencySourcesMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependencySourcesMojo.java
@@ -18,37 +18,49 @@
*/
package org.apache.maven.plugins.dependency.resolvers;
-import org.apache.maven.plugin.MojoExecutionException;
+import javax.inject.Inject;
+
+import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
+import org.apache.maven.plugins.dependency.utils.ResolverUtil;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.ProjectBuilder;
+import org.sonatype.plexus.build.incremental.BuildContext;
/**
* Goal that resolves the project source dependencies from the repository.
*
* @author Brian Fox
- * @since 2.0-alpha2
+ * @since 2.0-alpha2/3.7.0
*/
@Mojo(
- name = "sources",
+ name = "resolve-sources",
defaultPhase = LifecyclePhase.GENERATE_SOURCES,
requiresDependencyResolution = ResolutionScope.TEST,
threadSafe = true)
public class ResolveDependencySourcesMojo extends ResolveDependenciesMojo {
- private static final String SOURCE_CLASSIFIER = "sources";
+ private static final String SOURCES_CLASSIFIER = "sources";
- /**
- * Main entry into mojo. Gets the list of dependencies and iterates through resolving the source jars.
- *
- * @throws MojoExecutionException with a message if an error occurs.
- */
- @Override
- protected void doExecute() throws MojoExecutionException {
- if (this.classifier == null || this.classifier.isEmpty()) {
- this.classifier = SOURCE_CLASSIFIER;
- }
+ @Inject
+ // CHECKSTYLE_OFF: ParameterNumber
+ public ResolveDependencySourcesMojo(
+ MavenSession session,
+ BuildContext buildContext,
+ MavenProject project,
+ ResolverUtil resolverUtil,
+ ProjectBuilder projectBuilder,
+ ArtifactHandlerManager artifactHandlerManager) {
+ super(session, buildContext, project, resolverUtil, projectBuilder, artifactHandlerManager);
+ }
+ // CHECKSTYLE_ON: ParameterNumber
- super.doExecute();
+ @Parameter(name = "classifier", defaultValue = SOURCES_CLASSIFIER, readonly = true)
+ public void setClassifier(String classifier) {
+ this.classifier = classifier;
}
}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolvePluginsMojo.java b/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolvePluginsMojo.java
index b2393f717..2840ae615 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolvePluginsMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolvePluginsMojo.java
@@ -18,23 +18,31 @@
*/
package org.apache.maven.plugins.dependency.resolvers;
+import javax.inject.Inject;
+
+import java.io.File;
import java.io.IOException;
-import java.util.LinkedHashSet;
+import java.util.List;
import java.util.Objects;
+import java.util.Optional;
import java.util.Set;
-import org.apache.maven.artifact.Artifact;
+import java.util.function.Predicate;
+import java.util.stream.Collectors;
+
+import org.apache.maven.execution.MavenSession;
+import org.apache.maven.model.Plugin;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.plugins.dependency.AbstractDependencyMojo;
import org.apache.maven.plugins.dependency.utils.DependencyUtil;
-import org.apache.maven.project.ProjectBuildingRequest;
-import org.apache.maven.shared.artifact.filter.collection.ArtifactFilterException;
-import org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter;
-import org.apache.maven.shared.artifact.filter.collection.FilterArtifacts;
-import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolverException;
-import org.apache.maven.shared.transfer.dependencies.DefaultDependableCoordinate;
-import org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolverException;
+import org.apache.maven.plugins.dependency.utils.ResolverUtil;
+import org.apache.maven.project.MavenProject;
+import org.eclipse.aether.artifact.Artifact;
+import org.eclipse.aether.resolution.ArtifactResolutionException;
+import org.eclipse.aether.resolution.DependencyResolutionException;
+import org.sonatype.plexus.build.incremental.BuildContext;
/**
* Goal that resolves all project plugins and reports and their dependencies.
@@ -43,66 +51,144 @@
* @since 2.0
*/
@Mojo(name = "resolve-plugins", defaultPhase = LifecyclePhase.GENERATE_SOURCES, threadSafe = true)
-public class ResolvePluginsMojo extends AbstractResolveMojo {
+public class ResolvePluginsMojo extends AbstractDependencyMojo {
+
+ /**
+ * If specified, this parameter causes the dependencies to be written to the path specified instead of
+ * the console.
+ *
+ * @since 2.0
+ */
+ @Parameter(property = "outputFile")
+ protected File outputFile;
+
+ /**
+ * If we should exclude transitive dependencies.
+ * This means only the plugin artifacts itself will be resolved not plugin dependencies.
+ *
+ * @since 2.0
+ */
+ @Parameter(property = "excludeTransitive", defaultValue = "false")
+ protected boolean excludeTransitive;
+
+ /**
+ * List of artifact IDs to exclude.
+ *
+ * @since 2.0
+ */
+ @Parameter(property = "excludeArtifactIds", defaultValue = "")
+ protected List excludeArtifactIds;
+
+ /**
+ * List of artifact IDs to include. Empty list indicates include everything (default).
+ *
+ * @since 2.0
+ */
+ @Parameter(property = "includeArtifactIds", defaultValue = "")
+ protected List includeArtifactIds;
+
+ /**
+ * List of group IDs to exclude.
+ *
+ * @since 2.0
+ */
+ @Parameter(property = "excludeGroupIds", defaultValue = "")
+ protected List excludeGroupIds;
+
+ /**
+ * List of group IDs to include. Empty list indicates include everything (default).
+ *
+ * @since 2.0
+ */
+ @Parameter(property = "includeGroupIds", defaultValue = "")
+ protected List includeGroupIds;
+ /**
+ * Whether to append outputs into the output file or overwrite it.
+ *
+ * @since 2.2
+ */
+ @Parameter(property = "appendOutput", defaultValue = "false")
+ protected boolean appendOutput;
+
+ /**
+ * Don't resolve plugins that are in the current reactor.
+ *
+ * @since 2.7
+ */
+ @Parameter(property = "excludeReactor", defaultValue = "true")
+ protected boolean excludeReactor;
+
+ /**
+ * The encoding of the output file.
+ *
+ * @since 3.2.0
+ */
@Parameter(property = "outputEncoding", defaultValue = "${project.reporting.outputEncoding}")
private String outputEncoding;
+ /**
+ * Output absolute filename for resolved artifacts.
+ *
+ * @since 2.0
+ */
+ @Parameter(property = "outputAbsoluteArtifactFilename", defaultValue = "false")
+ private boolean outputAbsoluteArtifactFilename;
+
+ private final ResolverUtil resolverUtil;
+
+ @Inject
+ public ResolvePluginsMojo(
+ MavenSession session, BuildContext buildContext, MavenProject project, ResolverUtil resolverUtil) {
+ super(session, buildContext, project);
+ this.resolverUtil = resolverUtil;
+ }
+
/**
* Main entry into mojo. Gets the list of dependencies and iterates through displaying the resolved version.
*
- * @throws MojoExecutionException with a message if an error occurs.
+ * @throws MojoExecutionException with a message if an error occurs
*/
@Override
protected void doExecute() throws MojoExecutionException {
try {
// ideally this should either be DependencyCoordinates or DependencyNode
- final Set plugins = resolvePluginArtifacts();
+ final Set plugins = getProjectPlugins();
StringBuilder sb = new StringBuilder();
sb.append(System.lineSeparator());
sb.append("The following plugins have been resolved:");
sb.append(System.lineSeparator());
- if (plugins == null || plugins.isEmpty()) {
+ if (plugins.isEmpty()) {
sb.append(" none");
sb.append(System.lineSeparator());
} else {
- for (Artifact plugin : plugins) {
+ for (Plugin plugin : plugins) {
+ Artifact pluginArtifact = resolverUtil.resolvePlugin(plugin);
String artifactFilename = null;
if (outputAbsoluteArtifactFilename) {
- try {
- // we want to print the absolute file name here
- artifactFilename =
- plugin.getFile().getAbsoluteFile().getPath();
- } catch (NullPointerException e) {
- // ignore the null pointer, we'll output a null string
- artifactFilename = null;
- }
+ // we want to print the absolute file name here
+ artifactFilename = Optional.ofNullable(pluginArtifact.getFile())
+ .map(File::getAbsoluteFile)
+ .map(File::getPath)
+ .orElse(null);
}
- String id = plugin.toString();
+ String id = pluginArtifact.toString();
sb.append(" ")
.append(id)
.append(outputAbsoluteArtifactFilename ? ":" + artifactFilename : "")
.append(System.lineSeparator());
if (!excludeTransitive) {
- DefaultDependableCoordinate pluginCoordinate = new DefaultDependableCoordinate();
- pluginCoordinate.setGroupId(plugin.getGroupId());
- pluginCoordinate.setArtifactId(plugin.getArtifactId());
- pluginCoordinate.setVersion(plugin.getVersion());
-
- for (final Artifact artifact : resolveArtifactDependencies(pluginCoordinate)) {
+ for (Artifact artifact : resolverUtil.resolveDependencies(plugin)) {
artifactFilename = null;
if (outputAbsoluteArtifactFilename) {
- try {
- // we want to print the absolute file name here
- artifactFilename =
- artifact.getFile().getAbsoluteFile().getPath();
- } catch (NullPointerException e) {
- // ignore the null pointer, we'll output a null string
- artifactFilename = null;
- }
+ // we want to print the absolute file name here
+ artifactFilename = Optional.ofNullable(artifact.getFile())
+ .map(File::getAbsoluteFile)
+ .map(File::getPath)
+ .orElse(null);
}
id = artifact.toString();
@@ -123,58 +209,29 @@ protected void doExecute() throws MojoExecutionException {
DependencyUtil.write(output, outputFile, appendOutput, encoding);
}
}
- } catch (IOException | ArtifactFilterException | ArtifactResolverException | DependencyResolverException e) {
+ } catch (IOException | ArtifactResolutionException | DependencyResolutionException e) {
throw new MojoExecutionException(e.getMessage(), e);
}
}
/**
- * This method resolves the plugin artifacts from the project.
+ * This return plugin list of the project after applying the include/exclude filters.
*
- * @return set of resolved plugin artifacts
- * @throws ArtifactFilterException in case of an error
- * @throws ArtifactResolverException in case of an error
+ * @return set of project plugin
*/
- protected Set resolvePluginArtifacts() throws ArtifactFilterException, ArtifactResolverException {
- final Set plugins = getProject().getPluginArtifacts();
- final Set reports = getProject().getReportArtifacts();
-
- Set artifacts = new LinkedHashSet<>();
- artifacts.addAll(reports);
- artifacts.addAll(plugins);
-
- final FilterArtifacts filter = getArtifactsFilter();
- artifacts = filter.filter(artifacts);
-
- Set resolvedArtifacts = new LinkedHashSet<>(artifacts.size());
- // final ArtifactFilter filter = getPluginFilter();
- for (final Artifact artifact : new LinkedHashSet<>(artifacts)) {
- // if ( !filter.include( artifact ) )
- // {
- // final String logStr =
- // String.format( " Plugin SKIPPED: %s", DependencyUtil.getFormattedFileName( artifact, false ) );
- //
- // if ( !silent )
- // {
- // this.getLog().info( logStr );
- // }
- //
- // artifacts.remove( artifact );
- // continue;
- // }
-
- ProjectBuildingRequest buildingRequest = newResolvePluginProjectBuildingRequest();
-
- // resolve the new artifact
- resolvedArtifacts.add(getArtifactResolver()
- .resolveArtifact(buildingRequest, artifact)
- .getArtifact());
+ private Set getProjectPlugins() {
+
+ Predicate pluginsFilter = new PluginsIncludeExcludeFilter(
+ includeGroupIds, excludeGroupIds, includeArtifactIds, excludeArtifactIds);
+
+ Predicate reactorExclusionFilter = plugin -> true;
+ if (excludeReactor) {
+ reactorExclusionFilter = new PluginsReactorExcludeFilter(session.getProjects());
}
- return artifacts;
- }
- @Override
- protected ArtifactsFilter getMarkedArtifactFilter() {
- return null;
+ return resolverUtil.getProjectPlugins(getProject()).stream()
+ .filter(reactorExclusionFilter)
+ .filter(pluginsFilter)
+ .collect(Collectors.toSet());
}
}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/tree/AbstractSerializingVisitor.java b/src/main/java/org/apache/maven/plugins/dependency/tree/AbstractSerializingVisitor.java
index 8f8f40ed8..658813164 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/tree/AbstractSerializingVisitor.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/tree/AbstractSerializingVisitor.java
@@ -18,7 +18,6 @@
*/
package org.apache.maven.plugins.dependency.tree;
-import java.io.PrintWriter;
import java.io.Writer;
/**
@@ -31,7 +30,7 @@ public abstract class AbstractSerializingVisitor {
/**
* The writer to serialize to.
*/
- protected final PrintWriter writer;
+ protected final Writer writer;
/**
* Constructor.
@@ -39,13 +38,9 @@ public abstract class AbstractSerializingVisitor {
* Build a new AbstractSerializingDependencyNodeVisitor with the writer to serialize to.
*
*
- * @param writer the writer to serialize to.
+ * @param writer the writer to serialize to
*/
public AbstractSerializingVisitor(Writer writer) {
- if (writer instanceof PrintWriter) {
- this.writer = (PrintWriter) writer;
- } else {
- this.writer = new PrintWriter(writer, true);
- }
+ this.writer = writer;
}
}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/tree/BuildingDependencyNodeVisitor.java b/src/main/java/org/apache/maven/plugins/dependency/tree/BuildingDependencyNodeVisitor.java
index 7834c50db..411a1fb5c 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/tree/BuildingDependencyNodeVisitor.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/tree/BuildingDependencyNodeVisitor.java
@@ -21,6 +21,7 @@
import java.util.ArrayList;
import java.util.List;
import java.util.Stack;
+
import org.apache.maven.artifact.Artifact;
import org.apache.maven.model.Exclusion;
import org.apache.maven.shared.dependency.graph.DependencyNode;
@@ -69,7 +70,7 @@ public BuildingDependencyNodeVisitor() {
public BuildingDependencyNodeVisitor(DependencyNodeVisitor visitor) {
this.visitor = visitor;
- parentNodes = new Stack();
+ parentNodes = new Stack<>();
}
// DependencyNodeVisitor methods ------------------------------------------
@@ -89,7 +90,7 @@ public boolean visit(DependencyNode node) {
node.getOptional(),
node.getExclusions(),
node.toNodeString());
- newNode.setChildren(new ArrayList());
+ newNode.setChildren(new ArrayList<>());
if (parentNodes.empty()) {
rootNode = newNode;
diff --git a/src/main/java/org/apache/maven/plugins/dependency/tree/DOTDependencyNodeVisitor.java b/src/main/java/org/apache/maven/plugins/dependency/tree/DOTDependencyNodeVisitor.java
index bf4e0a947..0508a313a 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/tree/DOTDependencyNodeVisitor.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/tree/DOTDependencyNodeVisitor.java
@@ -18,8 +18,11 @@
*/
package org.apache.maven.plugins.dependency.tree;
+import java.io.IOException;
+import java.io.UncheckedIOException;
import java.io.Writer;
import java.util.List;
+
import org.apache.maven.shared.dependency.graph.DependencyNode;
import org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor;
@@ -35,7 +38,7 @@ public class DOTDependencyNodeVisitor extends AbstractSerializingVisitor impleme
/**
* Constructor.
*
- * @param writer the writer to write to.
+ * @param writer the writer to write to
*/
public DOTDependencyNodeVisitor(Writer writer) {
super(writer);
@@ -46,16 +49,23 @@ public DOTDependencyNodeVisitor(Writer writer) {
*/
@Override
public boolean visit(DependencyNode node) {
- if (node.getParent() == null || node.getParent() == node) {
- writer.write("digraph \"" + node.toNodeString() + "\" { " + System.lineSeparator());
- }
+ try {
+ if (node.getParent() == null || node.getParent() == node) {
+ writer.write("digraph \"" + node.toNodeString() + "\" { " + System.lineSeparator());
+ writer.flush();
+ }
- // Generate "currentNode -> Child" lines
+ // Generate "currentNode -> Child" lines
- List children = node.getChildren();
+ List children = node.getChildren();
- for (DependencyNode child : children) {
- writer.println("\t\"" + node.toNodeString() + "\" -> \"" + child.toNodeString() + "\" ; ");
+ for (DependencyNode child : children) {
+ writer.write("\t\"" + node.toNodeString() + "\" -> \"" + child.toNodeString() + "\" ; "
+ + System.lineSeparator());
+ }
+ writer.flush();
+ } catch (IOException e) {
+ throw new UncheckedIOException("Failed to write DOT format output", e);
}
return true;
@@ -66,8 +76,13 @@ public boolean visit(DependencyNode node) {
*/
@Override
public boolean endVisit(DependencyNode node) {
- if (node.getParent() == null || node.getParent() == node) {
- writer.write(" } ");
+ try {
+ if (node.getParent() == null || node.getParent() == node) {
+ writer.write(" } " + System.lineSeparator());
+ writer.flush();
+ }
+ } catch (IOException e) {
+ throw new UncheckedIOException("Failed to write DOT format output", e);
}
return true;
}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/tree/GraphmlDependencyNodeVisitor.java b/src/main/java/org/apache/maven/plugins/dependency/tree/GraphmlDependencyNodeVisitor.java
index 11f75ff85..c81a81a61 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/tree/GraphmlDependencyNodeVisitor.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/tree/GraphmlDependencyNodeVisitor.java
@@ -18,7 +18,10 @@
*/
package org.apache.maven.plugins.dependency.tree;
+import java.io.IOException;
+import java.io.UncheckedIOException;
import java.io.Writer;
+
import org.apache.maven.shared.dependency.graph.DependencyNode;
import org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor;
@@ -52,7 +55,7 @@ public class GraphmlDependencyNodeVisitor extends AbstractSerializingVisitor imp
/**
* Constructor.
*
- * @param writer the writer to write to.
+ * @param writer the writer to write to
*/
public GraphmlDependencyNodeVisitor(Writer writer) {
super(writer);
@@ -63,19 +66,24 @@ public GraphmlDependencyNodeVisitor(Writer writer) {
*/
@Override
public boolean endVisit(DependencyNode node) {
- if (node.getParent() == null || node.getParent() == node) {
- writer.write(GRAPHML_FOOTER);
- } else {
- DependencyNode p = node.getParent();
- writer.print("");
- if (node.getArtifact().getScope() != null) {
- // add Edge label
- writer.print(""
- + node.getArtifact().getScope() + " ");
+ if (node.getArtifact().getScope() != null) {
+ // add Edge label
+ writer.write(""
+ + node.getArtifact().getScope() + " " + System.lineSeparator());
}
- writer.println(" ");
+ writer.flush();
+ return true;
+ } catch (IOException e) {
+ throw new UncheckedIOException("Failed to write GraphML format output", e);
}
- return true;
}
/**
@@ -83,16 +91,22 @@ public boolean endVisit(DependencyNode node) {
*/
@Override
public boolean visit(DependencyNode node) {
- if (node.getParent() == null || node.getParent() == node) {
- writer.write(GRAPHML_HEADER);
+ try {
+ if (node.getParent() == null || node.getParent() == node) {
+ writer.write(GRAPHML_HEADER);
+ writer.flush();
+ }
+ // write node
+ writer.write("");
+ // add node label
+ writer.write("" + node.toNodeString()
+ + " " + System.lineSeparator());
+ writer.flush();
+ return true;
+ } catch (IOException e) {
+ throw new UncheckedIOException("Failed to write GraphML format output", e);
}
- // write node
- writer.print("");
- // add node label
- writer.print("" + node.toNodeString()
- + " ");
- return true;
}
/**
@@ -101,8 +115,8 @@ public boolean visit(DependencyNode node) {
* Current implementation is rather simple and uses hashcode.
*
*
- * @param node the DependencyNode to use.
- * @return the unique id.
+ * @param node the DependencyNode to use
+ * @return the unique id
*/
private static String generateId(DependencyNode node) {
return String.valueOf(node.hashCode());
diff --git a/src/main/java/org/apache/maven/plugins/dependency/tree/JsonDependencyNodeVisitor.java b/src/main/java/org/apache/maven/plugins/dependency/tree/JsonDependencyNodeVisitor.java
new file mode 100644
index 000000000..5faefbf1a
--- /dev/null
+++ b/src/main/java/org/apache/maven/plugins/dependency/tree/JsonDependencyNodeVisitor.java
@@ -0,0 +1,212 @@
+/*
+ * 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.plugins.dependency.tree;
+
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.io.Writer;
+import java.util.HashSet;
+import java.util.Set;
+
+import org.apache.maven.artifact.Artifact;
+import org.apache.maven.shared.dependency.graph.DependencyNode;
+import org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor;
+
+/**
+ * A dependency node visitor that serializes visited nodes to a writer using the JSON format.
+ */
+public class JsonDependencyNodeVisitor extends AbstractSerializingVisitor implements DependencyNodeVisitor {
+
+ private String indentChar = " ";
+
+ /**
+ * Creates a new instance of {@link JsonDependencyNodeVisitor}. The writer will be used to write the output.
+ *
+ * @param writer the writer to write to
+ */
+ public JsonDependencyNodeVisitor(Writer writer) {
+ super(writer);
+ }
+
+ @Override
+ public boolean visit(DependencyNode node) {
+ try {
+ if (node.getParent() == null || node.getParent() == node) {
+ writeRootNode(node);
+ }
+ return true;
+ } catch (IOException e) {
+ throw new UncheckedIOException("Failed to write JSON format output", e);
+ }
+ }
+
+ /**
+ * Writes the node to the writer. This method is recursive and will write all children nodes.
+ *
+ * @param node the node to write
+ * @throws IOException if an I/O error occurs while writing
+ */
+ private void writeRootNode(DependencyNode node) throws IOException {
+ Set visited = new HashSet<>();
+ int indent = 2;
+ StringBuilder sb = new StringBuilder();
+ sb.append("{").append(System.lineSeparator());
+ writeNode(indent, node, sb, visited);
+ sb.append("}").append(System.lineSeparator());
+ writer.write(sb.toString());
+ writer.flush();
+ }
+ /**
+ * Appends the node and its children to the string builder.
+ *
+ * @param indent the current indent level
+ * @param node the node to write
+ * @param sb the string builder to append to
+ */
+ private void writeNode(int indent, DependencyNode node, StringBuilder sb, Set visited) {
+ if (visited.contains(node)) {
+ // Circular dependency detected
+ // Should an exception be thrown?
+ return;
+ }
+ visited.add(node);
+ appendNodeValues(sb, indent, node.getArtifact(), !node.getChildren().isEmpty());
+ if (!node.getChildren().isEmpty()) {
+ writeChildren(indent, node, sb, visited);
+ }
+ }
+ /**
+ * Writes the children of the node to the string builder. Each child of each node will be written recursively.
+ *
+ * @param indent the current indent level
+ * @param node the node to write
+ * @param sb the string builder to append to
+ */
+ private void writeChildren(int indent, DependencyNode node, StringBuilder sb, Set visited) {
+ sb.append(indent(indent)).append("\"children\": [").append(System.lineSeparator());
+ indent += 2;
+ for (int i = 0; i < node.getChildren().size(); i++) {
+ DependencyNode child = node.getChildren().get(i);
+ sb.append(indent(indent));
+ sb.append("{").append(System.lineSeparator());
+ writeNode(indent + 2, child, sb, visited);
+ sb.append(indent(indent)).append("}");
+ // we skip the comma for the last child
+ if (i != node.getChildren().size() - 1) {
+ sb.append(",");
+ }
+ sb.append(System.lineSeparator());
+ }
+ sb.append(indent(indent)).append("]").append(System.lineSeparator());
+ }
+
+ @Override
+ public boolean endVisit(DependencyNode node) {
+ return true;
+ }
+ /**
+ * Appends the artifact values to the string builder.
+ *
+ * @param sb the string builder to append to
+ * @param indent the current indent level
+ * @param artifact the artifact to write
+ * @param hasChildren true if the artifact has children
+ */
+ private void appendNodeValues(StringBuilder sb, int indent, Artifact artifact, boolean hasChildren) {
+ appendKeyValue(sb, indent, "groupId", artifact.getGroupId());
+ appendKeyValue(sb, indent, "artifactId", artifact.getArtifactId());
+ appendKeyValue(sb, indent, "version", artifact.getVersion());
+ appendKeyValue(sb, indent, "type", artifact.getType());
+ appendKeyValue(sb, indent, "scope", artifact.getScope());
+ appendKeyValue(sb, indent, "classifier", artifact.getClassifier());
+ if (hasChildren) {
+ appendKeyValue(sb, indent, "optional", String.valueOf(artifact.isOptional()));
+ } else {
+ appendKeyWithoutComma(sb, indent, "optional", String.valueOf(artifact.isOptional()));
+ }
+ }
+ /**
+ * Appends a key value pair to the string builder.
+ *
+ * @param sb the string builder to append to
+ * @param indent the current indent level
+ * @param key the key used as json key
+ * @param value the value used as json value
+ */
+ private void appendKeyValue(StringBuilder sb, int indent, String key, String value) {
+ if (value == null) {
+ value = "";
+ }
+
+ sb.append(indent(indent))
+ .append("\"")
+ .append(key)
+ .append("\"")
+ .append(":")
+ .append(indentChar)
+ .append("\"")
+ .append(value)
+ .append("\"")
+ .append(",")
+ .append(System.lineSeparator());
+ }
+ /**
+ * Appends a key value pair to the string builder without a comma at the end. This is used for the last children of a node.
+ *
+ * @param sb the string builder to append to
+ * @param indent the current indent level
+ * @param key the key used as json key
+ * @param value the value used as json value
+ */
+ private void appendKeyWithoutComma(StringBuilder sb, int indent, String key, String value) {
+ if (value == null) {
+ value = "";
+ }
+
+ sb.append(indent(indent))
+ .append("\"")
+ .append(key)
+ .append("\"")
+ .append(":")
+ .append(indentChar)
+ .append("\"")
+ .append(value)
+ .append("\"")
+ .append(System.lineSeparator());
+ }
+
+ /**
+ * Returns a string of {@link #indentChar} for the indent level.
+ *
+ * @param indent the number of indent levels
+ * @return the string of indent characters
+ */
+ private String indent(int indent) {
+ if (indent < 1) {
+ return "";
+ }
+
+ StringBuilder sb = new StringBuilder();
+ for (int i = 0; i < indent; i++) {
+ sb.append(indentChar);
+ }
+
+ return sb.toString();
+ }
+}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/tree/TGFDependencyNodeVisitor.java b/src/main/java/org/apache/maven/plugins/dependency/tree/TGFDependencyNodeVisitor.java
index c76fdb984..3dc3a3286 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/tree/TGFDependencyNodeVisitor.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/tree/TGFDependencyNodeVisitor.java
@@ -18,9 +18,12 @@
*/
package org.apache.maven.plugins.dependency.tree;
+import java.io.IOException;
+import java.io.UncheckedIOException;
import java.io.Writer;
import java.util.ArrayList;
import java.util.List;
+
import org.apache.maven.shared.dependency.graph.DependencyNode;
import org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor;
@@ -34,7 +37,7 @@
public class TGFDependencyNodeVisitor extends AbstractSerializingVisitor implements DependencyNodeVisitor {
/**
- * Utiity class to write an Edge.
+ * Utility class to write an Edge.
*
* @author Jerome Creignou
*/
@@ -57,9 +60,9 @@ static final class EdgeAppender {
/**
* Build a new EdgeAppender.
*
- * @param from edge start.
+ * @param from edge start
* @param to edge end
- * @param label optional label.
+ * @param label optional label
*/
EdgeAppender(DependencyNode from, DependencyNode to, String label) {
super();
@@ -69,7 +72,7 @@ static final class EdgeAppender {
}
/**
- * build a string representing the edge.
+ * Build a string representing the edge.
*/
@Override
public String toString() {
@@ -90,7 +93,7 @@ public String toString() {
/**
* Constructor.
*
- * @param writer the writer to write to.
+ * @param writer the writer to write to
*/
public TGFDependencyNodeVisitor(Writer writer) {
super(writer);
@@ -101,18 +104,23 @@ public TGFDependencyNodeVisitor(Writer writer) {
*/
@Override
public boolean endVisit(DependencyNode node) {
- if (node.getParent() == null || node.getParent() == node) {
- // dump edges on last node endVisit
- writer.println("#");
- for (EdgeAppender edge : edges) {
- writer.println(edge.toString());
+ try {
+ if (node.getParent() == null || node.getParent() == node) {
+ // dump edges on last node endVisit
+ writer.write("#" + System.lineSeparator());
+ for (EdgeAppender edge : edges) {
+ writer.write(edge.toString() + System.lineSeparator());
+ }
+ writer.flush();
+ } else {
+ DependencyNode parent = node.getParent();
+ // using scope as edge label.
+ edges.add(new EdgeAppender(parent, node, node.getArtifact().getScope()));
}
- } else {
- DependencyNode p = node.getParent();
- // using scope as edge label.
- edges.add(new EdgeAppender(p, node, node.getArtifact().getScope()));
+ return true;
+ } catch (IOException e) {
+ throw new UncheckedIOException("Failed to write TGF format output", e);
}
- return true;
}
/**
@@ -120,11 +128,17 @@ public boolean endVisit(DependencyNode node) {
*/
@Override
public boolean visit(DependencyNode node) {
- // write node
- writer.write(generateId(node));
- writer.write(" ");
- writer.println(node.toNodeString());
- return true;
+ try {
+ // Write node
+ writer.write(generateId(node));
+ writer.write(" ");
+ writer.write(node.toNodeString());
+ writer.write(System.lineSeparator());
+ writer.flush();
+ return true;
+ } catch (IOException e) {
+ throw new UncheckedIOException("Failed to write TGF format output", e);
+ }
}
/**
@@ -133,8 +147,8 @@ public boolean visit(DependencyNode node) {
* Current implementation is rather simple and uses hashcode.
*
*
- * @param node the DependencyNode to use.
- * @return the unique id.
+ * @param node the DependencyNode to use
+ * @return the unique id
*/
private static String generateId(DependencyNode node) {
return String.valueOf(node.hashCode());
diff --git a/src/main/java/org/apache/maven/plugins/dependency/tree/TreeMojo.java b/src/main/java/org/apache/maven/plugins/dependency/tree/TreeMojo.java
index ac1131242..a2e7d8e84 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/tree/TreeMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/tree/TreeMojo.java
@@ -18,24 +18,22 @@
*/
package org.apache.maven.plugins.dependency.tree;
+import javax.inject.Inject;
+
import java.io.File;
import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import java.util.ArrayList;
-import java.util.Arrays;
import java.util.List;
import java.util.Objects;
+
import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
import org.apache.maven.artifact.resolver.filter.ScopeArtifactFilter;
-import org.apache.maven.artifact.versioning.ArtifactVersion;
-import org.apache.maven.artifact.versioning.Restriction;
-import org.apache.maven.artifact.versioning.VersionRange;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
-import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
@@ -59,15 +57,13 @@
import org.apache.maven.shared.dependency.graph.traversal.FilteringDependencyNodeVisitor;
import org.apache.maven.shared.dependency.graph.traversal.SerializingDependencyNodeVisitor;
import org.apache.maven.shared.dependency.graph.traversal.SerializingDependencyNodeVisitor.GraphTokens;
-import org.eclipse.aether.RepositorySystem;
-import org.eclipse.aether.RepositorySystemSession;
-import org.eclipse.aether.repository.RemoteRepository;
/**
* Displays the dependency tree for this project. Multiple formats are supported: text (by default), but also
* DOT,
- * GraphML, and
- * TGF.
+ * GraphML,
+ * TGF and
+ * JSON.
*
* @author Mark Hobson
* @since 2.0-alpha-5
@@ -79,50 +75,22 @@ public class TreeMojo extends AbstractMojo {
/**
* The Maven project.
*/
- @Parameter(defaultValue = "${project}", readonly = true, required = true)
- private MavenProject project;
-
- @Parameter(defaultValue = "${session}", readonly = true, required = true)
- private MavenSession session;
-
- @Parameter(property = "outputEncoding", defaultValue = "${project.reporting.outputEncoding}")
- private String outputEncoding;
-
- /**
- * Contains the full list of projects in the reactor.
- */
- @Parameter(defaultValue = "${reactorProjects}", readonly = true, required = true)
- private List reactorProjects;
-
- @Component
- private RepositorySystem repositorySystem;
-
- @Parameter(defaultValue = "${repositorySystem}")
- RepositorySystem repositorySystemParam;
-
- /**
- * The current repository/network configuration of Maven.
- */
- @Parameter(defaultValue = "${repositorySystemSession}")
- private RepositorySystemSession repoSession;
+ private final MavenProject project;
- /**
- * The project's remote repositories to use for the resolution of project dependencies.
- */
- @Parameter(defaultValue = "${project.remoteProjectRepositories}")
- private List projectRepos;
+ private final MavenSession session;
/**
* The dependency collector builder to use.
*/
- @Component(hint = "default")
- private DependencyCollectorBuilder dependencyCollectorBuilder;
+ private final DependencyCollectorBuilder dependencyCollectorBuilder;
/**
* The dependency graph builder to use.
*/
- @Component(hint = "default")
- private DependencyGraphBuilder dependencyGraphBuilder;
+ private final DependencyGraphBuilder dependencyGraphBuilder;
+
+ @Parameter(property = "outputEncoding", defaultValue = "${project.reporting.outputEncoding}")
+ private String outputEncoding;
/**
* If specified, this parameter will cause the dependency tree to be written to the path specified, instead of
@@ -135,7 +103,8 @@ public class TreeMojo extends AbstractMojo {
/**
* If specified, this parameter will cause the dependency tree to be written using the specified format. Currently
- * supported format are: text (default), dot, graphml and tgf.
+ * supported formats are: text (default), dot, graphml, tgf
+ * and json (since 3.7.0).
* These additional formats can be plotted to image files.
*
* @since 2.2
@@ -189,7 +158,7 @@ public class TreeMojo extends AbstractMojo {
* @since 2.0-alpha-6
*/
@Parameter(property = "includes")
- private String includes;
+ private List includes;
/**
* A comma-separated list of artifacts to filter from the serialized dependency tree, or null not to
@@ -210,7 +179,7 @@ public class TreeMojo extends AbstractMojo {
* @since 2.0-alpha-6
*/
@Parameter(property = "excludes")
- private String excludes;
+ private List excludes;
/**
* The computed dependency tree root node of the Maven project.
@@ -232,6 +201,19 @@ public class TreeMojo extends AbstractMojo {
*/
@Parameter(property = "skip", defaultValue = "false")
private boolean skip;
+
+ @Inject
+ public TreeMojo(
+ MavenProject project,
+ MavenSession session,
+ DependencyCollectorBuilder dependencyCollectorBuilder,
+ DependencyGraphBuilder dependencyGraphBuilder) {
+ this.project = project;
+ this.session = session;
+ this.dependencyCollectorBuilder = dependencyCollectorBuilder;
+ this.dependencyGraphBuilder = dependencyGraphBuilder;
+ }
+
// Mojo methods -----------------------------------------------------------
/*
@@ -379,6 +361,8 @@ public DependencyNodeVisitor getSerializingDependencyNodeVisitor(Writer writer)
return new TGFDependencyNodeVisitor(writer);
} else if ("dot".equals(outputType)) {
return new DOTDependencyNodeVisitor(writer);
+ } else if ("json".equals(outputType)) {
+ return new JsonDependencyNodeVisitor(writer);
} else {
return new SerializingDependencyNodeVisitor(writer, toGraphTokens(tokens));
}
@@ -417,55 +401,23 @@ private DependencyNodeFilter createDependencyNodeFilter() {
List filters = new ArrayList<>();
// filter includes
- if (includes != null) {
- List patterns = Arrays.asList(includes.split(","));
+ if (includes != null && !includes.isEmpty()) {
- getLog().debug("+ Filtering dependency tree by artifact include patterns: " + patterns);
+ getLog().debug("+ Filtering dependency tree by artifact include patterns: " + includes);
- ArtifactFilter artifactFilter = new StrictPatternIncludesArtifactFilter(patterns);
+ ArtifactFilter artifactFilter = new StrictPatternIncludesArtifactFilter(includes);
filters.add(new ArtifactDependencyNodeFilter(artifactFilter));
}
// filter excludes
- if (excludes != null) {
- List patterns = Arrays.asList(excludes.split(","));
+ if (excludes != null && !excludes.isEmpty()) {
- getLog().debug("+ Filtering dependency tree by artifact exclude patterns: " + patterns);
+ getLog().debug("+ Filtering dependency tree by artifact exclude patterns: " + excludes);
- ArtifactFilter artifactFilter = new StrictPatternExcludesArtifactFilter(patterns);
+ ArtifactFilter artifactFilter = new StrictPatternExcludesArtifactFilter(excludes);
filters.add(new ArtifactDependencyNodeFilter(artifactFilter));
}
return filters.isEmpty() ? null : new AndDependencyNodeFilter(filters);
}
-
- // following is required because the version handling in maven code
- // doesn't work properly. I ripped it out of the enforcer rules.
-
- /**
- * Copied from Artifact.VersionRange. This is tweaked to handle singular ranges properly. Currently the default
- * containsVersion method assumes a singular version means allow everything. This method assumes that "2.0.4" ==
- * "[2.0.4,)"
- *
- * @param allowedRange range of allowed versions.
- * @param theVersion the version to be checked.
- * @return true if the version is contained by the range.
- * @deprecated This method is unused in this project and will be removed in the future.
- */
- @Deprecated
- public static boolean containsVersion(VersionRange allowedRange, ArtifactVersion theVersion) {
- ArtifactVersion recommendedVersion = allowedRange.getRecommendedVersion();
- if (recommendedVersion == null) {
- List restrictions = allowedRange.getRestrictions();
- for (Restriction restriction : restrictions) {
- if (restriction.containsVersion(theVersion)) {
- return true;
- }
- }
- return false;
- } else {
- // only singular versions ever have a recommendedVersion
- return recommendedVersion.compareTo(theVersion) <= 0;
- }
- }
}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/utils/CopyUtil.java b/src/main/java/org/apache/maven/plugins/dependency/utils/CopyUtil.java
new file mode 100644
index 000000000..d18fbd992
--- /dev/null
+++ b/src/main/java/org/apache/maven/plugins/dependency/utils/CopyUtil.java
@@ -0,0 +1,88 @@
+/*
+ * 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.plugins.dependency.utils;
+
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Singleton;
+
+import java.io.File;
+import java.io.IOException;
+
+import org.apache.maven.artifact.Artifact;
+import org.apache.maven.plugin.MojoExecutionException;
+import org.codehaus.plexus.util.FileUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.sonatype.plexus.build.incremental.BuildContext;
+
+/**
+ * Provide a copyFile method in one place.
+ *
+ * @since 3.7.0
+ */
+@Named
+@Singleton
+public class CopyUtil {
+
+ private final BuildContext buildContext;
+
+ private final Logger logger = LoggerFactory.getLogger(CopyUtil.class);
+
+ @Inject
+ public CopyUtil(BuildContext buildContext) {
+ this.buildContext = buildContext;
+ }
+
+ /**
+ * Copies the artifact (file)
+ *
+ * @param sourceArtifact the artifact (file) to copy
+ * @param destination file name of destination file
+ * @throws IOException if copy has failed
+ * @throws MojoExecutionException if artifact file is a directory (which has not been packaged yet)
+ * @since 3.7.0
+ */
+ public void copyArtifactFile(Artifact sourceArtifact, File destination) throws IOException, MojoExecutionException {
+ File source = sourceArtifact.getFile();
+ if (source.isDirectory()) {
+ // usual case is a future jar packaging, but there are special cases: classifier and other packaging
+ throw new MojoExecutionException("Artifact '" + sourceArtifact
+ + "' has not been packaged yet (is a directory). When used on reactor artifact, "
+ + "copy should be executed after packaging: see MDEP-187.");
+ }
+ logger.debug("Copying artifact '{}' ({}) to {}", sourceArtifact.getId(), sourceArtifact.getFile(), destination);
+ FileUtils.copyFile(source, destination);
+ buildContext.refresh(destination);
+ }
+
+ /**
+ * Copies a file to a destination and refreshes the build context for the new file.
+ *
+ * @param source the source file to copy
+ * @param destination the destination file
+ * @throws IOException if copy has failed
+ * @since 3.2.0
+ */
+ public void copyFile(File source, File destination) throws IOException {
+ logger.debug("Copying file '{}' to {}", source, destination);
+ FileUtils.copyFile(source, destination);
+ buildContext.refresh(destination);
+ }
+}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/utils/DependencySilentLog.java b/src/main/java/org/apache/maven/plugins/dependency/utils/DependencySilentLog.java
index 165a327d0..7e2106a2f 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/utils/DependencySilentLog.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/utils/DependencySilentLog.java
@@ -19,14 +19,13 @@
package org.apache.maven.plugins.dependency.utils;
import org.apache.maven.plugin.logging.Log;
-import org.codehaus.plexus.logging.Logger;
/**
* This logger implements both types of logs currently in use and turns off logs.
*
* @author Brian Fox
*/
-public class DependencySilentLog implements Log, Logger {
+public class DependencySilentLog implements Log {
/**
* @return false
* @see org.apache.maven.plugin.logging.Log#isDebugEnabled()
@@ -184,148 +183,4 @@ public void error(CharSequence content, Throwable error) {
public void error(Throwable error) {
// nop
}
-
- /**
- * By default, do nothing.
- *
- * @see org.codehaus.plexus.logging.Logger#debug(java.lang.String)
- */
- @Override
- public void debug(String message) {
- // nop
- }
-
- /**
- * By default, do nothing.
- *
- * @see org.codehaus.plexus.logging.Logger#debug(java.lang.String, java.lang.Throwable)
- */
- @Override
- public void debug(String message, Throwable throwable) {
- // nop
- }
-
- /**
- * By default, do nothing.
- *
- * @see org.codehaus.plexus.logging.Logger#info(java.lang.String)
- */
- @Override
- public void info(String message) {
- // nop
- }
-
- /**
- * By default, do nothing.
- *
- * @see org.codehaus.plexus.logging.Logger#info(java.lang.String, java.lang.Throwable)
- */
- @Override
- public void info(String message, Throwable throwable) {
- // nop
- }
-
- /**
- * By default, do nothing.
- *
- * @see org.codehaus.plexus.logging.Logger#warn(java.lang.String)
- */
- @Override
- public void warn(String message) {
- // nop
- }
-
- /**
- * By default, do nothing.
- *
- * @see org.codehaus.plexus.logging.Logger#warn(java.lang.String, java.lang.Throwable)
- */
- @Override
- public void warn(String message, Throwable throwable) {
- // nop
- }
-
- /**
- * By default, do nothing.
- *
- * @see org.codehaus.plexus.logging.Logger#error(java.lang.String)
- */
- @Override
- public void error(String message) {
- // nop
- }
-
- /**
- * By default, do nothing.
- *
- * @see org.codehaus.plexus.logging.Logger#error(java.lang.String, java.lang.Throwable)
- */
- @Override
- public void error(String message, Throwable throwable) {
- // nop
- }
-
- /**
- * By default, do nothing.
- *
- * @see org.codehaus.plexus.logging.Logger#fatalError(java.lang.String)
- */
- @Override
- public void fatalError(String message) {
- // nop
- }
-
- /**
- * By default, do nothing.
- *
- * @see org.codehaus.plexus.logging.Logger#fatalError(java.lang.String, java.lang.Throwable)
- */
- @Override
- public void fatalError(String message, Throwable throwable) {
- // nop
- }
-
- /**
- * @return false
- * @see org.codehaus.plexus.logging.Logger#isFatalErrorEnabled()
- */
- @Override
- public boolean isFatalErrorEnabled() {
- return false;
- }
-
- /**
- * @return null
- * @see org.codehaus.plexus.logging.Logger#getChildLogger(java.lang.String)
- */
- @Override
- public Logger getChildLogger(String name) {
- return null;
- }
-
- /**
- * @return 0
- * @see org.codehaus.plexus.logging.Logger#getThreshold()
- */
- @Override
- public int getThreshold() {
- return 0;
- }
-
- /**
- * By default, do nothing
- */
- @Override
- public void setThreshold(int threshold) {
- // nop
- }
-
- /**
- * @return null
- * @see org.codehaus.plexus.logging.Logger#getName()
- */
- @Override
- public String getName() {
- return null;
- }
}
diff --git a/src/main/java/org/apache/maven/plugins/dependency/utils/DependencyStatusSets.java b/src/main/java/org/apache/maven/plugins/dependency/utils/DependencyStatusSets.java
index 07c7fa3f1..4aed77fa6 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/utils/DependencyStatusSets.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/utils/DependencyStatusSets.java
@@ -20,6 +20,7 @@
import java.util.LinkedHashSet;
import java.util.Set;
+
import org.apache.maven.artifact.Artifact;
/**
@@ -55,14 +56,14 @@ public DependencyStatusSets(Set resolved, Set unResolved, Se
}
/**
- * @return Returns the resolvedDependencies.
+ * @return returns the resolvedDependencies
*/
public Set