Merge pull request #7335 from murdos/clean-cucumber-setup

Run Cucumber tests with JUnit5
jhipster · Sep 14, 2023 · cac768a · cac768a
2 parents 9b8f1b7 + 4fb1bef
commit cac768a
Show file tree

Hide file tree

Showing 9 changed files with 61 additions and 67 deletions.
diff --git a/pom.xml b/pom.xml
@@ -215,7 +215,7 @@
 
     <dependency>
       <groupId>io.cucumber</groupId>
-      <artifactId>cucumber-junit</artifactId>
+      <artifactId>cucumber-junit-platform-engine</artifactId>
       <version>${cucumber.version}</version>
       <scope>test</scope>
     </dependency>
@@ -235,8 +235,8 @@
     </dependency>
 
     <dependency>
-      <groupId>org.junit.vintage</groupId>
-      <artifactId>junit-vintage-engine</artifactId>
+      <groupId>org.junit.platform</groupId>
+      <artifactId>junit-platform-suite</artifactId>
       <scope>test</scope>
     </dependency>
 

diff --git a/...ech/jhipster/lite/generator/server/springboot/cucumbercommon/domain/CucumbersModules.java b/...ech/jhipster/lite/generator/server/springboot/cucumbercommon/domain/CucumbersModules.java
@@ -16,17 +16,17 @@ private CucumbersModules() {}
   public static JHipsterModuleBuilder cucumberModuleBuilder(JHipsterModuleProperties properties) {
     return moduleBuilder(properties)
       .javaDependencies()
-      .addDependency(cucumberJunitDependency())
+      .addDependency(cucumberJunitPlatformEngineDependency())
       .addDependency(cucumberJavaDependency())
       .addDependency(cucumberSpringDependency())
-      .addDependency(junitVintageDependency())
+      .addDependency(junitPlatformSuiteDependency())
       .and();
   }
 
