org.codenarc.rule.junit.JUnitSetUpCallsSuperRule.groovy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of CodeNarc Show documentation
Show all versions of CodeNarc Show documentation
The CodeNarc project provides a static analysis tool for Groovy code.
/*
* Copyright 2009 the original author or 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 org.codenarc.rule.junit
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.AstUtil
/**
* Rule that checks that if the JUnit setUp() method is defined, that it includes a call to
* super.setUp().
*
* This rule sets the default value of applyToFilesMatching to only match source code file
* paths ending in 'Test.groovy' or 'Tests.groovy'.
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class JUnitSetUpCallsSuperRule extends AbstractAstVisitorRule {
String name = 'JUnitSetUpCallsSuper'
int priority = 2
Class astVisitorClass = JUnitSetUpCallsSuperAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class JUnitSetUpCallsSuperAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode methodNode) {
if (JUnitUtil.isSetUpMethod(methodNode)) {
def statements = methodNode.code.statements
def found = statements.find { stmt ->
AstUtil.isMethodCall(stmt, 'super', 'setUp', 0)
}
if (!found) {
addViolation(methodNode, 'The method setUp() does not call super.setUp()')
}
}
}
}