lib/AssetOptions.ps1

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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
## TM Dependency Type
function Get-TMDependencyType {
    param(
        [Parameter(Mandatory = $false)]
        [String]$TMSession = "Default",

        [Parameter(Mandatory = $false)]
        [String]$Server = $global:TMSessions[$TMSession].TMServer,

        [Parameter(Mandatory = $false)]
        $AllowInsecureSSL = $global:TMSessions[$TMSession].AllowInsecureSSL,

        [Parameter(Mandatory = $false,
            Position = 1,
            ParameterSetName = 'ByType')]
        [String]$Name,

        [Parameter(Mandatory = $false)]
        [Switch]$ResetIDs
    )

    Get-TMAssetOption -TMSession $TMSession -Type 'Dependency Type' -Name $Name -ResetIDs:$ResetIDs
}


function New-TMDependencyType {
    param(
        [Parameter(Mandatory = $false)]
        [String]$TMSession = "Default",

        [Parameter(Mandatory = $false)]
        [String]$Server = $global:TMSessions[$TMSession].TMServer,

        [Parameter(Mandatory = $false)]
        $AllowInsecureSSL = $global:TMSessions[$TMSession].AllowInsecureSSL,

        [Parameter(Mandatory = $true)]
        [TMDependencyType]$DependencyType
    )

    New-TMAssetOption -TMSession $TMSession -InputObject $DependencyType -Type 'Dependency Type'
}


