Tests/Unit/MSFT_WindowsProcess.Tests.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 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 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 |
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '')] param () $errorActionPreference = 'Stop' Set-StrictMode -Version 'Latest' $script:moduleRootPath = Split-Path -Path $PSScriptRoot -Parent $script:testHelpersPath = Join-Path -Path $script:moduleRootPath -ChildPath 'TestHelpers' Import-Module -Name (Join-Path -Path $script:testHelpersPath -ChildPath 'CommonTestHelper.psm1') $script:testEnvironment = Enter-DscResourceTestEnvironment ` -DscResourceModuleName 'PSDscResources' ` -DscResourceName 'MSFT_WindowsProcess' ` -TestType 'Unit' try { InModuleScope 'MSFT_WindowsProcess' { # Mock objects $script:validPath1 = 'ValidPath1' $script:validPath2 = 'ValidPath2' $script:validPath3 = 'ValidPath3' $script:invalidPath = 'InvalidPath' $script:testUserName = 'TestUserName12345' $testPassword = 'StrongOne7.' $testSecurePassword = ConvertTo-SecureString -String $testPassword -AsPlainText -Force $script:testCredential = New-Object PSCredential ($script:testUserName, $testSecurePassword) $script:exceptionMessage = 'Test Invalid Operation Exception' $script:mockProcess1 = @{ Path = $script:validPath1 CommandLine = 'C:\temp\test.exe argument1 argument2 argument3' Arguments = 'argument1 argument2 argument3' ProcessId = 12345 Id = 12345 PagedMemorySize64 = 1048 NonpagedSystemMemorySize64 = 16 VirtualMemorySize64 = 256 HandleCount = 50 } $script:mockProcess2 = @{ Path = $script:validPath2 CommandLine = '' Arguments = '' ProcessId = 54321 Id = 54321 PagedMemorySize64 = 2096 NonpagedSystemMemorySize64 = 8 VirtualMemorySize64 = 512 HandleCount = 5 } $script:mockProcess3 = @{ Path = $script:validPath1 CommandLine = 'C:\test.exe arg6' Arguments = 'arg6' ProcessId = 1111101 Id = 1111101 PagedMemorySize64 = 512 NonpagedSystemMemorySize64 = 32 VirtualMemorySize64 = 64 HandleCount = 0 } $script:mockProcess4 = @{ Path = $script:validPath1 CommandLine = 'C:\test.exe arg6' Arguments = 'arg6' ProcessId = 1111101 Id = 1111101 PagedMemorySize64 = 510 NonpagedSystemMemorySize64 = 16 VirtualMemorySize64 = 8 HandleCount = 8 } $script:errorProcess = @{ Path = $script:validPath3 CommandLine = '' Arguments = '' ProcessId = 77777 Id = 77777 PagedMemorySize64 = 0 NonpagedSystemMemorySize64 = 0 VirtualMemorySize64 = 0 HandleCount = 0 } Describe 'WindowsProcess\Get-TargetResource' { Mock -CommandName Expand-Path -MockWith { return $Path } Mock -CommandName Get-ProcessCimInstance -MockWith { if ($Path -eq $script:validPath1) { return @($script:mockProcess1, $script:mockProcess3) } elseif ($Path -eq $script:validPath2) { return @($script:mockProcess2) } elseif ($Path -eq $script:validPath3) { return @($script:errorProcess) } else { return @() } } Mock -CommandName Get-Process -MockWith { if ($ID -eq $script:mockProcess1.Id) { return $script:mockProcess1 } elseif ($script:mockProcess2.Id) { return $script:mockProcess2 } elseif ($script:mockProcess3.Id) { return $script:mockProcess3 } else { return $script:errorProcess } } Mock -CommandName New-InvalidOperationException -MockWith { Throw $script:exceptionMessage } Mock -CommandName New-InvalidArgumentException -MockWith { Throw $script:exceptionMessage } It 'Should return the correct properties for a process that is Absent' { $processArguments = 'TestGetProperties' $getTargetResourceResult = Get-TargetResource -Path $invalidPath ` -Arguments $processArguments $getTargetResourceResult.Arguments | Should -Be $processArguments $getTargetResourceResult.Ensure | Should -Be 'Absent' $getTargetResourceResult.Path | Should -Be $invalidPath Assert-MockCalled -CommandName Expand-Path -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-ProcessCimInstance -Exactly 1 -Scope It } It 'Should return the correct properties for one process with a credential' { $getTargetResourceResult = Get-TargetResource -Path $script:validPath2 ` -Arguments $script:mockProcess2.Arguments ` -Credential $script:testCredential $getTargetResourceResult.VirtualMemorySize | Should -Be $script:mockProcess2.VirtualMemorySize64 $getTargetResourceResult.Arguments | Should -Be $script:mockProcess2.Arguments $getTargetResourceResult.Ensure | Should -Be 'Present' $getTargetResourceResult.PagedMemorySize | Should -Be $script:mockProcess2.PagedMemorySize64 $getTargetResourceResult.Path | Should -Be $script:mockProcess2.Path $getTargetResourceResult.NonPagedMemorySize | Should -Be $script:mockProcess2.NonpagedSystemMemorySize64 $getTargetResourceResult.HandleCount | Should -Be $script:mockProcess2.HandleCount $getTargetResourceResult.ProcessId | Should -Be $script:mockProcess2.ProcessId Assert-MockCalled -CommandName Expand-Path -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-ProcessCimInstance -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-Process -Exactly 1 -Scope It } It 'Should return the correct properties when there are multiple processes' { $getTargetResourceResult = Get-TargetResource -Path $script:validPath1 ` -Arguments $script:mockProcess1.Arguments $getTargetResourceResult.VirtualMemorySize | Should -Be $script:mockProcess1.VirtualMemorySize64 $getTargetResourceResult.Arguments | Should -Be $script:mockProcess1.Arguments $getTargetResourceResult.Ensure | Should -Be 'Present' $getTargetResourceResult.PagedMemorySize | Should -Be $script:mockProcess1.PagedMemorySize64 $getTargetResourceResult.Path | Should -Be $script:mockProcess1.Path $getTargetResourceResult.NonPagedMemorySize | Should -Be $script:mockProcess1.NonpagedSystemMemorySize64 $getTargetResourceResult.HandleCount | Should -Be $script:mockProcess1.HandleCount $getTargetResourceResult.ProcessId | Should -Be $script:mockProcess1.ProcessId Assert-MockCalled -CommandName Expand-Path -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-ProcessCimInstance -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-Process -Exactly 1 -Scope It } } Describe 'WindowsProcess\Set-TargetResource' { Mock -CommandName Expand-Path -MockWith { return $Path } Mock -CommandName Get-ProcessCimInstance -MockWith { if ($Path -eq $script:validPath1) { return @($script:mockProcess1, $script:mockProcess3) } elseif ($Path -eq $script:validPath2) { return @($script:mockProcess2) } elseif ($Path -eq $script:validPath3) { return @($script:errorProcess) } else { return @() } } Mock -CommandName New-InvalidOperationException -MockWith { Throw $script:exceptionMessage } Mock -CommandName New-InvalidArgumentException -MockWith { Throw $script:exceptionMessage } Mock -CommandName Stop-Process -MockWith { return $null } ` -ParameterFilter { ($Id -contains $script:mockProcess1.ProcessId) -or ` ($Id -contains $script:mockProcess2.ProcessId) -or ` ($Id -contains $script:mockProcess3.ProcessId) } Mock -CommandName Stop-Process -MockWith { return 'error' } ` -ParameterFilter { $Id -contains $script:errorProcess.ProcessId} Mock -CommandName Test-IsRunFromLocalSystemUser -MockWith { return $true } Mock -CommandName Wait-ProcessCount -MockWith { return $true } It 'Should not throw when Ensure set to Absent and processes are running' { { Set-TargetResource -Path $script:validPath1 ` -Arguments $script:mockProcess1.Arguments ` -Credential $script:testCredential ` -Ensure 'Absent' } | Should -Not -Throw Assert-MockCalled -CommandName Expand-Path -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-ProcessCimInstance -Exactly 1 -Scope It Assert-MockCalled -CommandName Stop-Process -Exactly 1 -Scope It Assert-MockCalled -CommandName Wait-ProcessCount -Exactly 1 -Scope It } It 'Should not throw when Ensure set to Absent and processes are not running' { { Set-TargetResource -Path $script:invalidPath ` -Arguments '' ` -Ensure 'Absent' } | Should -Not -Throw Assert-MockCalled -CommandName Expand-Path -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-ProcessCimInstance -Exactly 1 -Scope It Assert-MockCalled -CommandName Stop-Process -Exactly 0 -Scope It Assert-MockCalled -CommandName Wait-ProcessCount -Exactly 0 -Scope It } It 'Should throw an invalid operation exception when Stop-Process throws an error' { { Set-TargetResource -Path $script:errorProcess.Path ` -Arguments '' ` -Ensure 'Absent' } | Should -Throw -ExpectedMessage $script:exceptionMessage Assert-MockCalled -CommandName Expand-Path -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-ProcessCimInstance -Exactly 1 -Scope It Assert-MockCalled -CommandName Stop-Process -Exactly 1 -Scope It Assert-MockCalled -CommandName New-InvalidOperationException -Exactly 1 -Scope It Assert-MockCalled -CommandName Wait-ProcessCount -Exactly 0 -Scope It } Mock -CommandName Wait-ProcessCount -MockWith { return $false } It 'Should throw an invalid operation exception when there is a problem waiting for the processes' { { Set-TargetResource -Path $script:validPath1 ` -Arguments $script:mockProcess1.Arguments ` -Ensure 'Absent' } | Should -Throw -ExpectedMessage $script:exceptionMessage Assert-MockCalled -CommandName Expand-Path -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-ProcessCimInstance -Exactly 1 -Scope It Assert-MockCalled -CommandName Stop-Process -Exactly 1 -Scope It Assert-MockCalled -CommandName Wait-ProcessCount -Exactly 1 -Scope It Assert-MockCalled -CommandName New-InvalidOperationException -Exactly 1 -Scope It } Mock -CommandName Wait-ProcessCount -MockWith { return $true } Mock -CommandName Start-ProcessAsLocalSystemUser -MockWith {} It 'Should not throw when Ensure set to Present and processes are not running and credential passed in' { { Set-TargetResource -Path $script:invalidPath ` -Arguments $script:mockProcess1.Arguments ` -Credential $script:testCredential ` -Ensure 'Present' } | Should -Not -Throw Assert-MockCalled -CommandName Expand-Path -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-ProcessCimInstance -Exactly 1 -Scope It Assert-MockCalled -CommandName Test-IsRunFromLocalSystemUser -Exactly 1 -Scope It Assert-MockCalled -CommandName Start-ProcessAsLocalSystemUser -Exactly 1 -Scope It Assert-MockCalled -CommandName Wait-ProcessCount -Exactly 1 -Scope It } Mock -CommandName Start-ProcessAsLocalSystemUser -MockWith {} Mock -CommandName Assert-PathArgumentRooted -MockWith {} Mock -CommandName Assert-PathArgumentValid -MockWith {} It 'Should throw when Ensure set to Present, processes not running and credential and WorkingDirectory passed' { { Set-TargetResource -Path $script:invalidPath ` -Arguments $script:mockProcess1.Arguments ` -Credential $script:testCredential ` -WorkingDirectory 'test working directory' ` -Ensure 'Present' } | Should -Throw -ExpectedMessage $script:exceptionMessage Assert-MockCalled -CommandName Expand-Path -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-ProcessCimInstance -Exactly 1 -Scope It Assert-MockCalled -CommandName Test-IsRunFromLocalSystemUser -Exactly 1 -Scope It Assert-MockCalled -CommandName Start-ProcessAsLocalSystemUser -Exactly 0 -Scope It Assert-MockCalled -CommandName Wait-ProcessCount -Exactly 0 -Scope It Assert-MockCalled -CommandName Assert-PathArgumentRooted -Exactly 1 -Scope It Assert-MockCalled -CommandName Assert-PathArgumentValid -Exactly 1 -Scope It Assert-MockCalled -CommandName New-InvalidArgumentException -Exactly 1 -Scope It } $testErrorRecord = 'test Start-ProcessAsLocalSystemUser error record' Mock -CommandName Start-ProcessAsLocalSystemUser -MockWith { Throw $testErrorRecord } It 'Should throw when Ensure set to Present and Start-processAsLocalSystemUser fails' { { Set-TargetResource -Path $script:invalidPath ` -Arguments $script:mockProcess1.Arguments ` -Credential $script:testCredential ` -Ensure 'Present' } | Should -Throw -ExpectedMessage $testErrorRecord Assert-MockCalled -CommandName Expand-Path -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-ProcessCimInstance -Exactly 1 -Scope It Assert-MockCalled -CommandName Test-IsRunFromLocalSystemUser -Exactly 1 -Scope It Assert-MockCalled -CommandName Start-ProcessAsLocalSystemUser -Exactly 1 -Scope It Assert-MockCalled -CommandName Wait-ProcessCount -Exactly 0 -Scope It } Mock -CommandName Start-Process -MockWith {} It 'Should not throw when Ensure set to Present and processes are not running and no credential passed' { { Set-TargetResource -Path $script:invalidPath ` -Arguments $script:mockProcess1.Arguments ` -Ensure 'Present' } | Should -Not -Throw Assert-MockCalled -CommandName Expand-Path -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-ProcessCimInstance -Exactly 1 -Scope It Assert-MockCalled -CommandName Start-Process -Exactly 1 -Scope It Assert-MockCalled -CommandName Wait-ProcessCount -Exactly 1 -Scope It } $mockStartProcessException = New-Object -TypeName 'InvalidOperationException' ` -ArgumentList @('Start-Process test exception') Mock -CommandName Start-Process -MockWith { Throw $mockStartProcessException } It 'Should throw when Ensure set to Present and Start-Process fails' { { Set-TargetResource -Path $script:invalidPath ` -Arguments $script:mockProcess1.Arguments ` -Ensure 'Present' } | Should -Throw -ExpectedMessage $script:exceptionMessage Assert-MockCalled -CommandName Expand-Path -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-ProcessCimInstance -Exactly 1 -Scope It Assert-MockCalled -CommandName Start-Process -Exactly 1 -Scope It Assert-MockCalled -CommandName Wait-ProcessCount -Exactly 0 -Scope It Assert-MockCalled -CommandName New-InvalidOperationException -Exactly 1 -Scope It } Mock -CommandName Wait-ProcessCount -MockWith { return $false } Mock -CommandName Start-Process -MockWith {} It 'Should throw when there is a failure waiting for the process to start' { { Set-TargetResource -Path $script:invalidPath ` -Arguments $script:mockProcess1.Arguments ` -Ensure 'Present' } | Should -Throw -ExpectedMessage $script:exceptionMessage Assert-MockCalled -CommandName Expand-Path -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-ProcessCimInstance -Exactly 1 -Scope It Assert-MockCalled -CommandName Start-Process -Exactly 1 -Scope It Assert-MockCalled -CommandName Wait-ProcessCount -Exactly 1 -Scope It } Mock -CommandName Wait-ProcessCount -MockWith { return $true } It 'Should not throw when Ensure set to Present and processes are already running' { { Set-TargetResource -Path $script:validPath1 ` -Arguments $script:mockProcess1.Arguments ` -Ensure 'Present' } | Should -Not -Throw Assert-MockCalled -CommandName Expand-Path -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-ProcessCimInstance -Exactly 1 -Scope It Assert-MockCalled -CommandName Start-Process -Exactly 0 -Scope It Assert-MockCalled -CommandName Wait-ProcessCount -Exactly 0 -Scope It } } Describe 'WindowsProcess\Test-TargetResource' { Mock -CommandName Expand-Path -MockWith { return $Path } Mock -CommandName Get-ProcessCimInstance -MockWith { if ($Path -eq $script:validPath1) { return @($script:mockProcess1, $script:mockProcess3) } elseif ($Path -eq $script:validPath2) { return @($script:mockProcess2) } elseif ($Path -eq $script:validPath3) { return @($script:errorProcess) } else { return @() } } It 'Should return true when Ensure set to Present and process is running' { $testTargetResourceResult = Test-TargetResource -Path $script:validPath1 ` -Arguments $script:mockProcess1.Arguments ` -Ensure 'Present' $testTargetResourceResult | Should -BeTrue } It 'Should return false when Ensure set to Present and process is not running' { $testTargetResourceResult = Test-TargetResource -Path $script:invalidPath ` -Arguments $script:mockProcess1.Arguments ` -Ensure 'Present' $testTargetResourceResult | Should -BeFalse } It 'Should return true when Ensure set to Absent and process is not running and Credential passed' { $testTargetResourceResult = Test-TargetResource -Path $script:invalidPath ` -Arguments $script:mockProcess1.Arguments ` -Credential $script:testCredential ` -Ensure 'Absent' $testTargetResourceResult | Should -BeTrue } It 'Should return false when Ensure set to Absent and process is running' { $testTargetResourceResult = Test-TargetResource -Path $script:validPath1 ` -Arguments $script:mockProcess1.Arguments ` -Ensure 'Absent' $testTargetResourceResult | Should -BeFalse } } Describe 'WindowsProcess\Expand-Path' { Mock -CommandName New-InvalidArgumentException -MockWith { Throw $script:exceptionMessage } Mock -CommandName Test-Path -MockWith { return $true } It 'Should return the original path when path is rooted' { $rootedPath = 'C:\testProcess.exe' $expandPathResult = Expand-Path -Path $rootedPath $expandPathResult | Should -Be $rootedPath } Mock -CommandName Test-Path -MockWith { return $false } It 'Should throw an invalid argument exception when Path is rooted and does not exist' { $rootedPath = 'C:\invalidProcess.exe' { Expand-Path -Path $rootedPath} | Should -Throw -ExpectedMessage $script:exceptionMessage Assert-MockCalled -CommandName New-InvalidArgumentException -Exactly 1 -Scope It } It 'Should throw an invalid argument exception when Path is unrooted and does not exist' { $unrootedPath = 'invalidfile.txt' { Expand-Path -Path $unrootedPath} | Should -Throw -ExpectedMessage $script:exceptionMessage Assert-MockCalled -CommandName New-InvalidArgumentException -Exactly 1 -Scope It } } Describe 'WindowsProcess\Get-ProcessCimInstance' { Mock -CommandName Get-Process -MockWith { return @($script:mockProcess2) } Mock -CommandName Get-CimInstance -MockWith { return $script:mockProcess2 } It 'Should return the correct process when it exists and no arguments passed' { $resultProcess = Get-ProcessCimInstance -Path $script:mockProcess2.Path $resultProcess | Should -Be @($script:mockProcess2) Assert-MockCalled -CommandName Get-Process -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-CimInstance -Exactly 1 -Scope It } Mock -CommandName Get-Process -MockWith { return @($script:mockProcess1) } Mock -CommandName Get-CimInstance -MockWith { return $script:mockProcess1 } It 'Should return the correct process when it exists and arguments are passed' { $resultProcess = Get-ProcessCimInstance -Path $script:mockProcess1.Path ` -Arguments $script:mockProcess1.Arguments $resultProcess | Should -Be @($script:mockProcess1) Assert-MockCalled -CommandName Get-Process -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-CimInstance -Exactly 1 -Scope It } $expectedProcesses = @($script:mockProcess1, $script:mockProcess1, $script:mockProcess1) Mock -CommandName Get-Process -MockWith { return $expectedProcesses } Mock -CommandName Get-CimInstance -MockWith { return $script:mockProcess1 } It 'Should return the correct processes when multiple exist' { $resultProcess = Get-ProcessCimInstance -Path $script:mockProcess1.Path ` -Arguments $script:mockProcess1.Arguments Compare-Object -ReferenceObject $expectedProcesses -DifferenceObject $resultProcess | Should -Be $null Assert-MockCalled -CommandName Get-Process -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-CimInstance -Exactly 3 -Scope It } Mock -CommandName Get-Process -MockWith { return @($script:mockProcess2, $script:mockProcess2) } Mock -CommandName Get-CimInstance -MockWith { return @($script:mockProcess2, $script:mockProcess2) } It 'Should return the correct processes when they exists and cim instance threshold is lower than number of processes found' { $resultProcess = Get-ProcessCimInstance -Path $script:mockProcess2.Path ` -Arguments $script:mockProcess2.Arguments ` -UseGetCimInstanceThreshold 1 $resultProcess | Should -Be @($script:mockProcess2, $script:mockProcess2) Assert-MockCalled -CommandName Get-Process -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-CimInstance -Exactly 1 -Scope It } Mock -CommandName Get-Process -MockWith { return @($script:mockProcess2) } Mock -CommandName Get-CimInstance -MockWith { return $script:mockProcess2 } Mock -CommandName Get-ProcessOwner -MockWith { return ($env:computerName + '\' + $script:testUsername) } ` -ParameterFilter { ($Process -eq $script:mockProcess2) } It 'Should return the correct process when it exists and Credential is passed in' { $resultProcess = Get-ProcessCimInstance -Path $script:mockProcess2.Path ` -Credential $script:testCredential $resultProcess | Should -Be @($script:mockProcess2) Assert-MockCalled -CommandName Get-Process -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-CimInstance -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-ProcessOwner -Exactly 1 -Scope It } Mock -CommandName Get-Process -MockWith { return @($script:mockProcess3, $script:mockProcess3, $script:mockProcess4, $script:mockProcess2) } Mock -CommandName Get-CimInstance -MockWith { return @($script:mockProcess3, $script:mockProcess3, $script:mockProcess4, $script:mockProcess2) } Mock -CommandName Get-ProcessOwner -MockWith { return ($env:computerName + '\' + $script:testUsername) } ` -ParameterFilter { ($Process -eq $script:mockProcess3) } Mock -CommandName Get-ProcessOwner -MockWith { return ('wrongDomain' + '\' + $script:testUsername) } ` -ParameterFilter { ($Process -eq $script:mockProcess4) -or ($Process -eq $script:mockProcess2) } It 'Should return only processes that match Credential' { $resultProcess = Get-ProcessCimInstance -Path $script:mockProcess3.Path ` -Credential $script:testCredential ` -Arguments $script:mockProcess3.Arguments ` -UseGetCimInstanceThreshold 1 $resultProcess | Should -Be @($script:mockProcess3, $script:mockProcess3) Assert-MockCalled -CommandName Get-Process -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-CimInstance -Exactly 1 -Scope It } Mock -CommandName Get-ProcessOwner -MockWith { return ($env:computerName + '\' + $script:testUsername) } ` -ParameterFilter { ($Process -eq $script:mockProcess3) -or ($Process -eq $script:mockProcess2) } Mock -CommandName Get-ProcessOwner -MockWith { return ('wrongDomain' + '\' + $script:testUsername) } ` -ParameterFilter { ($Process -eq $script:mockProcess4) } It 'Should return only processes that match Credential and Arguments' { $resultProcess = Get-ProcessCimInstance -Path $script:mockProcess3.Path ` -Credential $script:testCredential ` -Arguments $script:mockProcess3.Arguments ` -UseGetCimInstanceThreshold 1 $resultProcess | Should -Be @($script:mockProcess3, $script:mockProcess3) Assert-MockCalled -CommandName Get-Process -Exactly 1 -Scope It Assert-MockCalled -CommandName Get-CimInstance -Exactly 1 -Scope It } } Describe 'WindowsProcess\ConvertTo-EscapedStringForWqlFilter' { It 'Should return the same string when there are no escaped characters' { $inputString = 'testString%$.@123' $convertedString = ConvertTo-EscapedStringForWqlFilter -FilterString $inputString $convertedString | Should -Be $inputString } It 'Should return a string with escaped characters: ("\)' { $inputString = '\test"string"\123' $expectedString = '\\test\"string\"\\123' $convertedString = ConvertTo-EscapedStringForWqlFilter -FilterString $inputString $convertedString | Should -Be $expectedString } It "Should return a string with escaped characters: ('\)" { $inputString = "\test'string'\123" $expectedString = "\\test\'string\'\\123" $convertedString = ConvertTo-EscapedStringForWqlFilter -FilterString $inputString $convertedString | Should -Be $expectedString } } Describe 'WindowsProcess\Get-ProcessOwner' { $mockOwner = @{ Domain = 'Mock Domain' User = 'Mock User' } Mock -CommandName Get-ProcessOwnerCimInstance -MockWith { return $mockOwner } It 'Should return the correct string with domain\user' { $owner = Get-ProcessOwner -Process $script:mockProcess1 $owner | Should -Be ($mockOwner.Domain + '\' + $mockOwner.User) } It 'Should return the correct string with default-domain\user when domain is not there' { $mockOwner.Domain = $null $owner = Get-ProcessOwner -Process $script:mockProcess1 $owner | Should -Be ($env:computerName + '\' + $mockOwner.User) } } Describe 'WindowsProcess\Get-ArgumentsFromCommandLineInput' { It 'Should return the correct arguments when single quotes are used' { $inputString = 'test.txt a b c' $argumentsReturned = Get-ArgumentsFromCommandLineInput -CommandLineInput $inputString $argumentsReturned | Should -Be 'a b c' } It 'Should return the correct arguments when double quotes are used' { $inputString = '"test file test" a b c' $argumentsReturned = Get-ArgumentsFromCommandLineInput -CommandLineInput $inputString $argumentsReturned | Should -Be 'a b c' } It 'Should return an empty string when an empty string is passed in' { $inputString = $null $resultString = [System.String]::Empty $argumentsReturned = Get-ArgumentsFromCommandLineInput -CommandLineInput $inputString $argumentsReturned | Should -Be $resultString } It 'Should return an empty string when there are no arguments' { $inputString = 'test.txt' $resultString = [System.String]::Empty $argumentsReturned = Get-ArgumentsFromCommandLineInput -CommandLineInput $inputString $argumentsReturned | Should -Be $resultString } } Describe 'WindowsProcess\Assert-HashtableDoesNotContainKey' { $mockHashtable = @{ Key1 = 'test key1' Key2 = 'test key2' Key3 = 'test key3' } Mock -CommandName New-InvalidArgumentException -MockWith { Throw $script:exceptionMessage } It 'Should not throw an exception if the hashtable does not contain a key' { $mockKey = @('k1', 'k2', 'k3', 'k4', 'k5') { Assert-HashTableDoesNotContainKey -Hashtable $mockHashtable -Key $mockKey } | Should -Not -Throw } It 'Should throw an exception if the hashtable contains a key' { $mockKey = @('k1', 'k2', 'Key3', 'k4', 'k5') { Assert-HashTableDoesNotContainKey -Hashtable $mockHashtable -Key $mockKey } | Should -Throw -ExpectedMessage $script:exceptionMessage Assert-MockCalled -CommandName New-InvalidArgumentException -Exactly 1 -Scope It } } Describe 'WindowsProcess\Wait-ProcessCount' { $mockProcessSettings = @{ Path = 'mockPath' Arguments = 'mockArguments' } Mock -CommandName Get-ProcessCimInstance -MockWith { return @($script:mockProcess1, $script:mockProcess3) } It 'Should return true when all processes are returned' { $processCountResult = Wait-ProcessCount -ProcessSettings $mockProcessSettings -ProcessCount 2 $processCountResult | Should -BeTrue } It 'Should return false when not all processes are returned' { $processCountResult = Wait-ProcessCount -ProcessSettings $mockProcessSettings ` -ProcessCount 3 ` -WaitTime 10 $processCountResult | Should -BeFalse } } Describe 'WindowsProcess\Assert-PathArgumentRooted' { Mock -CommandName New-InvalidArgumentException -MockWith { Throw $script:exceptionMessage } It 'Should not throw when path is rooted' { $rootedPath = 'C:\testProcess.exe' { Assert-PathArgumentRooted -PathArgumentName 'mock test name' ` -PathArgument $rootedPath } | Should -Not -Throw } It 'Should throw an invalid argument exception when Path is unrooted' { $unrootedPath = 'invalidfile.txt' { Assert-PathArgumentRooted -PathArgumentName 'mock test name' ` -PathArgument $unrootedPath } | Should -Throw -ExpectedMessage $script:exceptionMessage Assert-MockCalled -CommandName New-InvalidArgumentException -Exactly 1 -Scope It } } Describe 'WindowsProcess\Assert-PathArgumentValid' { Mock -CommandName New-InvalidArgumentException -MockWith { Throw $script:exceptionMessage } It 'Should not throw when path is valid' { Mock -CommandName Test-Path -MockWith { return $true } { Assert-PathArgumentValid -PathArgumentName 'test name' ` -PathArgument 'validPath' } | Should -Not -Throw } It 'Should throw an invalid argument exception when Path is not valid' { Mock -CommandName Test-Path -MockWith { return $false } { Assert-PathArgumentValid -PathArgumentName 'test name' ` -PathArgument 'invalidPath' } | Should -Throw -ExpectedMessage $script:exceptionMessage Assert-MockCalled -CommandName New-InvalidArgumentException -Exactly 1 -Scope It } } Describe 'WindowsProcess\Split-Credential' { Mock -CommandName New-InvalidArgumentException -MockWith { Throw $script:exceptionMessage } It 'Should return correct domain and username with @ seperator' { $testUsername = 'user@domain' $testPassword = ConvertTo-SecureString -String 'dummy' -AsPlainText -Force $testCredential = New-Object -TypeName 'PSCredential' -ArgumentList @($testUsername, $testPassword) $splitCredentialResult = Split-Credential -Credential $testCredential $splitCredentialResult.Domain | Should -Be 'domain' $splitCredentialResult.Username | Should -Be 'user' } It 'Should return correct domain and username with \ seperator' { $testUsername = 'domain\user' $testPassword = ConvertTo-SecureString -String 'dummy' -AsPlainText -Force $testCredential = New-Object -TypeName 'PSCredential' -ArgumentList @($testUsername, $testPassword) $splitCredentialResult = Split-Credential -Credential $testCredential $splitCredentialResult.Domain | Should -Be 'domain' $splitCredentialResult.Username | Should -Be 'user' } It 'Should return correct domain and username with a local user' { $testUsername = 'localuser' $testPassword = ConvertTo-SecureString -String 'dummy' -AsPlainText -Force $testCredential = New-Object -TypeName 'PSCredential' -ArgumentList @($testUsername, $testPassword) $splitCredentialResult = Split-Credential -Credential $testCredential $splitCredentialResult.Domain | Should -Be $env:computerName $splitCredentialResult.Username | Should -Be 'localuser' } It 'Should throw an invalid argument exception when more than one \ in username' { $testUsername = 'user\domain\foo' $testPassword = ConvertTo-SecureString -String 'dummy' -AsPlainText -Force $testCredential = New-Object -TypeName 'PSCredential' -ArgumentList @($testUsername, $testPassword) { $null = Split-Credential -Credential $testCredential } | Should -Throw -ExpectedMessage $script:exceptionMessage Assert-MockCalled -CommandName New-InvalidArgumentException -Exactly 1 -Scope It } It 'Should throw an invalid argument exception when more than one @ in username' { $testUsername = 'user@domain@foo' $testPassword = ConvertTo-SecureString -String 'dummy' -AsPlainText -Force $testCredential = New-Object -TypeName 'PSCredential' -ArgumentList @($testUsername, $testPassword) { $null = Split-Credential -Credential $testCredential } | Should -Throw -ExpectedMessage $script:exceptionMessage Assert-MockCalled -CommandName New-InvalidArgumentException -Exactly 1 -Scope It } } } } finally { Exit-DscResourceTestEnvironment -TestEnvironment $script:testEnvironment } |