From c4abc09d24d50cc7c0bed7efb6565ad3f7448074 Mon Sep 17 00:00:00 2001 From: Modular Magician Date: Tue, 6 Dec 2022 18:18:47 +0000 Subject: [PATCH] Cloud Storage for Firebase provider (#6899) closes https://github.com/hashicorp/terraform-provider-google/issues/13163 Signed-off-by: Modular Magician --- .changelog/6899.txt | 3 + google-beta/config.go | 4 + google-beta/config_test_utils.go | 1 + google-beta/provider.go | 14 +- .../resource_firebase_storage_bucket.go | 211 ++++++++++++++++++ ..._firebase_storage_bucket_generated_test.go | 100 +++++++++ ...ce_firebase_storage_bucket_sweeper_test.go | 128 +++++++++++ .../r/firebase_storage_bucket.html.markdown | 101 +++++++++ 8 files changed, 560 insertions(+), 2 deletions(-) create mode 100644 .changelog/6899.txt create mode 100644 google-beta/resource_firebase_storage_bucket.go create mode 100644 google-beta/resource_firebase_storage_bucket_generated_test.go create mode 100644 google-beta/resource_firebase_storage_bucket_sweeper_test.go create mode 100644 website/docs/r/firebase_storage_bucket.html.markdown diff --git a/.changelog/6899.txt b/.changelog/6899.txt new file mode 100644 index 0000000000..c6b0c21846 --- /dev/null +++ b/.changelog/6899.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +google_firebase_storage_bucket +``` diff --git a/google-beta/config.go b/google-beta/config.go index 301d9d8988..f670f0bb2f 100644 --- a/google-beta/config.go +++ b/google-beta/config.go @@ -221,6 +221,7 @@ type Config struct { FilestoreBasePath string FirebaseBasePath string FirebaseHostingBasePath string + FirebaseStorageBasePath string FirestoreBasePath string GameServicesBasePath string GKEBackupBasePath string @@ -333,6 +334,7 @@ const EssentialContactsBasePathKey = "EssentialContacts" const FilestoreBasePathKey = "Filestore" const FirebaseBasePathKey = "Firebase" const FirebaseHostingBasePathKey = "FirebaseHosting" +const FirebaseStorageBasePathKey = "FirebaseStorage" const FirestoreBasePathKey = "Firestore" const GameServicesBasePathKey = "GameServices" const GKEBackupBasePathKey = "GKEBackup" @@ -439,6 +441,7 @@ var DefaultBasePaths = map[string]string{ FilestoreBasePathKey: "https://file.googleapis.com/v1beta1/", FirebaseBasePathKey: "https://firebase.googleapis.com/v1beta1/", FirebaseHostingBasePathKey: "https://firebasehosting.googleapis.com/v1beta1/", + FirebaseStorageBasePathKey: "https://firebasestorage.googleapis.com/v1beta/", FirestoreBasePathKey: "https://firestore.googleapis.com/v1/", GameServicesBasePathKey: "https://gameservices.googleapis.com/v1beta/", GKEBackupBasePathKey: "https://gkebackup.googleapis.com/v1/", @@ -1321,6 +1324,7 @@ func ConfigureBasePaths(c *Config) { c.FilestoreBasePath = DefaultBasePaths[FilestoreBasePathKey] c.FirebaseBasePath = DefaultBasePaths[FirebaseBasePathKey] c.FirebaseHostingBasePath = DefaultBasePaths[FirebaseHostingBasePathKey] + c.FirebaseStorageBasePath = DefaultBasePaths[FirebaseStorageBasePathKey] c.FirestoreBasePath = DefaultBasePaths[FirestoreBasePathKey] c.GameServicesBasePath = DefaultBasePaths[GameServicesBasePathKey] c.GKEBackupBasePath = DefaultBasePaths[GKEBackupBasePathKey] diff --git a/google-beta/config_test_utils.go b/google-beta/config_test_utils.go index 0a751af1dc..c175e772b9 100644 --- a/google-beta/config_test_utils.go +++ b/google-beta/config_test_utils.go @@ -67,6 +67,7 @@ func configureTestBasePaths(c *Config, url string) { c.FilestoreBasePath = url c.FirebaseBasePath = url c.FirebaseHostingBasePath = url + c.FirebaseStorageBasePath = url c.FirestoreBasePath = url c.GameServicesBasePath = url c.GKEBackupBasePath = url diff --git a/google-beta/provider.go b/google-beta/provider.go index befd36a401..e4432545c5 100644 --- a/google-beta/provider.go +++ b/google-beta/provider.go @@ -541,6 +541,14 @@ func Provider() *schema.Provider { "GOOGLE_FIREBASE_HOSTING_CUSTOM_ENDPOINT", }, DefaultBasePaths[FirebaseHostingBasePathKey]), }, + "firebase_storage_custom_endpoint": { + Type: schema.TypeString, + Optional: true, + ValidateFunc: validateCustomEndpoint, + DefaultFunc: schema.MultiEnvDefaultFunc([]string{ + "GOOGLE_FIREBASE_STORAGE_CUSTOM_ENDPOINT", + }, DefaultBasePaths[FirebaseStorageBasePathKey]), + }, "firestore_custom_endpoint": { Type: schema.TypeString, Optional: true, @@ -1047,9 +1055,9 @@ func Provider() *schema.Provider { return provider } -// Generated resources: 288 +// Generated resources: 289 // Generated IAM resources: 189 -// Total generated resources: 477 +// Total generated resources: 478 func ResourceMap() map[string]*schema.Resource { resourceMap, _ := ResourceMapWithErrors() return resourceMap @@ -1349,6 +1357,7 @@ func ResourceMapWithErrors() (map[string]*schema.Resource, error) { "google_firebase_apple_app": resourceFirebaseAppleApp(), "google_firebase_hosting_site": resourceFirebaseHostingSite(), "google_firebase_hosting_channel": resourceFirebaseHostingChannel(), + "google_firebase_storage_bucket": resourceFirebaseStorageBucket(), "google_firestore_index": resourceFirestoreIndex(), "google_firestore_document": resourceFirestoreDocument(), "google_game_services_realm": resourceGameServicesRealm(), @@ -1814,6 +1823,7 @@ func providerConfigure(ctx context.Context, d *schema.ResourceData, p *schema.Pr config.FilestoreBasePath = d.Get("filestore_custom_endpoint").(string) config.FirebaseBasePath = d.Get("firebase_custom_endpoint").(string) config.FirebaseHostingBasePath = d.Get("firebase_hosting_custom_endpoint").(string) + config.FirebaseStorageBasePath = d.Get("firebase_storage_custom_endpoint").(string) config.FirestoreBasePath = d.Get("firestore_custom_endpoint").(string) config.GameServicesBasePath = d.Get("game_services_custom_endpoint").(string) config.GKEBackupBasePath = d.Get("gke_backup_custom_endpoint").(string) diff --git a/google-beta/resource_firebase_storage_bucket.go b/google-beta/resource_firebase_storage_bucket.go new file mode 100644 index 0000000000..adb119b549 --- /dev/null +++ b/google-beta/resource_firebase_storage_bucket.go @@ -0,0 +1,211 @@ +// ---------------------------------------------------------------------------- +// +// *** 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 google + +import ( + "fmt" + "log" + "time" + + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" +) + +func resourceFirebaseStorageBucket() *schema.Resource { + return &schema.Resource{ + Create: resourceFirebaseStorageBucketCreate, + Read: resourceFirebaseStorageBucketRead, + Delete: resourceFirebaseStorageBucketDelete, + + Importer: &schema.ResourceImporter{ + State: resourceFirebaseStorageBucketImport, + }, + + Timeouts: &schema.ResourceTimeout{ + Create: schema.DefaultTimeout(20 * time.Minute), + Delete: schema.DefaultTimeout(20 * time.Minute), + }, + + Schema: map[string]*schema.Schema{ + "bucket_id": { + Type: schema.TypeString, + Optional: true, + ForceNew: true, + Description: `Required. Immutable. The ID of the underlying Google Cloud Storage bucket`, + }, + "name": { + Type: schema.TypeString, + Computed: true, + Description: `Resource name of the bucket in the format projects/PROJECT_IDENTIFIER/buckets/BUCKET_ID`, + }, + "project": { + Type: schema.TypeString, + Optional: true, + Computed: true, + ForceNew: true, + }, + }, + UseJSONNumber: true, + } +} + +func resourceFirebaseStorageBucketCreate(d *schema.ResourceData, meta interface{}) error { + config := meta.(*Config) + userAgent, err := generateUserAgentString(d, config.userAgent) + if err != nil { + return err + } + + obj := make(map[string]interface{}) + + url, err := replaceVars(d, config, "{{FirebaseStorageBasePath}}projects/{{project}}/buckets/{{bucket_id}}:addFirebase") + if err != nil { + return err + } + + log.Printf("[DEBUG] Creating new Bucket: %#v", obj) + billingProject := "" + + project, err := getProject(d, config) + if err != nil { + return fmt.Errorf("Error fetching project for Bucket: %s", err) + } + billingProject = project + + // err == nil indicates that the billing_project value was found + if bp, err := getBillingProject(d, config); err == nil { + billingProject = bp + } + + res, err := sendRequestWithTimeout(config, "POST", billingProject, url, userAgent, obj, d.Timeout(schema.TimeoutCreate)) + if err != nil { + return fmt.Errorf("Error creating Bucket: %s", err) + } + if err := d.Set("name", flattenFirebaseStorageBucketName(res["name"], d, config)); err != nil { + return fmt.Errorf(`Error setting computed identity field "name": %s`, err) + } + + // Store the ID now + id, err := replaceVars(d, config, "projects/{{project}}/buckets/{{bucket_id}}") + if err != nil { + return fmt.Errorf("Error constructing id: %s", err) + } + d.SetId(id) + + log.Printf("[DEBUG] Finished creating Bucket %q: %#v", d.Id(), res) + + return resourceFirebaseStorageBucketRead(d, meta) +} + +func resourceFirebaseStorageBucketRead(d *schema.ResourceData, meta interface{}) error { + config := meta.(*Config) + userAgent, err := generateUserAgentString(d, config.userAgent) + if err != nil { + return err + } + + url, err := replaceVars(d, config, "{{FirebaseStorageBasePath}}projects/{{project}}/buckets/{{bucket_id}}") + if err != nil { + return err + } + + billingProject := "" + + project, err := getProject(d, config) + if err != nil { + return fmt.Errorf("Error fetching project for Bucket: %s", err) + } + billingProject = project + + // err == nil indicates that the billing_project value was found + if bp, err := getBillingProject(d, config); err == nil { + billingProject = bp + } + + res, err := sendRequest(config, "GET", billingProject, url, userAgent, nil) + if err != nil { + return handleNotFoundError(err, d, fmt.Sprintf("FirebaseStorageBucket %q", d.Id())) + } + + if err := d.Set("project", project); err != nil { + return fmt.Errorf("Error reading Bucket: %s", err) + } + + if err := d.Set("name", flattenFirebaseStorageBucketName(res["name"], d, config)); err != nil { + return fmt.Errorf("Error reading Bucket: %s", err) + } + + return nil +} + +func resourceFirebaseStorageBucketDelete(d *schema.ResourceData, meta interface{}) error { + config := meta.(*Config) + userAgent, err := generateUserAgentString(d, config.userAgent) + if err != nil { + return err + } + + billingProject := "" + + project, err := getProject(d, config) + if err != nil { + return fmt.Errorf("Error fetching project for Bucket: %s", err) + } + billingProject = project + + url, err := replaceVars(d, config, "{{FirebaseStorageBasePath}}projects/{{project}}/buckets/{{bucket_id}}:removeFirebase") + if err != nil { + return err + } + + var obj map[string]interface{} + log.Printf("[DEBUG] Deleting Bucket %q", d.Id()) + + // err == nil indicates that the billing_project value was found + if bp, err := getBillingProject(d, config); err == nil { + billingProject = bp + } + + res, err := sendRequestWithTimeout(config, "POST", billingProject, url, userAgent, obj, d.Timeout(schema.TimeoutDelete)) + if err != nil { + return handleNotFoundError(err, d, "Bucket") + } + + log.Printf("[DEBUG] Finished deleting Bucket %q: %#v", d.Id(), res) + return nil +} + +func resourceFirebaseStorageBucketImport(d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) { + config := meta.(*Config) + if err := parseImportId([]string{ + "projects/(?P[^/]+)/buckets/(?P[^/]+)", + "(?P[^/]+)/(?P[^/]+)", + "(?P[^/]+)", + }, d, config); err != nil { + return nil, err + } + + // Replace import id for the resource id + id, err := replaceVars(d, config, "projects/{{project}}/buckets/{{bucket_id}}") + if err != nil { + return nil, fmt.Errorf("Error constructing id: %s", err) + } + d.SetId(id) + + return []*schema.ResourceData{d}, nil +} + +func flattenFirebaseStorageBucketName(v interface{}, d *schema.ResourceData, config *Config) interface{} { + return v +} diff --git a/google-beta/resource_firebase_storage_bucket_generated_test.go b/google-beta/resource_firebase_storage_bucket_generated_test.go new file mode 100644 index 0000000000..cb261a4e13 --- /dev/null +++ b/google-beta/resource_firebase_storage_bucket_generated_test.go @@ -0,0 +1,100 @@ +// ---------------------------------------------------------------------------- +// +// *** 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 google + +import ( + "fmt" + "strings" + "testing" + + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" + "github.com/hashicorp/terraform-plugin-sdk/v2/terraform" +) + +func TestAccFirebaseStorageBucket_firebasestorageBucketBasicExample(t *testing.T) { + t.Parallel() + + context := map[string]interface{}{ + "project_id": getTestProjectFromEnv(), + "random_suffix": randString(t, 10), + } + + vcrTest(t, resource.TestCase{ + PreCheck: func() { testAccPreCheck(t) }, + Providers: testAccProvidersOiCS, + CheckDestroy: testAccCheckFirebaseStorageBucketDestroyProducer(t), + Steps: []resource.TestStep{ + { + Config: testAccFirebaseStorageBucket_firebasestorageBucketBasicExample(context), + }, + { + ResourceName: "google_firebase_storage_bucket.default", + ImportState: true, + ImportStateVerify: true, + ImportStateVerifyIgnore: []string{"bucket_id"}, + }, + }, + }) +} + +func testAccFirebaseStorageBucket_firebasestorageBucketBasicExample(context map[string]interface{}) string { + return Nprintf(` +resource "google_storage_bucket" "default" { + provider = google-beta + name = "tf_test_test_bucket%{random_suffix}" + location = "US" + uniform_bucket_level_access = true +} + +resource "google_firebase_storage_bucket" "default" { + provider = google-beta + project = "%{project_id}" + bucket_id = google_storage_bucket.default.id +} +`, context) +} + +func testAccCheckFirebaseStorageBucketDestroyProducer(t *testing.T) func(s *terraform.State) error { + return func(s *terraform.State) error { + for name, rs := range s.RootModule().Resources { + if rs.Type != "google_firebase_storage_bucket" { + continue + } + if strings.HasPrefix(name, "data.") { + continue + } + + config := googleProviderConfig(t) + + url, err := replaceVarsForTest(config, rs, "{{FirebaseStorageBasePath}}projects/{{project}}/buckets/{{bucket_id}}") + if err != nil { + return err + } + + billingProject := "" + + if config.BillingProject != "" { + billingProject = config.BillingProject + } + + _, err = sendRequest(config, "GET", billingProject, url, config.userAgent, nil) + if err == nil { + return fmt.Errorf("FirebaseStorageBucket still exists at %s", url) + } + } + + return nil + } +} diff --git a/google-beta/resource_firebase_storage_bucket_sweeper_test.go b/google-beta/resource_firebase_storage_bucket_sweeper_test.go new file mode 100644 index 0000000000..8987759478 --- /dev/null +++ b/google-beta/resource_firebase_storage_bucket_sweeper_test.go @@ -0,0 +1,128 @@ +// ---------------------------------------------------------------------------- +// +// *** 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 google + +import ( + "context" + "log" + "strings" + "testing" + + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" +) + +func init() { + resource.AddTestSweepers("FirebaseStorageBucket", &resource.Sweeper{ + Name: "FirebaseStorageBucket", + F: testSweepFirebaseStorageBucket, + }) +} + +// At the time of writing, the CI only passes us-central1 as the region +func testSweepFirebaseStorageBucket(region string) error { + resourceName := "FirebaseStorageBucket" + log.Printf("[INFO][SWEEPER_LOG] Starting sweeper for %s", resourceName) + + config, err := 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 := getTestBillingAccountFromEnv(t) + + // Setup variables to replace in list template + d := &ResourceDataMock{ + FieldsInSchema: map[string]interface{}{ + "project": config.Project, + "region": region, + "location": region, + "zone": "-", + "billing_account": billingId, + }, + } + + listTemplate := strings.Split("https://firebasestorage.googleapis.com/v1beta/projects/{{project}}/buckets", "?")[0] + listUrl, err := replaceVars(d, config, listTemplate) + if err != nil { + log.Printf("[INFO][SWEEPER_LOG] error preparing sweeper list url: %s", err) + return nil + } + + res, err := sendRequest(config, "GET", config.Project, listUrl, config.userAgent, nil) + if err != nil { + log.Printf("[INFO][SWEEPER_LOG] Error in response from request %s: %s", listUrl, err) + return nil + } + + resourceList, ok := res["buckets"] + 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{}) + var name string + // Id detected in the delete URL, attempt to use id. + if obj["id"] != nil { + name = GetResourceNameFromSelfLink(obj["id"].(string)) + } else if obj["name"] != nil { + name = GetResourceNameFromSelfLink(obj["name"].(string)) + } else { + log.Printf("[INFO][SWEEPER_LOG] %s resource name and id were nil", resourceName) + return nil + } + // Skip resources that shouldn't be sweeped + if !isSweepableTestResource(name) { + nonPrefixCount++ + continue + } + + deleteTemplate := "https://firebasestorage.googleapis.com/v1beta/projects/{{project}}/buckets/{{bucket_id}}:removeFirebase" + deleteUrl, err := 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 = sendRequest(config, "DELETE", config.Project, deleteUrl, config.userAgent, nil) + 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 +} diff --git a/website/docs/r/firebase_storage_bucket.html.markdown b/website/docs/r/firebase_storage_bucket.html.markdown new file mode 100644 index 0000000000..dd219af672 --- /dev/null +++ b/website/docs/r/firebase_storage_bucket.html.markdown @@ -0,0 +1,101 @@ +--- +# ---------------------------------------------------------------------------- +# +# *** 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. +# +# ---------------------------------------------------------------------------- +subcategory: "Cloud Storage for Firebase" +page_title: "Google: google_firebase_storage_bucket" +description: |- + An association between a Firebase project and a Google Cloud Storage bucket. +--- + +# google\_firebase\_storage\_bucket + +An association between a Firebase project and a Google Cloud Storage bucket. +This association enables integration of Cloud Storage buckets with Firebase such as Firebase SDKS, Authentication, and Security Rules. + +~> **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider. +See [Provider Versions](https://terraform.io/docs/providers/google/guides/provider_versions.html) for more details on beta resources. + +To get more information about Bucket, see: + +* [API documentation](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets) +* How-to Guides + * [Official Documentation](https://firebase.google.com/docs/storage/) + +## Example Usage - Firebasestorage Bucket Basic + + +```hcl +resource "google_storage_bucket" "default" { + provider = google-beta + name = "test_bucket" + location = "US" + uniform_bucket_level_access = true +} + +resource "google_firebase_storage_bucket" "default" { + provider = google-beta + project = "my-project-name" + bucket_id = google_storage_bucket.default.id +} +``` + +## Argument Reference + +The following arguments are supported: + + + +- - - + + +* `bucket_id` - + (Optional) + Required. Immutable. The ID of the underlying Google Cloud Storage bucket + +* `project` - (Optional) The ID of the project in which the resource belongs. + If it is not provided, the provider project is used. + + +## Attributes Reference + +In addition to the arguments listed above, the following computed attributes are exported: + +* `id` - an identifier for the resource with format `projects/{{project}}/buckets/{{bucket_id}}` + +* `name` - + Resource name of the bucket in the format projects/PROJECT_IDENTIFIER/buckets/BUCKET_ID + + +## Timeouts + +This resource provides the following +[Timeouts](/docs/configuration/resources.html#timeouts) configuration options: + +- `create` - Default is 20 minutes. +- `delete` - Default is 20 minutes. + +## Import + + +Bucket can be imported using any of these accepted formats: + +``` +$ terraform import google_firebase_storage_bucket.default projects/{{project}}/buckets/{{bucket_id}} +$ terraform import google_firebase_storage_bucket.default {{project}}/{{bucket_id}} +$ terraform import google_firebase_storage_bucket.default {{bucket_id}} +``` + +## User Project Overrides + +This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override).