From 0d70c4bb6d181203bb131d56a4f08c5f605e3057 Mon Sep 17 00:00:00 2001 From: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com> Date: Thu, 8 Oct 2020 10:56:08 -0700 Subject: [PATCH] Sync eng/common directory with azure-sdk-tools for PR 1077 (#14329) * Simplify Net-TestResources usage * docs and windows check * Update eng/common/TestResources/New-TestResources.ps1 Co-authored-by: Heath Stewart * update markdown * make service directory the default parameter * Fix links * Doc change Co-authored-by: Pavel Krymets Co-authored-by: Heath Stewart --- .../TestResources/New-TestResources.ps1 | 61 ++++++++++++++++--- .../TestResources/New-TestResources.ps1.md | 16 ++--- eng/common/TestResources/README.md | 10 +-- 3 files changed, 63 insertions(+), 24 deletions(-) diff --git a/eng/common/TestResources/New-TestResources.ps1 b/eng/common/TestResources/New-TestResources.ps1 index 59aab61fe728..4ce8a76d1a43 100644 --- a/eng/common/TestResources/New-TestResources.ps1 +++ b/eng/common/TestResources/New-TestResources.ps1 @@ -11,17 +11,17 @@ [CmdletBinding(DefaultParameterSetName = 'Default', SupportsShouldProcess = $true, ConfirmImpact = 'Medium')] param ( # Limit $BaseName to enough characters to be under limit plus prefixes, and https://docs.microsoft.com/azure/architecture/best-practices/resource-naming. - [Parameter(Mandatory = $true, Position = 0)] + [Parameter()] [ValidatePattern('^[-a-zA-Z0-9\.\(\)_]{0,80}(?<=[a-zA-Z0-9\(\)])$')] [string] $BaseName, [ValidatePattern('^[-\w\._\(\)]+$')] [string] $ResourceGroupName, - [Parameter(Mandatory = $true)] + [Parameter(Mandatory = $true, Position = 0)] [string] $ServiceDirectory, - [Parameter(Mandatory = $true)] + [Parameter()] [ValidatePattern('^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$')] [string] $TestApplicationId, @@ -119,6 +119,8 @@ $root = [System.IO.Path]::Combine($repositoryRoot, "sdk", $ServiceDirectory) | R $templateFileName = 'test-resources.json' $templateFiles = @() $environmentVariables = @{} +# Azure SDK Developer Playground +$defaultSubscription = "faa080af-c1d8-40ad-9cce-e1a450ca5b57" Write-Verbose "Checking for '$templateFileName' files under '$root'" Get-ChildItem -Path $root -Filter $templateFileName -Recurse | ForEach-Object { @@ -133,6 +135,26 @@ if (!$templateFiles) { exit } +$UserName = if ($env:USER) { $env:USER } else { "${env:USERNAME}" } + +# If no base name is specified use current user name +if (!$BaseName) { + $BaseName = "$UserName$ServiceDirectory" + + Log "BaseName was not set. Using default base name: '$BaseName'" +} + +# Try detecting repos that support OutFile and defaulting to it +if (!$CI -and !$PSBoundParameters.ContainsKey('OutFile') -and $IsWindows) +{ + # TODO: find a better way to detect the language + if (Test-Path "$repositoryRoot/eng/service.proj") + { + $OutFile = $true + Log "Detected .NET repository. Defaulting OutFile to true. Test environment settings would be stored into the file so you don't need to set environment variables manually." + } +} + # If no location is specified use safe default locations for the given # environment. If no matching environment is found $Location remains an empty # string. @@ -147,7 +169,7 @@ if (!$Location) { Write-Verbose "Location was not set. Using default location for environment: '$Location'" } -# Log in if requested; otherwise, the user is expected to already be authenticated via Connect-AzAccount. +# Log in if requested; otherwise, try to login into playground subscription. if ($ProvisionerApplicationId) { $null = Disable-AzContextAutosave -Scope Process @@ -176,6 +198,25 @@ if ($ProvisionerApplicationId) { } } } +elseif (!$CI) +{ + # check if user is logged in and login into + $context = Get-AzContext; + if (!$context) + { + Log "You are not logged in, connecting to 'Azure SDK Developer Playground'" + Connect-AzAccount -Subscription $defaultSubscription + } + + # If no test application id is specified create a new service principal + if (!$TestApplicationId) { + Log "TestApplicationId was not specified, creating a new service principal." + $servicePrincipal = New-AzADServicePrincipal -Role Owner + + $TestApplicationId = $servicePrincipal.ApplicationId + $TestApplicationSecret = (ConvertFrom-SecureString $servicePrincipal.Secret -AsPlainText); + } +} # Get test application OID from ID if not already provided. if ($TestApplicationId -and !$TestApplicationOid) { @@ -215,7 +256,7 @@ $ResourceGroupName = if ($ResourceGroupName) { # Tag the resource group to be deleted after a certain number of hours if specified. $tags = @{ - Creator = if ($env:USER) { $env:USER } else { "${env:USERNAME}" } + Creator = $UserName ServiceDirectory = $ServiceDirectory } @@ -403,7 +444,11 @@ foreach ($templateFile in $templateFiles) { $exitActions.Invoke() -return $environmentVariables +# Suppress output locally +if ($CI) +{ + return $environmentVariables +} <# .SYNOPSIS @@ -466,7 +511,7 @@ test resources (e.g. Role Assignments on resources). It is passed as to the ARM template as 'testApplicationOid' For more information on the relationship between AAD Applications and Service -Principals see: https://docs.microsoft.com/en-us/azure/active-directory/develop/app-objects-and-service-principals +Principals see: https://docs.microsoft.com/azure/active-directory/develop/app-objects-and-service-principals .PARAMETER TenantId The tenant ID of a service principal when a provisioner is specified. The same @@ -568,4 +613,4 @@ log redaction). .LINK Remove-TestResources.ps1 -#> \ No newline at end of file +#> diff --git a/eng/common/TestResources/New-TestResources.ps1.md b/eng/common/TestResources/New-TestResources.ps1.md index aab44b896d1f..6fc15eefdb49 100644 --- a/eng/common/TestResources/New-TestResources.ps1.md +++ b/eng/common/TestResources/New-TestResources.ps1.md @@ -14,16 +14,16 @@ Deploys live test resources defined for a service directory to Azure. ### Default (Default) ``` -New-TestResources.ps1 [-BaseName] [-ResourceGroupName ] -ServiceDirectory - -TestApplicationId [-TestApplicationSecret ] [-TestApplicationOid ] +New-TestResources.ps1 [-BaseName ] [-ResourceGroupName ] [-ServiceDirectory] + [-TestApplicationId ] [-TestApplicationSecret ] [-TestApplicationOid ] [-DeleteAfterHours ] [-Location ] [-Environment ] [-AdditionalParameters ] [-CI] [-Force] [-OutFile] [-WhatIf] [-Confirm] [] ``` ### Provisioner ``` -New-TestResources.ps1 [-BaseName] [-ResourceGroupName ] -ServiceDirectory - -TestApplicationId [-TestApplicationSecret ] [-TestApplicationOid ] +New-TestResources.ps1 [-BaseName ] [-ResourceGroupName ] [-ServiceDirectory] + [-TestApplicationId ] [-TestApplicationSecret ] [-TestApplicationOid ] -TenantId [-SubscriptionId ] -ProvisionerApplicationId -ProvisionerApplicationSecret [-DeleteAfterHours ] [-Location ] [-Environment ] [-AdditionalParameters ] [-CI] [-Force] [-OutFile] [-WhatIf] [-Confirm] @@ -106,8 +106,8 @@ Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -140,7 +140,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -159,7 +159,7 @@ Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/eng/common/TestResources/README.md b/eng/common/TestResources/README.md index 9cd79fe714be..070f2ba49ec5 100644 --- a/eng/common/TestResources/README.md +++ b/eng/common/TestResources/README.md @@ -27,16 +27,10 @@ is a member of multiple subscriptions. ```powershell Connect-AzAccount -Subscription 'YOUR SUBSCRIPTION ID' -$sp = New-AzADServicePrincipal -Role Owner -eng\common\TestResources\New-TestResources.ps1 ` - -BaseName 'myusername' ` - -ServiceDirectory 'search' ` - -TestApplicationId $sp.ApplicationId ` - -TestApplicationSecret (ConvertFrom-SecureString $sp.Secret -AsPlainText) +eng\common\TestResources\New-TestResources.ps1 -ServiceDirectory 'search' ``` -If you are running this for a .NET project on Windows, the recommended method is to -add the `-OutFile` switch to the above command. This will save test environment settings +The `OutFile` switch would be set if you are running this for a .NET project on Windows. This will save test environment settings into a test-resources.json.env file next to test-resources.json. The file is protected via DPAPI. The environment file would be scoped to the current repository directory and avoids the need to set environment variables or restart your IDE to recognize them.