JUnit3TestNotRun.java

/*
 * Copyright 2013 The Error Prone Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.errorprone.bugpatterns;

import static com.google.common.base.Ascii.toUpperCase;
import static com.google.errorprone.BugPattern.SeverityLevel.ERROR;
import static com.google.errorprone.fixes.SuggestedFixes.addModifiers;
import static com.google.errorprone.fixes.SuggestedFixes.removeModifiers;
import static com.google.errorprone.fixes.SuggestedFixes.renameMethod;
import static com.google.errorprone.matchers.Description.NO_MATCH;
import static com.google.errorprone.matchers.JUnitMatchers.isJUnit3TestClass;
import static com.google.errorprone.matchers.JUnitMatchers.isJunit3TestCase;
import static com.google.errorprone.matchers.JUnitMatchers.wouldRunInJUnit4;
import static com.google.errorprone.matchers.Matchers.allOf;
import static com.google.errorprone.matchers.Matchers.anyOf;
import static com.google.errorprone.matchers.Matchers.enclosingClass;
import static com.google.errorprone.matchers.Matchers.hasModifier;
import static com.google.errorprone.matchers.Matchers.methodHasNoParameters;
import static com.google.errorprone.matchers.Matchers.methodReturns;
import static com.google.errorprone.matchers.Matchers.not;
import static com.google.errorprone.suppliers.Suppliers.VOID_TYPE;
import static com.google.errorprone.util.ASTHelpers.findSuperMethods;
import static com.google.errorprone.util.ASTHelpers.getSymbol;

import com.google.common.collect.ImmutableSet;
import com.google.errorprone.BugPattern;
import com.google.errorprone.VisitorState;
import com.google.errorprone.bugpatterns.BugChecker.CompilationUnitTreeMatcher;
import com.google.errorprone.fixes.SuggestedFix;
import com.google.errorprone.matchers.Description;
import com.google.errorprone.matchers.Matcher;
import com.sun.source.tree.CompilationUnitTree;
import com.sun.source.tree.MethodInvocationTree;
import com.sun.source.tree.MethodTree;
import com.sun.source.util.TreeScanner;
import com.sun.tools.javac.code.Symbol.MethodSymbol;
import java.util.Optional;
import java.util.regex.Pattern;
import javax.lang.model.element.Modifier;

/** A bugpattern; see the associated summary. */
@BugPattern(
    summary =
        "Test method will not be run; please correct method signature "
            + "(Should be public, non-static, and method name should begin with \"test\").",
    severity = ERROR)
public final class JUnit3TestNotRun extends BugChecker implements CompilationUnitTreeMatcher {

  /**
   * Regular expression for test method name that is misspelled and should be replaced with "test".
   * ".est" and "est" are omitted, because they catch real words like "restore", "destroy", "best",
   * "establish". ".test" is omitted, because people use it on purpose, to disable the test.
   * Otherwise, I haven't found any false positives; "tes" was most common typo. There are some
   * ambiguities in this regex that lead to bad corrections (i.e. tets -> tests, tesst -> testst),
   * but the error is still found (those could be improved with regex lookahead, but I prefer
   * simpler regex). TODO(rburny): see if we can cleanup intentional ".test" misspellings
   */
  private static final Pattern MISSPELLED_NAME =
      Pattern.compile(
          "t.est|te.st|"
              + // letter inserted
              "tst|tet|tes|"
              + // letter removed
              "etst|tset|tets|"
              + // letters swapped
              "t.st|te.t|"
              + // letter changed
              "[tT][eE][sS][tT]" // miscapitalized
          );

  private static final Matcher<MethodTree> LOOKS_LIKE_TEST_CASE =
      allOf(
          enclosingClass(isJUnit3TestClass),
          not(isJunit3TestCase),
          anyOf(methodHasNoParameters(), hasModifier(Modifier.PUBLIC)),
          enclosingClass((t, s) -> !getSymbol(t).getSimpleName().toString().endsWith("Base")),
          methodReturns(VOID_TYPE));

  @Override
  public Description matchCompilationUnit(CompilationUnitTree unused, VisitorState state) {
    ImmutableSet<MethodSymbol> calledMethods = calledMethods(state);
    new SuppressibleTreePathScanner<Void, Void>(state) {
      @Override
      public Void visitMethod(MethodTree tree, Void unused) {
        checkMethod(tree, calledMethods, state.withPath(getCurrentPath()))
            .ifPresent(state::reportMatch);
        return super.visitMethod(tree, null);
      }
    }.scan(state.getPath(), null);
    return NO_MATCH;
  }

  private static ImmutableSet<MethodSymbol> calledMethods(VisitorState state) {
    ImmutableSet.Builder<MethodSymbol> calledMethods = ImmutableSet.builder();
    new TreeScanner<Void, Void>() {
      @Override
      public Void visitMethodInvocation(MethodInvocationTree tree, Void unused) {
        calledMethods.add(getSymbol(tree));
        return super.visitMethodInvocation(tree, null);
      }
    }.scan(state.getPath().getCompilationUnit(), null);
    return calledMethods.build();
  }

  /**
   * Matches iff:
   *
   * <ul>
   *   <li>Method's name begins with misspelled variation of "test".
   *   <li>Method is public, returns void, and has no parameters.
   *   <li>Enclosing class is JUnit3 test (extends TestCase, has no {@code @RunWith} annotation, no
   *       {@code @Test}-annotated methods, and is not abstract).
   * </ul>
   */
  public Optional<Description> checkMethod(
      MethodTree methodTree, ImmutableSet<MethodSymbol> calledMethods, VisitorState state) {
    if (calledMethods.contains(getSymbol(methodTree))) {
      return Optional.empty();
    }
    if (!LOOKS_LIKE_TEST_CASE.matches(methodTree, state)) {
      return Optional.empty();
    }
    if (!findSuperMethods(getSymbol(methodTree), state.getTypes()).isEmpty()) {
      return Optional.empty();
    }

    SuggestedFix.Builder fix = SuggestedFix.builder();

    String methodName = methodTree.getName().toString();
    if (!methodName.startsWith("test")) {
      var matcher = MISSPELLED_NAME.matcher(methodName);
      String fixedName;
      if (matcher.lookingAt()) {
        fixedName = matcher.replaceFirst("test");
      } else if (wouldRunInJUnit4.matches(methodTree, state)) {
        fixedName = "test" + toUpperCase(methodName.substring(0, 1)) + methodName.substring(1);
      } else {
        return Optional.empty();
      }
      fix.merge(renameMethod(methodTree, fixedName, state));
    }

    addModifiers(methodTree, state, Modifier.PUBLIC).ifPresent(fix::merge);
    removeModifiers(methodTree, state, Modifier.PRIVATE, Modifier.PROTECTED).ifPresent(fix::merge);
    // N.B. must occur in separate step because removeModifiers only removes one modifier at a time.
    removeModifiers(methodTree, state, Modifier.STATIC).ifPresent(fix::merge);

    return Optional.of(describeMatch(methodTree, fix.build()));
  }
}