Skip to content

Skip AddMockitoJavaAgentToMavenSurefirePlugin when agent already configured in build/plugins #1166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timtebeek merged 3 commits into from
Jul 6, 2026
Merged

Skip AddMockitoJavaAgentToMavenSurefirePlugin when agent already configured in build/plugins #1166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bf5495d
Skip AddMockitoJavaAgentToMavenSurefirePlugin when agent already conf…
timtebeek Jul 6, 2026
9f7a065
Minimize comments
timtebeek Jul 6, 2026
0a97c2f
Simplify plugin matching; tolerate implied plugin groupId
timtebeek Jul 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 42 additions & 8 deletions src/main/java/org/openrewrite/java/migrate/AddMockitoJavaAgentToMavenSurefirePlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import lombok.Getter;
import lombok.RequiredArgsConstructor;
import org.intellij.lang.annotations.Language;
import org.jspecify.annotations.Nullable;
import org.openrewrite.ExecutionContext;
import org.openrewrite.Preconditions;
import org.openrewrite.Recipe;
Expand Down Expand Up @@ -49,6 +50,7 @@ public class AddMockitoJavaAgentToMavenSurefirePlugin extends Recipe {

private static final String MAVEN_PLUGINS_GROUP_ID = "org.apache.maven.plugins";
private static final String MAVEN_SUREFIRE_PLUGIN_ARTIFACT_ID = "maven-surefire-plugin";
private static final String MAVEN_DEPENDENCY_PLUGIN_ARTIFACT_ID = "maven-dependency-plugin";

@Language("xpath")
private static final String MAVEN_DEPENDENCY_PLUGIN_EXECUTION_MATCHER = "/project/build/plugins/plugin[artifactId='maven-dependency-plugin']/executions/execution";
Expand Down Expand Up @@ -85,28 +87,46 @@ private Xml.Tag buildConfigurationTag(String argLineJavaAgentParam, boolean hasE

private void maybeAddMavenDependencyPluginWithPropertiesGoal() {
Optional<Plugin> mavenDependencyPlugin = getResolutionResult().getPom().getPlugins().stream()
.filter(plugin -> "org.apache.maven.plugins".equals(plugin.getGroupId()) &&
"maven-dependency-plugin".equals(plugin.getArtifactId())).findFirst();
.filter(plugin -> isMavenPlugin(plugin, MAVEN_DEPENDENCY_PLUGIN_ARTIFACT_ID)).findFirst();

if (!mavenDependencyPlugin.isPresent()) {
doAfterVisit(new AddPlugin("org.apache.maven.plugins", "maven-dependency-plugin", null, null, null,
doAfterVisit(new AddPlugin(MAVEN_PLUGINS_GROUP_ID, MAVEN_DEPENDENCY_PLUGIN_ARTIFACT_ID, null, null, null,
"<executions>" + MAVEN_DEPENDENCY_PLUGIN_EXECUTION_TAG + "</executions>", "**/pom.xml").getVisitor());
} else if (mavenDependencyPlugin.get().getExecutions().isEmpty()) {
doAfterVisit(new ChangePluginExecutions("org.apache.maven.plugins", "maven-dependency-plugin", MAVEN_DEPENDENCY_PLUGIN_EXECUTION_TAG).getVisitor());
doAfterVisit(new ChangePluginExecutions(MAVEN_PLUGINS_GROUP_ID, MAVEN_DEPENDENCY_PLUGIN_ARTIFACT_ID, MAVEN_DEPENDENCY_PLUGIN_EXECUTION_TAG).getVisitor());
} else if (mavenDependencyPlugin.get().getExecutions().stream().noneMatch(execution -> execution.getGoals() != null)) {
doAfterVisit(new AddOrUpdateChildTag(MAVEN_DEPENDENCY_PLUGIN_EXECUTION_MATCHER, "<goals>" + MAVEN_DEPENDENCY_PLUGIN_PROPERTIES_GOAL + "</goals>", false).getVisitor());
} else if (mavenDependencyPlugin.get().getExecutions().stream().noneMatch(execution -> execution.getGoals() != null && execution.getGoals().contains("properties"))) {
} else if (!hasPropertiesGoal(mavenDependencyPlugin.get())) {
doAfterVisit(new AppendChildTagToParentVisitor(
new XPathMatcher(MAVEN_DEPENDENCY_PLUGIN_EXECUTION_MATCHER + "/goals"),
Xml.Tag.build(MAVEN_DEPENDENCY_PLUGIN_PROPERTIES_GOAL)));
}
}

private @Nullable String surefireArgLineWithAgent(List<Plugin> plugins) {
String agentArgument = getArgLineJavaAgentArgument();
return plugins.stream()
.filter(plugin -> isMavenPlugin(plugin, MAVEN_SUREFIRE_PLUGIN_ARTIFACT_ID))
.map(plugin -> plugin.getConfigurationStringValue("argLine"))
.filter(argLine -> argLine != null && argLine.contains(agentArgument))
.findFirst().orElse(null);
}

private boolean mavenDependencyPluginHasPropertiesGoal() {
return getResolutionResult().getPom().getPlugins().stream()
.anyMatch(plugin -> isMavenPlugin(plugin, MAVEN_DEPENDENCY_PLUGIN_ARTIFACT_ID) && hasPropertiesGoal(plugin));
}

@Override
public Xml.Document visitDocument(Xml.Document document, ExecutionContext ctx) {
if (getResolutionResult().getPom().getPluginManagement().stream().anyMatch(
plugin -> "org.apache.maven.plugins".equals(plugin.getGroupId()) && "maven-surefire-plugin"
.equals(plugin.getArtifactId()) && plugin.getConfigurationStringValue("argLine") != null && plugin.getConfigurationStringValue("argLine").contains(getArgLineJavaAgentArgument()))) {
if (surefireArgLineWithAgent(getResolutionResult().getPom().getPluginManagement()) != null) {
return document;
}
// Nothing to add when the surefire agent, the properties goal, and any `@{argLine}` property
// are already present, whether declared here or inherited from a parent's `build/plugins` (#1164).
String pluginArgLine = surefireArgLineWithAgent(getResolutionResult().getPom().getPlugins());
if (pluginArgLine != null && mavenDependencyPluginHasPropertiesGoal() &&
(!pluginArgLine.contains("@{argLine}") || getResolutionResult().getPom().getProperties().containsKey("argLine"))) {
return document;
}

Expand Down Expand Up @@ -168,6 +188,20 @@ public Xml.Tag visitTag(Xml.Tag tag, ExecutionContext ctx) {
});
}

/**
* Matches a plugin under the {@code org.apache.maven.plugins} group, tolerating an implied (omitted) groupId,
* which Maven defaults to that group for {@code maven-*-plugin} declarations.
*/
private static boolean isMavenPlugin(Plugin plugin, String artifactId) {
return artifactId.equals(plugin.getArtifactId()) &&
(plugin.getGroupId() == null || MAVEN_PLUGINS_GROUP_ID.equals(plugin.getGroupId()));
}

private static boolean hasPropertiesGoal(Plugin plugin) {
return plugin.getExecutions().stream()
.anyMatch(execution -> execution.getGoals() != null && execution.getGoals().contains("properties"));
}

@RequiredArgsConstructor
private static class AppendChildTagToParentVisitor extends XmlIsoVisitor<ExecutionContext> {
private final XPathMatcher parentXPathMatcher;
Expand Down
134 changes: 134 additions & 0 deletions src/test/java/org/openrewrite/java/migrate/AddMockitoJavaAgentToMavenSurefirePluginTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1372,6 +1372,140 @@ void updatesIndividualPomsWhenParentPomManagesSurefirePluginWithoutAgentConfigur
);
}

@Test
void makesNoChangesWhenParentPomDeclaresSurefirePluginWithAgentConfiguration() {
rewriteRun(
mavenProject("test-project",
pomXml(
"""
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>org.sample</groupId>
<artifactId>test</artifactId>
<version>1.0</version>
<packaging>pom</packaging>

<modules>
<module>test-module1</module>
</modules>

<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.5.4</version>
<relativePath/>
</parent>

<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>properties</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<!--suppress MavenModelInspection -->
<argLine>-Xmx204m -javaagent:${org.mockito:mockito-core:jar}</argLine>
</configuration>
</plugin>
</plugins>
</build>
</project>
""",
spec -> spec.path("pom.xml")
),
pomXml(
"""
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>org.sample</groupId>
<artifactId>test-module1</artifactId>
<version>1.0</version>

<parent>
<groupId>org.sample</groupId>
<artifactId>test</artifactId>
<version>1.0</version>
<relativePath>../pom.xml</relativePath>
</parent>
</project>
""",
spec -> spec.path("test-module1/pom.xml")
)
)
);
}

@Test
void makesNoChangesWhenAgentConfiguredOnPluginsWithImpliedGroupId() {
rewriteRun(
mavenProject("test-project",
pomXml(
"""
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>org.sample</groupId>
<artifactId>test</artifactId>
<version>1.0</version>

<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.5.4</version>
<relativePath/>
</parent>

<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<artifactId>maven-dependency-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>properties</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<!--suppress MavenModelInspection -->
<argLine>-Xmx204m -javaagent:${org.mockito:mockito-core:jar}</argLine>
</configuration>
</plugin>
</plugins>
</build>
</project>
"""
)
)
);
}

@Test
void augmentsSurefirePluginDeclaredInPluginManagement() {
rewriteRun(
Expand Down
Loading