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 2018 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.collect.Streams.findLast;
import static com.google.errorprone.BugPattern.SeverityLevel.ERROR;
import static com.google.errorprone.matchers.Description.NO_MATCH;
import static com.google.errorprone.matchers.method.MethodMatchers.instanceMethod;
import static com.google.errorprone.util.ASTHelpers.getSymbol;
import static com.google.errorprone.util.ASTHelpers.streamReceivers;
import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;
import com.google.errorprone.BugPattern;
import com.google.errorprone.VisitorState;
import com.google.errorprone.bugpatterns.BugChecker.MethodTreeMatcher;
import com.google.errorprone.matchers.Description;
import com.google.errorprone.matchers.Matcher;
import com.sun.source.tree.ExpressionTree;
import com.sun.source.tree.IdentifierTree;
import com.sun.source.tree.MethodInvocationTree;
import com.sun.source.tree.MethodTree;
import com.sun.source.tree.ReturnTree;
import com.sun.source.util.TreePathScanner;
import com.sun.tools.javac.code.Symbol;
import java.util.HashSet;
import java.util.Set;
import javax.annotation.Nullable;
import javax.lang.model.element.ElementKind;
/**
* Matches test helpers which require a terminating method to be called.
*
* @author [email protected] (Graeme Morgan)
*/
@BugPattern(
name = "MissingTestCall",
summary = "A terminating method call is required for a test helper to have any effect.",
severity = ERROR)
public final class MissingTestCall extends BugChecker implements MethodTreeMatcher {
private static final ImmutableSet PAIRINGS =
ImmutableSet.of(
MethodPairing.of(
"EqualsTester",
instanceMethod()
.onDescendantOf("com.google.common.testing.EqualsTester")
.named("addEqualityGroup"),
instanceMethod()
.onDescendantOf("com.google.common.testing.EqualsTester")
.named("testEquals")),
MethodPairing.of(
"BugCheckerRefactoringTestHelper",
instanceMethod()
.onDescendantOf("com.google.errorprone.BugCheckerRefactoringTestHelper")
.namedAnyOf(
"addInput",
"addInputLines",
"addInputFile",
"addOutput",
"addOutputLines",
"addOutputFile",
"expectUnchanged"),
instanceMethod()
.onDescendantOf("com.google.errorprone.BugCheckerRefactoringTestHelper")
.named("doTest")),
MethodPairing.of(
"CompilationTestHelper",
instanceMethod()
.onDescendantOf("com.google.errorprone.CompilationTestHelper")
.namedAnyOf("addSourceLines", "addSourceFile", "expectNoDiagnostics"),
instanceMethod()
.onDescendantOf("com.google.errorprone.CompilationTestHelper")
.named("doTest")));
@Override
public Description matchMethod(MethodTree tree, VisitorState state) {
ImmutableSet pairings = PAIRINGS;
Set required = new HashSet<>();
Set called = new HashSet<>();
new TreePathScanner() {
@Override
public Void visitMethodInvocation(MethodInvocationTree node, Void unused) {
for (MethodPairing pairing : pairings) {
VisitorState stateWithPath = state.withPath(getCurrentPath());
if (pairing.ifCall().matches(node, stateWithPath)) {
if (!isField(getUltimateReceiver(node))
&& stateWithPath.findPathToEnclosing(ReturnTree.class) == null) {
required.add(pairing);
}
}
if (pairing.mustCall().matches(node, stateWithPath)) {
called.add(pairing);
}
}
return super.visitMethodInvocation(node, null);
}
}.scan(state.getPath(), null);
return Sets.difference(required, called).stream()
.findFirst()
.map(
p ->
buildDescription(tree)
.setMessage(
String.format(
"%s requires a terminating method call to have any effect.", p.name()))
.build())
.orElse(NO_MATCH);
}
@Nullable
private static ExpressionTree getUltimateReceiver(ExpressionTree tree) {
return findLast(streamReceivers(tree)).orElse(null);
}
private static boolean isField(@Nullable ExpressionTree tree) {
if (!(tree instanceof IdentifierTree)) {
return false;
}
Symbol symbol = getSymbol(tree);
return symbol != null && symbol.getKind() == ElementKind.FIELD;
}
@AutoValue
abstract static class MethodPairing {
abstract String name();
abstract Matcher ifCall();
abstract Matcher mustCall();
private static MethodPairing of(
String name, Matcher ifCall, Matcher mustCall) {
return new AutoValue_MissingTestCall_MethodPairing(name, ifCall, mustCall);
}
}
}
