Templates/NewModule/_build.psake.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 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 |
#Requires -Modules psake ############################################################################## # DO NOT MODIFY THIS FILE! Modify build.settings.ps1 instead. ############################################################################## ############################################################################## # This is the PowerShell Module psake build script. It defines the following tasks: # # Clean, Build, Sign, BuildHelp, Install, Test and Publish. # # The default task is Build. This task copies the appropriate files from the # $SrcRootDir under the $OutDir. Later, other tasks such as Sign and BuildHelp # will further modify the contents of $OutDir and add new files. # # The Sign task will only sign scripts if the $SignScripts variable is set to # $true. A code-signing certificate is required for this task to complete. # # The BuildHelp task invokes platyPS to generate markdown files from # comment-based help for your exported commands. platyPS then generates # a help file for your module from the markdown files. # # The Install task simplies copies the module folder under $OutDir to your # profile's Modules folder. # # The Test task invokes Pester on the $TestRootDir. # # The Publish task uses the Publish-Module command to publish # to either the PowerShell Gallery (the default) or you can change # the $PublishRepository property to the name of an alternate repository. # Note: the Publish task requires that the Test task execute without failures. # # You can exeute a specific task, such as the Test task by running the # following command: # # PS C:\> invoke-psake _build.psake.ps1 -taskList Test # # You can execute the Publish task with the following command. # The first time you execute the Publish task, you will be prompted to enter # your PowerShell Gallery NuGetApiKey. After entering the key, it is encrypted # and stored so you will not have to enter it again. # # PS C:\> invoke-psake _build.psake.ps1 -taskList Publish # # You can verify the stored and encrypted NuGetApiKey by running the following # command which will display a portion of your NuGetApiKey in plain text. # # PS C:\> invoke-psake _build.psake.ps1 -taskList ShowApiKey # # You can store a new NuGetApiKey with this command. You can leave off # the -properties parameter and you'll be prompted for the key. # # PS C:\> invoke-psake _build.psake.ps1 -taskList StoreApiKey -properties @{NuGetApiKey='test123'} # ############################################################################### # Dot source the user's customized properties and extension tasks. ############################################################################### . $PSScriptRoot\_build.settings.ps1 ############################################################################### # Private properties. ############################################################################### Properties { [System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseDeclaredVarsMoreThanAssigments', '')] $ModuleOutDir = "$OutDir\$ModuleName" [System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseDeclaredVarsMoreThanAssigments', '')] $UpdatableHelpOutDir = "$OutDir\UpdatableHelp" [System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseDeclaredVarsMoreThanAssigments', '')] $SharedProperties = @{} [System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseDeclaredVarsMoreThanAssigments', '')] $LineSep = "-" * 78 } ############################################################################### # Core task implementations. Avoid modifying these tasks. ############################################################################### Task default -depends Build Task Init -requiredVariables OutDir { if (!(Test-Path -LiteralPath $OutDir)) { New-Item $OutDir -ItemType Directory -Verbose:$VerbosePreference > $null } else { Write-Verbose "$($psake.context.currentTaskName) - directory already exists '$OutDir'." } } Task ExportPublicFunctions -requiredVariables SrcRootDir, ModuleOutDir, ModuleName { $PublicScriptFiles = @(Get-ChildItem "$SrcRootDir\Public" -Filter *.ps1 -Recurse) $PublicFunctions = @(foreach ($ScriptFile in $PublicScriptFiles) { $Parser = [System.Management.Automation.Language.Parser]::ParseFile($ScriptFile.FullName, [ref] $null, [ref] $null) if ($Parser.EndBlock.Statements.Name) { $Parser.EndBlock.Statements.Name } }) if ($PublicFunctions.Count -ge 1) { Update-ModuleManifest -Path "$ModuleOutDir\$ModuleName.psd1" -FunctionsToExport $PublicFunctions } else { "No public fuctions to export." } } Task ExportFunctionsToSrc -requiredVariables SrcRootDir, ModuleName { $PublicScriptFiles = @(Get-ChildItem "$SrcRootDir\Public" -Filter *.ps1 -Recurse) $PublicFunctions = @(foreach ($ScriptFile in $PublicScriptFiles) { $Parser = [System.Management.Automation.Language.Parser]::ParseFile($ScriptFile.FullName, [ref] $null, [ref] $null) if ($Parser.EndBlock.Statements.Name) { $Parser.EndBlock.Statements.Name } }) if ($PublicFunctions.Count -ge 1) { Update-ModuleManifest -Path "$SrcRootDir\$ModuleName.psd1" -FunctionsToExport $PublicFunctions } else { "No public fuctions to export." } } Task Clean -depends Init -requiredVariables OutDir { if ($OutDir.Length -gt 3) { Get-ChildItem $OutDir | Remove-Item -Recurse -Force -Verbose:$VerbosePreference } else { Write-Verbose "$($psake.context.currentTaskName) - `$OutDir '$OutDir' must be longer than 3 characters." } } Task StageFiles -depends Init, Clean, BeforeStageFiles, CoreStageFiles, AfterStageFiles, ExportPublicFunctions { } Task CoreStageFiles -requiredVariables ModuleOutDir, SrcRootDir, ModuleName { if (!(Test-Path -LiteralPath $ModuleOutDir)) { New-Item $ModuleOutDir -ItemType Directory -Verbose:$VerbosePreference > $null } else { Write-Verbose "$($psake.context.currentTaskName) - directory already exists '$ModuleOutDir'." } if (-not ($ConcatenateBuild)) { Copy-Item -Path $SrcRootDir\* -Destination $ModuleOutDir -Recurse -Exclude $Exclude -Verbose:$VerbosePreference } else { "Module concatenation is enabled. Level $ConcatenationLevel" switch ($ConcatenationLevel) { 1 { $FunctionFolders = @("Private","Public") [regex] $FunctionFoldersRegEx = '(?i)' + (($FunctionFolders | ForEach-Object {[regex]::escape($_)}) -join "|") + '' # Copy all but Public and Private $ToCopy = Get-ChildItem -Path $SrcRootDir -Recurse | Where-Object { $_.FullName.Replace($SrcRootDir, "") -notmatch $FunctionFoldersRegEx } foreach ($Item in $ToCopy) { # Ignore empty folders. if ($Item.PSIsContainer -and -not($Item.GetFiles())) { continue } $Item | Copy-Item -Destination { if ($_.PSIsContainer) { Join-Path $ModuleOutDir $_.Parent.FullName.Substring($SrcRootDir.length) } else { Join-Path $ModuleOutDir $_.FullName.Substring($SrcRootDir.length) } } -Force } # Copy contents of Public and Private files instead of the files themselves. ## Private functions are concatinated to Private\PrivateFunctions.ps1 ## Public functions are appended to the psm1 file. $PublicFunctions = Get-ChildItem (Join-Path $SrcRootDir 'Public') -Filter *.ps1 -Recurse $PrivateFunctions = Get-ChildItem (Join-Path $SrcRootDir 'Private') -Filter *.ps1 -Recurse $PrivateFile = Join-Path $ModuleOutDir 'Private\PrivateFunctions.ps1' New-Item $PrivateFile -Force | Out-Null Get-Content $PrivateFunctions.FullName | Set-Content $PrivateFile -Force Get-Content $PublicFunctions.FullName -Raw | Out-File (Join-Path $ModuleOutDir "$ModuleName.psm1") -Append -Encoding ASCII } 2 { # Copy non-script files. Get-ChildItem -Path $SrcRootDir -Directory -Recurse | Where-Object { $_.GetFiles() -and $_.GetFiles().Extension -notmatch [regex]"ps1" } | Copy-Item -Destination {Join-Path $ModuleOutDir ($_.Parent.FullName.Substring($SrcRootDir.length))} Get-ChildItem -Path $SrcRootDir -File -Recurse | Where-Object { $_.Name.Split('.')[-1] -notmatch [regex]"^ps1$" } | Copy-Item -Destination { Join-Path $ModuleOutDir $_.FullName.Substring($SrcRootDir.length) } -Force # Concatinate the rest. $Files = Get-ChildItem -Path $SrcRootDir -File -Recurse | Where-Object { $_.Name.Split('.')[-1] -match [regex]"^ps1$" } $ModuleManifest = Join-Path $ModuleOutDir "$ModuleName.psm1" $ManifestContent = Get-Content $ModuleManifest -Raw $Lines = foreach ($File in $Files) { foreach ($Line in [System.IO.File]::ReadLines($File.FullName)) { if ($Line -like "#Requires*") { [pscustomobject]@{Level = 0 ; Line = $Line} } elseif ($Line -like "Using*") { [pscustomobject]@{Level = 1 ; Line = $Line} } else { [pscustomobject]@{Level = 2 ; Line = $Line} } } } Set-Content $ModuleManifest -Value $null -Encoding Ascii -Force $Lines | Where-Object { $_.Level -eq 0 } | Select -ExpandProperty Line | Out-File $ModuleManifest -Append -Encoding ascii $Lines | Where-Object { $_.Level -eq 1 } | Select -ExpandProperty Line | Out-File $ModuleManifest -Append -Encoding ascii $ManifestContent | Out-File $ModuleManifest -Append -Encoding ascii $Lines | Where-Object { $_.Level -eq 2 } | Select -ExpandProperty Line | Out-File $ModuleManifest -Append -Encoding ascii } default { Copy-Item -Path $SrcRootDir\* -Destination $ModuleOutDir -Recurse -Exclude $Exclude -Verbose:$VerbosePreference } } } } Task Build -depends Init, Clean, BeforeBuild, StageFiles, Analyze, Sign, AfterBuild { } Task Analyze -depends StageFiles ` -requiredVariables ModuleOutDir, ScriptAnalysisEnabled, ScriptAnalysisFailBuildOnSeverityLevel, ScriptAnalyzerSettingsPath { if (!$ScriptAnalysisEnabled) { "Script analysis is not enabled. Skipping $($psake.context.currentTaskName) task." return } if (!(Get-Module PSScriptAnalyzer -ListAvailable)) { "PSScriptAnalyzer module is not installed. Skipping $($psake.context.currentTaskName) task." return } "ScriptAnalysisFailBuildOnSeverityLevel set to: $ScriptAnalysisFailBuildOnSeverityLevel" $analysisResult = Invoke-ScriptAnalyzer -Path $ModuleOutDir -Settings $ScriptAnalyzerSettingsPath -Recurse -Verbose:$VerbosePreference $analysisResult | Format-Table switch ($ScriptAnalysisFailBuildOnSeverityLevel) { 'None' { return } 'Error' { Assert -conditionToCheck ( ($analysisResult | Where-Object Severity -eq 'Error').Count -eq 0 ) -failureMessage 'One or more ScriptAnalyzer errors were found. Build cannot continue!' } 'Warning' { Assert -conditionToCheck ( ($analysisResult | Where-Object { $_.Severity -eq 'Warning' -or $_.Severity -eq 'Error' }).Count -eq 0) -failureMessage 'One or more ScriptAnalyzer warnings were found. Build cannot continue!' } default { Assert -conditionToCheck ( $analysisResult.Count -eq 0 ) -failureMessage 'One or more ScriptAnalyzer issues were found. Build cannot continue!' } } } Task Sign -depends StageFiles -requiredVariables CertPath, SettingsPath, ScriptSigningEnabled { if (!$ScriptSigningEnabled) { "Script signing is not enabled. Skipping $($psake.context.currentTaskName) task." return } $validCodeSigningCerts = Get-ChildItem -Path $CertPath -CodeSigningCert -Recurse | Where-Object NotAfter -ge (Get-Date) if (!$validCodeSigningCerts) { throw "There are no non-expired code-signing certificates in $CertPath. You can either install " + "a code-signing certificate into the certificate store or disable script analysis in build.settings.ps1." } $certSubjectNameKey = "CertSubjectName" $storeCertSubjectName = $true # Get the subject name of the code-signing certificate to be used for script signing. if (!$CertSubjectName -and ($CertSubjectName = GetSetting -Key $certSubjectNameKey -Path $SettingsPath)) { $storeCertSubjectName = $false } elseif (!$CertSubjectName) { "A code-signing certificate has not been specified." "The following non-expired, code-signing certificates are available in your certificate store:" $validCodeSigningCerts | Format-List Subject,Issuer,Thumbprint,NotBefore,NotAfter $CertSubjectName = Read-Host -Prompt 'Enter the subject name (case-sensitive) of the certificate to use for script signing' } # Find a code-signing certificate that matches the specified subject name. $certificate = $validCodeSigningCerts | Where-Object { $_.SubjectName.Name -cmatch [regex]::Escape($CertSubjectName) } | Sort-Object NotAfter -Descending | Select-Object -First 1 if ($certificate) { $SharedProperties.CodeSigningCertificate = $certificate if ($storeCertSubjectName) { SetSetting -Key $certSubjectNameKey -Value $certificate.SubjectName.Name -Path $SettingsPath "The new certificate subject name has been stored in ${SettingsPath}." } else { "Using stored certificate subject name $CertSubjectName from ${SettingsPath}." } $LineSep "Using code-signing certificate: $certificate" $LineSep $files = @(Get-ChildItem -Path $ModuleOutDir\* -Recurse -Include *.ps1,*.psm1) foreach ($file in $files) { $setAuthSigParams = @{ FilePath = $file.FullName Certificate = $certificate Verbose = $VerbosePreference } $result = Microsoft.PowerShell.Security\Set-AuthenticodeSignature @setAuthSigParams if ($result.Status -ne 'Valid') { throw "Failed to sign script: $($file.FullName)." } "Successfully signed script: $($file.Name)" } } else { $expiredCert = Get-ChildItem -Path $CertPath -CodeSigningCert -Recurse | Where-Object { ($_.SubjectName.Name -cmatch [regex]::Escape($CertSubjectName)) -and ($_.NotAfter -lt (Get-Date)) } Sort-Object NotAfter -Descending | Select-Object -First 1 if ($expiredCert) { throw "The code-signing certificate `"$($expiredCert.SubjectName.Name)`" EXPIRED on $($expiredCert.NotAfter)." } throw 'No valid certificate subject name supplied or stored.' } } Task BuildHelp -depends Build, BeforeBuildHelp, GenerateMarkdown, GenerateHelpFiles, AfterBuildHelp { } Task GenerateMarkdown -requiredVariables DefaultLocale, DocsRootDir, ModuleName, ModuleOutDir { if (!(Get-Module platyPS -ListAvailable)) { "platyPS module is not installed. Skipping $($psake.context.currentTaskName) task." return } $moduleInfo = Import-Module $ModuleOutDir\$ModuleName.psd1 -Global -Force -PassThru try { if ($moduleInfo.ExportedCommands.Count -eq 0) { "No commands have been exported. Skipping $($psake.context.currentTaskName) task." return } if (!(Test-Path -LiteralPath $DocsRootDir)) { New-Item $DocsRootDir -ItemType Directory > $null } if (Get-ChildItem -LiteralPath $DocsRootDir -Filter *.md -Recurse) { Get-ChildItem -LiteralPath $DocsRootDir -Directory | ForEach-Object { Update-MarkdownHelp -Path $_.FullName -Verbose:$VerbosePreference > $null } } # ErrorAction set to SilentlyContinue so this command will not overwrite an existing MD file. New-MarkdownHelp -Module $ModuleName -Locale $DefaultLocale -OutputFolder $DocsRootDir\$DefaultLocale ` -WithModulePage -ErrorAction SilentlyContinue -Verbose:$VerbosePreference > $null } finally { Remove-Module $ModuleName } } Task GenerateHelpFiles -requiredVariables DocsRootDir, ModuleName, ModuleOutDir, OutDir { if (!(Get-Module platyPS -ListAvailable)) { "platyPS module is not installed. Skipping $($psake.context.currentTaskName) task." return } if (!(Get-ChildItem -LiteralPath $DocsRootDir -Filter *.md -Recurse -ErrorAction SilentlyContinue)) { "No markdown help files to process. Skipping $($psake.context.currentTaskName) task." return } $helpLocales = (Get-ChildItem -Path $DocsRootDir -Directory).Name # Generate the module's primary MAML help file. foreach ($locale in $helpLocales) { New-ExternalHelp -Path $DocsRootDir\$locale -OutputPath $ModuleOutDir\$locale -Force ` -ErrorAction SilentlyContinue -Verbose:$VerbosePreference > $null } } Task BuildUpdatableHelp -depends BuildHelp, BeforeBuildUpdatableHelp, CoreBuildUpdatableHelp, AfterBuildUpdatableHelp { } Task CoreBuildUpdatableHelp -requiredVariables DocsRootDir, ModuleName, UpdatableHelpOutDir { if (!(Get-Module platyPS -ListAvailable)) { "platyPS module is not installed. Skipping $($psake.context.currentTaskName) task." return } $helpLocales = (Get-ChildItem -Path $DocsRootDir -Directory).Name # Create updatable help output directory. if (!(Test-Path -LiteralPath $UpdatableHelpOutDir)) { New-Item $UpdatableHelpOutDir -ItemType Directory -Verbose:$VerbosePreference > $null } else { Write-Verbose "$($psake.context.currentTaskName) - directory already exists '$UpdatableHelpOutDir'." Get-ChildItem $UpdatableHelpOutDir | Remove-Item -Recurse -Force -Verbose:$VerbosePreference } # Generate updatable help files. Note: this will currently update the version number in the module's MD # file in the metadata. foreach ($locale in $helpLocales) { New-ExternalHelpCab -CabFilesFolder $ModuleOutDir\$locale -LandingPagePath $DocsRootDir\$locale\$ModuleName.md ` -OutputFolder $UpdatableHelpOutDir -Verbose:$VerbosePreference > $null } } Task GenerateFileCatalog -depends Build, BuildHelp, BeforeGenerateFileCatalog, CoreGenerateFileCatalog, AfterGenerateFileCatalog { } Task CoreGenerateFileCatalog -requiredVariables CatalogGenerationEnabled, CatalogVersion, ModuleName, ModuleOutDir, OutDir { if (!$CatalogGenerationEnabled) { "FileCatalog generation is not enabled. Skipping $($psake.context.currentTaskName) task." return } if (!(Get-Command Microsoft.PowerShell.Security\New-FileCatalog -ErrorAction SilentlyContinue)) { "FileCatalog commands not available on this version of PowerShell. Skipping $($psake.context.currentTaskName) task." return } $catalogFilePath = "$OutDir\$ModuleName.cat" $newFileCatalogParams = @{ Path = $ModuleOutDir CatalogFilePath = $catalogFilePath CatalogVersion = $CatalogVersion Verbose = $VerbosePreference } Microsoft.PowerShell.Security\New-FileCatalog @newFileCatalogParams > $null if ($ScriptSigningEnabled) { if ($SharedProperties.CodeSigningCertificate) { $setAuthSigParams = @{ FilePath = $catalogFilePath Certificate = $SharedProperties.CodeSigningCertificate Verbose = $VerbosePreference } $result = Microsoft.PowerShell.Security\Set-AuthenticodeSignature @setAuthSigParams if ($result.Status -ne 'Valid') { throw "Failed to sign file catalog: $($catalogFilePath)." } "Successfully signed file catalog: $($catalogFilePath)" } else { "No code-signing certificate was found to sign the file catalog." } } else { "Script signing is not enabled. Skipping signing of file catalog." } Move-Item -LiteralPath $newFileCatalogParams.CatalogFilePath -Destination $ModuleOutDir } Task Install -depends Build, BuildHelp, GenerateFileCatalog, BeforeInstall, CoreInstall, AfterInstall { } Task CoreInstall -requiredVariables ModuleOutDir { if (!(Test-Path -LiteralPath $InstallPath)) { Write-Verbose 'Creating install directory' New-Item -Path $InstallPath -ItemType Directory -Verbose:$VerbosePreference > $null } Copy-Item -Path $ModuleOutDir\* -Destination $InstallPath -Verbose:$VerbosePreference -Recurse -Force "Module installed into $InstallPath" } Task Test -depends Build -requiredVariables TestRootDir, ModuleName, CodeCoverageEnabled, CodeCoverageFiles { if (!(Get-Module Pester -ListAvailable)) { "Pester module is not installed. Skipping $($psake.context.currentTaskName) task." return } Import-Module Pester try { Microsoft.PowerShell.Management\Push-Location -LiteralPath $TestRootDir if ($TestOutputFile) { $testing = @{ OutputFile = $TestOutputFile OutputFormat = $TestOutputFormat PassThru = $true Verbose = $VerbosePreference } } else { $testing = @{ PassThru = $true Verbose = $VerbosePreference } } # To control the Pester code coverage, a boolean $CodeCoverageEnabled is used. if ($CodeCoverageEnabled) { $testing.CodeCoverage = $CodeCoverageFiles } $testResult = Invoke-Pester @testing Assert -conditionToCheck ( $testResult.FailedCount -eq 0 ) -failureMessage "One or more Pester tests failed, build cannot continue." if ($CodeCoverageEnabled) { $testCoverage = [int]($testResult.CodeCoverage.NumberOfCommandsExecuted / $testResult.CodeCoverage.NumberOfCommandsAnalyzed * 100) "Pester code coverage on specified files: ${testCoverage}%" } } finally { Microsoft.PowerShell.Management\Pop-Location Remove-Module $ModuleName -ErrorAction SilentlyContinue } } Task Publish -depends Build, Test, BuildHelp, GenerateFileCatalog, BeforePublish, CorePublish, AfterPublish { } Task CorePublish -requiredVariables SettingsPath, ModuleOutDir { $publishParams = @{ Path = $ModuleOutDir NuGetApiKey = $NuGetApiKey } # Publishing to the PSGallery requires an API key, so get it. if ($NuGetApiKey) { "Using script embedded NuGetApiKey" } elseif ($NuGetApiKey = GetSetting -Path $SettingsPath -Key NuGetApiKey) { "Using stored NuGetApiKey" } else { $promptForKeyCredParams = @{ DestinationPath = $SettingsPath Message = 'Enter your NuGet API key in the password field' Key = 'NuGetApiKey' } $cred = PromptUserForCredentialAndStorePassword @promptForKeyCredParams $NuGetApiKey = $cred.GetNetworkCredential().Password "The NuGetApiKey has been stored in $SettingsPath" } $publishParams = @{ Path = $ModuleOutDir NuGetApiKey = $NuGetApiKey } # If an alternate repository is specified, set the appropriate parameter. if ($PublishRepository) { $publishParams['Repository'] = $PublishRepository } # Consider not using -ReleaseNotes parameter when Update-ModuleManifest has been fixed. if ($ReleaseNotesPath) { $publishParams['ReleaseNotes'] = @(Get-Content $ReleaseNotesPath) } "Calling Publish-Module..." Publish-Module @publishParams } ############################################################################### # Secondary/utility tasks - typically used to manage stored build settings. ############################################################################### Task ? -description 'Lists the available tasks' { "Available tasks:" $psake.context.Peek().Tasks.Keys | Sort-Object } Task RemoveApiKey -requiredVariables SettingsPath { if (GetSetting -Path $SettingsPath -Key NuGetApiKey) { RemoveSetting -Path $SettingsPath -Key NuGetApiKey } } Task StoreApiKey -requiredVariables SettingsPath { $promptForKeyCredParams = @{ DestinationPath = $SettingsPath Message = 'Enter your NuGet API key in the password field' Key = 'NuGetApiKey' } PromptUserForCredentialAndStorePassword @promptForKeyCredParams "The NuGetApiKey has been stored in $SettingsPath" } Task ShowApiKey -requiredVariables SettingsPath { $OFS = "" if ($NuGetApiKey) { "The embedded (partial) NuGetApiKey is: $($NuGetApiKey[0..7])" } elseif ($NuGetApiKey = GetSetting -Path $SettingsPath -Key NuGetApiKey) { "The stored (partial) NuGetApiKey is: $($NuGetApiKey[0..7])" } else { "The NuGetApiKey has not been provided or stored." return } "To see the full key, use the task 'ShowFullApiKey'" } Task ShowFullApiKey -requiredVariables SettingsPath { if ($NuGetApiKey) { "The embedded NuGetApiKey is: $NuGetApiKey" } elseif ($NuGetApiKey = GetSetting -Path $SettingsPath -Key NuGetApiKey) { "The stored NuGetApiKey is: $NuGetApiKey" } else { "The NuGetApiKey has not been provided or stored." } } Task RemoveCertSubjectName -requiredVariables SettingsPath { if (GetSetting -Path $SettingsPath -Key CertSubjectName) { RemoveSetting -Path $SettingsPath -Key CertSubjectName } } Task StoreCertSubjectName -requiredVariables SettingsPath { $certSubjectName = 'CN=' $certSubjectName += Read-Host -Prompt 'Enter the certificate subject name for script signing. Use exact casing, CN= prefix will be added' SetSetting -Key CertSubjectName -Value $certSubjectName -Path $SettingsPath "The new certificate subject name '$certSubjectName' has been stored in ${SettingsPath}." } Task ShowCertSubjectName -requiredVariables SettingsPath { $CertSubjectName = GetSetting -Path $SettingsPath -Key CertSubjectName "The stored certificate is: $CertSubjectName" $cert = Get-ChildItem -Path Cert:\CurrentUser\My -CodeSigningCert | Where-Object { $_.Subject -eq $CertSubjectName -and $_.NotAfter -gt (Get-Date) } | Sort-Object -Property NotAfter -Descending | Select-Object -First 1 if ($cert) { "A valid certificate for the subject $CertSubjectName has been found" } else { 'A valid certificate has not been found' } } Task BuildTests -requiredVariables SrcRootDir, TestRootDir { $PublicScriptFiles = @(Get-ChildItem "$SrcRootDir\Public" -Filter *.ps1 -Recurse) $PublicFunctions = @(foreach ($ScriptFile in $PublicScriptFiles) { $Parser = [System.Management.Automation.Language.Parser]::ParseFile($ScriptFile.FullName, [ref] $null, [ref] $null) if ($Parser.EndBlock.Statements.Name) { $Parser.EndBlock.Statements.Name } }) foreach ($Function in $PublicFunctions) { $TestFile = Join-Path $TestRootDir "$Function.Tests.ps1" if (Test-Path $TestFile) { continue } New-Item $TestFile -ErrorAction SilentlyContinue -Verbose:$VerbosePreference > $null $TestHead = @' [System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseDeclaredVarsMoreThanAssigments', '', Scope='*', Target='SuppressImportModule')] $SuppressImportModule = $false . $PSScriptRoot\Shared.ps1 '@ $TestBody = @" Describe '$Function' { } "@ $TestHead + $TestBody | Out-File $TestFile -Encoding Ascii } } ############################################################################### # Helper functions ############################################################################### function PromptUserForCredentialAndStorePassword { [Diagnostics.CodeAnalysis.SuppressMessage("PSProvideDefaultParameterValue", '')] param( [Parameter()] [ValidateNotNullOrEmpty()] [string] $DestinationPath, [Parameter(Mandatory)] [string] $Message, [Parameter(Mandatory, ParameterSetName = 'SaveSetting')] [string] $Key ) $cred = Get-Credential -Message $Message -UserName "ignored" if ($DestinationPath) { SetSetting -Key $Key -Value $cred.Password -Path $DestinationPath } $cred } function AddSetting { [System.Diagnostics.CodeAnalysis.SuppressMessage('PSShouldProcess', '', Scope='Function')] param( [Parameter(Mandatory)] [string]$Key, [Parameter(Mandatory)] [string]$Path, [Parameter(Mandatory)] [ValidateNotNull()] [object]$Value ) switch ($type = $Value.GetType().Name) { 'securestring' { $setting = $Value | ConvertFrom-SecureString } default { $setting = $Value } } if (Test-Path -LiteralPath $Path) { $storedSettings = Import-Clixml -Path $Path $storedSettings.Add($Key, @($type, $setting)) $storedSettings | Export-Clixml -Path $Path } else { $parentDir = Split-Path -Path $Path -Parent if (!(Test-Path -LiteralPath $parentDir)) { New-Item $parentDir -ItemType Directory > $null } @{$Key = @($type, $setting)} | Export-Clixml -Path $Path } } function GetSetting { param( [Parameter(Mandatory)] [string]$Key, [Parameter(Mandatory)] [string]$Path ) if (Test-Path -LiteralPath $Path) { $securedSettings = Import-Clixml -Path $Path if ($securedSettings.$Key) { switch ($securedSettings.$Key[0]) { 'securestring' { $value = $securedSettings.$Key[1] | ConvertTo-SecureString $cred = New-Object -TypeName PSCredential -ArgumentList 'jpgr', $value $cred.GetNetworkCredential().Password } default { $securedSettings.$Key[1] } } } } } function SetSetting { param( [Parameter(Mandatory)] [string]$Key, [Parameter(Mandatory)] [string]$Path, [Parameter(Mandatory)] [ValidateNotNull()] [object]$Value ) if (GetSetting -Key $Key -Path $Path) { RemoveSetting -Key $Key -Path $Path } AddSetting -Key $Key -Value $Value -Path $Path } function RemoveSetting { param( [Parameter(Mandatory)] [string]$Key, [Parameter(Mandatory)] [string]$Path ) if (Test-Path -LiteralPath $Path) { $storedSettings = Import-Clixml -Path $Path $storedSettings.Remove($Key) if ($storedSettings.Count -eq 0) { Remove-Item -Path $Path } else { $storedSettings | Export-Clixml -Path $Path } } else { Write-Warning "The build setting file '$Path' has not been created yet." } } |