Merge branch 'main' into key-revocation-action-field

Author: karolgorc

.ci/magician/cmd/templates/vcr/non_exercised_tests.tmpl

@@ -1,13 +1,13 @@
-{{- if or (gt (len .NotRunBetaTests) 0) (gt (len .NotRunGATests) 0) -}}
+{{- if or (gt (len .NotRunBetaTests) 0) (gt (len .NotRunGATests) 0)}}
 #### Non-exercised tests
 
 {{if gt (len .NotRunBetaTests) 0 -}}
-Tests were added that are skipped in VCR:
+{{color "red" "Tests were added that are skipped in VCR:"}}
 {{range .NotRunBetaTests}}{{. | printf "- %s\n"}}{{end}}
 {{end}}
 
 {{if gt (len .NotRunGATests) 0 -}}
-Tests were added that are GA-only additions and require manual runs:
+{{color "red" "Tests were added that are GA-only additions and require manual runs:"}}
 {{range .NotRunGATests}}{{. | printf "- %s\n"}}{{end}}
 {{end}}
 {{end}}

.ci/magician/cmd/templates/vcr/record_replay.tmpl

@@ -1,11 +1,19 @@
 {{- if gt (len .RecordingResult.PassedTests) 0 -}}
 {{color "green" "Tests passed during RECORDING mode:"}}
