You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2017/04/17 11:34:04 UTC

svn commit: r1791685 - in /maven/plugins/trunk/maven-dependency-plugin/src: main/java/org/apache/maven/plugins/dependency/fromConfiguration/ test/java/org/apache/maven/plugins/dependency/fromConfiguration/

Author: michaelo
Date: Mon Apr 17 11:34:03 2017
New Revision: 1791685

URL: http://svn.apache.org/viewvc?rev=1791685&view=rev
Log:
[MDEP-534] Document format of mojo parameter 'artifact'

Submitted-by: Elias Elmqvist Wulcan <el...@apptus.com>

Modified:
    maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java
    maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java
    maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java
    maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/fromConfiguration/TestCopyMojo.java

Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java?rev=1791685&r1=1791684&r2=1791685&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java Mon Apr 17 11:34:03 2017
@@ -106,15 +106,15 @@ public abstract class AbstractFromConfig
 
     @Component
     private ArtifactResolver artifactResolver;
-    
+
     @Component
     private RepositoryManager repositoryManager;
-    
+
     @Component
     private ArtifactHandlerManager artifactHandlerManager;
-    
+
     abstract ArtifactItemFilter getMarkedArtifactFilter( ArtifactItem item );
-    
+
     // artifactItems is filled by either field injection or by setArtifact()
     protected void verifyRequirements() throws MojoFailureException
     {
@@ -142,7 +142,7 @@ public abstract class AbstractFromConfig
         boolean removeVersion = processArtifactItemsRequest.isRemoveVersion(), prependGroupId =
             processArtifactItemsRequest.isPrependGroupId(), useBaseVersion =
             processArtifactItemsRequest.isUseBaseVersion();
-        
+
         boolean removeClassifier = processArtifactItemsRequest.isRemoveClassifier();
 
         if ( artifactItems == null || artifactItems.size() < 1 )
@@ -218,9 +218,9 @@ public abstract class AbstractFromConfig
              * artifactResolutionResult.getArtifactResolutionNodes().iterator(); while ( iter.hasNext() ) {
              * ResolutionNode node = (ResolutionNode) iter.next(); artifact = node.getArtifact(); }
              */
-            
+
             ProjectBuildingRequest buildingRequest = newResolveArtifactProjectBuildingRequest();
-            
+
             if ( localRepositoryDirectory != null )
             {
                 buildingRequest =
@@ -233,7 +233,7 @@ public abstract class AbstractFromConfig
             coordinate.setArtifactId( artifactItem.getArtifactId() );
             coordinate.setVersion( artifactItem.getVersion() );
             coordinate.setClassifier( artifactItem.getClassifier() );
-            
+
             final String extension;
             ArtifactHandler artifactHandler = artifactHandlerManager.getArtifactHandler( artifactItem.getType() );
             if ( artifactHandler != null )
@@ -245,7 +245,7 @@ public abstract class AbstractFromConfig
                 extension = artifactItem.getType();
             }
             coordinate.setExtension( extension );
-            
+
             artifact = artifactResolver.resolveArtifact( buildingRequest, coordinate ).getArtifact();
         }
         catch ( ArtifactResolverException e )
@@ -407,7 +407,7 @@ public abstract class AbstractFromConfig
             if ( tokens.length < 3 || tokens.length > 5 )
             {
                 throw new MojoFailureException(
-                    "Invalid artifact, you must specify groupId:artifactId:version[:packaging][:classifier] "
+                    "Invalid artifact, you must specify groupId:artifactId:version[:packaging[:classifier]] "
                         + artifact );
             }
             String groupId = tokens[0];
@@ -425,14 +425,14 @@ public abstract class AbstractFromConfig
             {
                 classifier = null;
             }
-    
+
             ArtifactItem artifactItem = new ArtifactItem();
             artifactItem.setGroupId( groupId );
             artifactItem.setArtifactId( artifactId );
             artifactItem.setVersion( version );
             artifactItem.setType( packaging );
             artifactItem.setClassifier( classifier );
-            
+
             setArtifactItems( Collections.singletonList( artifactItem ) );
         }
     }

Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java?rev=1791685&r1=1791684&r2=1791685&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java Mon Apr 17 11:34:03 2017
@@ -53,7 +53,7 @@ public class CopyMojo
      */
     @Parameter( property = "mdep.stripClassifier", defaultValue = "false" )
     private boolean stripClassifier = false;
