[MSHADE-284] Shaded test JARs are always empty

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.1.0
• Fix Version/s: 3.2.2
• Flags: Patch
• Assignee: Mark Struberg
• Reporter: Peter De Maeyer
• Created: 02/Apr/18 20:18
• Updated: 23/Dec/20 09:00
• Resolved: 17/Dec/19 19:38

Description

Shading test JARs using the shadeTestJar configuration option yields an empty test JAR. This has been noticed by others, see for example Steve K's answer on StackOverflow, but people have reverted to other hacks and workarounds to overcome this (e.g. use a different plugin).

Scenario:

1. Create modules api, impl and a module uber which has as sole purpose to make an uber JAR for the combination of the first two modules. uber itself has no sources.
2. Both modules have both jar and test-jar artifacts.
3. Configure the maven-shade-plugin in the uber module with the configuration option shadeTestJar set to true.

Expected:

1. Content of uber.jar is the aggregate content of api.jar and impl.jar.
2. Content of uber-tests.jar is the aggregate content of api-tests.jar and impl-tests.jar.

Actual:

1. Content of uber.jar is as expected.
2. uber-tests.jar is empty.

Root cause:

• The implementation of the shadeTestJar feature in ShaderMojo is buggy and incomplete.
• The call to processArtifactSelectors on line 425 doesn't pass the testArtifacts, so they are never correctly filled in.
• The implementation of processArtifactSelectors doesn't deal with test JARs at all and has to be extended to support them.
• The "if" statement on line 452 incorrectly treats a test JAR as sources.

This whole feature looks like it was done in a hurry as a sloppy copy-paste job, and in 5 years nobody took the time to report or fix it. Amazing. Anyway, you can find my proposed fix in attachment: shadeTestJar.patch. I have tested it manually on my project and it works.

Issue Links

• is caused by: MSHADE-158 Allow shading of test jar
• is depended upon by: MSHADE-285 It should be possible to shade test sources as a JAR
• is related to: MSHADE-286 Shading fails when a dependency's main artifact does not exist
• is related to: MSHADE-340 Shaded test jar artifact is not attached
• is related to: MSHADE-339 Shaded test jar has wrong type "jar"
• links to: GitHub Pull Request #30