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

Cleaned up one method

Browse Source
This commit is contained in:
Clément Fournier
2017-03-23 18:34:39 +01:00
committed by Juan Martín Sotuyo Dodero
parent f644aa5744
commit 38d3f4f67f
1 changed files with 94 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

192
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/junit/JUnitTestsShouldIncludeAssertRule.java
View File

@ -1,98 +1,94 @@
/**
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/
package net.sourceforge.pmd.lang.java.rule.junit;
import java.util.List;
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.java.ast.ASTClassOrInterfaceDeclaration;
import net.sourceforge.pmd.lang.java.ast.ASTMemberValuePair;
import net.sourceforge.pmd.lang.java.ast.ASTMethodDeclaration;
import net.sourceforge.pmd.lang.java.ast.ASTName;
import net.sourceforge.pmd.lang.java.ast.ASTNormalAnnotation;
import net.sourceforge.pmd.lang.java.ast.ASTPrimaryExpression;
import net.sourceforge.pmd.lang.java.ast.ASTPrimaryPrefix;
import net.sourceforge.pmd.lang.java.ast.ASTStatementExpression;
public class JUnitTestsShouldIncludeAssertRule extends AbstractJUnitRule {
@Override
public Object visit(ASTClassOrInterfaceDeclaration node, Object data) {
if (node.isInterface()) {
return data;
}
return super.visit(node, data);
}
@Override
public Object visit(ASTMethodDeclaration method, Object data) {
if (isJUnitMethod(method, data)) {
if (!containsAssert(method.getBlock(), false) && !containsExpect(method.jjtGetParent())) {
addViolation(data, method);
}
}
return data;
}
private boolean containsAssert(Node n, boolean assertFound) {
if (!assertFound) {
if (n instanceof ASTStatementExpression) {
if (isAssertOrFailStatement((ASTStatementExpression) n)) {
return true;
}
}
if (!assertFound) {
for (int i = 0; i < n.jjtGetNumChildren() && !assertFound; i++) {
Node c = n.jjtGetChild(i);
if (containsAssert(c, assertFound)) {
return true;
}
}
}
}
return false;
}
/**
* Tells if the node contains a Test annotation with an expected exception.
*/
private boolean containsExpect(Node methodParent) {
List<ASTNormalAnnotation> annotations = methodParent.findDescendantsOfType(ASTNormalAnnotation.class);
for (ASTNormalAnnotation annotation : annotations) {
ASTName name = annotation.getFirstChildOfType(ASTName.class);
if (name != null
&& ("Test".equals(name.getImage()) || name.getType() != null && name.getType().equals(JUNIT4_CLASS))) {
List<ASTMemberValuePair> memberValues = annotation.findDescendantsOfType(ASTMemberValuePair.class);
for (ASTMemberValuePair pair : memberValues) {
if ("expected".equals(pair.getImage())) {
return true;
}
}
}
}
return false;
}
/**
* Tells if the expression is an assert statement or not.
*/
private boolean isAssertOrFailStatement(ASTStatementExpression expression) {
if (expression != null && expression.jjtGetNumChildren() > 0
&& expression.jjtGetChild(0) instanceof ASTPrimaryExpression) {
ASTPrimaryExpression pe = (ASTPrimaryExpression) expression.jjtGetChild(0);
if (pe.jjtGetNumChildren() > 0 && pe.jjtGetChild(0) instanceof ASTPrimaryPrefix) {
ASTPrimaryPrefix pp = (ASTPrimaryPrefix) pe.jjtGetChild(0);
if (pp.jjtGetNumChildren() > 0 && pp.jjtGetChild(0) instanceof ASTName) {
String img = ((ASTName) pp.jjtGetChild(0)).getImage();
if (img != null
&& (img.startsWith("assert") || img.startsWith("fail") || img.startsWith("Assert.assert") || img
.startsWith("Assert.fail"))) {
return true;
}
}
}
}
return false;
}
}
/**
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/
package net.sourceforge.pmd.lang.java.rule.junit;
import java.util.List;
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.java.ast.ASTClassOrInterfaceDeclaration;
import net.sourceforge.pmd.lang.java.ast.ASTMemberValuePair;
import net.sourceforge.pmd.lang.java.ast.ASTMethodDeclaration;
import net.sourceforge.pmd.lang.java.ast.ASTName;
import net.sourceforge.pmd.lang.java.ast.ASTNormalAnnotation;
import net.sourceforge.pmd.lang.java.ast.ASTPrimaryExpression;
import net.sourceforge.pmd.lang.java.ast.ASTStatementExpression;
public class JUnitTestsShouldIncludeAssertRule extends AbstractJUnitRule {
@Override
public Object visit(ASTClassOrInterfaceDeclaration node, Object data) {
if (node.isInterface()) {
return data;
}
return super.visit(node, data);
}
@Override
public Object visit(ASTMethodDeclaration method, Object data) {
if (isJUnitMethod(method, data)) {
if (!containsAssert(method.getBlock(), false) && !containsExpect(method.jjtGetParent())) {
addViolation(data, method);
}
}
return data;
}
private boolean containsAssert(Node n, boolean assertFound) {
if (!assertFound) {
if (n instanceof ASTStatementExpression) {
if (isAssertOrFailStatement((ASTStatementExpression) n)) {
return true;
}
}
if (!assertFound) {
for (int i = 0; i < n.jjtGetNumChildren() && !assertFound; i++) {
Node c = n.jjtGetChild(i);
if (containsAssert(c, assertFound)) {
return true;
}
}
}
}
return false;
}
/**
* Tells if the node contains a Test annotation with an expected exception.
*/
private boolean containsExpect(Node methodParent) {
List<ASTNormalAnnotation> annotations = methodParent.findDescendantsOfType(ASTNormalAnnotation.class);
for (ASTNormalAnnotation annotation : annotations) {
ASTName name = annotation.getFirstChildOfType(ASTName.class);
if (name != null && ("Test".equals(name.getImage())
|| name.getType() != null && name.getType().equals(JUNIT4_CLASS))) {
List<ASTMemberValuePair> memberValues = annotation.findDescendantsOfType(ASTMemberValuePair.class);
for (ASTMemberValuePair pair : memberValues) {
if ("expected".equals(pair.getImage())) {
return true;
}
}
}
}
return false;
}
/**
* Tells if the expression is an assert statement or not.
*/
private boolean isAssertOrFailStatement(ASTStatementExpression expression) {
if (expression != null) {
ASTPrimaryExpression pe = expression.getFirstChildOfType(ASTPrimaryExpression.class);
if (pe != null) {
String img = pe.jjtGetChild(0).jjtGetChild(0).getImage();
if (img != null && (img.startsWith("assert") || img.startsWith("fail")
|| img.startsWith("Assert.assert") || img.startsWith("Assert.fail"))) {
return true;
}
}
}
return false;
}
}