azurerm_servicebus_subscription - support status property #7852

marc-sensenich · 2020-07-22T17:09:41Z

Allows the status to be set for an azurerm_servicebus_subscription resource

New Acceptance Tests

--- PASS: TestAccAzureRMServiceBusSubscription_status (317.34s)

Existing Acceptance Tests

--- PASS: TestAccAzureRMServiceBusSubscription_basic (195.05s)
--- PASS: TestAccAzureRMServiceBusSubscription_requiresImport (213.53s)
--- PASS: TestAccAzureRMServiceBusSubscription_updateForwardDeadLetteredMessagesTo (244.82s)
--- PASS: TestAccAzureRMServiceBusSubscription_updateForwardTo (244.98s)
--- PASS: TestAccAzureRMServiceBusSubscription_defaultTtl (245.65s)
--- PASS: TestAccAzureRMServiceBusSubscription_updateRequiresSession (253.25s)
--- PASS: TestAccAzureRMServiceBusSubscription_updateEnableBatched (286.92s)

mbfrahry

Hey @marc-sensenich, these changes look good but we can aim for a simpler one liner over the helper functions. We should be good to merge once that is taken care of!

mbfrahry · 2020-07-22T22:08:25Z

azurerm/internal/services/servicebus/resource_arm_servicebus_subscription.go

