Adding Eventarc-Workflows example for cgc docs #6279

minyu19 · 2022-07-15T18:50:50Z

Adding Eventarc-Workflows example for cgc docs that uses Terraform to invoke a workflow using Eventarc.

modular-magician · 2022-07-15T18:51:48Z

Hello! I am a robot who works on Magic Modules PRs.

I've detected that you're a community contributor. @megan07, a repository maintainer, has been assigned to assist you and help review your changes.

❓ First time contributing? Click here for more details

Your assigned reviewer will help review your code by:

Ensuring it's backwards compatible, covers common error cases, etc.
Summarizing the change into a user-facing changelog note.
Passes tests, either our "VCR" suite, a set of presubmit tests, or with manual test runs.

You can help make sure that review is quick by running local tests and ensuring they're passing in between each push you make to your PR's branch. Also, try to leave a comment with each push you make, as pushes generally don't generate emails.

If your reviewer doesn't get back to you within a week after your most recent change, please feel free to leave a comment on the issue asking them to take a look! In the absence of a dedicated review dashboard most maintainers manage their pending reviews through email, and those will sometimes get lost in their inbox.

modular-magician · 2022-07-15T19:03:28Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform Beta: Diff ( 1 file changed, 355 insertions(+), 228 deletions(-))
TF Cloud Doc Samples: Diff ( 1 file changed, 107 insertions(+))

modular-magician · 2022-07-15T19:04:33Z

Tests analytics

Total tests: 0
Passed tests 0
Skipped tests: 0
Failed tests: 0

Errors occurred during REPLAYING mode. Please fix them to complete your PR
View the build log

megan07 · 2022-07-19T16:47:30Z

/gcbrun

megan07 · 2022-07-19T16:50:21Z

mmv1/products/cgc/terraform.yaml

+    # Eventarc
+    ### Eventarc Workflows quickstart
+      - !ruby/object:Provider::Terraform::Examples
+        name: "eventarc-workflows"


Suggested change

name: "eventarc-workflows"

name: "eventarc_workflows"

We will want to use an underscore instead of the dash here, and we'll need to update the associated filename as well. Thanks!

modular-magician · 2022-07-19T17:00:44Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform Beta: Diff ( 1 file changed, 355 insertions(+), 228 deletions(-))
TF Cloud Doc Samples: Diff ( 1 file changed, 107 insertions(+))

modular-magician · 2022-07-19T17:01:52Z

Tests analytics

Total tests: 0
Passed tests 0
Skipped tests: 0
Failed tests: 0

Errors occurred during REPLAYING mode. Please fix them to complete your PR
View the build log

modular-magician · 2022-07-19T19:01:35Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform Beta: Diff ( 1 file changed, 127 insertions(+))
TF Cloud Doc Samples: Diff ( 1 file changed, 107 insertions(+))

modular-magician · 2022-07-19T19:37:48Z

Tests analytics

Total tests: 2112
Passed tests 1881
Skipped tests: 226
Failed tests: 5

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests

TestAccPrivatecaCertificateAuthority_subordinateCaActivatedByFirstPartyIssuerOnCreation|TestAccPrivatecaCertificateAuthority_privatecaCertificateAuthoritySubordinateExample|TestAccFirebaserulesRelease_BasicRelease|TestAccComputeInstance_soleTenantNodeAffinities|TestAccCGCSnippet_eventarcWorkflowsExample

modular-magician · 2022-07-19T19:39:00Z

Tests passed during RECORDING mode:
TestAccFirebaserulesRelease_BasicRelease[view]

Tests failed during RECORDING mode:
TestAccCGCSnippet_eventarcWorkflowsExample[view]
TestAccPrivatecaCertificateAuthority_privatecaCertificateAuthoritySubordinateExample[view]
TestAccPrivatecaCertificateAuthority_subordinateCaActivatedByFirstPartyIssuerOnCreation[view]
TestAccComputeInstance_soleTenantNodeAffinities[view]

Please fix these to complete your PR
View the build log or the debug log for each test

megan07

Looks good so far, just a couple change requests. Thanks!

megan07 · 2022-07-19T20:35:09Z

mmv1/templates/terraform/examples/eventarc_workflows.tf.erb

