Santize test names so diagnostics collection works. (#3468) (#3471)

Additionally, if diagnostics collection fails then capture and upload a
zip of the agent installation directory with the hope that it will
contain the logs and hint at the problem.

(cherry picked from commit 6a8d34a)

Co-authored-by: Craig MacKenzie <[email protected]>

pkg/testing/fixture_install.go

@@ -5,9 +5,11 @@
 package testing
 
 import (
+	"archive/zip"
 	"context"
 	"errors"
 	"fmt"
+	"io"
 	"io/fs"
 	"os"
 	"path/filepath"
@@ -227,12 +229,68 @@ func (f *Fixture) collectDiagnostics() {
 		f.t.Logf("failed to collect diagnostics; failed to create %s: %s", diagPath, err)
 		return
 	}
-	outputPath := filepath.Join(diagPath, fmt.Sprintf("%s-diagnostics-%s.zip", f.t.Name(), time.Now().Format(time.RFC3339)))
+
+	// Sub-test names are separated by "/" characters which are not valid filenames on Linux.
+	sanitizedTestName := strings.ReplaceAll(f.t.Name(), "/", "-")
+	outputPath := filepath.Join(diagPath, fmt.Sprintf("%s-diagnostics-%s.zip", sanitizedTestName, time.Now().Format(time.RFC3339)))
 
 	output, err := f.Exec(ctx, []string{"diagnostics", "-f", outputPath})
 	if err != nil {
 		f.t.Logf("failed to collect diagnostics to %s (%s): %s", outputPath, err, output)
+
+		// If collecting diagnostics fails, zip up the entire installation directory with the hope that it will contain logs.
+		f.t.Logf("creating zip archive of the installation directory: %s", f.workDir)
+		zipPath := filepath.Join(diagPath, fmt.Sprintf("%s-install-directory-%s.zip", sanitizedTestName, time.Now().Format(time.RFC3339)))
+		err = f.archiveInstallDirectory(f.workDir, zipPath)
+		if err != nil {
+			f.t.Logf("failed to zip install directory to %s: %s", zipPath, err)
+		}
+	}
+}
+
+func (f *Fixture) archiveInstallDirectory(installPath string, outputPath string) error {
+	file, err := os.Create(outputPath)
+	if err != nil {
+		return fmt.Errorf("creating zip output file %s: %w", outputPath, err)
+	}
+	defer file.Close()
+
+	w := zip.NewWriter(file)
+	defer w.Close()
+
+	walker := func(path string, info os.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+		if info.IsDir() {
+			return nil
+		}
+		file, err := os.Open(path)
+		if err != nil {
+			f.t.Logf("failed to add %s to zip, continuing: %s", path, err)
+			return nil
+		}
+		defer file.Close()
+
+		f, err := w.Create(path)
+		if err != nil {
+			return err
+		}
+
+		_, err = io.Copy(f, file)
+		if err != nil {
+			return err
+		}
+
+		return nil
 	}
+
+	err = filepath.Walk(f.workDir, walker)
+	if err != nil {
+		return fmt.Errorf("walking %s to create zip: %w", f.workDir, err)
+	}
+
+	return nil
 }
 
 func collectDiagFlag() bool {