From 85cf818d091f943049e1d8f6a7d767f55ab644f4 Mon Sep 17 00:00:00 2001
From: Modular Magician <magic-modules@google.com>
Date: Thu, 31 Jul 2025 14:21:25 +0000
Subject: [PATCH] feat: define smt examples for pubsub topics and subscriptions
 (#14627)

[upstream:8c5be926dde6d0cdb47717b96fee75df3b9a72f0]

Signed-off-by: Modular Magician <magic-modules@google.com>
---
 .../backing_file.tf                           | 15 ++++
 pubsub_subscription_multiple_smts/main.tf     | 49 ++++++++++++
 pubsub_subscription_multiple_smts/motd        |  7 ++
 pubsub_subscription_multiple_smts/tutorial.md | 79 +++++++++++++++++++
 .../backing_file.tf                           | 15 ++++
 pubsub_subscription_single_smt/main.tf        | 20 +++++
 pubsub_subscription_single_smt/motd           |  7 ++
 pubsub_subscription_single_smt/tutorial.md    | 79 +++++++++++++++++++
 pubsub_topic_multiple_smts/backing_file.tf    | 15 ++++
 pubsub_topic_multiple_smts/main.tf            | 44 +++++++++++
 pubsub_topic_multiple_smts/motd               |  7 ++
 pubsub_topic_multiple_smts/tutorial.md        | 79 +++++++++++++++++++
 pubsub_topic_single_smt/backing_file.tf       | 15 ++++
 pubsub_topic_single_smt/main.tf               | 15 ++++
 pubsub_topic_single_smt/motd                  |  7 ++
 pubsub_topic_single_smt/tutorial.md           | 79 +++++++++++++++++++
 16 files changed, 532 insertions(+)
 create mode 100644 pubsub_subscription_multiple_smts/backing_file.tf
 create mode 100644 pubsub_subscription_multiple_smts/main.tf
 create mode 100644 pubsub_subscription_multiple_smts/motd
 create mode 100644 pubsub_subscription_multiple_smts/tutorial.md
 create mode 100644 pubsub_subscription_single_smt/backing_file.tf
 create mode 100644 pubsub_subscription_single_smt/main.tf
 create mode 100644 pubsub_subscription_single_smt/motd
 create mode 100644 pubsub_subscription_single_smt/tutorial.md
 create mode 100644 pubsub_topic_multiple_smts/backing_file.tf
 create mode 100644 pubsub_topic_multiple_smts/main.tf
 create mode 100644 pubsub_topic_multiple_smts/motd
 create mode 100644 pubsub_topic_multiple_smts/tutorial.md
 create mode 100644 pubsub_topic_single_smt/backing_file.tf
 create mode 100644 pubsub_topic_single_smt/main.tf
 create mode 100644 pubsub_topic_single_smt/motd
 create mode 100644 pubsub_topic_single_smt/tutorial.md

diff --git a/pubsub_subscription_multiple_smts/backing_file.tf b/pubsub_subscription_multiple_smts/backing_file.tf
new file mode 100644
index 00000000..c60b1199
--- /dev/null
+++ b/pubsub_subscription_multiple_smts/backing_file.tf
@@ -0,0 +1,15 @@
+# This file has some scaffolding to make sure that names are unique and that
+# a region and zone are selected when you try to create your Terraform resources.
+
+locals {
+  name_suffix = "${random_pet.suffix.id}"
+}
+
+resource "random_pet" "suffix" {
+  length = 2
+}
+
+provider "google" {
+  region = "us-central1"
+  zone   = "us-central1-c"
+}
diff --git a/pubsub_subscription_multiple_smts/main.tf b/pubsub_subscription_multiple_smts/main.tf
new file mode 100644
index 00000000..290ca596
--- /dev/null
+++ b/pubsub_subscription_multiple_smts/main.tf
@@ -0,0 +1,49 @@
+resource "google_pubsub_topic" "example" {
+  name = "example-topic-${local.name_suffix}"
+}
+
+locals {
+  smts = [
+    {
+      function_name = "redactSSN"
+      code = <<EOF
+function redactSSN(message, metadata) {
+  const data = JSON.parse(message.data);
+  delete data['ssn'];
+  message.data = JSON.stringify(data);
+  return message;
+}
+EOF
+    },
+    {
+      function_name = "otherFunc",
+      code = <<EOF
+function otherFunc(message, metadata) {
+  return null;
+}
+EOF
+    },
+    {
+      function_name = "someSMTWeDisabled",
+      code = "..."
+      disabled = true
+    }
+  ]
+}
+
+resource "google_pubsub_subscription" "example" {
+  name  = "example-subscription-${local.name_suffix}"
+  topic = google_pubsub_topic.example.id
+
+  dynamic "message_transforms" {
+    for_each = local.smts
+
+    content {
+      disabled = lookup(message_transforms.value, "disabled", null)
+      javascript_udf {
+        function_name = message_transforms.value.function_name
+        code = message_transforms.value.code
+      }
+    }
+  }
+}
diff --git a/pubsub_subscription_multiple_smts/motd b/pubsub_subscription_multiple_smts/motd
new file mode 100644
index 00000000..45a906e8
--- /dev/null
+++ b/pubsub_subscription_multiple_smts/motd
@@ -0,0 +1,7 @@
+===
+
+These examples use real resources that will be billed to the
+Google Cloud Platform project you use - so make sure that you
+run "terraform destroy" before quitting!
+
+===
diff --git a/pubsub_subscription_multiple_smts/tutorial.md b/pubsub_subscription_multiple_smts/tutorial.md
new file mode 100644
index 00000000..f333cbaf
--- /dev/null
+++ b/pubsub_subscription_multiple_smts/tutorial.md
@@ -0,0 +1,79 @@
+# Pubsub Subscription Multiple Smts - Terraform
+
+## Setup
+
+<walkthrough-author name="rileykarson@google.com" analyticsId="UA-125550242-1" tutorialName="pubsub_subscription_multiple_smts" repositoryUrl="https://github.com/terraform-google-modules/docs-examples"></walkthrough-author>
+
+Welcome to Terraform in Google Cloud Shell! We need you to let us know what project you'd like to use with Terraform.
+
+<walkthrough-project-billing-setup></walkthrough-project-billing-setup>
+
+Terraform provisions real GCP resources, so anything you create in this session will be billed against this project.
+
+## Terraforming!
+
+Let's use {{project-id}} with Terraform! Click the Cloud Shell icon below to copy the command
+to your shell, and then run it from the shell by pressing Enter/Return. Terraform will pick up
+the project name from the environment variable.
+
+```bash
+export GOOGLE_CLOUD_PROJECT={{project-id}}
+```
+
+After that, let's get Terraform started. Run the following to pull in the providers.
+
+```bash
+terraform init
+```
+
+With the providers downloaded and a project set, you're ready to use Terraform. Go ahead!
+
+```bash
+terraform apply
+```
+
+Terraform will show you what it plans to do, and prompt you to accept. Type "yes" to accept the plan.
+
+```bash
+yes
+```
+
+
+## Post-Apply
+
+### Editing your config
+
+Now you've provisioned your resources in GCP! If you run a "plan", you should see no changes needed.
+
+```bash
+terraform plan
+```
+
+So let's make a change! Try editing a number, or appending a value to the name in the editor. Then,
+run a 'plan' again.
+
+```bash
+terraform plan
+```
+
+Afterwards you can run an apply, which implicitly does a plan and shows you the intended changes
+at the 'yes' prompt.
+
+```bash
+terraform apply
+```
+
+```bash
+yes
+```
+
+## Cleanup
+
+Run the following to remove the resources Terraform provisioned:
+
+```bash
+terraform destroy
+```
+```bash
+yes
+```
diff --git a/pubsub_subscription_single_smt/backing_file.tf b/pubsub_subscription_single_smt/backing_file.tf
new file mode 100644
index 00000000..c60b1199
--- /dev/null
+++ b/pubsub_subscription_single_smt/backing_file.tf
@@ -0,0 +1,15 @@
+# This file has some scaffolding to make sure that names are unique and that
+# a region and zone are selected when you try to create your Terraform resources.
+
+locals {
+  name_suffix = "${random_pet.suffix.id}"
+}
+
+resource "random_pet" "suffix" {
+  length = 2
+}
+
+provider "google" {
+  region = "us-central1"
+  zone   = "us-central1-c"
+}
diff --git a/pubsub_subscription_single_smt/main.tf b/pubsub_subscription_single_smt/main.tf
new file mode 100644
index 00000000..dd31f9f6
--- /dev/null
+++ b/pubsub_subscription_single_smt/main.tf
@@ -0,0 +1,20 @@
+resource "google_pubsub_topic" "example" {
+  name = "example-topic-${local.name_suffix}"
+}
+
+resource "google_pubsub_subscription" "example" {
+  name  = "example-subscription-${local.name_suffix}"
+  topic = google_pubsub_topic.example.id
+
+  message_transforms {
+    javascript_udf {
+      function_name = "isYearEven"
+      code = <<EOF
+function isYearEven(message, metadata) {
+  const data = JSON.parse(message.data);
+  return message.year %2 === 0;
+}
+EOF
+    }
+  }
+}
diff --git a/pubsub_subscription_single_smt/motd b/pubsub_subscription_single_smt/motd
new file mode 100644
index 00000000..45a906e8
--- /dev/null
+++ b/pubsub_subscription_single_smt/motd
@@ -0,0 +1,7 @@
+===
+
+These examples use real resources that will be billed to the
+Google Cloud Platform project you use - so make sure that you
+run "terraform destroy" before quitting!
+
+===
diff --git a/pubsub_subscription_single_smt/tutorial.md b/pubsub_subscription_single_smt/tutorial.md
new file mode 100644
index 00000000..d7ac69f2
--- /dev/null
+++ b/pubsub_subscription_single_smt/tutorial.md
@@ -0,0 +1,79 @@
+# Pubsub Subscription Single Smt - Terraform
+
+## Setup
+
+<walkthrough-author name="rileykarson@google.com" analyticsId="UA-125550242-1" tutorialName="pubsub_subscription_single_smt" repositoryUrl="https://github.com/terraform-google-modules/docs-examples"></walkthrough-author>
+
+Welcome to Terraform in Google Cloud Shell! We need you to let us know what project you'd like to use with Terraform.
+
+<walkthrough-project-billing-setup></walkthrough-project-billing-setup>
+
+Terraform provisions real GCP resources, so anything you create in this session will be billed against this project.
+
+## Terraforming!
+
+Let's use {{project-id}} with Terraform! Click the Cloud Shell icon below to copy the command
+to your shell, and then run it from the shell by pressing Enter/Return. Terraform will pick up
+the project name from the environment variable.
+
+```bash
+export GOOGLE_CLOUD_PROJECT={{project-id}}
+```
+
+After that, let's get Terraform started. Run the following to pull in the providers.
+
+```bash
+terraform init
+```
+
+With the providers downloaded and a project set, you're ready to use Terraform. Go ahead!
+
+```bash
+terraform apply
+```
+
+Terraform will show you what it plans to do, and prompt you to accept. Type "yes" to accept the plan.
+
+```bash
+yes
+```
+
+
+## Post-Apply
+
+### Editing your config
+
+Now you've provisioned your resources in GCP! If you run a "plan", you should see no changes needed.
+
+```bash
+terraform plan
+```
+
+So let's make a change! Try editing a number, or appending a value to the name in the editor. Then,
+run a 'plan' again.
+
+```bash
+terraform plan
+```
+
+Afterwards you can run an apply, which implicitly does a plan and shows you the intended changes
+at the 'yes' prompt.
+
+```bash
+terraform apply
+```
+
+```bash
+yes
+```
+
+## Cleanup
+
+Run the following to remove the resources Terraform provisioned:
+
+```bash
+terraform destroy
+```
+```bash
+yes
+```
diff --git a/pubsub_topic_multiple_smts/backing_file.tf b/pubsub_topic_multiple_smts/backing_file.tf
new file mode 100644
index 00000000..c60b1199
--- /dev/null
+++ b/pubsub_topic_multiple_smts/backing_file.tf
@@ -0,0 +1,15 @@
+# This file has some scaffolding to make sure that names are unique and that
+# a region and zone are selected when you try to create your Terraform resources.
+
+locals {
+  name_suffix = "${random_pet.suffix.id}"
+}
+
+resource "random_pet" "suffix" {
+  length = 2
+}
+
+provider "google" {
+  region = "us-central1"
+  zone   = "us-central1-c"
+}
diff --git a/pubsub_topic_multiple_smts/main.tf b/pubsub_topic_multiple_smts/main.tf
new file mode 100644
index 00000000..116e58d4
--- /dev/null
+++ b/pubsub_topic_multiple_smts/main.tf
@@ -0,0 +1,44 @@
+locals {
+  smts = [
+    {
+      function_name = "redactSSN"
+      code = <<EOF
+function redactSSN(message, metadata) {
+  const data = JSON.parse(message.data);
+  delete data['ssn'];
+  message.data = JSON.stringify(data);
+  return message;
+}
+EOF
+    },
+    {
+      function_name = "otherFunc",
+      code = <<EOF
+function otherFunc(message, metadata) {
+  return null;
+}
+EOF
+    },
+    {
+      function_name = "someSMTWeDisabled",
+      code = "..."
+      disabled = true
+    }
+  ]
+}
+
+resource "google_pubsub_topic" "example" {
+  name = "example-topic-${local.name_suffix}"
+
+  dynamic "message_transforms" {
+    for_each = local.smts
+
+    content {
+      disabled = lookup(message_transforms.value, "disabled", null)
+      javascript_udf {
+        function_name = message_transforms.value.function_name
+        code = message_transforms.value.code
+      }
+    }
+  }
+}
diff --git a/pubsub_topic_multiple_smts/motd b/pubsub_topic_multiple_smts/motd
new file mode 100644
index 00000000..45a906e8
--- /dev/null
+++ b/pubsub_topic_multiple_smts/motd
@@ -0,0 +1,7 @@
+===
+
+These examples use real resources that will be billed to the
+Google Cloud Platform project you use - so make sure that you
+run "terraform destroy" before quitting!
+
+===
diff --git a/pubsub_topic_multiple_smts/tutorial.md b/pubsub_topic_multiple_smts/tutorial.md
new file mode 100644
index 00000000..8d3527e9
--- /dev/null
+++ b/pubsub_topic_multiple_smts/tutorial.md
@@ -0,0 +1,79 @@
+# Pubsub Topic Multiple Smts - Terraform
+
+## Setup
+
+<walkthrough-author name="rileykarson@google.com" analyticsId="UA-125550242-1" tutorialName="pubsub_topic_multiple_smts" repositoryUrl="https://github.com/terraform-google-modules/docs-examples"></walkthrough-author>
+
+Welcome to Terraform in Google Cloud Shell! We need you to let us know what project you'd like to use with Terraform.
+
+<walkthrough-project-billing-setup></walkthrough-project-billing-setup>
+
+Terraform provisions real GCP resources, so anything you create in this session will be billed against this project.
+
+## Terraforming!
+
+Let's use {{project-id}} with Terraform! Click the Cloud Shell icon below to copy the command
+to your shell, and then run it from the shell by pressing Enter/Return. Terraform will pick up
+the project name from the environment variable.
+
+```bash
+export GOOGLE_CLOUD_PROJECT={{project-id}}
+```
+
+After that, let's get Terraform started. Run the following to pull in the providers.
+
+```bash
+terraform init
+```
+
+With the providers downloaded and a project set, you're ready to use Terraform. Go ahead!
+
+```bash
+terraform apply
+```
+
+Terraform will show you what it plans to do, and prompt you to accept. Type "yes" to accept the plan.
+
+```bash
+yes
+```
+
+
+## Post-Apply
+
+### Editing your config
+
+Now you've provisioned your resources in GCP! If you run a "plan", you should see no changes needed.
+
+```bash
+terraform plan
+```
+
+So let's make a change! Try editing a number, or appending a value to the name in the editor. Then,
+run a 'plan' again.
+
+```bash
+terraform plan
+```
+
+Afterwards you can run an apply, which implicitly does a plan and shows you the intended changes
+at the 'yes' prompt.
+
+```bash
+terraform apply
+```
+
+```bash
+yes
+```
+
+## Cleanup
+
+Run the following to remove the resources Terraform provisioned:
+
+```bash
+terraform destroy
+```
+```bash
+yes
+```
diff --git a/pubsub_topic_single_smt/backing_file.tf b/pubsub_topic_single_smt/backing_file.tf
new file mode 100644
index 00000000..c60b1199
--- /dev/null
+++ b/pubsub_topic_single_smt/backing_file.tf
@@ -0,0 +1,15 @@
+# This file has some scaffolding to make sure that names are unique and that
+# a region and zone are selected when you try to create your Terraform resources.
+
+locals {
+  name_suffix = "${random_pet.suffix.id}"
+}
+
+resource "random_pet" "suffix" {
+  length = 2
+}
+
+provider "google" {
+  region = "us-central1"
+  zone   = "us-central1-c"
+}
diff --git a/pubsub_topic_single_smt/main.tf b/pubsub_topic_single_smt/main.tf
new file mode 100644
index 00000000..c78ae37f
--- /dev/null
+++ b/pubsub_topic_single_smt/main.tf
@@ -0,0 +1,15 @@
+resource "google_pubsub_topic" "example" {
+  name = "example-topic-${local.name_suffix}"
+
+  message_transforms {
+    javascript_udf {
+      function_name = "isYearEven"
+      code = <<EOF
+function isYearEven(message, metadata) {
+  const data = JSON.parse(message.data);
+  return message.year %2 === 0;
+}
+EOF
+    }
+  }
+}
diff --git a/pubsub_topic_single_smt/motd b/pubsub_topic_single_smt/motd
new file mode 100644
index 00000000..45a906e8
--- /dev/null
+++ b/pubsub_topic_single_smt/motd
@@ -0,0 +1,7 @@
+===
+
+These examples use real resources that will be billed to the
+Google Cloud Platform project you use - so make sure that you
+run "terraform destroy" before quitting!
+
+===
diff --git a/pubsub_topic_single_smt/tutorial.md b/pubsub_topic_single_smt/tutorial.md
new file mode 100644
index 00000000..4f5b8b85
--- /dev/null
+++ b/pubsub_topic_single_smt/tutorial.md
@@ -0,0 +1,79 @@
+# Pubsub Topic Single Smt - Terraform
+
+## Setup
+
+<walkthrough-author name="rileykarson@google.com" analyticsId="UA-125550242-1" tutorialName="pubsub_topic_single_smt" repositoryUrl="https://github.com/terraform-google-modules/docs-examples"></walkthrough-author>
+
+Welcome to Terraform in Google Cloud Shell! We need you to let us know what project you'd like to use with Terraform.
+
+<walkthrough-project-billing-setup></walkthrough-project-billing-setup>
+
+Terraform provisions real GCP resources, so anything you create in this session will be billed against this project.
+
+## Terraforming!
+
+Let's use {{project-id}} with Terraform! Click the Cloud Shell icon below to copy the command
+to your shell, and then run it from the shell by pressing Enter/Return. Terraform will pick up
+the project name from the environment variable.
+
+```bash
+export GOOGLE_CLOUD_PROJECT={{project-id}}
+```
+
+After that, let's get Terraform started. Run the following to pull in the providers.
+
+```bash
+terraform init
+```
+
+With the providers downloaded and a project set, you're ready to use Terraform. Go ahead!
+
+```bash
+terraform apply
+```
+
+Terraform will show you what it plans to do, and prompt you to accept. Type "yes" to accept the plan.
+
+```bash
+yes
+```
+
+
+## Post-Apply
+
+### Editing your config
+
+Now you've provisioned your resources in GCP! If you run a "plan", you should see no changes needed.
+
+```bash
+terraform plan
+```
+
+So let's make a change! Try editing a number, or appending a value to the name in the editor. Then,
+run a 'plan' again.
+
+```bash
+terraform plan
+```
+
+Afterwards you can run an apply, which implicitly does a plan and shows you the intended changes
+at the 'yes' prompt.
+
+```bash
+terraform apply
+```
+
+```bash
+yes
+```
+
+## Cleanup
+
+Run the following to remove the resources Terraform provisioned:
+
+```bash
+terraform destroy
+```
+```bash
+yes
+```