com.liferay.source.formatter.check.JavaTestMethodAnnotationsCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.source.formatter
Liferay Source Formatter
The newest version!
/**
 * SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
 * SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
 */

package com.liferay.source.formatter.check;

import com.liferay.petra.string.StringBundler;
import com.liferay.portal.kernel.util.StringUtil;
import com.liferay.source.formatter.check.util.JavaSourceUtil;
import com.liferay.source.formatter.parser.JavaClass;
import com.liferay.source.formatter.parser.JavaParameter;
import com.liferay.source.formatter.parser.JavaSignature;
import com.liferay.source.formatter.parser.JavaTerm;

import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * @author Hugo Huijser
 */
public class JavaTestMethodAnnotationsCheck extends BaseJavaTermCheck {

	@Override
	public boolean isLiferaySourceCheck() {
		return true;
	}

	@Override
	protected String doProcess(
		String fileName, String absolutePath, JavaTerm javaTerm,
		String fileContent) {

		if (!fileName.endsWith("Test.java")) {
			return javaTerm.getContent();
		}

		JavaClass parentJavaClass = javaTerm.getParentJavaClass();

		if (parentJavaClass.getParentJavaClass() != null) {
			return javaTerm.getContent();
		}

		if (javaTerm.isPublic()) {
			_checkAnnotationForMethod(
				fileName, javaTerm, "^tearDown(?!Class)", false, "After",
				"AfterEach");
			_checkAnnotationForMethod(
				fileName, javaTerm, "^tearDownClass", true, "AfterAll",
				"AfterClass");
			_checkAnnotationForMethod(
				fileName, javaTerm, "^setUp(?!Class)", false, "Before",
				"BeforeEach");
			_checkAnnotationForMethod(
				fileName, javaTerm, "^setUpClass", true, "BeforeAll",
				"BeforeClass");
			_checkAnnotationForMethod(
				fileName, javaTerm, "^test", false, "Test");
		}

		_checkFeatureFlagsAnnotation(fileName, javaTerm);

		return javaTerm.getContent();
	}

	@Override
	protected String[] getCheckableJavaTermNames() {
		return new String[] {JAVA_METHOD};
	}

	private void _checkAnnotationForMethod(
		String fileName, JavaTerm javaTerm, String requiredMethodNameRegex,
		boolean staticRequired, String... annotations) {

		String methodName = javaTerm.getName();

		Pattern pattern = Pattern.compile(requiredMethodNameRegex);

		Matcher matcher = pattern.matcher(methodName);

		boolean hasAnnotation = false;

		for (String annotation : annotations) {
			if (javaTerm.hasAnnotation(annotation)) {
				hasAnnotation = true;

				break;
			}
		}

		if (hasAnnotation) {
			if (!matcher.find()) {
				addMessage(
					fileName, "Incorrect method name \"" + methodName + "\"",
					javaTerm.getLineNumber());
			}
			else if (javaTerm.isStatic() != staticRequired) {
				addMessage(
					fileName,
					"Incorrect method type for \"" + methodName + "\"",
					javaTerm.getLineNumber());
			}

			return;
		}

		if (!matcher.find()) {
			return;
		}

		JavaSignature signature = javaTerm.getSignature();

		List parameters = signature.getParameters();

		if (!parameters.isEmpty()) {
			return;
		}

		JavaClass javaClass = javaTerm.getParentJavaClass();

		if (javaClass.isAnonymous()) {
			return;
		}

		JavaClass parentJavaClass = javaClass.getParentJavaClass();

		if (parentJavaClass == null) {
			StringBundler sb = new StringBundler();

			for (String annotation : annotations) {
				sb.append("@");
				sb.append(annotation);
				sb.append(" or ");
			}

			sb.setIndex(sb.index() - 1);

			addMessage(
				fileName,
				StringBundler.concat(
					"Annotation ", sb, " required for \"", methodName, "\""),
				javaTerm.getLineNumber());
		}
	}

	private void _checkFeatureFlagsAnnotation(
		String fileName, JavaTerm javaTerm) {

		String javaTermContent = javaTerm.getContent();

		int x = -1;

		while (true) {
			x = javaTermContent.indexOf("PropsUtil.addProperties(", x + 1);

			if (x == -1) {
				break;
			}

			List parameterList = JavaSourceUtil.getParameterList(
				JavaSourceUtil.getMethodCall(javaTerm.getContent(), x));

			if ((parameterList.size() != 1) ||
				!StringUtil.startsWith(
					parameterList.get(0),
					"UnicodePropertiesBuilder.setProperty(")) {

				continue;
			}

			parameterList = JavaSourceUtil.getParameterList(
				JavaSourceUtil.getMethodCall(parameterList.get(0), 0));

			if ((parameterList.size() == 2) &&
				StringUtil.startsWith(
					parameterList.get(0), "\"feature.flag.")) {

				addMessage(
					fileName,
					"Use annotation \"@FeatureFlags\" instead of \"PropsUtil." +
						"addProperties\" for feature flag",
					javaTerm.getLineNumber() +
						getLineNumber(javaTermContent, x) - 1);
			}
		}
	}

}