phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'pr-435'

Browse Source
This commit is contained in:
Juan Martín Sotuyo Dodero
2017-06-12 19:21:05 -03:00
parent 6d86d85479 53687afeb8
commit d53c0c2fe6
5 changed files with 84 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/junit/AbstractJUnitRule.java
View File

@ -23,32 +23,40 @@ import net.sourceforge.pmd.lang.java.typeresolution.TypeHelper;
public abstract class AbstractJUnitRule extends AbstractJavaRule {
public static final Class<?> JUNIT4_CLASS;
public static final Class<?> JUNIT3_CLASS;
private static final String JUNIT3_CLASS_NAME = "junit.framework.TestCase";
public static final Class<?> JUNIT4_CLASS;
private static final String JUNIT4_CLASS_NAME = "org.junit.Test";
public static final Class<?> JUNIT5_CLASS;
private static final String JUNIT5_CLASS_NAME = "org.junit.jupiter.api.Test";
private boolean isJUnit3Class;
private boolean isJUnit4Class;
private boolean isJUnit5Class;
static {
Class<?> c;
try {
c = Class.forName("org.junit.Test");
} catch (ClassNotFoundException t) {
c = Class.forName(JUNIT3_CLASS_NAME);
} catch (ClassNotFoundException | NoClassDefFoundError t) {
c = null;
} catch (NoClassDefFoundError t) {
}
JUNIT3_CLASS = c;
try {
c = Class.forName(JUNIT4_CLASS_NAME);
} catch (ClassNotFoundException | NoClassDefFoundError t) {
c = null;
}
JUNIT4_CLASS = c;
try {
c = Class.forName("junit.framework.TestCase");
} catch (ClassNotFoundException t) {
c = null;
} catch (NoClassDefFoundError t) {
c = Class.forName(JUNIT5_CLASS_NAME);
} catch (ClassNotFoundException | NoClassDefFoundError t) {
c = null;
}
JUNIT3_CLASS = c;
JUNIT5_CLASS = c;
}
@Override
@ -56,13 +64,19 @@ public abstract class AbstractJUnitRule extends AbstractJavaRule {
isJUnit3Class = false;
isJUnit4Class = false;
isJUnit5Class = false;
isJUnit3Class = isJUnit3Class(node);
if (!isJUnit3Class) {
isJUnit4Class = isJUnit4Class(node);
isJUnit5Class = isJUnit5Class(node);
}
if (isJUnit4Class && isJUnit5Class) {
isJUnit4Class &= hasImports(node, JUNIT4_CLASS_NAME);
isJUnit5Class &= hasImports(node, JUNIT5_CLASS_NAME);
}
if (!isTestNgClass(node) && (isJUnit3Class || isJUnit4Class)) {
if (!isTestNgClass(node) && (isJUnit3Class || isJUnit4Class || isJUnit5Class)) {
return super.visit(node, data);
}
return data;
@ -79,22 +93,31 @@ public abstract class AbstractJUnitRule extends AbstractJavaRule {
}
public boolean isJUnitMethod(ASTMethodDeclaration method, Object data) {
if (!method.isPublic() || method.isAbstract() || method.isNative() || method.isStatic()) {
if (method.isAbstract() || method.isNative() || method.isStatic()) {
return false; // skip various inapplicable method variations
}
if (!isJUnit5Class && !method.isPublic()) {
// junit5 class doesn't require test methods to be public anymore
return false;
}
boolean result = false;
if (isJUnit3Class) {
result = isJUnit3Method(method);
}
result |= isJUnit4Method(method);
result |= isJUnit5Method(method);
return result;
}
private boolean isJUnit4Method(ASTMethodDeclaration method) {
return doesNodeContainJUnitAnnotation(method.jjtGetParent());
return doesNodeContainJUnitAnnotation(method.jjtGetParent(), JUNIT4_CLASS, JUNIT4_CLASS_NAME);
}
private boolean isJUnit5Method(ASTMethodDeclaration method) {
return doesNodeContainJUnitAnnotation(method.jjtGetParent(), JUNIT5_CLASS, JUNIT5_CLASS_NAME);
}
private boolean isJUnit3Method(ASTMethodDeclaration method) {
@ -106,14 +129,14 @@ public abstract class AbstractJUnitRule extends AbstractJavaRule {
}
private boolean isJUnit3Class(ASTCompilationUnit node) {
ASTClassOrInterfaceDeclaration cid = node.getFirstDescendantOfType(ASTClassOrInterfaceDeclaration.class);
if (cid == null) {
return false;
}
if (node.getType() != null && TypeHelper.isA(node, JUNIT3_CLASS)) {
return true;
} else if (node.getType() == null) {
ASTClassOrInterfaceDeclaration cid = node.getFirstDescendantOfType(ASTClassOrInterfaceDeclaration.class);
if (cid == null) {
return false;
}
ASTExtendsList extendsList = cid.getFirstChildOfType(ASTExtendsList.class);
if (extendsList == null) {
return false;
@ -123,25 +146,42 @@ public abstract class AbstractJUnitRule extends AbstractJavaRule {
}
String className = cid.getImage();
return className.endsWith("Test");
} else if (hasImports(node, JUNIT3_CLASS_NAME)) {
return cid.getImage().endsWith("Test");
}
return false;
}
private boolean isJUnit4Class(ASTCompilationUnit node) {
return doesNodeContainJUnitAnnotation(node);
return doesNodeContainJUnitAnnotation(node, JUNIT4_CLASS, JUNIT4_CLASS_NAME);
}
private boolean doesNodeContainJUnitAnnotation(Node node) {
private boolean isJUnit5Class(ASTCompilationUnit node) {
return doesNodeContainJUnitAnnotation(node, JUNIT5_CLASS, JUNIT5_CLASS_NAME);
}
private boolean doesNodeContainJUnitAnnotation(Node node, Class<?> annotationTypeClass, String annotationTypeClassName) {
List<ASTAnnotation> annotations = node.findDescendantsOfType(ASTAnnotation.class);
for (ASTAnnotation annotation : annotations) {
Node annotationTypeNode = annotation.jjtGetChild(0);
TypeNode annotationType = (TypeNode) annotationTypeNode;
if (annotationType.getType() == null) {
ASTName name = annotationTypeNode.getFirstChildOfType(ASTName.class);
if (name != null && "Test".equals(name.getImage())) {
if (name != null && (name.hasImageEqualTo("Test") || name.hasImageEqualTo(annotationTypeClassName))) {
return true;
}
} else if (annotationType.getType().equals(JUNIT4_CLASS)) {
} else if (annotationType.getType().equals(annotationTypeClass)) {
return true;
}
}
return false;
}
private boolean hasImports(ASTCompilationUnit cu, String className) {
List<ASTImportDeclaration> imports = cu.findDescendantsOfType(ASTImportDeclaration.class);
for (ASTImportDeclaration importDeclaration : imports) {
ASTName name = importDeclaration.getFirstChildOfType(ASTName.class);
if (name != null && name.hasImageEqualTo(className)) {
return true;
}
}

1
pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/junit/xml/JUnitTestsShouldIncludeAssert.xml
View File

@ -332,6 +332,7 @@ public class BaseConsoleTest extends UART {
<description>#330 NPE accessing local field / method with this.XXX</description>
<expected-problems>1</expected-problems>
<code><![CDATA[
import org.junit.Test;
public class Foo {
@Test
public void testName() {

14
pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/junit/xml/TestClassWithoutTestCases.xml
View File

@ -116,4 +116,18 @@ public class MyTest extends YourTest {
}
]]></code>
</test-code>
<test-code>
<description>#428 [java] PMD requires public modifier on JUnit 5 test</description>
<expected-problems>0</expected-problems>
<code><![CDATA[
import org.junit.jupiter.api.Test;
class JUnit5Test {
@Test
void myTest() {
}
}
]]></code>
</test-code>
</test-data>

1
pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/migrating/xml/JUnitUseExpected.xml
View File

@ -7,6 +7,7 @@ JUnit 4 - Contains assert
<expected-problems>1</expected-problems>
<code><![CDATA[
import java.lang.Thread;
import org.junit.Test;
public class Foo {
@Test
public void foo() throws Throwable {