Update autoscale throughput minimum and enhance resource cleanup in tests (#495)

PlagueHO · web-flow · commit 90c2f91629ad · 2024-12-15T07:51:13.000+13:00
* Update autoscale throughput minimum to 1000 and enhance Cosmos DB resource cleanup in tests

* Refactor build.yaml and unit tests for Cosmos DB to improve formatting and assertion readability

* Add error handling to resource group removal check in TestHelper.psm1

* Update Cosmos DB integration test to reflect new offer throughput value
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Changed integration tests to display the removal of the Cosmos DB account
   in the teardown phase to ensure the account is removed after the tests are
   completed.
+- Updated collection and database autoscale minimum from 4000 to
+  1000 - Fixes [Issue #493](https://github.com/PlagueHO/CosmosDB/issues/493).
+- Changed integration tests to attempt to clean up the Cosmos DB resource group
+  if it is not removed by the teardown phase - Fixes [Issue #494](https://github.com/PlagueHO/CosmosDB/issues/494).
 
 ## [5.0.0] - 2024-06-07
 
diff --git a/build.yaml b/build.yaml
@@ -92,8 +92,8 @@ CopyPaths:
   - formats
   - en-US
   - types
-prefix: prefix.ps1
-suffix: suffix.ps1
+Prefix: prefix.ps1
+Suffix: suffix.ps1
 Encoding: UTF8
 VersionedOutputDirectory: true
 
diff --git a/docs/New-CosmosDbCollection.md b/docs/New-CosmosDbCollection.md
@@ -322,7 +322,7 @@ Accept wildcard characters: False
 ### -AutoscaleThroughput
 
 The user specified autoscale throughput for the database expressed in RU/s.
-This can be between 4000 and 1,000,000 and should be specified in increments
+This can be between 1000 and 1,000,000 and should be specified in increments
 of 100 RU/s.
 This parameter can not be specified in OfferThroughput or OfferType is specified.
 
diff --git a/docs/New-CosmosDbDatabase.md b/docs/New-CosmosDbDatabase.md
@@ -166,7 +166,7 @@ Accept wildcard characters: False
 ### -AutoscaleThroughput
 
 The user specified autoscale throughput for the database expressed in RU/s.
-This can be between 4000 and 1,000,000 and should be specified in increments
+This can be between 1000 and 1,000,000 and should be specified in increments
 of 100 RU/s.
 This parameter can not be specified in OfferThroughput is specified.
 
diff --git a/source/Public/collections/New-CosmosDbCollection.ps1 b/source/Public/collections/New-CosmosDbCollection.ps1
@@ -77,7 +77,7 @@ function New-CosmosDbCollection
         $UniqueKeyPolicy,
 
         [Alias('AutopilotThroughput')]
-        [ValidateRange(4000, 1000000)]
+        [ValidateRange(1000, 1000000)]
         [System.Int32]
         $AutoscaleThroughput
     )
diff --git a/source/Public/databases/New-CosmosDbDatabase.ps1 b/source/Public/databases/New-CosmosDbDatabase.ps1
@@ -37,7 +37,7 @@ function New-CosmosDbDatabase
         $OfferThroughput,
 
         [Alias('AutopilotThroughput','AutoscaleMaxThroughput','AutopilotMaxThroughput')]
-        [ValidateRange(4000, 1000000)]
+        [ValidateRange(1000, 1000000)]
         [System.Int32]
         $AutoscaleThroughput
     )
diff --git a/tests/Integration/CosmosDB.integration.Tests.ps1 b/tests/Integration/CosmosDB.integration.Tests.ps1
@@ -528,7 +528,7 @@ Describe 'Cosmos DB Module' -Tag 'Integration' {
 
     Context 'When creating third new database with a specified autoscale throughput' {
         It 'Should not throw an exception' {
-            $script:result = New-CosmosDbDatabase -Context $script:testContext -Id $script:testDatabase3 -AutoscaleThroughput 4000 -Verbose
+            $script:result = New-CosmosDbDatabase -Context $script:testContext -Id $script:testDatabase3 -AutoscaleThroughput 1000 -Verbose
         }
 
         It 'Should return expected object' {
@@ -553,9 +553,9 @@ Describe 'Cosmos DB Module' -Tag 'Integration' {
             $script:result.OfferType | Should -BeOfType [System.String]
             $script:result.OfferResourceId | Should -BeOfType [System.String]
             $script:result.Id | Should -BeOfType [System.String]
-            $script:result.content.offerThroughput | Should -BeExactly 400
-            $script:result.content.offerMinimumThroughputParameters.maxThroughputEverProvisioned | Should -BeExactly 4000
-            $script:result.content.offerAutopilotSettings.maxThroughput | Should -BeExactly 4000
+            $script:result.content.offerThroughput | Should -BeExactly 100
+            $script:result.content.offerMinimumThroughputParameters.maxThroughputEverProvisioned | Should -BeExactly 1000
+            $script:result.content.offerAutopilotSettings.maxThroughput | Should -BeExactly 1000
         }
     }
 
@@ -1388,7 +1388,7 @@ Describe 'Cosmos DB Module' -Tag 'Integration' {
                 -Context $script:testContext `
                 -Id $script:testCollection `
                 -PartitionKey $script:testPartitionKey `
-                -AutoscaleThroughput 4000 `
+                -AutoscaleThroughput 1000 `
                 -Verbose
         }
 
diff --git a/tests/TestHelper/TestHelper.psm1 b/tests/TestHelper/TestHelper.psm1
@@ -314,10 +314,22 @@ function Remove-AzureTestCosmosDbResourceGroup
 
         if ($PSCmdlet.ShouldProcess('Azure', ("Remove Azure Cosmos DB resource group '{0}'" -f $ResourceGroupName)))
         {
-            $null = Remove-AzResourceGroup `
+            Remove-AzResourceGroup `
                 -Name $ResourceGroupName `
-                -Force `
-                -AsJob
+                -Force
+
+            # Check if the resource group was removed
+            $resourceGroup = Get-AzResourceGroup `
+                -Name $ResourceGroupName `
+                -ErrorAction SilentlyContinue
+
+            if ($null -ne $resourceGroup)
+            {
+                Write-Warning -Message ('Resource group {0} was not removed. Trying again.' -f $ResourceGroupName)
+                Remove-AzResourceGroup `
+                    -Name $ResourceGroupName `
+                    -Force
+            }
         }
     }
     catch [System.Exception]
diff --git a/tests/Unit/CosmosDB.accounts.Tests.ps1 b/tests/Unit/CosmosDB.accounts.Tests.ps1
@@ -124,7 +124,7 @@ InModuleScope $ProjectName {
 
         Context 'When called with a valid name' {
             It 'Should return $true' {
-                Assert-CosmosDbAccountNameValid -Name 'validaccountname' | Should -Be $true
+                Assert-CosmosDbAccountNameValid -Name 'validaccountname' | Should -BeTrue
             }
         }
 
@@ -196,7 +196,7 @@ InModuleScope $ProjectName {
 
         Context 'When called with a valid resource group name' {
             It 'Should return $true' {
-                Assert-CosmosDbResourceGroupNameValid -ResourceGroupName 'valid_resource-group.name123' | Should -Be $true
+                Assert-CosmosDbResourceGroupNameValid -ResourceGroupName 'valid_resource-group.name123' | Should -BeTrue
             }
         }
 
diff --git a/tests/Unit/CosmosDB.collections.Tests.ps1 b/tests/Unit/CosmosDB.collections.Tests.ps1
@@ -932,7 +932,7 @@ InModuleScope $ProjectName {
                 $Method -eq 'Post' -and `
                 $ResourceType -eq 'colls' -and `
                 $BodyObject.id -eq $script:testCollection1 -and `
-                $Headers.'x-ms-cosmos-offer-autopilot-settings' -eq "{`"maxThroughput`":4000}"
+                $Headers.'x-ms-cosmos-offer-autopilot-settings' -eq "{`"maxThroughput`":1000}"
             }
 
             Mock `
@@ -943,7 +943,7 @@ InModuleScope $ProjectName {
                 $newCosmosDbCollectionParameters = @{
                     Context             = $script:testContext
                     Id                  = $script:testCollection1
-                    AutoscaleThroughput = 4000
+                    AutoscaleThroughput = 1000
                     PartitionKey        = 'partitionkey'
                     Verbose             = $true
                 }
@@ -972,7 +972,7 @@ InModuleScope $ProjectName {
                 $newCosmosDbCollectionParameters = @{
                     Context             = $script:testContext
                     Id                  = $script:testCollection1
-                    AutoscaleThroughput = 4000
+                    AutoscaleThroughput = 1000
                     Verbose             = $true
                 }
 
@@ -993,7 +993,7 @@ InModuleScope $ProjectName {
                     Context             = $script:testContext
                     Id                  = $script:testCollection1
                     OfferThroughput     = 400
-                    AutoscaleThroughput = 4000
+                    AutoscaleThroughput = 1000
                     Verbose             = $true
                 }
 
@@ -1014,7 +1014,7 @@ InModuleScope $ProjectName {
                     Context             = $script:testContext
                     Id                  = $script:testCollection1
                     OfferType           = 'S1'
-                    AutoscaleThroughput = 4000
+                    AutoscaleThroughput = 1000
                     Verbose             = $true
                 }
 
diff --git a/tests/Unit/CosmosDB.databases.Tests.ps1 b/tests/Unit/CosmosDB.databases.Tests.ps1
@@ -34,7 +34,7 @@ InModuleScope $ProjectName {
     $script:testDatabase1 = 'testDatabase1'
     $script:testDatabase2 = 'testDatabase2'
     $script:testOfferThroughput = 2000
-    $script:testAutoscaleThroughput = 4000
+    $script:testAutoscaleThroughput = 1000
     $script:testJsonMulti = @'
 {
     "_rid": "",

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ function New-CosmosDbCollection`
`77`	`77`	`$UniqueKeyPolicy,`
`78`	`78`
`79`	`79`	`[Alias('AutopilotThroughput')]`
`80`		`- [ValidateRange(4000, 1000000)]`
	`80`	`+ [ValidateRange(1000, 1000000)]`
`81`	`81`	`[System.Int32]`
`82`	`82`	`$AutoscaleThroughput`
`83`	`83`	`)`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ function New-CosmosDbDatabase`
`37`	`37`	`$OfferThroughput,`
`38`	`38`
`39`	`39`	`[Alias('AutopilotThroughput','AutoscaleMaxThroughput','AutopilotMaxThroughput')]`
`40`		`- [ValidateRange(4000, 1000000)]`
	`40`	`+ [ValidateRange(1000, 1000000)]`
`41`	`41`	`[System.Int32]`
`42`	`42`	`$AutoscaleThroughput`
`43`	`43`	`)`
Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ InModuleScope $ProjectName {`
`124`	`124`
`125`	`125`	`Context 'When called with a valid name' {`
`126`	`126`	`It 'Should return $true' {`
`127`		`- Assert-CosmosDbAccountNameValid -Name 'validaccountname' \| Should -Be $true`
	`127`	`+ Assert-CosmosDbAccountNameValid -Name 'validaccountname' \| Should -BeTrue`
`128`	`128`	`}`
`129`	`129`	`}`
`130`	`130`
`@@ -196,7 +196,7 @@ InModuleScope $ProjectName {`
`196`	`196`
`197`	`197`	`Context 'When called with a valid resource group name' {`
`198`	`198`	`It 'Should return $true' {`
`199`		`- Assert-CosmosDbResourceGroupNameValid -ResourceGroupName 'valid_resource-group.name123' \| Should -Be $true`
	`199`	`+ Assert-CosmosDbResourceGroupNameValid -ResourceGroupName 'valid_resource-group.name123' \| Should -BeTrue`
`200`	`200`	`}`
`201`	`201`	`}`
`202`	`202`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ InModuleScope $ProjectName {`
`34`	`34`	`$script:testDatabase1 = 'testDatabase1'`
`35`	`35`	`$script:testDatabase2 = 'testDatabase2'`
`36`	`36`	`$script:testOfferThroughput = 2000`
`37`		`- $script:testAutoscaleThroughput = 4000`
	`37`	`+ $script:testAutoscaleThroughput = 1000`
`38`	`38`	`$script:testJsonMulti = @'`
`39`	`39`	`{`
`40`	`40`	`"_rid": "",`