Merge pull request #81 from SkillsFundingAgency/DASD-3104_appid

DASD-3104 Annotations for App Insights: Added App Id to New-ApplicationInsights and new script Get-ApplicationInsightsApiKey

Author: rivoric

Infrastructure/Resources/Get-ApplicationInsightsApiKey.ps1

@@ -0,0 +1,46 @@
+<#
+
+.SYNOPSIS
+Gets an App Insight API key for annotations
+
+.DESCRIPTION
+Gets an App Insight API key for annotations
+
+.PARAMETER AppInsightName
+The name of the App Insight resource
+
+.PARAMETER ResourceGroupName
+The name of the Resource Group of the App Insight resource
+
+.PARAMETER KeyName
+Optional name for the API key (defaults to VSTSAnnotateKey)
+
+.EXAMPLE
+
+#>
+
+param (
+    [Parameter(Mandatory=$true)]
+    [String[]]$AppInsightName,
+    [Parameter(Mandatory = $false)]
+    [ValidateNotNullOrEmpty()]
+    [String]$ResourceGroupName = $ENV:ResourceGroup,
+    [Parameter(Mandatory = $false)]
+    [String]$KeyName = "VSTSAnnotateKey"
+)
+
+# --- Import Helpers
+Import-Module (Resolve-Path -Path $PSScriptRoot\..\Modules\Helpers.psm1).Path
+
+foreach ($Service in $AppInsightName) {
+
+    Get-AzureRmApplicationInsightsApiKey -ResourceGroupName $ResourceGroupName -Name $Service |
+        Where-Object { $_.Description -eq $KeyName } | ForEach-Object {
+            Write-Log -LogLevel Information -Message "Deleting $($_.Description) [$($_.Id)]"
+            Remove-AzureRmApplicationInsightsApiKey -ResourceGroupName $ResourceGroupName -Name $Service -ApiKeyId $_.Id
+    }
+
+    $apikey = New-AzureRmApplicationInsightsApiKey -ResourceGroupName $ResourceGroupName -Name $Service -Permissions WriteAnnotations -Description $KeyName
+    Write-Output "##vso[task.setvariable variable=appInsightApiKey-$($Service);]$($apikey.ApiKey)"
+
+}

Infrastructure/Resources/New-ApplicationInsights.ps1

@@ -76,8 +76,10 @@ foreach ($Service in $Name) {
     }
     if ((((Get-Module AzureRM -ListAvailable | Sort-Object { $_.Version.Major } -Descending).Version.Major))[0] -gt 5) {
         Write-Output ("##vso[task.setvariable variable=InstrumentationKey-$($Service);]$($ApplicationInsights.InstrumentationKey)")
+        Write-Output ("##vso[task.setvariable variable=AppId-$($Service);]$($ApplicationInsights.AppId)")
     }
     else {
         Write-Output ("##vso[task.setvariable variable=InstrumentationKey-$($Service);]$($ApplicationInsights.Properties.InstrumentationKey)")
+        Write-Output ("##vso[task.setvariable variable=AppId-$($Service);]$($ApplicationInsights.Properties.AppId)")
     }
 }

Tests/AT006.New-ApplicationInsights.Acceptance.Tests.ps1

@@ -1,30 +1,42 @@
 $Config = Get-Content $PSScriptRoot\..\Tests\Acceptance.Config.json -Raw | ConvertFrom-Json
 Push-Location -Path $PSScriptRoot\..\Infrastructure\Resources\
 
