Add deadLetterPolicy to Pub/Sub Subscription resource #3305

shaxbee · 2020-03-25T22:07:46Z

Support dead_letter_policy as specified in https://pubsub.googleapis.com/$discovery/rest?version=v1

I've tested changes by applying dead_letter_policy with locally build terraform provider following instructions in README.

Release Note Template for Downstream PRs (will be copied)

pubsub: Added `dead_letter_policy` support to `google_pubsub_subscription`

Fixes hashicorp/terraform-provider-google#5522

modular-magician · 2020-03-25T22:09:27Z

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

I have detected that you are a community contributor, so your PR will be assigned to someone with a commit-bit on this repo for initial review.

Thanks for your contribution! A human will be with you soon.

@slevenick, please review this PR or find an appropriate assignee.

modular-magician · 2020-03-25T22:12:52Z

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

Diff report:

Terraform GA: Diff ( 2 files changed, 170 insertions(+))
Terraform Beta: Diff ( 2 files changed, 170 insertions(+))
Ansible: Diff ( 2 files changed, 130 insertions(+))
TF Conversion: Diff ( 1 file changed, 45 insertions(+))
Inspec: Diff ( 5 files changed, 49 insertions(+))

modular-magician · 2020-03-25T22:12:57Z

Oops! It looks like no changelog entry is attached to this PR. Please include a release note block in the PR body, as described in https://github.com/GoogleCloudPlatform/magic-modules/blob/master/.ci/RELEASE_NOTES_GUIDE.md:

```release-note:TYPE
Release note
```

modular-magician · 2020-03-26T14:39:54Z

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

Diff report:

Terraform GA: Diff ( 2 files changed, 170 insertions(+))
Terraform Beta: Diff ( 2 files changed, 170 insertions(+))
Ansible: Diff ( 2 files changed, 130 insertions(+))
TF Conversion: Diff ( 1 file changed, 45 insertions(+))
Inspec: Diff ( 5 files changed, 49 insertions(+))

modular-magician · 2020-03-26T14:40:00Z

Oops! It looks like you're using an unknown release-note type in your changelog entries:

enhancment

Please only use the types listed in https://github.com/GoogleCloudPlatform/magic-modules/blob/master/.ci/RELEASE_NOTES_GUIDE.md.

modular-magician · 2020-03-26T15:31:17Z

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

Diff report:

Terraform GA: Diff ( 2 files changed, 170 insertions(+))
Terraform Beta: Diff ( 2 files changed, 170 insertions(+))
Ansible: Diff ( 2 files changed, 130 insertions(+))
TF Conversion: Diff ( 1 file changed, 45 insertions(+))
Inspec: Diff ( 5 files changed, 49 insertions(+))

slevenick · 2020-03-26T21:36:38Z

products/pubsub/api.yaml

@@ -244,3 +244,44 @@ objects:
              If ttl is not set, the associated resource never expires.
              A duration in seconds with up to nine fractional digits, terminated by 's'.
              Example - "3.5s".
+      - !ruby/object:Api::Type::NestedObject
+        name: 'deadLetterPolicy'
+        allow_empty_object: true


We probably don't want allow_empty_object here. It will allow us to specify dead_letter_policy {} in a config, which is invalid for this.

slevenick

Thanks for the addition!

Can I have you add an integration test based on dead letter policies? It can be added as a file that is referenced in the products/pubsub/terraform.yaml examples block for the pubsub subscription.

slevenick · 2020-03-26T21:37:18Z

products/pubsub/api.yaml

