Add helper methods to AbstractExtensionTests

spring-io · Sep 30, 2024 · 3767fe1 · 3767fe1
1 parent 407ec4d
commit 3767fe1
Show file tree

Hide file tree

Showing 16 changed files with 53 additions and 50 deletions.
diff --git a/start-site/src/test/java/io/spring/start/site/extension/AbstractExtensionTests.java b/start-site/src/test/java/io/spring/start/site/extension/AbstractExtensionTests.java
@@ -101,6 +101,24 @@ protected AssertProvider<TextAssert> composeFile(ProjectRequest request) {
 		return () -> new TextAssert(project.getProjectDirectory().resolve("compose.yaml"));
 	}
 
+	protected AssertProvider<TextAssert> applicationProperties(ProjectRequest request) {
+		ProjectStructure project = generateProject(request);
+		return () -> new TextAssert(project.getProjectDirectory().resolve("src/main/resources/application.properties"));
+	}
+
+	protected AssertProvider<TextAssert> gitIgnore(ProjectRequest request) {
+		ProjectStructure project = generateProject(request);
+		return () -> new TextAssert(project.getProjectDirectory().resolve(".gitignore"));
+	}
+
+	protected AssertProvider<TextAssert> helpDocument(ProjectStructure project) {
+		return () -> new TextAssert(project.getProjectDirectory().resolve("HELP.md"));
+	}
+
+	protected AssertProvider<TextAssert> helpDocument(ProjectRequest request) {
+		return helpDocument(generateProject(request));
+	}
+
 	protected ProjectStructure generateProject(ProjectRequest request) {
 		ProjectGenerationResult result = getInvoker().invokeProjectStructureGeneration(request);
 		return new ProjectStructure(result.getRootDirectory());

diff --git a/...pring/start/site/extension/build/gradle/GradleBuildSystemHelpDocumentCustomizerTests.java b/...pring/start/site/extension/build/gradle/GradleBuildSystemHelpDocumentCustomizerTests.java
@@ -16,13 +16,13 @@
 
 package io.spring.start.site.extension.build.gradle;
 
-import io.spring.initializr.generator.test.io.TextAssert;
-import io.spring.initializr.generator.test.project.ProjectStructure;
 import io.spring.initializr.web.project.ProjectRequest;
 import io.spring.start.site.extension.AbstractExtensionTests;
 import org.assertj.core.api.ListAssert;
 import org.junit.jupiter.api.Test;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 /**
  * Tests for {@link GradleBuildSystemHelpDocumentCustomizer}.
  *
@@ -63,8 +63,7 @@ private ListAssert<String> assertHelpDocument(String type, String version) {
 		ProjectRequest request = createProjectRequest("web");
 		request.setType(type);
 		request.setBootVersion(version);
-		ProjectStructure project = generateProject(request);
-		return new TextAssert(project.getProjectDirectory().resolve("HELP.md")).lines();
+		return assertThat(helpDocument(request)).lines();
 	}
 
 }
diff --git a/.../spring/start/site/extension/build/maven/MavenBuildSystemHelpDocumentCustomizerTests.java b/.../spring/start/site/extension/build/maven/MavenBuildSystemHelpDocumentCustomizerTests.java
@@ -16,13 +16,13 @@
 
 package io.spring.start.site.extension.build.maven;
 
-import io.spring.initializr.generator.test.io.TextAssert;
-import io.spring.initializr.generator.test.project.ProjectStructure;
 import io.spring.initializr.web.project.ProjectRequest;
 import io.spring.start.site.extension.AbstractExtensionTests;
 import org.assertj.core.api.ListAssert;
 import org.junit.jupiter.api.Test;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 /**
  * Tests for {@link MavenBuildSystemHelpDocumentCustomizer}.
  *
@@ -61,8 +61,7 @@ private ListAssert<String> assertHelpDocument(String type, String version) {
 		ProjectRequest request = createProjectRequest("web");
 		request.setType(type);
 		request.setBootVersion(version);
-		ProjectStructure project = generateProject(request);
-		return new TextAssert(project.getProjectDirectory().resolve("HELP.md")).lines();
+		return assertThat(helpDocument(request)).lines();
 	}
 
 }
diff --git a/...test/java/io/spring/start/site/extension/code/kotlin/KotlinCoroutinesCustomizerTests.java b/...test/java/io/spring/start/site/extension/code/kotlin/KotlinCoroutinesCustomizerTests.java
@@ -37,9 +37,8 @@ void kotlinCoroutinesIsAdded() {
 		request.setLanguage("kotlin");
 		ProjectStructure project = generateProject(request);
 		assertThat(project).mavenBuild().hasDependency("org.jetbrains.kotlinx", "kotlinx-coroutines-reactor");
-		assertThat(project).textFile("HELP.md")
-			.contains(
-					"* [Coroutines section of the Spring Framework Documentation](https://docs.spring.io/spring/docs/6.1.8/spring-framework-reference/languages.html#coroutines)");
+		assertThat(helpDocument(request)).contains(
+				"* [Coroutines section of the Spring Framework Documentation](https://docs.spring.io/spring/docs/6.1.8/spring-framework-reference/languages.html#coroutines)");
 	}
 
 	@Test

diff --git a/.../io/spring/start/site/extension/dependency/dgs/DgsCodegenHelpDocumentCustomizerTests.java b/.../io/spring/start/site/extension/dependency/dgs/DgsCodegenHelpDocumentCustomizerTests.java
@@ -18,13 +18,14 @@
 
 import io.spring.initializr.generator.io.template.MustacheTemplateRenderer;
 import io.spring.initializr.generator.test.io.TextAssert;
-import io.spring.initializr.generator.test.project.ProjectStructure;
 import io.spring.initializr.web.project.ProjectRequest;
 import io.spring.start.site.extension.AbstractExtensionTests;
 import org.junit.jupiter.api.Test;
 
 import org.springframework.beans.factory.annotation.Autowired;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 /**
  * Tests for {@link DgsCodegenHelpDocumentCustomizer}.
  *
@@ -52,8 +53,7 @@ void gradleBuildAddsLinkToGradleCodegenPlugin() {
 	private TextAssert assertHelpDocument(String type, String... dependencies) {
 		ProjectRequest request = createProjectRequest(dependencies);
 		request.setType(type);
-		ProjectStructure project = generateProject(request);
-		return new TextAssert(project.getProjectDirectory().resolve("HELP.md"));
+		return assertThat(helpDocument(request));
 	}
 
 }
diff --git a/...io/spring/start/site/extension/dependency/graalvm/GraalVmHelpDocumentCustomizerTests.java b/...io/spring/start/site/extension/dependency/graalvm/GraalVmHelpDocumentCustomizerTests.java
@@ -24,7 +24,6 @@
 import io.spring.initializr.generator.project.ProjectDescription;
 import io.spring.initializr.generator.spring.documentation.HelpDocument;
 import io.spring.initializr.generator.test.io.TextAssert;
-import io.spring.initializr.generator.test.project.ProjectStructure;
 import io.spring.initializr.generator.version.Version;
 import io.spring.initializr.web.project.ProjectRequest;
 import io.spring.start.site.extension.AbstractExtensionTests;
@@ -146,8 +145,7 @@ void shouldNotDocumentGradleToolchainLimitationsWhenUsingMaven() {
 	}
 
 	private TextAssert assertHelpDocument(ProjectRequest request) {
-		ProjectStructure project = generateProject(request);
-		return new TextAssert(project.getProjectDirectory().resolve("HELP.md"));
+		return assertThat(helpDocument(request));
 	}
 
 	private TextAssert assertHelpDocument(String type, String... dependencies) {

diff --git a/...art/site/extension/dependency/observability/ObservabilityHelpDocumentCustomizerTests.java b/...art/site/extension/dependency/observability/ObservabilityHelpDocumentCustomizerTests.java
@@ -16,13 +16,13 @@
 
 package io.spring.start.site.extension.dependency.observability;
 
-import io.spring.initializr.generator.test.io.TextAssert;
-import io.spring.initializr.generator.test.project.ProjectStructure;
 import io.spring.initializr.web.project.ProjectRequest;
 import io.spring.start.site.extension.AbstractExtensionTests;
 import org.assertj.core.api.ListAssert;
 import org.junit.jupiter.api.Test;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 /**
  * Tests for {@link ObservabilityHelpDocumentCustomizer}.
  *
@@ -57,8 +57,7 @@ private ListAssert<String> assertHelpDocument(String version, String... dependen
 		ProjectRequest request = createProjectRequest(dependencies);
 		request.setType("gradle-build");
 		request.setBootVersion(version);
-		ProjectStructure project = generateProject(request);
-		return new TextAssert(project.getProjectDirectory().resolve("HELP.md")).lines();
+		return assertThat(helpDocument(request)).lines();
 	}
 
 }
diff --git a/.../java/io/spring/start/site/extension/dependency/okta/OktaHelpDocumentCustomizerTests.java b/.../java/io/spring/start/site/extension/dependency/okta/OktaHelpDocumentCustomizerTests.java
@@ -17,11 +17,12 @@
 package io.spring.start.site.extension.dependency.okta;
 
 import io.spring.initializr.generator.test.io.TextAssert;
-import io.spring.initializr.generator.test.project.ProjectStructure;
 import io.spring.initializr.web.project.ProjectRequest;
 import io.spring.start.site.extension.AbstractExtensionTests;
 import org.junit.jupiter.api.Test;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 /**
  * Tests for {@link OktaHelpDocumentCustomizer}.
  *
@@ -44,8 +45,7 @@ void oktaSectionWithoutOktaDependencyIsMissing() {
 	private TextAssert assertHelpDocument(String... dependencies) {
 		ProjectRequest request = createProjectRequest(dependencies);
 		request.setBootVersion(SPRING_BOOT_VERSION);
-		ProjectStructure project = generateProject(request);
-		return new TextAssert(project.getProjectDirectory().resolve("HELP.md"));
+		return assertThat(helpDocument(request));
 	}
 
 }
diff --git a/...site/extension/dependency/springazure/SpringAzureProjectGenerationConfigurationTests.java b/...site/extension/dependency/springazure/SpringAzureProjectGenerationConfigurationTests.java
@@ -130,7 +130,7 @@ private ProjectStructure generateProject(String bootVersion, String... dependenc
 	}
 
 	private TextAssert assertThatHelpDocumentOf(ProjectStructure project) {
-		return new TextAssert(project.getProjectDirectory().resolve("HELP.md"));
+		return assertThat(helpDocument(project));
 	}
 
 }
diff --git a/...site/extension/dependency/springcloud/SpringCloudFunctionHelpDocumentCustomizerTests.java b/...site/extension/dependency/springcloud/SpringCloudFunctionHelpDocumentCustomizerTests.java
@@ -41,7 +41,7 @@ void functionBuildSetupInfoSectionAddedForMaven() {
 		request.setBootVersion(SPRING_BOOT_VERSION);
 		request.setType("maven-build");
 		request.setDependencies(Arrays.asList("cloud-function", "azure-support"));
-		assertThat(generateProject(request)).textFile("HELP.md").contains(AZURE_SECTION_TITLE);
+		assertThat(helpDocument(request)).contains(AZURE_SECTION_TITLE);
 	}
 
 	@Test
@@ -50,13 +50,13 @@ void functionBuildSetupInfoSectionAddedForGradle() {
 		request.setBootVersion(SPRING_BOOT_VERSION);
 		request.setType("gradle-build");
 		request.setDependencies(Arrays.asList("cloud-function", "azure-support"));
-		assertThat(generateProject(request)).textFile("HELP.md").contains(AZURE_SECTION_TITLE);
+		assertThat(helpDocument(request)).contains(AZURE_SECTION_TITLE);
 	}
 
 	@Test
 	void functionBuildSetupInfoSectionNotAddedWhenFunctionAndCloudDependenciesAbsent() {
 		ProjectRequest request = createProjectRequest();
-		assertThat(generateProject(request)).textFile("HELP.md").doesNotContain(AZURE_SECTION_TITLE);
+		assertThat(helpDocument(request)).doesNotContain(AZURE_SECTION_TITLE);
 	}
 
 }
diff --git a/...on/dependency/springintegration/SpringIntegrationProjectGenerationConfigurationTests.java b/...on/dependency/springintegration/SpringIntegrationProjectGenerationConfigurationTests.java
@@ -120,8 +120,7 @@ private ProjectStructure generateProject(String... dependencies) {
 
 	private TextAssert assertHelpDocument(String... dependencyIds) {
 		ProjectRequest request = createProjectRequest(dependencyIds);
-		ProjectStructure project = generateProject(request);
-		return new TextAssert(project.getProjectDirectory().resolve("HELP.md"));
+		return assertThat(helpDocument(request));
 	}
 
 }
diff --git a/...xtension/dependency/testcontainers/TestcontainersProjectGenerationConfigurationTests.java b/...xtension/dependency/testcontainers/TestcontainersProjectGenerationConfigurationTests.java
@@ -476,8 +476,7 @@ private ProjectStructure generateProject(String platformVersion, String... depen
 	private TextAssert assertHelpDocument(String platformVersion, String... dependencyIds) {
 		ProjectRequest request = createProjectRequest(dependencyIds);
 		request.setBootVersion(platformVersion);
-		ProjectStructure project = generateProject(request);
-		return new TextAssert(project.getProjectDirectory().resolve("HELP.md"));
+		return assertThat(helpDocument(request));
 	}
 
 }
diff --git a/...ing/start/site/extension/dependency/vaadin/VaadinProjectGenerationConfigurationTests.java b/...ing/start/site/extension/dependency/vaadin/VaadinProjectGenerationConfigurationTests.java
@@ -113,14 +113,12 @@ void gitIgnoreWithoutVaadinDoesNotIgnoreNodeModules() {
 
 	@Test
 	void shouldAddLaunchBrowserProperty() {
-		assertThat(generateProject(createProjectRequest("vaadin"))).textFile("src/main/resources/application.properties")
-				.contains("vaadin.launch-browser=true");
+		assertThat(applicationProperties(createProjectRequest("vaadin"))).lines().contains("vaadin.launch-browser=true");
 	}
 
 	@Test
 	void shouldNotAddLaunchBrowserPropertyIfVaadinIsNotSelected() {
-		assertThat(generateProject(createProjectRequest("data-jpa"))).textFile("src/main/resources/application.properties")
-				.doesNotContain("vaadin.launch-browser=true");
+		assertThat(applicationProperties(createProjectRequest("data-jpa"))).lines().doesNotContain("vaadin.launch-browser=true");
 	}
 
 	@Override

diff --git a/...spring/start/site/extension/description/InvalidJvmVersionHelpDocumentCustomizerTests.java b/...spring/start/site/extension/description/InvalidJvmVersionHelpDocumentCustomizerTests.java
@@ -18,11 +18,12 @@
 
 import io.spring.initializr.generator.language.kotlin.KotlinLanguage;
 import io.spring.initializr.generator.test.io.TextAssert;
-import io.spring.initializr.generator.test.project.ProjectStructure;
 import io.spring.initializr.web.project.ProjectRequest;
 import io.spring.start.site.extension.AbstractExtensionTests;
 import org.junit.jupiter.api.Test;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 /**
  * Tests for {@link InvalidJvmVersionHelpDocumentCustomizer}.
  *
@@ -56,8 +57,7 @@ void warningNotAddedWithCompatibleVersion() {
 	}
 
 	private TextAssert assertHelpDocument(ProjectRequest request) {
-		ProjectStructure project = generateProject(request);
-		return new TextAssert(project.getProjectDirectory().resolve("HELP.md"));
+		return assertThat(helpDocument(request));
 	}
 
 	private TextAssert assertHelpDocument(String platformVersion, String jvmVersion) {

diff --git a/...pring/start/site/extension/description/InvalidPackageNameHelpDocumentCustomizerTests.java b/...pring/start/site/extension/description/InvalidPackageNameHelpDocumentCustomizerTests.java
@@ -17,11 +17,12 @@
 package io.spring.start.site.extension.description;
 
 import io.spring.initializr.generator.test.io.TextAssert;
-import io.spring.initializr.generator.test.project.ProjectStructure;
 import io.spring.initializr.web.project.ProjectRequest;
 import io.spring.start.site.extension.AbstractExtensionTests;
 import org.junit.jupiter.api.Test;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 /**
  * Tests for {@link InvalidPackageNameHelpDocumentCustomizer}.
  *
@@ -44,8 +45,7 @@ void warningNotAddedWithValidPackageName() {
 	private TextAssert assertHelpDocument(String packageName) {
 		ProjectRequest request = createProjectRequest("web");
 		request.setPackageName(packageName);
-		ProjectStructure project = generateProject(request);
-		return new TextAssert(project.getProjectDirectory().resolve("HELP.md"));
+		return assertThat(helpDocument(request));
 	}
 
 }
diff --git a/...o/spring/start/site/extension/properties/DefaultApplicationPropertiesCustomizerTests.java b/...o/spring/start/site/extension/properties/DefaultApplicationPropertiesCustomizerTests.java
@@ -16,12 +16,12 @@
 
 package io.spring.start.site.extension.properties;
 
-import io.spring.initializr.generator.test.io.TextAssert;
-import io.spring.initializr.generator.test.project.ProjectStructure;
 import io.spring.initializr.web.project.ProjectRequest;
 import io.spring.start.site.extension.AbstractExtensionTests;
 import org.junit.jupiter.api.Test;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 /**
  * Tests for {@link DefaultApplicationPropertiesCustomizer}.
  *
@@ -34,12 +34,7 @@ void shouldAddSpringApplicationName() {
 		ProjectRequest request = createProjectRequest("web");
 		request.setJavaVersion("21");
 		request.setName("test");
-		assertApplicationProperties(request).lines().contains("spring.application.name=test");
-	}
-
-	private TextAssert assertApplicationProperties(ProjectRequest request) {
-		ProjectStructure project = generateProject(request);
-		return new TextAssert(project.getProjectDirectory().resolve("src/main/resources/application.properties"));
+		assertThat(applicationProperties(request)).lines().contains("spring.application.name=test");
 	}
 
 }