+$ValidGuid = [System.Guid]::NewGuid()
+
 Describe "New-ApplicationInsights Tests" -Tag "Acceptance-ARM" {
 
     $ResourceGroupName = "$($Config.ResourceGroupName)$($Config.suffix)"
     $AppInsightsName = "$($Config.appInsightsName)$($Config.suffix)"
 
-    It "Should create an ApplicationInsights and return a valid instrumentation key" {
+    It "Should create an ApplicationInsights and return a valid Instrumentation Key and App Id" {
         $Result = .\New-ApplicationInsights.ps1 -Location $Config.location -Name $AppInsightsName -ResourceGroupName $ResourceGroupName
-        $Result.Count | Should Be 1
-        $Result.Contains("InstrumentationKey") | Should Be $true
-        $Result = $Result.Split("]")[1]
-        $ValidGuid = [System.Guid]::NewGuid()
-        $Success = [System.Guid]::TryParse($Result, [ref]$ValidGuid);
+        $Result.Count | Should Be 2
+        $ik = $Result | Where-Object { $_.Contains("InstrumentationKey") }
+        $ik.Contains("InstrumentationKey") | Should Be $true
+        $ikguid = $ik.Split("]")[1]
+        $Success = [System.Guid]::TryParse($ikguid, [ref]$ValidGuid);
+        $Success | Should Be $true
+        $aid = $Result | Where-Object { $_.Contains("AppId") }
+        $aid.Contains("AppId") | Should Be $true
+        $aidguid = $aid.Split("]")[1]
+        $Success = [System.Guid]::TryParse($aidguid, [ref]$ValidGuid);
         $Success | Should Be $true
     }
 
-    It "Should return a valid instrumentation key on subsequent runs" {
+    It "Should return a valid Instrumentation Key and App Id on subsequent runs" {
         $Result = .\New-ApplicationInsights.ps1 -Location $Config.location -Name $AppInsightsName -ResourceGroupName $ResourceGroupName
-        $Result.Count | Should Be 1
-        $Result.Contains("InstrumentationKey") | Should Be $true
-        $Result = $Result.Split("]")[1]
-        $ValidGuid = [System.Guid]::NewGuid()
-        $Success = [System.Guid]::TryParse($Result, [ref]$ValidGuid);
+        $Result.Count | Should Be 2
+        $ik = $Result | Where-Object { $_.Contains("InstrumentationKey") }
+        $ik.Contains("InstrumentationKey") | Should Be $true
+        $ikguid = $ik.Split("]")[1]
+        $Success = [System.Guid]::TryParse($ikguid, [ref]$ValidGuid);
+        $Success | Should Be $true
+        $aid = $Result | Where-Object { $_.Contains("AppId") }
+        $aid.Contains("AppId") | Should Be $true
+        $aidguid = $aid.Split("]")[1]
+        $Success = [System.Guid]::TryParse($aidguid, [ref]$ValidGuid);
         $Success | Should Be $true
     }
 }
 
-Pop-Location
+Pop-Location

Tests/AT013.Get-ApplicationInsightsApiKey.Acceptance.Tests.ps1

@@ -0,0 +1,28 @@
+$Config = Get-Content $PSScriptRoot\..\Tests\Acceptance.Config.json -Raw | ConvertFrom-Json
+Push-Location -Path $PSScriptRoot\..\Infrastructure\Resources\
+
+# requires AT006.New-ApplicationInsights.Acceptance.Tests.ps1 to have ran first!
+$global:firstkey = $null
+
+Describe "Get-ApplicationInsightsApiKey Tests" -Tag "Acceptance-ARM" {
+
+    $ResourceGroupName = "$($Config.ResourceGroupName)$($Config.suffix)"
+    $AppInsightsName = "$($Config.appInsightsName)$($Config.suffix)"
+
+    It "Should return an API Key" {
+        $Result = .\Get-ApplicationInsightsApiKey.ps1 -AppInsightName $AppInsightsName -ResourceGroupName $ResourceGroupName
+        $Result.Count | Should Be 1
+        $Result.Contains("appInsightApiKey") | Should Be $true
+        $global:firstkey = $Result.Split("]")[1]
+    }
+
+    It "Should generate new API Key on subsequent runs" {
+        $Result = .\Get-ApplicationInsightsApiKey.ps1 -AppInsightName $AppInsightsName -ResourceGroupName $ResourceGroupName
+        $Result.Count | Should Be 1
+        $Result.Contains("appInsightApiKey") | Should Be $true
+        $Result.Split("]")[1] | Should Not Be $global:firstkey
+    }
+
+}
+
+Pop-Location