This is an automated email from the ASF dual-hosted git repository. slachiewicz pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-shade-plugin.git
commit ccc91b6efe652dd04002f7b0bf1d2c2d78da711b Author: Vaclav Haisman <[email protected]> AuthorDate: Wed Aug 26 19:37:58 2026 +0200 [MSHADE-265] Parse module info options case-insensitively --- .../apache/maven/plugins/shade/DefaultShader.java | 7 ++-- .../plugins/shade/ModuleInfoConfiguration.java | 8 ++-- .../apache/maven/plugins/shade/ModuleInfoMode.java | 25 +++++++++++- .../maven/plugins/shade/ModuleInfoProcessor.java | 4 +- .../plugins/shade/ModuleInfoPublicBoundary.java | 25 +++++++++++- .../apache/maven/plugins/shade/ShadeRequest.java | 4 +- .../apache/maven/plugins/shade/mojo/ShadeMojo.java | 9 +++-- .../maven/plugins/shade/DefaultShaderTest.java | 20 ++++----- .../plugins/shade/ModuleInfoConfigurationTest.java | 8 ++-- .../maven/plugins/shade/ModuleInfoModeTest.java | 47 ++++++++++++++++++++++ .../maven/plugins/shade/mojo/ShadeMojoTest.java | 4 +- 11 files changed, 127 insertions(+), 34 deletions(-) diff --git a/src/main/java/org/apache/maven/plugins/shade/DefaultShader.java b/src/main/java/org/apache/maven/plugins/shade/DefaultShader.java index d1c301a2..122c1ea3 100644 --- a/src/main/java/org/apache/maven/plugins/shade/DefaultShader.java +++ b/src/main/java/org/apache/maven/plugins/shade/DefaultShader.java @@ -156,7 +156,7 @@ public class DefaultShader implements Shader { } ModuleInfoProcessor moduleInfoProcessor = null; - if (shadeRequest.getModuleInfoMode() == ModuleInfoMode.merge) { + if (shadeRequest.getModuleInfoMode() == ModuleInfoMode.MERGE) { moduleInfoProcessor = new ModuleInfoProcessor(shadeRequest, logger); if (manifestTransformer != null && manifestTransformer.isMultiReleaseExplicitlyEnabled()) { moduleInfoProcessor.enableMultiReleaseOutput(); @@ -183,8 +183,9 @@ public class DefaultShader implements Shader { logger.warn("Configured Multi-Release: false is overridden because module descriptor merging " + "produces versioned output."); } else { - logger.warn("Configured Multi-Release: false is overridden because shaded input " - + multiReleaseInputs.get(0) + " is a multi-release JAR."); + logger.warn( + "Configured Multi-Release: false is overridden because shaded input {} is a multi-release JAR.", + multiReleaseInputs.get(0)); } } forceMultiRelease = true; diff --git a/src/main/java/org/apache/maven/plugins/shade/ModuleInfoConfiguration.java b/src/main/java/org/apache/maven/plugins/shade/ModuleInfoConfiguration.java index 447f9871..85b721de 100644 --- a/src/main/java/org/apache/maven/plugins/shade/ModuleInfoConfiguration.java +++ b/src/main/java/org/apache/maven/plugins/shade/ModuleInfoConfiguration.java @@ -27,7 +27,7 @@ import java.util.Set; * Additional choices used while constructing the module descriptor for amalgamated shaded contents. */ public class ModuleInfoConfiguration { - private ModuleInfoPublicBoundary publicBoundary = ModuleInfoPublicBoundary.primary; + private String publicBoundary = ModuleInfoPublicBoundary.PRIMARY.name(); private Map<String, String> analysisJdkToolchain = Collections.emptyMap(); @@ -42,11 +42,11 @@ public class ModuleInfoConfiguration { private Set<String> dynamicUses = Collections.emptySet(); public ModuleInfoPublicBoundary getPublicBoundary() { - return publicBoundary; + return ModuleInfoPublicBoundary.fromString(publicBoundary); } - public void setPublicBoundary(ModuleInfoPublicBoundary publicBoundary) { - this.publicBoundary = publicBoundary == null ? ModuleInfoPublicBoundary.primary : publicBoundary; + public void setPublicBoundary(String publicBoundary) { + this.publicBoundary = publicBoundary == null ? ModuleInfoPublicBoundary.PRIMARY.name() : publicBoundary; } public Map<String, String> getAnalysisJdkToolchain() { diff --git a/src/main/java/org/apache/maven/plugins/shade/ModuleInfoMode.java b/src/main/java/org/apache/maven/plugins/shade/ModuleInfoMode.java index 902685da..fc763456 100644 --- a/src/main/java/org/apache/maven/plugins/shade/ModuleInfoMode.java +++ b/src/main/java/org/apache/maven/plugins/shade/ModuleInfoMode.java @@ -18,13 +18,34 @@ */ package org.apache.maven.plugins.shade; +import java.util.Locale; + /** * Controls how module descriptors are handled while shading. */ public enum ModuleInfoMode { /** Discard module descriptors, retaining the historical behavior. */ - discard, + DISCARD, /** Merge module descriptors into the descriptor of the primary artifact. */ - merge + MERGE; + + /** + * Parses a module descriptor handling mode without regard to case. + * + * @param value module descriptor handling mode + * @return parsed module descriptor handling mode + * @throws IllegalArgumentException if the value is not a supported mode + */ + public static ModuleInfoMode fromString(String value) { + if (value == null) { + throw new IllegalArgumentException("Module info mode must not be null."); + } + try { + return valueOf(value.toUpperCase(Locale.ROOT).trim()); + } catch (IllegalArgumentException e) { + throw new IllegalArgumentException( + "Unknown module info mode '" + value + "'. Expected one of: discard, merge."); + } + } } diff --git a/src/main/java/org/apache/maven/plugins/shade/ModuleInfoProcessor.java b/src/main/java/org/apache/maven/plugins/shade/ModuleInfoProcessor.java index b936a067..6860787a 100644 --- a/src/main/java/org/apache/maven/plugins/shade/ModuleInfoProcessor.java +++ b/src/main/java/org/apache/maven/plugins/shade/ModuleInfoProcessor.java @@ -636,7 +636,7 @@ final class ModuleInfoProcessor { } private void addAutomaticBoundary(MergedDescriptor target, ArtifactData artifact, int release) { - if (configuration.getPublicBoundary() != ModuleInfoPublicBoundary.merge) { + if (configuration.getPublicBoundary() != ModuleInfoPublicBoundary.MERGE) { return; } for (String packaze : effectiveArtifactPackages(artifact.file, release)) { @@ -651,7 +651,7 @@ final class ModuleInfoProcessor { ModuleDescriptorData descriptor, Set<String> embeddedNames, int release) { - if (configuration.getPublicBoundary() != ModuleInfoPublicBoundary.merge) { + if (configuration.getPublicBoundary() != ModuleInfoPublicBoundary.MERGE) { return; } Set<String> packages = effectivePackages(release); diff --git a/src/main/java/org/apache/maven/plugins/shade/ModuleInfoPublicBoundary.java b/src/main/java/org/apache/maven/plugins/shade/ModuleInfoPublicBoundary.java index abdac0b7..3c0cfb68 100644 --- a/src/main/java/org/apache/maven/plugins/shade/ModuleInfoPublicBoundary.java +++ b/src/main/java/org/apache/maven/plugins/shade/ModuleInfoPublicBoundary.java @@ -18,13 +18,34 @@ */ package org.apache.maven.plugins.shade; +import java.util.Locale; + /** * Controls which embedded package boundaries are retained in a merged module descriptor. */ public enum ModuleInfoPublicBoundary { /** Retain only the primary artifact's exports and opens. */ - primary, + PRIMARY, /** Merge the effective exports and opens of embedded explicit and automatic modules. */ - merge + MERGE; + + /** + * Parses a public boundary mode without regard to case. + * + * @param value public boundary mode + * @return parsed public boundary mode + * @throws IllegalArgumentException if the value is not a supported mode + */ + public static ModuleInfoPublicBoundary fromString(String value) { + if (value == null) { + throw new IllegalArgumentException("Module info public boundary must not be null."); + } + try { + return valueOf(value.toUpperCase(Locale.ROOT)); + } catch (IllegalArgumentException e) { + throw new IllegalArgumentException( + "Unknown module info public boundary '" + value + "'. Expected one of: primary, merge."); + } + } } diff --git a/src/main/java/org/apache/maven/plugins/shade/ShadeRequest.java b/src/main/java/org/apache/maven/plugins/shade/ShadeRequest.java index 6f0a742b..31d5dd76 100644 --- a/src/main/java/org/apache/maven/plugins/shade/ShadeRequest.java +++ b/src/main/java/org/apache/maven/plugins/shade/ShadeRequest.java @@ -48,7 +48,7 @@ public class ShadeRequest { private boolean shadeSourcesContent; - private ModuleInfoMode moduleInfoMode = ModuleInfoMode.discard; + private ModuleInfoMode moduleInfoMode = ModuleInfoMode.DISCARD; private ModuleInfoConfiguration moduleInfoConfiguration = new ModuleInfoConfiguration(); @@ -159,7 +159,7 @@ public class ShadeRequest { * @param moduleInfoMode module descriptor handling mode */ public void setModuleInfoMode(ModuleInfoMode moduleInfoMode) { - this.moduleInfoMode = moduleInfoMode == null ? ModuleInfoMode.discard : moduleInfoMode; + this.moduleInfoMode = moduleInfoMode == null ? ModuleInfoMode.DISCARD : moduleInfoMode; } public ModuleInfoConfiguration getModuleInfoConfiguration() { 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 c02b0bad..3000279f 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 @@ -350,7 +350,7 @@ public class ShadeMojo extends AbstractMojo { * @since 3.7.0 */ @Parameter(property = "shade.moduleInfoMode", defaultValue = "discard") - private ModuleInfoMode moduleInfoMode = ModuleInfoMode.discard; + private String moduleInfoMode = "discard"; /** * Configures how the merged descriptor represents the amalgamated shaded contents. @@ -786,9 +786,10 @@ public class ShadeMojo extends AbstractMojo { shadeRequest.setFilters(filters); shadeRequest.setRelocators(relocators); shadeRequest.setResourceTransformers(toResourceTransformers(shade, resourceTransformers)); - shadeRequest.setModuleInfoMode(moduleInfoMode); + ModuleInfoMode parsedModuleInfoMode = ModuleInfoMode.fromString(moduleInfoMode); + shadeRequest.setModuleInfoMode(parsedModuleInfoMode); shadeRequest.setModuleInfoConfiguration(moduleInfo); - if (moduleInfoMode == ModuleInfoMode.merge && primaryArtifact != null) { + if (parsedModuleInfoMode == ModuleInfoMode.MERGE && primaryArtifact != null) { shadeRequest.setModuleInfoAnalysisJdkHome(resolveModuleInfoAnalysisJdkHome()); } shadeRequest.setDependencyAnalysisArtifacts(dependencyAnalysisArtifacts); @@ -812,7 +813,7 @@ public class ShadeMojo extends AbstractMojo { relocators, resourceTransformers, Collections.<File>emptySet()); - shadeSourcesRequest.setModuleInfoMode(ModuleInfoMode.discard); + shadeSourcesRequest.setModuleInfoMode(ModuleInfoMode.DISCARD); shadeSourcesRequest.setShadeSourcesContent(shadeSourcesContent); return shadeSourcesRequest; } diff --git a/src/test/java/org/apache/maven/plugins/shade/DefaultShaderTest.java b/src/test/java/org/apache/maven/plugins/shade/DefaultShaderTest.java index 0702d7f5..4ec60b6a 100644 --- a/src/test/java/org/apache/maven/plugins/shade/DefaultShaderTest.java +++ b/src/test/java/org/apache/maven/plugins/shade/DefaultShaderTest.java @@ -89,6 +89,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertThrows; import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.doNothing; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; @@ -586,7 +587,7 @@ public class DefaultShaderTest { ShadeRequest request = new ShadeRequest(); request.setJars(new LinkedHashSet<>(Arrays.asList(primary, dependency))); request.setPrimaryArtifact(primary); - request.setModuleInfoMode(ModuleInfoMode.merge); + request.setModuleInfoMode(ModuleInfoMode.MERGE); request.setFilters(Collections.emptyList()); request.setRelocators(Collections.emptyList()); request.setResourceTransformers(Collections.singletonList(manifestTransformer)); @@ -626,7 +627,7 @@ public class DefaultShaderTest { ShadeRequest request = new ShadeRequest(); request.setJars(new LinkedHashSet<>(Arrays.asList(primary, dependency))); request.setPrimaryArtifact(primary); - request.setModuleInfoMode(ModuleInfoMode.merge); + request.setModuleInfoMode(ModuleInfoMode.MERGE); request.setFilters(Collections.emptyList()); request.setRelocators(Collections.emptyList()); request.setResourceTransformers(Collections.emptyList()); @@ -927,7 +928,7 @@ public class DefaultShaderTest { ShadeRequest request = new ShadeRequest(); request.setJars(new LinkedHashSet<>(Arrays.asList(primary, dependency))); request.setPrimaryArtifact(primary); - request.setModuleInfoMode(ModuleInfoMode.merge); + request.setModuleInfoMode(ModuleInfoMode.MERGE); request.setFilters(Collections.emptyList()); request.setRelocators(Collections.singletonList(new SimpleRelocator("dep", "hidden.dep", null, null))); request.setResourceTransformers(Collections.emptyList()); @@ -1040,7 +1041,7 @@ public class DefaultShaderTest { ShadeRequest request = new ShadeRequest(); request.setJars(new LinkedHashSet<>(Arrays.asList(primary, dependency))); request.setPrimaryArtifact(primary); - request.setModuleInfoMode(ModuleInfoMode.merge); + request.setModuleInfoMode(ModuleInfoMode.MERGE); request.setFilters(Collections.emptyList()); request.setRelocators(Collections.singletonList(new SimpleRelocator("dep", "hidden.dep", null, null))); request.setResourceTransformers(Collections.emptyList()); @@ -1171,7 +1172,7 @@ public class DefaultShaderTest { ShadeRequest request = new ShadeRequest(); request.setJars(new LinkedHashSet<>(Arrays.asList(primary, dependency))); request.setPrimaryArtifact(primary); - request.setModuleInfoMode(ModuleInfoMode.merge); + request.setModuleInfoMode(ModuleInfoMode.MERGE); request.setFilters(Collections.emptyList()); request.setRelocators(Collections.emptyList()); request.setResourceTransformers(Collections.emptyList()); @@ -1226,7 +1227,7 @@ public class DefaultShaderTest { ShadeRequest request = new ShadeRequest(); request.setJars(new LinkedHashSet<>(Arrays.asList(primary, dependency))); request.setPrimaryArtifact(primary); - request.setModuleInfoMode(ModuleInfoMode.merge); + request.setModuleInfoMode(ModuleInfoMode.MERGE); request.setFilters(Collections.emptyList()); request.setRelocators(Arrays.asList( new SimpleRelocator("app.versioned", "hidden.app.versioned", null, null), @@ -1276,7 +1277,7 @@ public class DefaultShaderTest { ShadeRequest request = new ShadeRequest(); request.setJars(new LinkedHashSet<>(Collections.singleton(primary))); request.setPrimaryArtifact(primary); - request.setModuleInfoMode(ModuleInfoMode.merge); + request.setModuleInfoMode(ModuleInfoMode.MERGE); request.setFilters(Collections.singletonList(filter)); request.setRelocators(Collections.emptyList()); request.setResourceTransformers(Collections.emptyList()); @@ -1315,7 +1316,7 @@ public class DefaultShaderTest { ShadeRequest request = new ShadeRequest(); request.setJars(new LinkedHashSet<>(Collections.singleton(primary))); request.setPrimaryArtifact(primary); - request.setModuleInfoMode(ModuleInfoMode.merge); + request.setModuleInfoMode(ModuleInfoMode.MERGE); request.setFilters(Collections.emptyList()); request.setRelocators(Collections.emptyList()); request.setResourceTransformers(Collections.emptyList()); @@ -1413,7 +1414,7 @@ public class DefaultShaderTest { ShadeRequest request = new ShadeRequest(); request.setJars(new LinkedHashSet<>(Arrays.asList(primary, dependency))); request.setPrimaryArtifact(primary); - request.setModuleInfoMode(ModuleInfoMode.merge); + request.setModuleInfoMode(ModuleInfoMode.MERGE); request.setDependencyAnalysisArtifacts(dependencyAnalysisArtifacts); request.setFilters(Collections.emptyList()); request.setRelocators(Collections.emptyList()); @@ -1881,6 +1882,7 @@ public class DefaultShaderTest { when(logger.isWarnEnabled()).thenReturn(true); doNothing().when(logger).debug(debugMessages.capture()); doNothing().when(logger).warn(warnMessages.capture()); + doNothing().when(logger).warn(warnMessages.capture(), any(Object.class)); return logger; } diff --git a/src/test/java/org/apache/maven/plugins/shade/ModuleInfoConfigurationTest.java b/src/test/java/org/apache/maven/plugins/shade/ModuleInfoConfigurationTest.java index cbe065bb..02f79a49 100644 --- a/src/test/java/org/apache/maven/plugins/shade/ModuleInfoConfigurationTest.java +++ b/src/test/java/org/apache/maven/plugins/shade/ModuleInfoConfigurationTest.java @@ -92,7 +92,7 @@ public class ModuleInfoConfigurationTest { File shadedFile = newFile("shaded.jar"); ShadeRequest request = moduleRequest(primary, shadedFile, dependency, automatic); ModuleInfoConfiguration configuration = new ModuleInfoConfiguration(); - configuration.setPublicBoundary(ModuleInfoPublicBoundary.merge); + configuration.setPublicBoundary("merge"); request.setModuleInfoConfiguration(configuration); request.setRelocators(Collections.singletonList(new SimpleRelocator("dep", "hidden.dep", null, null))); @@ -248,7 +248,7 @@ public class ModuleInfoConfigurationTest { ModuleInfoConfiguration.PackageDirective additionalOpen = new ModuleInfoConfiguration.PackageDirective(); additionalOpen.setPackageName("app.api"); ModuleInfoConfiguration configuration = new ModuleInfoConfiguration(); - configuration.setPublicBoundary(ModuleInfoPublicBoundary.merge); + configuration.setPublicBoundary("merge"); configuration.setAdditionalOpens(Collections.singletonList(additionalOpen)); File shadedFile = newFile("shaded.jar"); @@ -274,7 +274,7 @@ public class ModuleInfoConfigurationTest { } ModuleInfoConfiguration configuration = new ModuleInfoConfiguration(); - configuration.setPublicBoundary(ModuleInfoPublicBoundary.merge); + configuration.setPublicBoundary("merge"); File shadedFile = newFile("shaded.jar"); ShadeRequest request = moduleRequest(primary, shadedFile, dependency); @@ -360,7 +360,7 @@ public class ModuleInfoConfigurationTest { ShadeRequest request = new ShadeRequest(); request.setJars(jars); request.setPrimaryArtifact(primary); - request.setModuleInfoMode(ModuleInfoMode.merge); + request.setModuleInfoMode(ModuleInfoMode.MERGE); request.setFilters(Collections.emptyList()); request.setRelocators(Collections.emptyList()); request.setResourceTransformers(Collections.emptyList()); diff --git a/src/test/java/org/apache/maven/plugins/shade/ModuleInfoModeTest.java b/src/test/java/org/apache/maven/plugins/shade/ModuleInfoModeTest.java new file mode 100644 index 00000000..afd16bad --- /dev/null +++ b/src/test/java/org/apache/maven/plugins/shade/ModuleInfoModeTest.java @@ -0,0 +1,47 @@ +/* + * 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 org.apache.maven.plugins.shade; + +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertThrows; + +class ModuleInfoModeTest { + @Test + void shouldParseModesWithoutRegardToCase() { + assertEquals(ModuleInfoMode.DISCARD, ModuleInfoMode.fromString("discard")); + assertEquals(ModuleInfoMode.MERGE, ModuleInfoMode.fromString("MeRgE")); + assertEquals(ModuleInfoPublicBoundary.PRIMARY, ModuleInfoPublicBoundary.fromString("primary")); + assertEquals(ModuleInfoPublicBoundary.MERGE, ModuleInfoPublicBoundary.fromString("MeRgE")); + } + + @Test + void shouldRejectUnknownModes() { + IllegalArgumentException modeException = + assertThrows(IllegalArgumentException.class, () -> ModuleInfoMode.fromString("keep")); + assertEquals("Unknown module info mode 'keep'. Expected one of: discard, merge.", modeException.getMessage()); + + IllegalArgumentException boundaryException = + assertThrows(IllegalArgumentException.class, () -> ModuleInfoPublicBoundary.fromString("all")); + assertEquals( + "Unknown module info public boundary 'all'. Expected one of: primary, merge.", + boundaryException.getMessage()); + } +} diff --git a/src/test/java/org/apache/maven/plugins/shade/mojo/ShadeMojoTest.java b/src/test/java/org/apache/maven/plugins/shade/mojo/ShadeMojoTest.java index 2c298c5e..b7110a65 100644 --- a/src/test/java/org/apache/maven/plugins/shade/mojo/ShadeMojoTest.java +++ b/src/test/java/org/apache/maven/plugins/shade/mojo/ShadeMojoTest.java @@ -115,7 +115,7 @@ public class ShadeMojoTest extends AbstractMojoTestCase { public void testSourceRequestsDiscardModuleInfo() throws Exception { ShadeMojo mojo = new ShadeMojo(); - setVariableValueToObject(mojo, "moduleInfoMode", ModuleInfoMode.merge); + setVariableValueToObject(mojo, "moduleInfoMode", "mErGe"); Method method = ShadeMojo.class.getDeclaredMethod( "createShadeSourcesRequest", String.class, Set.class, File.class, List.class, List.class, List.class); method.setAccessible(true); @@ -129,7 +129,7 @@ public class ShadeMojoTest extends AbstractMojoTestCase { Collections.emptyList(), Collections.emptyList()); - assertEquals(ModuleInfoMode.discard, request.getModuleInfoMode()); + assertEquals(ModuleInfoMode.DISCARD, request.getModuleInfoMode()); assertTrue(request.getDependencyAnalysisArtifacts().isEmpty()); }
