(GH-61) Fix choco install package result

DSCResources/cChocoPackageInstall/cChocoPackageInstall.psm1

@@ -1,5 +1,4 @@
-# Copyright (c) 2017 Chocolatey Software, Inc.
-# Copyright (c) 2013 - 2017 Lawrence Gripper & original authors/contributors from https://github.com/chocolatey/cChoco
+# Copyright (c) 2013 - 2017 Lawrence Gripper & original authors/contributors from https://github.com/chocolatey/cChoco
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -91,26 +90,26 @@ function Set-TargetResource
             $whatIfShouldProcess = $pscmdlet.ShouldProcess("$Name", 'Remove Chocolatey package')
             if ($whatIfShouldProcess) {
                 Write-Verbose -Message "Removing $Name as ensure is set to absent"
-                UninstallPackage -pName $Name -pParams $Params
+                UninstallPackage -pName $Name -arguments $Params
             }
         } else {
             $whatIfShouldProcess = $pscmdlet.ShouldProcess("$Name", 'Installing / upgrading package from Chocolatey')
             if ($whatIfShouldProcess) {
                 if ($Version) {
                     Write-Verbose -Message "Uninstalling $Name due to version mis-match"
-                    UninstallPackage -pName $Name -pParams $Params
+                    UninstallPackage -pName $Name -arguments $Params
                     Write-Verbose -Message "Re-Installing $Name with correct version $version"
-                    InstallPackage -pName $Name -pParams $Params -pVersion $Version -pSource $Source -cParams $chocoParams
+                    InstallPackage -pName $Name -arguments $Params -pVersion $Version -pSource $Source -cParams $chocoParams
                 } elseif ($AutoUpgrade) {
                     Write-Verbose -Message "Upgrading $Name due to version mis-match"
-                    Upgrade-Package -pName $Name -pParams $Params -pSource $Source
+                    Upgrade-Package -pName $Name -arguments $Params -pSource $Source
                 }
             }
         }
     } else {
         $whatIfShouldProcess = $pscmdlet.ShouldProcess("$Name", 'Install package from Chocolatey')
         if ($whatIfShouldProcess) {
-            InstallPackage -pName $Name -pParams $Params -pVersion $Version -pSource $Source -cParams $chocoParams
+            InstallPackage -pName $Name -arguments $Params -pVersion $Version -pSource $Source -cParams $chocoParams
         }
     }
 }
@@ -240,13 +239,9 @@ function InstallPackage
         $chocoinstallparams += " $cParams"
     }
     Write-Verbose -Message "Install command: 'choco install $pName $chocoinstallparams'"
-
-    $packageInstallOuput = Invoke-Expression -Command "choco install $pName $chocoinstallparams"
+    $packageInstallOuput = Invoke-Chocolatey "install $pName $chocoinstallparams"
     Write-Verbose -Message "Package output $packageInstallOuput "
 
-    # Clear Package Cache
-    Get-ChocoInstalledPackage 'Purge'
-
     #refresh path varaible in powershell, as choco doesn"t, to pull in git
     $env:Path = [Environment]::GetEnvironmentVariable('Path','Machine')
 }
