Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add check to ensure junit5 tests are not used with junit4 Rule/ClassRule #714

Merged
merged 3 commits into from
Jul 31, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
/*
* (c) Copyright 2019 Palantir Technologies Inc. All rights reserved.
*
* 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.palantir.baseline.errorprone;

import com.google.auto.service.AutoService;
import com.google.errorprone.BugPattern;
import com.google.errorprone.VisitorState;
import com.google.errorprone.bugpatterns.BugChecker;
import com.google.errorprone.matchers.Description;
import com.google.errorprone.matchers.Matcher;
import com.google.errorprone.matchers.Matchers;
import com.google.errorprone.util.ASTHelpers;
import com.sun.source.tree.ClassTree;
import com.sun.source.tree.VariableTree;
import com.sun.tools.javac.code.Symbol;

@AutoService(BugChecker.class)
@BugPattern(
name = "Junit5RuleUsage",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JUnit5RuleUsage

severity = BugPattern.SeverityLevel.ERROR,
summary = "Using Rule/ClassRules in Junit5 tests results in the rules silently not executing")
public final class Junit5RuleUsage extends BugChecker implements BugChecker.ClassTreeMatcher {
private static final String JUNIT4_RULE = "org.junit.Rule";
private static final String JUNIT4_CLASS_RULE = "org.junit.ClassRule";
private static final String JUNIT5_TEST_ANNOTATION = "org.junit.jupiter.api.Test";

private static final Matcher<ClassTree> hasJunit5TestCases =
Matchers.hasMethod(Matchers.hasAnnotationOnAnyOverriddenMethod(JUNIT5_TEST_ANNOTATION));

private static final Matcher<ClassTree> hasJunit4Rules = hasVariable(
Matchers.anyOf(hasAnnotationOnVariable(JUNIT4_CLASS_RULE), hasAnnotationOnVariable(JUNIT4_RULE)));

@Override
public Description matchClass(ClassTree tree, VisitorState state) {
if (hasJunit5TestCases.matches(tree, state) && hasJunit4Rules.matches(tree, state)) {
return buildDescription(tree)
.setMessage("Do not use Rule/ClassRule with junit-jupiter")
.build();
}

return Description.NO_MATCH;
}

static Matcher<ClassTree> hasVariable(Matcher<VariableTree> matcher) {
return (classTree, state) -> classTree.getMembers().stream()
.filter(tree -> tree instanceof VariableTree)
.anyMatch(tree -> matcher.matches((VariableTree) tree, state));
}

static Matcher<VariableTree> hasAnnotationOnVariable(String annotation) {
return (variableTree, state) -> {
Symbol.VarSymbol sym = ASTHelpers.getSymbol(variableTree);
return sym != null && ASTHelpers.hasAnnotation(sym, annotation, state);
};
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
/*
* (c) Copyright 2019 Palantir Technologies Inc. All rights reserved.
*
* 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.palantir.baseline.errorprone;

import com.google.errorprone.CompilationTestHelper;
import org.junit.Before;
import org.junit.Test;

public class Junit5RuleUsageTest {

private CompilationTestHelper compilationHelper;

@Before
public void before() {
compilationHelper = CompilationTestHelper.newInstance(Junit5RuleUsage.class, getClass());
}

@Test
public void test_rule_with_junit5() {
compilationHelper.addSourceLines(
"TestCase.java",
"import org.junit.Rule;",
"import org.junit.jupiter.api.Test;",
"// BUG: Diagnostic contains: Do not use Rule/ClassRule",
"class TestCase {",
"@Rule public int foo = 1;",
"@Test",
"public void test() { }",
"}")
.doTest();
}

@Test
public void test_classrule_with_junit5() {
compilationHelper.addSourceLines(
"TestCase.java",
"import org.junit.ClassRule;",
"import org.junit.jupiter.api.Test;",
"// BUG: Diagnostic contains: Do not use Rule/ClassRule",
"class TestCase {",
"@ClassRule public static int foo = 1;",
"@Test",
"public void test() { }",
"}")
.doTest();
}

@Test
public void test_rule_with_junit4() {
compilationHelper.addSourceLines(
"TestCase.java",
"import org.junit.Rule;",
"import org.junit.Test;",
"class TestCase {",
"@Rule public static int foo = 1;",
"@Test",
"public void test() { }",
"}")
.doTest();
}
}