Fix issues with running RunKeyVaultTests.ps1.

## Background

When attempting to run the Azure Key Vault PowerShell tests via the
`RunKeyVaultTests.ps1` script, the following 5 tests would fail:
```
Test_ImportByokWithDefaultAttributes
Test_ImportByokWith1024BitKey
Test_ImportByokWithCustomAttributes
Test_GetAllKeys
Test_GetKeyVersions
```

The first 3 BYOK tests failed because they test against dummy `.byok`
files that were generated with a specific subscription ID that may not
match the subscription ID of whomever is running the tests. The last 2
tests failed because they attempt to reference
`[Microsoft.WindowsAzure.Testing.TestUtilities]`, which cannot be found.

Moreover, this PowerShell script was difficult to use if we didn't want
to provide our own vault to test against for both the data plane and the
control plane, but we instead wanted the script to generate its own
temporary vault. Also, we sometimes would like to programmatically skip
Active Directory related tests for certain environments (instead of
having it hardcoded to always skip for Fairfax environments). Finally,
the PowerShell script could use some cleanup with respect to formatting
whitespace, fleshing out docstrings, and general organization.

## The Change

This change addresses the above issues by:

- Guarding the 3 BYOK tests with an if condition that tests the
  subscription ID.
- Replacing `Wait($timeout * 1000)` with
  `Start-Sleep -Seconds $timeout`.
- Saving/restoring temporary vault state for both the control plane and
  data plane tests.
- Exposing the `$NoADCmdLetMode` parameter.
- Generally improving the coding style.

Author: adarce

src/ResourceManager/KeyVault/Commands.KeyVault.Test/Scripts/Common.ps1

@@ -109,11 +109,15 @@ function Get-ImportKeyFile1024([string]$filesuffix, [bool] $exists=$true)
 
 <#
 .SYNOPSIS
-Remove log file under a folder
+Remove log files under the given folder.
 #>
-function Cleanup-Log([string]$rootfolder)
-{    
-    Get-ChildItem –Path $rootfolder -Include *.debug_log -Recurse | where {$_.mode -match "a"} | Remove-Item -Force     
+function Cleanup-LogFiles([string]$rootfolder)
+{
+    Write-Host "Cleaning up log files from $rootfolder..."
+    
+    Get-ChildItem –Path $rootfolder -Include *.debug_log -Recurse |
+        where {$_.mode -match "a"} |
+        Remove-Item -Force     
 }
 
 <#
@@ -125,7 +129,7 @@ function Move-Log([string]$rootfolder)
     $logfolder = Join-Path $rootfolder ("$global:testEnv"+"$global:testns"+"log")
     if (Test-Path $logfolder)
     {
-        Cleanup-Log $logfolder
+        Cleanup-LogFiles $logfolder
     }
     else
     {
@@ -138,24 +142,32 @@ function Move-Log([string]$rootfolder)
 
 <#
 .SYNOPSIS
-Removes all keys starting with the prefix
+Remove all old keys starting with the given prefix.
 #>
-function Initialize-KeyTest
+function Cleanup-OldKeys
 {
+    Write-Host "Cleaning up old keys..."
+
     $keyVault = Get-KeyVault
     $keyPattern = Get-KeyName '*'
-    Get-AzureKeyVaultKey $keyVault  | Where-Object {$_.KeyName -like $keyPattern}  | Remove-AzureKeyVaultKey -Force -Confirm:$false
+    Get-AzureKeyVaultKey $keyVault |
+        Where-Object {$_.KeyName -like $keyPattern} |
+        Remove-AzureKeyVaultKey -Force -Confirm:$false
 }
 
 <#
 .SYNOPSIS
-Removes all secrets starting with the prefix
+Remove all old secrets starting with the given prefix.
 #>
-function Initialize-SecretTest
+function Cleanup-OldSecrets
 {
+    Write-Host "Cleaning up old secrets..."
+
     $keyVault = Get-KeyVault
     $secretPattern = Get-SecretName '*'
-    Get-AzureKeyVaultSecret $keyVault  | Where-Object {$_.SecretName -like $secretPattern}  | Remove-AzureKeyVaultSecret -Force -Confirm:$false
+    Get-AzureKeyVaultSecret $keyVault |
+        Where-Object {$_.SecretName -like $secretPattern} |
+        Remove-AzureKeyVaultSecret -Force -Confirm:$false
 }
 
 

src/ResourceManager/KeyVault/Commands.KeyVault.Test/Scripts/ControlPlane/KeyVaultManagementTests.ps1

@@ -37,6 +37,8 @@ Param($rgName, $location, $tagName, $tagValue)
     Assert-AreEqual "Standard" $actual.Sku	
     Assert-AreEqual $false $actual.EnabledForDeployment
 
+    if ($global:noADCmdLetMode) {return;}
+
     # Default Access Policy
     $upn = [Microsoft.WindowsAzure.Commands.Common.AzureRMProfileProvider]::Instance.Profile.Context.Account.Id
     $objectId = @(Get-AzureRmADUser -Mail $upn)[0].Id
@@ -50,8 +52,6 @@ Param($rgName, $location, $tagName, $tagValue)
             "restore")
     $expectedPermsToSecrets = @("all")
 
-    if ($global:noADCmdLetMode) {return;}
-
     Assert-AreEqual 1 @($actual.AccessPolicies).Count	
     Assert-AreEqual $objectId $actual.AccessPolicies[0].ObjectId
     $result = Compare-Object $expectedPermsToKeys $actual.AccessPolicies[0].PermissionsToKeys