-
Notifications
You must be signed in to change notification settings - Fork 0
/
psakefile.ps1
562 lines (471 loc) · 17.4 KB
/
psakefile.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
###############################################################################
### PSAKE build script ###
###############################################################################
### Copyright 2015 by PeopleWare n.v. ###
###############################################################################
### Authors: Ruben Vandeginste, Danny Van den Wouwer ###
###############################################################################
### ###
### A psake build file that configures ###
### - build and clean the solution ###
### - restore nuget packages ###
### - create and publish nuget packages ###
### - run unit tests ###
### - generate documentation ###
### ###
###############################################################################
#region CONFIGURATION
###############################################################################
### CONFIGURATION ###
###############################################################################
###############################################################################
# Use build tools from .NET framework 4.7
#
Framework '4.7'
###############################################################################
# Properties that are used by this psake
# script; these can be overridden when
# invoking this script
#
Properties {
# buildconfig: the configuration used for building
# note that this also determines the deployment configuration (SlowCheetah)
$buildconfig = 'Debug'
$buildPlatformTarget = 'AnyCpu'
# chatter: number to indicate verbosity during the execution of tasks
# 0 - no output
# 1 - minimal output, tasks executed
# 2 - extra output, steps within tasks
# 3 - even more output
$chatter = 1
# chattercolor: foreground color to use for task output
$chattercolor = 'Green'
# choco installer directives
$chocoIncludeXmlFiles = $true
$chocoIncludePdb = $true
# used nunit version
$nunitVersion = '3.9.0'
$nUnitFramework = $null
}
#endregion
#region PRIVATE HELPERS
###############################################################################
### PRIVATE HELPERS ###
###############################################################################
###############################################################################
# Helper for printing out documentation
#
function PropertyDocumentation() {
Write-Host 'Properties'
Write-Host '----------'
Write-Host "`$chatter The level of verbosity during task execution, defaults to 1."
Write-Host ' 0 - No output'
Write-Host ' 1 - Minimal output, tasks executed'
Write-Host ' 2 - Extra output, steps within tasks'
Write-Host ' 3 - Even more output, debug execution'
Write-Host "`$chattercolor Foreground color to use for task output., defaults to Green"
Write-Host "`$buildconfig Build configuration (Debug, Release), defaults to Debug."
Write-Host "`$buildPlatformTarget Build Target Platform (AnyCpu, x86, x64), defaults to AnyCpu."
Write-Host "`$chocoIncludeXmlFiles When creating a chocolatey-package, we can specify to include Xml-Files, defaults to $false."
Write-Host "`$chocoIncludePdb When creating a chocolatey-package, we can specify to include Pdb-Files, defaults to $false."
Write-Host "`$nunitVersion Version of nunit-runner, defaults to 3.9.0"
Write-Host "`$nUnitFramework RuntimeFramework for nunit-runner, defaults to $null, If not specified, tests will run under the framework they are compiled with"
}
###############################################################################
# Helper for chatter
#
function Chatter {
param
(
[string]
$msg = '.',
[int]
$level = 3
)
if ($level -le $chatter) {
Write-Host $msg -ForegroundColor $chattercolor
}
}
###############################################################################
# Helper for to see if we run with Administrator privileges
#
function Test-Administrator
{
$user = [Security.Principal.WindowsIdentity]::GetCurrent();
(New-Object Security.Principal.WindowsPrincipal $user).IsInRole([Security.Principal.WindowsBuiltinRole]::Administrator)
}
###############################################################################
# Helper to determine our msbuild parameters
#
function Get-DefaultMsBuildParameters
{
Param (
[Parameter(Mandatory = $true)]
[System.IO.FileInfo]$targetFile,
[Parameter(Mandatory = $true)]
[string[]]$tasks,
[Parameter(Mandatory = $false)]
[string[]]$configuration,
[Parameter(Mandatory = $false)]
[string[]]$platform,
[Parameter(Mandatory = $false)]
[string[]]$additionalParameters
)
if (-Not $configuration) {
$configuration = $buildconfig
}
if (-Not $platform) {
$platform = $buildPlatformTarget
if ($platform -eq "AnyCpu") {
$platform = "Any Cpu"
}
}
$concatedTasks = ($tasks -join ';')
$params = @(
"""$targetFile"""
"/t:$concatedTasks"
"/m"
"/nr:false"
"/nologo"
"/p:Configuration=""$configuration"""
"/p:Platform=""$platform"""
)
if ($chatter -eq 1) {
$params += "/v:quiet"
}
elseif ($chatter -eq 2) {
$params += "/v:minimal"
}
else {
$params += "/v:normal"
}
if ($additionalParameters) {
foreach($param in $additionalParameters) {
$params += $param
}
}
$params
}
###############################################################################
# Helper to invoke msbuild
#
function Invoke-MsBuild
{
Param (
[Parameter(Mandatory = $true)]
[System.IO.FileInfo]$targetFile,
[Parameter(Mandatory = $true)]
[string[]]$tasks,
[Parameter(Mandatory = $false)]
[string[]]$configuration,
[Parameter(Mandatory = $false)]
[string[]]$platform,
[Parameter(Mandatory = $false)]
[string[]]$additionalParameters
)
$msbuildParams = Get-DefaultMsBuildParameters -targetFile $targetFile -tasks $tasks -configuration $configuration -platform $platform -additionalParameters $additionalParameters
$message = "msbuild $tasks went wrong"
Chatter "msbuild $msbuildParams" 2
Exec { msbuild $msbuildParams } $message
}
###############################################################################
# Helper to determine our nuget parameters
#
function Get-DefaultNugetParameters
{
Param (
[Parameter(Mandatory = $true)]
[string]$task,
[Parameter(Mandatory = $true)]
[string[]]$additionalParameters,
[Parameter(Mandatory = $false)]
[string]$configuration,
[Parameter(Mandatory = $false)]
[string[]]$properties
)
$params = @($task)
if ($additionalParameters) {
foreach($param in $additionalParameters) {
$params += $param
}
}
if ($chatter -eq 1) {
$params += "-Verbosity quiet"
}
elseif ($chatter -eq 2) {
$params += "-Verbosity normal"
}
else {
$params += "-Verbosity detailed"
}
if ($configuration) {
if (-Not $properties) {
$properties = @()
}
$properties += "Configuration=$configuration"
}
if ($properties) {
$joinedProperties = $properties -join ';'
$params += "-Properties ""$joinedProperties"""
}
$params
}
###############################################################################
# Helper to invoke Nuget
# note: nuget commandline transparantly calls msbuild "restore" for new type csproj files
#
function Invoke-Nuget
{
Param (
[Parameter(Mandatory = $true)]
[string]$task,
[Parameter(Mandatory = $true)]
[string[]]$additionalParameters,
[Parameter(Mandatory = $false)]
[string]$configuration,
[Parameter(Mandatory = $false)]
[string[]]$properties
)
$nugetParams = Get-DefaultNugetParameters -task $task -additionalParameters $additionalParameters -configuration $configuration -properties $properties
$message = "nuget $task went wrong"
Chatter "nuget $nugetParams" 2
Exec { Invoke-Expression "nuget $nugetParams" } $message
}
#endregion
#region TASKS
###############################################################################
### TASKS ###
###############################################################################
###############################################################################
# Default task, executed when no task is
# given explicitly
#
Task Default -depends ?
###############################################################################
# Help
#
Task ? -description 'Show help.' {
Write-Host
PropertyDocumentation
WriteDocumentation
}
###############################################################################
# Helper to chat our properties
#
Task ShowProperties -description 'Show running properties' {
Chatter "Properties used:" 1
Chatter " buildconfig=$buildconfig" 1
Chatter " buildPlatformTarget=$buildPlatformTarget" 1
Chatter " chocoIncludeXmlFiles=$chocoIncludeXmlFiles" 1
Chatter " chocoIncludePdb=$chocoIncludePdb" 1
Chatter " nunitVersion=$nunitVersion" 1
Chatter " nUnitFramework=$nUnitFramework" 1
}
###############################################################################
# Clean build artifacts and temporary files
#
Task Clean -description 'Clean build output.' -depends ShowProperties {
Push-Location
try
{
Chatter 'Cleaning solution' 2
$solution = Get-Item '*.sln' | Select-Object -First 1
# msbuild clean
Invoke-MsBuild -targetFile $solution.Name -tasks @('Clean')
# clean up scratch folder
Chatter 'Cleaning scratch' 2
$path = "scratch"
if (Test-Path $path) {
Remove-Item -Path $path -Recurse -Force
}
# clean up bin/obj folders
Chatter 'Cleaning bin/obj' 2
Remove-Item -Path (Join-Path (Join-Path "src" "*") "bin"),(Join-Path (Join-Path "src" "*") "obj") -Recurse -Force
}
finally
{
Pop-Location
}
}
###############################################################################
# Clean ReSharper cache folder
#
Task ReSharperClean -description 'Clean ReSharper cache folders.' -depends ShowProperties {
Push-Location
try
{
# clean up cache folder
$path = '_ReSharper.Caches'
if (Test-Path $path) {
Remove-Item -Path $path -Recurse -Force
}
}
finally
{
Pop-Location
}
}
###############################################################################
# Restore packages
#
Task PackageRestore -description 'Restore NuGet package dependencies.' -depends ShowProperties {
Push-Location
try
{
$solution = Get-Item '*.sln' | Select-Object -First 1
# traditional nuget command-line restore
# note, nuget commandline transparantly calls msbuild "restore" for new type csproj files
$nugetRestoreParams = @(
"""$solution"""
"-NonInteractive"
)
Invoke-Nuget -task restore -additionalParameters $nugetRestoreParams
}
finally
{
Pop-Location
}
}
###############################################################################
# Restore
#
# Depends on PackageRestore to restore packages, and Clean to put the solution
# in a clean state so VS2017 is willing to open it without complaints.
#
Task Restore -description 'Restore solution.' -depends PackageRestore,Clean {
}
###############################################################################
# Build the solution
#
# Depends on Clean to ensure a clean build, not using any left-over compile artifacts.
#
Task Build -description 'Build the solution.' -depends Clean {
Push-Location
try
{
$solution = Get-Item '*.sln' | Select-Object -First 1
Invoke-MsBuild -targetFile $solution.Name -tasks @('Restore', 'Build')
}
finally
{
Pop-Location
}
}
###############################################################################
# Full build
#
Task FullBuild -description 'Do a full build starting from a clean solution.' -depends Restore,Build
###############################################################################
# Create a NuGet package, based on new project VS2017 style
#
# Depends on Clean to ensure a clean build, not using any left-over compile artifacts.
#
Task Pack -description 'Create a nuget-package (new project 2017 style).' -depends Clean {
Push-Location
try
{
$solution = Get-Item '*.sln' | Select-Object -First 1
if ($solution) {
$additionalParameters = @(
"/p:IncludeSymbols=True"
"/p:IncludeSource=True"
)
Invoke-MsBuild -targetFile $solution.Name -tasks @('Restore','Pack') -additionalParameters $additionalParameters
}
}
finally
{
Pop-Location
}
}
###############################################################################
# Run unit tests
#
Task Test -description 'Run the unit tests using NUnit console test runner.' -depends FullBuild {
Push-Location
try
{
$nunitApplicationName = 'nunit3-console.exe'
$nunitNugetPackageName = 'NUnit.ConsoleRunner'
$nunitNugetVersionedPackageName = "$nunitNugetPackageName.$($nunitVersion)"
$packageNUnitPath = `
Join-Path -Path 'src' -ChildPath 'packages' | `
Join-Path -ChildPath $nunitNugetVersionedPackageName
# Can we find nunit-runner in our traditional packages directory?
$runner = $null
$runnerPath = `
Join-Path -Path $packageNUnitPath -ChildPath 'tools' | `
Join-Path -ChildPath $nunitApplicationName
if (Test-Path $runnerPath) {
$runner = Get-Item -Path $runnerPath
}
# If we didn't found it, install nunit-runner in our scratch directory
if ($null -eq $runner) {
$scratchNUnitPath = Join-Path -Path '.\scratch' -ChildPath 'nunit'
$nugetRestoreParams = @(
"""$nunitNugetPackageName"""
"-Version '$($nunitVersion)'"
"-OutputDirectory ""$scratchNUnitPath"""
"-NonInteractive"
)
Invoke-Nuget -task install -additionalParameters $nugetRestoreParams
$runnerPath = `
Join-Path -Path $scratchNUnitPath -ChildPath $nunitNugetVersionedPackageName | `
Join-Path -ChildPath 'tools' | `
Join-Path -ChildPath $nunitApplicationName
if (Test-Path $runnerPath) {
$runner = Get-Item $runnerPath
}
}
# stop if we don't have a nunit-runner
if ($null -eq $runner)
{
throw 'Cannot find or fetch nunit runner.'
}
Chatter "Found nunit runner: $runner" 2
# find unit test dlls
Chatter 'Searching test projects ...' 1
Get-ChildItem -Path (Join-Path -Path 'scratch' -ChildPath 'bin') -Filter *Tests.dll -Recurse | ForEach-Object {
$testdll = $_
$testBaseName = $testdll.BaseName
# generate folder for test output
Chatter " Found test project: $testBaseName" 1
$nunitFolder = New-Item -ItemType Directory -Path (Join-Path -Path "scratch" -ChildPath "nunit") -Force
# intialise runner args
$testrunnerargs = @(
"--work:$nunitFolder"
"--result:nunit-test-results-$testBaseName.xml"
"--out:nunit-stdout-$testBaseName.txt"
'--labels:all'
)
if ($null -ne $nUnitFramework) {
$testrunnerargs += "--framework:$nUnitFramework"
}
# execute runner
Chatter "$($runner.FullName) $testdll.FullName $testrunnerargs" 2
Exec { & "$($runner.FullName)" $_.FullName $testrunnerargs } "Running nunit runner went wrong"
}
}
finally
{
Pop-Location
}
}
###############################################################################
# Open, starting all *.sln files, inside .\src directory
#
Task Open -description 'starting all *.sln files, inside .\src directory' -depends Restore {
Push-Location
try
{
Get-ChildItem -Path '.' -Filter '*.sln' -Recurse | ForEach-Object {
$solution = $_.FullName
Chatter "start $solution" 2
Invoke-Item $solution
}
}
finally {
Pop-Location
}
}
#endregion