@@ -266,19 +261,16 @@ function UninstallPackage
     if (-not ($pParams))
     {
         Write-Verbose -Message 'Uninstalling Package Standard'
-        $packageUninstallOuput = choco uninstall $pName -y
+        $packageUninstallOuput = Invoke-Chocolatey "uninstall $pName -y"
     }
     elseif ($pParams)
     {
         Write-Verbose -Message "Uninstalling Package with params $pParams"
-        $packageUninstallOuput = choco uninstall $pName --params="$pParams" -y
+        $packageUninstallOuput = Invoke-Chocolatey "uninstall $pName --params=`"$pParams`" -y"
     }
 
     Write-Verbose -Message "Package uninstall output $packageUninstallOuput "
 
-    # Clear Package Cache
-    Get-ChocoInstalledPackage 'Purge'
-
     #refresh path varaible in powershell, as choco doesn"t, to pull in git
     $env:Path = [Environment]::GetEnvironmentVariable('Path','Machine')
 }
@@ -332,7 +324,7 @@ Function Test-LatestVersionInstalled {
 
     Write-Verbose -Message "Testing if $pName can be upgraded: 'choco upgrade $pName $chocoupgradeparams'"
 
-    $packageUpgradeOuput = Invoke-Expression -Command "choco upgrade $pName $chocoupgradeparams"
+    $packageUpgradeOuput = Invoke-Chocolatey "choco upgrade $pName $chocoupgradeparams"
     $packageUpgradeOuput | ForEach-Object {Write-Verbose -Message $_}
 
     if ($packageUpgradeOuput -match "$pName.*is the latest version available based on your source") {
@@ -345,6 +337,7 @@ Function Test-LatestVersionInstalled {
 ##attempting to work around the issues with Chocolatey calling Write-host in its scripts.
 function global:Write-Host
 {
+    [Diagnostics.CodeAnalysis.SuppressMessage('PSAvoidGlobalFunctions','')]
     Param(
         [Parameter(Mandatory, Position = 0)]
         [Object]
@@ -389,41 +382,81 @@ Function Upgrade-Package {
     if ($cParams) {
         $chocoupgradeparams += " $cParams"
     }
-    $cmd = "choco upgrade $pName $chocoupgradeparams"
+    $cmd = "upgrade $pName $chocoupgradeparams"
     Write-Verbose -Message "Upgrade command: '$cmd'"
 
     if (-not (IsPackageInstalled -pName $pName))
     {
         throw "$pName is not installed, you cannot upgrade"
     }
 
-    $packageUpgradeOuput = Invoke-Expression -Command $cmd
+    $packageUpgradeOuput = Invoke-Chocolatey $cmd
     $packageUpgradeOuput | ForEach-Object { Write-Verbose -Message $_ }
+}
 
-    # Clear Package Cache
-    Get-ChocoInstalledPackage 'Purge'
+function Get-ChocoInstalledPackage {
+     (choco list -lo -r | ConvertFrom-Csv -Header 'Name', 'Version' -Delimiter "|")
 }
 
-function Get-ChocoInstalledPackage ($action) {
-    $ChocoInstallLP = Join-Path -Path $env:ChocolateyInstall -ChildPath 'cache'
-    if ( -not (Test-Path $ChocoInstallLP)){
-        New-Item -Name 'cache' -Path $env:ChocolateyInstall -ItemType Directory | Out-Null
-    }
-    $ChocoInstallList = Join-Path -Path $ChocoInstallLP -ChildPath 'ChocoInstalled.xml'
 
-    if ($action -eq 'Purge') {
-        Remove-Item $ChocoInstallList -Force
-        $res = $true
-    } else {
-        $PackageCacheSec = (Get-Date).AddSeconds('-60')
-        if ( $PackageCacheSec -lt (Get-Item $ChocoInstallList -ErrorAction SilentlyContinue).LastWriteTime ) {
-                $res = Import-Clixml $ChocoInstallList
-        } else {
-            choco list -lo -r | ConvertFrom-Csv -Header 'Name', 'Version' -Delimiter "|" -OutVariable res | Export-Clixml -Path $ChocoInstallList
-        }
-    }
+<#
+.Synopsis
+   Run chocolatey executable and throws error on failure
+.DESCRIPTION
+   Run chocolatey executable and throws error on failure
+.EXAMPLE
+   Invoke-Chocolatey "list -lo"
+.EXAMPLE
+   Invoke-Chocolatey -arguments "list -lo"
+#>
+function Invoke-Chocolatey
+{
+    [CmdletBinding()]
+    Param
+    (
+        # chocolatey arguments."
+        [Parameter(Position=0)]
+        [string]$arguments
+    )
 
-    Return $res
+    [int[]]$validExitCodes =  $(
+                0,    #most widely used success exit code
+                1605, #(MSI uninstall) - the product is not found, could have already been uninstalled
+                1614, #(MSI uninstall) - the product is uninstalled
+                1641, #(MSI) - restart initiated
+                3010  #(MSI, InnoSetup can be passed to provide this) - restart required
+            )
+    Write-Verbose -Message "command: 'choco $arguments'" 
+
+    $pinfo = New-Object System.Diagnostics.ProcessStartInfo
+    $pinfo.FileName = "choco"
+    $pinfo.RedirectStandardError = $true
+    $pinfo.RedirectStandardOutput = $true
+    $pinfo.UseShellExecute = $false
+    $pinfo.Arguments = "$arguments"
+
+    $p = New-Object System.Diagnostics.Process
+    $p.StartInfo = $pinfo
+    $p.Start() | Out-Null
+
+    $output = $p.StandardOutput.ReadToEnd()
+    $p.WaitForExit()
+    $exitcode = $p.ExitCode
+    $p.Dispose()
+
+    #Set $LASTEXITCODE variable.
+    powershell.exe   -NoLogo -NoProfile -Noninteractive "exit $exitcode"
+
+    if($exitcode -in $validExitCodes )
+    {
+        $output.Split("`n")
+        $outputdata
+    }
+    else
+    { 
+        #when error, throw output as error, contains errormessage
+        throw "Error: chocolatey command failed with exit code $exitcode.`n$output" 
+    }       
 }
 
 Export-ModuleMember -Function *-TargetResource

Tests/cChocoPackageInstall_Tests.ps1

@@ -122,6 +122,18 @@ Describe -Name "Testing $ResourceName loaded from $ResourceFile" -Fixture {
             Test-TargetResource @Scenario4 | Should Be $False
         }
     }
+
+    Context -Name "Package cannot be found" -Fixture {
+
+        $Scenario1 = @{
+            Name = 'NonExistendPackage'
+            Ensure = 'Present'
+        }
+        It -name "Set-TargeResource -ensure 'present' should throw" -test {
+            { Set-TargetResource @Scenario1 } | Should throw
+        }
+
+    }
 }
 
 #Clean-up