Upgrade Cosmos version from `2020-04-01-preview` to `2021-01-15` #10926

yupwei68 · 2021-03-11T05:37:10Z

All tests have passed

changes:

variable indexing_mode and order in resources azurerm_cosmosdb_sql_container and azurerm_cosmosdb_gremlin_graph is defined and returned in lower case instead of hybrid case. We keep the original hybrid cases instead of breaking changes.

breaking changes:

cosmos mongodb account default to "v3.6" instead of "v3.2". The changes occur in azurerm_cosmosdb_account tests. Thus, _id index is required in azurerm_cosmosdb_mongo_collection .
"patition_key_path" is "required" instead of "optional" in azurerm_cosmosdb_gremlin_graph and azurerm_cosmosdb_sql_container .

…form-provider-azurerm into wyp-cosmos-version

yupwei68 · 2021-03-15T01:53:11Z

katbyte

Thanks @yupwei68 - i've left some comments inline. Also we have a test failure:

------- Stdout: -------
=== RUN   TestAccCosmosDbMongoCollection_autoscale
=== PAUSE TestAccCosmosDbMongoCollection_autoscale
=== CONT  TestAccCosmosDbMongoCollection_autoscale
    testing_new_import_state.go:249: ImportStateVerify attributes not equivalent. Difference is shown below. Top is actual, bottom is expected.
        
        (map[string]string) (len=1) {
         (string) (len=10) "throughput": (string) (len=3) "500"
        }
        
        
        (map[string]string) (len=1) {
         (string) (len=10) "throughput": (string) (len=3) "400"
        }
--- FAIL: TestAccCosmosDbMongoCollection_autoscale (1235.42s)
FAIL

katbyte · 2021-03-18T22:46:13Z

azurerm/internal/services/cosmos/common/schema.go

@@ -123,7 +123,7 @@ func CosmosDbIndexingPolicySchema() *schema.Schema {
 					ValidateFunc: validation.StringInSlice([]string{
 						string(documentdb.Consistent),
 						string(documentdb.None),
-					}, false),
+					}, true),


Why are we making this case insensitive? the SDK values should match what we get from the API?

In preview version, the value is "consistent" and "none", but in current version, the value is "Consistent" and "None". To resolve the breaking change, I set it to be case insensitive?

instead of making this case insensitive can we just correct the casing to the SDK values on read?

also - could we open an issue on the SDK or somewhere to track this discrepancy?

The case has been change when the service has released 2020-04-01 stable version. The old 2020-04-01-preview version has been deleted.
Since preview version permits breaking changes, shall I not open the issue?

azurerm/internal/services/cosmos/common/schema.go

azurerm/internal/services/cosmos/cosmosdb_account_data_source_test.go

azurerm/internal/services/cosmos/cosmosdb_gremlin_graph_resource.go

katbyte

.

yupwei68 · 2021-03-19T07:57:23Z

Hi @katbyte Thanks for comments. I've run this test for three times locally. It all passed. I think it's a random hiccup.
=== RUN TestAccCosmosDbMongoCollection_autoscale
=== PAUSE TestAccCosmosDbMongoCollection_autoscale
=== CONT TestAccCosmosDbMongoCollection_autoscale
--- PASS: TestAccCosmosDbMongoCollection_autoscale (5617.59s)

yupwei68 · 2021-03-30T09:14:13Z

Hi kt, I've solved the breaking change. And all tests have passed.

katbyte

Thanks, just a few small things left to address and this'll be good to merge

katbyte · 2021-04-21T01:14:57Z

azurerm/internal/services/cosmos/common/schema.go

@@ -123,7 +123,7 @@ func CosmosDbIndexingPolicySchema() *schema.Schema {
 					ValidateFunc: validation.StringInSlice([]string{
 						string(documentdb.Consistent),
 						string(documentdb.None),
-					}, false),
+					}, true),


instead of making this case insensitive can we just correct the casing to the SDK values on read?

also - could we open an issue on the SDK or somewhere to track this discrepancy?

azurerm/internal/services/cosmos/cosmosdb_gremlin_graph_resource.go

yupwei68 · 2021-04-21T10:01:18Z

Thanks kt for your comments. I've changed all these. Please continue reviewing.

katbyte

Thanks @yupwei68 - aside from one comment inline (add todo 3.0 to those constants) and these two test failures this looks ready to merge!

------- Stdout: -------
=== RUN   TestAccCosmosDbSqlStoredProcedure_basic
=== PAUSE TestAccCosmosDbSqlStoredProcedure_basic
=== CONT  TestAccCosmosDbSqlStoredProcedure_basic
    testing.go:620: Step 1/2 error: Error running pre-apply refresh: 
        Error: Missing required argument
        
          on config293530581/terraform_plugin_test.tf line 35, in resource "azurerm_cosmosdb_sql_container" "test":
          35: resource "azurerm_cosmosdb_sql_container" "test" {
        
        The argument "partition_key_path" is required, but no definition was found.
        
--- FAIL: TestAccCosmosDbSqlStoredProcedure_basic (6.26s)
FAIL

------- Stderr: -------
2021/04/22 04:53:16 [DEBUG] not using binary driver name, it's no longer needed
2021/04/22 04:53:16 [DEBUG] not using binary driver name, it's no longer needed
------- Stdout: -------
=== RUN   TestAccCosmosDbSqlStoredProcedure_update
=== PAUSE TestAccCosmosDbSqlStoredProcedure_update
=== CONT  TestAccCosmosDbSqlStoredProcedure_update
    testing.go:620: Step 1/4 error: Error running pre-apply refresh: 
        Error: Missing required argument
        
          on config415328271/terraform_plugin_test.tf line 35, in resource "azurerm_cosmosdb_sql_container" "test":
          35: resource "azurerm_cosmosdb_sql_container" "test" {
        
        The argument "partition_key_path" is required, but no definition was found.
        
--- FAIL: TestAccCosmosDbSqlStoredProcedure_update (6.02s)
FAIL

------- Stderr: -------
2021/04/22 04:53:21 [DEBUG] not using binary driver name, it's no longer needed
2021/04/22 04:53:21 [DEBUG] not using binary driver name, it's no longer needed

azurerm/internal/services/cosmos/cosmosdb_gremlin_graph_resource.go

yupwei68 · 2021-04-23T05:19:01Z

Hi kt, tests have passed.

yupwei68 · 2021-04-25T06:02:09Z

Hi kt, I've updated the description of the PR to list all changes and breaking changes.

ghost · 2021-04-30T02:20:18Z

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

github-actions · 2021-05-30T02:43:43Z

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.

yupwei68 added 7 commits February 26, 2021 09:05

update

1891667

update

6ed89b1

update

f9918f6

update

8911183

Merge branch 'master' of https://github.com/terraform-providers/terra…

9b7914c

…form-provider-azurerm into wyp-cosmos-version

Merge branch 'master' of https://github.com/terraform-providers/terra…

c74be72

…form-provider-azurerm into wyp-cosmos-version

update

e9ac730

ghost added the size/XXL label Mar 11, 2021

yupwei68 changed the title ~~Upgrade Cosmos version to 2021-01-15~~ Upgrade Cosmos version from 2020-04-01-preview to 2021-01-15 Mar 11, 2021

yupwei68 added 2 commits March 11, 2021 13:50

update

11e9299

update

9ee2067

tombuildsstuff added the breaking-change label Mar 11, 2021

katbyte self-assigned this Mar 11, 2021

katbyte reviewed Mar 18, 2021

View reviewed changes

katbyte requested changes Mar 18, 2021

View reviewed changes

update

39f0ffe

yupwei68 added 4 commits March 29, 2021 17:10

update

f4bc427

restore

b8e123e

update

6426349

mrege

5d357a8

yupwei68 requested a review from katbyte March 30, 2021 09:14

katbyte added the service/cosmosdb label Apr 6, 2021

katbyte mentioned this pull request Apr 15, 2021

service/cosmos: Upgrade API to 2021-01-15 stable and other enhancements #11337

Closed

katbyte requested changes Apr 21, 2021

View reviewed changes

yupwei68 added 2 commits April 21, 2021 17:52

update

479498c

merge

f0eae7a

yupwei68 requested a review from katbyte April 21, 2021 10:01

merge

3d30631

katbyte approved these changes Apr 22, 2021

View reviewed changes

azurerm/internal/services/cosmos/cosmosdb_gremlin_graph_resource.go Show resolved Hide resolved

katbyte added this to the v2.57.0 milestone Apr 22, 2021

update

e119538

katbyte added 4 commits April 23, 2021 12:32

merge master

3a2b006

fix imports

ddac46a

fix imports

49a2ec7

make fmt

6a72efe

katbyte merged commit 5c91f84 into hashicorp:master Apr 27, 2021

katbyte added a commit that referenced this pull request Apr 27, 2021

CHANGELOG.md for #10926

57d84d7

yupwei68 deleted the wyp-cosmos-version branch April 28, 2021 02:14

github-actions bot locked as resolved and limited conversation to collaborators May 30, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade Cosmos version from `2020-04-01-preview` to `2021-01-15` #10926

Upgrade Cosmos version from `2020-04-01-preview` to `2021-01-15` #10926

yupwei68 commented Mar 11, 2021 •

edited

yupwei68 commented Mar 15, 2021

katbyte left a comment

katbyte Mar 18, 2021

yupwei68 Mar 19, 2021

katbyte Apr 21, 2021

yupwei68 Apr 21, 2021

katbyte left a comment

yupwei68 commented Mar 19, 2021

yupwei68 commented Mar 30, 2021

katbyte left a comment

katbyte Apr 21, 2021

yupwei68 commented Apr 21, 2021

katbyte left a comment

yupwei68 commented Apr 23, 2021

yupwei68 commented Apr 25, 2021

ghost commented Apr 30, 2021

github-actions bot commented May 30, 2021

Upgrade Cosmos version from 2020-04-01-preview to 2021-01-15 #10926

Upgrade Cosmos version from 2020-04-01-preview to 2021-01-15 #10926

Conversation

yupwei68 commented Mar 11, 2021 • edited

yupwei68 commented Mar 15, 2021

katbyte left a comment

Choose a reason for hiding this comment

katbyte Mar 18, 2021

Choose a reason for hiding this comment

yupwei68 Mar 19, 2021

Choose a reason for hiding this comment

katbyte Apr 21, 2021

Choose a reason for hiding this comment

yupwei68 Apr 21, 2021

Choose a reason for hiding this comment

katbyte left a comment

Choose a reason for hiding this comment

yupwei68 commented Mar 19, 2021

yupwei68 commented Mar 30, 2021

katbyte left a comment

Choose a reason for hiding this comment

katbyte Apr 21, 2021

Choose a reason for hiding this comment

yupwei68 commented Apr 21, 2021

katbyte left a comment

Choose a reason for hiding this comment

yupwei68 commented Apr 23, 2021

yupwei68 commented Apr 25, 2021

ghost commented Apr 30, 2021

github-actions bot commented May 30, 2021

Upgrade Cosmos version from `2020-04-01-preview` to `2021-01-15` #10926

Upgrade Cosmos version from `2020-04-01-preview` to `2021-01-15` #10926

yupwei68 commented Mar 11, 2021 •

edited