+          is disabled.
+
+          The Cloud Pub/Sub service account associated with this subscriptions's
+          parent project (i.e.,\nservice-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have


Extra \n in here

Fixed. Example added as well.

modular-magician · 2020-03-27T15:56:29Z

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

Diff report:

Terraform GA: Diff ( 3 files changed, 245 insertions(+))
Terraform Beta: Diff ( 3 files changed, 245 insertions(+))
Ansible: Diff ( 2 files changed, 130 insertions(+))
TF Conversion: Diff ( 1 file changed, 40 insertions(+))
TF OiCS: Diff ( 4 files changed, 118 insertions(+))
Inspec: Diff ( 5 files changed, 49 insertions(+))

shaxbee · 2020-03-27T17:59:05Z

@slevenick I have problem troubleshooting integration test failure:

make testacc TEST=./google TESTARGS='-run=TestAccPubsubSubscription_pubsubSubscriptionDeadLetterExample'
==> Checking source code against gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 TF_SCHEMA_PANIC_ON_ERROR=1 go test ./google -v -run=TestAccPubsubSubscription_pubsubSubscriptionDeadLetterExample -timeout 240m -ldflags="-X=github.com/terraform-providers/terraform-provider-google/version.ProviderVersion=acc"
=== RUN   TestAccPubsubSubscription_pubsubSubscriptionDeadLetterExample
=== PAUSE TestAccPubsubSubscription_pubsubSubscriptionDeadLetterExample
=== CONT  TestAccPubsubSubscription_pubsubSubscriptionDeadLetterExample
    TestAccPubsubSubscription_pubsubSubscriptionDeadLetterExample: testing.go:635: Step 0 error: Missing newline after argument: On /var/folders/cj/3yndnndj3hz6jps13xvwzr740000gn/T/tf-test748198000/main.tf line 16: An argument definition must end with a newline.
--- FAIL: TestAccPubsubSubscription_pubsubSubscriptionDeadLetterExample (0.00s)
FAIL
FAIL    github.com/terraform-providers/terraform-provider-google/google 0.666sFAIL
make: *** [testacc] Error 1

I'm using Terraform 0.12.
It seems that something is wrong with generated file but it gets deleted therefore I cannot check it.

slevenick · 2020-03-27T18:05:12Z

templates/terraform/examples/pubsub_subscription_dead_letter.tf.erb

+
+  expiration_policy {
+    dead_letter_topic = google_pubsub_topic.<%= ctx[:primary_resource_id] %>_dead_letter.id
+    max_delivery_attempts = <%= ctx[:vars]['max_delivery_attempts'] %>


The issue is that this is getting a random suffix added on during generation. Instead of using ctx here, just put the number 10 directly in this config

slevenick · 2020-03-27T19:30:44Z

@slevenick I have problem troubleshooting integration test failure:

make testacc TEST=./google TESTARGS='-run=TestAccPubsubSubscription_pubsubSubscriptionDeadLetterExample'
==> Checking source code against gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 TF_SCHEMA_PANIC_ON_ERROR=1 go test ./google -v -run=TestAccPubsubSubscription_pubsubSubscriptionDeadLetterExample -timeout 240m -ldflags="-X=github.com/terraform-providers/terraform-provider-google/version.ProviderVersion=acc"
=== RUN   TestAccPubsubSubscription_pubsubSubscriptionDeadLetterExample
=== PAUSE TestAccPubsubSubscription_pubsubSubscriptionDeadLetterExample
=== CONT  TestAccPubsubSubscription_pubsubSubscriptionDeadLetterExample
    TestAccPubsubSubscription_pubsubSubscriptionDeadLetterExample: testing.go:635: Step 0 error: Missing newline after argument: On /var/folders/cj/3yndnndj3hz6jps13xvwzr740000gn/T/tf-test748198000/main.tf line 16: An argument definition must end with a newline.
--- FAIL: TestAccPubsubSubscription_pubsubSubscriptionDeadLetterExample (0.00s)
FAIL
FAIL    github.com/terraform-providers/terraform-provider-google/google 0.666sFAIL
make: *** [testacc] Error 1

I'm using Terraform 0.12.
It seems that something is wrong with generated file but it gets deleted therefore I cannot check it.

You can see the issue in the downstream generated commit: https://github.com/modular-magician/terraform-provider-google-beta/compare/auto-pr-3305-old..auto-pr-3305#diff-465638d1b1e0cb367d7c78b83d054b32R118

shaxbee · 2020-03-27T22:27:29Z

@slevenick Thanks for help, I was able to fix it and integration tests are running successfully now.

modular-magician · 2020-03-27T22:29:30Z

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

Diff report:

Terraform GA: Diff ( 3 files changed, 245 insertions(+))
Terraform Beta: Diff ( 3 files changed, 245 insertions(+))
Ansible: Diff ( 2 files changed, 130 insertions(+))
TF Conversion: Diff ( 1 file changed, 40 insertions(+))
TF OiCS: Diff ( 4 files changed, 118 insertions(+))
Inspec: Diff ( 5 files changed, 49 insertions(+))

modular-magician · 2020-03-27T22:51:11Z

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

Diff report:

Terraform GA: Diff ( 3 files changed, 245 insertions(+))
Terraform Beta: Diff ( 3 files changed, 245 insertions(+))
Ansible: Diff ( 2 files changed, 130 insertions(+))
TF Conversion: Diff ( 1 file changed, 40 insertions(+))
TF OiCS: Diff ( 4 files changed, 118 insertions(+))
Inspec: Diff ( 5 files changed, 49 insertions(+))

slevenick

Looks good to me!

Thanks for the addition

…tform#3305) * Add deadLetterPolicy to Pub/Sub subscription resource * fix: disable allow_empty_objects, fix docstring, add example * fix: set max_delivery_attempts * fix: block and topic name

googlebot added the cla: yes label Mar 25, 2020

modular-magician added the community label Mar 25, 2020

shaxbee changed the title ~~products/pubsub/api.yaml~~ Add deadLetterPolicy to Pub/Sub Subscription resource Mar 25, 2020

shaxbee force-pushed the feat-pubsub-dlq branch from 360247a to ae9bb38 Compare March 26, 2020 14:34

Add deadLetterPolicy to Pub/Sub subscription resource

b8a95cd

shaxbee force-pushed the feat-pubsub-dlq branch from ae9bb38 to b8a95cd Compare March 26, 2020 15:26

slevenick reviewed Mar 26, 2020

View reviewed changes

slevenick requested changes Mar 26, 2020

View reviewed changes

shaxbee force-pushed the feat-pubsub-dlq branch from ee25841 to 165c604 Compare March 27, 2020 15:07

fix: disable allow_empty_objects, fix docstring, add example

3454a2b

shaxbee force-pushed the feat-pubsub-dlq branch from 165c604 to 3454a2b Compare March 27, 2020 15:51

slevenick reviewed Mar 27, 2020

View reviewed changes

fix: set max_delivery_attempts

2b56887

fix: block and topic name

e24b664

shaxbee force-pushed the feat-pubsub-dlq branch from aab89de to e24b664 Compare March 27, 2020 22:45

slevenick self-requested a review March 30, 2020 18:39

slevenick approved these changes Mar 30, 2020

View reviewed changes

slevenick merged commit 5cb9f2f into GoogleCloudPlatform:master Mar 30, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add deadLetterPolicy to Pub/Sub Subscription resource #3305

Add deadLetterPolicy to Pub/Sub Subscription resource #3305

shaxbee commented Mar 25, 2020 •

edited by slevenick

Loading

modular-magician commented Mar 25, 2020

modular-magician commented Mar 25, 2020

modular-magician commented Mar 25, 2020

modular-magician commented Mar 26, 2020

modular-magician commented Mar 26, 2020

modular-magician commented Mar 26, 2020

slevenick Mar 26, 2020

shaxbee Mar 27, 2020

slevenick left a comment

slevenick Mar 26, 2020

shaxbee Mar 27, 2020 •

edited

Loading

modular-magician commented Mar 27, 2020

shaxbee commented Mar 27, 2020 •

edited

Loading

slevenick Mar 27, 2020

shaxbee Mar 27, 2020

slevenick commented Mar 27, 2020

shaxbee commented Mar 27, 2020

modular-magician commented Mar 27, 2020

modular-magician commented Mar 27, 2020

slevenick left a comment

Add deadLetterPolicy to Pub/Sub Subscription resource #3305

Add deadLetterPolicy to Pub/Sub Subscription resource #3305

Conversation

shaxbee commented Mar 25, 2020 • edited by slevenick Loading

modular-magician commented Mar 25, 2020

modular-magician commented Mar 25, 2020

Diff report:

modular-magician commented Mar 25, 2020

modular-magician commented Mar 26, 2020

Diff report:

modular-magician commented Mar 26, 2020

modular-magician commented Mar 26, 2020

Diff report:

slevenick Mar 26, 2020

Choose a reason for hiding this comment

shaxbee Mar 27, 2020

Choose a reason for hiding this comment

slevenick left a comment

Choose a reason for hiding this comment

slevenick Mar 26, 2020

Choose a reason for hiding this comment

shaxbee Mar 27, 2020 • edited Loading

Choose a reason for hiding this comment

modular-magician commented Mar 27, 2020

Diff report:

shaxbee commented Mar 27, 2020 • edited Loading

slevenick Mar 27, 2020

Choose a reason for hiding this comment

shaxbee Mar 27, 2020

Choose a reason for hiding this comment

slevenick commented Mar 27, 2020

shaxbee commented Mar 27, 2020

modular-magician commented Mar 27, 2020

Diff report:

modular-magician commented Mar 27, 2020

Diff report:

slevenick left a comment

Choose a reason for hiding this comment

shaxbee commented Mar 25, 2020 •

edited by slevenick

Loading

shaxbee Mar 27, 2020 •

edited

Loading

shaxbee commented Mar 27, 2020 •

edited

Loading