-{{range .RecordingResult.PassedTests}}`{{.}}`[[Debug log](https://storage.cloud.google.com/ci-vcr-logs/beta/refs/heads/auto-pr-{{$.PRNumber}}/artifacts/{{$.BuildID}}/recording/{{.}}.log)]
+{{range .RecordingResult.PassedTests -}}
+`{{.}}` {{/* remove trailing whitespace */ -}}
+  [[Debug log](https://storage.cloud.google.com/{{$.LogBucket}}/{{$.Version}}/refs/heads/{{$.Head}}/artifacts/{{$.BuildID}}/recording/{{.}}.log)]
+{{/* remove trailing whitespace */ -}}
 {{end}}
 
-{{- if gt (len .ReplayingAfterRecordingResult.FailedTests ) 0 -}}
+{{- if gt (len .ReplayingAfterRecordingResult.FailedTests ) 0 }}
+
 {{color "red" "Tests failed when rerunning REPLAYING mode:"}}
-{{range .ReplayingAfterRecordingResult.FailedTests}}`{{.}}`[[Error message](https://storage.cloud.google.com/ci-vcr-logs/beta/refs/heads/auto-pr-{{$.PRNumber}}/artifacts/{{$.BuildID}}/build-log/replaying_build_after_recording/{{.}}_replaying_test.log)] [[Debug log](https://storage.cloud.google.com/ci-vcr-logs/beta/refs/heads/auto-pr-{{$.PRNumber}}/artifacts/{{$.BuildID}}/replaying_after_recording/{{.}}.log)]
+{{range .ReplayingAfterRecordingResult.FailedTests -}}
+`{{.}}` {{/* remove trailing whitespace */ -}}
+  [[Error message](https://storage.cloud.google.com/{{$.LogBucket}}/{{$.Version}}/refs/heads/{{$.Head}}/artifacts/{{$.BuildID}}/build-log/replaying_build_after_recording/{{.}}_replaying_test.log)] {{/* remove trailing whitespace */ -}}
+  [[Debug log](https://storage.cloud.google.com/{{$.LogBucket}}/{{$.Version}}/refs/heads/{{$.Head}}/artifacts/{{$.BuildID}}/replaying_after_recording/{{.}}.log)]
+{{/* remove trailing whitespace */ -}}
 {{end}}
 
 Tests failed due to non-determinism or randomness when the VCR replayed the response after the HTTP request was made.
@@ -20,12 +28,19 @@ Please fix these to complete your PR. If you believe these test failures to be i
 
 {{if gt (len .RecordingResult.FailedTests) 0 -}}
 {{color "red" "Tests failed during RECORDING mode:"}}
-{{range .RecordingResult.FailedTests}}`{{.}}`[[Error message](https://storage.cloud.google.com/ci-vcr-logs/beta/refs/heads/auto-pr-{{$.PRNumber}}/artifacts/{{$.BuildID}}/build-log/recording_build/{{.}}_recording_test.log)] [[Debug log](https://storage.cloud.google.com/ci-vcr-logs/beta/refs/heads/auto-pr-{{$.PRNumber}}/artifacts/{{$.BuildID}}/recording/{{.}}.log)]
+{{range .RecordingResult.FailedTests -}}
+`{{.}}` {{/* remove trailing whitespace */ -}}
+  [[Error message](https://storage.cloud.google.com/{{$.LogBucket}}/{{$.Version}}/refs/heads/{{$.Head}}/artifacts/{{$.BuildID}}/build-log/recording_build/{{.}}_recording_test.log)] {{/* remove trailing whitespace */ -}}
+  [[Debug log](https://storage.cloud.google.com/{{$.LogBucket}}/{{$.Version}}/refs/heads/{{$.Head}}/artifacts/{{$.BuildID}}/recording/{{.}}.log)]
+{{/* remove trailing whitespace */ -}}
 {{end}}
 {{end}} {{- /* end of if gt (len .RecordingResult.FailedTests) 0 */ -}}
 
-{{if .HasTerminatedTests}}{{color "red" "Several tests got terminated during RECORDING mode."}}{{end}}
+{{if .HasTerminatedTests}}{{color "red" "Several tests terminated during RECORDING mode."}}{{end}}
+
 {{if .RecordingErr}}{{color "red" "Errors occurred during RECORDING mode. Please fix them to complete your PR."}}{{end}}
+
 {{if .AllRecordingPassed}}{{color "green" "All tests passed!"}}{{end}}
 
-View the [build log](https://storage.cloud.google.com/ci-vcr-logs/beta/refs/heads/auto-pr-{{.PRNumber}}/artifacts/{{.BuildID}}/build-log/recording_test.log) or the [debug log](https://console.cloud.google.com/storage/browser/ci-vcr-logs/beta/refs/heads/auto-pr-{{.PRNumber}}/artifacts/{{.BuildID}}/recording) for each test
+View the [build log](https://storage.cloud.google.com/{{.LogBucket}}/{{.Version}}/refs/heads/{{.Head}}/artifacts/{{.BuildID}}/build-log/recording_test.log) {{/* remove trailing whitespace */ -}}
+or the [debug log](https://console.cloud.google.com/storage/browser/{{.LogBucket}}/{{.Version}}/refs/heads/{{.Head}}/artifacts/{{.BuildID}}/recording) for each test

.ci/magician/cmd/templates/vcr/without_replay_failed_tests.tmpl

@@ -4,4 +4,4 @@
 {{color "green" "All tests passed!"}}
 {{- end}}
 
-View the [build log](https://storage.cloud.google.com/ci-vcr-logs/beta/refs/heads/auto-pr-{{.PRNumber}}/artifacts/{{.BuildID}}/build-log/replaying_test.log)
+View the [build log](https://storage.cloud.google.com/{{.LogBucket}}/{{.Version}}/refs/heads/{{.Head}}/artifacts/{{.BuildID}}/build-log/replaying_test.log)

.ci/magician/cmd/test_terraform_vcr.go

@@ -72,7 +72,9 @@ type withReplayFailedTests struct {
 
 type withoutReplayFailedTests struct {
 	ReplayingErr error
-	PRNumber     string
+	LogBucket    string
+	Version      string
+	Head         string
 	BuildID      string
 }
 
@@ -82,14 +84,26 @@ type recordReplay struct {
 	HasTerminatedTests            bool
 	RecordingErr                  error
 	AllRecordingPassed            bool
-	PRNumber                      string
+	LogBucket                     string
+	Version                       string
+	Head                          string
 	BuildID                       string
 }
 
 var testTerraformVCRCmd = &cobra.Command{
 	Use:   "test-terraform-vcr",
 	Short: "Run vcr tests for affected packages",
-	Long:  `This command runs on new pull requests to replay VCR cassettes and re-record failing cassettes.`,
+	Long: `This command runs on new pull requests to replay VCR cassettes and re-record failing cassettes.
+
+It expects the following arguments:
+	1. PR number
+	2. SHA of the latest magic-modules commit
+	3. Build ID
+	4. Project ID where Cloud Builds are located
+	5. Build step number
+	
+The following environment variables are required:
+` + listTTVEnvironmentVariables(),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		env := make(map[string]string, len(ttvEnvironmentVariables))
 		for _, ev := range ttvEnvironmentVariables {
@@ -133,6 +147,14 @@ var testTerraformVCRCmd = &cobra.Command{
 	},
 }
 
+func listTTVEnvironmentVariables() string {
+	var result string
+	for i, ev := range ttvEnvironmentVariables {
+		result += fmt.Sprintf("\t%2d. %s\n", i+1, ev)
+	}
+	return result
+}
+
 func execTestTerraformVCR(prNumber, mmCommitSha, buildID, projectID, buildStep, baseBranch string, gh GithubClient, rnr ExecRunner, ctlr *source.Controller, vt *vcr.Tester) error {
 	newBranch := "auto-pr-" + prNumber
 	oldBranch := newBranch + "-old"
@@ -173,7 +195,7 @@ func execTestTerraformVCR(prNumber, mmCommitSha, buildID, projectID, buildStep,
 		return fmt.Errorf("error changing to tpgbRepo dir: %w", err)
 	}
 
-	services, runFullVCR := modifiedPackages(tpgbRepo.ChangedFiles)
+	services, runFullVCR := modifiedPackages(tpgbRepo.ChangedFiles, provider.Beta)
 	if len(services) == 0 && !runFullVCR {
 		fmt.Println("Skipping tests: No go files or test fixtures changed")
 		return nil
@@ -189,7 +211,7 @@ func execTestTerraformVCR(prNumber, mmCommitSha, buildID, projectID, buildStep,
 		return fmt.Errorf("error posting pending status: %w", err)
 	}
 
-	replayingResult, testDirs, replayingErr := runReplaying(runFullVCR, services, vt)
+	replayingResult, testDirs, replayingErr := runReplaying(runFullVCR, provider.Beta, services, vt)
 	testState := "success"
 	if replayingErr != nil {
 		testState = "failure"
@@ -316,7 +338,9 @@ func execTestTerraformVCR(prNumber, mmCommitSha, buildID, projectID, buildStep,
 			RecordingErr:                  recordingErr,
 			HasTerminatedTests:            hasTerminatedTests,
 			AllRecordingPassed:            allRecordingPassed,
-			PRNumber:                      prNumber,
+			LogBucket:                     "ci-vcr-logs",
+			Version:                       provider.Beta.String(),
+			Head:                          newBranch,
 			BuildID:                       buildID,
 		}
 		recordReplayComment, err := formatRecordReplay(recordReplayData)
@@ -330,7 +354,8 @@ func execTestTerraformVCR(prNumber, mmCommitSha, buildID, projectID, buildStep,
 	} else { //  len(replayingResult.FailedTests) == 0
 		withoutReplayFailedTestsData := withoutReplayFailedTests{
 			ReplayingErr: replayingErr,
-			PRNumber:     prNumber,
+			Head:         newBranch,
+			LogBucket:    "ci-vcr-logs",
 			BuildID:      buildID,
 		}
 		withoutReplayFailedTestsComment, err := formatWithoutReplayFailedTests(withoutReplayFailedTestsData)
@@ -393,7 +418,7 @@ func notRunTests(gaDiff, betaDiff string, result vcr.Result) ([]string, []string
 	return notRunBeta, notRunGa
 }
 
-func modifiedPackages(changedFiles []string) (map[string]struct{}, bool) {
+func modifiedPackages(changedFiles []string, version provider.Version) (map[string]struct{}, bool) {
 	var goFiles []string
 	for _, line := range changedFiles {
 		if strings.HasSuffix(line, ".go") || strings.Contains(line, "test-fixtures") || strings.HasSuffix(line, "go.mod") || strings.HasSuffix(line, "go.sum") {
@@ -403,10 +428,10 @@ func modifiedPackages(changedFiles []string) (map[string]struct{}, bool) {
 	services := make(map[string]struct{})
 	runFullVCR := false
 	for _, file := range goFiles {
-		if strings.HasPrefix(file, "google-beta/services/") {
+		if strings.HasPrefix(file, version.ProviderName()+"/services/") {
 			fileParts := strings.Split(file, "/")
 			services[fileParts[2]] = struct{}{}
-		} else if file == "google-beta/provider/provider_mmv1_resources.go" || file == "google-beta/provider/provider_dcl_resources.go" {
+		} else if file == version.ProviderName()+"/provider/provider_mmv1_resources.go" || file == version.ProviderName()+"/provider/provider_dcl_resources.go" {
 			fmt.Println("ignore changes in ", file)
 		} else {
 			fmt.Println("run full tests ", file)
@@ -417,25 +442,25 @@ func modifiedPackages(changedFiles []string) (map[string]struct{}, bool) {
 	return services, runFullVCR
 }
 
-func runReplaying(runFullVCR bool, services map[string]struct{}, vt *vcr.Tester) (vcr.Result, []string, error) {
+func runReplaying(runFullVCR bool, version provider.Version, services map[string]struct{}, vt *vcr.Tester) (vcr.Result, []string, error) {
 	result := vcr.Result{}
 	var testDirs []string
 	var replayingErr error
 	if runFullVCR {
 		fmt.Println("runReplaying: full VCR tests")
 		result, replayingErr = vt.Run(vcr.RunOptions{
 			Mode:    vcr.Replaying,
-			Version: provider.Beta,
+			Version: version,
 		})
 	} else if len(services) > 0 {
 		fmt.Printf("runReplaying: %d specific services: %v\n", len(services), services)
 		for service := range services {
-			servicePath := "./" + filepath.Join("google-beta", "services", service)
+			servicePath := "./" + filepath.Join(version.ProviderName(), "services", service)
 			testDirs = append(testDirs, servicePath)
 			fmt.Println("run VCR tests in ", service)
 			serviceResult, serviceReplayingErr := vt.Run(vcr.RunOptions{
 				Mode:     vcr.Replaying,
-				Version:  provider.Beta,
+				Version:  version,
 				TestDirs: []string{servicePath},
 			})
 			if serviceReplayingErr != nil {
@@ -475,8 +500,8 @@ func init() {
 
 func formatComment(fileName string, tmplText string, data any) (string, error) {
 	funcs := template.FuncMap{
-		"join": strings.Join,
-		"add":  func(i, j int) int { return i + j },
+		"join":  strings.Join,
+		"add":   func(i, j int) int { return i + j },
 		"color": color,
 	}
 	tmpl, err := template.New(fileName).Funcs(funcs).Parse(tmplText)