Modules/xNetworking/DSCResource.Tests/TestHelper.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 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 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 |
<#
.SYNOPSIS Helper functions for the common tests (Meta.Tests.ps1). #> <# .SYNOPSIS Creates a nuspec file for a nuget package at the specified path. .EXAMPLE New-Nuspec ` -PackageName 'TestPackage' ` -Version '1.0.0.0' ` -Author 'Microsoft Corporation' ` -Owners 'Microsoft Corporation' ` -DestinationPath C:\temp ` -LicenseUrl 'http://license' ` -PackageDescription 'Description of the package' ` -Tags 'tag1 tag2' #> function New-Nuspec { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [String] $PackageName, [Parameter(Mandatory = $true)] [String] $Version, [Parameter(Mandatory = $true)] [String] $Author, [Parameter(Mandatory=$true)] [String] $Owners, [Parameter(Mandatory=$true)] [String] $DestinationPath, [String] $LicenseUrl, [String] $ProjectUrl, [String] $IconUrl, [String] $PackageDescription, [String] $ReleaseNotes, [String] $Tags ) $currentYear = (Get-Date).Year $nuspecFileContent += @" <?xml version="1.0"?> <package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd"> <metadata> <id>$PackageName</id> <version>$Version</version> <authors>$Author</authors> <owners>$Owners</owners> "@ if (-not [String]::IsNullOrEmpty($LicenseUrl)) { $nuspecFileContent += @" <licenseUrl>$LicenseUrl</licenseUrl> "@ } if (-not [String]::IsNullOrEmpty($ProjectUrl)) { $nuspecFileContent += @" <projectUrl>$ProjectUrl</projectUrl> "@ } if (-not [String]::IsNullOrEmpty($IconUrl)) { $nuspecFileContent += @" <iconUrl>$IconUrl</iconUrl> "@ } $nuspecFileContent += @" <requireLicenseAcceptance>true</requireLicenseAcceptance> <description>$PackageDescription</description> <releaseNotes>$ReleaseNotes</releaseNotes> <copyright>Copyright $currentYear</copyright> <tags>$Tags</tags> </metadata> </package> "@ if (-not (Test-Path -Path $DestinationPath)) { $null = New-Item -Path $DestinationPath -ItemType 'Directory' } $nuspecFilePath = Join-Path -Path $DestinationPath -ChildPath "$PackageName.nuspec" $null = New-Item -Path $nuspecFilePath -ItemType 'File' -Force $null = Set-Content -Path $nuspecFilePath -Value $nuspecFileContent } <# .SYNOPSIS Downloads and installs a module from PowerShellGallery using Nuget. .PARAMETER ModuleName Name of the module to install .PARAMETER DestinationPath Path where module should be installed #> function Install-ModuleFromPowerShellGallery { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [String] $ModuleName, [Parameter(Mandatory = $true)] [String] $DestinationPath ) $nugetPath = 'nuget.exe' # Can't assume nuget.exe is available - look for it in Path if ($null -eq (Get-Command -Name $nugetPath -ErrorAction 'SilentlyContinue')) { # Is it in temp folder? $tempNugetPath = Join-Path -Path $env:temp -ChildPath $nugetPath if (-not (Test-Path -Path $tempNugetPath)) { # Nuget.exe can't be found - download it to temp folder $nugetDownloadURL = 'http://nuget.org/nuget.exe' Invoke-WebRequest -Uri $nugetDownloadURL -OutFile $tempNugetPath Write-Verbose -Message "nuget.exe downloaded at $tempNugetPath" $nugetPath = $tempNugetPath } else { Write-Verbose -Message "Using Nuget.exe found at $tempNugetPath" } } $moduleOutputDirectory = "$(Split-Path -Path $DestinationPath -Parent)\" $nugetSource = 'https://www.powershellgallery.com/api/v2' # Use Nuget.exe to install the module $null = & $nugetPath @( ` 'install', $ModuleName, ` '-source', $nugetSource, ` '-outputDirectory', $moduleOutputDirectory, ` '-ExcludeVersion' ` ) if ($LASTEXITCODE -ne 0) { throw "Installation of module $ModuleName using Nuget failed with exit code $LASTEXITCODE." } Write-Verbose -Message "The module $ModuleName was installed using Nuget." } <# .SYNOPSIS Initializes an environment for running unit or integration tests on a DSC resource. This includes: 1. Updates the $env:PSModulePath to ensure the correct module is tested. 2. Imports the module to test. 3. Sets the PowerShell ExecutionMode to Unrestricted. 4. Produces a test object to store the backed up settings. The above changes are reverted by calling the Restore-TestEnvironment function. Returns a test environment object which must be passed to the Restore-TestEnvironment function to allow it to restore the system back to the original state. .PARAMETER DscModuleName The name of the DSC Module containing the resource that the tests will be run on. .PARAMETER DscResourceName The full name of the DSC resource that the tests will be run on. This is usually the name of the folder containing the actual resource MOF file. .PARAMETER TestType Specifies the type of tests that are being initialized. It can be: Unit: Initialize for running Unit tests on a DSC resource. Default. Integration: Initialize for running Integration tests on a DSC resource. .PARAMETER ResourceType Specifies if the DscResource under test is mof-based or class-based. The default value is 'mof'. It can be: Mof: The test initialization assumes a Mof-based DscResource folder structure. Class: The test initialization assumes a Class-based DscResource folder structure. .EXAMPLE $TestEnvironment = Initialize-TestEnvironment ` -DSCModuleName 'xNetworking' ` -DSCResourceName 'MSFT_xFirewall' ` -TestType Unit This command will initialize the test environment for Unit testing the MSFT_xFirewall mof-based DSC resource in the xNetworking DSC module. .EXAMPLE $TestEnvironment = Initialize-TestEnvironment ` -DSCModuleName 'xSQLServer' ` -DSCResourceName 'xSQLServerAlwaysOnAvailabilityGroupDatabaseMembership' ` -TestType Unit -ResourceType Class This command will initialize the test environment for Unit testing the xSQLServerAlwaysOnAvailabilityGroupDatabaseMembership class-based DSC resource in the xSQLServer DSC module. .EXAMPLE $TestEnvironment = Initialize-TestEnvironment ` -DSCModuleName 'xNetworking' ` -DSCResourceName 'MSFT_xFirewall' ` -TestType Integration This command will initialize the test environment for Integration testing the MSFT_xFirewall DSC resource in the xNetworking DSC module. #> function Initialize-TestEnvironment { [OutputType([Hashtable])] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [String] $DscModuleName, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [String] $DscResourceName, [Parameter(Mandatory = $true)] [ValidateSet('Unit', 'Integration')] [String] $TestType, [Parameter()] [ValidateSet('Mof','Class')] [String] $ResourceType = 'Mof' ) Write-Verbose -Message "Initializing test environment for $TestType testing of $DscResourceName in module $DscModuleName" $moduleRootFilePath = Split-Path -Path $PSScriptRoot -Parent $moduleManifestFilePath = Join-Path -Path $moduleRootFilePath -ChildPath "$DscModuleName.psd1" if (Test-Path -Path $moduleManifestFilePath) { Write-Verbose -Message "Module manifest $DscModuleName.psd1 detected at $moduleManifestFilePath" } else { throw "Module manifest could not be found for the module $DscModuleName in the root folder $moduleRootFilePath" } # Import the module to test if ($TestType -ieq 'Unit') { switch ($ResourceType) { 'Mof' { $resourceTypeFolderName = 'DSCResources' } 'Class' { $resourceTypeFolderName = 'DSCClassResources' } } $dscResourcesFolderFilePath = Join-Path -Path $moduleRootFilePath -ChildPath $resourceTypeFolderName $dscResourceToTestFolderFilePath = Join-Path -Path $dscResourcesFolderFilePath -ChildPath $DscResourceName $moduleToImportFilePath = Join-Path -Path $dscResourceToTestFolderFilePath -ChildPath "$DscResourceName.psm1" } else { $moduleToImportFilePath = $moduleManifestFilePath } Import-Module -Name $moduleToImportFilePath -Scope 'Global' -Force <# Set the PSModulePath environment variable so that the module path that includes the module we want to test appears first. LCM will then use this path to locate modules when integration tests are called. Placing the path we want first ensures the correct module will be tested. #> $moduleParentFilePath = Split-Path -Path $moduleRootFilePath -Parent $oldPSModulePath = $env:PSModulePath if ($null -ne $oldPSModulePath) { $oldPSModulePathSplit = $oldPSModulePath.Split(';') } else { $oldPSModulePathSplit = $null } if ($oldPSModulePathSplit -ccontains $moduleParentFilePath) { # Remove the existing module path from the new PSModulePath $newPSModulePathSplit = $oldPSModulePathSplit | Where-Object {$_ -ne $moduleParentFilePath} $newPSModulePath = $newPSModulePathSplit -join ';' } else { $newPSModulePath = $oldPSModulePath } $newPSModulePath = "$moduleParentFilePath;$newPSModulePath" $env:PSModulePath = $newPSModulePath if ($TestType -ieq 'Integration') { <# For integration tests we have to set the machine's PSModulePath because otherwise the DSC LCM won't be able to find the resource module being tested or may use the wrong one. #> [System.Environment]::SetEnvironmentVariable('PSModulePath', $newPSModulePath, [System.EnvironmentVariableTarget]::Machine) # Reset the DSC LCM Reset-DSC } # Preserve and set the execution policy so that the DSC MOF can be created $oldExecutionPolicy = Get-ExecutionPolicy if ($oldExecutionPolicy -ine 'Unrestricted') { Set-ExecutionPolicy -ExecutionPolicy 'Unrestricted' -Scope 'Process' -Force } # Return the test environment return @{ DSCModuleName = $DscModuleName DSCResourceName = $DscResourceName TestType = $TestType ImportedModulePath = $moduleToImportFilePath OldPSModulePath = $oldPSModulePath OldExecutionPolicy = $oldExecutionPolicy } } <# .SYNOPSIS Restores the enviroment after running unit or integration tests on a DSC resource. This restores the following changes made by calling Initialize-TestEnvironemt: 1. Restores the $env:PSModulePath if it was changed. 2. Restores the PowerShell execution policy. 3. Resets the DSC LCM if running Integration tests. .PARAMETER TestEnvironment The hashtable created by the Initialize-TestEnvironment. .EXAMPLE Restore-TestEnvironment -TestEnvironment $TestEnvironment #> function Restore-TestEnvironment { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [Hashtable] $TestEnvironment ) Write-Verbose -Message "Cleaning up Test Environment after $($TestEnvironment.TestType) testing of $($TestEnvironment.DSCResourceName) in module $($TestEnvironment.DSCModuleName)." if ($TestEnvironment.TestType -ieq 'Integration') { # Reset the DSC LCM Reset-DSC } # Restore PSModulePath if ($TestEnvironment.OldPSModulePath -ne $env:PSModulePath) { $env:PSModulePath = $TestEnvironment.OldPSModulePath if ($TestEnvironment.TestType -eq 'Integration') { # Restore the machine PSModulePath for integration tests. [System.Environment]::SetEnvironmentVariable('PSModulePath', $TestEnvironment.OldPSModulePath, [System.EnvironmentVariableTarget]::Machine) } } # Restore the Execution Policy if ($TestEnvironment.OldExecutionPolicy -ne (Get-ExecutionPolicy)) { Set-ExecutionPolicy -ExecutionPolicy $TestEnvironment.OldExecutionPolicy -Scope 'Process' -Force } } <# .SYNOPSIS Resets the DSC LCM by performing the following functions: 1. Cancel any currently executing DSC LCM operations 2. Remove any DSC configurations that: - are currently applied - are pending application - have been previously applied The purpose of this function is to ensure the DSC LCM is in a known and idle state before an integration test is performed that will apply a configuration. This is to prevent an integration test from being performed but failing because the DSC LCM is applying a previous configuration. This function should be called after each Describe block in an integration test to ensure the DSC LCM is reset before another test DSC configuration is applied. .EXAMPLE Reset-DSC This command will reset the DSC LCM and clear out any DSC configurations. #> function Reset-DSC { [CmdletBinding()] param () Write-Verbose -Message 'Resetting the DSC LCM' Stop-DscConfiguration -ErrorAction 'SilentlyContinue' -Force Remove-DscConfigurationDocument -Stage 'Current' -Force Remove-DscConfigurationDocument -Stage 'Pending' -Force Remove-DscConfigurationDocument -Stage 'Previous' -Force } <# .SYNOPSIS Tests if a PowerShell file contains a DSC class resource. .PARAMETER FilePath The full path to the file to test. .EXAMPLE Test-ContainsClassResource -ModulePath 'c:\mymodule\myclassmodule.psm1' This command will test myclassmodule for the presence of any class-based DSC resources. #> function Test-FileContainsClassResource { [OutputType([Boolean])] [CmdletBinding()] param ( [Parameter(ValueFromPipeline = $true, Mandatory = $true)] [String] $FilePath ) $fileAst = [System.Management.Automation.Language.Parser]::ParseFile($FilePath, [ref]$null, [ref]$null) foreach ($fileAttributeAst in $fileAst.FindAll({$args[0] -is [System.Management.Automation.Language.AttributeAst]}, $false)) { if ($fileAttributeAst.Extent.Text -ieq '[DscResource()]') { return $true } } return $false } <# .SYNOPSIS Retrieves the name(s) of any DSC class resources from a PowerShell file. .PARAMETER FilePath The full path to the file to test. .EXAMPLE Get-ClassResourceNameFromFile -FilePath 'c:\mymodule\myclassmodule.psm1' This command will get any DSC class resource names from the myclassmodule module. #> function Get-ClassResourceNameFromFile { [OutputType([String[]])] [CmdletBinding()] param ( [Parameter(ValueFromPipeline = $true, Mandatory = $true)] [String] $FilePath ) $classResourceNames = [String[]]@() if (Test-FileContainsClassResource -FilePath $FilePath) { $fileAst = [System.Management.Automation.Language.Parser]::ParseFile($FilePath, [ref]$null, [ref]$null) $typeDefinitionAsts = $fileAst.FindAll({$args[0] -is [System.Management.Automation.Language.TypeDefinitionAst]}, $false) foreach ($typeDefinitionAst in $typeDefinitionAsts) { if ($typeDefinitionAst.Attributes.TypeName.Name -ieq 'DscResource') { $classResourceNames += $typeDefinitionAst.Name } } } return $classResourceNames } <# .SYNOPSIS Tests if a module contains a script resource. .PARAMETER ModulePath The path to the module to test. #> function Test-ModuleContainsScriptResource { [OutputType([Boolean])] [CmdletBinding()] param ( [Parameter(ValueFromPipeline = $true, Mandatory = $true)] [String] $ModulePath ) $dscResourcesFolderFilePath = Join-Path -Path $ModulePath -ChildPath 'DscResources' $mofSchemaFiles = Get-ChildItem -Path $dscResourcesFolderFilePath -Filter '*.schema.mof' -File -Recurse return ($null -ne $mofSchemaFiles) } <# .SYNOPSIS Tests if a module contains a class resource. .PARAMETER ModulePath The path to the module to test. #> function Test-ModuleContainsClassResource { [OutputType([Boolean])] [CmdletBinding()] param ( [Parameter(ValueFromPipeline = $true, Mandatory = $true)] [String] $ModulePath ) $psm1Files = Get-Psm1FileList -FilePath $ModulePath foreach ($psm1File in $psm1Files) { if (Test-FileContainsClassResource -FilePath $psm1File.FullName) { return $true } } return $false } <# .SYNOPSIS Retrieves all .psm1 files under the given file path. .PARAMETER FilePath The root file path to gather the .psm1 files from. #> function Get-Psm1FileList { [OutputType([Object[]])] [CmdletBinding()] param ( [Parameter(ValueFromPipeline = $true, Mandatory = $true)] [String] $FilePath ) return Get-ChildItem -Path $FilePath -Filter '*.psm1' -File -Recurse } <# .SYNOPSIS Retrieves the parse errors for the given file. .PARAMETER FilePath The path to the file to get parse errors for. #> function Get-FileParseErrors { [OutputType([System.Management.Automation.Language.ParseError[]])] [CmdletBinding()] param ( [Parameter(ValueFromPipeline = $true, Mandatory = $true)] [String] $FilePath ) $parseErrors = $null $null = [System.Management.Automation.Language.Parser]::ParseFile($FilePath, [ref] $null, [ref] $parseErrors) return $parseErrors } <# .SYNOPSIS Retrieves all text files under the given root file path. .PARAMETER Root The root file path under which to retrieve all text files. .NOTES Retrieves all files with the '.gitignore', '.gitattributes', '.ps1', '.psm1', '.psd1', '.json', '.xml', '.cmd', or '.mof' file extensions. #> function Get-TextFilesList { [OutputType([System.IO.FileInfo[]])] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [String] $Root ) $textFileExtensions = @('.gitignore', '.gitattributes', '.ps1', '.psm1', '.psd1', '.json', '.xml', '.cmd', '.mof','.md','.js','.yml') return Get-ChildItem -Path $Root -File -Recurse | Where-Object { $textFileExtensions -contains $_.Extension } } <# .SYNOPSIS Tests if a file is encoded in Unicode. .PARAMETER FileInfo The file to test. #> function Test-FileInUnicode { [OutputType([Boolean])] [CmdletBinding()] param ( [Parameter(ValueFromPipeline = $true, Mandatory = $true)] [System.IO.FileInfo] $FileInfo ) $filePath = $FileInfo.FullName $fileBytes = [System.IO.File]::ReadAllBytes($filePath) $zeroBytes = @( $fileBytes -eq 0 ) return ($zeroBytes.Length -ne 0) } <# .SYNOPSIS Retrieves the names of all script resources for the given module. .PARAMETER ModulePath The path to the module to retrieve the script resource names of. #> function Get-ModuleScriptResourceNames { [OutputType([String[]])] [CmdletBinding()] param ( [Parameter(ValueFromPipeline = $true, Mandatory = $true)] [String] $ModulePath ) $scriptResourceNames = @() $dscResourcesFolderFilePath = Join-Path -Path $ModulePath -ChildPath 'DscResources' $mofSchemaFiles = Get-ChildItem -Path $dscResourcesFolderFilePath -Filter '*.schema.mof' -File -Recurse foreach ($mofSchemaFile in $mofSchemaFiles) { $scriptResourceName = $mofSchemaFile.BaseName -replace '.schema','' $scriptResourceNames += $scriptResourceName } return $scriptResourceNames } <# .SYNOPSIS Imports the PS Script Analyzer module. Installs the module from the PowerShell Gallery if it is not already installed. #> function Import-PSScriptAnalyzer { [CmdletBinding()] param () $psScriptAnalyzerModule = Get-Module -Name 'PSScriptAnalyzer' -ListAvailable if ($null -eq $psScriptAnalyzerModule) { Write-Verbose -Message 'Installing PSScriptAnalyzer from the PowerShell Gallery' $userProfilePSModulePathItem = Get-UserProfilePSModulePathItem $psScriptAnalyzerModulePath = Join-Path -Path $userProfilePSModulePathItem -ChildPath PSScriptAnalyzer Install-ModuleFromPowerShellGallery -ModuleName 'PSScriptAnalyzer' -DestinationPath $psScriptAnalyzerModulePath } $psScriptAnalyzerModule = Get-Module -Name 'PSScriptAnalyzer' -ListAvailable <# When using custom rules in PSSA the Get-Help cmdlet gets called by PSSA. This causes a warning to be thrown in AppVeyor. This warning does not cause a failure or error, but causes additional bloat to the analyzer output. To suppress this the registry key HKLM:\Software\Microsoft\PowerShell\DisablePromptToUpdateHelp should be set to 1 when running in AppVeyor. See this line from PSSA in GetExternalRule() method for more information: https://github.com/PowerShell/PSScriptAnalyzer/blob/development/Engine/ScriptAnalyzer.cs#L1120 #> if ($env:APPVEYOR -eq $true) { Set-ItemProperty -Path HKLM:\Software\Microsoft\PowerShell -Name DisablePromptToUpdateHelp -Value 1 } Import-Module -Name $psScriptAnalyzerModule } <# .SYNOPSIS Imports the xDscResourceDesigner module. Installs the module from the PowerShell Gallery if it is not already installed. #> function Import-xDscResourceDesigner { [CmdletBinding()] param () $xDscResourceDesignerModule = Get-Module -Name 'xDscResourceDesigner' -ListAvailable if ($null -eq $xDscResourceDesignerModule) { Write-Verbose -Message 'Installing xDscResourceDesigner from the PowerShell Gallery' $userProfilePSModulePathItem = Get-UserProfilePSModulePathItem $xDscResourceDesignerModulePath = Join-Path -Path $userProfilePSModulePathItem -ChildPath xDscResourceDesigner Install-ModuleFromPowerShellGallery -ModuleName 'xDscResourceDesigner' -DestinationPath $xDscResourceDesignerModulePath } $xDscResourceDesignerModule = Get-Module -Name 'xDscResourceDesigner' -ListAvailable Import-Module -Name $xDscResourceDesignerModule } <# .SYNOPSIS Retrieves the list of suppressed PSSA rules in the file at the given path. .PARAMETER FilePath The path to the file to retrieve the suppressed rules of. #> function Get-SuppressedPSSARuleNameList { [OutputType([String[]])] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [String] $FilePath ) $suppressedPSSARuleNames = [String[]]@() $fileAst = [System.Management.Automation.Language.Parser]::ParseFile($FilePath, [ref]$null, [ref]$null) # Overall file attrbutes $attributeAsts = $fileAst.FindAll({$args[0] -is [System.Management.Automation.Language.AttributeAst]}, $true) foreach ($attributeAst in $attributeAsts) { if ([System.Diagnostics.CodeAnalysis.SuppressMessageAttribute].FullName.ToLower().Contains($attributeAst.TypeName.FullName.ToLower())) { $suppressedPSSARuleNames += $attributeAst.PositionalArguments.Extent.Text } } return $suppressedPSSARuleNames } <# .SYNOPSIS Downloads and installs a specific version of Nuget.exe to be used to produce DSC Resouce NUPKG files. This allows control over the version of Nuget.exe that is used. This helps resolve an issue with different versions of Nuget.exe formatting the version number in the filename of a produced NUPKG file. See https://github.com/PowerShell/xNetworking/issues/177 for more information. .PARAMETER OutFile The path to the download Nuget.exe to. .PARAMETER Uri The URI to use to dowload Nuget.exe from. #> function Install-NugetExe { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [String] $OutFile, [String] $Uri = 'https://dist.nuget.org/win-x86-commandline/v3.4.4/NuGet.exe' ) if (Test-Path -Path $OutFile) { Remove-Item -Path $OutFile -Force } Invoke-WebRequest -Uri $Uri -OutFile $OutFile } # Install-NugetExe <# .SYNOPSIS Gets the current Pester Describe block name #> function Get-PesterDescribeName { return Get-CommandNameParameterValue -Command 'Describe' } <# .SYNOPSIS Gets the opt-in status of the current pester Describe block. Writes a warning if the test is not opted-in. .PARAMETER OptIns An array of what is opted-in #> function Get-PesterDescribeOptInStatus { param ( [string[]]$OptIns ) $describeName = Get-PesterDescribeName $optIn = $OptIns -icontains $describeName if(!$optIn) { $message = @" Describe $describeName will not fail unless you opt-in. To opt-in, create a '.MetaTestOptIn.json' at the root of the repo in the following format: [ "$describeName" ] "@ Write-Warning -Message $message } return $optIn } <# .SYNOPSIS Gets the value of the Name parameter for the specified command in the stack .PARAMETER Command The name of the command to find the Name parameter for #> function Get-CommandNameParameterValue { Param( [Parameter(Mandatory=$true)] [string] $Command ) $commandStackItem = (Get-PSCallStack).Where{$_.Command -eq $Command} $commandArgumentNameValues = $commandStackItem.Arguments.TrimStart('{',' ').TrimEnd('}',' ') -split '\s*,\s*' $nameParameterValue = ($commandArgumentNameValues.Where{ $_ -like 'name=*'} -split '=')[-1] return $nameParameterValue } <# .SYNOPSIS Returns first the item in $env:PSModulePath that matches the given Prefix ($env:PSModulePath is list of semicolon-separated items). If no items are found, it reports an error. .PARAMETER Prefix Path prefix to look for. .NOTES If there are multiple matching items, the function returns the first item that occurs in the module path; this matches the lookup behavior of PowerSHell, which looks at the items in the module path in order of occurrence. .EXAMPLE If $env:PSModulePath is C:\Program Files\WindowsPowerShell\Modules;C:\Users\foo\Documents\WindowsPowerShell\Modules;C:\Windows\system32\WindowsPowerShell\v1.0\Modules then Get-PSModulePathItem C:\Users will return C:\Users\foo\Documents\WindowsPowerShell\Modules #> function Get-PSModulePathItem { param( [Parameter(Mandatory, Position = 0)] [string] $Prefix ) $item = $env:PSModulePath.Split(';') | Where-Object -FilterScript { $_ -like "$Prefix*" } | Select-Object -First 1 if (!$item) { Write-Error -Message "Cannot find the requested item in the PowerShell module path.`n`$env:PSModulePath = $env:PSModulePath" } return $item } <# .SYNOPSIS Returns the first item in $env:PSModulePath that is a path under $env:USERPROFILE. If no items are found, it reports an error. .EXAMPLE If $env:PSModulePath is C:\Program Files\WindowsPowerShell\Modules;C:\Users\foo\Documents\WindowsPowerShell\Modules;C:\Windows\system32\WindowsPowerShell\v1.0\Modules and the current user is 'foo', then Get-UserProfilePSModulePathItem will return C:\Users\foo\Documents\WindowsPowerShell\Modules #> function Get-UserProfilePSModulePathItem { param() return Get-PSModulePathItem -Prefix $env:USERPROFILE } <# .SYNOPSIS Returns the first item in $env:PSModulePath that is a path under $env:USERPROFILE. If no items are found, it reports an error. .EXAMPLE If $env:PSModulePath is C:\Program Files\WindowsPowerShell\Modules;C:\Users\foo\Documents\WindowsPowerShell\Modules;C:\Windows\system32\WindowsPowerShell\v1.0\Modules then Get-PSHomePSModulePathItem will return C:\Windows\system32\WindowsPowerShell\v1.0\Modules #> function Get-PSHomePSModulePathItem { param() return Get-PSModulePathItem -Prefix $global:PSHOME } <# .SYNOPSIS Tests if a file contains Byte Order Mark (BOM). .PARAMETER FilePath The file path to evaluate. #> function Test-FileHasByteOrderMark { param ( [Parameter(Mandatory = $true)] [System.String] $FilePath ) # This reads the first three bytes of the first row. $firstThreeBytes = Get-Content -Path $FilePath -Encoding Byte -ReadCount 3 -TotalCount 3 # Check for the correct byte order (239,187,191) which equal the Byte Order Mark (BOM). return ($firstThreeBytes[0] -eq 239 ` -and $firstThreeBytes[1] -eq 187 ` -and $firstThreeBytes[2] -eq 191) } <# .SYNOPSIS This returns a string containing the relative path from the module root. .PARAMETER FilePath The file path to remove the module root path from. .PARAMETER ModuleRootFilePath The root path to remove from the file path. #> function Get-RelativePathFromModuleRoot { param ( [Parameter(Mandatory = $true)] [System.String] $FilePath, [Parameter(Mandatory = $true)] [System.String] $ModuleRootFilePath ) <# Removing the module root path from the file path so that the path doesn't get so long in the Pester output. #> return ($FilePath -replace [Regex]::Escape($ModuleRootFilePath),'').Trim('\') } <# .SYNOPSIS Gets an array of DSC Resource modules imported in a DSC Configuration file. .PARAMETER ConfigurationPath The path to the configuration file to get the list from. #> function Get-ResourceModulesInConfiguration { [CmdletBinding()] [OutputType([System.Collections.Hashtable[]])] param ( [Parameter(Mandatory = $true)] [System.String] $ConfigurationPath ) # Resource modules $listedModules = @() # Get the AST object for the configuration $dscConfigurationAST = [System.Management.Automation.Language.Parser]::ParseFile($ConfigurationPath , [ref]$null, [ref]$Null) # Get all the Import-DscResource module commands $findAllImportDscResources = { $args[0] -is [System.Management.Automation.Language.DynamicKeywordStatementAst] ` -and $args[0].CommandElements[0].Value -eq 'Import-DscResource' } $importDscResourceCmds = $dscConfigurationAST.EndBlock.FindAll( $findAllImportDscResources, $true ) foreach ($importDscResourceCmd in $importDscResourceCmds) { $parameterName = 'ModuleName' $moduleName = '' $moduleVersion = '' foreach ($element in $importDscResourceCmd.CommandElements) { # For each element in the Import-DscResource command determine what it means if ($element -is [System.Management.Automation.Language.CommandParameterAst]) { $parameterName = $element.ParameterName } elseif ($element -is [System.Management.Automation.Language.StringConstantExpressionAst] ` -and $element.Value -ne 'Import-DscResource') { switch ($parameterName) { 'ModuleName' { $moduleName = $element.Value } # ModuleName 'ModuleVersion' { $moduleVersion = $element.Value } # ModuleVersion } # switch } elseif ($element -is [System.Management.Automation.Language.ArrayLiteralAst]) { <# This is an array of strings (usually something like xNetworking,xWebAdministration) So we need to add each module to the list #> foreach ($item in $element.Elements) { $listedModules += @{ Name = $item.Value } } # foreach } # if } # foreach # Did a module get identified when stepping through the elements? if (-not [String]::IsNullOrEmpty($moduleName)) { if ([String]::IsNullOrEmpty($moduleVersion)) { $listedModules += @{ Name = $moduleName } } else { $listedModules += @{ Name = $moduleName Version = $moduleVersion } } } # if } # foreach return $listedModules } <# .SYNOPSIS Installs dependent modules in the user scope, if not already available and only if run on an AppVeyor build worker. If not run on a AppVeyor build worker, it will output a warning saying that the users must install the correct module to be able to run the test. .PARAMETER Module An array of hash tables containing one or more dependent modules that should be installed. The correct array is returned by the helper function Get-ResourceModulesInConfiguration. Hash table should be in this format. Where property Name is mandatory and property Version is optional. @{ Name = 'xStorage' [Version = '3.2.0.0'] } #> function Install-DependentModule { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.Collections.Hashtable[]] $Module ) # Check any additional modules required are installed foreach ($requiredModule in $Module) { if (-not (Get-Module @requiredModule -ListAvailable -ErrorAction SilentlyContinue)) { # The required module is missing from this machine if ($requiredModule.ContainsKey('Version')) { $requiredModuleName = ('{0} version {1}' -f $requiredModule.Name, $requiredModule.Version) } else { $requiredModuleName = ('{0}' -f $requiredModule.Name) } if ($env:APPVEYOR -eq $true) { <# Tests are running in AppVeyor so just install the module. If not installed by using Force then the error message "User declined to install untrusted module (<module name>)." is thrown #> $installModuleParameters = @{ Name = $requiredModule.Name Force = $true } if ($requiredModule.ContainsKey('Version')) { $installModuleParameters['RequiredVersion'] = $requiredModule.Version } Write-Verbose -Message "Installing module $requiredModuleName required to compile a configuration." -Verbose try { Install-Module @installModuleParameters -Scope CurrentUser } catch { throw "An error occurred installing the required module $($requiredModuleName) : $_" } } else { # Warn the user that the test fill fail Write-Warning -Message ("To be able to compile a configuration the resource module $requiredModuleName " + ` 'is required but it is not installed on this computer. ' + ` 'The test that is dependent on this module will fail until the required module is installed. ' + ` 'Please install it from the PowerShell Gallery to enable these tests to pass.') } # if } # if } # foreach } <# .SYNOPSIS Returns the integration test order number if it exists in the attribute 'Microsoft.DscResourceKit.IntegrationTest' with the named attribute argument 'OrderNumber'. If it is not found, a $null value will be returned. .PARAMETER Path A path to the configuration file to search for the attribute 'Microsoft.DscResourceKit.IntegrationTest' with the named attribute argument 'OrderNumber'. #> function Get-DscIntegrationTestOrderNumber { [CmdletBinding()] [OutputType([System.UInt32])] param ( [Parameter()] [ValidateNotNullOrEmpty()] [String] $Path ) <# Will always return $null if the attribute 'Microsoft.DscResourceKit.IntegrationTest' is not found with the named attribute argument 'OrderNumber'. #> $returnValue = $null # Change WarningAction so it does not output a warning for the sealed class. Add-Type -Path (Join-Path -Path $PSScriptRoot -ChildPath 'Microsoft.DscResourceKit.cs') -WarningAction SilentlyContinue $scriptBlockAst = [System.Management.Automation.Language.Parser]::ParseFile($Path, [ref] $null, [ref] $null) $findIntegrationTestAttributeFilter = { $args[0] -is [System.Management.Automation.Language.AttributeAst] ` -and ( $args[0].TypeName.FullName -eq 'IntegrationTest' ` -or $args[0].TypeName.FullName -eq 'Microsoft.DscResourceKit.IntegrationTest' ) } # Get IntegrationTest attribute in the file if it exist. [System.Management.Automation.Language.Ast[]] $integrationTestAttributeAst = ` $scriptBlockAst.Find($findIntegrationTestAttributeFilter, $true) if ($integrationTestAttributeAst) { $findOrderNumberNamedAttributeArgumentFilter = { $args[0] -is [System.Management.Automation.Language.NamedAttributeArgumentAst] ` -and $args[0].ArgumentName -eq 'OrderNumber' } [System.Management.Automation.Language.Ast[]] $orderNumberNamedAttributeArgumentAst = ` $integrationTestAttributeAst.Find($findOrderNumberNamedAttributeArgumentFilter, $true) if ($orderNumberNamedAttributeArgumentAst) { $returnValue = $orderNumberNamedAttributeArgumentAst.Argument.Value } } return $returnValue } <# .SYNOPSIS Returns $true if the current repository being tested is DscResource.Tests, otherwise the value returned will be $false. .NOTES There are two scenarios. 1. Testing DscResource.Tests; path C:\Projects\DscResource.Tests, or V:\Source\GitHub\DscResource.Tests (or any other path used by users). 2. Testing a DSC resource module (ie. xStorage); path C:\Projects\xStorage\DscResource.Tests, or V:\Source\GitHub\xStorage\DscResource.Tests (or any other path used by users). In both these scenarios, when the tests are run, the $PSScriptRoot (current folder) is set to one of the above paths, that is $PSScriptRoot (current folder) will always be set to the DscResource.Tests folder. The following logic will determine if we are running the code on the repository DscResource.Tests or some other resource module. If the parent folder of $PSScriptRoot does NOT contain a module manifest we will assume that DscResource.Test is the module being tested. Example: Current folder: c:\source\DscResource.Tests Parent folder: c:\source Module manifest: $null If the parent folder of $PSScriptRoot do contain a module manifest we will assume that DscResource.Test has been cloned into another resource module and it is that resource module that is being tested. Example: Current folder: c:\source\xSQLServer\DscResource.Tests Parent folder: c:\source\xSQLServer Module manifest: c:\source\xSQLServer\xSQLServer.psd1 #> function Test-IsRepositoryDscResourceTests { [CmdletBinding()] [OutputType([System.Boolean])] param ( ) $moduleRootFilePath = Split-Path -Path $PSScriptRoot -Parent $moduleManifestExistInModuleRootFilePath = Get-ChildItem -Path $moduleRootFilePath -Filter '*.psd1' if (-not $moduleManifestExistInModuleRootFilePath) { return $true } else { return $false } } Export-ModuleMember -Function @( 'New-Nuspec', ` 'Install-ModuleFromPowerShellGallery', ` 'Initialize-TestEnvironment', ` 'Restore-TestEnvironment', ` 'Get-ClassResourceNameFromFile', ` 'Test-ModuleContainsScriptResource', ` 'Test-ModuleContainsClassResource', ` 'Get-Psm1FileList', ` 'Get-FileParseErrors', ` 'Get-TextFilesList', ` 'Test-FileInUnicode', ` 'Get-ModuleScriptResourceNames', ` 'Import-PSScriptAnalyzer', ` 'Import-xDscResourceDesigner', ` 'Get-SuppressedPSSARuleNameList', 'Reset-DSC', 'Install-NugetExe', 'Get-PesterDescribeOptInStatus', 'Get-UserProfilePSModulePathItem', 'Get-PSHomePSModulePathItem', 'Test-FileHasByteOrderMark', 'Get-RelativePathFromModuleRoot', 'Get-ResourceModulesInConfiguration', 'Install-DependentModule', 'Get-DscIntegrationTestOrderNumber', 'Test-IsRepositoryDscResourceTests' ) |