All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.mockito.internal.framework.DefaultMockitoSession Maven / Gradle / Ivy

There is a newer version: 5.12.0
Show newest version
/*
 * Copyright (c) 2018 Mockito contributors
 * This program is made available under the terms of the MIT License.
 */
package org.mockito.internal.framework;

import org.mockito.Mockito;
import org.mockito.MockitoAnnotations;
import org.mockito.MockitoSession;
import org.mockito.exceptions.base.MockitoException;
import org.mockito.exceptions.misusing.RedundantListenerException;
import org.mockito.internal.exceptions.Reporter;
import org.mockito.internal.junit.TestFinishedEvent;
import org.mockito.internal.junit.UniversalTestListener;
import org.mockito.plugins.MockitoLogger;
import org.mockito.quality.Strictness;

import java.util.ArrayList;
import java.util.List;

public class DefaultMockitoSession implements MockitoSession {

    private final String name;
    private final UniversalTestListener listener;

    private final List closeables = new ArrayList<>();

    public DefaultMockitoSession(
            List testClassInstances,
            String name,
            Strictness strictness,
            MockitoLogger logger) {
        this.name = name;
        listener = new UniversalTestListener(strictness, logger);
        try {
            // So that the listener can capture mock creation events
            Mockito.framework().addListener(listener);
        } catch (RedundantListenerException e) {
            Reporter.unfinishedMockingSession();
        }
        try {
            for (Object testClassInstance : testClassInstances) {
                closeables.add(MockitoAnnotations.openMocks(testClassInstance));
            }
        } catch (RuntimeException e) {
            try {
                release();
            } catch (Throwable t) {
                e.addSuppressed(t);
            }

            // clean up in case 'openMocks' fails
            listener.setListenerDirty();
            throw e;
        }
    }

    @Override
    public void setStrictness(Strictness strictness) {
        listener.setStrictness(strictness);
    }

    @Override
    public void finishMocking() {
        finishMocking(null);
    }

    @Override
    public void finishMocking(final Throwable failure) {
        try {
            // Cleaning up the state, we no longer need the listener hooked up
            // The listener implements MockCreationListener and at this point
            // we no longer need to listen on mock creation events. We are wrapping up the session
            Mockito.framework().removeListener(listener);

            // Emit test finished event so that validation such as strict stubbing can take place
            listener.testFinished(
                    new TestFinishedEvent() {
                        @Override
                        public Throwable getFailure() {
                            return failure;
                        }

                        @Override
                        public String getTestName() {
                            return name;
                        }
                    });

            // Validate only when there is no test failure to avoid reporting multiple problems
            if (failure == null) {
                // Finally, validate user's misuse of Mockito framework.
                Mockito.validateMockitoUsage();
            }
        } finally {
            release();
        }
    }

    private void release() {
        for (AutoCloseable closeable : closeables) {
            try {
                closeable.close();
            } catch (Exception e) {
                throw new MockitoException("Failed to release " + closeable, e);
            }
        }
    }
}