Skip to content

Commit

Permalink
Support full resource names in autokey_config.folder (GoogleCloudPlat…
Browse files Browse the repository at this point in the history
…form#11413)

Co-authored-by: Sarah French <[email protected]>
  • Loading branch information
2 people authored and iyabchen committed Sep 14, 2024
1 parent 0d5c798 commit 0718d4a
Show file tree
Hide file tree
Showing 11 changed files with 158 additions and 1 deletion.
8 changes: 8 additions & 0 deletions mmv1/products/kms/AutokeyConfig.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,14 @@ references: !ruby/object:Api::Resource::ReferenceLinks
id_format: 'folders/{{folder}}/autokeyConfig'
import_format: ['folders/{{folder}}/autokeyConfig']
min_version: beta
# Using a handwritten sweeper because of pre_delete.
skip_sweeper: true
custom_code: !ruby/object:Provider::Terraform::CustomCode
constants: templates/terraform/constants/autokey_config_folder_diff.go.erb
pre_create: templates/terraform/pre_create/kms_autokey_config_folder.go.erb
pre_delete: templates/terraform/pre_delete/kms_autokey_config_folder.go.erb
pre_read: templates/terraform/pre_read/kms_autokey_config_folder.go.erb
pre_update: templates/terraform/pre_update/kms_autokey_config_folder.go.erb
test_check_destroy: templates/terraform/custom_check_destroy/kms_autokey_config.go.erb
examples:
- !ruby/object:Provider::Terraform::Examples
Expand All @@ -65,6 +72,7 @@ parameters:
required: true
immutable: true
url_param_only: true
diff_suppress_func: 'folderPrefixSuppress'
description: |
The folder for which to retrieve config.
properties:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
func folderPrefixSuppress(_, old, new string, d *schema.ResourceData) bool {
prefix := "folders/"
return prefix+old == new || prefix+new == old
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
func folderPrefixSuppress(_, old, new string, d *schema.ResourceData) bool {
prefix := "folders/"
return prefix+old == new || prefix+new == old
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
config := acctest.GoogleProviderConfig(t)

url, err := tpgresource.ReplaceVarsForTest(config, rs, "{{KMSBasePath}}folders/{{folder}}/autokeyConfig")
url = strings.Replace(url, "folders/folders/", "folders/", 1)
if err != nil {
return err
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,14 @@ resource "time_sleep" "wait_srv_acc_permissions" {

resource "google_kms_autokey_config" "<%= ctx[:primary_resource_id] %>" {
provider = google-beta
folder = google_folder.autokms_folder.folder_id
folder = google_folder.autokms_folder.id
key_project = "projects/${google_project.key_project.project_id}"
depends_on = [time_sleep.wait_srv_acc_permissions]
}

# Wait delay after setting AutokeyConfig, to prevent diffs on reapply,
# because setting the config takes a little to fully propagate.
resource "time_sleep" "wait_autokey_propagation" {
create_duration = "30s"
depends_on = [google_kms_autokey_config.<%= ctx[:primary_resource_id] %>]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
id = strings.Replace(id, "folders/folders/", "folders/", 1)
d.SetId(id)
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
url = strings.Replace(url, "folders/folders/", "folders/", 1)
folderValue := d.Get("folder").(string)
folderValue = strings.Replace(folderValue, "folders/", "", 1)
d.Set("folder", folderValue)
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
url = strings.Replace(url, "folders/folders/", "folders/", 1)
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
url = strings.Replace(url, "folders/folders/", "folders/", 1)
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
url = strings.Replace(url, "folders/folders/", "folders/", 1)
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
package kms

import (
"context"
"log"
"strings"
"testing"

"github.com/hashicorp/terraform-provider-google/google/envvar"
"github.com/hashicorp/terraform-provider-google/google/sweeper"
"github.com/hashicorp/terraform-provider-google/google/tpgresource"
transport_tpg "github.com/hashicorp/terraform-provider-google/google/transport"
)

func init() {
sweeper.AddTestSweepers("KMSAutokeyConfig", testSweepKMSAutokeyConfig)
}

// At the time of writing, the CI only passes us-central1 as the region
func testSweepKMSAutokeyConfig(region string) error {
resourceName := "KMSAutokeyConfig"
log.Printf("[INFO][SWEEPER_LOG] Starting sweeper for %s", resourceName)

config, err := sweeper.SharedConfigForRegion(region)
if err != nil {
log.Printf("[INFO][SWEEPER_LOG] error getting shared config for region: %s", err)
return err
}

err = config.LoadAndValidate(context.Background())
if err != nil {
log.Printf("[INFO][SWEEPER_LOG] error loading: %s", err)
return err
}

t := &testing.T{}
billingId := envvar.GetTestBillingAccountFromEnv(t)

// Setup variables to replace in list template
d := &tpgresource.ResourceDataMock{
FieldsInSchema: map[string]interface{}{
"project": config.Project,
"region": region,
"location": region,
"zone": "-",
"billing_account": billingId,
},
}

listTemplate := strings.Split("https://cloudkms.googleapis.com/v1/folders/{{folder}}/autokeyConfig", "?")[0]
listUrl, err := tpgresource.ReplaceVars(d, config, listTemplate)
listUrl = strings.Replace(listUrl, "folders/folders/", "folders/", 1)
if err != nil {
log.Printf("[INFO][SWEEPER_LOG] error preparing sweeper list url: %s", err)
return nil
}

res, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
Config: config,
Method: "GET",
Project: config.Project,
RawURL: listUrl,
UserAgent: config.UserAgent,
})
if err != nil {
log.Printf("[INFO][SWEEPER_LOG] Error in response from request %s: %s", listUrl, err)
return nil
}

resourceList, ok := res["autokeyConfigs"]
if !ok {
log.Printf("[INFO][SWEEPER_LOG] Nothing found in response.")
return nil
}

rl := resourceList.([]interface{})

log.Printf("[INFO][SWEEPER_LOG] Found %d items in %s list response.", len(rl), resourceName)
// Keep count of items that aren't sweepable for logging.
nonPrefixCount := 0
for _, ri := range rl {
obj := ri.(map[string]interface{})
if obj["name"] == nil {
log.Printf("[INFO][SWEEPER_LOG] %s resource name was nil", resourceName)
return nil
}

name := tpgresource.GetResourceNameFromSelfLink(obj["name"].(string))
// Skip resources that shouldn't be sweeped
if !sweeper.IsSweepableTestResource(name) {
nonPrefixCount++
continue
}

deleteTemplate := "https://cloudkms.googleapis.com/v1/folders/{{folder}}/autokeyConfig?updateMask=keyProject"
deleteUrl, err := tpgresource.ReplaceVars(d, config, deleteTemplate)
if err != nil {
log.Printf("[INFO][SWEEPER_LOG] error preparing delete url: %s", err)
return nil
}
deleteUrl = deleteUrl + name
deleteUrl = strings.Replace(deleteUrl, "folders/folders/", "folders/", 1)

// Don't wait on operations as we may have a lot to delete
_, err = transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
Config: config,
Method: "DELETE",
Project: config.Project,
RawURL: deleteUrl,
UserAgent: config.UserAgent,
})
if err != nil {
log.Printf("[INFO][SWEEPER_LOG] Error deleting for url %s : %s", deleteUrl, err)
} else {
log.Printf("[INFO][SWEEPER_LOG] Sent delete request for %s resource: %s", resourceName, name)
}
}

if nonPrefixCount > 0 {
log.Printf("[INFO][SWEEPER_LOG] %d items were non-sweepable and skipped.", nonPrefixCount)
}

return nil
}

0 comments on commit 0718d4a

Please sign in to comment.