From 1e029d767b33ee8de42e58459a2c3e63ab3f7c41 Mon Sep 17 00:00:00 2001 From: Rafael Winterhalter Date: Sat, 15 Mar 2025 22:14:02 +0100 Subject: [PATCH 1/7] Add missing requirement to objenesis. --- mockito-core/src/main/java/module-info.java | 1 + 1 file changed, 1 insertion(+) diff --git a/mockito-core/src/main/java/module-info.java b/mockito-core/src/main/java/module-info.java index aae1013b04..15fbf51d4d 100644 --- a/mockito-core/src/main/java/module-info.java +++ b/mockito-core/src/main/java/module-info.java @@ -9,6 +9,7 @@ requires net.bytebuddy.agent; requires static junit; requires static org.hamcrest; + requires static org.objenesis; requires static org.opentest4j; requires static jdk.unsupported; From 1764e62102f525ff9a82b8166b8596edd25f5b7f Mon Sep 17 00:00:00 2001 From: Jan Ouwens Date: Tue, 18 Mar 2025 15:04:22 +0000 Subject: [PATCH 2/7] Update links to javadoc.io (#3616) Fixes #3615 --- README.md | 2 +- mockito-core/src/main/java/org/mockito/Mockito.java | 2 +- .../src/main/java/org/mockito/internal/PremainAttachAccess.java | 2 +- mockito-core/src/main/java/org/mockito/junit/MockitoJUnit.java | 2 +- .../android/internal/creation/AndroidByteBuddyMockMaker.java | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 24300a5f34..02461a5f04 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ publish a new minor or patch version to Maven Central. For release automation we [Shipkit library](http://shipkit.org), [Gradle Nexus Publish Plugin](https://github.com/gradle-nexus/publish-plugin). Fully automated releases are awesome, and you should do that for your libraries, too! See the [latest release notes](https://github.com/mockito/mockito/releases/) -and [latest documentation](https://javadoc.io/page/org.mockito/mockito-core/latest/org/mockito/Mockito.html). Docs in +and [latest documentation](https://javadoc.io/doc/org.mockito/mockito-core/latest/org.mockito/org/mockito/Mockito.html). Docs in javadoc.io are available 24h after release. Read also about [semantic versioning in Mockito](https://github.com/mockito/mockito/wiki/Semantic-Versioning). diff --git a/mockito-core/src/main/java/org/mockito/Mockito.java b/mockito-core/src/main/java/org/mockito/Mockito.java index 66f4520f6d..452f8ee44e 100644 --- a/mockito-core/src/main/java/org/mockito/Mockito.java +++ b/mockito-core/src/main/java/org/mockito/Mockito.java @@ -1609,7 +1609,7 @@ *

45. New JUnit Jupiter (JUnit5+) extension

* * For integration with JUnit Jupiter (JUnit5+), use the `org.mockito:mockito-junit-jupiter` artifact. - * For more information about the usage of the integration, see the JavaDoc of MockitoExtension. + * For more information about the usage of the integration, see the JavaDoc of MockitoExtension. * *

46. * New Mockito.lenient() and MockSettings.lenient() methods (Since 2.20.0)

diff --git a/mockito-core/src/main/java/org/mockito/internal/PremainAttachAccess.java b/mockito-core/src/main/java/org/mockito/internal/PremainAttachAccess.java index 2676fbce3e..b63614d451 100644 --- a/mockito-core/src/main/java/org/mockito/internal/PremainAttachAccess.java +++ b/mockito-core/src/main/java/org/mockito/internal/PremainAttachAccess.java @@ -73,7 +73,7 @@ public static Instrumentation getInstrumentation() { "Mockito is currently self-attaching to enable the inline-mock-maker. This " + "will no longer work in future releases of the JDK. Please add Mockito as an agent to your " + "build as described in Mockito's documentation: " - + "https://javadoc.io/doc/org.mockito/mockito-core/latest/org/mockito/Mockito.html#0.3"); + + "https://javadoc.io/doc/org.mockito/mockito-core/latest/org.mockito/org/mockito/Mockito.html#0.3"); } } // Attempt to dynamically attach, as a last resort. diff --git a/mockito-core/src/main/java/org/mockito/junit/MockitoJUnit.java b/mockito-core/src/main/java/org/mockito/junit/MockitoJUnit.java index bbe61308fd..c925995829 100644 --- a/mockito-core/src/main/java/org/mockito/junit/MockitoJUnit.java +++ b/mockito-core/src/main/java/org/mockito/junit/MockitoJUnit.java @@ -16,7 +16,7 @@ *
  • *
      JUnit Rules - see {@link MockitoRule}
    *
      JUnit runners - see {@link MockitoJUnitRunner}
    - * + * *
    • * * @since 1.10.17 diff --git a/mockito-extensions/mockito-android/src/main/java/org/mockito/android/internal/creation/AndroidByteBuddyMockMaker.java b/mockito-extensions/mockito-android/src/main/java/org/mockito/android/internal/creation/AndroidByteBuddyMockMaker.java index 64f6d70aa2..3cf42e310f 100644 --- a/mockito-extensions/mockito-android/src/main/java/org/mockito/android/internal/creation/AndroidByteBuddyMockMaker.java +++ b/mockito-extensions/mockito-android/src/main/java/org/mockito/android/internal/creation/AndroidByteBuddyMockMaker.java @@ -30,7 +30,7 @@ public AndroidByteBuddyMockMaker() { "The Android mock maker was disabled. You should only include the latter in your 'androidTestCompile' configuration", "If disabling was a mistake, you can set the 'org.mockito.mock.android' property to 'true' to override this detection.", "", - "Visit https://javadoc.io/page/org.mockito/mockito-core/latest/org/mockito/Mockito.html#0.1 for more information")); + "Visit https://javadoc.io/page/org.mockito/mockito-core/latest/org.mockito/org/mockito/Mockito.html#0.1 for more information")); delegate = new SubclassByteBuddyMockMaker(); } } From 4f469c830b2f6ab0e1f061e9383aff2e6f9f8376 Mon Sep 17 00:00:00 2001 From: Andre Kurait Date: Wed, 26 Mar 2025 02:44:15 -0500 Subject: [PATCH 3/7] MockitoExtension fails cleanup when aborted before setup (#3623) Fixes #3622 Signed-off-by: Andre Kurait --- .../junit/jupiter/MockitoExtension.java | 16 +++-- .../mockitousage/JunitJupiterSkippedTest.java | 65 +++++++++++++++++++ 2 files changed, 75 insertions(+), 6 deletions(-) create mode 100644 mockito-extensions/mockito-junit-jupiter/src/test/java/org/mockitousage/JunitJupiterSkippedTest.java diff --git a/mockito-extensions/mockito-junit-jupiter/src/main/java/org/mockito/junit/jupiter/MockitoExtension.java b/mockito-extensions/mockito-junit-jupiter/src/main/java/org/mockito/junit/jupiter/MockitoExtension.java index e2dc009cb8..684e25bd05 100644 --- a/mockito-extensions/mockito-junit-jupiter/src/main/java/org/mockito/junit/jupiter/MockitoExtension.java +++ b/mockito-extensions/mockito-junit-jupiter/src/main/java/org/mockito/junit/jupiter/MockitoExtension.java @@ -189,12 +189,16 @@ private Optional retrieveAnnotationFromTestClasses( @Override @SuppressWarnings("unchecked") public void afterEach(ExtensionContext context) { - context.getStore(MOCKITO) - .remove(MOCKS, Set.class) - .forEach(mock -> ((ScopedMock) mock).closeOnDemand()); - context.getStore(MOCKITO) - .remove(SESSION, MockitoSession.class) - .finishMocking(context.getExecutionException().orElse(null)); + ExtensionContext.Store store = context.getStore(MOCKITO); + + Optional.ofNullable(store.remove(MOCKS, Set.class)) + .ifPresent(mocks -> mocks.forEach(mock -> ((ScopedMock) mock).closeOnDemand())); + + Optional.ofNullable(store.remove(SESSION, MockitoSession.class)) + .ifPresent( + session -> + session.finishMocking( + context.getExecutionException().orElse(null))); } @Override diff --git a/mockito-extensions/mockito-junit-jupiter/src/test/java/org/mockitousage/JunitJupiterSkippedTest.java b/mockito-extensions/mockito-junit-jupiter/src/test/java/org/mockitousage/JunitJupiterSkippedTest.java new file mode 100644 index 0000000000..94bd0aed12 --- /dev/null +++ b/mockito-extensions/mockito-junit-jupiter/src/test/java/org/mockitousage/JunitJupiterSkippedTest.java @@ -0,0 +1,65 @@ +/* + * Copyright (c) 2018 Mockito contributors + * This program is made available under the terms of the MIT License. + */ +package org.mockitousage; + +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.BeforeAllCallback; +import org.junit.jupiter.api.extension.BeforeEachCallback; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.api.extension.ExtensionContext; +import org.mockito.junit.jupiter.MockitoExtension; +import org.opentest4j.TestAbortedException; + +class JunitJupiterSkippedTest { + @Nested + class NestedSkipBeforeEachMockito { + @Test + @ExtendWith({SkipTestBeforeEachExtension.class, MockitoExtension.class}) + void should_handle_skip_in_before_each() {} + + @Test + @ExtendWith({MockitoExtension.class, SkipTestBeforeEachExtension.class}) + void should_handle_skip_after_before_each() {} + + @Test + @ExtendWith(MockitoExtension.class) + void should_handle_skip_in_test() { + skipTest(); + } + } + + @Nested + @ExtendWith({SkipTestBeforeAllExtension.class, MockitoExtension.class}) + class NestedSkipBeforeAllSkipThenMockito { + @Test + void should_handle_skip_in_before_all() {} + } + + @Nested + @ExtendWith({MockitoExtension.class, SkipTestBeforeAllExtension.class}) + class NestedSkipBeforeAllMockitoThenSkip { + @Test + void should_handle_skip_in_before_all() {} + } + + private static class SkipTestBeforeEachExtension implements BeforeEachCallback { + @Override + public void beforeEach(ExtensionContext context) { + skipTest(); + } + } + + private static class SkipTestBeforeAllExtension implements BeforeAllCallback { + @Override + public void beforeAll(ExtensionContext context) { + skipTest(); + } + } + + private static void skipTest() { + throw new TestAbortedException("Skipped test"); + } +} From bfab74365e91135b2f88ccb0228372a8799d9279 Mon Sep 17 00:00:00 2001 From: Adrian Roos Date: Fri, 28 Mar 2025 11:04:04 +0100 Subject: [PATCH 4/7] Fall back to Throwable Location strategy on Android (#3619) Works around an Android Runtime bug where StackWalker would fail to traverse the stack if a stack frame involves java.lang.Proxy. Disables StackWalker for Android versions that do not yet include the fix in https://r.android.com/3548340. This issue was also reported as https://github.com/linkedin/dexmaker/issues/190. Fixes #3171 --- .../internal/debugging/LocationFactory.java | 5 +++ .../internal/util/AndroidPlatform.java | 33 +++++++++++++++++++ .../AaaMustRunFirstLocationTests.kt | 26 +++++++++++++++ 3 files changed, 64 insertions(+) create mode 100644 mockito-core/src/main/java/org/mockito/internal/util/AndroidPlatform.java create mode 100644 mockito-integration-tests/android-tests/src/androidTest/java/org/mockitousage/androidtest/AaaMustRunFirstLocationTests.kt diff --git a/mockito-core/src/main/java/org/mockito/internal/debugging/LocationFactory.java b/mockito-core/src/main/java/org/mockito/internal/debugging/LocationFactory.java index 3d936ae761..3b0d0a4ae0 100644 --- a/mockito-core/src/main/java/org/mockito/internal/debugging/LocationFactory.java +++ b/mockito-core/src/main/java/org/mockito/internal/debugging/LocationFactory.java @@ -4,6 +4,8 @@ */ package org.mockito.internal.debugging; +import org.mockito.internal.util.AndroidPlatform; +import org.mockito.internal.util.Platform; import org.mockito.invocation.Location; public final class LocationFactory { @@ -24,6 +26,9 @@ private interface Factory { } private static Factory createLocationFactory() { + if (Platform.isAndroid() && !AndroidPlatform.isStackWalkerUsable()) { + return new Java8LocationFactory(); + } try { // On some platforms, like Android, the StackWalker APIs may not be // available, in this case we have to fallback to Java 8 style of stack diff --git a/mockito-core/src/main/java/org/mockito/internal/util/AndroidPlatform.java b/mockito-core/src/main/java/org/mockito/internal/util/AndroidPlatform.java new file mode 100644 index 0000000000..5a0ffbcd2a --- /dev/null +++ b/mockito-core/src/main/java/org/mockito/internal/util/AndroidPlatform.java @@ -0,0 +1,33 @@ +/* + * Copyright (c) 2025 Mockito contributors + * This program is made available under the terms of the MIT License. + */ +package org.mockito.internal.util; + +public class AndroidPlatform { + + private static int getSdkInt() { + try { + return Class.forName("android.os.Build$VERSION").getField("SDK_INT").getInt(null); + } catch (ReflectiveOperationException e) { + return 0; + } + } + + private static int getExtensionVersion(int sdk) { + try { + return (int) + Class.forName("android.os.ext.SdkExtensions") + .getMethod("getExtensionVersion", int.class) + .invoke(null, sdk); + } catch (ReflectiveOperationException e) { + return 0; + } + } + + public static boolean isStackWalkerUsable() { + // StackWalker on Android had a bug that is fixed in Android Baklava (36) + // or SDK extension train M2025-05 (17) and later. See https://r.android.com/3548340. + return getSdkInt() >= 36 || getSdkInt() >= 31 && getExtensionVersion(31) >= 17; + } +} diff --git a/mockito-integration-tests/android-tests/src/androidTest/java/org/mockitousage/androidtest/AaaMustRunFirstLocationTests.kt b/mockito-integration-tests/android-tests/src/androidTest/java/org/mockitousage/androidtest/AaaMustRunFirstLocationTests.kt new file mode 100644 index 0000000000..c7e497581b --- /dev/null +++ b/mockito-integration-tests/android-tests/src/androidTest/java/org/mockitousage/androidtest/AaaMustRunFirstLocationTests.kt @@ -0,0 +1,26 @@ +package org.mockitousage.androidtest + +import androidx.test.ext.junit.runners.AndroidJUnit4 +import org.junit.Test +import org.junit.runner.RunWith +import org.mockito.Mockito.mock +import org.mockito.Mockito.withSettings +import org.mockito.internal.creation.proxy.ProxyMockMaker + +@RunWith(AndroidJUnit4::class) +class AaaMustRunFirstLocationTests { + + /** + * Regression test for https://github.com/mockito/mockito/issues/3171 and + * https://github.com/linkedin/dexmaker/issues/190. + * + * Bug only triggers if the first time LocationImpl is used is with ProxyMockMaker, therefore + * this test must be the first to run. + */ + @Test + fun mockAndUseInterfaceWithProxyMockMaker() { + val basicInterface = mock(BasicInterface::class.java, + withSettings().mockMaker(ProxyMockMaker::class.java.name)) + basicInterface.interfaceMethod() + } +} From 3edab5283552c3c6c393d8c818c8d6a8fa1f94a5 Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Sat, 29 Mar 2025 15:24:51 +0100 Subject: [PATCH 5/7] Clarify structure of commit messages (#3626) Since I have been merging most of the community contributions, I realized that I continuously rewrite commit messages with regards to the `Fixes #id` notation. Therefore, update the contribution guidelines to clarify that the fixes part should come at the end (as to not clutter the message). Also, link to the commit guide that I usually refer to, which also clarifies that the commit title should start with a verb. --- .github/CONTRIBUTING.md | 22 +++++++++++++++++----- .github/PULL_REQUEST_TEMPLATE.md | 15 +++------------ 2 files changed, 20 insertions(+), 17 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 5a49c782b4..967177cc4d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -14,7 +14,7 @@ ## Pull request criteria -* **At least one commit message** in the PR starts with `Fixes #id : ` where `id` is an [issue tracker](https://github.com/mockito/mockito/issues) id. This allows automated release notes generation. Also GitHub will track the issue and [close it](https://github.com/blog/1386-closing-issues-via-commit-messages) when the PR is merged. +* **At least one commit message** in the PR ends with `Fixes #id` where `id` is an [issue tracker](https://github.com/mockito/mockito/issues) id. This allows automated release notes generation. Also GitHub will track the issue and [close it](https://github.com/blog/1386-closing-issues-via-commit-messages) when the PR is merged. * Use `@since` tags for new public APIs * Include tests * Document public APIs with examples @@ -42,13 +42,25 @@ Things we pay attention in a PR : * On pull requests, please document the change, what it brings, what is the benefit. * **Clean commit history** in the topic branch in your fork of the repository, even during review. That means that commits are _rebased_ and _squashed_ if necessary, so that each commit clearly changes one things and there are no extraneous fix-ups. - For that matter it's possible to commit [_semantic_ changes](https://lemike-de.tumblr.com/post/79041908218/semantic-commits). _Tests are an asset, so is history_. + _Tests are an asset, so is history_. - _Example gratia_: + _Example gratia_ (based on https://cbea.ms/git-commit/): ``` - Fixes #73 : The new feature - Fixes #73 : Refactors this part of Mockito to make feature possible + Enable feature X to do Y + + Include some background information here. + + Fixes #73 + ``` + + ``` + Fix bug B with feature A + + Include some background information here. + Add example scenario/context. + + Fixes #73 ``` * In the code, always test your feature / change, in unit tests and in our `acceptance test suite` located in `org.mockitousage`. Older tests will be migrated when a test is modified. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b79cc7b012..6fbe6948a6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,12 +1,4 @@ - - + ## Checklist - [ ] Read the [contributing guide](https://github.com/mockito/mockito/blob/main/.github/CONTRIBUTING.md) @@ -16,7 +8,6 @@ If you have a suggestion for this template you can fix it in the .github/PULL_RE - [ ] Avoid other runtime dependencies - [ ] Meaningful commit history ; intention is important please rebase your commit history so that each commit is meaningful and help the people that will explore a change in 2 years - - [ ] The pull request follows coding style + - [ ] The pull request follows coding style (run `./gradlew spotlessApply` for auto-formatting) - [ ] Mention `Fixes #` in the description _if relevant_ - - [ ] At least one commit should mention `Fixes #` _if relevant_ - + - [ ] At least one commit should end with `Fixes #` _if relevant_ From ee92ad4916d9f3f6ae6836bdba5c30f8404d3d50 Mon Sep 17 00:00:00 2001 From: Taeik Lim Date: Tue, 1 Apr 2025 21:03:54 +0900 Subject: [PATCH 6/7] Fix broken banner image link (#3632) Fixes #3631 Signed-off-by: Taeik Lim --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 02461a5f04..40a805c948 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -Mockito From 7764992d1250f4e7f6ffd10f650dc89516139c8d Mon Sep 17 00:00:00 2001 From: Thach Le Date: Fri, 4 Apr 2025 20:17:14 +0700 Subject: [PATCH 7/7] Remove mention of `mockito-inline` from mockmaker exception (#3628) `mockito-inline` is a discontinued artifact, since the inline mockmaker is now the default mockmaker in `mockito-core`. Fixes #3621 --- .../main/java/org/mockito/plugins/MockMaker.java | 10 ++++------ .../src/test/java/org/mockito/MockitoTest.java | 14 ++++++-------- 2 files changed, 10 insertions(+), 14 deletions(-) diff --git a/mockito-core/src/main/java/org/mockito/plugins/MockMaker.java b/mockito-core/src/main/java/org/mockito/plugins/MockMaker.java index c0b1cbcd2d..106350aa85 100644 --- a/mockito-core/src/main/java/org/mockito/plugins/MockMaker.java +++ b/mockito-core/src/main/java/org/mockito/plugins/MockMaker.java @@ -171,9 +171,8 @@ default StaticMockControl createStaticMock( + getClass().getSimpleName() + " does not support the creation of static mocks", "", - "Mockito's inline mock maker supports static mocks based on the Instrumentation API.", - "You can simply enable this mock mode, by placing the 'mockito-inline' artifact where you are currently using 'mockito-core'.", - "Note that Mockito's inline mock maker is not supported on Android.")); + "Ensure your MockMaker implementation supports this feature.", + "Note that static mocks maker is not supported on Android.")); } /** @@ -203,9 +202,8 @@ default ConstructionMockControl createConstructionMock( + getClass().getSimpleName() + " does not support the creation of construction mocks", "", - "Mockito's inline mock maker supports construction mocks based on the Instrumentation API.", - "You can simply enable this mock mode, by placing the 'mockito-inline' artifact where you are currently using 'mockito-core'.", - "Note that Mockito's inline mock maker is not supported on Android.")); + "Ensure your MockMaker implementation supports this feature.", + "Note that construction mocks maker is not supported on Android.")); } /** diff --git a/mockito-core/src/test/java/org/mockito/MockitoTest.java b/mockito-core/src/test/java/org/mockito/MockitoTest.java index 1671280d0c..619bbf2165 100644 --- a/mockito-core/src/test/java/org/mockito/MockitoTest.java +++ b/mockito-core/src/test/java/org/mockito/MockitoTest.java @@ -104,7 +104,7 @@ public void shouldValidateMockWhenCreatingInOrderObject() { @SuppressWarnings({"CheckReturnValue", "MockitoUsage"}) @Test - public void shouldGiveExplanationOnStaticMockingWithoutInlineMockMaker() { + public void shouldGiveExplanationOnStaticMockingMockMaker() { Assume.assumeThat(Plugins.getMockMaker(), not(instanceOf(InlineMockMaker.class))); assertThatThrownBy( @@ -114,14 +114,13 @@ public void shouldGiveExplanationOnStaticMockingWithoutInlineMockMaker() { .isInstanceOf(MockitoException.class) .hasMessageContainingAll( "The used MockMaker SubclassByteBuddyMockMaker does not support the creation of static mocks", - "Mockito's inline mock maker supports static mocks based on the Instrumentation API.", - "You can simply enable this mock mode, by placing the 'mockito-inline' artifact where you are currently using 'mockito-core'.", - "Note that Mockito's inline mock maker is not supported on Android."); + "Ensure your MockMaker implementation supports this feature.", + "Note that static mocks maker is not supported on Android."); } @SuppressWarnings({"CheckReturnValue", "MockitoUsage"}) @Test - public void shouldGiveExplanationOnConstructionMockingWithoutInlineMockMaker() { + public void shouldGiveExplanationOnConstructionMockingMockMaker() { Assume.assumeThat(Plugins.getMockMaker(), not(instanceOf(InlineMockMaker.class))); assertThatThrownBy( @@ -131,9 +130,8 @@ public void shouldGiveExplanationOnConstructionMockingWithoutInlineMockMaker() { .isInstanceOf(MockitoException.class) .hasMessageContainingAll( "The used MockMaker SubclassByteBuddyMockMaker does not support the creation of construction mocks", - "Mockito's inline mock maker supports construction mocks based on the Instrumentation API.", - "You can simply enable this mock mode, by placing the 'mockito-inline' artifact where you are currently using 'mockito-core'.", - "Note that Mockito's inline mock maker is not supported on Android."); + "Ensure your MockMaker implementation supports this feature.", + "Note that construction mocks maker is not supported on Android."); } @SuppressWarnings({"CheckReturnValue", "MockitoUsage"})