Add Support for AzureChinaCloud - Fixes #365 (#367)

* Added support for AzureChinaCloud

* Fix daily build

* Fix changelog

Author: PlagueHO

CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Added support for AzureChinaCloud (Mooncake) - Fixes [Issue #365](https://github.com/PlagueHO/CosmosDB/issues/365).
+
+### Changed
+
+- Fix daily build by preventing deployment stage from running on
+  anything build not named `*.master` - Fixes [Issue #366](https://github.com/PlagueHO/CosmosDB/issues/366).
+
 ## [4.0.0] - 2020-05-11
 
 ### Changed

README.md

@@ -24,6 +24,7 @@
   - [Working with Contexts](#working-with-contexts)
     - [Create a Context specifying the Key Manually](#create-a-context-specifying-the-key-manually)
     - [Create a Context for a Cosmos DB in Azure US Government Cloud](#create-a-context-for-a-cosmos-db-in-azure-us-government-cloud)
+    - [Create a Context for a Cosmos DB in Azure China Cloud (Mooncake)](#create-a-context-for-a-cosmos-db-in-azure-china-cloud-mooncake)
     - [Use CosmosDB Module to Retrieve Key from Azure Management Portal](#use-cosmosdb-module-to-retrieve-key-from-azure-management-portal)
     - [Create a Context for a Cosmos DB Emulator](#create-a-context-for-a-cosmos-db-emulator)
     - [Create a Context from Resource Authorization Tokens](#create-a-context-from-resource-authorization-tokens)
@@ -152,6 +153,16 @@ create a context variable and set the `Environment` parameter to
 $cosmosDbContext = New-CosmosDbContext -Account 'MyAzureCosmosDB' -Database 'MyDatabase' -Key $primaryKey -Environment AzureUSGovernment
 ```
 
+#### Create a Context for a Cosmos DB in Azure China Cloud (Mooncake)
+
+Use the key secure string, Azure Cosmos DB account name and database to
+create a context variable and set the `Environment` parameter to
+`AzureChinaCloud`:
+
+```powershell
+$cosmosDbContext = New-CosmosDbContext -Account 'MyAzureCosmosDB' -Database 'MyDatabase' -Key $primaryKey -Environment AzureChinaCloud
+```
+
 #### Use CosmosDB Module to Retrieve Key from Azure Management Portal
 
 To create a context object so that the _CosmosDB PowerShell module_

azure-pipelines.yml

@@ -562,7 +562,8 @@ stages:
           eq(variables['Build.SourceBranch'], 'refs/heads/master'),
           startsWith(variables['Build.SourceBranch'], 'refs/tags/')
         ),
-        eq(variables['System.TeamFoundationCollectionUri'], 'https://dscottraynsford.visualstudio.com/')
+        eq(variables['System.TeamFoundationCollectionUri'], 'https://dscottraynsford.visualstudio.com/'),
+        endsWith(variables['Build.DefinitionName'],'master')
       )
     jobs:
       - job: Deploy_Module

source/Private/utils/Get-CosmosDbUri.ps1

@@ -28,6 +28,11 @@ function Get-CosmosDbUri
             {
                 $BaseUri = 'documents.azure.us'
             }
+
+            'AzureChinaCloud'
+            {
+                $BaseUri = 'documents.azure.cn'
+            }
         }
     }
 

source/classes/CosmosDB/CosmosDB.cs

@@ -2,6 +2,7 @@
 
 namespace CosmosDB {
     public enum Environment {
+        AzureChinaCloud,
         AzureCloud,
         AzureUSGovernment
     }

tests/Unit/CosmosDB.utils.Tests.ps1

@@ -31,6 +31,7 @@ InModuleScope $ProjectName {
     $script:testBaseUri = 'documents.contoso.com'
     $script:testBaseUriAzureCloud = 'documents.azure.com'
     $script:testBaseUriAzureUsGov = 'documents.azure.us'
+    $script:testBaseUriAzureChinaCloud = 'documents.azure.cn'
     $script:testDate = (Get-Date -Year 2017 -Month 11 -Day 29 -Hour 10 -Minute 45 -Second 10)
     $script:testUniversalDate = 'Tue, 28 Nov 2017 21:45:10 GMT'
     $script:testContext = [CosmosDb.Context] @{
@@ -261,6 +262,30 @@ console.log("done");
             }
         }
 
+        Context 'When called with Account and Environment AzureChinaCloud parameters' {
+            $script:result = $null
+
+            It 'Should not throw exception' {
+                $newCosmosDbContextParameters = @{
+                    Account     = $script:testAccount
+                    Database    = $script:testDatabase
+                    Key         = $script:testKeySecureString
+                    KeyType     = 'master'
+                    Environment = 'AzureChinaCloud'
+                }
+
+                { $script:result = New-CosmosDbContext @newCosmosDbContextParameters } | Should -Not -Throw
+            }
+
+            It 'Should return expected result' {
+                $script:result.Account | Should -Be $script:testAccount
+                $script:result.Database | Should -Be $script:testDatabase
+                $script:result.Key | Should -Be $script:testKeySecureString
+                $script:result.KeyType | Should -Be 'master'
+                $script:result.BaseUri | Should -Be ('https://{0}.{1}/' -f $script:testAccount, $script:testBaseUriAzureChinaCloud)
+            }
+        }
+
         Context 'When called with Account parameters and Back-off Policy' {
             $script:result = $null
 
@@ -375,6 +400,46 @@ console.log("done");
             }
         }
 
+        Context 'When called with AzureAccount and Environment AzureChinaCloud parameters and not connected to Azure and PrimaryMasterKey requested' {
+            $script:result = $null
+
+            Mock -CommandName Get-AzContext -MockWith { throw }
+            Mock -CommandName Connect-AzAccount
+            Mock `
+                -CommandName Get-CosmosDbAccountMasterKey `
+                -MockWith { $script:testKeySecureString }
+
+            It 'Should not throw exception' {
+                $newCosmosDbContextParameters = @{
+                    Account           = $script:testAccount
+                    Database          = $script:testDatabase
+                    ResourceGroupName = $script:testResourceGroupName
+                    MasterKeyType     = 'PrimaryMasterKey'
+                    Environment       = 'AzureChinaCloud'
+                }
+
+                { $script:result = New-CosmosDbContext @newCosmosDbContextParameters } | Should -Not -Throw
+            }
+
+            It 'Should return expected result' {
+                $script:result.Account | Should -Be $script:testAccount
+                $script:result.Database | Should -Be $script:testDatabase
+                $script:result.KeyType | Should -Be 'master'
+                $script:result.Key | Convert-CosmosDbSecureStringToString | Should -Be $script:testKey
+                $script:result.BaseUri | Should -Be ('https://{0}.{1}/' -f $script:testAccount, $script:testBaseUriAzureChinaCloud)
+            }
+
+            It 'Should call expected mocks' {
+                Assert-MockCalled -CommandName Get-AzContext -Exactly -Times 1
+                Assert-MockCalled -CommandName Connect-AzAccount `
+                    -ParameterFilter { $Environment -eq 'AzureChinaCloud' } `
+                    -Exactly -Times 1
+                Assert-MockCalled -CommandName Get-CosmosDbAccountMasterKey `
+                    -ParameterFilter { $MasterKeyType -eq 'PrimaryMasterKey' } `
+                    -Exactly -Times 1
+            }
+        }
+
         Context 'When called with AzureAccount parameters and connected to Azure' {
             $script:result = $null
 
@@ -571,6 +636,25 @@ console.log("done");
                 $script:result.ToString() | Should -Be ('https://{0}.{1}/' -f $script:testAccount, $script:testBaseUriAzureUsGov)
             }
         }
+
+        Context 'When called with Account and AzureChinaCloud Environment parameters' {
+            $script:result = $null
+
+            It 'Should not throw exception' {
+                $GetCosmosDbUriParameters = @{
+                    Account     = $script:testAccount
+                    Environment = [CosmosDb.Environment]::AzureChinaCloud
+                    Verbose     = $true
+                }
+
+                { $script:result = Get-CosmosDbUri @GetCosmosDbUriParameters } | Should -Not -Throw
+            }
+
+            It 'Should return expected result' {
+                $script:result | Should -BeOfType uri
+                $script:result.ToString() | Should -Be ('https://{0}.{1}/' -f $script:testAccount, $script:testBaseUriAzureChinaCloud)
+            }
+        }
     }
 
     Describe 'ConvertTo-CosmosDbTokenDateString' -Tag 'Unit' {