feat: support multiple firebase sites

app/placeholder/Dockerfile

@@ -18,4 +18,5 @@ ARG PROJECT_ID=YOURPROJECTID
 FROM gcr.io/$PROJECT_ID/firebase
 
 COPY . ./
+
 ENTRYPOINT ./placeholder-deploy.sh

app/placeholder/firebaserc.tmpl

@@ -0,0 +1,13 @@
+{
+  "projects": {},
+  "targets": {
+    "$PROJECT_ID": {
+      "hosting": {
+        "$SUFFIX": [
+          "${PROJECT_ID}-${SUFFIX}"
+        ]
+      }
+    }
+  },
+  "etags": {}
+}

app/placeholder/placeholder-deploy.sh

@@ -17,6 +17,24 @@
 # any errors? exit immediately.
 set -e
 
+# if deploying with a suffix (from infra/jobs.tf), adjust the config to suit the custom site
+# https://firebase.google.com/docs/hosting/multisites#set_up_deploy_targets
+if [[ -n $SUFFIX ]]; then
+    json -I -f firebase.json -e "this.hosting.target='$SUFFIX'"
+    UPDATED=true
+
+    # Use template file to generate configuration
+    envsubst  < firebaserc.tmpl > .firebaserc
+    echo "Customised .firebaserc created to support site."
+    cat .firebaserc
+fi
+
+# If anything was updated, then export the output.
+if [[ -n $UPDATED ]]; then
+    echo "Deploying with the following updated config: "
+    cat firebase.json
+fi
+
 echo "Deploying placeholder to Firebase..."
 
 firebase deploy --project "$PROJECT_ID" --only hosting

build/int.cloudbuild.yaml

@@ -22,22 +22,55 @@ steps:
   - 'TF_VAR_org_id=$_ORG_ID'
   - 'TF_VAR_folder_id=$_FOLDER_ID'
   - 'TF_VAR_billing_account=$_BILLING_ACCOUNT'
+
+# Initialize all tests, then run two parallel sets of tests.
+- id: init-all
+  name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
+  args: ['/bin/bash', '-c', 'cft test run all --stage init --verbose']
+
+# Simple example - one deployment per project
 - id: simple-example-init
+  waitFor: ['init-all']
   dir: infra
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
   args: ['/bin/bash', '-c', 'cft test run TestSimpleExample --stage init --verbose']
 - id: simple-example-apply
+  waitFor: ['simple-example-init']
   dir: infra
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
   args: ['/bin/bash', '-c', 'cft test run TestSimpleExample --stage apply --verbose']
 - id: simple-example-verify
+  waitFor: ['simple-example-apply']
   dir: infra
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
   args: ['/bin/bash', '-c', 'cft test run TestSimpleExample --stage verify --verbose']
 - id: simple-example-teardown
+  waitFor: ['simple-example-verify']
   dir: infra
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
   args: ['/bin/bash', '-c', 'cft test run TestSimpleExample --stage teardown --verbose']
+
+# Suffix example - supports multiple deployments per project
+- id: suffix-example-init
+  waitFor: ['init-all']
+  dir: infra
+  name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
+  args: ['/bin/bash', '-c', 'cft test run TestSuffixExample --stage init --verbose']
+- id: suffix-example-apply
+  waitFor: ['suffix-example-init']
+  dir: infra
+  name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
+  args: ['/bin/bash', '-c', 'cft test run TestSuffixExample --stage apply --verbose']
+- id: suffix-example-verify
+  waitFor: ['suffix-example-apply']
+  dir: infra
+  name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
+  args: ['/bin/bash', '-c', 'cft test run TestSuffixExample --stage verify --verbose']
+- id: suffix-example-teardown
+  waitFor: ['suffix-example-verify']
+  dir: infra
+  name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
+  args: ['/bin/bash', '-c', 'cft test run TestSuffixExample --stage teardown --verbose']
 tags:
 - 'ci'
 - 'integration'

