[system tests] Allow setting an optional prefix for the service TestRunID (#2744)

This PR allows to customize the Service TestRunID used in system
tests to include a prefix string. This prefix is defined via environment
variable "ELASTIC_PACKAGE_PREFIX_SERVICE_TEST_RUN_ID"

Author: mrodm

internal/common/helpers.go

@@ -58,7 +58,11 @@ func ToStringSlice(val interface{}) ([]string, error) {
 }
 
 func CreateTestRunID() string {
-	return fmt.Sprintf("%d", rand.Intn(testRunMaxID-testRunMinID)+testRunMinID)
+	return CreateTestRunIDWithPrefix("")
+}
+
+func CreateTestRunIDWithPrefix(prefix string) string {
+	return fmt.Sprintf("%s%d", prefix, rand.Intn(testRunMaxID-testRunMinID)+testRunMinID)
 }
 
 func ProcessResourceApplyResults(results resource.ApplyResults) string {

internal/testrunner/runners/system/tester.go

@@ -136,6 +136,7 @@ var (
 	enableIndependentAgentsEnv   = environment.WithElasticPackagePrefix("TEST_ENABLE_INDEPENDENT_AGENT")
 	dumpScenarioDocsEnv          = environment.WithElasticPackagePrefix("TEST_DUMP_SCENARIO_DOCS")
 	fieldValidationTestMethodEnv = environment.WithElasticPackagePrefix("FIELD_VALIDATION_TEST_METHOD")
+	prefixServiceTestRunIDEnv    = environment.WithElasticPackagePrefix("PREFIX_SERVICE_TEST_RUN_ID")
 )
 
 type fieldValidationMethod int
@@ -483,7 +484,12 @@ func (r *tester) createServiceInfo() (servicedeployer.ServiceInfo, error) {
 	svcInfo.Name = r.testFolder.Package
 	svcInfo.Logs.Folder.Local = r.locationManager.ServiceLogDir()
 	svcInfo.Logs.Folder.Agent = ServiceLogsAgentDir
-	svcInfo.Test.RunID = common.CreateTestRunID()
+
+	prefix := ""
+	if v, found := os.LookupEnv(prefixServiceTestRunIDEnv); found && v != "" {
+		prefix = v
+	}
+	svcInfo.Test.RunID = common.CreateTestRunIDWithPrefix(prefix)
 
 	if r.runTearDown || r.runTestsOnly {
 		logger.Debug("Skip creating output directory")

test/packages/parallel/terraform_local/data_stream/local/_dev/deploy/tf/main.tf

@@ -1,6 +1,6 @@
 resource "local_file" "log" {
   source          = "./files/example.log"
-  filename        = "/tmp/service_logs/file.log"
+  filename        = "/tmp/service_logs/file-${var.TEST_RUN_ID}.log"
   file_permission = "0777"
 }
 

test/packages/parallel/terraform_local/data_stream/local/_dev/deploy/tf/variables.tf

@@ -20,3 +20,7 @@ variable "ENVIRONMENT" {
 variable "REPO" {
   default = "unknown-repo-name"
 }
+
+variable "TEST_RUN_ID" {
+  default = "detached"
+}

test/packages/parallel/terraform_local/data_stream/local/_dev/test/system/test-default-config.yml

@@ -2,7 +2,7 @@ wait_for_data_timeout: 1m
 data_stream:
   vars:
     paths:
-      - "{{ SERVICE_LOGS_DIR }}/file.log"
+      - "{{ SERVICE_LOGS_DIR }}/file-{{ TEST_RUN_ID }}.log"
       - "{{ SERVICE_LOGS_DIR }}/file_vars.log"
 assert:
   hit_count: 2

test/packages/parallel/terraform_local/data_stream/outputs/_dev/deploy/tf/main.tf

@@ -1,7 +1,3 @@
-variable "TEST_RUN_ID" {
-  default = "detached"
-}
-
 resource "local_file" "log" {
   source          = "./files/example.log"
   filename        = "/tmp/service_logs/${var.TEST_RUN_ID}.log"

test/packages/parallel/terraform_local/data_stream/outputs/_dev/deploy/tf/variables.tf

@@ -20,3 +20,7 @@ variable "ENVIRONMENT" {
 variable "REPO" {
   default = "unknown-repo-name"
 }
+
+variable "TEST_RUN_ID" {
+  default = "detached"
+}