feat: Adding Submodule for Standalone Workflow for ADC (#54)

Co-authored-by: Bharath KKB <bharathkrishnakb@gmail.com>

Author: anshukaira

Makefile

@@ -18,7 +18,7 @@
 # Make will use bash instead of sh
 SHELL := /usr/bin/env bash
 
-DOCKER_TAG_VERSION_DEVELOPER_TOOLS := 1
+DOCKER_TAG_VERSION_DEVELOPER_TOOLS := 1.25
 DOCKER_IMAGE_DEVELOPER_TOOLS := cft/developer-tools
 REGISTRY_URL := gcr.io/cloud-foundation-cicd
 
@@ -62,7 +62,7 @@ docker_test_integration:
 		-e SERVICE_ACCOUNT_JSON \
 		-v "$(CURDIR)":/workspace \
 		$(REGISTRY_URL)/${DOCKER_IMAGE_DEVELOPER_TOOLS}:${DOCKER_TAG_VERSION_DEVELOPER_TOOLS} \
-		/usr/local/bin/test_integration.sh
+		cft test run all
 
 # Execute lint tests within the docker container
 .PHONY: docker_test_lint
@@ -77,9 +77,10 @@ docker_test_lint:
 .PHONY: docker_generate_docs
 docker_generate_docs:
 	docker run --rm -it \
+		-e ENABLE_BPMETADATA=1 \
 		-v "$(CURDIR)":/workspace \
 		$(REGISTRY_URL)/${DOCKER_IMAGE_DEVELOPER_TOOLS}:${DOCKER_TAG_VERSION_DEVELOPER_TOOLS} \
-		/bin/bash -c 'source /usr/local/bin/task_helper_functions.sh && generate_docs'
+		/bin/bash -c 'source /usr/local/bin/task_helper_functions.sh && generate_docs display --per-module-requirements'
 
 # Alias for backwards compatibility
 .PHONY: generate_docs

README.md

@@ -32,15 +32,15 @@ module "cloud_workflow" {
   - getCurrentTime:
       call: http.get
       args:
-          url: https://us-central1-workflowsample.cloudfunctions.net/datetime
+          url: https://timeapi.io/api/Time/current/zone?timeZone=Europe/Amsterdam
       result: CurrentDateTime
   - readWikipedia:
       call: http.get
       args:
           url: https://en.wikipedia.org/w/api.php
           query:
               action: opensearch
-              search: $${CurrentDateTime.body.dayOfTheWeek}
+              search: $${CurrentDateTime.body.dayOfWeek}
       result: WikiResult
   - returnOutput:
       return: $${WikiResult.body[1]}
@@ -72,15 +72,15 @@ module "cloud_workflow" {
   - getCurrentTime:
       call: http.get
       args:
-          url: https://us-central1-workflowsample.cloudfunctions.net/datetime
+          url: https://timeapi.io/api/Time/current/zone?timeZone=Europe/Amsterdam
       result: CurrentDateTime
   - readWikipedia:
       call: http.get
       args:
           url: https://en.wikipedia.org/w/api.php
           query:
               action: opensearch
-              search: $${CurrentDateTime.body.dayOfTheWeek}
+              search: $${CurrentDateTime.body.dayOfWeek}
       result: WikiResult
   - returnOutput:
       return: $${WikiResult.body[1]}

build/int.cloudbuild.yaml

@@ -30,12 +30,18 @@ steps:
 - id: simple-example-apply
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
   args: ['/bin/bash', '-c', 'cft test run all --stage apply --verbose']
+  waitFor:
+    - simple-example-init
 - id: simple-example-verify
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
   args: ['/bin/bash', '-c', 'cft test run all --stage verify --verbose']
+  waitFor:
+    - simple-example-apply
 - id: simple-example-teardown
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
   args: ['/bin/bash', '-c', 'cft test run all --stage teardown --verbose']
+  waitFor:
+    - simple-example-verify
 tags:
 - 'ci'
 - 'integration'

examples/gcs_event_arc_trigger_workflow/main.tf

@@ -55,7 +55,7 @@ resource "google_project_iam_binding" "project" {
 }
 
 resource "random_string" "string" {
-  length  = 8
+  length  = 4
   lower   = true
   upper   = false
   special = false
@@ -66,9 +66,10 @@ module "service_account" {
   source     = "terraform-google-modules/service-accounts/google"
   version    = "~> 4.1.1"
   project_id = var.project_id
-  prefix     = "gcs-eventarc-workflow"
+  prefix     = "eventarc-wf-${random_string.string.result}"
   names      = ["simple"]
   project_roles = ["${var.project_id}=>roles/workflows.invoker",
+    "${var.project_id}=>roles/eventarc.serviceAgent",
   "${var.project_id}=>roles/eventarc.eventReceiver"]
 }
 

examples/pubsub_event_arc_trigger_workflow/main.tf

@@ -22,11 +22,19 @@ resource "google_pubsub_topic" "event_arc" {
   project = var.project_id
 }
 
+resource "random_string" "string" {
+  length  = 4
+  lower   = true
+  upper   = false
+  special = false
+  numeric = false
+}
+
 module "service_account" {
   source        = "terraform-google-modules/service-accounts/google"
   version       = "~> 4.1.1"
   project_id    = var.project_id
-  prefix        = "eventarc-workflow"
+  prefix        = "eventarc-wf-${random_string.string.result}"
   names         = ["simple"]
   project_roles = ["${var.project_id}=>roles/workflows.invoker"]
 }

examples/schedule_workflow/main.tf

@@ -57,15 +57,15 @@ module "cloud_workflow" {
   - getCurrentTime:
       call: http.get
       args:
-          url: https://us-central1-workflowsample.cloudfunctions.net/datetime
+          url: https://timeapi.io/api/Time/current/zone?timeZone=Europe/Amsterdam
       result: CurrentDateTime
   - readWikipedia:
       call: http.get
       args:
           url: https://en.wikipedia.org/w/api.php
           query:
               action: opensearch
-              search: $${CurrentDateTime.body.dayOfTheWeek}
+              search: $${CurrentDateTime.body.dayOfWeek}
       result: WikiResult
   - returnOutput:
       return: $${WikiResult.body[1]}

examples/schedule_workflow_autocreate_sa/main.tf

@@ -48,15 +48,15 @@ module "cloud_workflow" {
   - getCurrentTime:
       call: http.get
       args:
-          url: https://us-central1-workflowsample.cloudfunctions.net/datetime
+          url: https://timeapi.io/api/Time/current/zone?timeZone=Europe/Amsterdam
       result: CurrentDateTime
   - readWikipedia:
       call: http.get
       args:
           url: https://en.wikipedia.org/w/api.php
           query:
               action: opensearch
-              search: $${CurrentDateTime.body.dayOfTheWeek}
+              search: $${CurrentDateTime.body.dayOfWeek}
       result: WikiResult
   - returnOutput:
       return: $${WikiResult.body[1]}

examples/simple_workflow/README.md

@@ -0,0 +1,15 @@
+<!-- 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 |
+|------|-------------|
+| revision\_id | The revision\_id  of the workflow. |
+| workflow\_id | The id  of the workflow. |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

examples/simple_workflow/main.tf

@@ -0,0 +1,50 @@
+/**
+ * Copyright 2025 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 "service_account" {
+  source        = "terraform-google-modules/service-accounts/google"
+  version       = "~> 4.1.1"
+  project_id    = var.project_id
+  prefix        = "simple-workflow"
+  names         = ["simple"]
+  project_roles = ["${var.project_id}=>roles/workflows.invoker"]
+}
+
+module "standalone_workflow" {
+  source  = "../../modules/simple_workflow"
+
+  project_id            = var.project_id
+  workflow_name         = "standalone-workflow"
+  location              = "us-central1"
+  service_account_email = module.service_account.email
+  workflow_source       = <<-EOF
+  # This is a sample workflow that simply reads wikipedia
+  # Note that $$ is needed for Terraform
+
+  main:
+      steps:
+      - readWikipedia:
+          call: http.get
+          args:
+              url: https://en.wikipedia.org/w/api.php
+              query:
+                  action: opensearch
+                  search: GoogleCloudPlatform
+          result: wikiResult
+      - returnOutput:
+              return: $${wikiResult.body[1]}
+EOF
+}

examples/simple_workflow/outputs.tf

@@ -0,0 +1,25 @@
+/**
+ * Copyright 2025 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 "workflow_id" {
+  description = "The id  of the workflow."
+  value       = module.standalone_workflow.workflow_id
+}
+
+output "revision_id" {
+  description = "The revision_id  of the workflow."
+  value       = module.standalone_workflow.revision_id
+}