DscResources/ChocolateyPackage/ChocolateyPackage.psm1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
function Get-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param
    (
        [parameter(Mandatory = $true)]
        [ValidateSet("Present","Absent")]
        [System.String]
        $Ensure,

        [parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [parameter(Mandatory = $true)]
        [System.String]
        $Version,

        [Microsoft.Management.Infrastructure.CimInstance[]]
        $ChocolateyOptions
    )
    
    $Env:Path = [Environment]::GetEnvironmentVariable('Path','Machine')
    Write-Verbose "Converting CIMInstance[] to hashtable"
    $ChocoOptions = Convert-CimInstancesToHashtable $ChocolateyOptions

    Import-Module $PSScriptRoot\..\..\Chocolatey.psd1 -verbose:$False
    $TestParams = @{
        Name = $Name
    }
    if($Version) { $TestParams.Add('Version',$Version) }
    foreach ($Option in $ChocoOptions.keys) {
        if(!$TestParams.ContainsKey($Option) -and
            $option -in (Get-Command Test-ChocolateyPackageIsInstalled).Parameters.keys) {
            $null = $TestParams.Add($option,$ChocoOptions[$Option])
        }
    }
    
    $InstalledPackage = Test-ChocolateyPackageIsInstalled @TestParams
    
    $returnValue = @{
        Ensure = @('Absent','Present')[[int]$InstalledPackage.VersionGreaterOrEqual]
        Name = $Name
        Version = $Version
    }

    $returnValue
}


function Set-TargetResource
{
    [CmdletBinding()]
    param
    (
        [parameter(Mandatory = $true)]
        [ValidateSet("Present","Absent")]
        [System.String]
        $Ensure,

        [parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [parameter(Mandatory = $true)]
        [System.String]
        $Version,

        [Microsoft.Management.Infrastructure.CimInstance[]]
        $ChocolateyOptions,

        [System.Boolean]
        $UpdateOnly
    )

    Begin {
        $Env:Path = [Environment]::GetEnvironmentVariable('Path','Machine')
        Write-Verbose "Converting CIMInstance[] to hashtable"
        $ChocoOptions = Convert-CimInstancesToHashtable $ChocolateyOptions
    }

    Process {
        Import-Module $PSScriptRoot\..\..\Chocolatey.psd1 -verbose:$False
        
        $TestParams = @{
            Name = $Name
        }
        if($Version) { $TestParams.Add('Version',$Version) }
        foreach ($Option in $ChocoOptions.keys) {
            if(!$TestParams.ContainsKey($Option) -and
                $option -in (Get-Command Test-ChocolateyPackageIsInstalled).Parameters.keys) {
                $null = $TestParams.Add($option,$ChocoOptions[$Option])
            }
        }

        $testResult = Test-ChocolateyPackageIsInstalled @TestParams
        $ChocoCommand = switch ($Ensure) {
            'Present' {
                if($testResult.PackagePresent -and !$testResult.VersionGreaterOrEqual) {
                    Get-Command Update-ChocolateyPackage 
                }
                elseif(!$UpdateOnly) {
                    Get-Command Install-ChocolateyPackage 
                }
                else {
                    Write-Verbose "Nothing to do: UpdateOnly : $UpdateOnly"
                    return
                }
                 
            }
            'Absent'  { Get-Command Uninstall-ChocolateyPackage }
        }
        Write-Verbose "$($ChocoCommand.Name) ``"
        Write-Verbose "`t -Name $Name)"
        Write-Verbose "`t -Confirm `$False)"
        Write-Verbose "`t -NoProgress `$true)"
        $ChocoCommandParams = @{
            Name = $Name
            Confirm = $False
            NoProgress = $true
        }
        if ($Version -and $Version -ne 'latest') { $ChocoCommandParams.Add('Version',$Version) }

        #Allow merge but no overrides
        foreach ($ChocoOptionName in $ChocoOptions.Keys) {
            if (
                !$ChocoCommandParams.ContainsKey($ChocoOptionName) -and
                $ChocoCommand.Parameters.ContainsKey($ChocoOptionName)
            )
            {
                Write-Verbose "`t -$ChocoOptionName $($ChocoOptions[$ChocoOptionName])"
                $ChocoCommandParams.Add($ChocoOptionName,$ChocoOptions[$ChocoOptionName])
            }
        }
        Write-Verbose "Starting the Execution..."
        &$ChocoCommand @ChocoCommandParams -verbose | Write-Verbose
    }
}

function Test-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [parameter(Mandatory = $true)]
        [ValidateSet("Present","Absent")]
        [System.String]
        $Ensure,

        [parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [parameter(Mandatory = $true)]
        [System.String]
        $Version,

        [Microsoft.Management.Infrastructure.CimInstance[]]
        $ChocolateyOptions,

        [System.Boolean]
        $UpdateOnly
    )
    
    Write-Verbose "Converting CIMInstance[] to hashtable"
    $ChocoOptions = Convert-CimInstancesToHashtable $ChocolateyOptions

    $Env:Path = [Environment]::GetEnvironmentVariable('Path','Machine')
    Import-Module $PSScriptRoot\..\..\Chocolatey.psd1 -verbose:$False

    $TestParams = @{
        Name = $Name
    }
    #Not decided whether Version should be mandatory or not
    if($Version) { $TestParams.Add('Version',$Version) }
    foreach ($Option in $ChocoOptions.keys) {
        if(!$TestParams.ContainsKey($Option) -and
            $option -in (Get-Command Test-ChocolateyPackageIsInstalled).Parameters.keys) {
            $null = $TestParams.Add($option,$ChocoOptions[$Option])
        }
    }

    $EnsureResultMap = @{
        'Present'=$true
        'Absent'=$false
    }
    Write-Verbose "Testing whether the Package $Name is Installed"
    return ($EnsureResultMap[$Ensure] -eq (Test-ChocolateyPackageIsInstalled @TestParams).VersionGreaterOrEqual)

}


Export-ModuleMember -Function *-TargetResource

#As per Dave Wyatt's : https://powershell.org/forums/topic/hashtable-as-parameter-for-custom-dsc-resource/
function Convert-CimInstancesToHashtable([Microsoft.Management.Infrastructure.CimInstance[]] $Pairs)
{
    Write-Verbose ">> Converting CIM Pairs"
    $hash = @{}
    foreach ($pair in $Pairs)
    {
        $hash[$pair.Key] = $pair.Value
    }
    return $hash
}