Randomize errand job name during tests to avoid cgroup conflicts

Tests in the integration2 package use the same `errand` job name when
executing `bpm run`. When these tests are run in quick succession, it
causes a race between cgroups from the previous test (with the same
name) being cleaned up after `bpm run` is complete and the currently
executing test. When `runc` tries to create a new container, it finds
a cgroup with the same name (errand) already exists and has processes
inside it, so it errors with a `runc run failed: container's cgroup is
not empty: 2 process(es) found` message.

This change adds a random string to the errand job's name, so cgroups do
not conflict with each other.

Signed-off-by: Nishad Mathur <nishad.mathur@broadcom.com>

Author: Rajath Agasthya

src/bpm/integration2/run_test.go

@@ -20,6 +20,7 @@ import (
 	"bytes"
 	"flag"
 	"fmt"
+	"math/rand"
 	"os"
 	"path/filepath"
 	"strings"
@@ -30,10 +31,20 @@ import (
 	"bpm/integration2/bpmsandbox"
 )
 
+const charset = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
+
 var runcExe = flag.String("runcExe", "/var/vcap/packages/bpm/bin/runc", "path to the runc executable")
 var tiniExe = flag.String("tiniExe", "/var/vcap/packages/bpm/bin/tini", "path to the tini executable")
 var bpmExe = flag.String("bpmExe", "", "path to bpm executable")
 
+func randomString(length int) string {
+	b := make([]byte, length)
+	for i := range b {
+		b[i] = charset[rand.Intn(len(charset))]
+	}
+	return string(b)
+}
+
 func TestMain(m *testing.M) {
 	flag.Parse()
 
@@ -61,11 +72,12 @@ func TestRun(t *testing.T) {
 	s := bpmsandbox.New(t)
 	defer s.Cleanup()
 
-	s.LoadFixture("errand", "testdata/errand.yml")
+	errandJob := generateJobName("errand")
+	s.LoadFixture(errandJob, "testdata/errand.yml")
 	stdoutSentinel := "stdout"
 	stderrSentinel := "stderr"
 
-	cmd := s.BPMCmd("run", "errand")
+	cmd := s.BPMCmd("run", errandJob, "-p", "errand")
 	output, err := cmd.CombinedOutput()
 	if err != nil {
 		t.Fatalf("failed to run bpm: %s", output)
@@ -79,7 +91,7 @@ func TestRun(t *testing.T) {
 		t.Errorf("stdout/stderr did not contain %q, contents: %q", stderrSentinel, combinedOutput)
 	}
 
-	stdout, err := os.ReadFile(s.Path("sys", "log", "errand", "errand.stdout.log"))
+	stdout, err := os.ReadFile(s.Path("sys", "log", errandJob, "errand.stdout.log"))
 	if err != nil {
 		t.Fatalf("failed to read stdout log: %v", err)
 	}
@@ -89,7 +101,7 @@ func TestRun(t *testing.T) {
 		t.Errorf("stdout log file did not contain %q, stdoutLog: %q", stdoutSentinel, stdoutLog)
 	}
 
-	stderr, err := os.ReadFile(s.Path("sys", "log", "errand", "errand.stderr.log"))
+	stderr, err := os.ReadFile(s.Path("sys", "log", errandJob, "errand.stderr.log"))
 	if err != nil {
 		t.Fatalf("failed to read stderr log: %v", err)
 	}
@@ -98,24 +110,30 @@ func TestRun(t *testing.T) {
 		t.Errorf("stderr log file did not contain %q, contents: %q", stderrSentinel, stderrLog)
 	}
 
-	pidfile := s.Path("sys", "run", "bpm", "errand", "errand.pid")
+	pidfile := s.Path("sys", "run", "bpm", errandJob, "errand.pid")
 	_, err = os.Stat(pidfile)
 	if !os.IsNotExist(err) {
 		t.Errorf("expected %q not to exist but it did", pidfile)
 	}
 }
 
+func generateJobName(prefix string) string {
+	return fmt.Sprintf("%s-%s", prefix, randomString(6))
+}
+
 func TestRunWithEnvFlags(t *testing.T) {
 	t.Parallel()
 	s := bpmsandbox.New(t)
 	defer s.Cleanup()
 
-	s.LoadFixture("errand", "testdata/env-flag.yml")
+	errandJob := generateJobName("errand")
+	s.LoadFixture(errandJob, "testdata/env-flag.yml")
 	sentinel := "sentinel"
 
 	cmd := s.BPMCmd(
 		"run",
-		"errand",
+		errandJob,
+		"-p", "errand",
 		"-e", fmt.Sprintf("ENVKEY=%s", sentinel),
 	)
 	output, err := cmd.CombinedOutput()
@@ -134,13 +152,15 @@ func TestRunWithVolumeFlags(t *testing.T) {
 	s := bpmsandbox.New(t)
 	defer s.Cleanup()
 
-	s.LoadFixture("errand", "testdata/volume-flag.yml")
+	errandJob := generateJobName("errand")
+	s.LoadFixture(errandJob, "testdata/volume-flag.yml")
 	extraVolumeDir := s.Path("data", "extra-volume")
 	extraVolumeFile := filepath.Join(extraVolumeDir, "data.txt")
 
 	cmd := s.BPMCmd(
 		"run",
-		"errand",
+		errandJob,
+		"-p", "errand",
 		"-v", fmt.Sprintf("%s:writable,allow_executions", extraVolumeDir),
 		"-e", fmt.Sprintf("FILE_TO_WRITE_TO=%s", extraVolumeFile),
 	)