save diagnostic and agent status on failed test (#5408)

Author: AndersonQ

pkg/testing/fixture_install.go

@@ -402,7 +402,7 @@ func getProcesses(t *gotesting.T, regex string) []runningProcess {
 //   - an error if any.
 func (f *Fixture) installDeb(ctx context.Context, installOpts *InstallOpts, opts []process.CmdOption) ([]byte, error) {
 	f.t.Logf("[test %s] Inside fixture installDeb function", f.t.Name())
-	//Prepare so that the f.srcPackage string is populated
+	// Prepare so that the f.srcPackage string is populated
 	err := f.EnsurePrepared(ctx)
 	if err != nil {
 		return nil, fmt.Errorf("failed to prepare: %w", err)
@@ -483,7 +483,7 @@ func (f *Fixture) installDeb(ctx context.Context, installOpts *InstallOpts, opts
 //   - an error if any.
 func (f *Fixture) installRpm(ctx context.Context, installOpts *InstallOpts, opts []process.CmdOption) ([]byte, error) {
 	f.t.Logf("[test %s] Inside fixture installRpm function", f.t.Name())
-	//Prepare so that the f.srcPackage string is populated
+	// Prepare so that the f.srcPackage string is populated
 	err := f.EnsurePrepared(ctx)
 	if err != nil {
 		return nil, fmt.Errorf("failed to prepare: %w", err)
@@ -649,12 +649,12 @@ func (f *Fixture) collectDiagnostics() {
 	ctx, cancel := context.WithTimeout(context.Background(), 1*time.Minute)
 	defer cancel()
 
-	dir, err := findProjectRoot(f.caller)
+	diagPath, err := f.DiagDir()
 	if err != nil {
-		f.t.Logf("failed to collect diagnostics; failed to find project root: %s", err)
+		f.t.Logf("failed to collect diagnostics: %v", err)
 		return
 	}
-	diagPath := filepath.Join(dir, "build", "diagnostics")
+
 	err = os.MkdirAll(diagPath, 0755)
 	if err != nil {
 		f.t.Logf("failed to collect diagnostics; failed to create %s: %s", diagPath, err)
@@ -699,6 +699,18 @@ func (f *Fixture) collectDiagnostics() {
 	}
 }
 
+// DiagDir returned {projectRoot}/build/diagnostics path. Files on this path
+// are saved if any test fails. Use it to save files for further investigation.
+func (f *Fixture) DiagDir() (string, error) {
+	dir, err := findProjectRoot(f.caller)
+	if err != nil {
+		return "", fmt.Errorf("failed to find project root: %w", err)
+	}
+
+	diagPath := filepath.Join(dir, "build", "diagnostics")
+	return diagPath, nil
+}
+
 func (f *Fixture) archiveInstallDirectory(installPath string, outputPath string) error {
 	file, err := os.Create(outputPath)
 	if err != nil {

testing/integration/package_version_test.go

@@ -91,10 +91,11 @@ func TestComponentBuildHashInDiagnostics(t *testing.T) {
 		"failed to install start agent [output: %s]", string(output))
 
 	stateBuff := bytes.Buffer{}
+	var status atesting.AgentStatusOutput
 	allHealthy := func() bool {
 		stateBuff.Reset()
 
-		status, err := f.ExecStatus(ctx)
+		status, err = f.ExecStatus(ctx)
 		if err != nil {
 			stateBuff.WriteString(fmt.Sprintf("failed to get agent status: %v",
 				err))
@@ -111,7 +112,6 @@ func TestComponentBuildHashInDiagnostics(t *testing.T) {
 
 			state := client.State(c.State)
 			if state != client.Healthy {
-
 				stateBuff.WriteString(fmt.Sprintf("%s not health, agent status output: %s",
 					c.Name, bs))
 				return false
@@ -130,6 +130,13 @@ func TestComponentBuildHashInDiagnostics(t *testing.T) {
 		allHealthy,
 		5*time.Minute, 10*time.Second,
 		"agent never became healthy. Last status: %v", &stateBuff)
+	t.Cleanup(func() {
+		if !t.Failed() {
+			return
+		}
+
+		t.Logf("test failed: last status output: %v", status)
+	})
 
 	agentbeat := "agentbeat"
 	if runtime.GOOS == "windows" {
@@ -166,6 +173,28 @@ func TestComponentBuildHashInDiagnostics(t *testing.T) {
 
 	diag := t.TempDir()
 	extractZipArchive(t, diagZip, diag)
+	// the test is flaky, so collecting some data to analyze later.
+	t.Cleanup(func() {
+		if !t.Failed() {
+			return
+		}
+
+		t.Logf("the test failed: trying to save the diagnostics used on the test")
+		diagDir, err := f.DiagDir()
+		if err != nil {
+			t.Logf("could not get diagnostics directory to save the diagnostics used on the test")
+			return
+		}
+
+		err = os.Rename(diagZip, filepath.Join(diagDir,
+			fmt.Sprintf("TestComponentBuildHashInDiagnostics-used-diag-%d.zip",
+				time.Now().Unix())))
+		if err != nil {
+			t.Logf("could not move diagnostics used in the test to %s: %v",
+				diagDir, err)
+			return
+		}
+	})
 
 	stateFilePath := filepath.Join(diag, "state.yaml")
 	stateYAML, err := os.Open(stateFilePath)