infra/README.md

@@ -62,10 +62,12 @@ Functional examples are included in the
 
 | Name | Description |
 |------|-------------|
+| client\_job\_name | Name of the Cloud Run Job, deploying the front end |
 | django\_admin\_password | Djando Admin password |
 | django\_admin\_url | Djando Admin URL |
 | firebase\_url | Firebase URL |
 | neos\_toc\_url | Neos Tutorial URL |
+| server\_service\_name | Name of the Cloud Run service, hosting the server API |
 | usage | Next steps for usage |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

infra/apis.tf

@@ -28,6 +28,7 @@ locals {
     "secretmanager.googleapis.com",
     "cloudresourcemanager.googleapis.com",
     "firebase.googleapis.com",
+    "firebasehosting.googleapis.com",
   ]
 }
 

infra/examples/simple_example/README.md

@@ -13,7 +13,9 @@ This example illustrates how to use the `dynamic-python-webapp` module.
 
 | Name | Description |
 |------|-------------|
+| client\_job\_name | Client Cloud Run job name |
 | firebase\_url | Firebase URL |
+| server\_service\_name | Server Cloud Run service name |
 | usage | Connection details for the project |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

infra/examples/simple_example/main.tf

@@ -15,7 +15,7 @@
  */
 
 module "dynamic-python-webapp" {
-  source = "../.."
-
-  project_id = var.project_id
+  source        = "../.."
+  project_id    = var.project_id
+  random_suffix = false
 }

infra/examples/simple_example/outputs.tf

@@ -24,3 +24,13 @@ output "firebase_url" {
   description = "Firebase URL"
   value       = module.dynamic-python-webapp.firebase_url
 }
+
+output "server_service_name" {
+  description = "Server Cloud Run service name"
+  value       = module.dynamic-python-webapp.server_service_name
+}
+
+output "client_job_name" {
+  description = "Client Cloud Run job name"
+  value       = module.dynamic-python-webapp.client_job_name
+}

infra/examples/suffix_example/README.md

@@ -0,0 +1,29 @@
+# Simple Example
+
+This example illustrates how to use the `dynamic-python-webapp` module.
+
+This example uses a randomly generated suffix when naming resources to support multiple deployments per project.
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| project\_id | The ID of the project in which to provision resources. | `string` | n/a | yes |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| client\_job\_name | Client Cloud Run job name |
+| firebase\_url | Firebase URL |
+| server\_service\_name | Server Cloud Run service name |
+| usage | Connection details for the project |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+
+To provision this example, run the following from within this directory:
+- `terraform init` to get the plugins
+- `terraform plan` to see the infrastructure plan
+- `terraform apply` to apply the infrastructure build
+- `terraform destroy` to destroy the built infrastructure

infra/examples/suffix_example/main.tf

@@ -0,0 +1,21 @@
+/**
+ * Copyright 2023 Google LLC
+ *
+ * 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.
+ */
+
+module "dynamic-python-webapp" {
+  source = "../.."
+
+  project_id = var.project_id
+}

infra/examples/suffix_example/outputs.tf

@@ -0,0 +1,37 @@
+/**
+ * Copyright 2023 Google LLC
+ *
+ * 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.
+ */
+
+output "usage" {
+  sensitive   = true
+  description = "Connection details for the project"
+  value       = module.dynamic-python-webapp.usage
+}
+
+output "firebase_url" {
+  description = "Firebase URL"
+  value       = module.dynamic-python-webapp.firebase_url
+}
+
+output "server_service_name" {
+  description = "Server Cloud Run service name"
+  value       = module.dynamic-python-webapp.server_service_name
+}
+
+output "client_job_name" {
+  description = "Client Cloud Run job name"
+  value       = module.dynamic-python-webapp.client_job_name
+}
+