+  project = data.google_project.project.id
+  role    = "roles/logging.logWriter"
+
+members = [


nit: would you mind lining up all these members lists to line up with the other attributes and remove the extra whitespace? thanks!

Done, thank you, Megan!

megan07 · 2022-07-19T20:35:30Z

mmv1/templates/terraform/examples/eventarc_workflows.tf.erb

+  description     = "A sample workflow"
+  service_account = google_service_account.eventarc_workflows_service_account.id
+  # Imported main workflow YAML file
+  source_contents = templatefile("${path.module}/workflow.yaml",{})


This file will need to exist in order for the test to pass. Would you be able to add the contents in like this?

I have added the contents as a workflow.yaml file into the same directory since it has been referenced as a yaml file within the eventarc_workflows.tf.erb file. Could you please let me know if I did that right? Thanks!

this is fine, I think you'll need to move the workflow.yaml file to third_party/terraform/utils/test-fixtures/workflow.yaml for it to work and then update the path here to be test-fixtures/workflow.yaml

Suggested change

source_contents = templatefile("${path.module}/workflow.yaml",{})

source_contents = templatefile("test-fixtures/workflow.yaml",{})

Updated, thank you! Please do let me know if this looks good.

megan07 · 2022-07-19T20:36:23Z

mmv1/templates/terraform/examples/eventarc-workflows.tf.erb

@@ -0,0 +1,108 @@
+# [START eventarc_terraform_enableapis]


this file can be removed in place of the new eventarc_workflows.tf.erb file

Done, thank you Megan.

megan07 · 2022-07-19T20:36:43Z

mmv1/products/cgc/terraform.yaml

+          pubsub_workflow_tf: "pubsub-workflow-tf"
+          trigger_pubsub_workflow_tf: "trigger-pubsub-workflow-tf"
+        min_version: beta
+        # ignore_read_extra:


nit: these commented out lines can be removed i believe

Done, thank you!

…entarc_workflows.tf.erb file

modular-magician · 2022-07-19T21:53:21Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform Beta: Diff ( 1 file changed, 121 insertions(+))
TF Cloud Doc Samples: Diff ( 1 file changed, 101 insertions(+))

modular-magician · 2022-07-19T22:28:44Z

Tests analytics

Total tests: 2112
Passed tests 1880
Skipped tests: 226
Failed tests: 6

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests

TestAccPrivatecaCertificateAuthority_subordinateCaActivatedByFirstPartyIssuerOnCreation|TestAccPrivatecaCertificateAuthority_privatecaCertificateAuthoritySubordinateExample|TestAccFirebaserulesRelease_BasicRelease|TestAccComputeInstance_soleTenantNodeAffinities|TestAccCGCSnippet_eventarcWorkflowsExample|TestAccSqlUser_mysqlDisabled

modular-magician · 2022-07-19T22:43:07Z

Tests passed during RECORDING mode:
TestAccSqlUser_mysqlDisabled[view]
TestAccFirebaserulesRelease_BasicRelease[view]

Tests failed during RECORDING mode:
TestAccCGCSnippet_eventarcWorkflowsExample[view]
TestAccPrivatecaCertificateAuthority_subordinateCaActivatedByFirstPartyIssuerOnCreation[view]
TestAccPrivatecaCertificateAuthority_privatecaCertificateAuthoritySubordinateExample[view]
TestAccComputeInstance_soleTenantNodeAffinities[view]

Please fix these to complete your PR
View the build log or the debug log for each test

…flow.yaml

modular-magician · 2022-07-22T19:05:45Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 1 file changed, 17 insertions(+))
Terraform Beta: Diff ( 2 files changed, 138 insertions(+))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))
TF Cloud Doc Samples: Diff ( 1 file changed, 101 insertions(+))

modular-magician · 2022-07-22T19:52:45Z

Tests analytics

Total tests: 2115
Passed tests 1884
Skipped tests: 226
Failed tests: 5

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests

TestAccPrivatecaCertificateAuthority_subordinateCaActivatedByFirstPartyIssuerOnCreation|TestAccComputeInstance_soleTenantNodeAffinities|TestAccCGCSnippet_eventarcWorkflowsExample|TestAccPrivatecaCertificateAuthority_privatecaCertificateAuthoritySubordinateExample|TestAccFirebaserulesRelease_BasicRelease

modular-magician · 2022-07-22T19:59:13Z

Tests passed during RECORDING mode:
TestAccPrivatecaCertificateAuthority_privatecaCertificateAuthoritySubordinateExample[view]
TestAccFirebaserulesRelease_BasicRelease[view]

Tests failed during RECORDING mode:
TestAccCGCSnippet_eventarcWorkflowsExample[view]
TestAccPrivatecaCertificateAuthority_subordinateCaActivatedByFirstPartyIssuerOnCreation[view]
TestAccComputeInstance_soleTenantNodeAffinities[view]

Please fix these to complete your PR
View the build log or the debug log for each test

megan07 · 2022-07-23T01:15:21Z

mmv1/templates/terraform/examples/eventarc_workflows.tf.erb

+  description     = "A sample workflow"
+  service_account = google_service_account.eventarc_workflows_service_account.id
+  # Imported main workflow YAML file
+  source_contents = templatefile("$text-fixtures/workflow.yaml",{})


Suggested change

source_contents = templatefile("$text-fixtures/workflow.yaml",{})

source_contents = templatefile("test-fixtures/workflow.yaml",{})

we can just use the hard-coded path where it will live :)

modular-magician · 2022-07-26T14:35:14Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 1 file changed, 17 insertions(+))
Terraform Beta: Diff ( 2 files changed, 138 insertions(+))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))
TF Cloud Doc Samples: Diff ( 1 file changed, 101 insertions(+))

megan07 · 2022-07-26T14:42:04Z

mmv1/templates/terraform/examples/eventarc_workflows.tf.erb

