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

org.mockito.internal.junit.MismatchReportingTestListener 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.junit;

import java.util.Collection;
import java.util.LinkedList;
import java.util.List;

import org.mockito.mock.MockCreationSettings;
import org.mockito.plugins.MockitoLogger;

/**
 * Reports stubbing argument mismatches to the supplied logger
 */
public class MismatchReportingTestListener implements MockitoTestListener {

    private final MockitoLogger logger;
    private List mocks = new LinkedList<>();

    public MismatchReportingTestListener(MockitoLogger logger) {
        this.logger = logger;
    }

    @Override
    public void testFinished(TestFinishedEvent event) {
        Collection createdMocks = mocks;
        // At this point, we don't need the mocks any more and we can mark all collected mocks for
        // gc
        // TODO make it better, it's easy to forget to clean up mocks and we still create new
        // instance of list that nobody will read, it's also duplicated
        mocks = new LinkedList<>();

        if (event.getFailure() != null) {
            // print unused stubbings only when test succeeds to avoid reporting multiple problems
            // and confusing users
            new ArgMismatchFinder()
                    .getStubbingArgMismatches(createdMocks)
                    .format(event.getTestName(), logger);
        }
    }

    @Override
    public void onMockCreated(Object mock, MockCreationSettings settings) {
        this.mocks.add(mock);
    }
}