JavaSourceProcessorTest.java

/**
 * 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;

import org.junit.Test;

/**
 * @author Hugo Huijser
 */
public class JavaSourceProcessorTest extends BaseSourceProcessorTestCase {

	@Test
	public void testAnnotationParameterImports() throws Exception {
		test("AnnotationParameterImports.testjava");
	}

	@Test
	public void testAssertUsage() throws Exception {
		test(
			"AssertUsage.testjava",
			"Use org.junit.Assert instead of org.testng.Assert, see LPS-55690");
	}

	@Test
	public void testCombineLines() throws Exception {
		test("CombineLines.testjava");
	}

	@Test
	public void testConstructorParameterOrder() throws Exception {
		test(
			"ConstructorParameterOrder.testjava",
			"'_value = value;' should come before '_attribute = attribute;' " +
				"to match order of constructor parameters");
	}

	@Test
	public void testDiamondOperator() throws Exception {
		test("DiamondOperator.testjava");
	}

	@Test
	public void testDuplicateConstructors() throws Exception {
		test(
			"DuplicateConstructors.testjava",
			"Duplicate DuplicateConstructors");
	}

	@Test
	public void testDuplicateMethods() throws Exception {
		test("DuplicateMethods.testjava", "Duplicate method");
	}

	@Test
	public void testDuplicateVariables() throws Exception {
		test("DuplicateVariables.testjava", "Duplicate _s2");
	}

	@Test
	public void testExceedMaxLineLength() throws Exception {
		test("ExceedMaxLineLength.testjava", "> 80", 37);
	}

	@Test
	public void testExceptionVariableName() throws Exception {
		test("ExceptionVariableName.testjava");
	}

	@Test
	public void testFormatAnnotations() throws Exception {
		test("FormatAnnotations.testjava");
	}

	@Test
	public void testFormatBooleanStatements() throws Exception {
		test("FormatBooleanStatements.testjava");
	}

	@Test
	public void testFormatImports() throws Exception {
		test("FormatImports.testjava");
	}

	@Test
	public void testFormatJSONObject() throws Exception {
		test("FormatJSONObject.testjava");
	}

	@Test
	public void testFormatReturnStatements() throws Exception {
		test("FormatReturnStatements.testjava");
	}

	@Test
	public void testIfClauseIncorrectLineBreaks() throws Exception {
		test("IfClauseIncorrectLineBreaks.testjava");
	}

	@Test
	public void testIfClauseParentheses() throws Exception {
		test(
			"IfClauseParentheses.testjava",
			new String[] {
				"Missing parentheses in if-statement",
				"Missing parentheses in if-statement",
				"Missing parentheses in if-statement",
				"Missing parentheses in if-statement",
				"Missing parentheses in if-statement",
				"Unnecessary parentheses around expression.",
				"Redundant parentheses in if-statement",
				"Unnecessary parentheses around expression."
			},
			new Integer[] {25, 29, 33, 39, 43, 43, 47, 51});
	}

	@Test
	public void testIfClauseWhitespace() throws Exception {
		test("IfClauseWhitespace.testjava");
	}

	@Test
	public void testIncorrectClose() throws Exception {
		test("IncorrectClose.testjava");
	}

	@Test
	public void testIncorrectCopyright() throws Exception {
		test("IncorrectCopyright.testjava", "File must start with copyright");
	}

	@Test
	public void testIncorrectIfStatement() throws Exception {
		test("IncorrectIfStatement.testjava", "Incorrect if statement", 23);
	}

	@Test
	public void testIncorrectImports() throws Exception {
		test("IncorrectImports1.testjava");
		test(
			"IncorrectImports2.testjava",
			new String[] {
				"Illegal import: edu.emory.mathcs.backport.java",
				"Illegal import: jodd.util.StringPool",
				"Use ProxyUtil instead of java.lang.reflect.Proxy"
			});
	}

	@Test
	public void testIncorrectLineBreaks() throws Exception {
		test(
			"IncorrectLineBreaks1.testjava",
			new String[] {
				"'=' should be on the previous line.",
				"There should be a line break after '||'",
				"There should be a line break after '\"Hello World\", " +
					"\"Hello\", \"World\"),'",
				"Add the string 'Hello World Hello World ' to the previous " +
					"literal string",
				"There should be a line break after '\"Hello World Hello " +
					"World Hello World\",'",
				"There should be a line break after " +
					"'anotherStringWithAVeryLongName,'",
				"There should be a line break after '='",
				"There should be a line break after '+'",
				"There should be a line break after '='",
				"Line should not start with '.'",
				"There should be a line break before 'throws'",
				"There should be a line break after '}'",
				"There should be a line break after '}'",
				"There should be a line break after '('",
				"There should be a line break after '('",
				"'null) {' should be added to previous line",
				"There should be a line break before 'new " +
					"Comparator<String>() {'",
				"There should be a line break after '},'",
				"Line starts with '2' tabs, but '3' tabs are expected",
				"Line starts with '2' tabs, but '3' tabs are expected",
				"There should be a line break before 'throws'",
				"Line starts with '2' tabs, but '3' tabs are expected",
				"There should be a line break before 'throws'",
				"'new String[] {' should be added to previous line"
			},
			new Integer[] {
				31, 35, 43, 47, 47, 52, 55, 58, 61, 65, 68, 73, 77, 82, 86, 93,
				104, 117, 121, 122, 122, 128, 128, 138
			});
		test("IncorrectLineBreaks2.testjava");
	}

	@Test
	public void testIncorrectParameterNames() throws Exception {
		test(
			"IncorrectParameterNames.testjava",
			new String[] {
				"Parameter 'StringMap' must match pattern " +
					"'^[a-z][a-zA-Z0-9]*$'",
				"Parameter 'TestString' must match pattern " +
					"'^[a-z][a-zA-Z0-9]*$'"
			},
			new Integer[] {24, 28});
	}

