org.mockito.internal.junit.DefaultStubbingLookupListener Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mockito-core Show documentation
Show all versions of mockito-core Show documentation
Mockito mock objects library core API and implementation
/*
* Copyright (c) 2017 Mockito contributors
* This program is made available under the terms of the MIT License.
*/
package org.mockito.internal.junit;
import static org.mockito.internal.stubbing.StrictnessSelector.determineStrictness;
import java.io.Serializable;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import java.util.Objects;
import org.mockito.internal.exceptions.Reporter;
import org.mockito.internal.stubbing.UnusedStubbingReporting;
import org.mockito.invocation.Invocation;
import org.mockito.listeners.StubbingLookupEvent;
import org.mockito.listeners.StubbingLookupListener;
import org.mockito.quality.Strictness;
import org.mockito.stubbing.Stubbing;
/**
* Default implementation of stubbing lookup listener.
* Fails early if stub called with unexpected arguments, but only if current strictness is set to STRICT_STUBS.
*/
class DefaultStubbingLookupListener implements StubbingLookupListener, Serializable {
private static final long serialVersionUID = -6789800638070123629L;
private Strictness currentStrictness;
private boolean mismatchesReported;
DefaultStubbingLookupListener(Strictness strictness) {
this.currentStrictness = strictness;
}
@Override
public void onStubbingLookup(StubbingLookupEvent event) {
Strictness actualStrictness =
determineStrictness(
event.getStubbingFound(), event.getMockSettings(), currentStrictness);
if (actualStrictness != Strictness.STRICT_STUBS) {
return;
}
if (event.getStubbingFound() == null) {
// If stubbing was not found for invocation it means that either the mock invocation was
// not stubbed or
// we have a stubbing arg mismatch.
List argMismatchStubbings =
potentialArgMismatches(event.getInvocation(), event.getAllStubbings());
if (!argMismatchStubbings.isEmpty()) {
mismatchesReported = true;
Reporter.potentialStubbingProblem(event.getInvocation(), argMismatchStubbings);
}
} else {
// when strict stubs are in use, every time a stub is realized in the code it is
// implicitly marked as verified
// this way, the users don't have to repeat themselves to verify stubbed invocations
// (DRY)
event.getInvocation().markVerified();
}
}
private static List potentialArgMismatches(
Invocation invocation, Collection stubbings) {
List matchingStubbings = new LinkedList<>();
for (Stubbing s : stubbings) {
if (UnusedStubbingReporting.shouldBeReported(s)
&& Objects.equals(
s.getInvocation().getMethod().getName(),
invocation.getMethod().getName())
// If stubbing and invocation are in the same source file we assume they are in
// the test code,
// and we don't flag it as mismatch:
&& !Objects.equals(
s.getInvocation().getLocation().getSourceFile(),
invocation.getLocation().getSourceFile())) {
matchingStubbings.add(s.getInvocation());
}
}
return matchingStubbings;
}
/**
* Enables resetting the strictness to desired level
*/
void setCurrentStrictness(Strictness currentStrictness) {
this.currentStrictness = currentStrictness;
}
/**
* Indicates that stubbing argument mismatch was reported
*/
boolean isMismatchesReported() {
return mismatchesReported;
}
}