tech.picnic.errorprone.refasterrules.MockitoRules Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of error-prone-contrib Show documentation

Extra Error Prone plugins by Picnic.

There is a newer version: 0.19.1

package tech.picnic.errorprone.refasterrules;

import static com.google.errorprone.refaster.ImportPolicy.STATIC_IMPORT_ALWAYS;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;

import com.google.errorprone.refaster.Refaster;
import com.google.errorprone.refaster.annotation.AfterTemplate;
import com.google.errorprone.refaster.annotation.BeforeTemplate;
import com.google.errorprone.refaster.annotation.UseImportPolicy;
import org.mockito.Mockito;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.verification.VerificationMode;
import tech.picnic.errorprone.refaster.annotation.OnlineDocumentation;

/** Refaster rules related to Mockito expressions and statements. */
@OnlineDocumentation
final class MockitoRules {
  private MockitoRules() {}

  /**
   * Prefer {@link Mockito#never()}} over explicitly specifying that the associated invocation must
   * happen precisely zero times.
   */
  static final class Never {
    @BeforeTemplate
    VerificationMode before() {
      return times(0);
    }

    @AfterTemplate
    @UseImportPolicy(STATIC_IMPORT_ALWAYS)
    VerificationMode after() {
      return never();
    }
  }

  /**
   * Prefer {@link Mockito#verify(Object)} over explicitly specifying that the associated invocation
   * must happen precisely once; this is the default behavior.
   */
  static final class VerifyOnce {
    @BeforeTemplate
    T before(T mock) {
      return verify(mock, times(1));
    }

    @AfterTemplate
    @UseImportPolicy(STATIC_IMPORT_ALWAYS)
    T after(T mock) {
      return verify(mock);
    }
  }

  static final class InvocationOnMockGetArguments {
    @BeforeTemplate
    Object before(InvocationOnMock invocation, int i) {
      return invocation.getArguments()[i];
    }

    @AfterTemplate
    Object after(InvocationOnMock invocation, int i) {
      return invocation.getArgument(i);
    }
  }

  static final class InvocationOnMockGetArgumentsWithTypeParameter {
    @BeforeTemplate
    @SuppressWarnings("unchecked")
    T before(InvocationOnMock invocation, int i) {
      return Refaster.anyOf(
          invocation.getArgument(i, Refaster.clazz()), (T) invocation.getArgument(i));
    }

    @AfterTemplate
    T after(InvocationOnMock invocation, int i) {
      return invocation.getArgument(i);
    }
  }
}