	@Test
	public void testIncorrectTabs() throws Exception {
		test(
			"IncorrectTabs.testjava",
			new String[] {
				"There should be a line break after '('",
				"There should be a line break after '{'",
				"Line starts with '3' tabs, but '4' tabs are expected",
				"Line starts with '2' tabs, but '3' tabs are expected",
				"Line starts with '3' tabs, but '4' tabs are expected"
			},
			new Integer[] {26, 30, 31, 32, 37});
	}

	@Test
	public void testIncorrectVariableNames() throws Exception {
		test(
			"IncorrectVariableNames1.testjava",
			new String[] {
				"Protected or public constant '_TEST_1' must match " +
					"pattern '^[a-zA-Z0-9][_a-zA-Z0-9]*$'",
				"Protected or public non-static field '_test2' must match " +
					"pattern '^[a-z0-9][_a-zA-Z0-9]*$'"
			},
			new Integer[] {22, 28});
		test(
			"IncorrectVariableNames2.testjava",
			"Private constant 'STRING_1' must match pattern '^_[_a-zA-Z0-9]*$'",
			26);
		test(
			"IncorrectVariableNames3.testjava",
			new String[] {
				"Local non-final variable 'TestMapWithARatherLongName' must " +
					"match pattern '^[a-z0-9][_a-zA-Z0-9]*$'",
				"Local non-final variable 'TestString' must match pattern " +
					"'^[a-z0-9][_a-zA-Z0-9]*$'"
			},
			new Integer[] {26, 29});
	}

	@Test
	public void testIncorrectWhitespace() throws Exception {
		test("IncorrectWhitespace.testjava");
	}

	@Test
	public void testInefficientStringMethods() throws Exception {
		test(
			"InefficientStringMethods.testjava",
			new String[] {
				"Use StringUtil.equalsIgnoreCase", "Use StringUtil.toLowerCase",
				"Use StringUtil.toUpperCase"
			},
			new Integer[] {26, 30, 31});
	}

	@Test
	public void testJavaTermDividers() throws Exception {
		test("JavaTermDividers.testjava");
	}

	@Test
	public void testLogLevels() throws Exception {
		test(
			"Levels.testjava",
			new String[] {
				"Do not use _log.isErrorEnabled()", "Use _log.isDebugEnabled()",
				"Use _log.isDebugEnabled()", "Use _log.isInfoEnabled()",
				"Use _log.isTraceEnabled()", "Use _log.isWarnEnabled()"
			},
			new Integer[] {27, 36, 41, 53, 58, 68});
	}

	@Test
	public void testLPS28266() throws Exception {
		test("LPS28266.testjava", "Use rs.getInt(1) for count, see LPS-28266");
	}

	@Test
	public void testMissingAuthor() throws Exception {
		test("MissingAuthor.testjava", "Missing author", 20);
	}

	@Test
	public void testMissingEmptyLines() throws Exception {
		test("MissingEmptyLines.testjava");
	}

	@Test
	public void testMissingSerialVersionUID() throws Exception {
		test(
			"MissingSerialVersionUID.testjava",
			"Assign ProcessCallable implementation a serialVersionUID");
	}

	@Test
	public void testNullVariable() throws Exception {
		test("NullVariable.testjava");
	}

	@Test
	public void testPackagePath() throws Exception {
		test(
			"PackagePath.testjava",
			"The declared package 'com.liferay.source.formatter.hello.world' " +
				"does not match the expected package");
	}

	@Test
	public void testProxyUsage() throws Exception {
		test(
			"ProxyUsage.testjava",
			"Use ProxyUtil instead of java.lang.reflect.Proxy");
	}

	@Test
	public void testRedundantCommas() throws Exception {
		test("RedundantCommas.testjava");
	}

	@Test
	public void testSecureRandomNumberGeneration() throws Exception {
		test(
			"SecureRandomNumberGeneration.testjava",
			"Use SecureRandomUtil or com.liferay.portal.kernel.security." +
				"SecureRandom instead of java.security.SecureRandom, see " +
					"LPS-39058");
	}

	@Test
	public void testSortAnnotationParameters() throws Exception {
		test(
			"SortAnnotationParameters.testjava",
			new String[] {
				"Annotation parameter 'immediate' is not sorted alphabetically",
				"Annotation parameter 'propagation' is not sorted " +
					"alphabetically"
			},
			new Integer[] {24, 27});
	}

	@Test
	public void testSortExceptions() throws Exception {
		test("SortExceptions.testjava");
	}

	@Test
	public void testSortJavaTerms() throws Exception {
		test("SortJavaTerms1.testjava");
		test("SortJavaTerms2.testjava");
		test("SortJavaTerms3.testjava");
		test("SortJavaTerms4.testjava");
	}

	@Test
	public void testSortMethodsWithAnnotatedParameters() throws Exception {
		test("SortMethodsWithAnnotatedParameters.testjava");
	}

	@Test
	public void testStaticFinalLog() throws Exception {
		test("StaticFinalLog.testjava");
	}

	@Test
	public void testThrowsSystemException() throws Exception {
		test("ThrowsSystemException.testjava");
	}

	@Test
	public void testTruncateLongLines() throws Exception {
		test("TruncateLongLines.testjava");
	}

	@Test
	public void testUnusedImport() throws Exception {
		test("UnusedImport.testjava");
	}

	@Test
	public void testUnusedParameter() throws Exception {
		test("UnusedParameter.testjava", "Parameter 'color' is unused", 26);
	}

}