function Get-TMAssetOption {
    <#
    .SYNOPSIS
    Retrieves one or more Asset Options from a TransitionManager instance

    .DESCRIPTION
    This function will retrieve one or more Asset Options (Asset Environment, Asset Plan Status,
    Asset Priority, Dependency Type, Dependency Status, Asset Type, Task Category) from
    the specified TransitionManager instance

    .PARAMETER TMSession
    The name of the TM Session to use when retrieving the Asset Option

    .PARAMETER Server
    The URI of the TransitionManager instance

    .PARAMETER AllowInsecureSSL
    Switch indicating that insecure SSL may be used

    .PARAMETER Type
    The type of TransitionManager Asset Option to retrieve

    .PARAMETER Name
    The Name/Label of the Asset Option

    .PARAMETER ResetIDs
    Switch indicating that the Asset Option(s) should be returned with IDs set to null

    .EXAMPLE
    Get-TMAssetOption -TMSession 'tmddev' -Type 'Task Category' -Name 'general'

    .EXAMPLE
    Get-TMAssetOption

    .EXAMPLE
    Get-TMAssetOption -Type 'Dependency Type'

    .OUTPUTS
    One or more TMAssetOption class objects
    #>


    [OutputType([TMAssetOption[]])]
    [CmdletBinding(DefaultParameterSetName = 'All')]
    param(
        [Parameter(Mandatory = $false)]
        [String]$TMSession = "Default",

        [Parameter(Mandatory = $false)]
        [String]$Server = $global:TMSessions[$TMSession].TMServer,

        [Parameter(Mandatory = $false)]
        $AllowInsecureSSL = $global:TMSessions[$TMSession].AllowInsecureSSL,

        [Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'All')]
        [Parameter(Mandatory = $true,
            Position = 0,
            ParameterSetName = 'ByType')]
        [ValidateSet(
            'Asset Environment',
            'Asset Plan Status',
            'Asset Priority',
            'Dependency Type',
            'Dependency Status',
            'App Type',
            'Asset Type',
            'App Type',
            'Task Category')]
        [String]$Type,

        [Parameter(Mandatory = $false,
            Position = 1,
            ParameterSetName = 'ByType')]
        [String]$Name,

        [Parameter(Mandatory = $false)]
        [Switch]$ResetIDs
    )

    begin {

        Import-Module PowerHTML

        ## Get Session Configuration
        $TMSessionConfig = $global:TMSessions[$TMSession]
        if (-not $TMSessionConfig) {
            throw "TM Session Not Found. Use New-TMSession command before using features."
        }

        $Instance = $Server.Replace('/tdstm', '').Replace('https://', '').Replace('http://', '')
        $Uri = "https://$instance/tdstm/assetEntity/assetOptions"

        $WebRequestSplat = @{
            Method               = 'GET'
            Uri                  = $Uri
            WebSession           = $TMSessionConfig.TMWebSession
            SkipCertificateCheck = $AllowInsecureSSL
        }

        # Make the request
        try {
            Write-Verbose "Web Request Parameters:"
            Write-Verbose ($WebRequestSplat | ConvertTo-Json -Depth 10)
            Write-Verbose "Invoking web request"
            $Response = Invoke-WebRequest @WebRequestSplat
            Write-Verbose "Response status code: $($Response.StatusCode)"
            Write-Verbose "Response Content: $($Response.Content)"
        }
        catch {
            throw $_
        }

        if ($Response.StatusCode -in 200, 204) {
            $AssetOptions = @{}
            $HTML = ConvertFrom-Html -Content $response.Content -Raw
            $AssetTypes = @(
                @{Element = 'planStatusTbodyId'; Class = 'TMAssetPlanStatus' }
                @{Element = 'priorityStatusTbodyId'; Class = 'TMAssetPriority' }
                @{Element = 'dependencyTypeTbodyId'; Class = 'TMDependencyType' }
                @{Element = 'dependencyStatusTbodyId'; Class = 'TMDependencyStatus' }
                @{Element = 'envOptionTbodyId'; Class = 'TMAssetEnvironment' }
                @{Element = 'appTypeTbodyId'; Class = 'TMAppType' }
                @{Element = 'assetTypeTbodyId'; Class = 'TMAssetType' }
                @{Element = 'taskCategoryTbodyId'; Class = 'TMTaskCategory' }
            )
            foreach ($AssetType in $AssetTypes) {
                $Result = [System.Collections.ArrayList]::new()
                $TableBody = $HTML.DocumentNode.SelectNodes("//*[contains(@id, '$($AssetType.Element)')]")
                $ChildNodes = $AssetType.Element -eq 'appTypeTableId' ? $TableBody.ChildNodes[3].ChildNodes : $TableBody.ChildNodes
                foreach ($Node in $ChildNodes) {
                    if ($Node.Attributes.Count -gt 0) {
                        if ($Node.Attributes[0].Name -eq 'id') {
                            $TypeId = $ResetIDs.IsPresent ? $null : $Node.Attributes[0].Value.Split("_")[1]
                            $TypeName = $Node.ChildNodes[1].innerText
                            $AssetOption = New-Object -TypeName $AssetType.Class -ArgumentList $TypeId, $TypeName
                            [void]$Result.Add($AssetOption)
                        }
                    }
                }

                $AssetOptions.Add($AssetType.Element.Replace('TbodyId', '').Replace('TableId', ''), $Result)
            }
        }
        else {
            throw "Unable to get Asset Options"
        }
    }

    process {
        if ($Type) {
            $AssetOptions = switch ($Type) {
                'Asset Environment' { $AssetOptions.envOption }
                'Asset Plan Status' { $AssetOptions.planStatus }
                'Asset Priority' { $AssetOptions.priorityStatus }
                'Dependency Type' { $AssetOptions.dependencyType }
                'Dependency Status' { $AssetOptions.dependencyStatus }
                'App Type' { $AssetOptions.appType }
                'Asset Type' { $AssetOptions.assetType }
                'Task Category' { $AssetOptions.taskCategory }
            }

            if ($Name) {
                $AssetOptions = $AssetOptions | Where-Object { $_.label -eq $Name }
            }
        }

        ## Reset IDs
        if ($ResetIDs) {
            for ($i = 0; $i -lt $AssetOptions.Count; $i++) {
                $AssetOptions[$i].id = $null
            }
        }

        $AssetOptions = $AssetOptions | Sort-Object -Property 'label'
        $AssetOptions
    }
}


