tgc-revival: add TGCTest struct (#15471)

Author: trodge

mmv1/api/resource.go

@@ -393,6 +393,10 @@ type TGCResource struct {
 	// Generally, it shouldn't be set when the identity can be decided.
 	// Otherswise, it should be set.
 	CaiIdentity string `yaml:"cai_identity,omitempty"`
+
+	// Tests for TGC, will automatically be filled with resource's examples
+	// and handwritten tests. Can be specified in order to skip specific tests.
+	TGCTests []resource.TGCTest `yaml:"tgc_tests,omitempty"`
 }
 
 func (r *Resource) UnmarshalYAML(unmarshal func(any) error) error {
@@ -2281,7 +2285,7 @@ func (r Resource) MarkdownHeader(templatePath string) string {
 // TGC Methods
 // ====================
 // Lists fields that test.BidirectionalConversion should ignore
-func (r Resource) TGCTestIgnorePropertiesToStrings(e resource.Examples) []string {
+func (r Resource) TGCTestIgnorePropertiesToStrings() []string {
 	props := []string{
 		"depends_on",
 		"count",
@@ -2301,7 +2305,6 @@ func (r Resource) TGCTestIgnorePropertiesToStrings(e resource.Examples) []string
 			props = append(props, tp.MetadataLineage())
 		}
 	}
-	props = append(props, e.TGCTestIgnoreExtra...)
 
 	slices.Sort(props)
 	return props

mmv1/api/resource/examples.go

@@ -179,14 +179,6 @@ type Examples struct {
 	// ====================
 	// TGC
 	// ====================
-	// Extra properties to ignore test.
-	// These properties are present in Terraform resources schema, but not in CAI assets.
-	// Virtual Fields and url parameters are already ignored by default and do not need to be duplicated here.
-	TGCTestIgnoreExtra []string `yaml:"tgc_test_ignore_extra,omitempty"`
-	// The properties ignored in CAI assets. It is rarely used.
-	TGCTestIgnoreInAsset []string `yaml:"tgc_test_ignore_in_asset,omitempty"`
-	// The reason to skip a test. For example, a link to a ticket explaining the issue that needs to be resolved before
-	// unskipping the test. If this is not empty, the test will be skipped.
 	TGCSkipTest string `yaml:"tgc_skip_test,omitempty"`
 }
 

mmv1/api/resource/tgc_test.go mmv1/api/resource/tgc.gommv1/api/resource/tgc_test.go renamed to mmv1/api/resource/tgc.go

@@ -29,6 +29,7 @@ import (
 
 	"github.com/GoogleCloudPlatform/magic-modules/mmv1/api"
 	"github.com/GoogleCloudPlatform/magic-modules/mmv1/api/product"
+	"github.com/GoogleCloudPlatform/magic-modules/mmv1/api/resource"
 	"github.com/GoogleCloudPlatform/magic-modules/mmv1/google"
 	"github.com/otiai10/copy"
 )
@@ -103,6 +104,7 @@ func (tgc TerraformGoogleConversionNext) GenerateObject(object api.Resource, out
 
 	if !object.IsExcluded() {
 		tgc.GenerateResource(object, *templateData, outputFolder, generateCode, generateDocs)
+		tgc.addTestsFromExamples(&object)
 		tgc.GenerateResourceTests(object, *templateData, outputFolder)
 	}
 }
@@ -130,16 +132,7 @@ func (tgc TerraformGoogleConversionNext) GenerateCaiToHclObjects(outputFolder, r
 }
 
 func (tgc *TerraformGoogleConversionNext) GenerateResourceTests(object api.Resource, templateData TemplateData, outputFolder string) {
-	eligibleExample := false
-	for _, example := range object.Examples {
-		if !example.ExcludeTest {
-			if object.ProductMetadata.VersionObjOrClosest(tgc.Version.Name).CompareTo(object.ProductMetadata.VersionObjOrClosest(example.MinVersion)) >= 0 {
-				eligibleExample = true
-				break
-			}
-		}
-	}
-	if !eligibleExample {
+	if len(object.TGCTests) == 0 {
 		return
 	}
 
@@ -314,6 +307,21 @@ func (tgc TerraformGoogleConversionNext) replaceImportPath(outputFolder, target
 	}
 }
 
+func (tgc TerraformGoogleConversionNext) addTestsFromExamples(object *api.Resource) {
+	for _, example := range object.Examples {
+		if example.ExcludeTest {
+			continue
+		}
+		if object.ProductMetadata.VersionObjOrClosest(tgc.Version.Name).CompareTo(object.ProductMetadata.VersionObjOrClosest(example.MinVersion)) < 0 {
+			continue
+		}
+		object.TGCTests = append(object.TGCTests, resource.TGCTest{
+			Name: "TestAcc" + example.TestSlug(object.ProductMetadata.Name, object.Name),
+			Skip: example.TGCSkipTest,
+		})
+	}
+}
+
 // Generates the list of resources, and gets the count of resources.
 // The resource object has the format
 //

mmv1/provider/terraform_tgc_next.go

@@ -20,22 +20,17 @@ import (
 	"github.com/GoogleCloudPlatform/terraform-google-conversion/v7/test"
 )
 
-{{ range $e := $.TestExamples }}
-func TestAcc{{ $e.TestSlug $.ProductMetadata.Name $.Name }}(t *testing.T) {
-	{{- if $e.TGCSkipTest }}
-	t.Skip("{{$e.TGCSkipTest}}")
+{{ range $t := $.TGCTests }}
+func {{ $t.Name }}(t *testing.T) {
+	{{- if $t.Skip }}
+	t.Skip("{{$t.Skip}}")
 	{{- end }}
 	t.Parallel()
 
 	test.BidirectionalConversion(
 		t,
 		[]string{
-{{- range $field := $.TGCTestIgnorePropertiesToStrings $e }}
-	"{{ $field }}",
-{{- end }}
-		},
-		[]string{
-{{- range $field := $e.TGCTestIgnoreInAsset }}
+{{- range $field := $.TGCTestIgnorePropertiesToStrings }}
 	"{{ $field }}",
 {{- end }}
 		},

mmv1/templates/tgc_next/test/test_file.go.tmpl

@@ -34,7 +34,7 @@ var (
 	tmpDir     = os.TempDir()
 )
 
-func BidirectionalConversion(t *testing.T, ignoredFields []string, ignoredAssetFields []string) {
+func BidirectionalConversion(t *testing.T, ignoredFields []string) {
 	testName := t.Name()
 	stepNumbers, err := getStepNumbers(testName)
 	if err != nil {
@@ -77,13 +77,13 @@ func BidirectionalConversion(t *testing.T, ignoredFields []string, ignoredAssetF
 				tName := fmt.Sprintf("%s_%s", testName, subtestName)
 				if primaryResource != "" {
 					t.Logf("Test for the primary resource %s begins.", primaryResource)
-					err = testSingleResource(t, tName, resourceTestData[primaryResource], tfDir, ignoredFields, ignoredAssetFields, logger, true)
+					err = testSingleResource(t, tName, resourceTestData[primaryResource], tfDir, ignoredFields, logger, true)
 					if err != nil {
 						return err
 					}
 				} else {
 					for _, testData := range resourceTestData {
-						err = testSingleResource(t, tName, testData, tfDir, ignoredFields, ignoredAssetFields, logger, false)
+						err = testSingleResource(t, tName, testData, tfDir, ignoredFields, logger, false)
 						if err != nil {
 							return err
 						}
@@ -110,7 +110,7 @@ func BidirectionalConversion(t *testing.T, ignoredFields []string, ignoredAssetF
 }
 
 // Tests a single resource
-func testSingleResource(t *testing.T, testName string, testData ResourceTestData, tfDir string, ignoredFields []string, ignoredAssetFields []string, logger *zap.Logger, primaryResource bool) error {
+func testSingleResource(t *testing.T, testName string, testData ResourceTestData, tfDir string, ignoredFields []string, logger *zap.Logger, primaryResource bool) error {
 	resourceType := testData.ResourceType
 	var tfplan2caiSupported, cai2hclSupported bool
 	if _, tfplan2caiSupported = tfplan2caiconverters.ConverterMap[resourceType]; !tfplan2caiSupported {
@@ -213,7 +213,7 @@ func testSingleResource(t *testing.T, testName string, testData ResourceTestData
 
 	// Convert the export config to roundtrip assets and then convert the roundtrip assets back to roundtrip config
 	ancestryCache, defaultProject := getAncestryCache(assets)
-	roundtripAssets, roundtripConfigData, err := getRoundtripConfig(t, testName, tfDir, ancestryCache, defaultProject, logger, ignoredAssetFields)
+	roundtripAssets, roundtripConfigData, err := getRoundtripConfig(t, testName, tfDir, ancestryCache, defaultProject, logger)
 	if err != nil {
 		return fmt.Errorf("error when converting the round-trip config: %#v", err)
 	}
@@ -404,7 +404,7 @@ func isIgnored(key string, ignoredFields map[string]any) bool {
 }
 
 // Converts a tfplan to CAI asset, and then converts the CAI asset into HCL
-func getRoundtripConfig(t *testing.T, testName string, tfDir string, ancestryCache map[string]string, defaultProject string, logger *zap.Logger, ignoredAssetFields []string) ([]caiasset.Asset, []byte, error) {
+func getRoundtripConfig(t *testing.T, testName string, tfDir string, ancestryCache map[string]string, defaultProject string, logger *zap.Logger) ([]caiasset.Asset, []byte, error) {
 	fileName := fmt.Sprintf("%s_export", testName)
 	roundtripAssetFile := fmt.Sprintf("%s_roundtrip.json", testName)
 
@@ -421,7 +421,6 @@ func getRoundtripConfig(t *testing.T, testName string, tfDir string, ancestryCac
 		return nil, nil, err
 	}
 
-	deleteFieldsFromAssets(roundtripAssetsCopy, ignoredAssetFields)
 	roundtripConfig, err := cai2hcl.Convert(roundtripAssetsCopy, &cai2hcl.Options{
 		ErrorLogger: logger,
 	})