com.liferay.source.formatter.checks.JavaTestMethodAnnotationsCheck Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.source.formatter.checks;
import com.liferay.portal.kernel.util.StringBundler;
import com.liferay.source.formatter.parser.JavaClass;
import com.liferay.source.formatter.parser.JavaTerm;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* @author Hugo Huijser
*/
public class JavaTestMethodAnnotationsCheck extends BaseJavaTermCheck {
@Override
public boolean isPortalCheck() {
return true;
}
@Override
protected String doProcess(
String fileName, String absolutePath, JavaTerm javaTerm,
String fileContent) {
if (!fileName.endsWith("Test.java")) {
return javaTerm.getContent();
}
String accessModifier = javaTerm.getAccessModifier();
if (!accessModifier.equals(JavaTerm.ACCESS_MODIFIER_PUBLIC)) {
return javaTerm.getContent();
}
JavaClass parentJavaClass = javaTerm.getParentJavaClass();
if (parentJavaClass.getParentJavaClass() != null) {
return javaTerm.getContent();
}
_checkAnnotationForMethod(
fileName, javaTerm, "After", "\\btearDown(?!Class)", false);
_checkAnnotationForMethod(
fileName, javaTerm, "AfterClass", "\\btearDownClass", true);
_checkAnnotationForMethod(
fileName, javaTerm, "Before", "\\bsetUp(?!Class)", false);
_checkAnnotationForMethod(
fileName, javaTerm, "BeforeClass", "\\bsetUpClass", true);
_checkAnnotationForMethod(fileName, javaTerm, "Test", "^.*test", false);
return javaTerm.getContent();
}
@Override
protected String[] getCheckableJavaTermNames() {
return new String[] {JAVA_METHOD};
}
private void _checkAnnotationForMethod(
String fileName, JavaTerm javaTerm, String annotation,
String requiredMethodNameRegex, boolean staticRequired) {
String methodName = javaTerm.getName();
Pattern pattern = Pattern.compile(requiredMethodNameRegex);
Matcher matcher = pattern.matcher(methodName);
if (javaTerm.hasAnnotation(annotation)) {
if (!matcher.find()) {
addMessage(
fileName, "Incorrect method name '" + methodName + "'",
"test_method_naming.markdown");
}
else if (javaTerm.isStatic() != staticRequired) {
addMessage(
fileName, "Incorrect method type for '" + methodName + "'",
"test_method_naming.markdown");
}
}
else if (matcher.find() && !javaTerm.hasAnnotation("Override")) {
addMessage(
fileName,
StringBundler.concat(
"Annotation @", annotation, " required for '", methodName,
"'"),
"test_method_naming.markdown");
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy