Add composite indexes support to CosmosDB SQL container

[favoretti]

Fixes #8762

[favoretti]

$ TF_ACC=1 go test -v ./azurerm/internal/services/cosmos/ -timeout=600m -run=TestAccAzureRMCosmosDbSqlContainer_complete
=== RUN   TestAccAzureRMCosmosDbSqlContainer_complete
=== PAUSE TestAccAzureRMCosmosDbSqlContainer_complete
=== CONT  TestAccAzureRMCosmosDbSqlContainer_complete
--- PASS: TestAccAzureRMCosmosDbSqlContainer_complete (1447.26s)
PASS
ok  	github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/cosmos	1448.461s

$ TF_ACC=1 go test -v ./azurerm/internal/services/cosmos/ -timeout=600m -run=TestAccAzureRMCosmosDbSqlContainer_indexing_policy
=== RUN   TestAccAzureRMCosmosDbSqlContainer_indexing_policy
=== PAUSE TestAccAzureRMCosmosDbSqlContainer_indexing_policy
=== CONT  TestAccAzureRMCosmosDbSqlContainer_indexing_policy
--- PASS: TestAccAzureRMCosmosDbSqlContainer_indexing_policy (1588.70s)
PASS
ok  	github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/cosmos	1589.996s

@tombuildsstuff I think this should be ready for a review now. Thanks!

[tombuildsstuff]

hey @favoretti

Thanks for pushing those changes - taking a look through I've left a couple of other comments but this otherwise LGTM 👍

Thanks!

[favoretti]

@tombuildsstuff Thank you, great comments for me to learn off. Committed all.

[tombuildsstuff]

two minor things but this is otherwise good 👍

[jackofallops]

Hi @favoretti - I had a quick pass at fixing up a couple items to try and get this into today's release, but it looks like there's a casing bug in the API for reading back the order property which is causing a Diff. We'll need to open an issue on the api-specs repo and possibly look at a workaround to get this in for the next release.

[favoretti]

@jackofallops ouch, that's not good. As a workaround we can just lowercase it all over the place when comparing?

[jackofallops]

@jackofallops ouch, that's not good. As a workaround we can just lowercase it all over the place when comparing?

Probably best to check the string value in the flatten and set the correctly cased value for the state there?

Test output (clipped) demonstrating the issue:

DIFF:
UPDATE: azurerm_cosmosdb_sql_container.test
account_name:                                      "acctest-ca-201015133402551728" => "acctest-ca-201015133402551728"
autoscale_settings.#:                              "0" => "0"
database_name:                                     "acctest-201015133402551728" => "acctest-201015133402551728"
default_ttl:                                       "500" => "500"
id:                                                "/subscriptions/*******/resourceGroups/acctestRG-cosmos-201015133402551728/providers/Microsoft.DocumentDB/databaseAccounts/acctest-ca-201015133402551728/sqlDatabases/acctest-201015133402551728/containers/acctest-CSQLC-201015133402551728" => "/subscriptions/*******/resourceGroups/acctestRG-cosmos-201015133402551728/providers/Microsoft.DocumentDB/databaseAccounts/acctest-ca-201015133402551728/sqlDatabases/acctest-201015133402551728/containers/acctest-CSQLC-201015133402551728"
indexing_policy.#:                                 "1" => "1"
indexing_policy.0.composite_index.#:               "2" => "2"
indexing_policy.0.composite_index.0.index.#:       "2" => "2"
indexing_policy.0.composite_index.0.index.0.order: "descending" => "Descending"
indexing_policy.0.composite_index.0.index.0.path:  "/path1" => "/path1"
indexing_policy.0.composite_index.0.index.1.order: "ascending" => "Ascending"

[favoretti]

@jackofallops Would something like this work?

index a2539bf50..eaa5e2c4c 100644
--- a/azurerm/internal/services/cosmos/common/indexing_policy.go
+++ b/azurerm/internal/services/cosmos/common/indexing_policy.go
@@ -2,6 +2,7 @@ package common

 import (
        "fmt"
+ "strings"

        "github.com/Azure/azure-sdk-for-go/services/cosmos-db/mgmt/2020-04-01/documentdb"
        "github.com/hashicorp/terraform-plugin-sdk/helper/schema"
@@ -123,7 +124,7 @@ func flattenCosmosDBIndexingPolicyCompositeIndex(input []documentdb.CompositePat

                block := make(map[string]interface{})
                block["path"] = path
-           block["order"] = v.Order
+           block["order"] = strings.Title(string(v.Order))
                indexPairs = append(indexPairs, block)
        }

If you're ok with it - I'll push.

[jackofallops]

At first glance that should be OK, would be worth running the TestAccAzureRMCosmosDbSqlContainer_complete test before pushing though if you can?
Could you also add a comment that it's a workaround for an API issue, I've created it here: Azure/azure-rest-api-specs#11222

[favoretti]

@jackofallops Seems to work:

[17:12:16](⎈ |eastus2-fxs-ops-fxc:ops)➜  terraform-providers/terraform-provider-azurerm git:(favoretti/composite_indexes) ✗ $ TF_ACC=1 go test -v ./azurerm/internal/services/cosmos/ -timeout=600m -run=TestAccAzureRMCosmosDbSqlContainer_complete
=== RUN   TestAccAzureRMCosmosDbSqlContainer_complete
=== PAUSE TestAccAzureRMCosmosDbSqlContainer_complete
=== CONT  TestAccAzureRMCosmosDbSqlContainer_complete
--- PASS: TestAccAzureRMCosmosDbSqlContainer_complete (1345.15s)
PASS
ok  	github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/cosmos	1346.355s
[17:35:59](⎈ |eastus2-fxs-ops-fxc:ops)➜  terraform-providers/terraform-provider-azurerm git:(favoretti/composite_indexes) ✗ $

[jackofallops]

Tests passing:

[ghost]

This has been released in version 2.33.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.33.0"
}
# ... other configuration ...

[ghost]

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 👉 [email protected]. Thanks!