azurerm_batch_pool - Fixes a bug in settings_json of extension block

[liuwuliuyun]

Related Resource
azurerm_batch_pool
Issue Description
This issue is raised by a customer that if specify settings_json = {} in azurerm_batch_pool. The extension will never be attached to the created batch pool.

Root Cause 1
The very first reason of this issue is that the value this property should be encapsulated with jsonencode function, so the correct usage should be settings_json = jsonencode({}).
Solution for 1
Add proper description for settings_json and protected_settings in doc.

Root Cause 2
The second reason above parsing error is not shown when user runs terraform apply is that the parsing error is not thrown in the resource creat function
Solution for 2
Add error handling logic to throw parsing error when creating the resource.

After above code change, there will be a plan diff after apply. In order to solve this new issue, I dig a little deeper in the read function.

Root Cause 3
In the read function, pluginsdk.FlattenJsonToString will transfer empty map to empty string "" rather than {}.
Solution for 3

• Use json.Unmarshel to replace pluginsdk.FlattenJsonToString will have correct transformation.
• Add a new testcase TestAccBatchPool_extensionsWithEmptySettings

GOROOT=C:\Program Files\Go #gosetup
GOPATH=C:\Users\yunliu1\go #gosetup
"C:\Program Files\Go\bin\go.exe" test -c -o C:\Users\yunliu1\AppData\Local\JetBrains\GoLand2023.3\tmp\GoLand\___TestAccBatchPool_extensionsWithEmptySettings_in_github_com_hashicorp_terraform_provider_azurerm_internal_services_batch.test.exe github.com/hashicorp/terraform-provider-azurerm/internal/services/batch #gosetup
"C:\Program Files\Go\bin\go.exe" tool test2json -t C:\Users\yunliu1\AppData\Local\JetBrains\GoLand2023.3\tmp\GoLand\___TestAccBatchPool_extensionsWithEmptySettings_in_github_com_hashicorp_terraform_provider_azurerm_internal_services_batch.test.exe -test.v -test.paniconexit0 -test.run ^\QTestAccBatchPool_extensionsWithEmptySettings\E$ #gosetup
=== RUN   TestAccBatchPool_extensionsWithEmptySettings
=== PAUSE TestAccBatchPool_extensionsWithEmptySettings
=== CONT  TestAccBatchPool_extensionsWithEmptySettings
--- PASS: TestAccBatchPool_extensionsWithEmptySettings (333.10s)
PASS


Process finished with the exit code 0

[catriona-m]

Hi @liuwuliuyun thanks for submitting this. It looks like there is a test failure that could be related to this:

------- Stdout: -------
=== RUN   TestAccBatchPool_basic
=== PAUSE TestAccBatchPool_basic
=== CONT  TestAccBatchPool_basic
    testcase.go:113: Step 1/2 error: Error running apply: exit status 1
        Error: creating Pool (Subscription: "*******"
        Resource Group Name: "acctestRG-batch-240222144545372017"
        Batch Account Name: "testaccbatcha3jut"
        Pool Name: "testaccpoola3jut"): unexpected status 400 with error: MissingRequiredProperty: A required property was not specified in the request body.
        RequestId:cb7a6301-4666-4f48-84e9-190c96db8615
        Time:2024-02-22T14:47:02.3650524Z
          with azurerm_batch_pool.test,
          on terraform_plugin_test.tf line 32, in resource "azurerm_batch_pool" "test":
          32: resource "azurerm_batch_pool" "test" {
--- FAIL: TestAccBatchPool_basic (141.73s)
FAIL

Once that is resolved, we can take another look. Thanks!

[liuwuliuyun]

Thanks @catriona-m for your review. I changed the code related to expanding vnet config. Here are the results from the latest test run. All those failed tests are identical to the failed tests from main branch.

[catriona-m]

Hi @liuwuliuyun - thanks for making the requested changes! LGTM!

[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.