refactor: use a Suite to run the tests against the Groovy and the Kotlin DSLs

Author: jnizet

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/docs/AbstractDocumentationTests.java

@@ -13,21 +13,36 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-package org.springframework.boot.gradle.docs.groovy;
-
-import org.springframework.boot.gradle.docs.AbstractManagingDependenciesDocumentationTests;
+package org.springframework.boot.gradle.docs;
 
 /**
- * Tests for the managing dependencies documentation.
- *
- * @author Jean-Baptiste Nizet
+ * The DSLs supported by Gradle and demonstrated in the documentation samples
  */
-public class ManagingDependenciesDocumentationTests
-		extends AbstractManagingDependenciesDocumentationTests {
+public enum DSL {
+
+	GROOVY("Groovy", ".gradle"), KOTLIN("Kotlin", ".gradle.kts");
+
+	private final String name;
+
+	private final String extension;
+
+	DSL(String name, String extension) {
+		this.name = name;
+		this.extension = extension;
+	}
+
+	/**
+	 * Gets the user-friendly name of the DSL
+	 */
+	public String getName() {
+		return this.name;
+	}
 
-	public ManagingDependenciesDocumentationTests() {
-		super(DSL.GROOVY);
+	/**
+	 * Gets the file extension of build scripts (starting with a dot)
+	 */
+	public String getExtension() {
+		return this.extension;
 	}
 
 }

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/docs/groovy/ManagingDependenciesDocumentationTests.java renamed to spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/docs/DSL.java

@@ -16,29 +16,33 @@
 
 package org.springframework.boot.gradle.docs;
 
+import org.junit.Rule;
 import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import org.springframework.boot.gradle.testkit.GradleBuild;
 
 /**
  * Tests for the getting started documentation.
  *
  * @author Andy Wilkinson
  * @author Jean-Baptiste Nizet
  */
-public abstract class AbstractGettingStartedDocumentationTests
-		extends AbstractDocumentationTests {
+@RunWith(GradleMultiDslSuite.class)
+public class GettingStartedDocumentationTests {
 
-	protected AbstractGettingStartedDocumentationTests(DSL dsl) {
-		super(dsl);
-	}
+	@Rule
+	public GradleBuild gradleBuild;
+
+	public DSL dsl;
 
 	// NOTE: We can't run any `apply-plugin` tests because during a release the
 	// jar won't be there
 
 	@Test
 	public void typicalPluginsAppliesExceptedPlugins() {
-		this.gradleBuild.script(
-				"src/main/gradle/getting-started/typical-plugins" + this.extension)
-				.build("verify");
+		this.gradleBuild.script("src/main/gradle/getting-started/typical-plugins"
+				+ this.dsl.getExtension()).build("verify");
 	}
 
 }

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/docs/AbstractGettingStartedDocumentationTests.java renamed to spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/docs/GettingStartedDocumentationTests.java

@@ -0,0 +1,90 @@
+/*
+ * Copyright 2012-2018 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.springframework.boot.gradle.docs;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.gradle.api.Rule;
+import org.junit.runner.Runner;
+import org.junit.runners.BlockJUnit4ClassRunner;
+import org.junit.runners.Suite;
+import org.junit.runners.model.FrameworkMethod;
+import org.junit.runners.model.InitializationError;
+
+import org.springframework.boot.gradle.testkit.GradleBuild;
+
+/**
+ * Custom {@link Suite} that runs tests against the Groovy and the Kotlin DSLs. Test
+ * classes using the suite must have a public {@link DSL} field named {@code dsl} and a
+ * public {@link GradleBuild} field named {@code gradleBuild} and annotated with
+ * {@link Rule}
+ *
+ * @author Jean-Baptiste Nizet
+ */
+public final class GradleMultiDslSuite extends Suite {
+
+	public GradleMultiDslSuite(Class<?> clazz) throws InitializationError {
+		super(clazz, createRunners(clazz));
+	}
+
+	private static List<Runner> createRunners(Class<?> clazz) throws InitializationError {
+		List<Runner> runners = new ArrayList<>();
+		runners.add(new GradleDslClassRunner(clazz, new GradleBuild(), DSL.GROOVY));
+		runners.add(new GradleDslClassRunner(clazz,
+				new GradleBuild().withMinimalGradleVersionForKotlinDSL(), DSL.KOTLIN));
+		return runners;
+	}
+
+	private static final class GradleDslClassRunner extends BlockJUnit4ClassRunner {
+
+		private final GradleBuild gradleBuild;
+
+		private final DSL dsl;
+
+		private GradleDslClassRunner(Class<?> klass, GradleBuild gradleBuild, DSL dsl)
+				throws InitializationError {
+			super(klass);
+			this.gradleBuild = gradleBuild;
+			this.dsl = dsl;
+		}
+
+		@Override
+		protected Object createTest() throws Exception {
+			Object test = super.createTest();
+			configureTest(test);
+			return test;
+		}
+
+		private void configureTest(Object test) throws Exception {
+			test.getClass().getField("gradleBuild").set(test, this.gradleBuild);
+			test.getClass().getField("dsl").set(test, this.dsl);
+		}
+
+		@Override
+		protected String getName() {
+			return this.dsl.getName() + " DSL";
+		}
+
+		@Override
+		protected String testName(FrameworkMethod method) {
+			return method.getName() + " [" + getName() + "]";
+		}
+
+	}
+
+}

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/docs/GradleMultiDslSuite.java

@@ -21,7 +21,11 @@
 import java.io.IOException;
 import java.util.Properties;
 
+import org.junit.Rule;
 import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import org.springframework.boot.gradle.testkit.GradleBuild;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -31,17 +35,19 @@
  * @author Andy Wilkinson
  * @author Jean-Baptiste Nizet
  */
-public abstract class AbstractIntegratingWithActuatorDocumentationTests
-		extends AbstractDocumentationTests {
+@RunWith(GradleMultiDslSuite.class)
+public class IntegratingWithActuatorDocumentationTests {
 
-	protected AbstractIntegratingWithActuatorDocumentationTests(DSL dsl) {
-		super(dsl);
-	}
+	@Rule
+	public GradleBuild gradleBuild;
+
+	public DSL dsl;
 
 	@Test
 	public void basicBuildInfo() throws IOException {
-		this.gradleBuild.script(
-				"src/main/gradle/integrating-with-actuator/build-info-basic" + extension)
+		this.gradleBuild
+				.script("src/main/gradle/integrating-with-actuator/build-info-basic"
+						+ this.dsl.getExtension())
 				.build("bootBuildInfo");
 		assertThat(new File(this.gradleBuild.getProjectDir(),
 				"build/resources/main/META-INF/build-info.properties")).isFile();
@@ -51,7 +57,7 @@ public void basicBuildInfo() throws IOException {
 	public void buildInfoCustomValues() throws IOException {
 		this.gradleBuild.script(
 				"src/main/gradle/integrating-with-actuator/build-info-custom-values"
-						+ extension)
+						+ this.dsl.getExtension())
 				.build("bootBuildInfo");
 		File file = new File(this.gradleBuild.getProjectDir(),
 				"build/resources/main/META-INF/build-info.properties");
@@ -67,7 +73,7 @@ public void buildInfoCustomValues() throws IOException {
 	public void buildInfoAdditional() throws IOException {
 		this.gradleBuild
 				.script("src/main/gradle/integrating-with-actuator/build-info-additional"
-						+ extension)
+						+ this.dsl.getExtension())
 				.build("bootBuildInfo");
 		File file = new File(this.gradleBuild.getProjectDir(),
 				"build/resources/main/META-INF/build-info.properties");

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/docs/AbstractIntegratingWithActuatorDocumentationTests.java renamed to spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/docs/IntegratingWithActuatorDocumentationTests.java

@@ -16,7 +16,11 @@
 
 package org.springframework.boot.gradle.docs;
 
+import org.junit.Rule;
 import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import org.springframework.boot.gradle.testkit.GradleBuild;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -26,33 +30,47 @@
  * @author Andy Wilkinson
  * @author Jean-Baptiste Nizet
  */
-public abstract class AbstractManagingDependenciesDocumentationTests
-		extends AbstractDocumentationTests {
+@RunWith(GradleMultiDslSuite.class)
+public class ManagingDependenciesDocumentationTests {
 
-	protected AbstractManagingDependenciesDocumentationTests(DSL dsl) {
-		super(dsl);
-	}
+	@Rule
+	public GradleBuild gradleBuild;
+
+	public DSL dsl;
 
 	@Test
 	public void dependenciesExampleEvaluatesSuccessfully() {
-		this.gradleBuild
-				.script("src/main/gradle/managing-dependencies/dependencies" + extension)
-				.build();
+		this.gradleBuild.script("src/main/gradle/managing-dependencies/dependencies"
+				+ this.dsl.getExtension()).build();
 	}
 
 	@Test
 	public void customManagedVersions() {
-		assertThat(this.gradleBuild.script(
-				"src/main/gradle/managing-dependencies/custom-version" + extension)
-				.build("slf4jVersion").getOutput()).contains("1.7.20");
+		assertThat(
+				this.gradleBuild
+						.script("src/main/gradle/managing-dependencies/custom-version"
+								+ this.dsl.getExtension())
+						.build("slf4jVersion").getOutput()).contains("1.7.20");
 	}
 
 	@Test
 	public void dependencyManagementInIsolation() {
 		assertThat(this.gradleBuild
-				.script("src/main/gradle/managing-dependencies/configure-bom" + extension)
+				.script("src/main/gradle/managing-dependencies/configure-bom"
+						+ this.dsl.getExtension())
 				.build("dependencyManagement").getOutput())
 						.contains("org.springframework.boot:spring-boot-starter ");
 	}
 
+	@Test
+	public void dependencyManagementInIsolationWithPluginsBlock() {
+		if (this.dsl == DSL.KOTLIN) {
+			assertThat(this.gradleBuild.script(
+					"src/main/gradle/managing-dependencies/configure-bom-with-plugins"
+							+ this.dsl.getExtension())
+					.build("dependencyManagement").getOutput())
+							.contains("org.springframework.boot:spring-boot-starter ");
+		}
+	}
+
 }