Add lifecycle hook and updated samples for firebaserules_release (#7779) (#5611)

Signed-off-by: Modular Magician <[email protected]>

Author: modular-magician

.changelog/7779.txt

@@ -0,0 +1,2 @@
+```release-note:none
+```

google-beta/resource_firebaserules_release_generated_test.go

@@ -29,7 +29,7 @@ import (
 	transport_tpg "github.com/hashicorp/terraform-provider-google-beta/google-beta/transport"
 )
 
-func TestAccFirebaserulesRelease_BasicRelease(t *testing.T) {
+func TestAccFirebaserulesRelease_FirestoreReleaseHandWritten(t *testing.T) {
 	t.Parallel()
 
 	context := map[string]interface{}{
@@ -43,15 +43,15 @@ func TestAccFirebaserulesRelease_BasicRelease(t *testing.T) {
 		CheckDestroy:             testAccCheckFirebaserulesReleaseDestroyProducer(t),
 		Steps: []resource.TestStep{
 			{
-				Config: testAccFirebaserulesRelease_BasicRelease(context),
+				Config: testAccFirebaserulesRelease_FirestoreReleaseHandWritten(context),
 			},
 			{
 				ResourceName:      "google_firebaserules_release.primary",
 				ImportState:       true,
 				ImportStateVerify: true,
 			},
 			{
-				Config: testAccFirebaserulesRelease_BasicReleaseUpdate0(context),
+				Config: testAccFirebaserulesRelease_FirestoreReleaseHandWrittenUpdate0(context),
 			},
 			{
 				ResourceName:      "google_firebaserules_release.primary",
@@ -61,11 +61,12 @@ func TestAccFirebaserulesRelease_BasicRelease(t *testing.T) {
 		},
 	})
 }
-func TestAccFirebaserulesRelease_MinimalRelease(t *testing.T) {
+func TestAccFirebaserulesRelease_StorageReleaseHandWritten(t *testing.T) {
 	t.Parallel()
 
 	context := map[string]interface{}{
 		"project_name":  acctest.GetTestProjectFromEnv(),
+		"region":        acctest.GetTestRegionFromEnv(),
 		"random_suffix": RandString(t, 10),
 	}
 
@@ -75,7 +76,7 @@ func TestAccFirebaserulesRelease_MinimalRelease(t *testing.T) {
 		CheckDestroy:             testAccCheckFirebaserulesReleaseDestroyProducer(t),
 		Steps: []resource.TestStep{
 			{
-				Config: testAccFirebaserulesRelease_MinimalRelease(context),
+				Config: testAccFirebaserulesRelease_StorageReleaseHandWritten(context),
 			},
 			{
 				ResourceName:      "google_firebaserules_release.primary",
@@ -86,29 +87,21 @@ func TestAccFirebaserulesRelease_MinimalRelease(t *testing.T) {
 	})
 }
 
-func testAccFirebaserulesRelease_BasicRelease(context map[string]interface{}) string {
+func testAccFirebaserulesRelease_FirestoreReleaseHandWritten(context map[string]interface{}) string {
 	return Nprintf(`
 resource "google_firebaserules_release" "primary" {
-  name         = "tf-test-release%{random_suffix}"
-  ruleset_name = "projects/%{project_name}/rulesets/${google_firebaserules_ruleset.basic.name}"
+  name         = "cloud.firestore"
+  ruleset_name = "projects/%{project_name}/rulesets/${google_firebaserules_ruleset.firestore.name}"
   project      = "%{project_name}"
-}
-
-resource "google_firebaserules_ruleset" "basic" {
-  source {
-    files {
-      content     = "service cloud.firestore {match /databases/{database}/documents { match /{document=**} { allow read, write: if false; } } }"
-      name        = "firestore.rules"
-      fingerprint = ""
-    }
 
-    language = ""
+  lifecycle {
+    replace_triggered_by = [
+      google_firebaserules_ruleset.firestore
+    ]
   }
-
-  project = "%{project_name}"
 }
 
-resource "google_firebaserules_ruleset" "minimal" {
+resource "google_firebaserules_ruleset" "firestore" {
   source {
     files {
       content = "service cloud.firestore {match /databases/{database}/documents { match /{document=**} { allow read, write: if false; } } }"
@@ -119,67 +112,79 @@ resource "google_firebaserules_ruleset" "minimal" {
   project = "%{project_name}"
 }
 
-
 `, context)
 }
 
-func testAccFirebaserulesRelease_BasicReleaseUpdate0(context map[string]interface{}) string {
+func testAccFirebaserulesRelease_FirestoreReleaseHandWrittenUpdate0(context map[string]interface{}) string {
 	return Nprintf(`
 resource "google_firebaserules_release" "primary" {
-  name         = "tf-test-release%{random_suffix}"
-  ruleset_name = "projects/%{project_name}/rulesets/${google_firebaserules_ruleset.minimal.name}"
+  name         = "cloud.firestore"
+  ruleset_name = "projects/%{project_name}/rulesets/${google_firebaserules_ruleset.firestore.name}"
   project      = "%{project_name}"
-}
 
-resource "google_firebaserules_ruleset" "basic" {
-  source {
-    files {
-      content     = "service cloud.firestore {match /databases/{database}/documents { match /{document=**} { allow read, write: if false; } } }"
-      name        = "firestore.rules"
-      fingerprint = ""
-    }
-
-    language = ""
+  lifecycle {
+    replace_triggered_by = [
+      google_firebaserules_ruleset.firestore
+    ]
   }
-
-  project = "%{project_name}"
 }
 
-resource "google_firebaserules_ruleset" "minimal" {
+resource "google_firebaserules_ruleset" "firestore" {
   source {
     files {
-      content = "service cloud.firestore {match /databases/{database}/documents { match /{document=**} { allow read, write: if false; } } }"
+      content = "service cloud.firestore {match /databases/{database}/documents { match /{document=**} { allow read, write: if request.auth != null; } } }"
       name    = "firestore.rules"
     }
   }
 
   project = "%{project_name}"
 }
 
-
 `, context)
 }
 
-func testAccFirebaserulesRelease_MinimalRelease(context map[string]interface{}) string {
+func testAccFirebaserulesRelease_StorageReleaseHandWritten(context map[string]interface{}) string {
 	return Nprintf(`
 resource "google_firebaserules_release" "primary" {
-  name         = "prod/tf-test-release%{random_suffix}"
-  ruleset_name = "projects/%{project_name}/rulesets/${google_firebaserules_ruleset.minimal.name}"
+  name         = "firebase.storage/${google_storage_bucket.bucket.name}"
+  ruleset_name = "projects/%{project_name}/rulesets/${google_firebaserules_ruleset.storage.name}"
   project      = "%{project_name}"
+
+  lifecycle {
+    replace_triggered_by = [
+      google_firebaserules_ruleset.storage
+    ]
+  }
+}
+
+# Provision a non-default Cloud Storage bucket.
+resource "google_storage_bucket" "bucket" {
+  project = "%{project_name}"
+  name    = "tf-test-bucket%{random_suffix}"
+  location = "%{region}"
 }
 
-resource "google_firebaserules_ruleset" "minimal" {
+# Make the Storage bucket accessible for Firebase SDKs, authentication, and Firebase Security Rules.
+resource "google_firebase_storage_bucket" "bucket" {
+  project   = "%{project_name}"
+  bucket_id = google_storage_bucket.bucket.name
+}
+
+# Create a ruleset of Firebase Security Rules from a local file.
+resource "google_firebaserules_ruleset" "storage" {
+  project = "%{project_name}"
   source {
     files {
-      content = "service cloud.firestore {match /databases/{database}/documents { match /{document=**} { allow read, write: if false; } } }"
-      name    = "firestore.rules"
+      name    = "storage.rules"
+      content = "service firebase.storage {match /b/{bucket}/o {match /{allPaths=**} {allow read, write: if request.auth != null;}}}"
     }
   }
 
-  project = "%{project_name}"
+  depends_on = [
+    google_firebase_storage_bucket.bucket
+  ]
 }
 
-
 `, context)
 }
 

website/docs/r/firebaserules_release.html.markdown

@@ -24,30 +24,22 @@ description: |-
 
 For more information, see:
 * [Get started with Firebase Security Rules](https://firebase.google.com/docs/rules/get-started)
-## Example Usage - basic_release
-Creates a basic Firebase Rules Release
+## Example Usage - firestore_release
+Creates a Firebase Rules Release to Cloud Firestore
 ```hcl
 resource "google_firebaserules_release" "primary" {
-  name         = "release"
-  ruleset_name = "projects/my-project-name/rulesets/${google_firebaserules_ruleset.basic.name}"
+  name         = "cloud.firestore"
+  ruleset_name = "projects/my-project-name/rulesets/${google_firebaserules_ruleset.firestore.name}"
   project      = "my-project-name"
-}
-
-resource "google_firebaserules_ruleset" "basic" {
-  source {
-    files {
-      content     = "service cloud.firestore {match /databases/{database}/documents { match /{document=**} { allow read, write: if false; } } }"
-      name        = "firestore.rules"
-      fingerprint = ""
-    }
 
-    language = ""
+  lifecycle {
+    replace_triggered_by = [
+      google_firebaserules_ruleset.firestore
+    ]
   }
-
-  project = "my-project-name"
 }
 
-resource "google_firebaserules_ruleset" "minimal" {
+resource "google_firebaserules_ruleset" "firestore" {
   source {
     files {
       content = "service cloud.firestore {match /databases/{database}/documents { match /{document=**} { allow read, write: if false; } } }"
@@ -58,29 +50,50 @@ resource "google_firebaserules_ruleset" "minimal" {
   project = "my-project-name"
 }
 
-
 ```
-## Example Usage - minimal_release
-Creates a minimal Firebase Rules Release
+## Example Usage - storage_release
+Creates a Firebase Rules Release for a Storage bucket
 ```hcl
 resource "google_firebaserules_release" "primary" {
-  name         = "prod/release"
-  ruleset_name = "projects/my-project-name/rulesets/${google_firebaserules_ruleset.minimal.name}"
+  name         = "firebase.storage/${google_storage_bucket.bucket.name}"
+  ruleset_name = "projects/my-project-name/rulesets/${google_firebaserules_ruleset.storage.name}"
   project      = "my-project-name"
+
+  lifecycle {
+    replace_triggered_by = [
+      google_firebaserules_ruleset.storage
+    ]
+  }
 }
 
-resource "google_firebaserules_ruleset" "minimal" {
+# Provision a non-default Cloud Storage bucket.
+resource "google_storage_bucket" "bucket" {
+  project = "my-project-name"
+  name    = "bucket"
+  location = "us-west1"
+}
+
+# Make the Storage bucket accessible for Firebase SDKs, authentication, and Firebase Security Rules.
+resource "google_firebase_storage_bucket" "bucket" {
+  project   = "my-project-name"
+  bucket_id = google_storage_bucket.bucket.name
+}
+
+# Create a ruleset of Firebase Security Rules from a local file.
+resource "google_firebaserules_ruleset" "storage" {
+  project = "my-project-name"
   source {
     files {
-      content = "service cloud.firestore {match /databases/{database}/documents { match /{document=**} { allow read, write: if false; } } }"
-      name    = "firestore.rules"
+      name    = "storage.rules"
+      content = "service firebase.storage {match /b/{bucket}/o {match /{allPaths=**} {allow read, write: if request.auth != null;}}}"
     }
   }
 
-  project = "my-project-name"
+  depends_on = [
+    google_firebase_storage_bucket.bucket
+  ]
 }
 
-
 ```
 
 ## Argument Reference