Resources/Vault/src/PSVault.build.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 |
<#
.SYNOPSIS An Invoke-Build Build file. .DESCRIPTION Build steps can include: - ValidateRequirements - ImportModuleManifest - Clean - Analyze - FormattingCheck - Test - DevCC - Build - InfraTest - Archive .EXAMPLE Invoke-Build This will perform the default build Add-BuildTasks: see below for the default Add-BuildTask execution .EXAMPLE Invoke-Build -Add-BuildTask Analyze,Test This will perform only the Analyze and Test Add-BuildTasks. .NOTES This build will pull in configurations from the "<module>.Settings.ps1" file as well, where users can more easily customize the build process if required. https://github.com/nightroman/Invoke-Build https://github.com/nightroman/Invoke-Build/wiki/Build-Scripts-Guidelines If using VSCode you can use the generated tasks.json to execute the various tasks in this build file. Ctrl + P | then type task (add space) - you will then be presented with a list of available tasks to run The 'InstallDependencies' Add-BuildTask isn't present here. Module dependencies are installed at a previous step in the pipeline. If your manifest has module dependencies include all required modules in your CI/CD bootstrap file: AWS - install_modules.ps1 Azure - actions_bootstrap.ps1 GitHub Actions - actions_bootstrap.ps1 AppVeyor - actions_bootstrap.ps1 #> #Include: Settings $ModuleName = (Split-Path -Path $BuildFile -Leaf).Split('.')[0] . "./$ModuleName.Settings.ps1" function Test-ManifestBool ($Path) { Get-ChildItem $Path | Test-ModuleManifest -ErrorAction SilentlyContinue | Out-Null; $? } #Default Build $str = @() $str = 'Clean', 'ValidateRequirements', 'ImportModuleManifest' <% If ($PLASTER_PARAM_CodingStyle -eq 'Stroustrup' -or $PLASTER_PARAM_CodingStyle -eq 'OTBS' -or $PLASTER_PARAM_CodingStyle -eq 'Allman') { @' $str += 'FormattingCheck' '@ } %> $str += 'Analyze', 'Test' $str += 'Build', 'InfraTest', 'Archive' Add-BuildTask -Name . -Jobs $str #Local testing build process Add-BuildTask TestLocal Clean, ImportModuleManifest, Analyze, Test # Pre-build variables to be used by other portions of the script Enter-Build { $script:ModuleName = (Split-Path -Path $BuildFile -Leaf).Split('.')[0] # Identify other required paths $script:ModuleSourcePath = Join-Path -Path $BuildRoot -ChildPath $script:ModuleName $script:ModuleFiles = Join-Path -Path $script:ModuleSourcePath -ChildPath '*' $script:ModuleManifestFile = Join-Path -Path $script:ModuleSourcePath -ChildPath "$($script:ModuleName).psd1" $manifestInfo = Import-PowerShellDataFile -Path $script:ModuleManifestFile $script:ModuleVersion = $manifestInfo.ModuleVersion $script:ModuleDescription = $manifestInfo.Description $Script:FunctionsToExport = $manifestInfo.FunctionsToExport $script:TestsPath = Join-Path -Path $BuildRoot -ChildPath 'Tests' $script:UnitTestsPath = Join-Path -Path $script:TestsPath -ChildPath 'Unit' $script:InfraTestsPath = Join-Path -Path $script:TestsPath -ChildPath 'Infrastructure' $script:ArtifactsPath = Join-Path -Path $BuildRoot -ChildPath 'Artifacts' $script:ArchivePath = Join-Path -Path $BuildRoot -ChildPath 'Archive' $script:BuildModuleRootFile = Join-Path -Path $script:ArtifactsPath -ChildPath "$($script:ModuleName).psm1" }#Enter-Build # Define headers as separator, task path, synopsis, and location, e.g. for Ctrl+Click in VSCode. # Also change the default color to Green. If you need task start times, use `$Task.Started`. Set-BuildHeader { param($Path) # separator line Write-Build DarkMagenta ('=' * 79) # default header + synopsis Write-Build DarkGray "Task $Path : $(Get-BuildSynopsis $Task)" # task location in a script Write-Build DarkGray "At $($Task.InvocationInfo.ScriptName):$($Task.InvocationInfo.ScriptLineNumber)" Write-Build Yellow "Manifest File: $script:ModuleManifestFile" Write-Build Yellow "Manifest Version: $($manifestInfo.ModuleVersion)" }#Set-BuildHeader # Define footers similar to default but change the color to DarkGray. Set-BuildFooter { param($Path) Write-Build DarkGray "Done $Path, $($Task.Elapsed)" # # separator line # Write-Build Gray ('=' * 79) }#Set-BuildFooter #Synopsis: Validate system requirements are met Add-BuildTask ValidateRequirements { # this setting comes from the *.Settings.ps1 Write-Build White " Verifying at least PowerShell $script:requiredPSVersion..." Assert-Build ($PSVersionTable.PSVersion.Major.ToString() -ge $script:requiredPSVersion) "At least Powershell $script:requiredPSVersion is required for this build to function properly" Write-Build Green ' ...Verification Complete!' }#ValidateRequirements # Synopsis: Import the current module manifest file for processing Add-BuildTask TestModuleManifest -Before ImportModuleManifest { Write-Build White ' Running module manifest tests...' Assert-Build (Test-Path $script:ModuleManifestFile) 'Unable to locate the module manifest file.' Assert-Build (Test-ManifestBool -Path $script:ModuleManifestFile) 'Module Manifest test did not pass verification.' Write-Build Green ' ...Module Manifest Verification Complete!' } # Synopsis: Load the module project Add-BuildTask ImportModuleManifest { Write-Build White ' Attempting to load the project module.' try { Import-Module $script:ModuleManifestFile -Force -PassThru -ErrorAction Stop } catch { throw 'Unable to load the project module' } Write-Build Green " ...$script:ModuleName imported successfully" } #Synopsis: Clean and reset Artifacts/Archive Directory Add-BuildTask Clean { Write-Build White ' Clean up our Artifacts/Archive directory...' $null = Remove-Item $script:ArtifactsPath -Force -Recurse -ErrorAction 0 $null = New-Item $script:ArtifactsPath -ItemType:Directory $null = Remove-Item $script:ArchivePath -Force -Recurse -ErrorAction 0 $null = New-Item $script:ArchivePath -ItemType:Directory Write-Build Green ' ...Clean Complete!' }#Clean #Synopsis: Invokes PSScriptAnalyzer against the Module source path Add-BuildTask Analyze { $scriptAnalyzerParams = @{ Path = $script:ModuleSourcePath Setting = "PSScriptAnalyzerSettings.psd1" Recurse = $true Verbose = $false } Write-Build White ' Performing Module ScriptAnalyzer checks...' $scriptAnalyzerResults = Invoke-ScriptAnalyzer @scriptAnalyzerParams if ($scriptAnalyzerResults) { $scriptAnalyzerResults | Format-Table throw ' One or more PSScriptAnalyzer errors/warnings where found.' } else { Write-Build Green ' ...Module Analyze Complete!' } }#Analyze #Synopsis: Invokes Script Analyzer against the Tests path if it exists Add-BuildTask AnalyzeTests -After Analyze { if (Test-Path -Path $script:TestsPath) { $scriptAnalyzerParams = @{ Path = $script:TestsPath Setting = "PSScriptAnalyzerSettings.psd1" Recurse = $true Verbose = $false } Write-Build White ' Performing Test ScriptAnalyzer checks...' $scriptAnalyzerResults = Invoke-ScriptAnalyzer @scriptAnalyzerParams if ($scriptAnalyzerResults) { $scriptAnalyzerResults | Format-Table throw ' One or more PSScriptAnalyzer errors/warnings where found.' } else { Write-Build Green ' ...Test Analyze Complete!' } } }#AnalyzeTests #Synopsis: Analyze scripts to verify if they adhere to desired coding format (Stroustrup / OTBS / Allman) Add-BuildTask FormattingCheck { <% if ($PLASTER_PARAM_CodingStyle -eq 'Stroustrup') { @' $scriptAnalyzerParams = @{ Setting = 'CodeFormattingStroustrup' ExcludeRule = 'PSUseConsistentWhitespace' Recurse = $true Verbose = $false } '@ } %> <% if ($PLASTER_PARAM_CodingStyle -eq 'OTBS') { @' $scriptAnalyzerParams = @{ Setting = 'CodeFormattingOTBS' ExcludeRule = 'PSUseConsistentWhitespace' Recurse = $true Verbose = $false } '@ } %> <% if ($PLASTER_PARAM_CodingStyle -eq 'Allman') { @' $scriptAnalyzerParams = @{ Setting = 'CodeFormattingAllman' ExcludeRule = 'PSUseConsistentWhitespace' Recurse = $true Verbose = $false } '@ } %> Write-Build White ' Performing script formatting checks...' $scriptAnalyzerResults = Get-ChildItem -Path $script:ModuleSourcePath -Exclude "*.psd1" | Invoke-ScriptAnalyzer @scriptAnalyzerParams if ($scriptAnalyzerResults) { $scriptAnalyzerResults | Format-Table throw ' PSScriptAnalyzer code formatting check did not adhere to {0} standards' -f $scriptAnalyzerParams.Setting } else { Write-Build Green ' ...Formatting Analyze Complete!' } }#FormattingCheck #Synopsis: Invokes all Pester Unit Tests in the Tests\Unit folder (if it exists) Add-BuildTask Test { $codeCovPath = "$script:ArtifactsPath\ccReport\" $testOutPutPath = "$script:ArtifactsPath\testOutput\" if (-not(Test-Path $codeCovPath)) { New-Item -Path $codeCovPath -ItemType Directory | Out-Null } if (-not(Test-Path $testOutPutPath)) { New-Item -Path $testOutPutPath -ItemType Directory | Out-Null } if (Test-Path -Path $script:UnitTestsPath) { $invokePesterParams = @{ Path = 'Tests\Unit' Strict = $true PassThru = $true Verbose = $false EnableExit = $false CodeCoverage = "$ModuleName\*\*.psm1" CodeCoverageOutputFile = "$codeCovPath\CodeCoverage.xml" CodeCoverageOutputFileFormat = 'JaCoCo' OutputFile = "$testOutPutPath\PesterTests.xml" OutputFormat = 'NUnitXML' } Write-Build White ' Performing Pester Unit Tests...' # Publish Test Results as NUnitXml $testResults = Invoke-Pester @invokePesterParams # This will output a nice json for each failed test (if running in CodeBuild) if ($env:CODEBUILD_BUILD_ARN) { $testResults.TestResult | ForEach-Object { if ($_.Result -ne 'Passed') { ConvertTo-Json -InputObject $_ -Compress } } } $numberFails = $testResults.FailedCount Assert-Build($numberFails -eq 0) ('Failed "{0}" unit tests.' -f $numberFails) # Ensure our builds fail until if below a minimum defined code test coverage threshold $coverageThreshold = 50 if ($testResults.CodeCoverage.NumberOfCommandsExecuted -ne 0) { $coveragePercent = '{0:N2}' -f ($testResults.CodeCoverage.NumberOfCommandsExecuted / $testResults.CodeCoverage.NumberOfCommandsAnalyzed * 100) <# if ($testResults.CodeCoverage.NumberOfCommandsMissed -gt 0) { 'Failed to analyze "{0}" commands' -f $testResults.CodeCoverage.NumberOfCommandsMissed } Write-Host "PowerShell Commands not tested:`n$(ConvertTo-Json -InputObject $testResults.CodeCoverage.MissedCommands)" #> if ([Int]$coveragePercent -lt $coverageThreshold) { throw ('Failed to meet code coverage threshold of {0}% with only {1}% coverage' -f $coverageThreshold, $coveragePercent) } else { Write-Build Cyan " $('Covered {0}% of {1} analyzed commands in {2} files.' -f $coveragePercent,$testResults.CodeCoverage.NumberOfCommandsAnalyzed,$testResults.CodeCoverage.NumberOfFilesAnalyzed)" Write-Build Green ' ...Pester Unit Tests Complete!' } } else { # account for new module build condition Write-Build Yellow ' Code coverage check skipped. No commands to execute...' } } }#Test #Synopsis: Used primarily during active development to generate xml file to graphically display code coverage in VSCode using Coverage Gutters Add-BuildTask DevCC { Write-Build White ' Generating code coverage report at root...' $invokePesterParams = @{ Path = 'Tests\Unit' CodeCoverage = "$ModuleName\*\*.ps1" CodeCoverageOutputFile = '..\..\..\cov.xml' } Invoke-Pester @invokePesterParams Write-Build Green ' ...Code Coverage report generated!' }#DevCC # Synopsis: Copies module assets to Artifacts folder Add-BuildTask AssetCopy -Before Build { Write-Build Gray ' Copying assets to Artifacts...' $dirDest = New-Item -Path "$script:ArtifactsPath\$ModuleName.Extension" -ItemType Directory -ErrorAction Stop Copy-Item -Path "$script:ModuleSourcePath\$ModuleName.Extension\*" -Destination $dirDest -Recurse -Force -ErrorAction Stop Write-Build Gray ' ...Assets copy complete.' }#AssetCopy # Synopsis: Builds the Module to the Artifacts folder Add-BuildTask Build { Write-Build White ' Performing Module Build' Write-Build Gray ' Copying manifest file to Artifacts...' Copy-Item -Path $script:ModuleManifestFile -Destination $script:ArtifactsPath -Recurse -ErrorAction Stop #Copy-Item -Path $script:ModuleSourcePath\bin -Destination $script:ArtifactsPath -Recurse -ErrorAction Stop Write-Build Gray ' ...manifest copy complete.' Write-Build Green ' ...Build Complete!' }#Build #Synopsis: Invokes all Pester Infrastructure Tests in the Tests\Infrastructure folder (if it exists) Add-BuildTask InfraTest { if (Test-Path -Path $script:InfraTestsPath) { $invokePesterParams = @{ Path = 'Tests\Infrastructure' Strict = $true PassThru = $true Verbose = $false EnableExit = $false } Write-Build White " Performing Pester Infrastructure Tests in $($invokePesterParams.path)" # Publish Test Results as NUnitXml $testResults = Invoke-Pester @invokePesterParams # This will output a nice json for each failed test (if running in CodeBuild) if ($env:CODEBUILD_BUILD_ARN) { $testResults.TestResult | ForEach-Object { if ($_.Result -ne 'Passed') { ConvertTo-Json -InputObject $_ -Compress } } } $numberFails = $testResults.FailedCount Assert-Build($numberFails -eq 0) ('Failed "{0}" unit tests.' -f $numberFails) Write-Build Green ' ...Pester Infrastructure Tests Complete!' } }#InfraTest #Synopsis: Creates an archive of the built Module Add-BuildTask Archive { Write-Build White ' Performing Archive...' $archivePath = Join-Path -Path $BuildRoot -ChildPath 'Archive' if (Test-Path -Path $archivePath) { $null = Remove-Item -Path $archivePath -Recurse -Force } $null = New-Item -Path $archivePath -ItemType Directory -Force $zipFileName = '{0}_{1}_{2}.{3}.zip' -f $script:ModuleName, $script:ModuleVersion, ([DateTime]::UtcNow.ToString("yyyyMMdd")), ([DateTime]::UtcNow.ToString("hhmmss")) $zipFile = Join-Path -Path $archivePath -ChildPath $zipFileName if ($PSEdition -eq 'Desktop') { Add-Type -AssemblyName 'System.IO.Compression.FileSystem' } [System.IO.Compression.ZipFile]::CreateFromDirectory($script:ArtifactsPath, $zipFile) Write-Build Green ' ...Archive Complete!' }#Archive |