Merge pull request #86 from SkillsFundingAgency/DASD-3585_AddStorageQueueMessage

Dasd 3585 add storage queue message

Author: smneal

Infrastructure/Resources/Add-AzureStorageQueueMessage.ps1

@@ -0,0 +1,70 @@
+<#
+.SYNOPSIS
+Add the specified content to an Azure Storage Queue
+
+.DESCRIPTION
+Add the specified content to an Azure Storage Queue
+
+.PARAMETER ResourceGroupName
+Resource group of the storage account
+
+.PARAMETER StorageAccountName
+Storage account name
+
+.PARAMETER StorageQueueName
+Storage queue where the message should be added
+
+.PARAMETER MessageContent
+Any message content that should be added to the queue. Can be blank.
+
+VSTS Variable with the Value '{"Release Definition":"$(Release.DefinitionName)","Release Name":"$(Release.ReleaseName)"}' produces a JSON formatted message
+with information about the release definition and name that the script was run from.
+
+.EXAMPLE
+
+.\Add-AzureStorageQueueMessage.ps1 -ResourceGroupName resourcegroupname `
+                                   -StorageAccountName storageaccountname `
+                                   -StorageQueueName storagequeuename `
+                                   -MessageContent "{"Release Definition":"$(Release.DefinitionName)","Release Name":"$(Release.ReleaseName)"}"
+
+#>
+[CmdletBinding()]
+Param(
+    [Parameter(Mandatory = $true)]
+    [String]$ResourceGroupName,
+    [Parameter(Mandatory = $true)]
+    [String]$StorageAccountName,
+    [Parameter(Mandatory = $true)]
+    [String]$StorageQueueName,
+    [Parameter(Mandatory = $false)]
+    [String]$MessageContent
+)
+try {
+
+    # Get the Storage account key
+    $StorageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $($ResourceGroupName) -Name $($StorageAccountName)).Value[0]
+
+    # Set the Storage context
+    $Context = New-AzureStorageContext -StorageAccountName $($StorageAccountName) -StorageAccountKey $StorageAccountKey
+
+    # Check whether the queue exists
+    $Queue = Get-AzureStorageQueue -Name $($StorageQueueName) -Context $Context
+
+    if (!$Queue) {
+        Write-Host "Specified storage queue $($StorageQueueName) doesn't exist in storage account $($StorageAccountName)"
+    }
+    else {
+        if ($PSBoundParameters.ContainsKey('MessageContent')) {
+            Write-Host "Supplied message content: $($MessageContent)"
+        }
+        else {
+            Write-Host "Setting empty MessageContent"
+            $MessageContent = ""
+        }
+        Write-Host "Adding message to queue"
+        $Queue.CloudQueue.AddMessage($MessageContent)
+    }
+}
+catch {
+    throw "$_"
+}

Tests/AT014.Add-AzureStorageQueueMessage.Tests.ps1

@@ -0,0 +1,39 @@
+$Config = Get-Content $PSScriptRoot\..\Tests\Acceptance.Config.json -Raw | ConvertFrom-Json
+Push-Location -Path $PSScriptRoot\..\Infrastructure\Resources\
+Describe "Add-AzureStorageQueueMessage Tests" -Tag "Acceptance-ARM" {
+
+    $StorageAccountName = "$($Config.armStorageAccountName)$($Config.suffix)"
+    $ResourceGroupName = "$($Config.resourceGroupName)$($Config.suffix)"
+    $StorageQueueName = "$($Config.classicStorageQueueName)$($Config.suffix)"
+    $StorageQueueMessage = "$($Config.classicStorageQueueMessage)$($Config.suffix)"
+
+    try {
+        $null = New-AzureRmStorageAccount -ResourceGroupName $ResourceGroupName -Location "West Europe" -Name $StorageAccountName -SkuName Standard_LRS
+        $StorageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $ResourceGroupName -Name $StorageAccountName)[0].Value
+        $StorageAccountContext = New-AzureStorageContext -StorageAccountName $StorageAccountName -StorageAccountKey $StorageAccountKey
+        $Queue = New-AzureStorageQueue -Name $StorageQueueName -Context $StorageAccountContext
+    } catch {
+        throw $_
+    }
+
+    It "Should complete succesfully and return one output with an empty message" {
+        $null = .\Add-AzureStorageQueueMessage.ps1 -ResourceGroupName $ResourceGroupName -StorageAccountName $StorageAccountName `
+                    -StorageQueueName $StorageQueueName
+        $Output = $Queue.CloudQueue.GetMessage()
+        $Queue.CloudQueue.DeleteMessage($Output)
+        $Output.Count | Should Be 1
+        $Output.AsString | Should Be
+    }
+
+    It "Should complete succesfully and return one output with a specific message" {
+        $Output = .\Add-AzureStorageQueueMessage.ps1 -ResourceGroupName $ResourceGroupName -StorageAccountName $StorageAccountName `
+                    -StorageQueueName $StorageQueueName -MessageContent $StorageQueueMessage
+        $Output = $Queue.CloudQueue.GetMessage()
+        $Queue.CloudQueue.DeleteMessage($Output)
+        $Output.Count | Should Be 1
+        $Output.AsString | Should Be $StorageQueueMessage
+    }
+
+}
+
+Pop-Location

Tests/Acceptance.Config.json

@@ -6,6 +6,7 @@
     "classicStorageContainerName": "public",
     "classicStorageTableName": "table1",
     "classicStorageQueueName": "queue1",
+    "classicStorageQueueMessage": "queuemessage",
     "cloudServiceName": "devops-at-cs",
     "appInsightsName": "devops-at-ai",
     "appServiceName": "devops-at-as",