mockit.internal.expectations.ActiveInvocations Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jmockit Show documentation
JMockit is a Java toolkit for automated developer testing. It contains APIs for the creation of the objects to be tested, for mocking dependencies, and for faking external APIs; JUnit (4 & 5) and TestNG test runners are supported. It also contains an advanced code coverage tool.
The newest version!
/*
 * Copyright (c) 2006 JMockit developers
 * This file is subject to the terms of the MIT license (see LICENSE.txt).
 */
package mockit.internal.expectations;

import static mockit.internal.expectations.argumentMatching.AlwaysTrueMatcher.ANY_BOOLEAN;
import static mockit.internal.expectations.argumentMatching.AlwaysTrueMatcher.ANY_BYTE;
import static mockit.internal.expectations.argumentMatching.AlwaysTrueMatcher.ANY_CHAR;
import static mockit.internal.expectations.argumentMatching.AlwaysTrueMatcher.ANY_DOUBLE;
import static mockit.internal.expectations.argumentMatching.AlwaysTrueMatcher.ANY_FLOAT;
import static mockit.internal.expectations.argumentMatching.AlwaysTrueMatcher.ANY_INT;
import static mockit.internal.expectations.argumentMatching.AlwaysTrueMatcher.ANY_LONG;
import static mockit.internal.expectations.argumentMatching.AlwaysTrueMatcher.ANY_SHORT;
import static mockit.internal.expectations.argumentMatching.AlwaysTrueMatcher.ANY_STRING;
import static mockit.internal.expectations.argumentMatching.AlwaysTrueMatcher.ANY_VALUE;

import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;

import mockit.internal.expectations.argumentMatching.ArgumentMatcher;
import mockit.internal.expectations.transformation.ArgumentCapturing;
import mockit.internal.state.TestRun;
import mockit.internal.util.ClassLoad;

import org.checkerframework.checker.index.qual.NonNegative;

@SuppressWarnings("unused")
public final class ActiveInvocations {
    private ActiveInvocations() {
    }

    public static void anyString() {
        addArgMatcher(ANY_STRING);
    }

    public static void anyBoolean() {
        addArgMatcher(ANY_BOOLEAN);
    }

    public static void anyChar() {
        addArgMatcher(ANY_CHAR);
    }

    public static void anyByte() {
        addArgMatcher(ANY_BYTE);
    }

    public static void anyShort() {
        addArgMatcher(ANY_SHORT);
    }

    public static void anyInt() {
        addArgMatcher(ANY_INT);
    }

    public static void anyFloat() {
        addArgMatcher(ANY_FLOAT);
    }

    public static void anyLong() {
        addArgMatcher(ANY_LONG);
    }

    public static void anyDouble() {
        addArgMatcher(ANY_DOUBLE);
    }

    public static void any() {
        addArgMatcher(ANY_VALUE);
    }

    private static void addArgMatcher(@NonNull ArgumentMatcher argumentMatcher) {
        RecordAndReplayExecution instance = TestRun.getRecordAndReplayForRunningTest();

        if (instance != null) {
            TestOnlyPhase currentPhase = instance.getCurrentTestOnlyPhase();

            if (currentPhase != null) {
                currentPhase.addArgMatcher(argumentMatcher);
            }
        }
    }

    public static void moveArgMatcher(@NonNegative int originalMatcherIndex, @NonNegative int toIndex) {
        RecordAndReplayExecution instance = TestRun.getRecordAndReplayForRunningTest();

        if (instance != null) {
            TestOnlyPhase currentPhase = instance.getCurrentTestOnlyPhase();

            if (currentPhase != null) {
                currentPhase.moveArgMatcher(originalMatcherIndex, toIndex);
            }
        }
    }

    public static void setExpectedArgumentType(@NonNegative int parameterIndex, @NonNull String typeDesc) {
        RecordAndReplayExecution instance = TestRun.getRecordAndReplayForRunningTest();

        if (instance != null) {
            TestOnlyPhase currentPhase = instance.getCurrentTestOnlyPhase();

            if (currentPhase != null) {
                Class argumentType = ClassLoad.loadByInternalName(typeDesc);
                currentPhase.setExpectedSingleArgumentType(parameterIndex, argumentType);
            }
        }
    }

    public static void setExpectedArgumentType(@NonNegative int parameterIndex, int varIndex) {
        RecordAndReplayExecution instance = TestRun.getRecordAndReplayForRunningTest();

        if (instance != null) {
            String typeDesc = ArgumentCapturing.extractArgumentType(varIndex);

            if (typeDesc != null) {
                TestOnlyPhase currentPhase = instance.getCurrentTestOnlyPhase();

                if (currentPhase != null) {
                    Class argumentType = ClassLoad.loadByInternalName(typeDesc);
                    currentPhase.setExpectedMultiArgumentType(parameterIndex, argumentType);
                }
            }
        }
    }

    @Nullable
    public static Object matchedArgument(@NonNegative int parameterIndex, @Nullable String argTypeDesc) {
        RecordAndReplayExecution instance = TestRun.getRecordAndReplayForRunningTest();

        if (instance != null) {
            BaseVerificationPhase verificationPhase = (BaseVerificationPhase) instance.getCurrentTestOnlyPhase();

            if (verificationPhase != null) {
                return verificationPhase.getArgumentValueForCurrentVerification(parameterIndex);
            }
        }

        return null;
    }

    public static void addResult(@Nullable Object result) {
        RecordAndReplayExecution instance = TestRun.getRecordAndReplayForRunningTest();

        if (instance != null) {
            RecordPhase recordPhase = instance.getRecordPhase();

            if (recordPhase != null) {
                recordPhase.addResult(result);
            }
        }
    }

    public static void times(int n) {
        RecordAndReplayExecution instance = TestRun.getRecordAndReplayForRunningTest();

        if (instance != null) {
            TestOnlyPhase currentPhase = instance.getCurrentTestOnlyPhase();

            if (currentPhase != null) {
                currentPhase.handleInvocationCountConstraint(n, n);
            }
        }
    }

    public static void minTimes(int n) {
        RecordAndReplayExecution instance = TestRun.getRecordAndReplayForRunningTest();

        if (instance != null) {
            TestOnlyPhase currentPhase = instance.getCurrentTestOnlyPhase();

            if (currentPhase != null) {
                currentPhase.handleInvocationCountConstraint(n, -1);
            }
        }
    }

    public static void maxTimes(int n) {
        RecordAndReplayExecution instance = TestRun.getRecordAndReplayForRunningTest();

        if (instance != null) {
            TestOnlyPhase currentPhase = instance.getCurrentTestOnlyPhase();

            if (currentPhase != null) {
                currentPhase.setMaxInvocationCount(n);
            }
        }
    }

    public static void endInvocations() {
        TestRun.enterNoMockingZone();

        try {
            RecordAndReplayExecution instance = TestRun.getRecordAndReplayForRunningTest();
            assert instance != null;
            instance.endInvocations();
        } finally {
            TestRun.exitNoMockingZone();
        }
    }
}