@@ -222,6 +236,7 @@ func resourceArmServiceBusSubscriptionRead(d *schema.ResourceData, meta interfac
 		d.Set("requires_session", props.RequiresSession)
 		d.Set("forward_to", props.ForwardTo)
 		d.Set("forward_dead_lettered_messages_to", props.ForwardDeadLetteredMessagesTo)
+		d.Set("status", helper.FlattenEntityStatus(props.Status))


Similar to the above comment, we should aim for simplicity here.

Suggested change

d.Set("status", helper.FlattenEntityStatus(props.Status))

d.Set("status", string(props.Status))

Changed this to a one-liner in 87b1115

mbfrahry · 2020-07-22T22:12:16Z

azurerm/internal/services/servicebus/resource_arm_servicebus_subscription.go

@@ -145,6 +158,7 @@ func resourceArmServiceBusSubscriptionCreateUpdate(d *schema.ResourceData, meta
 			EnableBatchedOperations:          &enableBatchedOps,
 			MaxDeliveryCount:                 &maxDeliveryCount,
 			RequiresSession:                  &requiresSession,
+			Status:                           helper.ExpandEntityStatus(d.Get("status")),


I appreciate all the work you put into making the helper function to get the status but we should aim for simplicity. We know that status can only be servicebus.EntityStatus because of what we allow in the ValidateFunc so we can be confident that we can get away with a single line versus the helper function + tests that you wrote

Suggested change

Status: helper.ExpandEntityStatus(d.Get("status")),

Status: servicebus.EntityStatus(d.Get("status").(string)),

Changed this to a one-liner in 87b1115

marc-sensenich · 2020-07-23T00:53:51Z

@mbfrahry thanks for the review! Removal of the helper function has been completed as of 87b1115 and I validated the acceptance tests once more

katbyte

Thanks @marc-sensenich - this LGTM 👍

ghost · 2020-07-31T15:56:12Z

This has been released in version 2.21.0 of the provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading. As an example:

provider "azurerm" {
    version = "~> 2.21.0"
}
# ... other configuration ...

## Description 🗣️ This pull requests is easier to read commit by commit `SBQueueProperties` struct contains a handful of read-write attributes, with a few of them not being exposed to the terraform schema representing it. This includes `enable_batched_operations`, `forward_to`, `forward_dead_lettered_messages_to` ( fixes #6472 ) and `status`. The spec itself is described in <https://docs.microsoft.com/en-us/azure/templates/microsoft.servicebus/2017-04-01/namespaces/queues>. This pulls requests aims to align the current terraform schema with the `2017-01-01` spec for Azure ServiceBus Queues, with the following three components : 1. Add the missing attributes 2. Reorder the attributes to match the official doc 3. Update the doc accordingly ## Motivation - [x] Fix #6472 - [x] Backport d331091 ( `enable_batched_operations` ) - [x] Backport #861 ( `forward_to` ) - [x] Backport #4789 ( `forward_dead_lettered_messages_to` ) - [x] Backport #7852 ( `status` ) ## Testing ### Initialization <details><summary>This section is merely a small doc for myself</summary> See details in <https://medium.com/@gmusumeci/getting-started-with-terraform-and-microsoft-azure-a2fcb690eb67> ```bash $ az login $ az ad sp create-for-rbac --name terraform-provider-azurerm-acceptance-tests --role Contributor --scopes /subscriptions/00000000-0000-0000-0000-000000000000 Changing "terraform-provider-azurerm-acceptance-tests" to a valid URI of "http://ayaz-tf-acceptance-tests", which is the required format used for service principal names Creating a role assignment under the scope of "/subscriptions/00000000-0000-0000-0000-000000000000" Retrying role assignment creation: 1/36 Retrying role assignment creation: 2/36 { "appId": "<client-id>", "displayName": "terraform-provider-azurerm-acceptance-tests", "name": "http://terraform-provider-azurerm-acceptance-tests", "password": "<client-secret>", "tenant": "<tenant-id>" } ``` Once the credentials have been retrieved, save them as environment variables. ⚠️ Never run these commands as is, otherwise they will be written to disk within the shell history file. ```bash $ export ARM_CLIENT_ID='<client-id>' $ export ARM_CLIENT_SECRET='<client-secret>' $ export ARM_SUBSCRIPTION_ID='00000000-0000-0000-0000-000000000000' $ export ARM_TENANT_ID='<tenant-id>' $ export ARM_TEST_LOCATION='West US 2' $ export ARM_TEST_LOCATION_ALT='West US 2' $ export ARM_TEST_LOCATION_ALT2='West US 2' ``` And now we're good to go testing ! </details> ### Run Run tests with the following commands : ```bash $ make acctests SERVICE="servicebus" TESTARGS="-run=TestAccAzureRMServiceBusQueue" TESTTIMEOUT="6h" ; terminal-notifier -title "terraform-provider-azurerm" -message "Acceptance tests just finished \!" Wed Aug 5 21:43:16 CEST 2020 ==> Checking that code complies with gofmt requirements... ==> Checking that Custom Timeouts are used... ==> Checking that acceptance test packages are used... TF_ACC=1 go test -v ./azurerm/internal/services/servicebus/tests/ -run=TestAccAzureRMServiceBusQueue -timeout 6h -ldflags="-X=github.com/terraform-providers/terraform-provider-azurerm/version.ProviderVersion=acc" === RUN TestAccAzureRMServiceBusQueueAuthorizationRule_listen === PAUSE TestAccAzureRMServiceBusQueueAuthorizationRule_listen === RUN TestAccAzureRMServiceBusQueueAuthorizationRule_send === PAUSE TestAccAzureRMServiceBusQueueAuthorizationRule_send === RUN TestAccAzureRMServiceBusQueueAuthorizationRule_listensend === PAUSE TestAccAzureRMServiceBusQueueAuthorizationRule_listensend === RUN TestAccAzureRMServiceBusQueueAuthorizationRule_manage === PAUSE TestAccAzureRMServiceBusQueueAuthorizationRule_manage === RUN TestAccAzureRMServiceBusQueueAuthorizationRule_rightsUpdate === PAUSE TestAccAzureRMServiceBusQueueAuthorizationRule_rightsUpdate === RUN TestAccAzureRMServiceBusQueueAuthorizationRule_requiresImport === PAUSE TestAccAzureRMServiceBusQueueAuthorizationRule_requiresImport === RUN TestAccAzureRMServiceBusQueue_basic === PAUSE TestAccAzureRMServiceBusQueue_basic === RUN TestAccAzureRMServiceBusQueue_requiresImport === PAUSE TestAccAzureRMServiceBusQueue_requiresImport === RUN TestAccAzureRMServiceBusQueue_update === PAUSE TestAccAzureRMServiceBusQueue_update === RUN TestAccAzureRMServiceBusQueue_enablePartitioningStandard === PAUSE TestAccAzureRMServiceBusQueue_enablePartitioningStandard === RUN TestAccAzureRMServiceBusQueue_defaultEnablePartitioningPremium === PAUSE TestAccAzureRMServiceBusQueue_defaultEnablePartitioningPremium === RUN TestAccAzureRMServiceBusQueue_enableDuplicateDetection === PAUSE TestAccAzureRMServiceBusQueue_enableDuplicateDetection === RUN TestAccAzureRMServiceBusQueue_enableRequiresSession === PAUSE TestAccAzureRMServiceBusQueue_enableRequiresSession === RUN TestAccAzureRMServiceBusQueue_enableDeadLetteringOnMessageExpiration === PAUSE TestAccAzureRMServiceBusQueue_enableDeadLetteringOnMessageExpiration === RUN TestAccAzureRMServiceBusQueue_lockDuration === PAUSE TestAccAzureRMServiceBusQueue_lockDuration === RUN TestAccAzureRMServiceBusQueue_isoTimeSpanAttributes === PAUSE TestAccAzureRMServiceBusQueue_isoTimeSpanAttributes === RUN TestAccAzureRMServiceBusQueue_maxDeliveryCount === PAUSE TestAccAzureRMServiceBusQueue_maxDeliveryCount === RUN TestAccAzureRMServiceBusQueue_forwardTo === PAUSE TestAccAzureRMServiceBusQueue_forwardTo === RUN TestAccAzureRMServiceBusQueue_forwardDeadLetteredMessagesTo === PAUSE TestAccAzureRMServiceBusQueue_forwardDeadLetteredMessagesTo === RUN TestAccAzureRMServiceBusQueue_status === PAUSE TestAccAzureRMServiceBusQueue_status === CONT TestAccAzureRMServiceBusQueueAuthorizationRule_listen === CONT TestAccAzureRMServiceBusQueue_enableDuplicateDetection === CONT TestAccAzureRMServiceBusQueue_maxDeliveryCount === CONT TestAccAzureRMServiceBusQueue_lockDuration --- PASS: TestAccAzureRMServiceBusQueueAuthorizationRule_listen (227.06s) === CONT TestAccAzureRMServiceBusQueue_defaultEnablePartitioningPremium --- PASS: TestAccAzureRMServiceBusQueue_enableDuplicateDetection (271.59s) === CONT TestAccAzureRMServiceBusQueue_enablePartitioningStandard --- PASS: TestAccAzureRMServiceBusQueue_lockDuration (286.99s) === CONT TestAccAzureRMServiceBusQueue_update --- PASS: TestAccAzureRMServiceBusQueue_maxDeliveryCount (286.99s) === CONT TestAccAzureRMServiceBusQueue_requiresImport --- PASS: TestAccAzureRMServiceBusQueue_requiresImport (247.19s) === CONT TestAccAzureRMServiceBusQueue_basic --- PASS: TestAccAzureRMServiceBusQueue_enablePartitioningStandard (344.15s) === CONT TestAccAzureRMServiceBusQueueAuthorizationRule_requiresImport --- PASS: TestAccAzureRMServiceBusQueue_defaultEnablePartitioningPremium (407.24s) === CONT TestAccAzureRMServiceBusQueueAuthorizationRule_rightsUpdate --- PASS: TestAccAzureRMServiceBusQueue_basic (197.08s) === CONT TestAccAzureRMServiceBusQueueAuthorizationRule_manage --- PASS: TestAccAzureRMServiceBusQueueAuthorizationRule_rightsUpdate (247.67s) === CONT TestAccAzureRMServiceBusQueueAuthorizationRule_listensend --- PASS: TestAccAzureRMServiceBusQueue_update (614.87s) === CONT TestAccAzureRMServiceBusQueueAuthorizationRule_send --- PASS: TestAccAzureRMServiceBusQueueAuthorizationRule_manage (207.24s) === CONT TestAccAzureRMServiceBusQueue_isoTimeSpanAttributes --- PASS: TestAccAzureRMServiceBusQueueAuthorizationRule_requiresImport (395.49s) === CONT TestAccAzureRMServiceBusQueue_status --- PASS: TestAccAzureRMServiceBusQueueAuthorizationRule_listensend (260.17s) === CONT TestAccAzureRMServiceBusQueue_forwardDeadLetteredMessagesTo --- PASS: TestAccAzureRMServiceBusQueue_isoTimeSpanAttributes (212.45s) === CONT TestAccAzureRMServiceBusQueue_enableDeadLetteringOnMessageExpiration --- PASS: TestAccAzureRMServiceBusQueue_forwardDeadLetteredMessagesTo (230.64s) === CONT TestAccAzureRMServiceBusQueue_forwardTo --- PASS: TestAccAzureRMServiceBusQueueAuthorizationRule_send (492.21s) === CONT TestAccAzureRMServiceBusQueue_enableRequiresSession --- PASS: TestAccAzureRMServiceBusQueue_enableDeadLetteringOnMessageExpiration (291.38s) --- PASS: TestAccAzureRMServiceBusQueue_status (571.67s) --- PASS: TestAccAzureRMServiceBusQueue_forwardTo (228.06s) --- PASS: TestAccAzureRMServiceBusQueue_enableRequiresSession (233.17s) PASS ok github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/servicebus/tests 1628.884s ``` ### Document <details><summary>Do not use this section, the diff is huge</summary> ```bash $ make scaffold-website BRAND_NAME="ServiceBus Queue" RESOURCE_NAME="azurerm_servicebus_queue" RESOURCE_TYPE="resource" RESOURCE_ID="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/microsoft.servicebus/namespaces/sbns1/queues/snqueue1" ./scripts/scaffold-website.sh ==> Verifying required variables are set... ==> Validated. ==> Scaffolding Documentation... ==> Done. ``` </details> ### Cleanup <details><summary>This section is merely a small doc for myself</summary> In this code block, `$ARM_CLIENT_ID` is the content of the `appId` retrieved in the initialization section. ```bash $ az ad sp delete --id $ARM_CLIENT_ID Removing role assignments ``` </details>

ghost · 2020-08-23T14:52:07Z

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 hashibot-feedback@hashicorp.com. Thanks!

marc-sensenich added 2 commits July 22, 2020 13:05

Add status to azurerm_servicebus_subscription resource

7ffd78b

fixup! Add status to azurerm_servicebus_subscription resource

e3a3b45

ghost added size/L documentation labels Jul 22, 2020

mbfrahry requested changes Jul 22, 2020

View reviewed changes

fixup! Add status to azurerm_servicebus_subscription resource

87b1115

ghost added size/S and removed size/L labels Jul 23, 2020

marc-sensenich requested a review from mbfrahry July 23, 2020 00:51

katbyte added the service/service-bus label Jul 23, 2020

katbyte added this to the v2.21.0 milestone Jul 23, 2020

katbyte approved these changes Jul 23, 2020

View reviewed changes

katbyte changed the title ~~Add status to azurerm_servicebus_subscription resource~~ azurerm_servicebus_subscription - support status property Jul 23, 2020

katbyte merged commit 4e3bbe8 into hashicorp:master Jul 23, 2020

katbyte added a commit that referenced this pull request Jul 23, 2020

update CHANGELOG.md to include #7852

a9729d9

badouralix mentioned this pull request Aug 3, 2020

azurerm_servicebus_queue - support enable_batched_operations, status, forward_to, forward_dead_lettered_messages_to #7990

Merged

5 tasks

ghost locked and limited conversation to collaborators Aug 23, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

azurerm_servicebus_subscription - support status property #7852

azurerm_servicebus_subscription - support status property #7852

marc-sensenich commented Jul 22, 2020 •

edited

mbfrahry left a comment

mbfrahry Jul 22, 2020

marc-sensenich Jul 23, 2020

mbfrahry Jul 22, 2020

marc-sensenich Jul 23, 2020

marc-sensenich commented Jul 23, 2020

katbyte left a comment

ghost commented Jul 31, 2020

ghost commented Aug 23, 2020

	d.Set("status", helper.FlattenEntityStatus(props.Status))
	d.Set("status", string(props.Status))

	Status: helper.ExpandEntityStatus(d.Get("status")),
	Status: servicebus.EntityStatus(d.Get("status").(string)),

azurerm_servicebus_subscription - support status property #7852

azurerm_servicebus_subscription - support status property #7852

Conversation

marc-sensenich commented Jul 22, 2020 • edited

mbfrahry left a comment

Choose a reason for hiding this comment

mbfrahry Jul 22, 2020

Choose a reason for hiding this comment

marc-sensenich Jul 23, 2020

Choose a reason for hiding this comment

mbfrahry Jul 22, 2020

Choose a reason for hiding this comment

marc-sensenich Jul 23, 2020

Choose a reason for hiding this comment

marc-sensenich commented Jul 23, 2020

katbyte left a comment

Choose a reason for hiding this comment

ghost commented Jul 31, 2020

ghost commented Aug 23, 2020

marc-sensenich commented Jul 22, 2020 •

edited