`AddMockitoJavaAgentToMavenSurefirePlugin` adds the agent when a parent already loads it from an explicit jar path

未關閉
  • 哪裡不對？
#1,383 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
3/5
預估耗時
1-2 天
新手友好度
72/100
Issue 類型
缺陷
描述清晰度
描述清楚
活躍度
活躍
技術堆疊
java
領域
build-system

研究方向

Start with AddMockitoJavaAgentToMavenSurefirePlugin.java, especially the surefireArgLineWithAgent check, and trace how it handles inherited Surefire configuration and the dependency-plugin execution requirement. Add a regression test based on the parent-and-child reproduction in the issue. Done means an inherited explicit Mockito agent path prevents redundant recipe changes and preserves the parent's Surefire arguments.

由索引模型根據 Issue 內容生成。

描述

bug

What version of OpenRewrite are you using?

  • rewrite-migrate-java 3.49.0
  • rewrite-maven-plugin 6.53.0

How are you running OpenRewrite?

Through the Maven plugin, with org.openrewrite.java.migrate.UpgradeToJava25 in a multi-module project. All modules inherit from a corporate parent POM.

What is the smallest, simplest way to reproduce the problem?

The parent POM sets up the Mockito agent once for every project that inherits it. It refers to the jar by its path in the local repository, not by ${org.mockito:mockito-core:jar}:

<properties>
    <argLine/>
</properties>

<build>
    <plugins>
        <plugin>
            <artifactId>maven-surefire-plugin</artifactId>
            <configuration>
                <argLine>
                    @{argLine}
                    -javaagent:${settings.localRepository}/org/mockito/mockito-core/${mockito.version}/mockito-core-${mockito.version}.jar
                </argLine>
            </configuration>
        </plugin>
    </plugins>
</build>

A child module uses the parent and has org.mockito:mockito-core as a test dependency, with no surefire configuration of its own.

@Test
void agentInheritedFromParentAsExplicitJarPath() {
    rewriteRun(
      mavenProject("parent",
        pomXml(/* the parent above, with mockito.version set */),
        mavenProject("child",
          pomXml(/* child with mockito-core test dependency, no surefire config */)
        )
      )
    );
}

What did you expect to see?

No changes. Every module already runs its tests with the Mockito agent, inherited from the parent's build/plugins.

What did you see instead?

The recipe changes every module that uses mockito-core:

  • it adds a maven-surefire-plugin with <argLine>-javaagent:${org.mockito:mockito-core:jar}</argLine> (or @{argLine} -javaagent:...);
  • it adds a maven-dependency-plugin properties execution (get-mockito-agent-path).

The module's own <argLine> replaces the inherited one, so each module loses the rest of the parent's surefire arguments (here --add-opens and the @{argLine}/JaCoCo chaining).

Why it happens

The parent check added in #1166 (for #1164) only treats the agent as configured when the inherited argLine contains the exact text the recipe would add (AddMockitoJavaAgentToMavenSurefirePlugin.java, surefireArgLineWithAgent):

.filter(argLine -> argLine != null && argLine.contains(agentArgument))

agentArgument is -javaagent:${org.mockito:mockito-core:jar} (or the byte-buddy-agent form). It also requires an inherited maven-dependency-plugin properties execution. That execution is only needed for the ${group:artifact:jar} form.

Why a parent would use the explicit path

${org.mockito:mockito-core:jar} is only set by maven-dependency-plugin:properties in modules that depend on mockito-core. In a corporate parent that applies one surefire configuration to every project, a module without mockito-core gets an unresolved -javaagent:${org.mockito:mockito-core:jar}, and its test JVM fails to start. Referring to the jar by its path, with the version Spring Boot's BOM manages, avoids that.

Suggested fix

Treat the agent as already configured when any inherited or local surefire argLine has a -javaagent: argument that points at a Mockito or Byte Buddy agent jar, in whatever form. For example, match -javaagent:\S*(mockito-core|byte-buddy-agent)\S*, not only the exact ${...:jar} text. When that agent is not the ${...:jar} form, don't require the maven-dependency-plugin properties execution either.

Are you interested in contributing a fix to OpenRewrite?

Yes, I'm happy to open a PR with the test above and the change to surefireArgLineWithAgent.

主要語言
Java
星號
162
分支
139
平均合併
10 小時 28 分鐘
30 天內合併 PR
121

環境準備

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue，再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫，在一個分支上完成修改。
  4. 送出 Pull Request，並在描述裡引用這個 Issue 編號。

openrewrite/rewrite-migrate-java 的其他 Issue

查看 openrewrite/rewrite-migrate-java 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。