function New-TMAssetOption {
    <#
    .SYNOPSIS
    Creates a new Asset Option in TransitionManager

    .DESCRIPTION
    This function will create a new Asset Option (Asset Environment, Asset Plan Status,
    Asset Priority, Dependency Type, Dependency Status, Asset Type, Task Category) on
    the specified TransitionManager instance

    .PARAMETER TMSession
    The name of the TM Session to use when creating the Asset Option

    .PARAMETER Server
    The URI of the TransitionManager instance

    .PARAMETER AllowInsecureSSL
    Switch indicating that insecure SSL may be used

    .PARAMETER Type
    The type of TransitionManager Asset Option to create

    .PARAMETER Name
    The Name/Label of the Asset Option

    .PARAMETER InputObject
    A TMAssetOption object representing the Asset Option to create

    .PARAMETER Passthru
    Switch indicating that the newly created Asset Option should be returned

    .EXAMPLE
    New-TMAssetOption -TMSession 'tdsmd06' -Type 'Asset Priority' -Name 'Critical' -Passthru

    .EXAMPLE
    $AssetType = [TMAssetType]::new('Server')
    New-TMAssetOption -InputObject $AssetType

    .EXAMPLE
    New-TMSession -ProfileName 'tmddev'
    New-TMSession -ProfileName 'tmddev2'
    Get-TMAssetOption -TMSession 'tmddev' -Type 'Asset Plan Status' | New-TMAssetOption -TMSession 'tmddev2'

    .OUTPUTS
    A TMAssetOption object if the Passthru switch is used, otherwise nothing
    #>


    [CmdletBinding(DefaultParameterSetName = 'ByProperty')]
    param(
        [Parameter(Mandatory = $false)]
        [String]$TMSession = "Default",

        [Parameter(Mandatory = $false)]
        [String]$Server = $global:TMSessions[$TMSession].TMServer,

        [Parameter(Mandatory = $false)]
        $AllowInsecureSSL = $global:TMSessions[$TMSession].AllowInsecureSSL,

        [Parameter(Mandatory = $true, Position = 0)]
        [ValidateSet(
            'Asset Environment',
            'Asset Plan Status',
            'Asset Priority',
            'Dependency Type',
            'Dependency Status',
            'App Type',
            'Asset Type',
            'App Type',
            'Task Category')]
        [String]$Type,

        [Parameter(Mandatory = $true,
            Position = 1,
            ParameterSetName = 'ByProperty')]
        [Alias('Label')]
        [String]$Name,

        [Parameter(Mandatory = $true,
            ValueFromPipeline = $true,
            ParameterSetName = 'ByObject')]
        [TMAssetOption]$InputObject,

        [Parameter(Mandatory = $false)]
        [Switch]$Passthru
    )

    begin {
        ## Get Session Configuration
        $TMSessionConfig = $global:TMSessions[$TMSession]
        if (-not $TMSessionConfig) {
            throw "TM Session Not Found. Use New-TMSession command before using features."
        }

        $Instance = $Server.Replace('/tdstm', '').Replace('https://', '').Replace('http://', '')
        $Uri = "https://$instance/tdstm/assetEntity/saveAssetoptions"

        Set-TMHeaderContentType -ContentType 'Form' -TMSession $TMSession
    }

    process {
        if ($PSCmdlet.ParameterSetName -eq 'ByObject') {
            $Type = switch ($InputObject.GetType().Name) {
                'TMAssetEnvironment' { 'Asset Environment' }
                'TMAssetPlanStatus' { 'Asset Plan Status' }
                'TMAssetPriority' { 'Asset Priority' }
                'TMDependencyType' { 'Dependency Type' }
                'TMDependencyStatus' { 'Dependency Status' }
                'TMAssetType' { 'App Type' }
                'TMAssetType' { 'Asset Type' }
                'TMTaskCategory' { 'Task Category' }
                default {
                    Write-Error "The type of Asset Option could not be determined"
                    return
                }
            }
            $Name = $InputObject.label
        }

        switch ($Type) {
            'Asset Environment' { $Class = 'TMAssetEnvironment'; $PostBody = @{environment = $Name; assetOptionType = 'environment' } }
            'Asset Plan Status' { $Class = 'TMAssetPlanStatus'; $PostBody = @{planStatus = $Name; assetOptionType = 'planStatus' } }
            'Asset Priority' { $Class = 'TMAssetPriority'; $PostBody = @{priorityOption = $Name; assetOptionType = 'Priority' } }
            'Dependency Type' { $Class = 'TMDependencyType'; $PostBody = @{dependencyType = $Name; assetOptionType = 'dependency' } }
            'Dependency Status' { $Class = 'TMDependencyStatus'; $PostBody = @{dependencyStatus = $Name; assetOptionType = 'dependencyStatus' } }
            'App Type' { $Class = 'TMAppType'; $PostBody = @{appType = $Name; assetOptionType = 'appType' } }
            'Asset Type' { $Class = 'TMAssetType'; $PostBody = @{assetType = $Name; assetOptionType = 'assetType' } }
            'Task Category' { $Class = 'TMTaskCategory'; $PostBody = @{taskCategory = $Name; assetOptionType = 'taskCategory' } }
        }

        $WebRequestSplat = @{
            Method               = 'POST'
            Uri                  = $Uri
            WebSession           = $TMSessionConfig.TMWebSession
            SkipCertificateCheck = $AllowInsecureSSL
            Body                 = $PostBody
        }

        # Make the request
        try {
            Write-Verbose "Web Request Parameters:"
            Write-Verbose ($WebRequestSplat | ConvertTo-Json -Depth 10)
            Write-Verbose "Invoking web request"
            $Response = Invoke-WebRequest @WebRequestSplat
            Write-Verbose "Response status code: $($Response.StatusCode)"
            Write-Verbose "Response Content: $($Response.Content)"
        }
        catch {
            throw $_
        }

        if ($Response.StatusCode -in 200, 204) {
            $ResponseContent = $Response.Content | ConvertFrom-Json
            if ($ResponseContent.status -eq "error") {
                if ($ResponseContent.errors[0] -notlike 'Property value with value * must be unique') {
                    Write-Error $ResponseContent.errors[0]
                }
            }
            elseif ($Passthru) {
                New-Object -TypeName $Class -ArgumentList $ResponseContent.id, $Name
            }
        }
    }
}


