fix: gradle mockitoAgent configuration should not be transitive (#3454)

bric3 · web-flow · commit 39a0c75b2311 · 2024-09-30T10:17:01.000+02:00
See #3037 Follow up to #3437
diff --git a/src/main/java/org/mockito/Mockito.java b/src/main/java/org/mockito/Mockito.java
@@ -176,14 +176,15 @@
  * to function without an explicit setup to enable instrumentation, and the JVM will always display a warning.
  *
  * <p>
- * To explicitly attach Mockito during test execution, the library's jar file needs to be specified as `-javaagent`
+ * To explicitly attach Mockito during test execution, the library's jar file needs to be specified as <code>-javaagent</code>
  * as an argument to the executing JVM. To enable this in Gradle, the following example adds Mockito to all test
  * tasks:
  *
  * <pre class="code"><code class="kotlin">
  * val mockitoAgent = configurations.create("mockitoAgent")
  * dependencies {
- *     mockitoAgent(libs.mockito)
+ *     testImplementation(libs.mockito)
+ *     mockitoAgent(libs.mockito) { isTransitive = false }
  * }
  * tasks {
  *     test {
@@ -192,6 +193,16 @@
  * }
  * </code></pre>
  *
+ * Supposing <code>Mockito</code> is declared in the version catalog as the following
+ *
+ * <pre class="code"><code class="toml">
+ * [versions]
+ * mockito = "5.14.0"
+ *
+ * [libraries]
+ * mockito = { module = "org.mockito:mockito-core", version.ref = "mockito" }
+ * </code></pre>
+ *
  * To add Mockito as an agent to Maven's surefire plugin, the following configuration is needed:
  *
  * <pre class="code"><code class="xml">
