Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* 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.errorprone.BugPattern.SeverityLevel.ERROR;
import static com.google.errorprone.matchers.Description.NO_MATCH;
import static com.google.errorprone.matchers.JUnitMatchers.containsTestMethod;
import static com.google.errorprone.matchers.JUnitMatchers.isJUnit4TestClass;
import static com.google.errorprone.matchers.JUnitMatchers.isJunit3TestCase;
import static com.google.errorprone.matchers.Matchers.allOf;
import static com.google.errorprone.matchers.Matchers.hasModifier;
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.getSymbol;
import static com.google.errorprone.util.ASTHelpers.getType;
import static com.google.errorprone.util.ASTHelpers.isSameType;
import static javax.lang.model.element.Modifier.PUBLIC;
import static javax.lang.model.element.Modifier.STATIC;
import com.google.errorprone.BugPattern;
import com.google.errorprone.VisitorState;
import com.google.errorprone.bugpatterns.BugChecker.ClassTreeMatcher;
import com.google.errorprone.fixes.SuggestedFix;
import com.google.errorprone.fixes.SuggestedFixes;
import com.google.errorprone.matchers.Description;
import com.google.errorprone.matchers.JUnitMatchers;
import com.google.errorprone.matchers.Matcher;
import com.google.errorprone.suppliers.Supplier;
import com.google.errorprone.suppliers.Suppliers;
import com.sun.source.tree.AnnotationTree;
import com.sun.source.tree.ClassTree;
import com.sun.source.tree.MethodInvocationTree;
import com.sun.source.tree.MethodTree;
import com.sun.source.tree.Tree;
import com.sun.source.util.TreeScanner;
import com.sun.tools.javac.code.Symbol.MethodSymbol;
import com.sun.tools.javac.code.Type;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.lang.model.element.Modifier;
/** @author [email protected] (Eddie Aftandilian) */
@BugPattern(
name = "JUnit4TestNotRun",
summary =
"This looks like a test method but is not run; please add @Test and @Ignore, or, if this"
+ " is a helper method, reduce its visibility.",
severity = ERROR)
public class JUnit4TestNotRun extends BugChecker implements ClassTreeMatcher {
private static final String TEST_CLASS = "org.junit.Test";
private static final String IGNORE_CLASS = "org.junit.Ignore";
private static final String TEST_ANNOTATION = "@Test ";
private static final String IGNORE_ANNOTATION = "@Ignore ";
private final Matcher possibleTestMethod =
allOf(
hasModifier(PUBLIC),
methodReturns(VOID_TYPE),
(t, s) ->
t.getParameters().stream()
.allMatch(
v ->
v.getModifiers().getAnnotations().stream()
.anyMatch(a -> isParameterAnnotation(a, s))),
not(JUnitMatchers::hasJUnitAnnotation));
private boolean isParameterAnnotation(AnnotationTree annotation, VisitorState state) {
Type annotationType = getType(annotation);
if (isSameType(annotationType, FROM_DATA_POINTS.get(state), state)) {
return true;
}
return false;
}
private static final Supplier FROM_DATA_POINTS =
Suppliers.typeFromString("org.junit.experimental.theories.FromDataPoints");
private static final Matcher NOT_STATIC = not(hasModifier(STATIC));
@Override
public Description matchClass(ClassTree tree, VisitorState state) {
if (!isJUnit4TestClass.matches(tree, state)) {
return NO_MATCH;
}
Map suspiciousMethods = new HashMap<>();
for (Tree member : tree.getMembers()) {
if (!(member instanceof MethodTree) || isSuppressed(member)) {
continue;
}
MethodTree methodTree = (MethodTree) member;
if (possibleTestMethod.matches(methodTree, state) && !isSuppressed(tree)) {
suspiciousMethods.put(getSymbol(methodTree), methodTree);
}
}
if (suspiciousMethods.isEmpty()) {
return NO_MATCH;
}
tree.accept(
new TreeScanner() {
@Override
public Void visitMethodInvocation(
MethodInvocationTree methodInvocationTree, Void unused) {
suspiciousMethods.remove(getSymbol(methodInvocationTree));
return super.visitMethodInvocation(methodInvocationTree, null);
}
},
null);
for (MethodTree methodTree : suspiciousMethods.values()) {
handleMethod(methodTree, state).ifPresent(state::reportMatch);
}
return NO_MATCH;
}
/**
* Matches if:
*
*
*
The method is public, void, and has no parameters;
*
the method is not already annotated with {@code @Test}, {@code @Before}, {@code @After},
* {@code @BeforeClass}, or {@code @AfterClass};
*
and, the method appears to be a test method, that is:
*
*
The method is named like a JUnit 3 test case,
*
or, the method body contains a method call with a name that contains "assert",
* "verify", "check", "fail", or "expect".
*
*
*
* Assumes that we have reason to believe we're in a test class (i.e. has a {@code RunWith}
* annotation; has other {@code @Test} methods, etc).
*/
private Optional handleMethod(MethodTree methodTree, VisitorState state) {
// Method appears to be a JUnit 3 test case (name prefixed with "test"), probably a test.
if (isJunit3TestCase.matches(methodTree, state)) {
return Optional.of(describeFixes(methodTree, state));
}
// Method is annotated, probably not a test.
List annotations = methodTree.getModifiers().getAnnotations();
if (annotations != null && !annotations.isEmpty()) {
return Optional.empty();
}
// Method non-static and contains call(s) to testing method, probably a test,
// unless it is called elsewhere in the class, in which case it is a helper method.
if (NOT_STATIC.matches(methodTree, state) && containsTestMethod(methodTree)) {
return Optional.of(describeFixes(methodTree, state));
}
return Optional.empty();
}
/**
* Returns a finding for the given method tree containing fixes:
*
*
*
Add @Test, remove static modifier if present.
*
Add @Test and @Ignore, remove static modifier if present.
*
Change visibility to private (for local helper methods).
*