-    
+
     /**
      * Prepend artifact groupId during copy
      * @since 2.7
@@ -69,8 +69,9 @@ public class CopyMojo
     private boolean useBaseVersion = false;
 
     /**
-     * The artifact to copy from commandLine.
-     * Use {@link #artifactItems} within the pom-configuration.
+     * The artifact to copy from command line. A string of the form
+     * groupId:artifactId:version[:packaging[:classifier]]. Use {@link #artifactItems} within the
+     * POM configuration.
      */
     @SuppressWarnings( "unused" ) //marker-field, setArtifact(String) does the magic
     @Parameter( property = "artifact" )
@@ -160,7 +161,7 @@ public class CopyMojo
     {
         this.stripVersion = stripVersion;
     }
-    
+
     /**
      * @return Returns the stripClassifier.
      */

Modified: maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java?rev=1791685&r1=1791684&r2=1791685&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java Mon Apr 17 11:34:03 2017
@@ -72,8 +72,9 @@ public class UnpackMojo
     private String excludes;
 
     /**
-     * The artifact to unpack from commandLine.
-     * Use {@link #artifactItems} within the pom-configuration.
+     * The artifact to unpack from command line. A string of the form
+     * groupId:artifactId:version[:packaging[:classifier]]. Use {@link #artifactItems} within the
+     * POM configuration.
      */
     @SuppressWarnings( "unused" ) //marker-field, setArtifact(String) does the magic
     @Parameter( property = "artifact" )
@@ -96,7 +97,7 @@ public class UnpackMojo
         {
             return;
         }
-        
+
         verifyRequirements();
 
         List<ArtifactItem> processedItems = getProcessedArtifactItems( false );
@@ -124,7 +125,7 @@ public class UnpackMojo
         throws MojoExecutionException
     {
         MarkerHandler handler = new UnpackFileMarkerHandler( artifactItem, this.markersDirectory );
-        
+
         unpack( artifactItem.getArtifact(), artifactItem.getType(), artifactItem.getOutputDirectory(),
                 artifactItem.getIncludes(), artifactItem.getExcludes(), artifactItem.getEncoding() );
         handler.setMarker();

Modified: maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/fromConfiguration/TestCopyMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/fromConfiguration/TestCopyMojo.java?rev=1791685&r1=1791684&r2=1791685&view=diff
==============================================================================
--- maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/fromConfiguration/TestCopyMojo.java (original)
+++ maven/plugins/trunk/maven-dependency-plugin/src/test/java/org/apache/maven/plugins/dependency/fromConfiguration/TestCopyMojo.java Mon Apr 17 11:34:03 2017
@@ -76,6 +76,39 @@ public class TestCopyMojo
         return list.get( 0 );
     }
 
+    public void testSetArtifactWithoutPackaging() throws Exception
+    {
+        mojo.setArtifact("a:b:c");
+        ArtifactItem item = mojo.getArtifactItems().get(0);
+        assertEquals("a", item.getGroupId());
+        assertEquals("b", item.getArtifactId());
+        assertEquals("c", item.getVersion());
+        assertEquals("jar", item.getType());
+        assertNull(item.getClassifier());
+    }
+
+    public void testSetArtifactWithoutClassifier() throws Exception
+    {
+        mojo.setArtifact("a:b:c:d");
+        ArtifactItem item = mojo.getArtifactItems().get(0);
+        assertEquals("a", item.getGroupId());
+        assertEquals("b", item.getArtifactId());
+        assertEquals("c", item.getVersion());
+        assertEquals("d", item.getType());
+        assertNull(item.getClassifier());
+    }
+
+    public void testSetArtifact() throws Exception
+    {
+        mojo.setArtifact("a:b:c:d:e");
+        ArtifactItem item = mojo.getArtifactItems().get(0);
+        assertEquals("a", item.getGroupId());
+        assertEquals("b", item.getArtifactId());
+        assertEquals("c", item.getVersion());
+        assertEquals("d", item.getType());
+        assertEquals("e", item.getClassifier());
+    }
+
     public void testGetArtifactItems()
         throws Exception
     {