Initial setup for the system test api #2092

- introduce model
- introduce first version of API
- added some unit tests
- added one integration test

- implemented config features:
  - configrue url + credentials for sechub(remote)
  - configure start stop for sechub (local)
  - configure start stop for pds solutions (local)
  - configure executors for sechub
  - configure tests + asserts
  - automatically set calculated parts into configuration
    (altering configuration, but this is very useful for
     debugging)
  - automatically calculate pds server config file location
  - the wrong configuration exception does now always contain
    a stacktrace with the altered JSON

- implemented runtime features
  - start /stop of sechub (local)
  - start /stop of pds-solutions (local)
  - environment variables on script launch (local)
  - fallback default-profile and default-project when
    missing in configuration + link to executors

gradle/projects.gradle

@@ -18,6 +18,7 @@ projectType = [
                project(':sechub-storage-core'),
                project(':sechub-wrapper-owasp-zap'),
                project(':sechub-pds-tools'),
+               project(':sechub-systemtest'),
 
             ],
 

sechub-pds-tools/build.gradle

@@ -16,6 +16,9 @@ dependencies {
     implementation project(':sechub-commons-pds')
     implementation project(':sechub-commons-archive')
 
+    // we need the next line to provide system tests via pds tools!
+    implementation project(':sechub-systemtest')
+
     implementation library.apache_commons_io
     implementation library.apache_commons_compress // we need TAR archive support
 

sechub-systemtest/build.gradle

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: MIT
+ /*============================================================================
+ * Build file for subproject
+ *
+ * Root build file: "${rootProject.projectDir}/build.gradle"
+ * ============================================================================
+ */
+plugins {
+    id 'java-library'
+}
+
+version =   VersionData.getServerVersion()
+
+dependencies {
+
+    implementation project(':sechub-commons-model')
+
+    testImplementation spring_boot_dependency.junit_jupiter
+    testImplementation spring_boot_dependency.mockito_core
+
+    implementation spring_boot_dependency.logback_classic
+
+}

sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/SystemTestAPI.java

@@ -0,0 +1,34 @@
+package com.mercedesbenz.sechub.systemtest;
+
+import com.mercedesbenz.sechub.systemtest.config.SystemTestConfiguration;
+import com.mercedesbenz.sechub.systemtest.config.SystemTestConfigurationBuilder;
+import com.mercedesbenz.sechub.systemtest.runtime.ExecutionSupport;
+import com.mercedesbenz.sechub.systemtest.runtime.LocationSupport;
+import com.mercedesbenz.sechub.systemtest.runtime.SystemTestResult;
+import com.mercedesbenz.sechub.systemtest.runtime.SystemTestRuntime;
+import com.mercedesbenz.sechub.systemtest.runtime.VariableSupport;
+
+/**
+ * This is the central point for system tests
+ *
+ * @author Albert Tregnaghi
+ *
+ */
+public class SystemTestAPI {
+
+    public static SystemTestConfigurationBuilder configure() {
+        return SystemTestConfiguration.builder();
+    }
+
+    public static SystemTestResult runSystemTests(SystemTestConfiguration configuration, String pathToPdsSolution) {
+        LocationSupport locationSupport = new LocationSupport(pathToPdsSolution, null);
+
+        VariableSupport variableSupport = new VariableSupport();
+        ExecutionSupport execSupport = new ExecutionSupport(variableSupport);
+
+        SystemTestRuntime runtime = new SystemTestRuntime(locationSupport, execSupport);
+
+        return runtime.run(configuration);
+    }
+
+}

sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/config/AbstractDefinition.java

@@ -0,0 +1,13 @@
+package com.mercedesbenz.sechub.systemtest.config;
+
+public abstract class AbstractDefinition {
+    private String comment;
+
+    public String getComment() {
+        return comment;
+    }
+
+    public void setComment(String comment) {
+        this.comment = comment;
+    }
+}

sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/config/AssertContainsStringsDefinition.java

@@ -0,0 +1,17 @@
+package com.mercedesbenz.sechub.systemtest.config;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class AssertContainsStringsDefinition extends AbstractDefinition {
+
+    private List<String> values = new ArrayList<>();
+
+    public List<String> getValues() {
+        return values;
+    }
+
+    public void setValues(List<String> strings) {
+        this.values = strings;
+    }
+}

sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/config/AssertEqualsFileDefinition.java

@@ -0,0 +1,14 @@
+package com.mercedesbenz.sechub.systemtest.config;
+
+public class AssertEqualsFileDefinition extends AbstractDefinition {
+
+    private String path;
+
+    public String getPath() {
+        return path;
+    }
+
+    public void setPath(String path) {
+        this.path = path;
+    }
+}

sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/config/AssertSechubResultDefinition.java

@@ -0,0 +1,36 @@
+package com.mercedesbenz.sechub.systemtest.config;
+
+import java.util.Optional;
+
+import com.mercedesbenz.sechub.commons.model.TrafficLight;
+
+public class AssertSechubResultDefinition extends AbstractDefinition {
+
+    private Optional<TrafficLight> hasTrafficLight = Optional.ofNullable(null);
+    private Optional<AssertEqualsFileDefinition> equalsFile = Optional.ofNullable(null);
+    private Optional<AssertContainsStringsDefinition> containsStrings = Optional.ofNullable(null);
+
+    public Optional<TrafficLight> getHasTrafficLight() {
+        return hasTrafficLight;
+    }
+
+    public void setHasTrafficLight(Optional<TrafficLight> hasTrafficLight) {
+        this.hasTrafficLight = hasTrafficLight;
+    }
+
+    public void setEqualsFile(Optional<AssertEqualsFileDefinition> equalsFile) {
+        this.equalsFile = equalsFile;
+    }
+
+    public Optional<AssertEqualsFileDefinition> getEqualsFile() {
+        return equalsFile;
+    }
+
+    public Optional<AssertContainsStringsDefinition> getContainsStrings() {
+        return containsStrings;
+    }
+
+    public void setContainsStrings(Optional<AssertContainsStringsDefinition> containsStrings) {
+        this.containsStrings = containsStrings;
+    }
+}

sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/config/ConfigConstants.java

@@ -0,0 +1,13 @@
+package com.mercedesbenz.sechub.systemtest.config;
+
+public class ConfigConstants {
+
+    private static final String PREFIX_RUNTIME = "runtime.";
+
+    public static final String RUNTIME_WORKSPACE_ROOT = PREFIX_RUNTIME + "workspaceRoot";
+    public static final String RUNTIME_PDS_SOLUTION_ROOT = PREFIX_RUNTIME + "pdsSolutionRoot";
+    public static final String RUNTIME_SECHUB_SOLUTION_ROOT = PREFIX_RUNTIME + "secHubSolutionRoot";
+
+    public static final String DEFAULT_PROJECT_NAME = "default-project";
+    public static final String DEFAULT_PROFILE_ID = "default-profile";
+}

sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/config/CredentialsDefinition.java

@@ -0,0 +1,24 @@
+package com.mercedesbenz.sechub.systemtest.config;
+
+public class CredentialsDefinition extends AbstractDefinition {
+
+    private String userId;
+
+    private String apiToken;
+
+    public String getApiToken() {
+        return apiToken;
+    }
+
+    public void setApiToken(String apiToken) {
+        this.apiToken = apiToken;
+    }
+
+    public String getUserId() {
+        return userId;
+    }
+
+    public void setUserId(String userId) {
+        this.userId = userId;
+    }
+}

sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/config/ExecutionStepDefinition.java

@@ -0,0 +1,24 @@
+package com.mercedesbenz.sechub.systemtest.config;
+
+import java.util.Optional;
+
+/**
+ * Represents a step definition which really executes/does something at runtime.
+ * For example: execute a script
+ *
+ * @author Albert Tregnaghi
+ *
+ */
+public class ExecutionStepDefinition extends AbstractDefinition {
+
+    private Optional<ScriptDefinition> script = Optional.ofNullable(null);
+
+    public Optional<ScriptDefinition> getScript() {
+        return script;
+    }
+
+    public void setScript(Optional<ScriptDefinition> script) {
+        this.script = script;
+    }
+
+}

sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/config/LocalSecHubDefinition.java

@@ -0,0 +1,36 @@
+package com.mercedesbenz.sechub.systemtest.config;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class LocalSecHubDefinition extends AbstractDefinition {
+
+    private List<ExecutionStepDefinition> start = new ArrayList<>();
+
+    private SecHubConfigurationDefinition configure = new SecHubConfigurationDefinition();
+
+    private List<ExecutionStepDefinition> stop = new ArrayList<>();
+
+    private String baseDir;
+
+    public SecHubConfigurationDefinition getConfigure() {
+        return configure;
+    }
+
+    public List<ExecutionStepDefinition> getStart() {
+        return start;
+    }
+
+    public List<ExecutionStepDefinition> getStop() {
+        return stop;
+    }
+
+    public void setBaseDir(String baseDir) {
+        this.baseDir = baseDir;
+    }
+
+    public String getBaseDir() {
+        return baseDir;
+    }
+
+}

sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/config/LocalSetupDefinition.java

@@ -0,0 +1,24 @@
+package com.mercedesbenz.sechub.systemtest.config;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class LocalSetupDefinition extends AbstractDefinition {
+
+    private LocalSecHubDefinition secHub = new LocalSecHubDefinition();
+
+    private List<PDSSolutionDefinition> pdsSolutions = new ArrayList<>();
+
+    public List<PDSSolutionDefinition> getPdsSolutions() {
+        return pdsSolutions;
+    }
+
+    public void setPdsSolutions(List<PDSSolutionDefinition> solutions) {
+        this.pdsSolutions = solutions;
+    }
+
+    public LocalSecHubDefinition getSecHub() {
+        return secHub;
+    }
+
+}

sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/config/PDSSolutionDefinition.java

@@ -0,0 +1,68 @@
+package com.mercedesbenz.sechub.systemtest.config;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class PDSSolutionDefinition extends AbstractDefinition {
+
+    private String name;
+
+    private String baseDir;
+
+    private String pathToPdsServerConfigFile;
+
+    private List<ExecutionStepDefinition> start = new ArrayList<>();
+
+    private boolean waitForPDSAvailable = true;
+
+    private List<ExecutionStepDefinition> stop = new ArrayList<>();
+
+    public String getPathToPdsServerConfigFile() {
+        return pathToPdsServerConfigFile;
+    }
+
+    public void setPathToPdsServerConfigFile(String pathToPdsServerConfigFile) {
+        this.pathToPdsServerConfigFile = pathToPdsServerConfigFile;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public boolean isWaitForPDSAvailable() {
+        return waitForPDSAvailable;
+    }
+
+    public void setWaitForPDSAvailable(boolean waitForAvailable) {
+        this.waitForPDSAvailable = waitForAvailable;
+    }
+
+    public List<ExecutionStepDefinition> getStart() {
+        return start;
+    }
+
+    public List<ExecutionStepDefinition> getStop() {
+        return stop;
+    }
+
+    /**
+     * Set the base directory for the solution. This is optional. If not defined,
+     * the test runtime will try to resolve it automatically (by name and defined
+     * folder location of "sechub-pds-solutions". The PDS base directory is
+     * important, because the PDS configuration file must be loaded to determine the
+     * provided products inside the PDS.
+     *
+     * @param baseDir
+     */
+    public void setBaseDirectory(String baseDir) {
+        this.baseDir = baseDir;
+    }
+
+    public String getBaseDir() {
+        return baseDir;
+    }
+}

sechub-systemtest/src/main/java/com/mercedesbenz/sechub/systemtest/config/ProjectDefinition.java

@@ -0,0 +1,22 @@
+package com.mercedesbenz.sechub.systemtest.config;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class ProjectDefinition extends AbstractDefinition {
+
+    private String name;
+    private List<String> profiles = new ArrayList<>();
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public List<String> getProfiles() {
+        return profiles;
+    }
+}