Skip to content

Commit

Permalink
MSHADE-373: allow to specify optional target for resource transformers.
Browse files Browse the repository at this point in the history
  • Loading branch information
raphw committed Jul 2, 2020
1 parent 6ea8543 commit 92da058
Show file tree
Hide file tree
Showing 4 changed files with 194 additions and 10 deletions.
109 changes: 109 additions & 0 deletions src/it/projects/MSHADE-373/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
<?xml version="1.0" encoding="UTF-8"?>

<!--
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.
-->

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>org.apache.maven.its.shade.mt</groupId>
<artifactId>test</artifactId>
<version>1.0</version>
<packaging>jar</packaging>

<name>MSHADE-373</name>
<description>
Test that reproduces the issue described in MSHADE-373.
</description>

<dependencies>
<dependency>
<!-- dummy dependency to test interaction of multiple manifests -->
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>@project.version@</version>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>2.0.2</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-install-plugin</artifactId>
<version>2.2</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.2</version>
<configuration>
<archive>
<manifest>
<mainClass>org.apache.maven.Main</mainClass>
</manifest>
<manifestEntries>
<Test-Entry>PASSED</Test-Entry>
<Original-Entry>PASSED</Original-Entry>
</manifestEntries>
</archive>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>2.2</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>@project.version@</version>
<executions>
<execution>
<id>attach-shade</id>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<shadedArtifactAttached>false</shadedArtifactAttached>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<forShade>sources-jar</forShade>
<manifestEntries>
<Test-Entry>FAILED</Test-Entry>
</manifestEntries>
</transformer>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.3.1</version>
</plugin>
</plugins>
</build>
</project>
40 changes: 40 additions & 0 deletions src/it/projects/MSHADE-373/verify.bsh
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
/*
* 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 java.io.*;
import java.util.jar.*;

// NOTE: We deliberately use JarInputStream and not JarFile here!
JarInputStream jarStream = new JarInputStream( new FileInputStream( new File( basedir, "target/test-1.0.jar" ) ) );
Manifest mf = jarStream.getManifest();
jarStream.close();

if ( mf == null )
{
throw new IllegalStateException( "META-INF/MANIFEST.MF is missing" );
}

if ( !"PASSED".equals( mf.getMainAttributes().getValue( "Test-Entry" ) ) )
{
throw new IllegalStateException( "Test-Entry should not have been changed" );
}

if ( !"PASSED".equals( mf.getMainAttributes().getValue( "Original-Entry" ) ) )
{
throw new IllegalStateException( "META-INF/MANIFEST.MF is incomplete" );
}
38 changes: 28 additions & 10 deletions src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
import org.apache.maven.plugins.shade.pom.PomWriter;
import org.apache.maven.plugins.shade.relocation.Relocator;
import org.apache.maven.plugins.shade.relocation.SimpleRelocator;
import org.apache.maven.plugins.shade.resource.ManifestResourceTransformer;
import org.apache.maven.plugins.shade.resource.ResourceTransformer;
import org.apache.maven.project.DefaultProjectBuildingRequest;
import org.apache.maven.project.MavenProject;
Expand Down Expand Up @@ -458,31 +459,33 @@ public void execute()

List<ResourceTransformer> resourceTransformers = getResourceTransformers();

ShadeRequest shadeRequest = shadeRequest( artifacts, outputJar, filters, relocators, resourceTransformers );
ShadeRequest shadeRequest = shadeRequest( "jar", artifacts, outputJar, filters, relocators,
resourceTransformers );

shader.shade( shadeRequest );

if ( createSourcesJar )
{
ShadeRequest shadeSourcesRequest =
createShadeSourcesRequest( sourceArtifacts, sourcesJar, filters, relocators, resourceTransformers );
createShadeSourcesRequest( "sources-jar", sourceArtifacts, sourcesJar, filters, relocators,
resourceTransformers );

shader.shade( shadeSourcesRequest );
}

if ( shadeTestJar )
{
ShadeRequest shadeTestRequest =
shadeRequest( testArtifacts, testJar, filters, relocators, resourceTransformers );
shadeRequest( "test-jar", testArtifacts, testJar, filters, relocators, resourceTransformers );

shader.shade( shadeTestRequest );
}

if ( createTestSourcesJar )
{
ShadeRequest shadeTestSourcesRequest =
createShadeSourcesRequest( testSourceArtifacts, testSourcesJar, filters, relocators,
resourceTransformers );
createShadeSourcesRequest( "test-sources-jar", testSourceArtifacts, testSourcesJar, filters,
relocators, resourceTransformers );

shader.shade( shadeTestSourcesRequest );
}
Expand Down Expand Up @@ -621,24 +624,24 @@ private void createErrorOutput()
getLog().error( "- You removed the configuration of the maven-jar-plugin that produces the main artifact." );
}

private ShadeRequest shadeRequest( Set<File> artifacts, File outputJar, List<Filter> filters,
private ShadeRequest shadeRequest( String shade, Set<File> artifacts, File outputJar, List<Filter> filters,
List<Relocator> relocators, List<ResourceTransformer> resourceTransformers )
{
ShadeRequest shadeRequest = new ShadeRequest();
shadeRequest.setJars( artifacts );
shadeRequest.setUberJar( outputJar );
shadeRequest.setFilters( filters );
shadeRequest.setRelocators( relocators );
shadeRequest.setResourceTransformers( resourceTransformers );
shadeRequest.setResourceTransformers( toResourceTransformers( shade, resourceTransformers ) );
return shadeRequest;
}

private ShadeRequest createShadeSourcesRequest( Set<File> testArtifacts, File testJar, List<Filter> filters,
List<Relocator> relocators,
private ShadeRequest createShadeSourcesRequest( String shade, Set<File> testArtifacts, File testJar,
List<Filter> filters, List<Relocator> relocators,
List<ResourceTransformer> resourceTransformers )
{
ShadeRequest shadeSourcesRequest =
shadeRequest( testArtifacts, testJar, filters, relocators, resourceTransformers );
shadeRequest( shade, testArtifacts, testJar, filters, relocators, resourceTransformers );
shadeSourcesRequest.setShadeSourcesContent( shadeSourcesContent );
return shadeSourcesRequest;
}
Expand Down Expand Up @@ -1314,4 +1317,19 @@ public boolean updateExcludesInDeps( MavenProject project, List<Dependency> depe
session.getProjectBuildingRequest().setProject( original );
}
}

private List<ResourceTransformer> toResourceTransformers(
String shade, List<ResourceTransformer> resourceTransformers )
{
List<ResourceTransformer> forShade = new ArrayList<ResourceTransformer>();
for ( ResourceTransformer transformer : resourceTransformers )
{
if ( !( transformer instanceof ManifestResourceTransformer )
|| ( ( ManifestResourceTransformer ) transformer ) .isForShade( shade ) )
{
forShade.add( transformer );
}
}
return forShade;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ public class ManifestResourceTransformer

private long time = Long.MIN_VALUE;

private String shade;

public void setMainClass( String mainClass )
{
this.mainClass = mainClass;
Expand Down Expand Up @@ -188,4 +190,19 @@ private String relocate( String originalValue, List<Relocator> relocators )
}
return newValue;
}

/**
* The shades to apply this transformer to or no shades if no filter is applied.
*
* @param shade {@code null}, {@code jar}, {@code test-jar}, {@code sources-jar} or {@code test-sources-jar}.
*/
public void setForShade( String shade )
{
this.shade = shade;
}

public boolean isForShade( String shade )
{
return shade == null || shade.isEmpty() || this.shade.equalsIgnoreCase( shade );
}
}

0 comments on commit 92da058

Please sign in to comment.