[MSHADE-363] add ReproducibleResourceTransformer to keep compatibility

hboutemy · hboutemy · commit 229f4d79836b · 2020-05-14T12:48:36.000+02:00
diff --git a/src/main/java/org/apache/maven/plugins/shade/DefaultShader.java b/src/main/java/org/apache/maven/plugins/shade/DefaultShader.java
@@ -49,6 +49,7 @@
 import org.apache.maven.plugins.shade.filter.Filter;
 import org.apache.maven.plugins.shade.relocation.Relocator;
 import org.apache.maven.plugins.shade.resource.ManifestResourceTransformer;
+import org.apache.maven.plugins.shade.resource.ReproducibleResourceTransformer;
 import org.apache.maven.plugins.shade.resource.ResourceTransformer;
 import org.codehaus.plexus.component.annotations.Component;
 import org.codehaus.plexus.logging.AbstractLogEnabled;
@@ -76,15 +77,15 @@ public void shade( ShadeRequest shadeRequest )
     {
         Set<String> resources = new HashSet<>();
 
-        ResourceTransformer manifestTransformer = null;
+        ManifestResourceTransformer manifestTransformer = null;
         List<ResourceTransformer> transformers =
             new ArrayList<>( shadeRequest.getResourceTransformers() );
         for ( Iterator<ResourceTransformer> it = transformers.iterator(); it.hasNext(); )
         {
             ResourceTransformer transformer = it.next();
             if ( transformer instanceof ManifestResourceTransformer )
             {
-                manifestTransformer = transformer;
+                manifestTransformer = (ManifestResourceTransformer) transformer;
                 it.remove();
             }
         }
@@ -265,11 +266,11 @@ else if ( shadeRequest.isShadeSourcesContent() && name.endsWith( ".java" ) )
     }
 
     private void goThroughAllJarEntriesForManifestTransformer( ShadeRequest shadeRequest, Set<String> resources,
-                                                               ResourceTransformer resourceTransformer,
+                                                               ManifestResourceTransformer manifestTransformer,
                                                                JarOutputStream jos )
         throws IOException
     {
-        if ( resourceTransformer != null )
+        if ( manifestTransformer != null )
         {
             for ( File jar : shadeRequest.getJars() )
             {
@@ -279,22 +280,22 @@ private void goThroughAllJarEntriesForManifestTransformer( ShadeRequest shadeReq
                     {
                         JarEntry entry = en.nextElement();
                         String resource = entry.getName();
-                        if ( resourceTransformer.canTransformResource( resource ) )
+                        if ( manifestTransformer.canTransformResource( resource ) )
                         {
                             resources.add( resource );
                             try ( InputStream inputStream = jarFile.getInputStream( entry ) )
                             {
-                                resourceTransformer.processResource( resource, inputStream,
-                                        shadeRequest.getRelocators(), entry.getTime() );
+                                manifestTransformer.processResource( resource, inputStream,
+                                                                     shadeRequest.getRelocators(), entry.getTime() );
                             }
                             break;
                         }
                     }
                 }
             }
-            if ( resourceTransformer.hasTransformedResource() )
+            if ( manifestTransformer.hasTransformedResource() )
             {
-                resourceTransformer.modifyOutputStream( jos );
+                manifestTransformer.modifyOutputStream( jos );
             }
         }
     }
@@ -544,7 +545,14 @@ private boolean resourceTransformed( List<ResourceTransformer> resourceTransform
             {
                 getLogger().debug( "Transforming " + name + " using " + transformer.getClass().getName() );
 
-                transformer.processResource( name, is, relocators, time );
+                if ( transformer instanceof ReproducibleResourceTransformer )
+                {
+                    ( (ReproducibleResourceTransformer) transformer ).processResource( name, is, relocators, time );
+                }
+                else
+                {
+                    transformer.processResource( name, is, relocators );
+                }
 
                 resourceTransformed = true;
 
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/AbstractCompatibilityTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/AbstractCompatibilityTransformer.java
@@ -0,0 +1,39 @@
+package org.apache.maven.plugins.shade.resource;
+
+/*
+ * 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.
+ */
+
+import org.apache.maven.plugins.shade.relocation.Relocator;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.List;
+
+/**
+ * An abstract class to implement once the old non-reproducible ResourceTransformer API.
+ */
+abstract class AbstractCompatibilityTransformer
+    implements ReproducibleResourceTransformer
+{
+    public final void processResource( String resource, InputStream is, List<Relocator> relocators )
+        throws IOException
+    {
+        processResource( resource, is, relocators, 0 );
+    }
+}
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/ApacheLicenseResourceTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/ApacheLicenseResourceTransformer.java
@@ -30,7 +30,7 @@
  * Prevents duplicate copies of the license
  */
 public class ApacheLicenseResourceTransformer
-    implements ResourceTransformer
+    extends AbstractCompatibilityTransformer
 {
     private static final String LICENSE_PATH = "META-INF/LICENSE";
 
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/ApacheNoticeResourceTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/ApacheNoticeResourceTransformer.java
@@ -43,7 +43,7 @@
  * Merges <code>META-INF/NOTICE.TXT</code> files.
  */
 public class ApacheNoticeResourceTransformer
-    implements ResourceTransformer
+    extends AbstractCompatibilityTransformer
 {
     Set<String> entries = new LinkedHashSet<>();
 
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/AppendingTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/AppendingTransformer.java
@@ -33,7 +33,7 @@
  * A resource processor that appends content for a resource, separated by a newline.
  */
 public class AppendingTransformer
-    implements ResourceTransformer
+    extends AbstractCompatibilityTransformer
 {
     String resource;
 
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/ComponentsXmlResourceTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/ComponentsXmlResourceTransformer.java
@@ -42,7 +42,7 @@
  * A resource processor that aggregates plexus <code>components.xml</code> files.
  */
 public class ComponentsXmlResourceTransformer
-    implements ResourceTransformer
+    extends AbstractCompatibilityTransformer
 {
     private Map<String, Xpp3Dom> components = new LinkedHashMap<>();
 
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/DontIncludeResourceTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/DontIncludeResourceTransformer.java
@@ -32,7 +32,7 @@
  * resource into the shaded JAR.
  */
 public class DontIncludeResourceTransformer
-    implements ResourceTransformer
+    extends AbstractCompatibilityTransformer
 {
     String resource;
     
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/GroovyResourceTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/GroovyResourceTransformer.java
@@ -36,7 +36,7 @@
  * Aggregate Apache Groovy extension modules descriptors
  */
 public class GroovyResourceTransformer
-    implements ResourceTransformer
+    extends AbstractCompatibilityTransformer
 {
 
     static final String EXT_MODULE_NAME_LEGACY = "META-INF/services/org.codehaus.groovy.runtime.ExtensionModule";
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/IncludeResourceTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/IncludeResourceTransformer.java
@@ -35,7 +35,7 @@
  * content into the shaded JAR.
  */
 public class IncludeResourceTransformer
-    implements ResourceTransformer
+    extends AbstractCompatibilityTransformer
 {
     File file;
 
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/ManifestResourceTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/ManifestResourceTransformer.java
@@ -41,7 +41,7 @@
  * @since 1.2
  */
 public class ManifestResourceTransformer
-    implements ResourceTransformer
+    extends AbstractCompatibilityTransformer
 {
     private final List<String> defaultAttributes = Arrays.asList( "Export-Package",
                                                                   "Import-Package",
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/PluginXmlResourceTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/PluginXmlResourceTransformer.java
@@ -44,7 +44,7 @@
  * @since 3.0
  */
 public class PluginXmlResourceTransformer
-    implements ResourceTransformer
+    extends AbstractCompatibilityTransformer
 {
     private List<Xpp3Dom> mojos = new ArrayList<>();
 
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/ReproducibleResourceTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/ReproducibleResourceTransformer.java
@@ -0,0 +1,49 @@
+package org.apache.maven.plugins.shade.resource;
+
+/*
+ * 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.
+ */
+
+import org.apache.maven.plugins.shade.relocation.Relocator;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.List;
+
+/**
+ * Transform resource ensuring reproducible output: that requires to get the timestamp of
+ * the initial resources to define in a reproducible way the timestamp of the transformed
+ * resource.
+ *
+ * @author Hervé Boutemy
+ * @since 3.2.4
+ */
+public interface ReproducibleResourceTransformer
+    extends ResourceTransformer
+{
+    /**
+     * Transform an individual resource
+     * @param resource The resource name
+     * @param is An input stream for the resource, the implementation should *not* close this stream
+     * @param relocators  A list of relocators
+     * @param time the time of the resource to process
+     * @throws IOException When the IO blows up
+     */
+    void processResource( String resource, InputStream is, List<Relocator> relocators, long time )
+        throws IOException;
+}
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/ResourceBundleAppendingTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/ResourceBundleAppendingTransformer.java
@@ -39,7 +39,7 @@
  * @since 3.0.0
  */
 public class ResourceBundleAppendingTransformer
-    implements ResourceTransformer
+    extends AbstractCompatibilityTransformer
 {
     private Map<String, ByteArrayOutputStream>  dataMap = new HashMap<>();
     
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/ResourceTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/ResourceTransformer.java
@@ -36,10 +36,10 @@ public interface ResourceTransformer
      * @param resource The resource name
      * @param is An input stream for the resource, the implementation should *not* close this stream
      * @param relocators  A list of relocators
-     * @param time the time of the resource to process
      * @throws IOException When the IO blows up
+     * @deprecated prefer ReproducibleResourceTransformer
      */
-    void processResource( String resource, InputStream is, List<Relocator> relocators, long time )
+    void processResource( String resource, InputStream is, List<Relocator> relocators )
         throws IOException;
 
     boolean hasTransformedResource();
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/ServicesResourceTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/ServicesResourceTransformer.java
@@ -46,7 +46,7 @@
  * shading process.
  */
 public class ServicesResourceTransformer
-    implements ResourceTransformer
+    extends AbstractCompatibilityTransformer
 {
 
     private static final String SERVICES_PATH = "META-INF/services";
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/XmlAppendingTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/XmlAppendingTransformer.java
@@ -44,7 +44,7 @@
  * Appends multiple occurrences of some XML file.
  */
 public class XmlAppendingTransformer
-    implements ResourceTransformer
+    extends AbstractCompatibilityTransformer
 {
     public static final String XSI_NS = "http://www.w3.org/2001/XMLSchema-instance";
 
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/properties/PropertiesTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/properties/PropertiesTransformer.java
@@ -32,7 +32,7 @@
 import java.util.jar.JarOutputStream;
 
 import org.apache.maven.plugins.shade.relocation.Relocator;
-import org.apache.maven.plugins.shade.resource.ResourceTransformer;
+import org.apache.maven.plugins.shade.resource.ReproducibleResourceTransformer;
 import org.apache.maven.plugins.shade.resource.properties.io.NoCloseOutputStream;
 import org.apache.maven.plugins.shade.resource.properties.io.SkipPropertiesDateLineWriter;
 
@@ -42,7 +42,7 @@
  * @since 3.2.2
  */
 public class PropertiesTransformer
-    implements ResourceTransformer
+    implements ReproducibleResourceTransformer
 {
     private String resource;
     private String alreadyMergedKey;
@@ -73,6 +73,13 @@ public boolean canTransformResource( final String resource )
         return Objects.equals( resource, this.resource );
     }
 
+    @Override
+    public final void processResource( String resource, InputStream is, List<Relocator> relocators )
+        throws IOException
+    {
+        processResource( resource, is, relocators, 0 );
+    }
+
     @Override
     public void processResource( final String resource, final InputStream is, final List<Relocator> relocators,
                                  long time )
diff --git a/src/test/java/org/apache/maven/plugins/shade/resource/rule/TransformerTesterRule.java b/src/test/java/org/apache/maven/plugins/shade/resource/rule/TransformerTesterRule.java

Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@`
`49`	`49`	`import org.apache.maven.plugins.shade.filter.Filter;`
`50`	`50`	`import org.apache.maven.plugins.shade.relocation.Relocator;`
`51`	`51`	`import org.apache.maven.plugins.shade.resource.ManifestResourceTransformer;`
	`52`	`+import org.apache.maven.plugins.shade.resource.ReproducibleResourceTransformer;`
`52`	`53`	`import org.apache.maven.plugins.shade.resource.ResourceTransformer;`
`53`	`54`	`import org.codehaus.plexus.component.annotations.Component;`
`54`	`55`	`import org.codehaus.plexus.logging.AbstractLogEnabled;`
`@@ -76,15 +77,15 @@ public void shade( ShadeRequest shadeRequest )`
`76`	`77`	`{`
`77`	`78`	`Set<String> resources = new HashSet<>();`
`78`	`79`
`79`		`- ResourceTransformer manifestTransformer = null;`
	`80`	`+ ManifestResourceTransformer manifestTransformer = null;`
`80`	`81`	`List<ResourceTransformer> transformers =`
`81`	`82`	`new ArrayList<>( shadeRequest.getResourceTransformers() );`
`82`	`83`	`for ( Iterator<ResourceTransformer> it = transformers.iterator(); it.hasNext(); )`
`83`	`84`	`{`
`84`	`85`	`ResourceTransformer transformer = it.next();`
`85`	`86`	`if ( transformer instanceof ManifestResourceTransformer )`
`86`	`87`	`{`
`87`		`- manifestTransformer = transformer;`
	`88`	`+ manifestTransformer = (ManifestResourceTransformer) transformer;`
`88`	`89`	`it.remove();`
`89`	`90`	`}`
`90`	`91`	`}`
`@@ -265,11 +266,11 @@ else if ( shadeRequest.isShadeSourcesContent() && name.endsWith( ".java" ) )`
`265`	`266`	`}`
`266`	`267`
`267`	`268`	`private void goThroughAllJarEntriesForManifestTransformer( ShadeRequest shadeRequest, Set<String> resources,`
`268`		`- ResourceTransformer resourceTransformer,`
	`269`	`+ ManifestResourceTransformer manifestTransformer,`
`269`	`270`	`JarOutputStream jos )`
`270`	`271`	`throws IOException`
`271`	`272`	`{`
`272`		`- if ( resourceTransformer != null )`
	`273`	`+ if ( manifestTransformer != null )`
`273`	`274`	`{`
`274`	`275`	`for ( File jar : shadeRequest.getJars() )`
`275`	`276`	`{`
`@@ -279,22 +280,22 @@ private void goThroughAllJarEntriesForManifestTransformer( ShadeRequest shadeReq`
`279`	`280`	`{`
`280`	`281`	`JarEntry entry = en.nextElement();`
`281`	`282`	`String resource = entry.getName();`
`282`		`- if ( resourceTransformer.canTransformResource( resource ) )`
	`283`	`+ if ( manifestTransformer.canTransformResource( resource ) )`
`283`	`284`	`{`
`284`	`285`	`resources.add( resource );`
`285`	`286`	`try ( InputStream inputStream = jarFile.getInputStream( entry ) )`
`286`	`287`	`{`
`287`		`- resourceTransformer.processResource( resource, inputStream,`
`288`		`- shadeRequest.getRelocators(), entry.getTime() );`
	`288`	`+ manifestTransformer.processResource( resource, inputStream,`
	`289`	`+ shadeRequest.getRelocators(), entry.getTime() );`
`289`	`290`	`}`
`290`	`291`	`break;`
`291`	`292`	`}`
`292`	`293`	`}`
`293`	`294`	`}`
`294`	`295`	`}`
`295`		`- if ( resourceTransformer.hasTransformedResource() )`
	`296`	`+ if ( manifestTransformer.hasTransformedResource() )`
`296`	`297`	`{`
`297`		`- resourceTransformer.modifyOutputStream( jos );`
	`298`	`+ manifestTransformer.modifyOutputStream( jos );`
`298`	`299`	`}`
`299`	`300`	`}`
`300`	`301`	`}`
`@@ -544,7 +545,14 @@ private boolean resourceTransformed( List<ResourceTransformer> resourceTransform`
`544`	`545`	`{`
`545`	`546`	`getLogger().debug( "Transforming " + name + " using " + transformer.getClass().getName() );`
`546`	`547`
`547`		`- transformer.processResource( name, is, relocators, time );`
	`548`	`+ if ( transformer instanceof ReproducibleResourceTransformer )`
	`549`	`+ {`
	`550`	`+ ( (ReproducibleResourceTransformer) transformer ).processResource( name, is, relocators, time );`
	`551`	`+ }`
	`552`	`+ else`
	`553`	`+ {`
	`554`	`+ transformer.processResource( name, is, relocators );`
	`555`	`+ }`
`548`	`556`
`549`	`557`	`resourceTransformed = true;`
`550`	`558`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`* Prevents duplicate copies of the license`
`31`	`31`	`*/`
`32`	`32`	`public class ApacheLicenseResourceTransformer`
`33`		`- implements ResourceTransformer`
	`33`	`+ extends AbstractCompatibilityTransformer`
`34`	`34`	`{`
`35`	`35`	`private static final String LICENSE_PATH = "META-INF/LICENSE";`
`36`	`36`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@`
`43`	`43`	`* Merges <code>META-INF/NOTICE.TXT</code> files.`
`44`	`44`	`*/`
`45`	`45`	`public class ApacheNoticeResourceTransformer`
`46`		`- implements ResourceTransformer`
	`46`	`+ extends AbstractCompatibilityTransformer`
`47`	`47`	`{`
`48`	`48`	`Set<String> entries = new LinkedHashSet<>();`
`49`	`49`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@`
`33`	`33`	`* A resource processor that appends content for a resource, separated by a newline.`
`34`	`34`	`*/`
`35`	`35`	`public class AppendingTransformer`
`36`		`- implements ResourceTransformer`
	`36`	`+ extends AbstractCompatibilityTransformer`
`37`	`37`	`{`
`38`	`38`	`String resource;`
`39`	`39`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@`
`42`	`42`	`* A resource processor that aggregates plexus <code>components.xml</code> files.`
`43`	`43`	`*/`
`44`	`44`	`public class ComponentsXmlResourceTransformer`
`45`		`- implements ResourceTransformer`
	`45`	`+ extends AbstractCompatibilityTransformer`
`46`	`46`	`{`
`47`	`47`	`private Map<String, Xpp3Dom> components = new LinkedHashMap<>();`
`48`	`48`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@`
`32`	`32`	`* resource into the shaded JAR.`
`33`	`33`	`*/`
`34`	`34`	`public class DontIncludeResourceTransformer`
`35`		`- implements ResourceTransformer`
	`35`	`+ extends AbstractCompatibilityTransformer`
`36`	`36`	`{`
`37`	`37`	`String resource;`
`38`	`38`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@`
`36`	`36`	`* Aggregate Apache Groovy extension modules descriptors`
`37`	`37`	`*/`
`38`	`38`	`public class GroovyResourceTransformer`
`39`		`- implements ResourceTransformer`
	`39`	`+ extends AbstractCompatibilityTransformer`
`40`	`40`	`{`
`41`	`41`
`42`	`42`	`static final String EXT_MODULE_NAME_LEGACY = "META-INF/services/org.codehaus.groovy.runtime.ExtensionModule";`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@`
`35`	`35`	`* content into the shaded JAR.`
`36`	`36`	`*/`
`37`	`37`	`public class IncludeResourceTransformer`
`38`		`- implements ResourceTransformer`
	`38`	`+ extends AbstractCompatibilityTransformer`
`39`	`39`	`{`
`40`	`40`	`File file;`
`41`	`41`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@`
`41`	`41`	`* @since 1.2`
`42`	`42`	`*/`
`43`	`43`	`public class ManifestResourceTransformer`
`44`		`- implements ResourceTransformer`
	`44`	`+ extends AbstractCompatibilityTransformer`
`45`	`45`	`{`
`46`	`46`	`private final List<String> defaultAttributes = Arrays.asList( "Export-Package",`
`47`	`47`	`"Import-Package",`