Skip to content
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.

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

fix(deps): update mockito monorepo to v5 (major) - autoclosed #552

Closed
wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jan 15, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
org.mockito:mockito-junit-jupiter 4.11.0 -> 5.10.0 age adoption passing confidence
org.mockito:mockito-inline 4.11.0 -> 5.2.0 age adoption passing confidence

Release Notes

mockito/mockito (org.mockito:mockito-junit-jupiter)

v5.10.0

Changelog generated by Shipkit Changelog Gradle Plugin

5.10.0
  • 2024-01-24 - 8 commit(s) by Andre Brait, dependabot[bot]
  • Bump org.shipkit:shipkit-auto-version from 1.2.2 to 2.0.2 (#​3248)
  • Bump org.assertj:assertj-core from 3.25.1 to 3.25.2 (#​3247)
  • Bump org.shipkit:shipkit-changelog from 1.2.0 to 2.0.1 (#​3245)
  • Bump com.diffplug.spotless from 6.24.0 to 6.25.0 (#​3244)
  • Better typing for PluginLoader#loadPlugin(..) (#​3242)
  • Bump com.github.ben-manes.versions from 0.50.0 to 0.51.0 (#​3241)
  • Bump com.diffplug.spotless from 6.23.3 to 6.24.0 (#​3236)
  • Fixes #​3219: Add support for static mocks on DoNotMockEnforcer (#​3220)
  • Mockito#mockStatic(Class<?>) skips DoNotMockEnforcer (#​3219)

v5.9.0

Changelog generated by Shipkit Changelog Gradle Plugin

5.9.0
  • 2024-01-14 - 18 commit(s) by Björn Michael, Stefano Cordio, dependabot[bot]
  • Bump org.gradle.toolchains.foojay-resolver-convention from 0.7.0 to 0.8.0 (#​3234)
  • Align Javadoc configuration to Java 21 standards (#​3230)
  • Bump com.google.googlejavaformat:google-java-format from 1.19.1 to 1.19.2 (#​3228)
  • Run release job on Java 21 (#​3226)
  • Update Gradle to 8.5 (#​3225)
  • Bump org.assertj:assertj-core from 3.25.0 to 3.25.1 (#​3223)
  • Bump org.assertj:assertj-core from 3.24.2 to 3.25.0 (#​3218)
  • @​since at ArgumentCaptor.captor() (#​3214)
  • Bump org.codehaus.groovy:groovy from 3.0.19 to 3.0.20 (#​3213)
  • Bump org.jetbrains.kotlin:kotlin-stdlib from 1.9.21 to 1.9.22 (#​3211)
  • Bump org.jetbrains.kotlin:kotlin-gradle-plugin from 1.9.21 to 1.9.22 (#​3210)
  • Bump versions.bytebuddy from 1.14.10 to 1.14.11 (#​3208)
  • Bump com.google.googlejavaformat:google-java-format from 1.18.1 to 1.19.1 (#​3206)
  • Bump actions/upload-artifact from 3 to 4 (#​3201)
  • Bump com.gradle.enterprise from 3.16 to 3.16.1 (#​3200)
  • Bump org.eclipse.platform:org.eclipse.osgi from 3.18.500 to 3.18.600 (#​3193)
  • Bump com.gradle.enterprise from 3.15.1 to 3.16 (#​3192)
  • Bump com.diffplug.spotless from 6.23.2 to 6.23.3 (#​3191)

v5.8.0

Changelog generated by Shipkit Changelog Gradle Plugin

5.8.0
  • 2023-12-01 - 15 commit(s) by Andreas Turban, Mikaël Francoeur, dependabot[bot], jfrantzius
  • #​3000: fix ArrayIndexOutOfBoundsException (#​3190)
  • Bump com.diffplug.spotless from 6.23.1 to 6.23.2 (#​3188)
  • Bump com.diffplug.spotless from 6.23.0 to 6.23.1 (#​3186)
  • Bump actions/setup-java from 3 to 4 (#​3185)
  • Apply spotless to all java projects (#​3184)
  • Bump com.diffplug.spotless from 6.22.0 to 6.23.0 (#​3182)
  • Fixes #​3179 : Add module for Java 21 tests. (#​3180)
  • Need separate module for java 21 tests (#​3179)
  • Bump org.jetbrains.kotlin:kotlin-gradle-plugin from 1.9.20 to 1.9.21 (#​3176)
  • Bump org.jetbrains.kotlin:kotlin-stdlib from 1.9.20 to 1.9.21 (#​3175)
  • Bump versions.bytebuddy from 1.14.9 to 1.14.10 (#​3174)
  • Fixes #​3160 : Fix interference between spies when spying on records. (#​3173)
  • Bump com.github.ben-manes.versions from 0.49.0 to 0.50.0 (#​3172)
  • Bump versions.junitJupiter from 5.10.0 to 5.10.1 (#​3169)
  • Bump org.junit.platform:junit-platform-launcher from 1.10.0 to 1.10.1 (#​3168)
  • Deep Stubs Incompatible With Mocking Enum (#​3167)
  • Annotation-based spying on a generic class breaks existing final/inline Spies (#​3160)
  • ArrayIndexOutOfBoundsException with Version 5.3.1 (#​3000)
  • Deep Stubs Incompatible With Mocking Enum (#​2984)

v5.7.0

Changelog generated by Shipkit Changelog Gradle Plugin

5.7.0
  • 2023-11-02 - 15 commit(s) by Stefan M, Tim van der Lippe, Valery Yatsynovich, Vladimir Glinskikh, ascopes, dependabot[bot]
  • Bump org.jetbrains.kotlin:kotlin-gradle-plugin from 1.9.10 to 1.9.20 (#​3166)
  • Bump org.jetbrains.kotlin:kotlin-stdlib from 1.9.10 to 1.9.20 (#​3165)
  • Attempt to detect system property mangling prior to loading ByteBuddy. (#​3164)
  • Handle Termux in InlineDelegateByteBuddyMockMaker.java (#​3158)
  • Bump versions.errorprone from 2.22.0 to 2.23.0 (#​3153)
  • Fix license url according to spdx license spec (#​3152)
  • Remove checks for unsupported Java version from unit tests (#​3150)
  • Add CodeCov token to upload coverage report (#​3149)
  • Migrate to JaCoCo 0.8.11 (#​3147)
  • Add Java 21 to CI build matrix (#​3145)
  • Feat: add generic-inferred methods for constructing ArgumentCaptors (#​3144)
  • Bump gradle from 8.2 to 8.4 (#​3142)
  • Bump com.github.ben-manes.versions from 0.48.0 to 0.49.0 (#​3139)
  • Bump versions.bytebuddy from 1.14.8 to 1.14.9 (#​3138)
  • Bump biz.aQute.bnd.builder from 6.4.0 to 7.0.0 (#​3135)

v5.6.0

Changelog generated by Shipkit Changelog Gradle Plugin

5.6.0
  • 2023-10-06 - 22 commit(s) by Andreas Turban, Stefan M, StevenCurran, Yevhen Lazhyntsev, dependabot[bot]
  • Use spdx identifier for license name (#​3134)
  • Fixes #​1382 Jupiter Captor annotation support (#​3133)
  • Bump com.gradle.enterprise from 3.15 to 3.15.1 (#​3132)
  • Bump com.google.googlejavaformat:google-java-format from 1.18.0 to 1.18.1 (#​3131)
  • Make MockUtil.getMockMaker() public Mockito API (#​3129)
  • Make MockUtil.getMockMaker() public or public Mockito API (#​3128)
  • Bump com.google.googlejavaformat:google-java-format from 1.17.0 to 1.18.0 (#​3126)
  • Bump com.diffplug.spotless from 6.21.0 to 6.22.0 (#​3125)
  • Bump versions.errorprone from 2.21.1 to 2.22.0 (#​3122)
  • Bump versions.bytebuddy from 1.14.7 to 1.14.8 (#​3117)
  • Bump com.gradle.enterprise from 3.14.1 to 3.15 (#​3115)
  • Bump org.eclipse.platform:org.eclipse.osgi from 3.18.400 to 3.18.500 (#​3113)
  • Bump com.github.ben-manes.versions from 0.47.0 to 0.48.0 (#​3110)
  • Bump actions/checkout from 3 to 4 (#​3108)
  • Bump com.diffplug.spotless from 6.20.0 to 6.21.0 (#​3106)
  • Bump versions.bytebuddy from 1.14.6 to 1.14.7 (#​3105)
  • Update Javadoc for ArgumentCaptor (#​3103)
  • Bump org.jetbrains.kotlin:kotlin-gradle-plugin from 1.9.0 to 1.9.10 (#​3102)
  • Bump org.jetbrains.kotlin:kotlin-stdlib from 1.9.0 to 1.9.10 (#​3101)
  • Bump org.codehaus.groovy:groovy from 3.0.18 to 3.0.19 (#​3100)
  • Resolve more Gradle Tasks lazily (#​3099)
  • Added JavaFlightRecorder options for Tests (#​3098)
  • Default mock of Optional.isEmpty() returns true for RETURN_DEEP_STUBS (#​3097)
  • Default mock of Optional is not empty when using RETURN_DEEP_STUBS (#​2865)
  • Support @​Captor injection in JUnit 5 method parameters (#​1382)

v5.5.0

Compare Source

Changelog generated by Shipkit Changelog Gradle Plugin

5.5.0
  • 2023-08-22 - 25 commit(s) by Andreas Turban, Chris Egerton, Róbert Papp, Thach Le, dependabot[bot]
  • Bump org.gradle.toolchains.foojay-resolver-convention from 0.6.0 to 0.7.0 (#​3096)
  • Excessive locking in TypeCachingBytecodeGenerator#BOOTSTRAP_LOCK (#​3095)
  • Bump versions.bytebuddy from 1.14.5 to 1.14.6 (#​3094)
  • Fixes 3087 : Add note on backporting to README (#​3090)
  • Backporting policy (#​3087)
  • Bump versions.errorprone from 2.21.0 to 2.21.1 (#​3083)
  • Fixes #​3077 : Report unused stubbing exceptions when test filter is no-op (#​3078)
  • Unused stubbings are not reported when filters are used (#​3077)
  • Bump versions.errorprone from 2.20.0 to 2.21.0 (#​3076)
  • Bump com.gradle.enterprise from 3.14 to 3.14.1 (#​3074)
  • Bump org.opentest4j:opentest4j from 1.2.0 to 1.3.0 (#​3072)
  • Bump versions.junitJupiter from 5.9.3 to 5.10.0 (#​3071)
  • Bump org.junit.platform:junit-platform-launcher from 1.9.3 to 1.10.0 (#​3070)
  • Bump gradle/wrapper-validation-action from 1.0.6 to 1.1.0 (#​3069)
  • Gradle 8.3 compatibility: buildDir -> layout.buildDirectory (#​3068)
  • Bump com.gradle.enterprise from 3.13.4 to 3.14 (#​3067)
  • Bump com.diffplug.spotless from 6.19.0 to 6.20.0 (#​3066)
  • Toolchain for Test task (#​3064)
  • Gradle build script improvements (#​3062)
  • Fixes #​3046 (#​3060)
  • Fix Gradle 8.2 deprecation of Conventions in nexus plugin. (#​3056)
  • Bump kotlinVersion from 1.8.22 to 1.9.0 (#​3055)
  • Bump ru.vyarus.animalsniffer from 1.7.0 to 1.7.1 (#​3054)
  • Gradle 8.2: work around fix for release publishing (#​3053)
  • Rewire Jacoco for Gradle 8/9 (#​3052)
  • Gradle 7.6 to 8.2 (conventions to extensions migration, mostly) (#​3051)
  • Bump org.codehaus.groovy:groovy from 3.0.17 to 3.0.18 (#​3049)
  • Mockito#reset Condescending Documentation (#​3046)
  • Excessive locking in TypeCachingBytecodeGenerator#BOOTSTRAP_LOCK (#​3035)

v5.4.0

Compare Source

Changelog generated by Shipkit Changelog Gradle Plugin

5.4.0
  • 2023-06-18 - 22 commit(s) by Alexander von Trostorff, Andriy Redko, Benoit Maggi, Chris Povirk, DerFrZocker, Nicolas Ot, Tim van der Lippe, dependabot[bot], ellaella12
  • Bump versions.errorprone from 2.19.1 to 2.20.0 (#​3041)
  • Bump org.eclipse.platform:org.eclipse.osgi from 3.18.300 to 3.18.400 (#​3038)
  • Bump com.google.auto.service:auto-service from 1.1.0 to 1.1.1 (#​3036)
  • Bump com.github.ben-manes.versions from 0.46.0 to 0.47.0 (#​3034)
  • Bump kotlinVersion from 1.8.21 to 1.8.22 (#​3033)
  • Documentation about MockMakers slightly outdated in some places. Fixes #​3031 (#​3032)
  • Documentation about MockMakers slightly outdated in some places (#​3031)
  • Bump versions.bytebuddy from 1.14.4 to 1.14.5 (#​3025)
  • Edit DoAnswerStyleStubbing.isSet() to return true if there are answers (#​3020)
  • Bump com.diffplug.spotless from 6.18.0 to 6.19.0 (#​3018)
  • Bump com.google.auto.service:auto-service from 1.0.1 to 1.1.0 (#​3017)
  • Bump versions.errorprone from 2.18.0 to 2.19.1 (#​3009)
  • Fix @Mock(serializable = true) for parameterized types. (#​3007)
  • Add varargs changes to ArgumentMatchers#any() JavaDoc
    (#​3003)
  • Mockito 5 any() does not match a vararg int[] argument anymore. I need to use any(int[].class) to get the ArgumentMatcher to work (#​2998)
  • Bump com.google.googlejavaformat:google-java-format from 1.16.0 to 1.17.0 (#​2996)
  • Remove redundant double "now" in JavaDocs for mock without class (#​2994)
  • Bump org.junit.platform:junit-platform-launcher from 1.9.2 to 1.9.3 (#​2993)
  • Bump versions.junitJupiter from 5.9.2 to 5.9.3 (#​2992)
  • Provide a variant of assertArg that works well with checked exceptions (#​2991)
  • Bump kotlinVersion from 1.8.10 to 1.8.21 (#​2990)
  • Fix #​2915 Forbid spy on mocked interface (#​2989)
  • Bump net.ltgt.gradle:gradle-errorprone-plugin from 3.0.1 to 3.1.0 (#​2987)
  • @Mock(serializable = true) no longer works with parameterized types (#​2979)
  • Bug with @​InjectMocks in 5.3.0 (#​2978)
  • �Function name is incorrect. (#​2955)
  • Verify on Spy Interface incorrect count of actual invocation (#​2915)
  • Only run injection once (#​2603)
  • mockito-core MockitoAnnotations::openMocks initializes class twice if said class has super class (#​2602)

v5.3.1

Compare Source

Changelog generated by Shipkit Changelog Gradle Plugin

5.3.1

v5.3.0

Compare Source

Changelog generated by Shipkit Changelog Gradle Plugin

5.3.0
  • 2023-04-11 - 14 commit(s) by Krzysztof Krasoń, Maciej Walkowiak, Rafael Winterhalter, Wesley Tsai, dependabot[bot], jfrantzius
  • Bump com.diffplug.spotless from 6.17.0 to 6.18.0 (#​2967)
  • Bump versions.bytebuddy from 1.14.3 to 1.14.4 (#​2966)
  • Adds withoutAnnotations parameter to @Mock (#​2965)
  • Fix ClassCastException (#​2962)
  • Bump org.codehaus.groovy:groovy from 3.0.16 to 3.0.17 (#​2959)
  • ClassCastException when combining InjectMocks with generified Mock field (#​2958)
  • Bump versions.bytebuddy from 1.14.2 to 1.14.3 (#​2950)
  • Add ArgumentMatchers#assertArg method. (#​2949)
  • Fixes 2947: correct visibility check to respect nestmates (#​2948)
  • spy does not initialize objects fully with InstrumentationMemberAccessor (#​2947)
  • Fixes #​2877: removed mockito-inline as subproject and actual subproject (#​2945)
  • #​2934 throw exception on multiple matches by type if cannot be reduce… (#​2942)
  • Bump org.eclipse.platform:org.eclipse.osgi from 3.18.200 to 3.18.300 (#​2941)
  • Bump com.diffplug.spotless from 6.16.0 to 6.17.0 (#​2940)
  • Bump org.codehaus.groovy:groovy from 3.0.15 to 3.0.16 (#​2939)
  • Bump versions.bytebuddy from 1.14.1 to 1.14.2 (#​2938)
  • Feature suggestion: TerminalMockCandidateFilter should report error when more than one candidate left (#​2934)
  • Mockito-inline dependency after upgrade 5.0.0 (#​2877)
  • Assertions on parameters during verification (#​2285)

v5.2.0

Compare Source

Changelog generated by Shipkit Changelog Gradle Plugin

5.2.0
  • 2023-03-09 - 25 commit(s) by Andriy Redko, Iulian Dragos, Roberto Trunfio, Róbert Papp, dependabot[bot], jfrantzius, tobiasbaum
  • Fixes 2933: IOUtils does not depend on platform encoding any more (#​2935)
  • Execution with mockito-inline fails on platforms with EBCDIC as default encoding (#​2933)
  • Bump io.github.gradle-nexus:publish-plugin from 1.2.0 to 1.3.0 (#​2932)
  • Bump versions.bytebuddy from 1.14.0 to 1.14.1 (#​2931)
  • Bump com.diffplug.spotless from 6.15.0 to 6.16.0 (#​2930)
  • Bump com.google.googlejavaformat:google-java-format from 1.15.0 to 1.16.0 (#​2928)
  • Bump io.github.gradle-nexus:publish-plugin from 1.1.0 to 1.2.0 (#​2924)
  • Feature 2921 generic types (#​2923)
  • Bump com.github.ben-manes.versions from 0.45.0 to 0.46.0 (#​2922)
  • Use generic type information in TypeBasedCandidateFilter to circumvent type erasure (#​2921)
  • Make project relocatable by using relative paths in the OSGi test task (#​2920)
  • Cache misses due to OSGi tests referencing absolute paths (#​2919)
  • Bump versions.bytebuddy from 1.13.0 to 1.14.0 (#​2918)
  • Bump gradle/wrapper-validation-action from 1.0.5 to 1.0.6 (#​2917)
  • Bump com.diffplug.spotless from 6.14.1 to 6.15.0 (#​2913)
  • Bump versions.bytebuddy from 1.12.23 to 1.13.0 (#​2912)
  • Bump ru.vyarus.animalsniffer from 1.6.0 to 1.7.0 (#​2911)
  • Bump org.codehaus.groovy:groovy from 3.0.14 to 3.0.15 (#​2910)
  • Fixes #​2905 : ThreadLocal classes can be mocked. (#​2908)
  • StackOverflow while mocking a ThreadLocal on Mockito 5.1.1 (#​2905)
  • Fix most Gradle warnings in build (#​2904)
  • Android CI improvements, improves #​2892 (#​2903)
  • Bump com.diffplug.spotless from 6.14.0 to 6.14.1 (#​2902)
  • Bump versions.bytebuddy from 1.12.22 to 1.12.23 (#​2901)
  • CI on Android API level 33 for Java 11 compatibility testing (#​2899)
  • Bump kotlinVersion from 1.8.0 to 1.8.10 (#​2897)
  • Bump com.github.ben-manes.versions from 0.44.0 to 0.45.0 (#​2895)
  • Simplify and modernize Android Test module. (#​2894)
  • Set up Android Github Action pipeline. Fixes #​2892 (#​2893)

v5.1.1

Compare Source

Changelog generated by Shipkit Changelog Gradle Plugin

5.1.1
  • 2023-01-30 - 1 commit(s) by Andriy Redko
  • StackWalker.Option not found on Mockito 5.1.0 (#​2891)
  • StackWalker.Option not found on Mockito 5.1.0 (#​2890)

v5.1.0

Compare Source

Changelog generated by Shipkit Changelog Gradle Plugin

5.1.0
  • 2023-01-29 - 12 commit(s) by Andriy Redko, Ashley, Róbert Papp, Stephan Schroevers, Tim te Beek, dependabot[bot]
  • Fixes some mistakes and missing details in documentation (#​2889)
  • Bump com.diffplug.spotless from 6.13.0 to 6.14.0 (#​2888)
  • Clean up JDK-8 related code (#​2883)
  • Feat: reified mock overloads (#​2882)
  • Clean up JDK-8 related code (#​2879)
  • Bump assertj-core from 3.24.1 to 3.24.2 (#​2875)
  • Make sure the tests use mock maker with intended member accessor (#​2872)
  • Bump com.diffplug.spotless from 6.12.1 to 6.13.0 (#​2871)
  • Remove broken link from CONTRIBUTING.md (#​2870)
  • Update outdated badge 3.x to 5.x (#​2869)
  • Broken link in CONTRIBUTING.md (#​2868)
  • Set current version to 5.x in README and highlight changes (#​2867)
  • Annotate Mockito#{mock,spy}(T... reified) with @SafeVarargs (#​2866)
  • Make sure the tests use mock maker with intended member accessor (#​2855)
  • Improve examples for InOrder (#​2843)

v5.0.0

Compare Source

Mockito 5: prepare for future JDK versions

For a while now, we have seen an increase in problems/incompatibilities with recent versions of the JDK due to our usage of JVM-internal API.
Most notably, JDK 17 made some changes which are incompatible with the current subclass mockmaker.
Therefore, to prepare for the future of JDK, we are making some core changes to ensure Mockito keeps on working.

Switch the default mockmaker to mockito-inline

Back in Mockito 2.7.6, we published a new mockmaker based on the "inline bytecode" principle.
This mockmaker creates mocks manipulating bytecode equivalent within the original class such that its method implementations hook into the normal Mockito machinery.
As a comparison, the subclass mockmaker generates "real" subclasses for mocks, to mimic the same behavior.
While the approaches are similar, the inline mockmaker avoids certain restrictions that the JDK imposes.
For example, it does not violate module boundaries (introduced in JDK 9, but more heavily used in JDK 17) and avoids the leaking of the creation of the subclass.

Massive thanks to community member @​reta who implemented this change.

Note: this does not affect mockito-android nor testing on Android.

When should I still be using the subclass mockmaker?

There are legitimate remaining use cases for the subclass mockmaker.
For example, on the Graal VM's native image, the inline mockmaker will not work and the subclass mockmaker is the appropriate choice.
Additionally, if you would like to avoid mocking final classes, using the subclass mockmaker is a possibibility.
Note however that if you solely want to use the subclass mockmaker to avoid mocking final, you will run into the above mentioned issues on JDK 17+.
We want to leave this choice up to our users, which is why we will keep on supporting the subclass mockmaker.

If you want to use the subclass mockmaker instead, you can use the new mockito-subclass artifact (published on Maven Central along with all our other artifacts).

Update the minimum supported Java version to 11

Mockito 4 supports Java 8 and above.
Similar to other open source projects, we are moving away from JDK 8 and to newer versions.
The primary reason for moving away from JDK 8 is the increasing maintenance costs with keeping our own infrastructure working.
Lately we have been running into more and more JDK 8 breakages.
Additionally, while we want to support the newest JDK API's, our current solution to support both JDK 8 and newer versions causes issues with the SecurityManager.
Since we want Mockito to work on the newest version and more and more businesses adopting JDK 11, we have decided to make the switch as well.

Massive thanks to community member @​reta who implemented this change.

What should I do if I still run JDK 8?

For JDK 8 and below, you can keep on using Mockito 4.
This is similar to if you are using JDK 6, for which you can keep on using Mockito 2.
The changes in Mockito 5 (for now) are primarily focused on the latest JDK versions, which means the API differences between Mockito 4 and 5 are minimal.
However, over time this will most likely widen, so we do recommend adopting JDK 11 in the future.

New type() method on ArgumentMatcher

One of our most used public API's for customizing Mockito is the ArgumentMatcher interface.
The interface allows you to define a custom matcher, which you can pass into method arguments to provide more targeted matches.
One major shortcoming of the ArgumentMatcher was the lack of varargs support.
There were many, many issues filed related to varargs and Mockito unable to handle them.

Community member @​big-andy-coates put in a lot of effort to come up with an appropriate solution, including fully implementing and comparing 2 approaches.
Ultimately, we decided that introducing a new type() method on ArgumentMatcher is the best solution.
As a result, it is now possible to update your custom matchers to implement varargs support, if you so desire.
Note that ArgumentMatcher is still a @FunctionalInterface and can therefore still be written as a lambda.

Massive thanks to community member @​big-andy-coates who implemented this change.

What is the effect of this new method?

For varargs methods, there was previously a way to only match zero arguments, or two or more arguments, by using the exact number of matchers, i.e.

long call(String... args);

// Will match calls with exactly zero arguments:
when(mock.call()).thenReturn(0L);

// Will match calls with exactly two arguments:
when(mock.call(any(), any())).thenReturn(0L);

But following the pattern to match exactly one argument:

when(mock.call(any())).thenReturn(0L);

doesn't work, as any is "vararg aware", so Mockito matched the any against each element of the varargs parameter, meaning it will match any number of arguments, i.e. the above would of matched all of these:

mock.call();
mock.call("a");
mock.call("a", "b");

With the new type method, it's now possible to differentiate matching calls with any exact number of arguments, or to match any number of arguments.

// Match any number of arguments:
when(mock.call(any(String[].class))).thenReturn(1L);
// Match invocations with no arguments:
when(mock.call()).thenReturn(1L);
// Match invocations with exactly one argument:
when(mock.call(any())).thenReturn(1L);
// Alternative to match invocations with exactly one argument:
when(mock.call(any(String.class))).thenReturn(1L);
// Match invocations with exactly two arguments:
when(mock.call(any(), any())).thenReturn(1L);

Therefore, if you want to match 0 or more arguments, use any(String[].class).
If you want to match an exact number of arguments, use any(String.class) (and specify as many any matchers as arguments you want to match on).

In a similar fashion, the behavior of ArgumentCaptor.forClass has changed as well.
If you want to capture all arguments, use an ArgumentCaptor for String[], otherwise String:

// Will capture 1 string
@&#8203;Captor private ArgumentCaptor<String> captor;
// Will capture all strings
@&#8203;Captor private ArgumentCaptor<String[]> captor;

For more information, see the description and conversation in pull request 2835 and pull request 2807.

At the same time, ArgumentCaptor is now fully type-aware.
This allows for capturing specific subclasses on a generic method:

// Given:
int simpleMethod(Collection<?> arg);

// When:
mock.simpleMethod(Set.of());
mock.simpleMethod(List.of());

// Then:
ArgumentCaptor<Collection<?>> captor = ArgumentCaptor.forClass(List.class);
verify(mock).simpleMethod(captor.capture());
assertThat(captor.getAllValues()).containsExactly(List.of());
Do I need to implement this new method?

No, you don't need to.
Mockito 5 declares a default implementation, returning Void.type as the type of an ArgumentMatcher.
This essentially means that Mockito will not consider the type when handling varargs.
However, if you do return a specific type, Mockito will consider this when matching arguments.
As a result, this new method is not a source-breaking change, but is a bytecode-breaking change.
All code working on Mockito 4 should work as-is when recompiled with Mockito 5.


Configuration

📅 Schedule: Branch creation - "before 4am on Monday" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot force-pushed the renovate/major-mockito-monorepo branch 6 times, most recently from 9b55b7f to b44be2c Compare January 24, 2024 19:55
@renovate renovate bot force-pushed the renovate/major-mockito-monorepo branch from b44be2c to 368f69a Compare January 29, 2024 10:10
@renovate renovate bot force-pushed the renovate/major-mockito-monorepo branch from 368f69a to d6f8782 Compare January 30, 2024 11:41
@renovate renovate bot changed the title fix(deps): update mockito monorepo to v5 (major) fix(deps): update mockito monorepo to v5 (major) - autoclosed Feb 2, 2024
@renovate renovate bot closed this Feb 2, 2024
@renovate renovate bot deleted the renovate/major-mockito-monorepo branch February 2, 2024 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants