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

Update dependency org.mockito:mockito-core to v5 (release/4.2.x) #3118

Merged
merged 2 commits into from Feb 7, 2023

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jan 15, 2023

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
org.mockito:mockito-core 4.6.1 -> 5.1.1 age adoption passing confidence

Release Notes

mockito/mockito

v5.1.1

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

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.

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.

v4.11.0

Compare Source

Changelog generated by Shipkit Changelog Gradle Plugin

4.11.0
  • 2022-12-28 - 1 commit(s) by Andy Coates
  • Improve vararg handling: approach 2 (#​2807)
  • Mocking varargs method with any(String[].class) doesn't work as expected (#​2796)
  • (Argument)Matchers regression from 1.10.19 to 2.18.3 for varargs (#​1498)
  • Cannot verify varargs parameter as an array (#​1222)
  • ArgumentCaptor can't capture varargs-arrays (#​584)
  • Verification of an empty varargs call fails when isNotNull() is used (#​567)

v4.10.0

Compare Source

Changelog generated by Shipkit Changelog Gradle Plugin

4.10.0
  • 2022-12-14 - 13 commit(s) by Andrei Solntsev, Andriy Redko, Andy Coates, Christopher Lambert, Marcono1234, Vladimir Glinskikh, dependabot[bot]
  • Add new artifact mockito-subclass (to use mock-maker-subclass MockMaker) (#​2821)
  • Bump gradle from 7.5.1 to 7.6 (#​2817)
  • Fix incorrect Javadoc inline tag for MockitoJUnitRunner (#​2816)
  • Bump shipkit-auto-version from 1.2.1 to 1.2.2 (#​2811)
  • Bump com.github.ben-manes.versions from 0.42.0 to 0.44.0 (#​2810)
  • Bump kotlinVersion from 1.7.21 to 1.7.22 (#​2809)
  • Bump junit from 1.1.3 to 1.1.4 (#​2806)
  • Simplify MatcherApplicationStrategy (#​2803)
  • Bump kotlinVersion from 1.7.10 to 1.7.21 (#​2801)
  • Bump espresso-core from 3.4.0 to 3.5.0 (#​2800)
  • Bump versions.bytebuddy from 1.12.16 to 1.12.19 (#​2799)
  • Upgrade errorprone from 2.14.0 to 2.16 (#​2794)
  • automatically detect class to mock (#​2779)

v4.9.0

Compare Source

Changelog generated by Shipkit Changelog Gradle Plugin

4.9.0
  • 2022-11-14 - 6 commit(s) by Andrei Solntsev, Rafael Winterhalter, Rick Ossendrijver, dependabot[bot]
  • Upgrade objenesis 3.2 -> 3.3 (#​2784)
  • Upgrade objenesis 3.2 -> 3.3 (#​2783)
  • Avoids clearing stale weak entries from critical code segments. (#​2780)
  • bump gradle from 7.3.1 to 7.5.1 (#​2776)
  • Bump gradle/wrapper-validation-action from 1.0.4 to 1.0.5 (#​2775)
  • Bump gradle-errorprone-plugin from 2.0.2 to 3.0.1 (#​2770)
  • Bump junit-platform-launcher from 1.9.0 to 1.9.1 (#​2768)

v4.8.1

Compare Source

Changelog generated by Shipkit Changelog Gradle Plugin

4.8.1
  • 2022-10-17 - 6 commit(s) by andrepaschoal, dependabot[bot]
  • Possible fix #​2765: Add task to download package-list file from java as element-list (#​2766)
  • JavaDoc warning is blocking all pull requests (#​2765)
  • Bump versions.junitJupiter from 5.9.0 to 5.9.1 (#​2758)
  • Bump groovy from 3.0.12 to 3.0.13 (#​2756)
  • Bump com.diffplug.spotless from 6.10.0 to 6.11.0 (#​2753)
  • Bump org.eclipse.osgi from 3.18.0 to 3.18.100 (#​2751)
  • Bump versions.bytebuddy from 1.12.14 to 1.12.16 (#​2747)

v4.8.0

Compare Source

Changelog generated by Shipkit Changelog Gradle Plugin

4.8.0
  • 2022-09-07 - 10 commit(s) by Alex, James Baker, Johannes Spangenberg, Kurt Alfred Kluever, Rafael Winterhalter, Thibault Helsmoortel, dependabot[bot]
  • GitHub Workflows security hardening (#​2744)
  • Assign GlobalConfiguration initializer to unused variable (#​2742)
  • Bump com.diffplug.spotless from 6.9.1 to 6.10.0 (#​2738)
  • Drop varargs collector before invoking a user method. (#​2736)
  • Bump versions.bytebuddy from 1.12.13 to 1.12.14 (#​2734)
  • Remove useless thrown exception from constructor (#​2732)
  • TypeSafeMatching no longer iterates over class methods inefficiently (#​2729)
  • Fixes #​2720: Use StackWalker on Java 9+ to create Locations (#​2723)
  • LocationImpl adds performance overheads due to instantiating a stack trace (#​2720)
  • Fixes #​2626 : Introduce MockSettings.mockMaker (#​2701)
  • Introduce option to disable inline-mock-maker for a specific instance (#​2626)

v4.7.0

Compare Source

Changelog generated by Shipkit Changelog Gradle Plugin

4.7.0
  • 2022-08-13 - 33 commit(s) by 1988123, Andy Coates, Chen Ni, Marius Lichtblau, Nikita Koselev. Developer Advocate, Open Source Ally, Rafael Winterhalter, dependabot[bot], dstango, fishautumn, heqiang
  • Bump com.diffplug.spotless from 6.9.0 to 6.9.1 (#​2725)
  • Bump versions.bytebuddy from 1.12.12 to 1.12.13 (#​2719)
  • Fix Javadoc for Mockito. (#​2718)
  • Bump com.diffplug.spotless from 6.8.0 to 6.9.0 (#​2717)
  • Fix a typo in comment of InternalRunner.java (#​2715)
  • Bump junit-platform-launcher from 1.8.2 to 1.9.0 (#​2713)
  • Bump versions.junitJupiter from 5.8.2 to 5.9.0 (#​2712)
  • Bump groovy from 3.0.11 to 3.0.12 (#​2711)
  • Bump shipkit-auto-version from 1.2.0 to 1.2.1 (#​2709)
  • Bump kotlinVersion from 1.7.0 to 1.7.10 (#​2705)
  • Bump com.diffplug.spotless from 6.7.2 to 6.8.0 (#​2699)
  • Bump versions.bytebuddy from 1.12.11 to 1.12.12 (#​2695)
  • Makes error message less misleading and points to github for help. Issue #​2692 (#​2693)
  • Misleading error message when mocking and a class (of a parameter) is not found (#​2692)
  • Bump kotlinx-coroutines-core from 1.6.1-native-mt to 1.6.3-native-mt (#​2691)
  • Bump versions.bytebuddy from 1.12.10 to 1.12.11 (#​2690)
  • Fixes #​2679 : Update Javadoc (#​2689)
  • Bump org.eclipse.osgi from 3.17.200 to 3.18.0 (#​2688)
  • RETURNS_SELF: Avoids returning mock when mock type is assignable to method return type, but method return type is Object. (#​2687)
  • RETURNS_SELF breaks methods with generic return type (#​2686)
  • Fix #​2616 wrong stub for nested static (#​2685)
  • Bump com.diffplug.spotless from 6.7.0 to 6.7.2 (#​2684)
  • Avoids starting mocks "half-way" if a superclass constructor is mocked but an unmocked subclass is initiated. (#​2682)
  • Fix typo (#​2681)
  • Update javadoc of Strictness.STRICT_STUBS (#​2679)
  • Bump kotlinVersion from 1.6.21 to 1.7.0 (#​2677)
  • Bump biz.aQute.bnd.builder from 6.3.0 to 6.3.1 (#​2675)
  • Bump biz.aQute.bnd.gradle from 6.3.0 to 6.3.1 (#​2674)
  • Bump com.diffplug.spotless from 6.6.1 to 6.7.0 (#​2672)
  • update CONTRIBUTING.md - stackoverflow (#​2671)
  • stackoverflow.com is a non-actionable text, to be replaced with a hyperlink (#​2670)
  • Fix typos (#​2669)
  • Bump biz.aQute.bnd.gradle from 6.2.0 to 6.3.0 (#​2666)
  • Bump biz.aQute.bnd.builder from 6.2.0 to 6.3.0 (#​2665)
  • Improve Varargs handling in AdditionalAnswers (#​2664)
  • Bump appcompat from 1.4.1 to 1.4.2 (#​2663)
  • Varargs methods cause ClassCastException in AnswerFunctionalInterfaces (#​2644)
  • Mock static class seems records wrong invocations if called nested method throws exception (#​2616)

Configuration

📅 Schedule: Branch creation - "before 2am" (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 this update 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 requested review from a team as code owners January 15, 2023 00:55
@renovate renovate bot added the dependencies Pull requests that update a dependency file label Jan 15, 2023
@gitpod-io
Copy link

gitpod-io bot commented Jan 15, 2023

@renovate renovate bot force-pushed the renovate/release/4.2.x-major-mockito-monorepo branch 4 times, most recently from a696d80 to 47990ce Compare January 30, 2023 23:53
@renovate renovate bot force-pushed the renovate/release/4.2.x-major-mockito-monorepo branch 6 times, most recently from 8a1dc5f to 6f622df Compare February 6, 2023 12:29
@renovate renovate bot force-pushed the renovate/release/4.2.x-major-mockito-monorepo branch from 6f622df to dbf8141 Compare February 7, 2023 08:33
@renovate
Copy link
Contributor Author

renovate bot commented Feb 7, 2023

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.
You can manually request rebase by checking the rebase/retry box above.

Warning: custom changes will be lost.

@sonarcloud
Copy link

sonarcloud bot commented Feb 7, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@joschi joschi merged commit cb6dd55 into release/4.2.x Feb 7, 2023
@joschi joschi deleted the renovate/release/4.2.x-major-mockito-monorepo branch February 7, 2023 22:12
@joschi joschi added this to the 4.2.16 milestone Feb 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant