Octopus Step Testing

Examples.md

The example step includes one required parameter and one that is not required and has a default.

Call with No Parameters

PS C:\temp> Invoke-OctopusStep @{} .\step.ps1
Missing parameter value RequiredParameter
At C:\temp\step.ps1:12 char:13
+             throw "Missing parameter value $Name"
+             ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo          : OperationStopped: (Missing paramet...quiredParameter:String) [], RuntimeException
+ FullyQualifiedErrorId : Missing parameter value RequiredParameter

Call with required parameter but no default

PS C:\temp> Invoke-OctopusStep @{RequiredParameter="apple"} .\step.ps1
Script Title...
RequiredParameter: apple
DefaultedParameter: default value

Call with both the required and defaulted parameter

PS C:\temp> Invoke-OctopusStep @{RequiredParameter="apple"; DefaultedParameter="orange"} .\step.ps1
Script Title...
RequiredParameter: apple
DefaultedParameter: orange

Step template.ps1

$ErrorActionPreference = "Stop" 
function Get-Parameter($Name, $Default, [switch]$Required) {
    $result = $null

    if ($OctopusParameters -ne $null) {
        $result = $OctopusParameters[$Name]
    }

    if ($result -eq $null) {
        if ($Required) {
            throw "Missing parameter value $Name"
        } else {
            $result = $Default
        }
    }

    return $result
}

$requiredParameter = Get-Parameter "RequiredParameter" -Required
$defaultedParameter = Get-Parameter "DefaultedParameter" "default value"

Write-Host "Script Title..."
Write-Host "RequiredParameter: $requiredParameter"
Write-Host "DefaultedParameter: $defaultedParameter"

# Main body of the script goes here!

Test wrapper.ps1

function Invoke-OctopusStep {
	param (
		[Parameter(Mandatory=$true)]
		[hashtable]$parameters,

		[Parameter(Mandatory=$true)]
		[string]$script
	)
	
	$OctopusParameters = @{}
	foreach ($item in $parameters.GetEnumerator()) {
		$OctopusParameters[$item.Name] = $item.Value;
	}

	& $script
}