Xester.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
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
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
Write-Verbose 'Importing from [C:\projects\xester\Xester\private]'
# .\Xester\private\Get-TestRunSet.ps1
function Get-TestRunSet {
    <#
    .DESCRIPTION
        This function will Gather TestRun data.
    .PARAMETER RestServer
        A Rest Server is required.
    .PARAMETER TestRunId
        A TestRunId Id is optional.
    .PARAMETER StatusId
        A StatusId Id is optional.
    .PARAMETER TestRun_Manager_ID
        A StatusId Id is optional.
    .EXAMPLE
        Get-TestRunSet -RestServer localhost -TestRunId 1
    .EXAMPLE
        Get-TestRunSet -RestServer localhost -StatusId 1
    .EXAMPLE
        Get-TestRunSet -RestServer localhost -TestRun_Manager_ID 1
    .NOTES
        This will return a hashtable of data from the database.
    #>

    [CmdletBinding(
        SupportsShouldProcess = $true,
        ConfirmImpact = "Low"
    )]
    [OutputType([hashtable])]
    [OutputType([Boolean])]
    param(
        [Parameter(Mandatory=$true)][string]$RestServer,
        [Parameter(Mandatory=$false)][int]$TestRunId,
        [Parameter(Mandatory=$false)][int]$StatusId,
        [Parameter(Mandatory=$false)][int]$TestRun_Manager_ID
    )
    begin {
        if ($TestRunId){
            # Filter on the TestRunId
            $Url = "/testrun?filter=ID,eq,$TestRunId&transform=true"
        } elseif ($StatusId){
            # Filter on the STATUS_ID
            $Url = "/testrun?filter=STATUS_ID,eq,$StatusId&transform=true"
        } elseif ($TestRun_Manager_ID) {
            # Filter on the TestRun_Manager_ID
            $Url = "/testrun?filter=TestRun_Manager_ID,eq,$TestRun_Manager_ID&transform=true"
        } else {
            # No Filter
            $Url = "/testrun?transform=true"
        }
    }
    process
    {
        if ($pscmdlet.ShouldProcess("Get-TestRunSet"))
        {
            try
            {
                Write-Log -Message "Gathering TestRun Data" -MsgType DEBUG -Logfile $Logfile -LogLevel $LogLevel
                # Make the rest call to Get the data
                Invoke-XesterRestCall -RestServer $RestServer -URI "$Url" -Method Get
            }
            catch
            {
                $ErrorMessage = $_.Exception.Message
                $FailedItem = $_.Exception.ItemName
                Throw "Get-TestRunSet: $ErrorMessage $FailedItem"
            }
        }
        else
        {
            # -WhatIf was used.
            return $false
        }
    }
}
# .\Xester\private\Get-TmanData.ps1
function Get-TmanData {
    <#
    .DESCRIPTION
        This function will Gather TestRun data.
    .PARAMETER RestServer
        A Rest Server is required.
    .PARAMETER StatusId
        A StatusId Id is optional.
    .EXAMPLE
        Get-TmanData -RestServer localhost -StatusId 2
    .NOTES
        This will return a hashtable of data from the database.
    #>

    [CmdletBinding(
        SupportsShouldProcess = $true,
        ConfirmImpact = "Low"
    )]
    [OutputType([hashtable])]
    [OutputType([Boolean])]
    param(
        [Parameter(Mandatory=$true)][string]$RestServer,
        [Parameter(Mandatory=$false)][int]$StatusId
    )
    begin {
        if ($StatusId){
            # Filter on the STATUS_ID
            $Url = "/testrun_manager?filter=STATUS_ID,eq,$StatusId&transform=true"
        } else {
            # No Filter
            $Url = "/testrun_manager?transform=true"
        }
    }
    process
    {
        if ($pscmdlet.ShouldProcess("Get-TmanData"))
        {
            try
            {
                Write-Log -Message "Gathering TestRun Manager Data" -MsgType DEBUG -Logfile $Logfile -LogLevel $LogLevel
                # Make the rest call to Get the data
                Invoke-XesterRestCall -RestServer $RestServer -URI "$Url" -Method Get
            }
            catch
            {
                $ErrorMessage = $_.Exception.Message
                $FailedItem = $_.Exception.ItemName
                Throw "Get-TmanData: $ErrorMessage $FailedItem"
            }
        }
        else
        {
            # -WhatIf was used.
            return $false
        }
    }
}
# .\Xester\private\Get-XsTimeStamp.ps1
function Get-XsTimeStamp {
    <#
    .DESCRIPTION
        This function will return a TimeStamp.
    .PARAMETER RestServer
        A Rest Server is required.
    .EXAMPLE
        Get-XsTimeStamp
    .NOTES
        This will return a TimeStamp.
    #>

    [CmdletBinding()]
    [OutputType([string])]
    param()
    try
    {
        Get-Date -Format "MMddyyyy-HH:mm:ss"
    }
    catch
    {
        $ErrorMessage = $_.Exception.Message
        $FailedItem = $_.Exception.ItemName
        Throw "Get-XsTimeStamp: $ErrorMessage $FailedItem"
    }
}
# .\Xester\private\Update-TestRun.ps1
function Update-TestRun {
    <#
    .DESCRIPTION
        This function will Update the TestRun Data - Simple fields.
    .PARAMETER RestServer
        A Rest Server is required.
    .PARAMETER TestRunId
        A TestRunId Id is required.
    .PARAMETER Status
        A Status is required.
    .PARAMETER Result
        A Result is required.
    .PARAMETER TestRun_Manager_ID
        A TestRun_Manager_ID is required.
    .EXAMPLE
        Update-TestRun -RestServer localhost -Status 2 -TestRunId 1 -Result 2 -TestRun_Manager_ID 1
    .NOTES
        This will return a hashtable of data from the PPS database.
    #>

    [CmdletBinding(
        SupportsShouldProcess = $true,
        ConfirmImpact = "Low"
    )]
    [OutputType([hashtable])]
    [OutputType([Boolean])]
    param(
        [Parameter(Mandatory=$true)][string]$RestServer,
        [Parameter(Mandatory=$true)][int]$Status,
        [Parameter(Mandatory=$true)][int]$TestRunId,
        [Parameter(Mandatory=$true)][int]$Result,
        [Parameter(Mandatory=$true)][int]$TestRun_Manager_ID
    )
    begin {
        $body = @{
            STATUS_ID = "$Status"
            RESULT_ID = "$Result"
            TestRun_Manager_ID = "$TestRun_Manager_ID"
        }
        $body = $body | ConvertTo-Json
    }
    process
    {
        if ($pscmdlet.ShouldProcess("Update-TestRun"))
        {
            try
            {
                Write-Log -Message "Updating the TestRun ID: $TestRunId" -MsgType DEBUG -Logfile $Logfile -LogLevel $LogLevel
                # Make the rest call to update the data
                $Url = "/testrun/$TestRunId"
                Invoke-XesterRestCall -RestServer $RestServer -URI "$Url" -Method Put -Body $body
            }
            catch
            {
                $ErrorMessage = $_.Exception.Message
                $FailedItem = $_.Exception.ItemName
                Throw "Update-TestRun: $ErrorMessage $FailedItem"
            }
        }
        else
        {
            # -WhatIf was used.
            return $false
        }
    }
}
Write-Verbose 'Importing from [C:\projects\xester\Xester\public]'
# .\Xester\public\Complete-CancelledTestSet.ps1
function Complete-CancelledTestSet {
    <#
    .DESCRIPTION
        This function will set all Cancelled TestRuns to Aborted.
    .PARAMETER RestServer
        A Rest Server is required.
    .EXAMPLE
        Complete-CancelledTestSet -RestServer localhost
    .NOTES
        This will return a hashtable of data from the PPS database.
    #>

    [CmdletBinding(
        SupportsShouldProcess = $true,
        ConfirmImpact = "Low"
    )]
    [OutputType([hashtable])]
    [OutputType([Boolean])]
    param(
        [Parameter(Mandatory=$true)][string]$RestServer
    )
    begin {
    }
    process
    {
        if ($pscmdlet.ShouldProcess("Complete-CancelledTestSet"))
        {
            try
            {
                Write-Log -Message "Setting all Cancelled Tests to Complete-Aborted." -MsgType DEBUG -Logfile $Logfile -LogLevel $LogLevel
                # Get the List of Queued Tests.
                $TestRunSet = (Get-TestRunSet -RestServer $RestServer -StatusId 10).testrun
                foreach ($TestRun in $TestRunSet){
                    $TestRunId = $TestRun.ID
                    Write-Log -Message "Setting TestRunID: $TestRunId to Complete-Aborted." -MsgType DEBUG -Logfile $Logfile -LogLevel $LogLevel
                    Update-TestRun -RestServer localhost -Status 9 -TestRunId $TestRunId -Result 5 -TestRun_Manager_ID 9999 | Out-Null
                }
            }
            catch
            {
                $ErrorMessage = $_.Exception.Message
                $FailedItem = $_.Exception.ItemName
                Throw "Complete-CancelledTestSet: $ErrorMessage $FailedItem"
            }
        }
        else
        {
            # -WhatIf was used.
            return $false
        }
    }
}
# .\Xester\public\Get-XSqmanData.ps1
function Get-XsQmanData {
    <#
    .DESCRIPTION
        This function will Gather Qman data.
    .PARAMETER RestServer
        A Rest Server is required.
    .PARAMETER QmanId
        A Qman Id is required.
    .EXAMPLE
        Get-XSqmanData -RestServer localhost -QmanId 1
    .NOTES
        This will return a hashtable of data from the PPS database.
    #>

    [CmdletBinding(
        SupportsShouldProcess = $true,
        ConfirmImpact = "Low"
    )]
    [OutputType([hashtable])]
    [OutputType([Boolean])]
    param(
        [Parameter(Mandatory=$true)][string]$RestServer,
        [Parameter(Mandatory=$true)][int]$QmanId
    )
    begin {
    }
    process
    {
        if ($pscmdlet.ShouldProcess("Get-XSqmanData"))
        {
            try
            {
                Write-Log -Message "Getting the Qman Data" -MsgType DEBUG -Logfile $Logfile -LogLevel $LogLevel
                # Make the rest call to Get the data
                $Url = "/queue_manager/$QmanId"
                Invoke-XesterRestCall -RestServer $RestServer -URI "$Url" -Method Get
            }
            catch
            {
                $ErrorMessage = $_.Exception.Message
                $FailedItem = $_.Exception.ItemName
                Throw "Get-XSqmanData: $ErrorMessage $FailedItem"
            }
        }
        else
        {
            # -WhatIf was used.
            return $false
        }
    }
}
# .\Xester\public\Invoke-AssignQueuedTestSet.ps1
function Invoke-AssignQueuedTestSet {
    <#
    .DESCRIPTION
        This function will set all Cancelled TestRuns to Aborted.
    .PARAMETER RestServer
        A Rest Server is required.
    .EXAMPLE
        Invoke-AssignQueuedTestSet -RestServer localhost
    .NOTES
        This will return a hashtable of data from the PPS database.
    #>

    [CmdletBinding(
        SupportsShouldProcess = $true,
        ConfirmImpact = "Low"
    )]
    [OutputType([hashtable])]
    [OutputType([Boolean])]
    param(
        [Parameter(Mandatory=$true)][string]$RestServer
    )
    begin {
    }
    process
    {
        if ($pscmdlet.ShouldProcess("Invoke-AssignQueuedTestSet"))
        {
            try
            {
                Write-Log -Message "Attempting to Assign Queued Tests." -MsgType DEBUG -Logfile $Logfile -LogLevel $LogLevel
                # Get the List of Queued Tests.
                $TestRunSet = (Get-TestRunSet -RestServer $RestServer -StatusId 6).testrun
                foreach ($TestRun in $TestRunSet){
                    $TestRunId = $TestRun.ID
                    # Query for Running TestRun Managers
                    $TmanList = (Get-TmanData -RestServer $RestServer -StatusId 2).testrun_manager
                    if(($TmanList | Measure-Object).count -ne 0){
                        :ManagerLoop foreach($TestRunManager in $TmanList){
                            $Tman_ID = $TestRunManager.ID
                            # Assign the test to the Manager and break the loop.
                            Write-Log -Message "Assigning TestRunID: $TestRunId to TmanID: $Tman_ID." -MsgType DEBUG -Logfile $Logfile -LogLevel $LogLevel
                            Update-TestRun -RestServer localhost -Status 7 -TestRunId $TestRunId -Result 6 -TestRun_Manager_ID $Tman_ID | Out-Null
                            break ManagerLoop
                        }
                    } else {
                        Write-log -Message "There are no TestRun Managers Available" -Logfile $logfile -LogLevel $logLevel -MsgType INFO
                    }
                }
            }
            catch
            {
                $ErrorMessage = $_.Exception.Message
                $FailedItem = $_.Exception.ItemName
                Throw "Invoke-AssignQueuedTestSet: $ErrorMessage $FailedItem"
            }
        }
        else
        {
            # -WhatIf was used.
            return $false
        }
    }
}
# .\Xester\public\Invoke-XesterRestCall.ps1
function Invoke-XesterRestCall
{
    <#
    .DESCRIPTION
        This function will Perform a Rest Call to a Specific XesterUI Server.
    .PARAMETER RestServer
        A Rest Server is required.(Hostname or IP, not full URL)
    .PARAMETER URI
        A URI is required.
    .PARAMETER Method
        A Method is Required.
    .PARAMETER Body
        A Method is Optional.
    .EXAMPLE
        Invoke-XesterRestCall -RestServer localhost -URI "/queue_manager/1?transform=true" -Method Get
    .NOTES
        This will return a hashtable of data from the PPS database.
    #>

    [CmdletBinding()]
    [OutputType([hashtable])]
    param(
        [Parameter(Mandatory = $true)][string]$RestServer,
        [Parameter(Mandatory = $true)][string]$URI,
        [ValidateSet("GET", "POST", "PUT", "DELETE")]
        [Parameter(Mandatory = $true)][string]$Method,
        [Parameter(Mandatory = $false)]$Body
    )
    try
    {
        $fullURL = "http://" + $RestServer + "/XesterUI/api/index.php" + $URI
        if ($null -eq $Body)
        {
            $RestParams = @{
                Method = "$Method"
                URI    = "$fullURL"
            }
        }
        else
        {
            $RestParams = @{
                Method = "$Method"
                URI    = "$fullURL"
                Body   = $Body
            }
        }
        Write-Log -Message "RestCall Details; FullUrl: $FullURL - Method: $Method" -LogLevel $LogLevel -MsgType DEBUG -Logfile $Logfile | Out-Null
        Invoke-RestMethod @RestParams
    }
    catch
    {
        $ErrorMessage = $_.Exception.Message
        $FailedItem = $_.Exception.ItemName
        Throw "Invoke-XesterRestCall: $ErrorMessage $FailedItem"
    }
}
# .\Xester\public\Reset-QueuedTestSet.ps1
function Reset-QueuedTestSet {
    <#
    .DESCRIPTION
        This function will Update all queued testruns to Submitted.
    .PARAMETER RestServer
        A Rest Server is required.
    .EXAMPLE
        Reset-QueuedTestSet -RestServer localhost
    .NOTES
        This will return a hashtable of data from the PPS database.
    #>

    [CmdletBinding(
        SupportsShouldProcess = $true,
        ConfirmImpact = "Low"
    )]
    [OutputType([hashtable])]
    [OutputType([Boolean])]
    param(
        [Parameter(Mandatory=$true)][string]$RestServer
    )
    begin {
    }
    process
    {
        if ($pscmdlet.ShouldProcess("Reset-QueuedTestSet"))
        {
            try
            {
                Write-Log -Message "Setting all Queued Tests to Submitted." -MsgType DEBUG -Logfile $Logfile -LogLevel $LogLevel
                # Get the List of Queued Tests.
                $TestRunSet = (Get-TestRunSet -RestServer $RestServer -StatusId 6).testrun
                foreach ($TestRun in $TestRunSet){
                    $TestRunId = $TestRun.ID
                    Write-Log -Message "Setting TestRunID: $TestRunId to Submitted." -MsgType DEBUG -Logfile $Logfile -LogLevel $LogLevel
                    Update-TestRun -RestServer localhost -Status 5 -TestRunId $TestRunId -Result 6 -TestRun_Manager_ID 9999 | Out-Null
                }
            }
            catch
            {
                $ErrorMessage = $_.Exception.Message
                $FailedItem = $_.Exception.ItemName
                Throw "Reset-QueuedTestSet: $ErrorMessage $FailedItem"
            }
        }
        else
        {
            # -WhatIf was used.
            return $false
        }
    }
}
# .\Xester\public\Update-SubmittedTestSet.ps1
function Update-SubmittedTestSet {
    <#
    .DESCRIPTION
        This function will Update the TestRun Data - Simple fields.
    .PARAMETER RestServer
        A Rest Server is required.
    .EXAMPLE
        Update-SubmittedTestSet -RestServer localhost
    .NOTES
        This will return a hashtable of data from the PPS database.
    #>

    [CmdletBinding(
        SupportsShouldProcess = $true,
        ConfirmImpact = "Low"
    )]
    [OutputType([hashtable])]
    [OutputType([Boolean])]
    param(
        [Parameter(Mandatory=$true)][string]$RestServer
    )
    begin {
    }
    process
    {
        if ($pscmdlet.ShouldProcess("Update-SubmittedTestSet"))
        {
            try
            {
                Write-Log -Message "Setting all submitted tests to Queued." -MsgType DEBUG -Logfile $Logfile -LogLevel $LogLevel
                # Get the List of Queued Tests.
                $TestRunSet = (Get-TestRunSet -RestServer $RestServer -StatusId 5).testrun
                foreach ($TestRun in $TestRunSet){
                    $TestRunId = $TestRun.ID
                    Write-Log -Message "Setting TestRunID: $TestRunId to Queued." -MsgType DEBUG -Logfile $Logfile -LogLevel $LogLevel
                    Update-TestRun -RestServer localhost -Status 6 -TestRunId $TestRunId -Result 6 -TestRun_Manager_ID 9999 | Out-Null
                }
            }
            catch
            {
                $ErrorMessage = $_.Exception.Message
                $FailedItem = $_.Exception.ItemName
                Throw "Update-SubmittedTestSet: $ErrorMessage $FailedItem"
            }
        }
        else
        {
            # -WhatIf was used.
            return $false
        }
    }
}
# .\Xester\public\Update-XSqmanData.ps1
function Update-XsQmanData {
    <#
    .DESCRIPTION
        This function will Update the Qman Data
    .PARAMETER RestServer
        A Rest Server is required.
    .PARAMETER Status
        A Status is required.
    .PARAMETER QmanId
        A Qman Id is required.
    .PARAMETER QmanLogFile
        A QmanLogFile is optional.
    .EXAMPLE
        Update-XSqmanData -RestServer localhost -Status 2 -QmanId 1 -QmanLogFile "c:\test\test.log"
    .NOTES
        This will return a hashtable of data from the PPS database.
    #>

    [CmdletBinding(
        SupportsShouldProcess = $true,
        ConfirmImpact = "Low"
    )]
    [OutputType([hashtable])]
    [OutputType([Boolean])]
    param(
        [Parameter(Mandatory=$true)][string]$RestServer,
        [Parameter(Mandatory=$true)][int]$Status,
        [Parameter(Mandatory=$false)][string]$QmanLogFile,
        [Parameter(Mandatory=$true)][int]$QmanId
    )
    begin {
        $HeartBeat = Get-XsTimeStamp
        if(($null -eq $QmanLogFile) -or ($QmanLogFile -eq "")){
            $body = @{
                STATUS_ID = "$Status"
                Heartbeat = "$HeartBeat"
            }
        } else {
            $body = @{
                STATUS_ID = "$Status"
                Log_File = "$QmanLogFile"
                Heartbeat = "$HeartBeat"
            }
        }
        $body = $body | ConvertTo-Json
    }
    process
    {
        if ($pscmdlet.ShouldProcess("Update-XSqmanData"))
        {
            try
            {
                Write-Log -Message "Updating the Qman" -MsgType DEBUG -Logfile $Logfile -LogLevel $LogLevel
                # Make the rest call to update the data
                $Url = "/queue_manager/$QmanId"
                Invoke-XesterRestCall -RestServer $RestServer -URI "$Url" -Method Put -Body $body
            }
            catch
            {
                $ErrorMessage = $_.Exception.Message
                $FailedItem = $_.Exception.ItemName
                Throw "Update-XSqmanData: $ErrorMessage $FailedItem"
            }
        }
        else
        {
            # -WhatIf was used.
            return $false
        }
    }
}
Write-Verbose 'Importing from [C:\projects\xester\Xester\classes]'