Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Mockito \#1013: Defines and implements API for static mocking.
- Loading branch information
Showing
66 changed files
with
1,294 additions
and
198 deletions.
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,209 @@ | ||
| /* | ||
| * Copyright (c) 2007 Mockito contributors | ||
| * This program is made available under the terms of the MIT License. | ||
| */ | ||
| package org.mockito; | ||
|
|
||
| import org.mockito.exceptions.base.MockitoAssertionError; | ||
| import org.mockito.exceptions.base.MockitoException; | ||
| import org.mockito.internal.creation.StaticMockControl; | ||
| import org.mockito.internal.debugging.LocationImpl; | ||
| import org.mockito.internal.listeners.VerificationStartedNotifier; | ||
| import org.mockito.internal.progress.MockingProgress; | ||
| import org.mockito.internal.stubbing.InvocationContainerImpl; | ||
| import org.mockito.internal.verification.MockAwareVerificationMode; | ||
| import org.mockito.internal.verification.VerificationDataImpl; | ||
| import org.mockito.invocation.Location; | ||
| import org.mockito.invocation.MockHandler; | ||
| import org.mockito.stubbing.OngoingStubbing; | ||
| import org.mockito.verification.VerificationMode; | ||
|
|
||
| import static org.mockito.Mockito.times; | ||
| import static org.mockito.internal.exceptions.Reporter.missingMethodInvocation; | ||
| import static org.mockito.internal.progress.ThreadSafeMockingProgress.mockingProgress; | ||
| import static org.mockito.internal.util.MockUtil.getInvocationContainer; | ||
| import static org.mockito.internal.util.MockUtil.resetMock; | ||
| import static org.mockito.internal.util.StringUtil.join; | ||
| import static org.mockito.internal.verification.VerificationModeFactory.noInteractions; | ||
| import static org.mockito.internal.verification.VerificationModeFactory.noMoreInteractions; | ||
|
|
||
| /** | ||
| * Represents an active mock of a type's static methods. The mocking only affects the thread | ||
| * on which this static mock was created and it is not safe to use this object from another | ||
| * thread. The static mock is released when this object's {@link MockedStatic#close()} method | ||
| * is invoked. If this object is never closed, the static mock will remain active on the | ||
| * initiating thread. It is therefore recommended to create this object within a try-with-resources | ||
| * statement unless when managed explicitly, for example by using a JUnit rule or extension. | ||
| * <p> | ||
| * If the {@link Mock} annotation is used on fields or method parameters of this type, a static mock | ||
| * is created instead of a regular mock. The static mock is activated and released upon completing any | ||
| * relevant test. | ||
| * | ||
| * @param <T> The type being mocked. | ||
| */ | ||
| @Incubating | ||
| public final class MockedStatic<T> implements AutoCloseable { | ||
|
|
||
| private final StaticMockControl<T> control; | ||
|
|
||
| private boolean closed; | ||
|
|
||
| private final Location location = new LocationImpl(); | ||
|
|
||
| public MockedStatic(StaticMockControl<T> control) { | ||
| this.control = control; | ||
| } | ||
|
|
||
| /** | ||
| * See {@link Mockito#when(Object)}. | ||
| */ | ||
| public <S> OngoingStubbing<S> when(Verification verification) { | ||
| assertNotClosed(); | ||
|
|
||
| try { | ||
| verification.apply(); | ||
| } catch (Throwable ignored) { | ||
| } | ||
|
|
||
| MockingProgress mockingProgress = mockingProgress(); | ||
| mockingProgress.stubbingStarted(); | ||
| @SuppressWarnings("unchecked") | ||
| OngoingStubbing<S> stubbing = (OngoingStubbing<S>) mockingProgress.pullOngoingStubbing(); | ||
| if (stubbing == null) { | ||
| mockingProgress.reset(); | ||
| throw missingMethodInvocation(); | ||
| } | ||
| return stubbing; | ||
| } | ||
|
|
||
| /** | ||
| * See {@link Mockito#verify(Object)}. | ||
| */ | ||
| public void verify(Verification verification) { | ||
| verify(times(1), verification); | ||
| } | ||
|
|
||
| /** | ||
| * See {@link Mockito#verify(Object, VerificationMode)}. | ||
| */ | ||
| public void verify(VerificationMode mode, Verification verification) { | ||
| assertNotClosed(); | ||
|
|
||
| MockingDetails mockingDetails = Mockito.mockingDetails(control.getType()); | ||
| MockHandler handler = mockingDetails.getMockHandler(); | ||
|
|
||
| VerificationStartedNotifier.notifyVerificationStarted( | ||
| handler.getMockSettings().getVerificationStartedListeners(), mockingDetails); | ||
|
|
||
| MockingProgress mockingProgress = mockingProgress(); | ||
| VerificationMode actualMode = mockingProgress.maybeVerifyLazily(mode); | ||
| mockingProgress.verificationStarted( | ||
| new MockAwareVerificationMode( | ||
| control.getType(), actualMode, mockingProgress.verificationListeners())); | ||
|
|
||
| try { | ||
| verification.apply(); | ||
| } catch (MockitoException | MockitoAssertionError e) { | ||
| throw e; | ||
| } catch (Throwable t) { | ||
| throw new MockitoException( | ||
| join( | ||
| "An unexpected error occurred while verifying a static stub", | ||
| "", | ||
| "To correctly verify a stub, invoke a single static method of " | ||
| + control.getType().getName() | ||
| + " in the provided lambda.", | ||
| "For example, if a method 'sample' was defined, provide a lambda or anonymous class containing the code", | ||
| "", | ||
| "() -> " + control.getType().getSimpleName() + ".sample()", | ||
| "or", | ||
| control.getType().getSimpleName() + "::sample"), | ||
| t); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * See {@link Mockito#reset(Object[])}. | ||
| */ | ||
| public void reset() { | ||
| assertNotClosed(); | ||
|
|
||
| MockingProgress mockingProgress = mockingProgress(); | ||
| mockingProgress.validateState(); | ||
| mockingProgress.reset(); | ||
| mockingProgress.resetOngoingStubbing(); | ||
|
|
||
| resetMock(control.getType()); | ||
| } | ||
|
|
||
| /** | ||
| * See {@link Mockito#clearInvocations(Object[])}. | ||
| */ | ||
| public void clearInvocations() { | ||
| assertNotClosed(); | ||
|
|
||
| MockingProgress mockingProgress = mockingProgress(); | ||
| mockingProgress.validateState(); | ||
| mockingProgress.reset(); | ||
| mockingProgress.resetOngoingStubbing(); | ||
|
|
||
| getInvocationContainer(control.getType()).clearInvocations(); | ||
| } | ||
|
|
||
| /** | ||
| * {@link Mockito#verifyNoMoreInteractions(Object...)}. | ||
| */ | ||
| public void verifyNoMoreInteractions() { | ||
| assertNotClosed(); | ||
|
|
||
| mockingProgress().validateState(); | ||
| InvocationContainerImpl invocations = getInvocationContainer(control.getType()); | ||
| VerificationDataImpl data = new VerificationDataImpl(invocations, null); | ||
| noMoreInteractions().verify(data); | ||
| } | ||
|
|
||
| /** | ||
| * See {@link Mockito#verifyNoInteractions(Object...)}. | ||
| */ | ||
| public void verifyNoInteractions() { | ||
| assertNotClosed(); | ||
|
|
||
| mockingProgress().validateState(); | ||
| InvocationContainerImpl invocations = getInvocationContainer(control.getType()); | ||
| VerificationDataImpl data = new VerificationDataImpl(invocations, null); | ||
| noInteractions().verify(data); | ||
| } | ||
|
|
||
| @Override | ||
| public void close() { | ||
| assertNotClosed(); | ||
|
|
||
| closed = true; | ||
| control.disable(); | ||
| } | ||
|
|
||
| /** | ||
| * Releases this static mock and is non-operational if already released. | ||
| */ | ||
| public void closeOnDemand() { | ||
| if (!closed) { | ||
| close(); | ||
| } | ||
| } | ||
|
|
||
| private void assertNotClosed() { | ||
| if (closed) { | ||
| throw new MockitoException( | ||
| join( | ||
| "The static mock created at", | ||
| location.toString(), | ||
| "is already resolved and cannot longer be used")); | ||
| } | ||
| } | ||
|
|
||
| @FunctionalInterface | ||
| public interface Verification { | ||
|
|
||
| void apply() throws Throwable; | ||
| } | ||
| } |
Oops, something went wrong.