+  description     = "A sample workflow"
+  service_account = google_service_account.eventarc_workflows_service_account.id
+  # Imported main workflow YAML file
+  source_contents = templatefile("text-fixtures/workflow.yaml",{})


Suggested change

source_contents = templatefile("text-fixtures/workflow.yaml",{})

source_contents = templatefile("test-fixtures/workflow.yaml",{})

sorry for the misunderstanding, I think you'll want test here, not text :)

Oh gosh! I'm so sorry, I have corrected it now.

no worries :) thanks!

modular-magician · 2022-07-26T14:59:37Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 1 file changed, 17 insertions(+))
Terraform Beta: Diff ( 2 files changed, 138 insertions(+))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))
TF Cloud Doc Samples: Diff ( 1 file changed, 101 insertions(+))

modular-magician · 2022-07-26T15:43:09Z

Tests analytics

Total tests: 2120
Passed tests 1889
Skipped tests: 226
Failed tests: 5

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests

TestAccComputeInstance_soleTenantNodeAffinities|TestAccCGCSnippet_eventarcWorkflowsExample|TestAccPrivatecaCertificateAuthority_subordinateCaActivatedByFirstPartyIssuerOnCreation|TestAccPrivatecaCertificateAuthority_privatecaCertificateAuthoritySubordinateExample|TestAccSqlUser_mysqlDisabled

modular-magician · 2022-07-26T16:02:43Z

Tests passed during RECORDING mode:
TestAccCGCSnippet_eventarcWorkflowsExample[view]
TestAccSqlUser_mysqlDisabled[view]

Tests failed during RECORDING mode:
TestAccPrivatecaCertificateAuthority_subordinateCaActivatedByFirstPartyIssuerOnCreation[view]
TestAccPrivatecaCertificateAuthority_privatecaCertificateAuthoritySubordinateExample[view]
TestAccComputeInstance_soleTenantNodeAffinities[view]

Please fix these to complete your PR
View the build log or the debug log for each test

megan07

LGTM, thanks!!

Adding Eventarc-Workflows example for cgc docs

73a19d6

modular-magician requested a review from megan07 July 15, 2022 18:51

megan07 reviewed Jul 19, 2022

View reviewed changes

Modified eventarc-workflows to eventarc_workflows

6da5562

modular-magician requested a review from megan07 July 19, 2022 18:50

megan07 suggested changes Jul 19, 2022

View reviewed changes

minyu19 added 2 commits July 19, 2022 16:49

Merge remote-tracking branch 'upstream/main' into 228321734

d6f682b

Addressed the comments; Added a new file to be referenced from the ev…

cf7aedd

…entarc_workflows.tf.erb file

modular-magician requested a review from megan07 July 19, 2022 21:41

Moved workflow.yaml to third_party/terraform/utils/test-fixtures/work…

2908a53

…flow.yaml

megan07 reviewed Jul 23, 2022

View reviewed changes

Added the hard-coded path

b452d0c

modular-magician requested a review from megan07 July 26, 2022 14:23

megan07 reviewed Jul 26, 2022

View reviewed changes

Updated eventarc_workflows.tf.erb

b944440

modular-magician requested a review from megan07 July 26, 2022 14:50

megan07 approved these changes Jul 26, 2022

View reviewed changes

megan07 merged commit 8f81680 into GoogleCloudPlatform:main Jul 26, 2022

	source_contents = templatefile("${path.module}/workflow.yaml",{})
	source_contents = templatefile("test-fixtures/workflow.yaml",{})

	source_contents = templatefile("$text-fixtures/workflow.yaml",{})
	source_contents = templatefile("test-fixtures/workflow.yaml",{})

	source_contents = templatefile("text-fixtures/workflow.yaml",{})
	source_contents = templatefile("test-fixtures/workflow.yaml",{})

Adding Eventarc-Workflows example for cgc docs #6279

Adding Eventarc-Workflows example for cgc docs #6279

Conversation

minyu19 commented Jul 15, 2022

modular-magician commented Jul 15, 2022

modular-magician commented Jul 15, 2022

Diff report:

modular-magician commented Jul 15, 2022

Tests analytics

megan07 commented Jul 19, 2022

Choose a reason for hiding this comment

modular-magician commented Jul 19, 2022

Diff report:

modular-magician commented Jul 19, 2022

Tests analytics

modular-magician commented Jul 19, 2022

Diff report:

modular-magician commented Jul 19, 2022

Tests analytics

Action taken

modular-magician commented Jul 19, 2022

megan07 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

modular-magician commented Jul 19, 2022

Diff report:

modular-magician commented Jul 19, 2022

Tests analytics

Action taken

modular-magician commented Jul 19, 2022

modular-magician commented Jul 22, 2022

Diff report:

modular-magician commented Jul 22, 2022

Tests analytics

Action taken

modular-magician commented Jul 22, 2022

Choose a reason for hiding this comment

modular-magician commented Jul 26, 2022

Diff report:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

modular-magician commented Jul 26, 2022

Diff report:

modular-magician commented Jul 26, 2022

Tests analytics

Action taken

modular-magician commented Jul 26, 2022

megan07 left a comment

Choose a reason for hiding this comment