Using now always growing scenarios to speed up execution time #1340

- some minor changes
- created new gradle task `cleanIntegrationTestData`
  and integrated in to `integrationtest` task so will be executed
  on every server build automaticaly and ensures growing ids
  are always reset
- Growing scenarios abstract implementation does now create
  main prefix automatically
- added test case
- every `CleanScenario` has been changed to `GrowingScenario` and
  inherits now AbstractGrowingSecHubServerTestScenario

sechub-integrationtest/build.gradle

@@ -138,11 +138,14 @@ task startIntegrationTestPDS(dependsOn: stopOldIntegrationTestPDS){
 
 }
 
-task startIntegrationTestInstances(dependsOn: [startIntegrationTestServer, startIntegrationTestPDS]){
-
+task cleanIntegrationTestData(type: Delete) {
+    group 'sechub'
+    delete "${project.buildDir}/sechub/integrationtest"
 }
 
-
+task startIntegrationTestInstances(dependsOn: [startIntegrationTestServer, startIntegrationTestPDS, cleanIntegrationTestData]){
+
+}
 
 task stopIntegrationTestServer(dependsOn: configureIntegrationTestServer){
     doLast{
@@ -193,8 +196,6 @@ task integrationtest(type: Test, dependsOn: startIntegrationTestInstances) {
 
 }
 
-
-
 /**
  * Special groovy class for executing external script. This is because exec task of groovy does ALWAYS wait until process has executed.
  * Unfortunately this has blocked always when using exec in combination (server runs) - even when using "&" option.

sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/internal/AbstractGrowingSecHubServerTestScenario.java

@@ -1,27 +1,73 @@
 // SPDX-License-Identifier: MIT
 package com.mercedesbenz.sechub.integrationtest.internal;
 
+import java.util.ArrayList;
+import java.util.List;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 public abstract class AbstractGrowingSecHubServerTestScenario extends AbstractSecHubServerTestScenario implements GrowingScenario {
 
+    private static final Logger LOG = LoggerFactory.getLogger(AbstractGrowingSecHubServerTestScenario.class);
+
     private PersistentScenarioTestDataProvider scenarioTestDataProvider = new PersistentScenarioTestDataProvider(this);
+    private String generatedPrefixMainId;
+    private static List<String> generatedPrefixMainIds = new ArrayList<>();
 
     @Override
     protected void waitForTestDataAvailable() {
-        /* we do NOT wait */
+        /* we do NEVER wait */
 
     }
 
     @Override
-    public void grow() {
+    public final void grow() {
         scenarioTestDataProvider.increaseGrowId();
-
-        /* recalculate test data... */
-
     }
 
     @Override
-    public String getGrowId() {
+    public final String getGrowId() {
         return scenarioTestDataProvider.getGrowId();
     }
 
+    @Override
+    public final String getPrefixMainId() {
+        if (generatedPrefixMainId == null) {
+            generatePrefixMainId();
+        }
+        return generatedPrefixMainId;
+    }
+
+    private void generatePrefixMainId() {
+        String className = getClass().getSimpleName();
+        char firstChar = className.charAt(0);
+        String numberAsString = className.substring(className.length() - 2);
+
+        if (!Character.isDigit(numberAsString.charAt(0))) {
+            numberAsString = numberAsString.substring(1);
+        }
+        try {
+            String id = ("" + firstChar).toLowerCase();
+            int number = Integer.decode(numberAsString);
+            if (number < 10) {
+                id = id + 0;
+            }
+            id = id + number;
+
+            /* check uniqueness of id inside JVM */
+            if (generatedPrefixMainIds.contains(id)) {
+                throw new IllegalStateException("The generated prefix main id:" + id + " is already generated before:" + generatedPrefixMainIds);
+            }
+            /* register */
+            generatedPrefixMainIds.add(id);
+            generatedPrefixMainId = id;
+
+        } catch (NumberFormatException e) {
+            throw new IllegalStateException("Test scenarios class names must end with a number! But found class name:" + className);
+        }
+
+        LOG.debug("Prefix main id calculated:", generatedPrefixMainId);
+    }
+
 }

sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/internal/CleanScenario.java

@@ -1,6 +1,16 @@
 // SPDX-License-Identifier: MIT
 package com.mercedesbenz.sechub.integrationtest.internal;
 
+/**
+ * Those scenarios will reuse the same project names and old data will be
+ * automatically deleted. Every new test inside such a scenario will first check
+ * if the user, the project etc. exists and if so, drop the old data. This can
+ * take some time, so using a {@link GrowingScenario} (or a
+ * {@link StaticTestScenario}) is the better choice in most cases!
+ *
+ * @author Albert Tregnaghi
+ *
+ */
 public interface CleanScenario extends TestScenario {
 
 }

sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/internal/PersistentScenarioTestDataProvider.java

@@ -28,14 +28,25 @@ public PersistentScenarioTestDataProvider(GrowingScenario scenario) {
     }
 
     /**
+     * Only for PersistentScenarioTestDataProviderTest and internal call from other
+     * constructor. Do not use directly.
+     *
      * @param file
      */
-    public PersistentScenarioTestDataProvider(File file) {
+    PersistentScenarioTestDataProvider(File file) {
+        if (file == null) {
+            throw new IllegalStateException("Wrong usage: file may not be null!");
+        }
         this.file = file;
-        this.file.getParentFile().mkdirs();
+        ensurePropertyFileExists();
+
+    }
+
+    private void ensurePropertyFileExists() {
+        file.getParentFile().mkdirs();
 
         properties = new Properties();
-        if (this.file.exists()) {
+        if (file.exists()) {
 
             try (FileInputStream fis = new FileInputStream(file)) {
                 properties.load(fis);
@@ -57,7 +68,6 @@ public PersistentScenarioTestDataProvider(File file) {
                 throw new IllegalStateException("cannot create growid file:" + file.getAbsolutePath(), e);
             }
         }
-
     }
 
     /**
@@ -70,7 +80,8 @@ public PersistentScenarioTestDataProvider(File file) {
     public void increaseGrowId() {
         grow++;
         if (grow > 9999) {
-            throw new IllegalStateException("Grow ID >9999 - not valid");
+            throw new IllegalStateException(
+                    "Grow ID >9999 - not valid. This should only happen on local development.\nHow to handle this? Please call `gradlew cleanIntegrationTestData` to have a clean counter again and restart tests.");
         }
         properties.put(SECHUB_INTEGRATIONTEST_DATA_GROWINGID, "" + grow);
         store();

sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/scenario1/Scenario1.java

@@ -51,9 +51,4 @@ protected void waitForTestDataAvailable() {
         initializer().waitUntilUserCanLogin(OWNER_1);
     }
 
-    @Override
-    public String getPrefixMainId() {
-        return "s01";
-    }
-
 }

sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/scenario10/Scenario10.java

@@ -5,8 +5,7 @@
 
 import com.mercedesbenz.sechub.integrationtest.api.TestProject;
 import com.mercedesbenz.sechub.integrationtest.api.TestUser;
-import com.mercedesbenz.sechub.integrationtest.internal.AbstractSecHubServerTestScenario;
-import com.mercedesbenz.sechub.integrationtest.internal.CleanScenario;
+import com.mercedesbenz.sechub.integrationtest.internal.AbstractGrowingSecHubServerTestScenario;
 import com.mercedesbenz.sechub.integrationtest.internal.PDSTestScenario;
 
 /**
@@ -33,7 +32,7 @@
  * @author Albert Tregnaghi
  *
  */
-public class Scenario10 extends AbstractSecHubServerTestScenario implements PDSTestScenario, CleanScenario {
+public class Scenario10 extends AbstractGrowingSecHubServerTestScenario implements PDSTestScenario {
 
     /**
      * User 1 is registered on startup, also owner and user of {@link #PROJECT_1}
@@ -70,4 +69,5 @@ protected void waitForTestDataAvailable() {
             ;
         /* @formatter:on */
     }
+
 }

sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/scenario11/Scenario11.java

@@ -5,8 +5,7 @@
 
 import com.mercedesbenz.sechub.integrationtest.api.TestProject;
 import com.mercedesbenz.sechub.integrationtest.api.TestUser;
-import com.mercedesbenz.sechub.integrationtest.internal.AbstractSecHubServerTestScenario;
-import com.mercedesbenz.sechub.integrationtest.internal.CleanScenario;
+import com.mercedesbenz.sechub.integrationtest.internal.AbstractGrowingSecHubServerTestScenario;
 import com.mercedesbenz.sechub.integrationtest.internal.IntegrationTestDefaultProfiles;
 import com.mercedesbenz.sechub.integrationtest.internal.PDSTestScenario;
 import com.mercedesbenz.sechub.integrationtest.scenario5.Scenario5;
@@ -38,7 +37,7 @@
  * @author Albert Tregnaghi
  *
  */
-public class Scenario11 extends AbstractSecHubServerTestScenario implements PDSTestScenario, CleanScenario {
+public class Scenario11 extends AbstractGrowingSecHubServerTestScenario implements PDSTestScenario {
 
     /**
      * User 1 is registered on startup, also owner and user of {@link #PROJECT_1}
@@ -75,4 +74,5 @@ protected void waitForTestDataAvailable() {
             ;
         /* @formatter:on */
     }
+
 }

sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/scenario12/Scenario12.java

@@ -5,8 +5,7 @@
 
 import com.mercedesbenz.sechub.integrationtest.api.TestProject;
 import com.mercedesbenz.sechub.integrationtest.api.TestUser;
-import com.mercedesbenz.sechub.integrationtest.internal.AbstractSecHubServerTestScenario;
-import com.mercedesbenz.sechub.integrationtest.internal.CleanScenario;
+import com.mercedesbenz.sechub.integrationtest.internal.AbstractGrowingSecHubServerTestScenario;
 import com.mercedesbenz.sechub.integrationtest.internal.PDSTestScenario;
 
 /**
@@ -32,7 +31,7 @@
  * @author Albert Tregnaghi
  *
  */
-public class Scenario12 extends AbstractSecHubServerTestScenario implements PDSTestScenario, CleanScenario {
+public class Scenario12 extends AbstractGrowingSecHubServerTestScenario implements PDSTestScenario {
 
     /**
      * User 1 is registered on startup, also owner and user of {@link #PROJECT_1}
@@ -69,4 +68,5 @@ protected void waitForTestDataAvailable() {
             ;
         /* @formatter:on */
     }
+
 }

sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/scenario13/Scenario13.java

@@ -1,12 +1,11 @@
 // SPDX-License-Identifier: MIT
 package com.mercedesbenz.sechub.integrationtest.scenario13;
 
-import static com.mercedesbenz.sechub.integrationtest.internal.IntegrationTestDefaultProfiles.PROFILE_9_PDS_LICENSESCAN_SPDX;
+import static com.mercedesbenz.sechub.integrationtest.internal.IntegrationTestDefaultProfiles.*;
 
 import com.mercedesbenz.sechub.integrationtest.api.TestProject;
 import com.mercedesbenz.sechub.integrationtest.api.TestUser;
-import com.mercedesbenz.sechub.integrationtest.internal.AbstractSecHubServerTestScenario;
-import com.mercedesbenz.sechub.integrationtest.internal.CleanScenario;
+import com.mercedesbenz.sechub.integrationtest.internal.AbstractGrowingSecHubServerTestScenario;
 import com.mercedesbenz.sechub.integrationtest.internal.PDSTestScenario;
 
 /**
@@ -32,7 +31,7 @@
  * </pre>
  *
  */
-public class Scenario13 extends AbstractSecHubServerTestScenario implements PDSTestScenario, CleanScenario {
+public class Scenario13 extends AbstractGrowingSecHubServerTestScenario implements PDSTestScenario {
 
     /**
      * User 1 is registered on startup, also owner and user of {@link #PROJECT_1}

sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/scenario2/Scenario2.java

@@ -83,9 +83,4 @@ protected void waitForTestDataAvailable() {
 		/* @formatter:on */
     }
 
-    @Override
-    public String getPrefixMainId() {
-        return "s02";
-    }
-
 }

sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/scenario3/Scenario3.java

@@ -66,9 +66,4 @@ protected void waitForTestDataAvailable() {
 		/* @formatter:on */
     }
 
-    @Override
-    public String getPrefixMainId() {
-        return PREFIX_MAIN_ID;
-    }
-
 }

sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/scenario5/Scenario5.java

@@ -5,8 +5,7 @@
 
 import com.mercedesbenz.sechub.integrationtest.api.TestProject;
 import com.mercedesbenz.sechub.integrationtest.api.TestUser;
-import com.mercedesbenz.sechub.integrationtest.internal.AbstractSecHubServerTestScenario;
-import com.mercedesbenz.sechub.integrationtest.internal.CleanScenario;
+import com.mercedesbenz.sechub.integrationtest.internal.AbstractGrowingSecHubServerTestScenario;
 import com.mercedesbenz.sechub.integrationtest.internal.PDSTestScenario;
 
 /**
@@ -33,7 +32,7 @@
  * @author Albert Tregnaghi
  *
  */
-public class Scenario5 extends AbstractSecHubServerTestScenario implements PDSTestScenario, CleanScenario {
+public class Scenario5 extends AbstractGrowingSecHubServerTestScenario implements PDSTestScenario {
 
     /**
      * User 1 is registered on startup, also owner and user of {@link #PROJECT_1}

sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/scenario7/Scenario7.java

@@ -59,9 +59,4 @@ protected void waitForTestDataAvailable() {
 		/* @formatter:on */
     }
 
-    @Override
-    public String getPrefixMainId() {
-        return "s07";
-    }
-
 }

sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/scenario8/Scenario8.java

@@ -29,8 +29,6 @@
  */
 public class Scenario8 extends AbstractGrowingSecHubServerTestScenario {
 
-    public static final String PREFIX_MAIN_ID = "s08";
-
     /**
      * User 1 is registered on startup, also owner and user of {@link #PROJECT_1}
      */
@@ -67,9 +65,4 @@ protected void waitForTestDataAvailable() {
 		/* @formatter:on */
     }
 
-    @Override
-    public String getPrefixMainId() {
-        return PREFIX_MAIN_ID;
-    }
-
 }

sechub-integrationtest/src/main/java/com/mercedesbenz/sechub/integrationtest/scenario9/Scenario9.java

@@ -5,8 +5,7 @@
 
 import com.mercedesbenz.sechub.integrationtest.api.TestProject;
 import com.mercedesbenz.sechub.integrationtest.api.TestUser;
-import com.mercedesbenz.sechub.integrationtest.internal.AbstractSecHubServerTestScenario;
-import com.mercedesbenz.sechub.integrationtest.internal.CleanScenario;
+import com.mercedesbenz.sechub.integrationtest.internal.AbstractGrowingSecHubServerTestScenario;
 import com.mercedesbenz.sechub.integrationtest.internal.IntegrationTestDefaultProfiles;
 import com.mercedesbenz.sechub.integrationtest.internal.PDSTestScenario;
 
@@ -39,7 +38,7 @@
  * @author Albert Tregnaghi
  *
  */
-public class Scenario9 extends AbstractSecHubServerTestScenario implements PDSTestScenario, CleanScenario {
+public class Scenario9 extends AbstractGrowingSecHubServerTestScenario implements PDSTestScenario {
 
     /**
      * User 1 is registered on startup, also owner and user of {@link #PROJECT_1}