chore(deps): Update mockito monorepo to v5 (major) #8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
renovate
bot
force-pushed
the
renovate/major-mockito-monorepo
branch
from
f71747d to
3c8ded2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
4.11.0->5.9.04.11.0->5.9.0Release Notes
mockito/mockito (org.mockito:mockito-junit-jupiter)
v5.9.0Compare Source
Changelog generated by Shipkit Changelog Gradle Plugin
5.9.0
v5.8.0Compare Source
Changelog generated by Shipkit Changelog Gradle Plugin
5.8.0
v5.7.0Compare Source
Changelog generated by Shipkit Changelog Gradle Plugin
5.7.0
0.8.11(#3147)v5.6.0Compare Source
Changelog generated by Shipkit Changelog Gradle Plugin
5.6.0
Optionalis notemptywhen usingRETURN_DEEP_STUBS(#2865)v5.5.0Compare Source
Changelog generated by Shipkit Changelog Gradle Plugin
5.5.0
v5.4.0Compare Source
Changelog generated by Shipkit Changelog Gradle Plugin
5.4.0
@Mock(serializable = true)for parameterized types. (#3007)ArgumentMatchers#any()JavaDoc(#3003)
@Mock(serializable = true)no longer works with parameterized types (#2979)v5.3.1Compare Source
Changelog generated by Shipkit Changelog Gradle Plugin
5.3.1
v5.3.0Compare Source
Changelog generated by Shipkit Changelog Gradle Plugin
5.3.0
withoutAnnotationsparameter to@Mock(#2965)ArgumentMatchers#assertArgmethod. (#2949)v5.2.0Compare Source
Changelog generated by Shipkit Changelog Gradle Plugin
5.2.0
v5.1.1Changelog generated by Shipkit Changelog Gradle Plugin
5.1.1
v5.1.0Changelog generated by Shipkit Changelog Gradle Plugin
5.1.0
CONTRIBUTING.md(#2870)CONTRIBUTING.md(#2868)Mockito#{mock,spy}(T... reified)with@SafeVarargs(#2866)v5.0.0Mockito 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-inlineBack 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-androidnor 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-subclassartifact (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 onArgumentMatcherOne of our most used public API's for customizing Mockito is the
ArgumentMatcherinterface.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
ArgumentMatcherwas 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 onArgumentMatcheris 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
ArgumentMatcheris still a@FunctionalInterfaceand 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.
But following the pattern to match exactly one argument:
doesn't work, as
anyis "vararg aware", so Mockito matched theanyagainst each element of the varargs parameter, meaning it will match any number of arguments, i.e. the above would of matched all of these:With the new
typemethod, it's now possible to differentiate matching calls with any exact number of arguments, or to match any number of arguments.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 manyanymatchers as arguments you want to match on).In a similar fashion, the behavior of
ArgumentCaptor.forClasshas changed as well.If you want to capture all arguments, use an
ArgumentCaptorforString[], otherwiseString:For more information, see the description and conversation in pull request 2835 and pull request 2807.
At the same time,
ArgumentCaptoris now fully type-aware.This allows for capturing specific subclasses on a generic method:
Do I need to implement this new method?
No, you don't need to.
Mockito 5 declares a default implementation, returning
Void.typeas the type of anArgumentMatcher.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 - At any time (no schedule defined), 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.
This PR has been generated by Mend Renovate. View repository job log here.