DSCResources/xVSTSAgent/xVSTSAgent.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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.

function Get-PrefixComputerName {
    param(
        [parameter(Mandatory = $true)]
        [string]$Name
    )

    "$($env:COMPUTERNAME)-$Name"
}

<#
.SYNOPSIS
    Returns the status of vsts agent installs.
.PARAMETER Name
    The name of the agent to get.
.PARAMETER AgentDirectory
    The directory to search for installed agents.
.PARAMETER Account
    Unused - the account is discovered, not dictated.
.PARAMETER AccountCredential
    Unused - not necessary for discovery.
.PARAMETER LogonCredential
    Unused - not necessary for discovery.
.PARAMETER Ensure
    Unused - not necessary for discovery.
#>

function Get-TargetResource {
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]
        $Name,

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

        [parameter(Mandatory = $false)]
        [System.String]
        $Work,

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

        [parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        $AccountCredential,

        [System.Management.Automation.PSCredential]
        $LogonCredential,

        [ValidateSet("Present", "Absent")]
        [System.String]
        $Ensure = 'Present',

        [System.Boolean]
        $PrefixComputerName = $false
    )

    if ( $PrefixComputerName ) { $Name = Get-PrefixComputerName $Name }

    $returnValue = @{ 'Name' = $Name; 'AgentDirectory' = $AgentDirectory }
    $agent = Get-VSTSAgent -NameFilter $Name -AgentDirectory $AgentDirectory
    if ( $agent ) {
        $returnValue['ServerUrl'] = $agent.ServerUrl
        $returnValue['Work'] = "$($agent.Work)"
        $returnValue['PoolId'] = "$($agent.PoolId)"
        $returnValue['Ensure'] = 'Present'
    }
    else {
        $returnValue['Ensure'] = 'Absent'
    }

    $returnValue
}

<#
.SYNOPSIS
    Installs or uninstalls the specified agent.
.PARAMETER Name
    What's the name of the agent we're concerned with?
.PARAMETER Pool
    What's the pool of the agent we're concerned with? Note, only used on install.
.PARAMETER AgentDirectory
    What directory is used for agents?
.PARAMETER Account
    What VSTS account should we be concerned with?
.PARAMETER AccountCredential
    The credential used to auth with VSTS.
.PARAMETER LogonCredential
    What credential should the agent service use?
.PARAMETER Ensure
    Should we ensure the agent exists or that it doesn't?
#>

function Set-TargetResource {
    [CmdletBinding()]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [System.String]
        $Pool = 'Default',

        [System.String]
        $DeploymentGroup = '',

        [System.String]
        $DeploymentGroupTags = '',

        [System.String]
        [string]$ProjectName = '',

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

        [parameter(Mandatory = $false)]
        [System.String]
        $Work,

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

        [parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        $AccountCredential,

        [System.Management.Automation.PSCredential]
        $LogonCredential,

        [ValidateSet("Present", "Absent")]
        [System.String]
        $Ensure = 'Present',

        [System.Boolean]
        $PrefixComputerName = $false
    )

    if ( Test-TargetResource @PSBoundParameters ) { return }

    if ( $PrefixComputerName ) { $Name = Get-PrefixComputerName $Name }

    if ( $Ensure -eq 'Present') {
        $installArgs = @{
            'Name'                  = $Name 
            'Pool'                  = $Pool
            'ServerUrl'             = $ServerUrl
            'PAT'                   = $AccountCredential.Password
            'AgentDirectory'        = $AgentDirectory
            'Replace'               = $true
            'DeploymentGroup'       = $DeploymentGroup
            'DeploymentGroupTags'   = $DeploymentGroupTags
            'ProjectName'           = $ProjectName
        }

        if ( $Work ) { $installArgs['Work'] = $Work }
        if ( $LogonCredential ) { $installArgs['LogonCredential'] = $LogonCredential }
        
        Install-VSTSAgent @installArgs
    }
    else {
        Uninstall-VSTSAgent -Name $Name -AgentDirectory $AgentDirectory -PAT $AccountCredential.Password 
    }
}

<#
.SYNOPSIS
    Test the status of the specified agent.
.PARAMETER Name
    What's the name of the agent we're concerned with?
.PARAMETER Pool
    Unused - Agent pool is not currently detectable.
.PARAMETER AgentDirectory
    What directory should we search for agents?
.PARAMETER Account
    What account should the agent use?
.PARAMETER AccountCredential
    Unused - testing does not require credentials.
.PARAMETER LogonCredential
    Unused - agent service logon user is not currently detectable.
.PARAMETER Ensure
    Should the agent be present or absent?
#>

function Test-TargetResource {
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [System.String]
        $Pool = 'Default',

        [System.String]
        $DeploymentGroup = '',

        [System.String]
        $DeploymentGroupTags = '',

        [System.String]
        [string]$ProjectName = '',

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

        [parameter(Mandatory = $false)]
        [System.String]
        $Work,

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

        [parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        $AccountCredential,

        [System.Management.Automation.PSCredential]
        $LogonCredential,

        [ValidateSet("Present", "Absent")]
        [System.String]
        $Ensure = 'Present',

        [System.Boolean]
        $PrefixComputerName = $false
    )

    if ( $PrefixComputerName ) { $Name = Get-PrefixComputerName $Name }

    $agent = Get-VSTSAgent -NameFilter $Name -AgentDirectory $AgentDirectory -Verbose

    switch ($Ensure) {
        'Present' {
            if ( -not $agent ) { return $false }

            Write-Verbose "Found agent pointed to $($agent.ServerUrl) and working from $($agent.Work)"
            if ( $agent.ServerUrl -ne $ServerUrl ) {
                Write-Verbose "ServerUrl mismatch: $($agent.ServerUrl) -ne $ServerUrl"
                return $false 
            }
            if ( $Work -and $agent.Work -ne $Work ) { 
                Write-Verbose "Work folder mismatch: $($agent.Work) -ne $Work"
                return $false 
            }
            # TODO: Get back to pool name from $agent.PoolId.

            Write-Verbose "VSTS Agent is Present"
            return $true
        }
        'Absent' { 
            if ( $agent ) { 
                Write-Verbose "Found agent pointed to $($agent.ServerUrl) and working from $($agent.Work)"
                return $false
            } 

            Write-Verbose "VSTS Agent is Absent"
            return $true
        }
    }
}


Export-ModuleMember -Function *-TargetResource