Fix task for when value is missing

Author: EwanNoble

tasks/EnvironmentConfiguration/task/ps_modules/Handlers/private/schema/Get-SchemaProperty.ps1

@@ -24,49 +24,47 @@ function Get-SchemaProperty {
         if ($PropertyObject.ExtensionData.ContainsKey("environmentVariable")) {
 
             $VariableName = $PropertyObject.ExtensionData.Item("environmentVariable").Value
+            $TaskVariable = Get-VstsTaskVariable -Name $VariableName
+            if (![string]::IsNullOrEmpty($TaskVariable)) {
+                switch ($PSCmdlet.ParameterSetName) {
 
-            switch ($PSCmdlet.ParameterSetName) {
+                    'Standard' {
+                        $TaskVariable = "$($TaskVariable)"
+                        break
+                    }
 
-                'Standard' {
-                    $TaskVariable = Get-VstsTaskVariable -Name $VariableName
-                    break
-                }
-
-                'AsInt' {
-                    $TaskVariable = Get-VstsTaskVariable -Name $VariableName -AsInt
-                    break
-                }
+                    'AsInt' {
+                        $TaskVariable = [int]$TaskVariable
+                        break
+                    }
 
-                'AsNumber' {
-                    $TaskVariable = [Decimal]::Parse((Get-VstsTaskVariable -Name $VariableName))
-                    break
-                }
+                    'AsNumber' {
+                        $TaskVariable = [Decimal]::Parse($TaskVariable)
+                        break
+                    }
 
-                'AsArray' {
-                    $ArrayString = Get-VstsTaskVariable -Name $VariableName
-                    $TaskVariable = @($ArrayString | ConvertFrom-Json)
-                    break
-                }
+                    'AsArray' {
+                        $TaskVariable = @($TaskVariable | ConvertFrom-Json)
+                        break
+                    }
 
-                'AsBool' {
-                    $TaskVariable = Get-VstsTaskVariable -Name $VariableName -AsBool
-                    break
+                    'AsBool' {
+                        $TaskVariable = $TaskVariable.ToLower() -in '1', 'true'
+                        break
+                    }
                 }
-
+                return $TaskVariable
             }
         }
 
         if (!$TaskVariable -and $null -ne $PropertyObject.Default) {
-            Write-Verbose -Message "No environment variable found for [ $VariableName ] and a default value is present in the schema"
+            Write-Verbose -Message "No environment variable found but a default value is present in the schema"
             $TaskVariable = $PropertyObject.Default.Value
             Write-Verbose -Message "Set default value '$TaskVariable'"
+            return $TaskVariable
         }
 
-        if ($null -eq $TaskVariable) {
-            throw "No environment variable found and no default value set in schema"
-        }
-
-        Write-Output $TaskVariable
+        throw "No environment variable found and no default value set in schema"
     }
     catch {
         Write-Error -Message "Could not get property from object [ $VariableName ] : $_" -ErrorAction Stop

tasks/EnvironmentConfiguration/tests/Get-SchemaProperty.unit.tests.ps1

@@ -11,10 +11,6 @@ InModuleScope "Handlers" {
             Clear-MockEnvironment
         }
 
-        Mock Get-VstsTaskVariable { return "default-string" }
-        Mock Get-VstsTaskVariable { return 1 } -ParameterFilter { $AsInt -eq $true }
-        Mock Get-VstsTaskVariable { return $true } -ParameterFilter { $AsBool -eq $true }
-
         $SchemaDefinitionPath = "$PSScriptRoot/resource/SFA.DAS.Test.schema.json"
         $SchemaDefinition = Get-Content -Path $SchemaDefinitionPath -Raw
         $SchemaObject = [Newtonsoft.Json.Schema.JSchema, Newtonsoft.Json.Schema, Version = 2.0.0.0, Culture = neutral, PublicKeyToken = 30ad4fe6b2a6aeed]::Parse($SchemaDefinition)
@@ -23,52 +19,48 @@ InModuleScope "Handlers" {
         Context "When given a valid properties object" {
 
             It "Should return a string when no parameters are passed" {
-
+                Mock Get-VstsTaskVariable { return "default-string" }
                 $Property = Get-SchemaProperty -PropertyObject $SchemaObject.Properties["PaymentsString"]
                 $Property | Should BeOfType [string]
                 Assert-MockCalled -CommandName Get-VstsTaskVariable -Times 1
             }
 
             It "Should return an int when -AsInt is passed" {
-
+                Mock Get-VstsTaskVariable { return "1" }
                 $Property = Get-SchemaProperty -PropertyObject $SchemaObject.Properties["PaymentsInt"] -AsInt
                 $Property | Should BeOfType [int]
-                Assert-MockCalled -CommandName Get-VstsTaskVariable -ParameterFilter { $AsInt -eq $true } -Times 1
+                Assert-MockCalled -CommandName Get-VstsTaskVariable -Times 1
             }
 
             It "Should return a decimal when -AsNumber is passed" {
-
                 Mock Get-VstsTaskVariable { return "1.0" }
                 $Property = Get-SchemaProperty -PropertyObject $SchemaObject.Properties["PaymentsNumber"] -AsNumber
                 $Property | Should BeOfType [decimal]
                 Assert-MockCalled -CommandName Get-VstsTaskVariable -Times 1
             }
 
             It "Should return an array when -AsArray is passed" {
-
                 Mock Get-VstsTaskVariable { return "['one','two','three']" }
                 $Property = Get-SchemaProperty -PropertyObject $SchemaObject.Properties["PaymentsArray"] -AsArray
                 $Property.GetType().BaseType.Name | Should Be 'Array'
                 Assert-MockCalled -CommandName Get-VstsTaskVariable -Times 1
             }
 
             It "Should return an bool when -AsBool is passed" {
-
+                Mock Get-VstsTaskVariable { return "True" }
                 $Property = Get-SchemaProperty -PropertyObject $SchemaObject.Properties["PaymentsBool"] -AsBool
                 $Property | Should BeOfType [bool]
-                Assert-MockCalled -CommandName Get-VstsTaskVariable -ParameterFilter { $AsBool -eq $true } -Times 1
+                Assert-MockCalled -CommandName Get-VstsTaskVariable -Times 1
             }
 
             It "Should return the default value if no environment variable can be found and the default property is populated" {
-
                 Mock Get-VstsTaskVariable { return $null }
                 $Property = Get-SchemaProperty -PropertyObject $SchemaObject.Properties["PaymentsDefaultValue"]
                 $Property | Should Be "default-value"
                 Assert-MockCalled -CommandName Get-VstsTaskVariable -Times 5
             }
 
             It "Should throw an exception if no value can be found" {
-
                 Mock Get-VstsTaskVariable { return $null }
                 { Get-SchemaProperty -PropertyObject $SchemaObject.Properties["PaymentsString"] } | Should Throw
                 Assert-MockCalled -CommandName Get-VstsTaskVariable -Times 5