function Remove-TMAssetOption {
    <#
    .SYNOPSIS
    Deletes an Asset Option from TransitionManager

    .DESCRIPTION
    This function will delete an Asset Option (Asset Environment, Asset Plan Status,
    Asset Priority, Dependency Type, Dependency Status, Asset Type, Task Category) from
    the specified TransitionManager instance

    .PARAMETER TMSession
    The name of the TM Session to use when deleting the Asset Option

    .PARAMETER Server
    The URI of the TransitionManager instance

    .PARAMETER AllowInsecureSSL
    Switch indicating that insecure SSL may be used

    .PARAMETER Type
    The type of TransitionManager Asset Option to delete

    .PARAMETER Name
    The NAme of the Asset Option to delete

    .PARAMETER Id
    The Id of the Asset Option to delete

    .PARAMETER InputObject
    A TMAssetOption object representing the Asset Option to remove

    .EXAMPLE
    Get-TMAssetOption -Type 'Asset Environment' | Remove-TMAssetOption

    .EXAMPLE
    Remove-TMAssetOption -TMSession 'tmddev' -Type 'Dependency Type' -Name 'A2A'

    .OUTPUTS
    None
    #>


    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $false)]
        [String]$TMSession = "Default",

        [Parameter(Mandatory = $false)]
        [String]$Server = $global:TMSessions[$TMSession].TMServer,

        [Parameter(Mandatory = $false)]
        $AllowInsecureSSL = $global:TMSessions[$TMSession].AllowInsecureSSL,

        [Parameter(Mandatory = $true,
            Position = 0,
            ParameterSetName = 'ByName')]
        [Parameter(Mandatory = $true,
            Position = 0,
            ParameterSetName = 'ById')]
        [ValidateSet(
            'Asset Environment',
            'Asset Plan Status',
            'Asset Priority',
            'Dependency Type',
            'Dependency Status',
            'Asset Type',
            'App Type',
            'Task Category')]
        [String]$Type,

        [Parameter(Mandatory = $true,
            Position = 1,
            ParameterSetName = 'ByName')]
        [Alias('Label')]
        [String]$Name,

        [Parameter(Mandatory = $true,
            Position = 1,
            ParameterSetName = 'ById')]
        [String]$Id,

        [Parameter(Mandatory = $true,
            ValueFromPipeline = $true,
            ParameterSetName = 'ByObject')]
        [TMAssetOption]$InputObject
    )

    begin {
        ## Get Session Configuration
        $TMSessionConfig = $global:TMSessions[$TMSession]
        if (-not $TMSessionConfig) {
            throw "TM Session Not Found. Use New-TMSession command before using features."
        }

        $Instance = $Server.Replace('/tdstm', '').Replace('https://', '').Replace('http://', '')
        $Uri = "https://$instance/tdstm/assetEntity/deleteAssetOptions"

        Set-TMHeaderContentType -ContentType 'Form' -TMSession $TMSession
    }

    process {
        if ($PSCmdlet.ParameterSetName -eq 'ByObject') {
            $Type = switch ($InputObject.GetType().Name) {
                'TMAssetEnvironment' { 'Asset Environment' }
                'TMAssetPlanStatus' { 'Asset Plan Status' }
                'TMAssetPriority' { 'Asset Priority' }
                'TMDependencyType' { 'Dependency Type' }
                'TMDependencyStatus' { 'Dependency Status' }
                'TMAssetType' { 'Asset Type' }
                'TMTaskCategory' { 'Task Category' }
            }
            $Name = $InputObject.label
            $Id = $InputObject.id
        }

        # Get the Id if it wasn't provided
        if (($null -eq $Id) -or ($Id -le 0)) {
            $AssetOption = Get-TMAssetOption -TMSession $TMSession -Type $Type -Name $Name
            if ($AssetOption) {
                $Id = $AssetOption.id
            }
            else {
                # There is no asset option, so there's nothing to remove
                return
            }
        }

        # Format the request form body
        $PostBody = switch ($Type) {
            'Asset Environment' { @{ environmentId = $Id; assetOptionType = 'environment' } }
            'Asset Plan Status' { @{ assetStatusId = $Id; assetOptionType = 'planStatus' } }
            'Asset Priority' { @{ priorityId = $Id; assetOptionType = 'Priority' } }
            'Dependency Type' { @{ dependecyId = $Id; assetOptionType = 'dependency' } }
            'Dependency Status' { @{ dependecyId = $Id; assetOptionType = 'dependencyStatus' } }
            'Asset Type' { @{ assetTypeId = $Id; assetOptionType = 'assetType' } }
            'Task Category' { @{ taskCategoryId = $Id; assetOptionType = 'taskCategory' } }
        }

        # Format the web request
        $WebRequestSplat = @{
            Method               = 'POST'
            Uri                  = $Uri
            WebSession           = $TMSessionConfig.TMWebSession
            SkipCertificateCheck = $AllowInsecureSSL
            Body                 = $PostBody
        }

        # Make the web request
        try {
            Write-Verbose "Web Request Parameters:"
            Write-Verbose ($WebRequestSplat | ConvertTo-Json -Depth 10)
            Write-Verbose "Invoking web request"
            $Response = Invoke-WebRequest @WebRequestSplat
            Write-Verbose "Response status code: $($Response.StatusCode)"
            Write-Verbose "Response Content: $($Response.Content)"
        }
        catch {
            Write-Error $_
        }

        # Process the response
        if ($Response.StatusCode -in 200, 204) {
            $ResponseContent = $Response.Content | ConvertFrom-Json
            if ($ResponseContent.status -eq "error") {
                Write-Error $ResponseContent.errors[0]
            }
        }
    }
}