[MSHADE-434] Restore project.getFile() after dependency-reduced POM creation

[elharo]

Problem

Calling project.setFile(dependencyReducedPomLocation) in ShadeMojo changes the project file reference for all subsequent plugins in the build. This causes plugins like apache-rat-plugin and maven-checkstyle-plugin to resolve relative paths against the wrong directory, breaking their behavior.

Specifically, when dependencyReducedPomLocation is set to a directory other than ${basedir} (e.g., target/), project.getFile() returns the DRP path, and plugins relying on getFile().getParentFile() for basedir resolution will resolve paths incorrectly.

This was introduced/changed by MSHADE-321 (commit 6ea8543) which moved the createDependencyReducedPom() call outside of the inner artifact-processing block.

Fix

Save project.getFile() before calling createDependencyReducedPom() and restore it afterward in ShadeMojo.execute(). This ensures project.getFile() continues to point to the original pom.xml after the shade plugin finishes, preventing side effects on subsequent plugins.

Integration Test

MSHADE-434_ratSideEffect: Configures shade with dependencyReducedPomLocation in target/, then verifies via maven-help-plugin:evaluate that ${project.file} still points to the original pom.xml after shading.

• Without fix: test fails (project.file is dependency-reduced-pom.xml)
• With fix: test passes (project.file is pom.xml)

All 72 unit tests pass.

Fixes #453

[Copilot]

Pull request overview

Note

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Restores MavenProject#getFile() after creating the dependency-reduced POM to prevent side effects on subsequent plugins, and adds an integration test to pin the behavior.

Changes:

• Save the original project.getFile() before DRP generation and restore it afterward in ShadeMojo.
• Add an IT project that configures dependencyReducedPomLocation under target/.
• Add Groovy verification to assert DRP + shaded JAR creation and that ${project.file} remains pom.xml.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java	Saves/restores project.file around DRP generation to avoid leaking state to later plugins.
src/it/projects/MSHADE-434_ratSideEffect/verify.groovy	Verifies DRP + shaded JAR outputs and checks build log for ${project.file} value.
src/it/projects/MSHADE-434_ratSideEffect/pom.xml	Integration-test Maven project reproducing the side-effect scenario and evaluating project.file.

Comments suppressed due to low confidence (1)

src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java:1

• project.setFile(originalProjectFile) won’t run if createDependencyReducedPom(artifactIds) (or subsequent logic) throws, so the broken project.file can still leak to later plugins on failure paths. Wrap DRP creation in a try { ... } finally { project.setFile(originalProjectFile); } (and keep the useDependencyReducedPomInJar logic inside the try).

/*

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[slachiewicz]

The red cell is this PR's own IT, not the change under test. windows-latest jdk-8-zulu is the only failing cell; the other 17 are green, and the invoker summary is Passed: 83, Failed: 1 with MSHADE-434_ratSideEffect\pom.xml as the one failure.

verify.groovy looks for the help:evaluate output like this:

def projectFileLine = lines.find { it =~ /^\// && it.endsWith("/pom.xml") }
assert projectFileLine != null

Both predicates assume a Unix path. On Windows the value is D:\a\maven-shade-plugin\...\pom.xml, which neither starts with / nor ends with /pom.xml, so find returns null and the assert fires before anything about project.file is actually checked:

'/home/runner/work/p/pom.xml'  -> found = true
'D:\a\...\pom.xml'             -> found = false

Matching on the file name instead of the separator fixes it — it.trim().endsWith("pom.xml") && !it.trim().endsWith("dependency-reduced-pom.xml") — or compare against new File(basedir, "pom.xml").canonicalPath, which is separator-correct by construction.

#828 carries the identical matcher and fails on the same single cell, so one fix covers both.

On the overlap

#128, this PR, and #828 all address the same thing: dependencyReducedPomLocation leaving project.getFile() pointing at the reduced POM. #128 changes setFile to setPomFile so basedir is never reassigned; these two save the original and restore it afterwards. Both work, but they are alternatives rather than complements, and #128 has been approved and open since 2022. Worth a maintainer deciding which one lands before either is merged.

This comment was created with AI assistance.