Fix the connection string that is set to TEST_CSM_ORGID_AUTHENTICATION (Azure#19813)

msJinLei · web-flow · commit 5c0c886d4e61 · 2022-10-20T23:21:49.000+08:00
diff --git a/documentation/development-docs/azure-powershell-developer-guide.md b/documentation/development-docs/azure-powershell-developer-guide.md
@@ -338,7 +338,7 @@ CI in DevOps will happens under `Debug` folder. So you need to make sure that th
 Create this environment variables for the AD scenario tests:
 
 - `AZURE_SERVICE_PRINCIPAL` should be a service principal - an application defined in the subscription's tenant - that has management access to the subscription (or at least to a resource group in the tenant)
-  - `AZURE_SERVICE_PRINCIPAL=UserId=<UserGuid>;Password=<Password>;AADTenant=<TenantGuid>;SubscriptionId=<SubscriptionId>`
+  - `AZURE_SERVICE_PRINCIPAL=UserId=<UserGuid>;Password=<Password>;TenantId=<TenantGuid>;SubscriptionId=<SubscriptionId>`
 
 ### Recording/Running Tests
 
diff --git a/documentation/testing-docs/using-azure-test-framework.md b/documentation/testing-docs/using-azure-test-framework.md
@@ -121,7 +121,7 @@ To use this option, set the following environment variable before starting Visua
 * The [AAD Tenant ID](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal#get-tenant-id)
 
 ```
-TEST_CSM_ORGID_AUTHENTICATION=SubscriptionId={SubId};ServicePrincipal={clientId};ServicePrincipalSecret={clientSecret};AADTenant={tenantId};Environment={env};HttpRecorderMode=Record;
+TEST_CSM_ORGID_AUTHENTICATION=SubscriptionId={SubId};ServicePrincipal={clientId};ServicePrincipalSecret={clientSecret};TenantId={tenantId};Environment={env};HttpRecorderMode=Record;
 AZURE_TEST_MODE=Record
 ```
 
diff --git a/src/Accounts/Accounts.Test/ConnectAzAccountScenarioTests.ps1 b/src/Accounts/Accounts.Test/ConnectAzAccountScenarioTests.ps1
@@ -23,7 +23,7 @@ function Test-MaxContextPopulationWithSpecifiedValue
 	$applicationId=$authenticationString.SubString($authenticationString.IndexOf("ServicePrincipal=")+"ServicePrincipal=".length,36)
 	$password=$authenticationString.SubString($authenticationString.IndexOf("ServicePrincipalSecret=")+"ServicePrincipalSecret=".length,34)
 	$secret = ConvertTo-SecureString -String $password -AsPlainText -Force
-	$tenantId=$authenticationString.SubString($authenticationString.IndexOf("AADTenant=")+"AADTenant=".length,36)
+	$tenantId=$authenticationString.SubString($authenticationString.IndexOf("TenantId=")+"TenantId=".length,36)
 	
 	$credential = New-Object -TypeName System.Management.Automation.PSCredential($applicationId, $secret)	
 
@@ -55,7 +55,7 @@ function Test-MaxContextPopulationWithDefaultValue
 	$applicationId=$authenticationString.SubString($authenticationString.IndexOf("ServicePrincipal=")+"ServicePrincipal=".length,36)
 	$password=$authenticationString.SubString($authenticationString.IndexOf("ServicePrincipalSecret=")+"ServicePrincipalSecret=".length,34)
 	$secret = ConvertTo-SecureString -String $password -AsPlainText -Force
-	$tenantId=$authenticationString.SubString($authenticationString.IndexOf("AADTenant=")+"AADTenant=".length,36)
+	$tenantId=$authenticationString.SubString($authenticationString.IndexOf("TenantId=")+"TenantId=".length,36)
 	
 	$credential = New-Object -TypeName System.Management.Automation.PSCredential($applicationId, $secret)	
 	Connect-AzAccount -ServicePrincipal -Credential $credential -Tenant $tenantId	
@@ -84,7 +84,7 @@ function Test-MaxContextPopulationGetAll
 	$applicationId=$authenticationString.SubString($authenticationString.IndexOf("ServicePrincipal=")+"ServicePrincipal=".length,36)
 	$password=$authenticationString.SubString($authenticationString.IndexOf("ServicePrincipalSecret=")+"ServicePrincipalSecret=".length,34)
 	$secret = ConvertTo-SecureString -String $password -AsPlainText -Force
-	$tenantId=$authenticationString.SubString($authenticationString.IndexOf("AADTenant=")+"AADTenant=".length,36)
+	$tenantId=$authenticationString.SubString($authenticationString.IndexOf("TenantId=")+"TenantId=".length,36)
 	
 	$credential = New-Object -TypeName System.Management.Automation.PSCredential($applicationId, $secret)	
 	
diff --git a/tools/Modules/TestFx-Tasks.Tests.ps1 b/tools/Modules/TestFx-Tasks.Tests.ps1
@@ -39,7 +39,7 @@ Describe "Test-NewCredentialNewServicePrincipal"{
         It "creates correctly formatted environment string" {
             $Env:AZURE_TEST_MODE | Should Match "Playback"
             $Env:TEST_CSM_ORGID_AUTHENTICATION | Should Match "SubscriptionId=" + $context.Subscription.Id + ";HttpRecorderMode=Playback;Environment=Prod;ServicePrincipal=" + 
-            "8bc48661-1801-4b7a-8ca1-6a3cadfb4870" + ";ServicePrincipalSecret=testpassword;" + "AADTenant=" + $context.Tenant.Id
+            "8bc48661-1801-4b7a-8ca1-6a3cadfb4870" + ";ServicePrincipalSecret=testpassword;" + "TenantId=" + $context.Tenant.Id
         }
     }
 
@@ -78,7 +78,7 @@ Describe "Test-NewCredentialExistingServicePrincipal" {
         It "creates correctly formatted environment string" {
             $Env:AZURE_TEST_MODE | Should Match "Record"
             $Env:TEST_CSM_ORGID_AUTHENTICATION | Should Match "SubscriptionId=" + $context.Subscription.Id + ";HttpRecorderMode=Record;Environment=Prod;ServicePrincipal=" + 
-                "1234" + ";ServicePrincipalSecret=testpassword;" + "AADTenant=" + $context.Tenant.Id
+                "1234" + ";ServicePrincipalSecret=testpassword;" + "TenantId=" + $context.Tenant.Id
         }
     }
 
@@ -137,7 +137,7 @@ Describe "Test-SetEnvironmentServicePrincipal" {
 		Set-TestEnvironment -ServicePrincipalId $NewServicePrincipal.ApplicationId -ServicePrincipalSecret "testpassword" -SubscriptionId $context.Subscription.Id -TenantId $context.Tenant.Id -RecordMode "Record"
 		It "creates correctly formatted environment string" {
             $Env:AZURE_TEST_MODE | Should Match "Record"
-			$Env:TEST_CSM_ORGID_AUTHENTICATION | Should Match "SubscriptionId=" + $context.Subscription.Id + ";HttpRecorderMode=Record;Environment=Prod;AADTenant=" +
+			$Env:TEST_CSM_ORGID_AUTHENTICATION | Should Match "SubscriptionId=" + $context.Subscription.Id + ";HttpRecorderMode=Record;Environment=Prod;TenantId=" +
 				$context.Tenant.Id + ";ServicePrincipal=" + "1234" + ";ServicePrincipalSecret=testpassword"
 		}
 	}
@@ -160,4 +160,4 @@ Describe "Test-SetEnvironmentUserId" {
 	# Clean-up
 	Remove-Item Env:AZURE_TEST_MODE
 	Remove-Item Env:TEST_CSM_ORGID_AUTHENTICATION
-}
+}
diff --git a/tools/Modules/TestFx-Tasks.psm1 b/tools/Modules/TestFx-Tasks.psm1
@@ -228,7 +228,7 @@ This cmdlet will only prompt you for Subscription and Tenant information, rest a
 
     if([string]::IsNullOrEmpty($TenantId) -eq $false)
     {
-        $formattedConnStr = [string]::Format([string]::Concat($formattedConnStr, ";AADTenant={0}"), $TenantId)
+        $formattedConnStr = [string]::Format([string]::Concat($formattedConnStr, ";TenantId={0}"), $TenantId)
     }
 
     if([string]::IsNullOrEmpty($ServicePrincipalId) -eq $false)
@@ -325,7 +325,7 @@ Function Print-ConnectionString([string]$uid, [string]$subId, [string]$aadTenant
 
     if([string]::IsNullOrEmpty($aadTenant) -eq $false)
     {
-        Write-Host "AADTenant=" -ForegroundColor Green -NoNewline
+        Write-Host "TenantId=" -ForegroundColor Green -NoNewline
         Write-Host $aadTenant";" -NoNewline
     }
 

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ Describe "Test-NewCredentialNewServicePrincipal"{`
`39`	`39`	`It "creates correctly formatted environment string" {`
`40`	`40`	`$Env:AZURE_TEST_MODE \| Should Match "Playback"`
`41`	`41`	`$Env:TEST_CSM_ORGID_AUTHENTICATION \| Should Match "SubscriptionId=" + $context.Subscription.Id + ";HttpRecorderMode=Playback;Environment=Prod;ServicePrincipal=" +`
`42`		`- "8bc48661-1801-4b7a-8ca1-6a3cadfb4870" + ";ServicePrincipalSecret=testpassword;" + "AADTenant=" + $context.Tenant.Id`
	`42`	`+ "8bc48661-1801-4b7a-8ca1-6a3cadfb4870" + ";ServicePrincipalSecret=testpassword;" + "TenantId=" + $context.Tenant.Id`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`
`@@ -78,7 +78,7 @@ Describe "Test-NewCredentialExistingServicePrincipal" {`
`78`	`78`	`It "creates correctly formatted environment string" {`
`79`	`79`	`$Env:AZURE_TEST_MODE \| Should Match "Record"`
`80`	`80`	`$Env:TEST_CSM_ORGID_AUTHENTICATION \| Should Match "SubscriptionId=" + $context.Subscription.Id + ";HttpRecorderMode=Record;Environment=Prod;ServicePrincipal=" +`
`81`		`- "1234" + ";ServicePrincipalSecret=testpassword;" + "AADTenant=" + $context.Tenant.Id`
	`81`	`+ "1234" + ";ServicePrincipalSecret=testpassword;" + "TenantId=" + $context.Tenant.Id`
`82`	`82`	`}`
`83`	`83`	`}`
`84`	`84`
`@@ -137,7 +137,7 @@ Describe "Test-SetEnvironmentServicePrincipal" {`
`137`	`137`	`Set-TestEnvironment -ServicePrincipalId $NewServicePrincipal.ApplicationId -ServicePrincipalSecret "testpassword" -SubscriptionId $context.Subscription.Id -TenantId $context.Tenant.Id -RecordMode "Record"`
`138`	`138`	`It "creates correctly formatted environment string" {`
`139`	`139`	`$Env:AZURE_TEST_MODE \| Should Match "Record"`
`140`		`- $Env:TEST_CSM_ORGID_AUTHENTICATION \| Should Match "SubscriptionId=" + $context.Subscription.Id + ";HttpRecorderMode=Record;Environment=Prod;AADTenant=" +`
	`140`	`+ $Env:TEST_CSM_ORGID_AUTHENTICATION \| Should Match "SubscriptionId=" + $context.Subscription.Id + ";HttpRecorderMode=Record;Environment=Prod;TenantId=" +`
`141`	`141`	`$context.Tenant.Id + ";ServicePrincipal=" + "1234" + ";ServicePrincipalSecret=testpassword"`
`142`	`142`	`}`
`143`	`143`	`}`
`@@ -160,4 +160,4 @@ Describe "Test-SetEnvironmentUserId" {`
`160`	`160`	`# Clean-up`
`161`	`161`	`Remove-Item Env:AZURE_TEST_MODE`
`162`	`162`	`Remove-Item Env:TEST_CSM_ORGID_AUTHENTICATION`
`163`		`-}`
	`163`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -228,7 +228,7 @@ This cmdlet will only prompt you for Subscription and Tenant information, rest a`
`228`	`228`
`229`	`229`	`if([string]::IsNullOrEmpty($TenantId) -eq $false)`
`230`	`230`	`{`
`231`		`- $formattedConnStr = [string]::Format([string]::Concat($formattedConnStr, ";AADTenant={0}"), $TenantId)`
	`231`	`+ $formattedConnStr = [string]::Format([string]::Concat($formattedConnStr, ";TenantId={0}"), $TenantId)`
`232`	`232`	`}`
`233`	`233`
`234`	`234`	`if([string]::IsNullOrEmpty($ServicePrincipalId) -eq $false)`
`@@ -325,7 +325,7 @@ Function Print-ConnectionString([string]$uid, [string]$subId, [string]$aadTenant`
`325`	`325`
`326`	`326`	`if([string]::IsNullOrEmpty($aadTenant) -eq $false)`
`327`	`327`	`{`
`328`		`- Write-Host "AADTenant=" -ForegroundColor Green -NoNewline`
	`328`	`+ Write-Host "TenantId=" -ForegroundColor Green -NoNewline`
`329`	`329`	`Write-Host $aadTenant";" -NoNewline`
`330`	`330`	`}`
`331`	`331`