You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by rf...@apache.org on 2016/06/18 19:49:53 UTC

svn commit: r1749089 - in /maven/plugins/trunk/maven-assembly-plugin/src: it/projects/repositories/basic-repository/ main/java/org/apache/maven/plugins/assembly/ main/java/org/apache/maven/plugins/assembly/io/ main/java/org/apache/maven/plugins/assembl...

Author: rfscholte
Date: Sat Jun 18 19:49:52 2016
New Revision: 1749089

URL: http://svn.apache.org/viewvc?rev=1749089&view=rev
Log:
[MASSEMBLY-818] Remove deprecated parameters for the single goal
Remove descriptor; instead use descriptors
Include check for removed parameters

Modified:
    maven/plugins/trunk/maven-assembly-plugin/src/it/projects/repositories/basic-repository/pom.xml
    maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/AssemblerConfigurationSource.java
    maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/io/DefaultAssemblyReader.java
    maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/mojos/AbstractAssemblyMojo.java
    maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/mojos/SingleAssemblyMojo.java
    maven/plugins/trunk/maven-assembly-plugin/src/test/java/org/apache/maven/plugins/assembly/io/DefaultAssemblyReaderTest.java

Modified: maven/plugins/trunk/maven-assembly-plugin/src/it/projects/repositories/basic-repository/pom.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/it/projects/repositories/basic-repository/pom.xml?rev=1749089&r1=1749088&r2=1749089&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/it/projects/repositories/basic-repository/pom.xml (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/it/projects/repositories/basic-repository/pom.xml Sat Jun 18 19:49:52 2016
@@ -45,7 +45,9 @@ under the License.
       <plugin>
         <artifactId>maven-assembly-plugin</artifactId>
         <configuration>
-          <descriptor>src/assemble/bin.xml</descriptor>
+          <descriptors>
+            <descriptor>src/assemble/bin.xml</descriptor>
+          </descriptors>
           <finalName>assembly</finalName>        
         </configuration>
 

Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/AssemblerConfigurationSource.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/AssemblerConfigurationSource.java?rev=1749089&r1=1749088&r2=1749089&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/AssemblerConfigurationSource.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/AssemblerConfigurationSource.java Sat Jun 18 19:49:52 2016
@@ -35,12 +35,6 @@ import java.util.List;
  */
 public interface AssemblerConfigurationSource
 {
-
-    /**
-     * @return The descriptor.
-     */
-    String getDescriptor();
-
     /**
      * @return The descriptors.
      */

Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/io/DefaultAssemblyReader.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/io/DefaultAssemblyReader.java?rev=1749089&r1=1749088&r2=1749089&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/io/DefaultAssemblyReader.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/io/DefaultAssemblyReader.java Sat Jun 18 19:49:52 2016
@@ -103,17 +103,10 @@ public class DefaultAssemblyReader
 
         final List<Assembly> assemblies = new ArrayList<Assembly>();
 
-        final String descriptor = configSource.getDescriptor();
         final String[] descriptors = configSource.getDescriptors();
         final String[] descriptorRefs = configSource.getDescriptorReferences();
         final File descriptorSourceDirectory = configSource.getDescriptorSourceDirectory();
 
-        if ( descriptor != null )
-        {
-            locator.setStrategies( strategies );
-            addAssemblyFromDescriptor( descriptor, locator, configSource, assemblies );
-        }
-
         if ( ( descriptors != null ) && ( descriptors.length > 0 ) )
         {
             locator.setStrategies( strategies );

Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/mojos/AbstractAssemblyMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/mojos/AbstractAssemblyMojo.java?rev=1749089&r1=1749088&r2=1749089&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/mojos/AbstractAssemblyMojo.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/mojos/AbstractAssemblyMojo.java Sat Jun 18 19:49:52 2016
@@ -194,15 +194,6 @@ public abstract class AbstractAssemblyMo
     private File archiveBaseDirectory;
 
     /**
-     * Assembly XML Descriptor file. This must be the path to your customized descriptor file.
-     *
-     * @deprecated Please use descriptors instead
-     */
-    @Deprecated
-    @Parameter( property = "descriptor" )
-    private String descriptor;
-
-    /**
      * Sets the TarArchiver behavior on file paths with more than 100 characters length. Valid values are: "warn"
      * (default), "fail", "truncate", "gnu", "posix", "posix_warn" or "omit".
      */
@@ -629,18 +620,6 @@ public abstract class AbstractAssemblyMo
         this.basedir = basedir;
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * @deprecated This has been replaced by {@link #getDescriptors()}
-     */
-    @Override
-    @Deprecated
-    public String getDescriptor()
-    {
-        return descriptor;
-    }
-
     @Override
     public String[] getDescriptorReferences()
     {

Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/mojos/SingleAssemblyMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/mojos/SingleAssemblyMojo.java?rev=1749089&r1=1749088&r2=1749089&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/mojos/SingleAssemblyMojo.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugins/assembly/mojos/SingleAssemblyMojo.java Sat Jun 18 19:49:52 2016
@@ -19,10 +19,15 @@ package org.apache.maven.plugins.assembl
  * under the License.
  */
 
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugin.MojoFailureException;
+import org.apache.maven.plugin.descriptor.PluginDescriptor;
+
 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.project.MavenProject;
+import org.codehaus.plexus.util.xml.Xpp3Dom;
 
 /**
  * Assemble an application bundle or distribution from an assembly descriptor. This goal is suitable either for binding
@@ -38,6 +43,36 @@ import org.apache.maven.project.MavenPro
 public class SingleAssemblyMojo
     extends AbstractAssemblyMojo
 {
+    @Parameter( defaultValue = "${plugin}", readonly = true )
+    private PluginDescriptor plugin;
+
+    @Override
+    public void execute()
+        throws MojoExecutionException, MojoFailureException
+    {
+        verifyRemovedParameter( "classifier" );
+        verifyRemovedParameter( "descriptor" );
+        verifyRemovedParameter( "descriptorId" );
+        verifyRemovedParameter( "includeSite" );
+        
+        super.execute();
+    }
+    
+    private void verifyRemovedParameter( String paramName )
+    {
+        Object pluginConfiguration = plugin.getPlugin().getConfiguration();
+        if ( pluginConfiguration instanceof Xpp3Dom )
+        {
+            Xpp3Dom configDom = (Xpp3Dom) pluginConfiguration;
+            
+            if ( configDom.getChild( paramName ) != null )
+            {
+                throw new IllegalArgumentException( "parameter '" + paramName
+                    + "' has been removed from the plugin, please verify documentation." );
+            }
+        }
+    }
+    
     /**
      */
     @Parameter( defaultValue = "${project}", readonly = true, required = true )

Modified: maven/plugins/trunk/maven-assembly-plugin/src/test/java/org/apache/maven/plugins/assembly/io/DefaultAssemblyReaderTest.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/test/java/org/apache/maven/plugins/assembly/io/DefaultAssemblyReaderTest.java?rev=1749089&r1=1749088&r2=1749089&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/test/java/org/apache/maven/plugins/assembly/io/DefaultAssemblyReaderTest.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/test/java/org/apache/maven/plugins/assembly/io/DefaultAssemblyReaderTest.java Sat Jun 18 19:49:52 2016
@@ -825,7 +825,7 @@ public class DefaultAssemblyReaderTest
 
         final String assemblyFile = files.get( 0 );
 
-        final List<Assembly> assemblies = performReadAssemblies( basedir, assemblyFile, null, null, null );
+        final List<Assembly> assemblies = performReadAssemblies( basedir, new String[] { assemblyFile }, null, null );
 
         assertNotNull( assemblies );
         assertEquals( 1, assemblies.size() );
@@ -845,7 +845,7 @@ public class DefaultAssemblyReaderTest
 
         try
         {
-            performReadAssemblies( basedir, assemblyFile.getAbsolutePath(), null, null, null, false );
+            performReadAssemblies( basedir, null, null, null, false );
 
             fail( "Should fail when descriptor file is missing and ignoreDescriptors == false" );
         }
@@ -865,7 +865,7 @@ public class DefaultAssemblyReaderTest
 
         try
         {
-            performReadAssemblies( basedir, assemblyFile.getAbsolutePath(), null, null, null, true );
+            performReadAssemblies( basedir, null, null, null, true );
         }
         catch ( final AssemblyReadException e )
         {
@@ -892,7 +892,7 @@ public class DefaultAssemblyReaderTest
         final List<String> files = writeAssembliesToFile( assemblies, basedir );
 
         final List<Assembly> results =
-            performReadAssemblies( basedir, null, files.toArray( new String[files.size()] ), null, null );
+            performReadAssemblies( basedir, files.toArray( new String[files.size()] ), null, null );
 
         assertNotNull( results );
         assertEquals( 2, results.size() );
@@ -912,7 +912,7 @@ public class DefaultAssemblyReaderTest
         final File basedir = fileManager.createTempDir();
 
         final List<Assembly> assemblies =
-            performReadAssemblies( basedir, null, null, new String[]{ "bin", "src" }, null );
+            performReadAssemblies( basedir, null, new String[]{ "bin", "src" }, null );
 
         assertNotNull( assemblies );
         assertEquals( 2, assemblies.size() );
@@ -943,7 +943,7 @@ public class DefaultAssemblyReaderTest
 
         writeAssembliesToFile( assemblies, basedir );
 
-        final List<Assembly> results = performReadAssemblies( basedir, null, null, null, basedir );
+        final List<Assembly> results = performReadAssemblies( basedir, null, null, basedir );
 
         assertNotNull( results );
         assertEquals( 2, results.size() );
@@ -976,7 +976,7 @@ public class DefaultAssemblyReaderTest
 
         fileManager.createFile( basedir, "readme.txt", "This is just a readme file, not a descriptor." );
 
-        final List<Assembly> results = performReadAssemblies( basedir, null, null, null, basedir );
+        final List<Assembly> results = performReadAssemblies( basedir, null, null, basedir );
 
         assertNotNull( results );
         assertEquals( 2, results.size() );
@@ -1018,21 +1018,18 @@ public class DefaultAssemblyReaderTest
         return files;
     }
 
-    private List<Assembly> performReadAssemblies( final File basedir, final String descriptor,
-                                                  final String[] descriptors, final String[] descriptorRefs,
-                                                  final File descriptorDir )
+    private List<Assembly> performReadAssemblies( final File basedir, final String[] descriptors,
+                                                  final String[] descriptorRefs, final File descriptorDir )
         throws AssemblyReadException, InvalidAssemblerConfigurationException
     {
-        return performReadAssemblies( basedir, descriptor, descriptors, descriptorRefs, descriptorDir, false );
+        return performReadAssemblies( basedir, descriptors, descriptorRefs, descriptorDir, false );
     }
 
-    private List<Assembly> performReadAssemblies( final File basedir, final String descriptor,
-                                                  final String[] descriptors, final String[] descriptorRefs,
-                                                  final File descriptorDir, final boolean ignoreMissing )
+    private List<Assembly> performReadAssemblies( final File basedir, final String[] descriptors,
+                                                  final String[] descriptorRefs, final File descriptorDir,
+                                                  final boolean ignoreMissing )
         throws AssemblyReadException, InvalidAssemblerConfigurationException
     {
-        expect( configSource.getDescriptor() ).andReturn( descriptor );
-
         expect( configSource.getDescriptorReferences() ).andReturn( descriptorRefs );
 
         expect( configSource.getDescriptors() ).andReturn( descriptors );