-  private static JavaDependency cucumberJunitDependency() {
+  private static JavaDependency cucumberJunitPlatformEngineDependency() {
     return javaDependency()
       .groupId(CUCUMBER_GROUP_ID)
-      .artifactId("cucumber-junit")
+      .artifactId("cucumber-junit-platform-engine")
       .versionSlug(CUCUMBER_VERSION)
       .scope(JavaDependencyScope.TEST)
       .build();
@@ -50,7 +50,7 @@ private static JavaDependency cucumberSpringDependency() {
       .build();
   }
 
-  private static JavaDependency junitVintageDependency() {
-    return javaDependency().groupId("org.junit.vintage").artifactId("junit-vintage-engine").scope(JavaDependencyScope.TEST).build();
+  private static JavaDependency junitPlatformSuiteDependency() {
+    return javaDependency().groupId("org.junit.platform").artifactId("junit-platform-suite").scope(JavaDependencyScope.TEST).build();
   }
 }
diff --git a/src/main/resources/generator/dependencies/pom.xml b/src/main/resources/generator/dependencies/pom.xml
@@ -174,7 +174,7 @@
       </dependency>
       <dependency>
         <groupId>io.cucumber</groupId>
-        <artifactId>cucumber-junit</artifactId>
+        <artifactId>cucumber-junit-platform-engine</artifactId>
         <version>${cucumber.version}</version>
         <scope>test</scope>
       </dependency>
@@ -191,8 +191,8 @@
         <scope>test</scope>
       </dependency>
       <dependency>
-        <groupId>org.junit.vintage</groupId>
-        <artifactId>junit-vintage-engine</artifactId>
+        <groupId>org.junit.platform</groupId>
+        <artifactId>junit-platform-suite</artifactId>
         <scope>test</scope>
       </dependency>
       <dependency>

diff --git a/src/main/resources/generator/server/springboot/cucumber/CucumberTest.java.mustache b/src/main/resources/generator/server/springboot/cucumber/CucumberTest.java.mustache
@@ -1,17 +1,20 @@
 package {{packageName}}.cucumber;
 
-import io.cucumber.junit.Cucumber;
-import io.cucumber.junit.CucumberOptions;
-import org.junit.runner.RunWith;
+import static io.cucumber.junit.platform.engine.Constants.*;
+
+import org.junit.platform.suite.api.ConfigurationParameter;
+import org.junit.platform.suite.api.IncludeEngines;
+import org.junit.platform.suite.api.Suite;
 import {{packageName}}.ComponentTest;
 
+@Suite(failIfNoTests = false)
 @ComponentTest
-@RunWith(Cucumber.class)
-@CucumberOptions(
-  glue = "{{packageName}}",
-  plugin = {
-    "pretty", "json:target/cucumber/cucumber.json", "html:target/cucumber/cucumber.htm", "junit:target/cucumber/TEST-cucumber.xml",
-  },
-  features = "src/test/features"
+@IncludeEngines("cucumber")
+@SuppressWarnings("java:S2187")
+@ConfigurationParameter(key = GLUE_PROPERTY_NAME, value = "{{packageName}}")
+@ConfigurationParameter(
+  key = PLUGIN_PROPERTY_NAME,
+  value = "pretty, json:target/cucumber/cucumber.json, html:target/cucumber/cucumber.htm, junit:target/cucumber/TEST-cucumber.xml"
 )
+@ConfigurationParameter(key = FEATURES_PROPERTY_NAME, value = "src/test/features")
 public class CucumberTest {}
diff --git a/src/main/resources/generator/server/springboot/cucumber/cucumber.md.mustache b/src/main/resources/generator/server/springboot/cucumber/cucumber.md.mustache
@@ -112,27 +112,12 @@ Behind the scene, your last service will be recalled until the assertions are OK
 You may need to mock beans for your component tests but you won't be able to do it in a "classic" way (using `@MockBean`) since the application context will be already loaded. A way to achieve that is to overload beans to have mocks:
 
 ```java
-@RunWith(Cucumber.class)
+@ActiveProfiles("test")
 @CucumberContextConfiguration
-@CucumberOptions(
-  glue = "{{packageName}}",
-  plugin = {
-    "pretty",
-    "json:target/cucumber/cucumber.json",
-    "html:target/cucumber/cucumber.htm",
-    "junit:target/cucumber/cucumber.xml"
-  },
-  features = "src/test/features"
-)
-@SpringBootTest(
-  classes = {
-    {{ baseName }}App.class,
-    CucumberConfiguration.class,
-    CucumberMocksConfiguration.class
-  },
-  webEnvironment = WebEnvironment.RANDOM_PORT
-)
-public class CucumberTest {
+@SpringBootTest(classes = { JhipsterSampleApplicationApp.class, CucumberMocksConfiguration.class }, webEnvironment = WebEnvironment.RANDOM_PORT)
+public class CucumberConfiguration {
+
+  // other code omitted
 
   @TestConfiguration
   public static class CucumberMocksConfiguration {

diff --git a/src/main/resources/generator/server/springboot/custom-jhlite/CucumberTest.java.mustache b/src/main/resources/generator/server/springboot/custom-jhlite/CucumberTest.java.mustache
@@ -1,17 +1,20 @@
 package {{packageName}}.cucumber;
 
-import io.cucumber.junit.Cucumber;
-import io.cucumber.junit.CucumberOptions;
-import org.junit.runner.RunWith;
+import static io.cucumber.junit.platform.engine.Constants.*;
+
+import org.junit.platform.suite.api.ConfigurationParameter;
+import org.junit.platform.suite.api.IncludeEngines;
+import org.junit.platform.suite.api.Suite;
 import {{packageName}}.ComponentTest;
 
+@Suite(failIfNoTests = false)
 @ComponentTest
-@RunWith(Cucumber.class)
-@CucumberOptions(
-  glue = { "{{packageName}}", "tech.jhipster.lite.module.infrastructure.primary" },
-  plugin = {
-    "pretty", "json:target/cucumber/cucumber.json", "html:target/cucumber/cucumber.htm", "junit:target/cucumber/TEST-cucumber.xml",
-  },
-  features = "src/test/features"
+@IncludeEngines("cucumber")
+@SuppressWarnings("java:S2187")
+@ConfigurationParameter(key = GLUE_PROPERTY_NAME, value = "{{packageName}}, tech.jhipster.lite.module.infrastructure.primary")
+@ConfigurationParameter(
+  key = PLUGIN_PROPERTY_NAME,
+  value = "pretty, json:target/cucumber/cucumber.json, html:target/cucumber/cucumber.htm, junit:target/cucumber/TEST-cucumber.xml"
 )
+@ConfigurationParameter(key = FEATURES_PROPERTY_NAME, value = "src/test/features")
 public class CucumberTest {}
diff --git a/src/test/java/tech/jhipster/lite/cucumber/CucumberTest.java b/src/test/java/tech/jhipster/lite/cucumber/CucumberTest.java
@@ -1,17 +1,20 @@
 package tech.jhipster.lite.cucumber;
 
-import io.cucumber.junit.Cucumber;
-import io.cucumber.junit.CucumberOptions;
-import org.junit.runner.RunWith;
+import static io.cucumber.junit.platform.engine.Constants.*;
+
+import org.junit.platform.suite.api.ConfigurationParameter;
+import org.junit.platform.suite.api.IncludeEngines;
+import org.junit.platform.suite.api.Suite;
 import tech.jhipster.lite.ComponentTest;
 
+@Suite
 @ComponentTest
-@RunWith(Cucumber.class)
-@CucumberOptions(
-  glue = "tech.jhipster.lite",
-  plugin = {
-    "pretty", "json:target/cucumber/cucumber.json", "html:target/cucumber/cucumber.htm", "junit:target/cucumber/TEST-cucumber.xml",
-  },
-  features = "src/test/features"
+@IncludeEngines("cucumber")
+@SuppressWarnings("java:S2187")
+@ConfigurationParameter(key = GLUE_PROPERTY_NAME, value = "tech.jhipster.lite")
+@ConfigurationParameter(
+  key = PLUGIN_PROPERTY_NAME,
+  value = "pretty, json:target/cucumber/cucumber.json, html:target/cucumber/cucumber.htm, junit:target/cucumber/TEST-cucumber.xml"
 )
+@ConfigurationParameter(key = FEATURES_PROPERTY_NAME, value = "src/test/features")
 public class CucumberTest {}
diff --git a/.../jhipster/lite/generator/server/springboot/cucumber/domain/CucumberModuleFactoryTest.java b/.../jhipster/lite/generator/server/springboot/cucumber/domain/CucumberModuleFactoryTest.java
@@ -50,10 +50,10 @@ void shouldBuildInitialModule() {
       .hasFiles("documentation/cucumber.md")
       .hasFiles("src/test/features/.gitkeep")
       .hasFile("pom.xml")
-      .containing("<artifactId>cucumber-junit</artifactId>")
+      .containing("<artifactId>cucumber-junit-platform-engine</artifactId>")
       .containing("<artifactId>cucumber-java</artifactId>")
       .containing("<artifactId>cucumber-spring</artifactId>")
-      .containing("<artifactId>junit-vintage-engine</artifactId>")
+      .containing("<artifactId>junit-platform-suite</artifactId>")
       .containing("<artifactId>awaitility</artifactId>")
       .containing("<version>${cucumber.version}</version>")
       .and()

diff --git a/...r/lite/generator/server/springboot/customjhlite/domain/CustomJHLiteModuleFactoryTest.java b/...r/lite/generator/server/springboot/customjhlite/domain/CustomJHLiteModuleFactoryTest.java
@@ -28,10 +28,10 @@ void shouldBuildModule() {
     //@formatter:off
     assertThatModuleWithFiles(module, pomFile(), mainAppFile())
       .hasFile("pom.xml")
-        .containing("<artifactId>cucumber-junit</artifactId>")
+        .containing("<artifactId>cucumber-junit-platform-engine</artifactId>")
         .containing("<artifactId>cucumber-java</artifactId>")
         .containing("<artifactId>cucumber-spring</artifactId>")
-        .containing("<artifactId>junit-vintage-engine</artifactId>")
+        .containing("<artifactId>junit-platform-suite</artifactId>")
         .containing(
           """
               <dependency>
@@ -76,7 +76,7 @@ void shouldBuildModule() {
         "src/test/java/tech/jhipster/test/security/infrastructure/primary/CorsFilterConfigurationIT.java"
       )
       .hasFile("src/test/java/com/jhipster/test/cucumber/CucumberTest.java")
-        .containing("glue = { \"com.jhipster.test\", \"tech.jhipster.lite.module.infrastructure.primary\" },")
+        .containing("key = GLUE_PROPERTY_NAME, value = \"com.jhipster.test, tech.jhipster.lite.module.infrastructure.primary\"")
         .and()
       .hasFile("src/test/java/com/jhipster/test/cucumber/CucumberConfiguration.java")
         .containing("import com.jhipster.test.MyappApp;")