forked from GoogleCloudPlatform/magic-modules
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Convert sweeeper template with Go (GoogleCloudPlatform#10862)
- Loading branch information
Showing
5 changed files
with
261 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| // 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. | ||
|
|
||
| package resource | ||
|
|
||
| type Sweeper struct { | ||
| //Google::YamlValidator | ||
| // The field checked by sweeper to determine | ||
| // eligibility for deletion for generated resources | ||
| SweepableIdentifierField string `yaml:"sweepable_identifier_field"` | ||
| } | ||
|
|
||
| // def validate | ||
| // super | ||
|
|
||
| // check :sweepable_identifier_field, type: String | ||
| // end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| {{/* <% if hc_downstream */ -}} | ||
| // Copyright (c) HashiCorp, Inc. | ||
| // SPDX-License-Identifier: MPL-2.0 | ||
|
|
||
| // ---------------------------------------------------------------------------- | ||
| // | ||
| // *** AUTO GENERATED CODE *** Type: MMv1 *** | ||
| // | ||
| // ---------------------------------------------------------------------------- | ||
| // | ||
| // This file is automatically generated by Magic Modules and manual | ||
| // changes will be clobbered when the file is regenerated. | ||
| // | ||
| // Please read more about how to change this file in | ||
| // .github/CONTRIBUTING.md. | ||
| // | ||
| // ---------------------------------------------------------------------------- | ||
|
|
||
| package {{ lower $.ProductMetadata.Name }} | ||
|
|
||
| import ( | ||
| "context" | ||
| "log" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "{{ $.ImportPath }}/envvar" | ||
| "{{ $.ImportPath }}/sweeper" | ||
| "{{ $.ImportPath }}/tpgresource" | ||
| transport_tpg "{{ $.ImportPath }}/transport" | ||
| ) | ||
|
|
||
| func init() { | ||
| sweeper.AddTestSweepers("{{ $.ResourceName }}", testSweep{{ $.ResourceName }}) | ||
| } | ||
|
|
||
| // At the time of writing, the CI only passes us-central1 as the region | ||
| func testSweep{{ $.ResourceName }}(region string) error { | ||
| resourceName := "{{ $.ResourceName }}" | ||
| 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("{{ $.ListUrlTemplate }}", "?")[0] | ||
| listUrl, err := tpgresource.ReplaceVars(d, config, listTemplate) | ||
| 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["{{ $.ResourceListKey }}"] | ||
| if !ok { | ||
| log.Printf("[INFO][SWEEPER_LOG] Nothing found in response.") | ||
| return nil | ||
| } | ||
| {{- if contains $.ListUrlTemplate "/aggregated/" }} | ||
| var rl []interface{} | ||
| zones := resourceList.(map[string]interface{}) | ||
| // Loop through every zone in the list response | ||
| for _, zonesValue := range zones { | ||
| zone := zonesValue.(map[string]interface{}) | ||
| for k, v := range zone { | ||
| // Zone map either has resources or a warning stating there were no resources found in the zone | ||
| if k != "warning" { | ||
| resourcesInZone := v.([]interface{}) | ||
| rl = append(rl, resourcesInZone...) | ||
| } | ||
| } | ||
| } | ||
| {{- else }} | ||
|
|
||
| rl := resourceList.([]interface{}) | ||
| {{- end }} | ||
|
|
||
| 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 contains $.DeleteUrlTemplate "_id" }} | ||
| var name string | ||
| // Id detected in the delete URL, attempt to use id. | ||
| if obj["id"] != nil { | ||
| name = tpgresource.GetResourceNameFromSelfLink(obj["id"].(string)) | ||
| } else if obj["name"] != nil { | ||
| name = tpgresource.GetResourceNameFromSelfLink(obj["name"].(string)) | ||
| } else { | ||
| log.Printf("[INFO][SWEEPER_LOG] %s resource name and id were nil", resourceName) | ||
| return nil | ||
| } | ||
| {{- else }} | ||
| if obj["name"] == nil { | ||
| log.Printf("[INFO][SWEEPER_LOG] %s resource name was nil", resourceName) | ||
| return nil | ||
| } | ||
|
|
||
| name := tpgresource.GetResourceNameFromSelfLink(obj["name"].(string)) | ||
| {{- end }} | ||
| // Skip resources that shouldn't be sweeped | ||
| {{- if $.Sweeper.SweepableIdentifierField }} | ||
| if !sweeper.IsSweepableTestResource(obj["{{ $.Sweeper.SweepableIdentifierField }}"].(string)) { | ||
| {{- else }} | ||
| if !sweeper.IsSweepableTestResource(name) { | ||
| {{- end }} | ||
| nonPrefixCount++ | ||
| continue | ||
| } | ||
|
|
||
| deleteTemplate := "{{ $.DeleteUrlTemplate }}" | ||
| {{- if contains $.ListUrlTemplate "/aggregated/" }} | ||
| if obj["zone"] == nil { | ||
| log.Printf("[INFO][SWEEPER_LOG] %s resource zone was nil", resourceName) | ||
| return nil | ||
| } | ||
| zone := tpgresource.GetResourceNameFromSelfLink(obj["zone"].(string)) | ||
| deleteTemplate = strings.Replace(deleteTemplate, "{{"{{zone}}"}}", zone, -1) | ||
|
|
||
| {{- end }} | ||
| 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 | ||
|
|
||
| // 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 | ||
| } |