diff --git a/src/it/projects/MSHADE-36-inject-dep-reduced-pom-in-final/invoker.properties b/src/it/projects/MSHADE-36-inject-dep-reduced-pom-in-final/invoker.properties new file mode 100644 index 00000000..a644cb7e --- /dev/null +++ b/src/it/projects/MSHADE-36-inject-dep-reduced-pom-in-final/invoker.properties @@ -0,0 +1,18 @@ +# 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. + +invoker.goals = clean package diff --git a/src/it/projects/MSHADE-36-inject-dep-reduced-pom-in-final/pom.xml b/src/it/projects/MSHADE-36-inject-dep-reduced-pom-in-final/pom.xml new file mode 100644 index 00000000..db4be437 --- /dev/null +++ b/src/it/projects/MSHADE-36-inject-dep-reduced-pom-in-final/pom.xml @@ -0,0 +1,95 @@ + + + + + + 4.0.0 + + + org.apache.maven.plugins.shade.its + shade-parent + 1.0 + ../setup-parent + + + org.apache.maven.its.shade.drp + test + 1.0 + jar + + MSHADE-36 + + Test to see that the dependency-reduced-pom.xml is injected into the final jar instead of the original pom.xml + + + + + junit + junit + 3.8.2 + + + org.codehaus.plexus + plexus-utils + 1.4.1 + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + 2.0.2 + + + org.apache.maven.plugins + maven-shade-plugin + @project.version@ + + + attach-shade + package + + shade + + + true + true + true + + + org.codehaus.plexus + com.example.shaded.org.codehaus.plexus + + + + + junit:junit + org.codehaus.plexus:plexus-utils + + + + + + + + + diff --git a/src/it/projects/MSHADE-36-inject-dep-reduced-pom-in-final/src/main/java/com/example/Main.java b/src/it/projects/MSHADE-36-inject-dep-reduced-pom-in-final/src/main/java/com/example/Main.java new file mode 100644 index 00000000..9d5cf11c --- /dev/null +++ b/src/it/projects/MSHADE-36-inject-dep-reduced-pom-in-final/src/main/java/com/example/Main.java @@ -0,0 +1,33 @@ +/* + * 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 com.example; + +import org.codehaus.plexus.util.StringUtils; + +public class Main +{ + public static void main( String[] args ) { + System.out.println( "Hello World!" + ( isEmpty("foo") ? " is empty!" : " -- ") ); + } + + public static boolean isEmpty( String input ) { + return StringUtils.isEmpty( input ); + } +} diff --git a/src/it/projects/MSHADE-36-inject-dep-reduced-pom-in-final/verify.bsh b/src/it/projects/MSHADE-36-inject-dep-reduced-pom-in-final/verify.bsh new file mode 100644 index 00000000..ae48cd93 --- /dev/null +++ b/src/it/projects/MSHADE-36-inject-dep-reduced-pom-in-final/verify.bsh @@ -0,0 +1,73 @@ +/* + * 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.*; +import java.util.Arrays; +import org.codehaus.plexus.util.*; + +String[] wanted = +{ + "com/example/Main.class", + "junit/swingui/icons/error.gif", + "com/example/shaded/org/codehaus/plexus/util/StringUtils.class", +}; + +String[] unwanted = +{ + "junit/swingui/TestRunner.class", + "org/codehaus/plexus/util/StringUtils.class", +}; + +JarFile jarFile = null; +try +{ + jarFile = new JarFile ( new File( basedir, "target/test-1.0.jar" ) ); + + for ( String path:wanted ) + { + if ( jarFile.getEntry( path ) == null ) + { + throw new IllegalStateException( "wanted path is missing: "+path ); + } + } + + for ( String path:unwanted ) + { + if ( jarFile.getEntry( path ) != null ) + { + throw new IllegalStateException ( "unwanted path is present: "+path ); + } + } + + JarEntry jarEntry = jarFile.getEntry( "META-INF/maven/org.apache.maven.its.shade.drp/test/pom.xml" ); + String pomFile = IOUtil.toString( jarFile.getInputStream( jarEntry ), "UTF-8" ); + + if ( pomFile.contains( "org.codehaus.plexus" ) ) + { + throw new IllegalStateException( "The pom.xml still contains a reference to the org.codehaus.plexus dependency" ); + } + +} +finally +{ + if ( jarFile != null ) { + jarFile.close(); + } +} diff --git a/src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java b/src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java index 25b83303..7c524f80 100644 --- a/src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java +++ b/src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java @@ -76,6 +76,7 @@ import java.util.Set; import javax.inject.Inject; +import static org.apache.maven.plugins.shade.resource.UseDependencyReducedPom.createPomReplaceTransformers; /** * Mojo that performs shading delegating to the Shader component. @@ -285,6 +286,15 @@ public class ShadeMojo @Parameter( defaultValue = "false" ) private boolean generateUniqueDependencyReducedPom; + /** + * Add dependency reduced POM to the JAR instead of the original one provided by the project. + * If {@code createDependencyReducedPom} is {@code false} this parameter will be ignored. + * + * @since 3.3.0 + */ + @Parameter( defaultValue = "false" ) + private boolean useDependencyReducedPomInJar; + /** * When true, dependencies are kept in the pom but with scope 'provided'; when false, the dependency is removed. */ @@ -449,6 +459,19 @@ public void execute() List resourceTransformers = getResourceTransformers(); + if ( createDependencyReducedPom ) + { + createDependencyReducedPom( artifactIds ); + + if ( useDependencyReducedPomInJar ) + { + // In some cases the used implementation of the resourceTransformers is immutable. + resourceTransformers = new ArrayList<>( resourceTransformers ); + resourceTransformers.addAll( + createPomReplaceTransformers( project, dependencyReducedPomLocation ) ); + } + } + ShadeRequest shadeRequest = shadeRequest( "jar", artifacts, outputJar, filters, relocators, resourceTransformers ); @@ -588,11 +611,6 @@ else if ( !renamed ) } } } - - if ( createDependencyReducedPom ) - { - createDependencyReducedPom( artifactIds ); - } } } catch ( Exception e ) diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/UseDependencyReducedPom.java b/src/main/java/org/apache/maven/plugins/shade/resource/UseDependencyReducedPom.java new file mode 100644 index 00000000..8e7071d1 --- /dev/null +++ b/src/main/java/org/apache/maven/plugins/shade/resource/UseDependencyReducedPom.java @@ -0,0 +1,55 @@ +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.project.MavenProject; + +import java.io.File; +import java.util.ArrayList; +import java.util.List; + +/** + * Manually creates the resource processors needed to remove the original pom.xml and inject + * the dependency-reduced-pom.xml in its place in the shaded JAR. + */ +public class UseDependencyReducedPom +{ + public static List createPomReplaceTransformers( + MavenProject project, + File dependencyReducedPomLocation + ) + { + String pomInFinalJarFilename = + "META-INF/maven/" + project.getGroupId() + "/" + project.getArtifactId() + "/pom.xml"; + + List resourceTransformers = new ArrayList<>(); + + DontIncludeResourceTransformer removePom = new DontIncludeResourceTransformer(); + removePom.resource = pomInFinalJarFilename; + resourceTransformers.add( removePom ); + + IncludeResourceTransformer insertDependencyReducedPom = new IncludeResourceTransformer(); + insertDependencyReducedPom.file = dependencyReducedPomLocation; + insertDependencyReducedPom.resource = pomInFinalJarFilename; + resourceTransformers.add( insertDependencyReducedPom ); + + return resourceTransformers; + } +}