Add tests and for SpringImportOrderCheck

Add tests for `SpringImportOrderCheck` and also allow it to be
configured from `SpringChecks`.

Closes gh-62

Author: philwebb

spring-javaformat/spring-javaformat-checkstyle/src/main/java/io/spring/javaformat/checkstyle/SpringChecks.java

@@ -38,6 +38,7 @@
 import com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement;
 
 import io.spring.javaformat.checkstyle.check.SpringHeaderCheck;
+import io.spring.javaformat.checkstyle.check.SpringImportOrderCheck;
 
 /**
  * {@link FileSetCheck} that applies Spring checkstype rules.
@@ -62,6 +63,8 @@ public class SpringChecks extends AbstractFileSetCheck implements ExternalResour
 
 	private String headerFile;
 
+	private String projectRootPackage = SpringImportOrderCheck.DEFAULT_PROJECT_ROOT_PACKAGE;
+
 	/**
 	 * Sets tab width.
 	 * @param tabWidth the distance between tab stops
@@ -97,6 +100,7 @@ public void finishLocalSetup() {
 		put(properties, "headerType", this.headerType);
 		put(properties, "headerCopyrightPattern", this.headerCopyrightPattern);
 		put(properties, "headerFile", this.headerFile);
+		put(properties, "projectRootPackage", this.projectRootPackage);
 		this.checks = new SpringConfigurationLoader(context, this.moduleFactory)
 				.load(new PropertiesExpander(properties));
 	}
@@ -161,4 +165,8 @@ public void setHeaderFile(String headerFile) {
 		this.headerFile = headerFile;
 	}
 
+	public void setProjectRootPackage(String projectRootPackage) {
+		this.projectRootPackage = projectRootPackage;
+	}
+
 }

spring-javaformat/spring-javaformat-checkstyle/src/main/java/io/spring/javaformat/checkstyle/check/SpringImportOrderCheck.java

@@ -25,7 +25,10 @@
  */
 public class SpringImportOrderCheck extends ImportOrderCheck {
 
-	private static final String DEFAULT_PROJECT_ROOT_PACKAGE = "org.springframework";
+	/**
+	 * The default root package.
+	 */
+	public static final String DEFAULT_PROJECT_ROOT_PACKAGE = "org.springframework";
 
 	public SpringImportOrderCheck() {
 		setProjectRootPackage(DEFAULT_PROJECT_ROOT_PACKAGE);

spring-javaformat/spring-javaformat-checkstyle/src/main/resources/io/spring/javaformat/checkstyle/spring-checkstyle.xml

@@ -81,7 +81,9 @@
 		<module name="com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck">
 			<property name="processJavadoc" value="true" />
 		</module>
-		<module name="io.spring.javaformat.checkstyle.check.SpringImportOrderCheck"/>
+		<module name="io.spring.javaformat.checkstyle.check.SpringImportOrderCheck">
+			<property name="projectRootPackage" value="${projectRootPackage}"/>
+		</module>
 
 		<!-- Javadoc Comments -->
 		<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck">

spring-javaformat/spring-javaformat-checkstyle/src/test/java/io/spring/javaformat/checkstyle/SpringConfigurationLoaderTests.java

@@ -28,6 +28,7 @@
 import org.junit.Test;
 
 import io.spring.javaformat.checkstyle.check.SpringHeaderCheck;
+import io.spring.javaformat.checkstyle.check.SpringImportOrderCheck;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -56,6 +57,8 @@ private PropertyResolver getPropertyResolver() {
 		properties.put("headerFile", "");
 		properties.put("headerCopyrightPattern",
 				SpringHeaderCheck.DEFAULT_HEADER_COPYRIGHT_PATTERN);
+		properties.put("projectRootPackage",
+				SpringImportOrderCheck.DEFAULT_PROJECT_ROOT_PACKAGE);
 		return new PropertiesExpander(properties);
 	}
 

spring-javaformat/spring-javaformat-checkstyle/src/test/resources/check/ImportOrderCustomPackageInvalid.txt

@@ -0,0 +1 @@
++ImportOrderCustomPackageInvalid.java:21: import.ordering [SpringImportOrder]

spring-javaformat/spring-javaformat-checkstyle/src/test/resources/check/ImportOrderCustomPackageValid.txt

@@ -0,0 +1 @@
++0 errors

spring-javaformat/spring-javaformat-checkstyle/src/test/resources/config/ImportOrderCustomPackageInvalid.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+		"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+		"https://checkstyle.org/dtds/configuration_1_3.dtd">
+<module name="com.puppycrawl.tools.checkstyle.Checker">
+	<module name="io.spring.javaformat.checkstyle.SpringChecks">
+		<property name="projectRootPackage" value="com.example"/>
+	</module>
+</module>

spring-javaformat/spring-javaformat-checkstyle/src/test/resources/config/ImportOrderCustomPackageValid.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+		"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+		"https://checkstyle.org/dtds/configuration_1_3.dtd">
+<module name="com.puppycrawl.tools.checkstyle.Checker">
+	<module name="io.spring.javaformat.checkstyle.SpringChecks">
+		<property name="projectRootPackage" value="com.example"/>
+	</module>
+</module>

spring-javaformat/spring-javaformat-checkstyle/src/test/resources/source/ImportOrderCustomPackageInvalid.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2017-2019 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
+ *
+ *      https://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 com.example;
+
+import com.example.util.MyUtils1;
+import com.example.util.MyUtils2;
+import java.util.Objects;
+
+/**
+ * Custom pacakge with valid imports.
+ *
+ * @author Phillip Webb
+ */
+public final class ImportOrderCustomPackageInvalid {
+
+	private ImportOrderCustomPackageValid() {
+	}
+
+	public static void main(String[] args) {
+		if (Objects.nonNull(args)) {
+			MyUtils1.sort(args);
+			MyUtils2.find(args);
+		}
+	}
+
+}

spring-javaformat/spring-javaformat-checkstyle/src/test/resources/source/ImportOrderCustomPackageValid.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2017-2019 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
+ *
+ *      https://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 com.example;
+
+import java.util.Objects;
+
+import com.example.util.MyUtils1;
+import com.example.util.MyUtils2;
+
+/**
+ * Custom pacakge with valid imports.
+ *
+ * @author Phillip Webb
+ */
+public final class ImportOrderCustomPackageValid {
+
+	private ImportOrderCustomPackageValid() {
+	}
+
+	public static void main(String[] args) {
+		if (Objects.nonNull(args)) {
+			MyUtils1.sort(args);
+			MyUtils2.find(args);
+		}
+	}
+
+}