Add google_logging_folder_sink to TGC tfplan2cai converter (#15553)

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
Co-authored-by: Zhenhua Li <[email protected]>

Author: 3 people

mmv1/provider/terraform_tgc.go

@@ -435,6 +435,7 @@ func (tgc TerraformGoogleConversion) CopyCommonFiles(outputFolder string, genera
 		"converters/google/resources/services/logging/logging_billing_account_bucket_config.go": "third_party/tgc/services/logging/logging_billing_account_bucket_config.go",
 		"converters/google/resources/services/appengine/appengine_standard_version.go":          "third_party/tgc/services/appengine/appengine_standard_version.go",
 		"converters/google/resources/services/logging/logging_project_sink.go":                  "third_party/tgc/services/logging/logging_project_sink.go",
+		"converters/google/resources/services/logging/logging_folder_sink.go":                   "third_party/tgc/services/logging/logging_folder_sink.go",
 		"converters/google/resources/services/logging/logging_organization_sink.go":             "third_party/tgc/services/logging/logging_organization_sink.go",
 	}
 	tgc.CopyFileList(outputFolder, resourceConverters)

mmv1/third_party/tgc/resource_converters.go.tmpl

@@ -194,6 +194,7 @@ func ResourceConverters() map[string][]cai.ResourceConverter {
 		"google_logging_project_bucket_config":       	   {logging.ResourceConverterLogProjectBucket()},
 		"google_logging_billing_account_bucket_config":    {logging.ResourceConverterLogBillingAccountBucket()},
 		"google_logging_project_sink":                     {logging.ResourceConverterLogProjectSink()},
+		"google_logging_folder_sink":                      {logging.ResourceConverterLogFolderSink()},
 		"google_logging_organization_sink":                {logging.ResourceConverterLogOrganizationSink()},
 		"google_cloud_tasks_queue":                        {cloudtasks.ResourceConverterCloudTasksQueue()},
 		"google_pubsub_topic":                             {pubsub.ResourceConverterPubsubTopic()},

mmv1/third_party/tgc/services/logging/logging_folder_sink.go

@@ -0,0 +1,210 @@
+package logging
+
+import (
+	"reflect"
+
+	"github.com/GoogleCloudPlatform/terraform-google-conversion/v7/tfplan2cai/converters/google/resources/cai"
+	"github.com/hashicorp/terraform-provider-google-beta/google-beta/tpgresource"
+	transport_tpg "github.com/hashicorp/terraform-provider-google-beta/google-beta/transport"
+)
+
+const LogSinkAssetType string = "logging.googleapis.com/LogSink"
+
+func ResourceConverterLogFolderSink() cai.ResourceConverter {
+	return cai.ResourceConverter{
+		AssetType: LogSinkAssetType,
+		Convert:   GetLogFolderSinkCaiObject,
+	}
+}
+
+func GetLogFolderSinkCaiObject(d tpgresource.TerraformResourceData, config *transport_tpg.Config) ([]cai.Asset, error) {
+	name, err := cai.AssetName(d, config, "//logging.googleapis.com/folders/{{folder}}/sinks/{{name}}")
+	if err != nil {
+		return []cai.Asset{}, err
+	}
+	if obj, err := GetLogFolderSinkApiObject(d, config); err == nil {
+		return []cai.Asset{{
+			Name: name,
+			Type: LogSinkAssetType,
+			Resource: &cai.AssetResource{
+				Version:              "v2",
+				DiscoveryDocumentURI: "https://logging.googleapis.com/$discovery/rest",
+				DiscoveryName:        "LogSink",
+				Data:                 obj,
+			},
+		}}, nil
+	} else {
+		return []cai.Asset{}, err
+	}
+}
+
+func GetLogFolderSinkApiObject(d tpgresource.TerraformResourceData, config *transport_tpg.Config) (map[string]interface{}, error) {
+	obj := make(map[string]interface{})
+	nameProp, err := expandLogFolderSinkName(d.Get("name"), d, config)
+	if err != nil {
+		return nil, err
+	} else if v, ok := d.GetOkExists("name"); !tpgresource.IsEmptyValue(reflect.ValueOf(nameProp)) && (ok || !reflect.DeepEqual(v, nameProp)) {
+		obj["name"] = nameProp
+	}
+
+	destinationProp, err := expandLogFolderSinkDestination(d.Get("destination"), d, config)
+	if err != nil {
+		return nil, err
+	} else if v, ok := d.GetOkExists("destination"); !tpgresource.IsEmptyValue(reflect.ValueOf(destinationProp)) && (ok || !reflect.DeepEqual(v, destinationProp)) {
+		obj["destination"] = destinationProp
+	}
+
+	filterProp, err := expandLogFolderSinkFilter(d.Get("filter"), d, config)
+	if err != nil {
+		return nil, err
+	} else if v, ok := d.GetOkExists("filter"); !tpgresource.IsEmptyValue(reflect.ValueOf(filterProp)) && (ok || !reflect.DeepEqual(v, filterProp)) {
+		obj["filter"] = filterProp
+	}
+
+	descriptionProp, err := expandLogFolderSinkDescription(d.Get("description"), d, config)
+	if err != nil {
+		return nil, err
+	} else if v, ok := d.GetOkExists("description"); !tpgresource.IsEmptyValue(reflect.ValueOf(descriptionProp)) && (ok || !reflect.DeepEqual(v, descriptionProp)) {
+		obj["description"] = descriptionProp
+	}
+
+	disabledProp, err := expandLogFolderSinkDisabled(d.Get("disabled"), d, config)
+	if err != nil {
+		return nil, err
+	} else if v, ok := d.GetOkExists("disabled"); !tpgresource.IsEmptyValue(reflect.ValueOf(disabledProp)) && (ok || !reflect.DeepEqual(v, disabledProp)) {
+		obj["disabled"] = disabledProp
+	}
+
+	exclusionsProp, err := expandLogFolderSinkExclusions(d.Get("exclusions"), d, config)
+	if err != nil {
+		return nil, err
+	} else if v, ok := d.GetOkExists("exclusions"); !tpgresource.IsEmptyValue(reflect.ValueOf(exclusionsProp)) && (ok || !reflect.DeepEqual(v, exclusionsProp)) {
+		obj["exclusions"] = exclusionsProp
+	}
+
+	includeChildrenProp, err := expandLogFolderSinkIncludeChildren(d.Get("include_children"), d, config)
+	if err != nil {
+		return nil, err
+	} else if v, ok := d.GetOkExists("include_children"); !tpgresource.IsEmptyValue(reflect.ValueOf(includeChildrenProp)) && (ok || !reflect.DeepEqual(v, includeChildrenProp)) {
+		obj["includeChildren"] = includeChildrenProp
+	}
+
+	bigqueryOptionsProp, err := expandLogFolderSinkBigqueryOptions(d.Get("bigquery_options"), d, config)
+	if err != nil {
+		return nil, err
+	} else if v, ok := d.GetOkExists("bigquery_options"); !tpgresource.IsEmptyValue(reflect.ValueOf(bigqueryOptionsProp)) && (ok || !reflect.DeepEqual(v, bigqueryOptionsProp)) {
+		obj["bigqueryOptions"] = bigqueryOptionsProp
+	}
+
+	return obj, nil
+}
+
+func expandLogFolderSinkName(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
+func expandLogFolderSinkDestination(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
+func expandLogFolderSinkFilter(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
+func expandLogFolderSinkDescription(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
+func expandLogFolderSinkDisabled(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
+func expandLogFolderSinkExclusions(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	l, ok := v.([]interface{})
+	if !ok {
+		return nil, nil
+	}
+
+	req := make([]interface{}, 0, len(l))
+	for _, raw := range l {
+		if raw == nil {
+			continue
+		}
+		original := raw.(map[string]interface{})
+		transformed := make(map[string]interface{})
+
+		transformedName, err := expandLogFolderSinkExclusionsName(original["name"], d, config)
+		if err != nil {
+			return nil, err
+		} else if val := reflect.ValueOf(transformedName); val.IsValid() && !tpgresource.IsEmptyValue(val) {
+			transformed["name"] = transformedName
+		}
+
+		transformedDescription, err := expandLogFolderSinkExclusionsDescription(original["description"], d, config)
+		if err != nil {
+			return nil, err
+		} else if val := reflect.ValueOf(transformedDescription); val.IsValid() && !tpgresource.IsEmptyValue(val) {
+			transformed["description"] = transformedDescription
+		}
+
+		transformedFilter, err := expandLogFolderSinkExclusionsFilter(original["filter"], d, config)
+		if err != nil {
+			return nil, err
+		} else if val := reflect.ValueOf(transformedFilter); val.IsValid() && !tpgresource.IsEmptyValue(val) {
+			transformed["filter"] = transformedFilter
+		}
+
+		transformedDisabled, err := expandLogFolderSinkExclusionsDisabled(original["disabled"], d, config)
+		if err != nil {
+			return nil, err
+		} else if val := reflect.ValueOf(transformedDisabled); val.IsValid() && !tpgresource.IsEmptyValue(val) {
+			transformed["disabled"] = transformedDisabled
+		}
+
+		req = append(req, transformed)
+	}
+	return req, nil
+}
+
+func expandLogFolderSinkExclusionsName(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
+func expandLogFolderSinkExclusionsDescription(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
+func expandLogFolderSinkExclusionsFilter(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
+func expandLogFolderSinkExclusionsDisabled(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
+func expandLogFolderSinkIncludeChildren(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
+func expandLogFolderSinkBigqueryOptions(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	l := v.([]interface{})
+	if len(l) == 0 || l[0] == nil {
+		return nil, nil
+	}
+	raw := l[0]
+	original := raw.(map[string]interface{})
+	transformed := make(map[string]interface{})
+
+	transformedUsePartitionedTables, err := expandLogFolderSinkBigqueryOptionsUsePartitionedTables(original["use_partitioned_tables"], d, config)
+	if err != nil {
+		return nil, err
+	} else if val := reflect.ValueOf(transformedUsePartitionedTables); val.IsValid() && !tpgresource.IsEmptyValue(val) {
+		transformed["usePartitionedTables"] = transformedUsePartitionedTables
+	}
+
+	return transformed, nil
+}
+
+func expandLogFolderSinkBigqueryOptionsUsePartitionedTables(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}

mmv1/third_party/tgc/tests/data/example_google_logging_folder_sink.json

@@ -0,0 +1,50 @@
+[{
+    "name": "//logging.googleapis.com/folders/{{.FolderID}}/sinks/tf-test-sink",
+    "asset_type": "logging.googleapis.com/LogSink",
+    "ancestry_path": "{{.Ancestry}}",
+    "resource": {
+        "version": "v2",
+        "discovery_document_uri": "https://logging.googleapis.com/$discovery/rest",
+        "discovery_name": "LogSink",
+        "parent": "//cloudresourcemanager.googleapis.com/folders/{{.FolderID}}",
+        "data": {
+            "name": "tf-test-sink",
+            "destination": "storage.googleapis.com/tf-test-bucket-{{.Project.Number}}",
+            "filter": "severity >= ERROR",
+            "includeChildren": true,
+            "exclusions": [{
+                "name": "exclude-gce-activity",
+                "description": "Exclude GCE activity logs.",
+                "filter": "logName:\"logs/compute.googleapis.com%2Factivity_log\""
+            }],
+            "bigqueryOptions": {
+                "usePartitionedTables": true
+            }
+        }
+    }
+},
+{
+    "name": "//storage.googleapis.com/tf-test-bucket-{{.Project.Number}}",
+    "asset_type": "storage.googleapis.com/Bucket",
+    "ancestry_path": "{{.Ancestry}}/project/{{.Provider.project}}",
+    "resource": {
+        "version": "v2",
+        "discovery_document_uri": "https://www.googleapis.com/discovery/v1/apis/storage/v1/rest",
+        "discovery_name": "Bucket",
+        "parent": "//cloudresourcemanager.googleapis.com/projects/{{.Provider.project}}",
+        "data": {
+            "iamConfiguration": {
+                "uniformBucketLevelAccess": {
+                    "enabled": false
+                }
+            },
+            "lifecycle": {
+                "rule": []
+            },
+            "location": "US",
+            "name": "tf-test-bucket-{{.Project.Number}}",
+            "project": "{{.Provider.project}}",
+            "storageClass": "STANDARD"
+        }
+    }
+}]

mmv1/third_party/tgc/tests/data/example_google_logging_folder_sink.tf

@@ -0,0 +1,36 @@
+terraform {
+  required_providers {
+    google = {
+      source  = "hashicorp/google"
+      version = ">= 4.54.0"
+    }
+  }
+}
+
+provider "google" {
+  project = "{{.Provider.project}}"
+}
+
+resource "google_storage_bucket" "test_bucket" {
+  name     = "tf-test-bucket-{{.Project.Number}}"
+  location = "US"
+  project  = "{{.Provider.project}}"
+}
+
+resource "google_logging_folder_sink" "test_sink" {
+  name        = "tf-test-sink"
+  folder      = "folders/{{.FolderID}}"
+  destination = "storage.googleapis.com/${google_storage_bucket.test_bucket.name}"
+  filter      = "severity >= ERROR"
+  include_children = true
+
+  exclusions {
+    name        = "exclude-gce-activity"
+    description = "Exclude GCE activity logs."
+    filter      = "logName:\"logs/compute.googleapis.com%2Factivity_log\""
+  }
+
+  bigquery_options {
+    use_partitioned_tables = true
+  }
+}