New Resource - azurerm_signalr_service_custom_domain, azurerm_web_pubsub_custom_domain

[xiaxyi]

The acc test requires some prerequisite:

1. we need to provide an owned domain
2. we need to add the custom certificate first -> depends on pr:New Resource - azurerm_web_pubsub_custom_certificate #21114 and New Resource - azurerm_signalr_service_custom_certificate #21112
3. we need to add the cname record for the signalr service in the owned domain as mentioned in this docs:https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-custom-domain?tabs=vault-access-policy%2Cazure-powershell#create-a-custom-domain-cname

any of the prerequisite mentioned above not satisfied will cause the acc test failure as the polling function is checking the resource provisioning status.

[xiaxyi]

acc tests:

--- PASS: TestAccSignalrServiceCustomDomainResource_requiresImport (581.07s)
--- PASS: TestAccSignalrServiceCustomDomainResource_basic (619.66s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/signalr       620.573s
--- PASS: TestAccWebPubsubCustomDomainResource_requiresImport (239.91s)
--- PASS: TestAccWebPubsubCustomDomainResource_basic (314.16s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/signalr       314.911s

[katbyte]

tests are failing:

------- Stdout: -------
=== RUN   TestAccSignalrServiceCustomDomainResource_basic
=== PAUSE TestAccSignalrServiceCustomDomainResource_basic
=== CONT  TestAccSignalrServiceCustomDomainResource_basic
    testcase.go:110: Step 1/2 error: Error running pre-apply refresh: exit status 1
        
        Error: Reference to undeclared resource
        
          on terraform_plugin_test.tf line 65, in resource "azurerm_key_vault" "test":
          65:     object_id = data.azurerm_signalr_service.test.identity[0].principal_id
        
        A data resource "azurerm_signalr_service" "test" has not been declared in the
        root module.
        
        Error: Invalid resource type
        
          on terraform_plugin_test.tf line 100, in resource "azurerm_signalr_custom_domain" "test":
         100: resource "azurerm_signalr_custom_domain" "test" {
        
        The provider hashicorp/azurerm does not support resource type
        "azurerm_signalr_custom_domain".
--- FAIL: TestAccSignalrServiceCustomDomainResource_basic (2.48s)
FAIL

[stephybun]

Thanks for this PR @xiaxyi. Overall this is looking good, I left some comments on the resources as well as regarding casing and consistency in the docs. Once those are resolved we can take another look through and get this merged!

[xiaxyi]

Thanks @katbyte for the comment, the operation to update the custom domain of SignalR service is actually updating the SignalR service's property. The two APIs are not totally independent, so we need to ensure SignalR update is finished before moving forward to another operation.

[stephybun]

@xiaxyi - coming back to my initial comment and suggestion if creating/updating the custom domain updates the parent resource then we should have the logic that checks the status in the create/update and only return once it's ready instead of waiting for it in the delete. Does that make sense?

[xiaxyi]

@stephybun thanks for replying back, as we discussed offline. The reason to add the signalR waiter here is to ensure the delete can be started when siganlR service is not being updated by another operation since the operation on custom domain is actually updating the signalR service. can you let me know the concerns of this waiting function?

[stephybun]

@xiaxyi after discussion with @tombuildsstuff the following needs to be done:

• Needing additional wait logic in the delete indicates an eventual consistency issue/bug in the API - removing this waiting logic in the delete will highlight where the issue is and where we will need to add locks to these resources and associated resources e.g. azurerm_signalr_service to account for that
• We will also need to add a custom poller to check the provisioning state in the create/update of this resource and associated resources

Ensuring the resource is in a ready state before deletion is outside of the scope for terraform - one of the core tenants is that when we've finished a create or update of something it is truly ready and fully provisioned.

If you can make the changes outlined above we can take another look through this.

[xiaxyi]

Thanks @stephybun for the comment, I updated the code, can you take a look and let me know if anything needed.

[xiaxyi]

Add API issue link:Azure/azure-rest-api-specs#23986

[katbyte]

LGTM 🌵

[katbyte]

Suggested change

	return fmt.Errorf("context had no deadline")
	return fmt.Errorf("internal-error: context had no deadline")

[katbyte]

Suggested change

	return fmt.Errorf("context had no deadline")
	return fmt.Errorf("internal-error: context had no deadline")

[katbyte]

Suggested change

	return fmt.Errorf("context had no deadline")
	return fmt.Errorf("internal-error: context had no deadline")

[github-actions]

This functionality has been released in v3.58.0 of the Terraform Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.