Make UploadLogs use options struct (#11723)

GoogleCloudPlatform · Sep 17, 2024 · 3dfa7c3 · 3dfa7c3
1 parent d60a3c8
commit 3dfa7c3
Show file tree

Hide file tree

Showing 3 changed files with 82 additions and 17 deletions.
diff --git a/.ci/magician/cmd/check_cassettes.go b/.ci/magician/cmd/check_cassettes.go
@@ -110,7 +110,11 @@ func execCheckCassettes(commit string, vt *vcr.Tester, ctlr *source.Controller)
 	if err != nil {
 		fmt.Println("Error running VCR: ", err)
 	}
-	if err := vt.UploadLogs("vcr-check-cassettes", "", "", false, false, vcr.Replaying, provider.Beta); err != nil {
+	if err := vt.UploadLogs(vcr.UploadLogsOptions{
+		LogBucket: "vcr-check-cassettes",
+		Mode:      vcr.Replaying,
+		Version:   provider.Beta,
+	}); err != nil {
 		return fmt.Errorf("error uploading logs: %w", err)
 	}
 	fmt.Println(len(result.FailedTests), " failed tests: ", result.FailedTests)

diff --git a/.ci/magician/cmd/test_terraform_vcr.go b/.ci/magician/cmd/test_terraform_vcr.go
@@ -195,7 +195,13 @@ func execTestTerraformVCR(prNumber, mmCommitSha, buildID, projectID, buildStep,
 		testState = "failure"
 	}
 
-	if err := vt.UploadLogs("ci-vcr-logs", prNumber, buildID, false, false, vcr.Replaying, provider.Beta); err != nil {
+	if err := vt.UploadLogs(vcr.UploadLogsOptions{
+		LogBucket: "ci-vcr-logs",
+		PRNumber:  prNumber,
+		BuildID:   buildID,
+		Mode:      vcr.Replaying,
+		Version:   provider.Beta,
+	}); err != nil {
 		return fmt.Errorf("error uploading replaying logs: %w", err)
 	}
 
@@ -260,7 +266,14 @@ func execTestTerraformVCR(prNumber, mmCommitSha, buildID, projectID, buildStep,
 			return fmt.Errorf("error uploading cassettes: %w", err)
 		}
 
-		if err := vt.UploadLogs("ci-vcr-logs", prNumber, buildID, true, false, vcr.Recording, provider.Beta); err != nil {
+		if err := vt.UploadLogs(vcr.UploadLogsOptions{
+			LogBucket: "ci-vcr-logs",
+			PRNumber:  prNumber,
+			BuildID:   buildID,
+			Parallel:  true,
+			Mode:      vcr.Recording,
+			Version:   provider.Beta,
+		}); err != nil {
 			return fmt.Errorf("error uploading recording logs: %w", err)
 		}
 
@@ -283,9 +296,18 @@ func execTestTerraformVCR(prNumber, mmCommitSha, buildID, projectID, buildStep,
 				testState = "failure"
 			}
 
-			if err := vt.UploadLogs("ci-vcr-logs", prNumber, buildID, true, true, vcr.Replaying, provider.Beta); err != nil {
+			if err := vt.UploadLogs(vcr.UploadLogsOptions{
+				LogBucket:      "ci-vcr-logs",
+				PRNumber:       prNumber,
+				BuildID:        buildID,
+				Parallel:       true,
+				AfterRecording: true,
+				Mode:           vcr.Replaying,
+				Version:        provider.Beta,
+			}); err != nil {
 				return fmt.Errorf("error uploading recording logs: %w", err)
 			}
+
 		}
 
 		hasTerminatedTests := (len(recordingResult.PassedTests) + len(recordingResult.FailedTests)) < len(replayingResult.FailedTests)

diff --git a/.ci/magician/vcr/tester.go b/.ci/magician/vcr/tester.go
@@ -396,39 +396,78 @@ func (vt *Tester) getLogPath(mode Mode, version provider.Version) (string, error
 	return logPath, nil
 }
 
-func (vt *Tester) UploadLogs(logBucket, prNumber, buildID string, parallel, afterRecording bool, mode Mode, version provider.Version) error {
-	bucketPath := fmt.Sprintf("gs://%s/%s/", logBucket, version)
-	if prNumber != "" {
-		bucketPath += fmt.Sprintf("refs/heads/auto-pr-%s/", prNumber)
+// UploadLogsOptions defines options for uploading logs.
+type UploadLogsOptions struct {
+	LogBucket      string
+	PRNumber       string
+	BuildID        string
+	Parallel       bool
+	AfterRecording bool
+	Mode           Mode
+	Version        provider.Version
+}
+
+// UploadLogs uploads logs to Google Cloud Storage.
+func (vt *Tester) UploadLogs(opts UploadLogsOptions) error {
+	bucketPath := fmt.Sprintf("gs://%s/%s/", opts.LogBucket, opts.Version)
+	if opts.PRNumber != "" {
+		bucketPath += fmt.Sprintf("refs/heads/auto-pr-%s/", opts.PRNumber)
 	}
-	if buildID != "" {
-		bucketPath += fmt.Sprintf("artifacts/%s/", buildID)
+	if opts.BuildID != "" {
+		bucketPath += fmt.Sprintf("artifacts/%s/", opts.BuildID)
 	}
-	lgky := logKey{mode, version}
+	lgky := logKey{opts.Mode, opts.Version}
 	logPath, ok := vt.logPaths[lgky]
 	if !ok {
-		return fmt.Errorf("no log path found for mode %s and version %s", mode.Lower(), version)
+		return fmt.Errorf("no log path found for mode %s and version %s", opts.Mode.Lower(), opts.Version)
+	}
+	args := []string{
+		"-h",
+		"Content-Type:text/plain",
+		"-q",
+		"cp",
+		"-r",
+		filepath.Join(vt.baseDir, "testlogs", fmt.Sprintf("%s_test.log", opts.Mode.Lower())),
+		bucketPath + "build-log/",
 	}
-	args := []string{"-h", "Content-Type:text/plain", "-q", "cp", "-r", filepath.Join(vt.baseDir, "testlogs", fmt.Sprintf("%s_test.log", mode.Lower())), bucketPath + "build-log/"}
 	fmt.Println("Uploading build log:\n", "gsutil", strings.Join(args, " "))
 	if _, err := vt.rnr.Run("gsutil", args, nil); err != nil {
 		fmt.Println("Error uploading build log: ", err)
 	}
 	var suffix string
-	if afterRecording {
+	if opts.AfterRecording {
 		suffix = "_after_recording"
 	}
-	if parallel {
-		args := []string{"-h", "Content-Type:text/plain", "-m", "-q", "cp", "-r", filepath.Join(vt.baseDir, "testlogs", mode.Lower()+"_build", "*"), fmt.Sprintf("%sbuild-log/%s_build%s/", bucketPath, mode.Lower(), suffix)}
+	if opts.Parallel {
+		args := []string{
+			"-h",
+			"Content-Type:text/plain",
+			"-m",
+			"-q",
+			"cp",
+			"-r",
+			filepath.Join(vt.baseDir, "testlogs", opts.Mode.Lower()+"_build", "*"),
+			fmt.Sprintf("%sbuild-log/%s_build%s/", bucketPath, opts.Mode.Lower(), suffix),
+		}
 		fmt.Println("Uploading build logs:\n", "gsutil", strings.Join(args, " "))
 		if _, err := vt.rnr.Run("gsutil", args, nil); err != nil {
 			fmt.Println("Error uploading build logs: ", err)
 		}
 	}
-	args = []string{"-h", "Content-Type:text/plain", "-m", "-q", "cp", "-r", filepath.Join(logPath, "*"), fmt.Sprintf("%s%s%s/", bucketPath, mode.Lower(), suffix)}
+	args = []string{
+		"-h",
+		"Content-Type:text/plain",
+		"-m",
+		"-q",
+		"cp",
+		"-r",
+		filepath.Join(logPath, "*"),
+		fmt.Sprintf("%s%s%s/", bucketPath, opts.Mode.Lower(), suffix),
+	}
 	fmt.Println("Uploading logs:\n", "gsutil", strings.Join(args, " "))
 	if _, err := vt.rnr.Run("gsutil", args, nil); err != nil {
 		fmt.Println("Error uploading logs: ", err)
+		vt.printLogs(logPath)
 	}
 	return nil
 }