infra/examples/suffix_example/variables.tf

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2023 Google LLC
+ *
+ * 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.
+ */
+
+variable "project_id" {
+  description = "The ID of the project in which to provision resources."
+  type        = string
+}

infra/examples/suffix_example/versions.tf

@@ -0,0 +1,25 @@
+/**
+ * Copyright 2023 Google LLC
+ *
+ * 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.
+ */
+
+terraform {
+  required_providers {
+    google = {
+      source  = "hashicorp/google"
+      version = "~> 4.0"
+    }
+  }
+  required_version = ">= 0.13"
+}

infra/firebase.tf

@@ -20,3 +20,15 @@ resource "google_firebase_project" "default" {
 
   depends_on = [google_project_service.enabled]
 }
+
+resource "google_firebase_hosting_site" "client" {
+
+  # By default, a firebase site will be named "project_id". Only create a custom site if using suffixes
+  count = var.random_suffix ? 1 : 0
+
+  provider = google-beta
+  project  = google_firebase_project.default.project
+  site_id  = "${var.project_id}-${random_id.suffix.hex}"
+
+  depends_on = [google_project_service.enabled]
+}

infra/jobs.tf

@@ -115,6 +115,13 @@ resource "google_cloud_run_v2_job" "client" {
       service_account = google_service_account.client.email
       containers {
         image = local.client_image
+
+        # Variables used to customise Firebase configuration on deployment
+        # https://github.com/GoogleCloudPlatform/avocano/blob/main/client/docker-deploy.sh
+        env {
+          name  = "SUFFIX"
+          value = var.random_suffix ? random_id.suffix.hex : ""
+        }
         env {
           name  = "SERVICE_NAME"
           value = google_cloud_run_v2_service.server.name
@@ -154,6 +161,10 @@ resource "google_cloud_run_v2_job" "placeholder" {
           value = var.project_id
         }
 
+        env {
+          name  = "SUFFIX"
+          value = var.random_suffix ? random_id.suffix.hex : ""
+        }
       }
     }
   }

infra/main.tf

@@ -20,3 +20,8 @@ provider "google" {
   project = var.project_id
   region  = var.region
 }
+
+provider "google-beta" {
+  project = var.project_id
+  region  = var.region
+}

infra/metadata.yaml

@@ -45,6 +45,8 @@ spec:
     examples:
     - name: simple_example
       location: examples/simple_example
+    - name: suffix_example
+      location: examples/suffix_example
   interfaces:
     variables:
     - name: client_image_host
@@ -100,6 +102,8 @@ spec:
       varType: string
       defaultValue: us-central1-c
     outputs:
+    - name: client_job_name
+      description: Name of the Cloud Run Job, deploying the front end
     - name: django_admin_password
       description: Djando Admin password
     - name: django_admin_url
@@ -108,6 +112,8 @@ spec:
       description: Firebase URL
     - name: neos_toc_url
       description: Neos Tutorial URL
+    - name: server_service_name
+      description: Name of the Cloud Run service, hosting the server API
     - name: usage
       description: Next steps for usage
   requirements:

infra/outputs.tf

@@ -16,7 +16,7 @@
 
 locals {
   server_url   = google_cloud_run_v2_service.server.uri
-  firebase_url = "https://${var.project_id}.web.app"
+  firebase_url = var.random_suffix ? google_firebase_hosting_site.client[0].default_url : "https://${var.project_id}.web.app"
 }
 
 output "firebase_url" {
@@ -63,3 +63,13 @@ output "usage" {
     Password: ${google_secret_manager_secret_version.django_admin_password.secret_data}
     EOF
 }
+
+output "server_service_name" {
+  description = "Name of the Cloud Run service, hosting the server API"
+  value       = google_cloud_run_v2_service.server.name
+}
+
+output "client_job_name" {
+  description = "Name of the Cloud Run Job, deploying the front end"
+  value       = google_cloud_run_v2_job.client.name
+}