From 6d67e349fe1f372cb7cb1bc1f720f858dab78187 Mon Sep 17 00:00:00 2001 From: vijaykanthm Date: Fri, 13 Sep 2024 15:11:17 -0700 Subject: [PATCH] Add Resource v1 SCC Findings Export to BQ Folder Config (#11587) --- .../FolderSccBigQueryExport.yaml | 141 ++++++++++++++++++ ...older_big_query_export_config_basic.tf.erb | 31 ++++ ...scc_folder_big_query_export_config_test.go | 131 ++++++++++++++++ 3 files changed, 303 insertions(+) create mode 100644 mmv1/products/securitycenter/FolderSccBigQueryExport.yaml create mode 100644 mmv1/templates/terraform/examples/scc_folder_big_query_export_config_basic.tf.erb create mode 100644 mmv1/third_party/terraform/services/securitycenter/resource_scc_folder_big_query_export_config_test.go diff --git a/mmv1/products/securitycenter/FolderSccBigQueryExport.yaml b/mmv1/products/securitycenter/FolderSccBigQueryExport.yaml new file mode 100644 index 000000000000..baa4142b1077 --- /dev/null +++ b/mmv1/products/securitycenter/FolderSccBigQueryExport.yaml @@ -0,0 +1,141 @@ +# Copyright 2024 Google Inc. +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +--- !ruby/object:Api::Resource +name: 'FolderSccBigQueryExport' +base_url: folders/{{folder}}/bigQueryExports +self_link: folders/{{folder}}/bigQueryExports/{{big_query_export_id}} +create_url: folders/{{folder}}/bigQueryExports?bigQueryExportId={{big_query_export_id}} +update_verb: :PATCH +update_mask: true +import_format: + - 'folders/{{folder}}/bigQueryExports/{{big_query_export_id}}' +description: | + A Cloud Security Command Center (Cloud SCC) Big Query Export Config. + It represents exporting Security Command Center data, including assets, findings, and security marks + to a BigQuery instance. + + -> **Note:** In order to use Cloud SCC resources, your organization must be enrolled + in [SCC Standard/Premium](https://cloud.google.com/security-command-center/docs/quickstart-security-command-center). + Without doing so, you may run into errors during resource creation. +references: !ruby/object:Api::Resource::ReferenceLinks + guides: + 'Official Documentation': 'https://cloud.google.com/security-command-center/docs/how-to-analyze-findings-in-big-query' + api: 'https://cloud.google.com/security-command-center/docs/reference/rest/v1/folders.bigQueryExports' +examples: + - !ruby/object:Provider::Terraform::Examples + name: 'scc_folder_big_query_export_config_basic' + primary_resource_id: 'custom_big_query_export_config' + skip_test: true + vars: + big_query_export_id: 'my-export' + dataset: 'my-dataset' + dataset_id: 'my_dataset_id' + name: 'my-export' + folder_display_name: "folder-name" + test_env_vars: + org_id: :ORG_ID + project: :PROJECT_NAME + +parameters: + - !ruby/object:Api::Type::String + name: folder + required: true + immutable: true + url_param_only: true + description: | + The folder where Cloud Security Command Center Big Query Export + Config lives in. + - !ruby/object:Api::Type::String + name: bigQueryExportId + required: true + immutable: true + url_param_only: true + description: | + This must be unique within the organization. +properties: + - !ruby/object:Api::Type::String + name: name + output: true + description: | + The resource name of this export, in the format + `projects/{{project}}/bigQueryExports/{{big_query_export_id}}`. + This field is provided in responses, and is ignored when provided in create requests. + - !ruby/object:Api::Type::String + name: description + required: true + description: | + The description of the export (max of 1024 characters). + validation: !ruby/object:Provider::Terraform::Validation + function: 'validation.StringLenBetween(0, 1024)' + - !ruby/object:Api::Type::String + name: dataset + required: true + description: | + The dataset to write findings' updates to. + Its format is "projects/[projectId]/datasets/[bigquery_dataset_id]". + BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). + - !ruby/object:Api::Type::String + name: createTime + output: true + description: | + The time at which the BigQuery export was created. + A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. + Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". + - !ruby/object:Api::Type::String + name: updateTime + output: true + description: | + The most recent time at which the BigQuery export was updated. + A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. + Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". + - !ruby/object:Api::Type::String + name: mostRecentEditor + output: true + description: | + Email address of the user who last edited the BigQuery export. + - !ruby/object:Api::Type::String + name: principal + output: true + description: | + The service account that needs permission to create table and upload data to the BigQuery dataset. + - !ruby/object:Api::Type::String + name: filter + required: true + send_empty_value: true + description: | + Expression that defines the filter to apply across create/update + events of findings. The + expression is a list of zero or more restrictions combined via + logical operators AND and OR. Parentheses are supported, and OR + has higher precedence than AND. + + Restrictions have the form and may have + a - character in front of them to indicate negation. The fields + map to those defined in the corresponding resource. + + The supported operators are: + + * = for all value types. + * >, <, >=, <= for integer values. + * :, meaning substring matching, for strings. + + The supported value types are: + + * string literals in quotes. + * integer literals without quotes. + * boolean literals true and false without quotes. + + See + [Filtering notifications](https://cloud.google.com/security-command-center/docs/how-to-api-filter-notifications) + for information on how to write a filter. diff --git a/mmv1/templates/terraform/examples/scc_folder_big_query_export_config_basic.tf.erb b/mmv1/templates/terraform/examples/scc_folder_big_query_export_config_basic.tf.erb new file mode 100644 index 000000000000..48b368ec2ac8 --- /dev/null +++ b/mmv1/templates/terraform/examples/scc_folder_big_query_export_config_basic.tf.erb @@ -0,0 +1,31 @@ +resource "google_folder" "folder" { + parent = "organizations/<%= ctx[:test_env_vars]['org_id'] %>" + display_name = "<%= ctx[:vars]['folder_display_name'] %>" + + deletion_protection = false +} + +resource "google_bigquery_dataset" "default" { + dataset_id = "<%= ctx[:vars]['dataset_id'] %>" + friendly_name = "test" + description = "This is a test description" + location = "US" + default_table_expiration_ms = 3600000 + default_partition_expiration_ms = null + + labels = { + env = "default" + } + + lifecycle { + ignore_changes = [default_partition_expiration_ms] + } +} + +resource "google_scc_folder_scc_big_query_export" "<%= ctx[:primary_resource_id] %>" { + big_query_export_id = "<%= ctx[:vars]['big_query_export_id'] %>" + folder = google_folder.folder.folder_id + dataset = google_bigquery_dataset.default.id + description = "Cloud Security Command Center Findings Big Query Export Config" + filter = "state=\"ACTIVE\" AND NOT mute=\"MUTED\"" +} diff --git a/mmv1/third_party/terraform/services/securitycenter/resource_scc_folder_big_query_export_config_test.go b/mmv1/third_party/terraform/services/securitycenter/resource_scc_folder_big_query_export_config_test.go new file mode 100644 index 000000000000..22609aff569e --- /dev/null +++ b/mmv1/third_party/terraform/services/securitycenter/resource_scc_folder_big_query_export_config_test.go @@ -0,0 +1,131 @@ +package securitycenter_test + +import ( + "testing" + + "github.com/hashicorp/terraform-plugin-testing/helper/resource" + "github.com/hashicorp/terraform-plugin-testing/plancheck" + "github.com/hashicorp/terraform-provider-google/google/acctest" + "github.com/hashicorp/terraform-provider-google/google/envvar" +) + +func TestAccSecurityCenterFolderBigQueryExportConfig_update(t *testing.T) { + t.Parallel() + + randomSuffix := acctest.RandString(t, 10) + dataset_id := "tf_test_" + randomSuffix + dataset_id2 := dataset_id + "2" + orgID := envvar.GetTestOrgFromEnv(t) + + context := map[string]interface{}{ + "org_id": orgID, + "random_suffix": randomSuffix, + "dataset_id": dataset_id, + "dataset_id2": dataset_id2, + "big_query_export_id": "tf-test-export-" + randomSuffix, + "folder_name": "tf-test-folder-name-" + randomSuffix, + } + + acctest.VcrTest(t, resource.TestCase{ + PreCheck: func() { acctest.AccTestPreCheck(t) }, + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t), + ExternalProviders: map[string]resource.ExternalProvider{ + "time": {}, + }, + Steps: []resource.TestStep{ + { + Config: testAccSecurityCenterFolderBigQueryExportConfig_basic(context), + }, + { + ResourceName: "google_scc_folder_scc_big_query_export.default", + ImportState: true, + ImportStateVerify: true, + ImportStateVerifyIgnore: []string{"update_time"}, + }, + { + Config: testAccSecurityCenterFolderBigQueryExportConfig_update(context), + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction("google_scc_folder_scc_big_query_export.default", plancheck.ResourceActionUpdate), + }, + }, + }, + { + ResourceName: "google_scc_folder_scc_big_query_export.default", + ImportState: true, + ImportStateVerify: true, + ImportStateVerifyIgnore: []string{"update_time"}, + }, + }, + }) +} + +func testAccSecurityCenterFolderBigQueryExportConfig_basic(context map[string]interface{}) string { + return acctest.Nprintf(` +resource "google_folder" "folder" { + parent = "organizations/%{org_id}" + display_name = "%{folder_name}" + deletion_protection = false +} +resource "google_bigquery_dataset" "default" { + dataset_id = "%{dataset_id}" + friendly_name = "test" + description = "This is a test description" + location = "US" + default_table_expiration_ms = 3600000 + default_partition_expiration_ms = null + labels = { + env = "default" + } + lifecycle { + ignore_changes = [default_partition_expiration_ms] + } +} +resource "time_sleep" "wait_1_minute" { + depends_on = [google_bigquery_dataset.default] + create_duration = "3m" +} +resource "google_scc_folder_scc_big_query_export" "default" { + big_query_export_id = "%{big_query_export_id}" + folder = google_folder.folder.folder_id + dataset = google_bigquery_dataset.default.id + description = "Cloud Security Command Center Findings Big Query Export Config" + filter = "state=\"ACTIVE\" AND NOT mute=\"MUTED\"" + + depends_on = [time_sleep.wait_1_minute] +} + +`, context) +} + +func testAccSecurityCenterFolderBigQueryExportConfig_update(context map[string]interface{}) string { + return acctest.Nprintf(` +resource "google_folder" "folder" { + parent = "organizations/%{org_id}" + display_name = "%{folder_name}" + deletion_protection = false +} +resource "google_bigquery_dataset" "default" { + dataset_id = "%{dataset_id2}" + friendly_name = "test" + description = "This is a test description" + location = "US" + default_table_expiration_ms = 3600000 + default_partition_expiration_ms = null + labels = { + env = "default" + } + lifecycle { + ignore_changes = [default_partition_expiration_ms] + } +} +resource "google_scc_folder_scc_big_query_export" "default" { + big_query_export_id = "%{big_query_export_id}" + folder = google_folder.folder.folder_id + dataset = google_bigquery_dataset.default.id + description = "SCC Findings Big Query Export Update" + filter = "" +} + +`, context) +}