-
Notifications
You must be signed in to change notification settings - Fork 163
/
build.ps1
517 lines (411 loc) · 18.4 KB
/
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
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
<#
.DESCRIPTION
Bootstrap and build script for PowerShell module CI/CD pipeline
.PARAMETER Tasks
The task or tasks to run. The default value is '.' (runs the default task).
.PARAMETER CodeCoverageThreshold
The code coverage target threshold to uphold. Set to 0 to disable.
The default value is '' (empty string).
.PARAMETER BuildConfig
Not yet written.
.PARAMETER OutputDirectory
Specifies the folder to build the artefact into. The default value is 'output'.
.PARAMETER BuiltModuleSubdirectory
Subdirectory name to build the module (under $OutputDirectory). The default
value is '' (empty string).
.PARAMETER RequiredModulesDirectory
Can be a path (relative to $PSScriptRoot or absolute) to tell Resolve-Dependency
and PSDepend where to save the required modules. It is also possible to use
'CurrentUser' och 'AllUsers' to install missing dependencies. You can override
the value for PSDepend in the Build.psd1 build manifest. The default value is
'output/RequiredModules'.
.PARAMETER PesterScript
One or more paths that will override the Pester configuration in build
configuration file when running the build task Invoke_Pester_Tests.
If running Pester 5 test, use the alias PesterPath to be future-proof.
.PARAMETER PesterTag
Filter which tags to run when invoking Pester tests. This is used in the
Invoke-Pester.pester.build.ps1 tasks.
.PARAMETER PesterExcludeTag
Filter which tags to exclude when invoking Pester tests. This is used in
the Invoke-Pester.pester.build.ps1 tasks.
.PARAMETER DscTestTag
Filter which tags to run when invoking DSC Resource tests. This is used
in the DscResource.Test.build.ps1 tasks.
.PARAMETER DscTestExcludeTag
Filter which tags to exclude when invoking DSC Resource tests. This is
used in the DscResource.Test.build.ps1 tasks.
.PARAMETER ResolveDependency
Not yet written.
.PARAMETER BuildInfo
The build info object from ModuleBuilder. Defaults to an empty hashtable.
.PARAMETER AutoRestore
Not yet written.
#>
[CmdletBinding()]
param
(
[Parameter(Position = 0)]
[System.String[]]
$Tasks = '.',
[Parameter(Position = 1)]
[ScriptBlock]
$Filter = {},
[Parameter()]
[System.String]
$CodeCoverageThreshold = '',
[Parameter()]
[System.String]
[ValidateScript(
{ Test-Path -Path $_ }
)]
$BuildConfig,
[Parameter()]
[System.String]
$OutputDirectory = 'output',
[Parameter()]
[System.String]
$BuiltModuleSubdirectory = '',
[Parameter()]
[System.String]
$RequiredModulesDirectory = $(Join-Path 'output' 'RequiredModules'),
[Parameter()]
# This alias is to prepare for the rename of this parameter to PesterPath when Pester 4 support is removed
[Alias('PesterPath')]
[System.Object[]]
$PesterScript,
[Parameter()]
[System.String[]]
$PesterTag,
[Parameter()]
[System.String[]]
$PesterExcludeTag,
[Parameter()]
[System.String[]]
$DscTestTag,
[Parameter()]
[System.String[]]
$DscTestExcludeTag,
[Parameter()]
[Alias('bootstrap')]
[System.Management.Automation.SwitchParameter]
$ResolveDependency,
[Parameter(DontShow)]
[AllowNull()]
[System.Collections.Hashtable]
$BuildInfo,
[Parameter()]
[System.Management.Automation.SwitchParameter]
$AutoRestore
)
<#
The BEGIN block (at the end of this file) handles the Bootstrap of the Environment
before Invoke-Build can run the tasks if the parameter ResolveDependency (or
parameter alias Bootstrap) is specified.
#>
process
{
if ($MyInvocation.ScriptName -notLike '*Invoke-Build.ps1')
{
# Only run the process block through InvokeBuild (look at the Begin block at the bottom of this script).
return
}
# Execute the Build process from the .build.ps1 path.
Push-Location -Path $PSScriptRoot -StackName 'BeforeBuild'
try
{
Write-Host -Object "[build] Parsing defined tasks" -ForeGroundColor Magenta
# Load the default BuildInfo if the parameter BuildInfo is not set.
if (-not $PSBoundParameters.ContainsKey('BuildInfo'))
{
try
{
if (Test-Path -Path $BuildConfig)
{
$configFile = Get-Item -Path $BuildConfig
Write-Host -Object "[build] Loading Configuration from $configFile"
$BuildInfo = switch -Regex ($configFile.Extension)
{
# Native Support for PSD1
'\.psd1'
{
if (-not (Get-Command -Name Import-PowerShellDataFile -ErrorAction SilentlyContinue))
{
Import-Module -Name Microsoft.PowerShell.Utility -RequiredVersion 3.1.0.0
}
Import-PowerShellDataFile -Path $BuildConfig
}
# Support for yaml when module PowerShell-Yaml is available
'\.[yaml|yml]'
{
Import-Module -Name 'powershell-yaml' -ErrorAction Stop
ConvertFrom-Yaml -Yaml (Get-Content -Raw $configFile)
}
# Native Support for JSON and JSONC (by Removing comments)
'\.[json|jsonc]'
{
$jsonFile = Get-Content -Raw -Path $configFile
$jsonContent = $jsonFile -replace '(?m)\s*//.*?$' -replace '(?ms)/\*.*?\*/'
# Yaml is superset of JSON.
ConvertFrom-Yaml -Yaml $jsonContent
}
# Unknown extension, return empty hashtable.
default
{
Write-Error -Message "Extension '$_' not supported. using @{}"
@{ }
}
}
}
else
{
Write-Host -Object "Configuration file '$($BuildConfig.FullName)' not found" -ForegroundColor Red
# No config file was found, return empty hashtable.
$BuildInfo = @{ }
}
}
catch
{
$logMessage = "Error loading Config '$($BuildConfig.FullName)'.`r`nAre you missing dependencies?`r`nMake sure you run './build.ps1 -ResolveDependency -tasks noop' before running build to restore the required modules."
Write-Host -Object $logMessage -ForegroundColor Yellow
$BuildInfo = @{ }
Write-Error -Message $_.Exception.Message
}
}
# If the Invoke-Build Task Header is specified in the Build Info, set it.
if ($BuildInfo.TaskHeader)
{
Set-BuildHeader -Script ([scriptblock]::Create($BuildInfo.TaskHeader))
}
<#
Add BuildModuleOutput to PSModule Path environment variable.
Moved here (not in begin block) because build file can contains BuiltSubModuleDirectory value.
#>
if ($BuiltModuleSubdirectory)
{
if (-not (Split-Path -IsAbsolute -Path $BuiltModuleSubdirectory))
{
$BuildModuleOutput = Join-Path -Path $OutputDirectory -ChildPath $BuiltModuleSubdirectory
}
else
{
$BuildModuleOutput = $BuiltModuleSubdirectory
}
} # test if BuiltModuleSubDirectory set in build config file
elseif ($BuildInfo.ContainsKey('BuiltModuleSubDirectory'))
{
$BuildModuleOutput = Join-Path -Path $OutputDirectory -ChildPath $BuildInfo['BuiltModuleSubdirectory']
}
else
{
$BuildModuleOutput = $OutputDirectory
}
# Pre-pending $BuildModuleOutput folder to PSModulePath to resolve built module from this folder.
if ($powerShellModulePaths -notcontains $BuildModuleOutput)
{
Write-Host -Object "[build] Pre-pending '$BuildModuleOutput' folder to PSModulePath" -ForegroundColor Green
$env:PSModulePath = $BuildModuleOutput + [System.IO.Path]::PathSeparator + $env:PSModulePath
}
<#
Import Tasks from modules via their exported aliases when defined in Build Manifest.
https://github.com/nightroman/Invoke-Build/tree/master/Tasks/Import#example-2-import-from-a-module-with-tasks
#>
if ($BuildInfo.ContainsKey('ModuleBuildTasks'))
{
foreach ($module in $BuildInfo['ModuleBuildTasks'].Keys)
{
try
{
Write-Host -Object "Importing tasks from module $module" -ForegroundColor DarkGray
$loadedModule = Import-Module -Name $module -PassThru -ErrorAction Stop
foreach ($TaskToExport in $BuildInfo['ModuleBuildTasks'].($module))
{
$loadedModule.ExportedAliases.GetEnumerator().Where{
Write-Host -Object "`t Loading $($_.Key)..." -ForegroundColor DarkGray
# Using -like to support wildcard.
$_.Key -like $TaskToExport
}.ForEach{
# Dot-sourcing the Tasks via their exported aliases.
. (Get-Alias $_.Key)
}
}
}
catch
{
Write-Host -Object "Could not load tasks for module $module." -ForegroundColor Red
Write-Error -Message $_
}
}
}
# Loading Build Tasks defined in the .build/ folder (will override the ones imported above if same task name).
Get-ChildItem -Path '.build/' -Recurse -Include '*.ps1' -ErrorAction Ignore |
ForEach-Object {
"Importing file $($_.BaseName)" | Write-Verbose
. $_.FullName
}
# Synopsis: Empty task, useful to test the bootstrap process.
task noop { }
# Define default task sequence ("."), can be overridden in the $BuildInfo.
task . {
Write-Build -Object 'No sequence currently defined for the default task' -ForegroundColor Yellow
}
Write-Host -Object 'Adding Workflow from configuration:' -ForegroundColor DarkGray
# Load Invoke-Build task sequences/workflows from $BuildInfo.
foreach ($workflow in $BuildInfo.BuildWorkflow.keys)
{
Write-Verbose -Message "Creating Build Workflow '$Workflow' with tasks $($BuildInfo.BuildWorkflow.($Workflow) -join ', ')."
$workflowItem = $BuildInfo.BuildWorkflow.($workflow)
if ($workflowItem.Trim() -match '^\{(?<sb>[\w\W]*)\}$')
{
$workflowItem = [ScriptBlock]::Create($Matches['sb'])
}
Write-Host -Object " +-> $workflow" -ForegroundColor DarkGray
task $workflow $workflowItem
}
Write-Host -Object "[build] Executing requested workflow: $($Tasks -join ', ')" -ForeGroundColor Magenta
}
finally
{
Pop-Location -StackName 'BeforeBuild'
}
}
Begin
{
# Find build config if not specified.
if (-not $BuildConfig)
{
$config = Get-ChildItem -Path "$PSScriptRoot\*" -Include 'build.y*ml', 'build.psd1', 'build.json*' -ErrorAction Ignore
if (-not $config -or ($config -is [System.Array] -and $config.Length -le 0))
{
throw 'No build configuration found. Specify path via parameter BuildConfig.'
}
elseif ($config -is [System.Array])
{
if ($config.Length -gt 1)
{
throw 'More than one build configuration found. Specify which path to use via parameter BuildConfig.'
}
$BuildConfig = $config[0]
}
else
{
$BuildConfig = $config
}
}
# Bootstrapping the environment before using Invoke-Build as task runner
if ($MyInvocation.ScriptName -notlike '*Invoke-Build.ps1')
{
Write-Host -Object "[pre-build] Starting Build Init" -ForegroundColor Green
Push-Location $PSScriptRoot -StackName 'BuildModule'
}
if ($RequiredModulesDirectory -in @('CurrentUser', 'AllUsers'))
{
# Installing modules instead of saving them.
Write-Host -Object "[pre-build] Required Modules will be installed to the PowerShell module path that is used for $RequiredModulesDirectory." -ForegroundColor Green
<#
The variable $PSDependTarget will be used below when building the splatting
variable before calling Resolve-Dependency.ps1, unless overridden in the
file Resolve-Dependency.psd1.
#>
$PSDependTarget = $RequiredModulesDirectory
}
else
{
if (-not (Split-Path -IsAbsolute -Path $OutputDirectory))
{
$OutputDirectory = Join-Path -Path $PSScriptRoot -ChildPath $OutputDirectory
}
# Resolving the absolute path to save the required modules to.
if (-not (Split-Path -IsAbsolute -Path $RequiredModulesDirectory))
{
$RequiredModulesDirectory = Join-Path -Path $PSScriptRoot -ChildPath $RequiredModulesDirectory
}
# Create the output/modules folder if not exists, or resolve the Absolute path otherwise.
if (Resolve-Path -Path $RequiredModulesDirectory -ErrorAction SilentlyContinue)
{
Write-Debug -Message "[pre-build] Required Modules path already exist at $RequiredModulesDirectory"
$requiredModulesPath = Convert-Path -Path $RequiredModulesDirectory
}
else
{
Write-Host -Object "[pre-build] Creating required modules directory $RequiredModulesDirectory." -ForegroundColor Green
$requiredModulesPath = (New-Item -ItemType Directory -Force -Path $RequiredModulesDirectory).FullName
}
$powerShellModulePaths = $env:PSModulePath -split [System.IO.Path]::PathSeparator
# Pre-pending $requiredModulesPath folder to PSModulePath to resolve from this folder FIRST.
if ($RequiredModulesDirectory -notin @('CurrentUser', 'AllUsers') -and
($powerShellModulePaths -notcontains $RequiredModulesDirectory))
{
Write-Host -Object "[pre-build] Pre-pending '$RequiredModulesDirectory' folder to PSModulePath" -ForegroundColor Green
$env:PSModulePath = $RequiredModulesDirectory + [System.IO.Path]::PathSeparator + $env:PSModulePath
}
$powerShellYamlModule = Get-Module -Name 'powershell-yaml' -ListAvailable
$invokeBuildModule = Get-Module -Name 'InvokeBuild' -ListAvailable
$psDependModule = Get-Module -Name 'PSDepend' -ListAvailable
# Checking if the user should -ResolveDependency.
if (-not ($powerShellYamlModule -and $invokeBuildModule -and $psDependModule) -and -not $ResolveDependency)
{
if ($AutoRestore -or -not $PSBoundParameters.ContainsKey('Tasks') -or $Tasks -contains 'build')
{
Write-Host -Object "[pre-build] Dependency missing, running './build.ps1 -ResolveDependency -Tasks noop' for you `r`n" -ForegroundColor Yellow
$ResolveDependency = $true
}
else
{
Write-Warning -Message "Some required Modules are missing, make sure you first run with the '-ResolveDependency' parameter. Running 'build.ps1 -ResolveDependency -Tasks noop' will pull required modules without running the build task."
}
}
<#
The variable $PSDependTarget will be used below when building the splatting
variable before calling Resolve-Dependency.ps1, unless overridden in the
file Resolve-Dependency.psd1.
#>
$PSDependTarget = $requiredModulesPath
}
if ($ResolveDependency)
{
Write-Host -Object "[pre-build] Resolving dependencies." -ForegroundColor Green
$resolveDependencyParams = @{ }
# If BuildConfig is a Yaml file, bootstrap powershell-yaml via ResolveDependency.
if ($BuildConfig -match '\.[yaml|yml]$')
{
$resolveDependencyParams.Add('WithYaml', $true)
}
$resolveDependencyAvailableParams = (Get-Command -Name '.\Resolve-Dependency.ps1').Parameters.Keys
foreach ($cmdParameter in $resolveDependencyAvailableParams)
{
# The parameter has been explicitly used for calling the .build.ps1
if ($MyInvocation.BoundParameters.ContainsKey($cmdParameter))
{
$paramValue = $MyInvocation.BoundParameters.Item($cmdParameter)
Write-Debug " adding $cmdParameter :: $paramValue [from user-provided parameters to Build.ps1]"
$resolveDependencyParams.Add($cmdParameter, $paramValue)
}
# Use defaults parameter value from Build.ps1, if any
else
{
$paramValue = Get-Variable -Name $cmdParameter -ValueOnly -ErrorAction Ignore
if ($paramValue)
{
Write-Debug " adding $cmdParameter :: $paramValue [from default Build.ps1 variable]"
$resolveDependencyParams.Add($cmdParameter, $paramValue)
}
}
}
Write-Host -Object "[pre-build] Starting bootstrap process." -ForegroundColor Green
.\Resolve-Dependency.ps1 @resolveDependencyParams
}
if ($MyInvocation.ScriptName -notlike '*Invoke-Build.ps1')
{
Write-Verbose -Message "Bootstrap completed. Handing back to InvokeBuild."
if ($PSBoundParameters.ContainsKey('ResolveDependency'))
{
Write-Verbose -Message "Dependency already resolved. Removing task."
$null = $PSBoundParameters.Remove('ResolveDependency')
}
Write-Host -Object "[build] Starting build with InvokeBuild." -ForegroundColor Green
Invoke-Build @PSBoundParameters -Task $Tasks -File $MyInvocation.MyCommand.Path
Pop-Location -StackName 'BuildModule'
return
}
}