Merge pull request kcp-dev#3272 from sttts/sttts-prow-artifacts

🌱 Configure prow artifacts correctly

Author: kcp-ci-bot

.prow.yaml

@@ -109,6 +109,8 @@ presubmits:
             - ./hack/run-with-prometheus.sh
             - make
             - test-e2e
+          args:
+            - ARTIFACT_DIR=$(ARTIFACTS) # propagate prow artifact directory
           env:
             - name: SUITES
               value: control-plane
@@ -137,6 +139,8 @@ presubmits:
             - ./hack/run-with-prometheus.sh
             - make
             - test-e2e
+          args:
+            - ARTIFACT_DIR=$(ARTIFACTS) # propagate prow artifact directory
           env:
             - name: SUITES
               value: control-plane
@@ -167,6 +171,8 @@ presubmits:
             - ./hack/run-with-prometheus.sh
             - make
             - test-e2e-shared-minimal
+          args:
+            - ARTIFACT_DIR=$(ARTIFACTS) # propagate prow artifact directory
           env:
             - name: SUITES
               value: control-plane
@@ -193,6 +199,8 @@ presubmits:
             - ./hack/run-with-prometheus.sh
             - make
             - test-e2e-sharded-minimal
+          args:
+            - ARTIFACT_DIR=$(ARTIFACTS) # propagate prow artifact directory
           env:
             - name: SUITES
               value: control-plane

Makefile

@@ -301,7 +301,7 @@ test-e2e-shared-minimal: build-all
 	mkdir -p "$(LOG_DIR)" "$(WORK_DIR)/.kcp"
 	rm -f "$(WORK_DIR)/.kcp/ready-to-test"
 	UNSAFE_E2E_HACK_DISABLE_ETCD_FSYNC=true NO_GORUN=1 \
-		./bin/test-server --quiet --log-file-path="$(LOG_DIR)/kcp.log" $(TEST_SERVER_ARGS) -- --feature-gates=$(TEST_FEATURE_GATES) 2>&1 & PID=$$! && echo "PID $$PID" && \
+		./bin/test-server --quiet --log-dir-path="$(LOG_DIR)" $(TEST_SERVER_ARGS) -- --feature-gates=$(TEST_FEATURE_GATES) 2>&1 & PID=$$! && echo "PID $$PID" && \
 	trap 'kill -TERM $$PID' TERM INT EXIT && \
 	while [ ! -f "$(WORK_DIR)/.kcp/ready-to-test" ]; do sleep 1; done && \
 	echo 'Starting test(s)' && \

cmd/sharded-test-server/cache.go

@@ -64,7 +64,10 @@ func startCacheServer(ctx context.Context, logDirPath, workingDir string, synthe
 	fmt.Fprintf(out, "running: %v\n", strings.Join(commandLine, " "))
 	cmd := exec.CommandContext(ctx, commandLine[0], commandLine[1:]...) //nolint:gosec
 
-	logFilePath := filepath.Join(logDirPath, ".kcp-cache", "out.log")
+	logFilePath := filepath.Join(".kcp-cache", "kcp.log")
+	if logDirPath != "" {
+		logFilePath = filepath.Join(logDirPath, "kcp-cache.log")
+	}
 	if err := os.MkdirAll(filepath.Dir(logFilePath), 0755); err != nil {
 		return nil, "", err
 	}

cmd/test-server/main.go

@@ -48,7 +48,7 @@ import (
 //
 //	$ go test -v --use-default-kcp-server
 func main() {
-	flag.String("log-file-path", ".kcp/kcp.log", "Path to the log file")
+	logDirPath := flag.String("log-dir-path", "", "Directory for log files. If empty, .kcp is used.")
 	quiet := flag.Bool("quiet", false, "Suppress output of the subprocesses")
 
 	// split flags into --shard-* and everything else (generic). The former are
@@ -67,7 +67,7 @@ func main() {
 	}
 	flag.CommandLine.Parse(genericFlags) //nolint:errcheck
 
-	if err := start(shardFlags, *quiet); err != nil {
+	if err := start(shardFlags, *logDirPath, *quiet); err != nil {
 		var exitErr *exec.ExitError
 		if errors.As(err, &exitErr) {
 			os.Exit(exitErr.ExitCode())
@@ -77,7 +77,7 @@ func main() {
 	}
 }
 
-func start(shardFlags []string, quiet bool) error {
+func start(shardFlags []string, logDirPath string, quiet bool) error {
 	// We use a shutdown context to know that it's time to gather metrics, before stopping the shard
 	shutdownCtx, shutdownCancel := context.WithCancel(genericapiserver.SetupSignalContext())
 	defer shutdownCancel()
@@ -98,7 +98,11 @@ func start(shardFlags []string, quiet bool) error {
 		return fmt.Errorf("failed to create client-ca: %w", err)
 	}
 
-	logFilePath := flag.Lookup("log-file-path").Value.String()
+	logFilePath := filepath.Join(".kcp", "kcp.log")
+	if logDirPath != "" {
+		logFilePath = filepath.Join(logDirPath, "kcp.log")
+	}
+
 	s := shard.NewShard(
 		"kcp",
 		".kcp",

test/e2e/framework/util.go

@@ -34,6 +34,7 @@ import (
 	"os"
 	"path"
 	"path/filepath"
+	"regexp"
 	"strconv"
 	"strings"
 	"sync"
@@ -161,15 +162,37 @@ func CreateTempDirForTest(t *testing.T, dirName string) (string, error) {
 }
 
 // ScratchDirs determines where artifacts and data should live for a test server.
+// The passed subDir is appended to the artifact directory and should be unique
+// to the test.
 func ScratchDirs(t *testing.T) (string, string, error) {
 	t.Helper()
-	artifactDir, err := CreateTempDirForTest(t, "artifacts")
+
+	artifactDir, err := CreateTempDirForTest(t, toTestDir(t.Name()))
 	if err != nil {
 		return "", "", err
 	}
 	return artifactDir, t.TempDir(), nil
 }
 
+// toTestDir converts a test name into a Unix-compatible directory name.
+func toTestDir(testName string) string {
+	// Insert a dash before uppercase letters in the middle of the string
+	reg := regexp.MustCompile(`([a-z0-9])([A-Z])`)
+	safeName := reg.ReplaceAllString(testName, "${1}-${2}")
+
+	// Replace any remaining non-alphanumeric characters (except dashes and underscores) with underscores
+	reg = regexp.MustCompile(`[^a-zA-Z0-9_-]+`)
+	safeName = reg.ReplaceAllString(safeName, "_")
+
+	// Remove any leading or trailing underscores or dashes
+	safeName = strings.Trim(safeName, "_-")
+
+	// Convert to lowercase (optional, depending on your preference)
+	safeName = strings.ToLower(safeName)
+
+	return safeName
+}
+
 func (c *kcpServer) CADirectory() string {
 	return c.dataDir
 }