-
Notifications
You must be signed in to change notification settings - Fork 0
/
build.ps1
505 lines (338 loc) · 14.6 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
<#
Title: build.ps1
Author: [email protected]
Last Update: 27.09.2022
Description:
This script automates the process of building:
- this library as NuGet package
- its client application as (zipped, self-contained) executable files for the three major operating systems
Pre-requisites:
- The script expects the project source to be stored into the '{solution_folder}\src\{project_name}' folder
- The script requires 'dotnet.exe' to be installed on the system.
Features
- The script can be run both in VSCode and in a shell/Windows Terminal
- If the '{solution_folder}\artifacts' folder is not found, '{desktop}\artifacts' will be used.
- The user can even force the second option by enabling the $forcePublishToDesktop flag.
- The script supports timestamped logging
- The client application artifacts will be zipped self-contained executables, and be named something like:
- "unifor_2.5.0_win-x64.zip"
- "unifor_2.5.0_osx-x64.zip"
- "unifor_2.5.0_linux-x64.zip"
- The library artifact will be something like:
- "NW.UnivariateForecasting.2.5.0.nupkg"
- The script is a wrapper around the following 'dotnet' commands:
- dotnet publish -r win-x64 -c Release /p:PublishSingleFile=true /p:PublishReadyToRun=false /p:DebugSymbols=false /p:DebugType=None -o 'C:\'
- dotnet publish -r osx-x64 -c Release /p:PublishSingleFile=true /p:PublishReadyToRun=false /p:DebugSymbols=false /p:DebugType=None -o 'C:\'
- dotnet publish -r linux-x64 -c Release /p:PublishSingleFile=true /p:PublishReadyToRun=false /p:DebugSymbols=false /p:DebugType=None -o 'C:\'
- dotnet pack
#>
# Variables
[string]$clientProjectName = 'NW.UnivariateForecastingClient'
[string[]]$runtimes = @("win-x64", "osx-x64", "linux-x64")
[bool]$forcePublishToDesktop = $true
[bool]$removeAllExceptZip = $true
# Classes
class Logger {
# Fields
# Properties
# Constructors()
hidden Logger() { }
# Methods
static [void] Log([string]$message) {
Write-Host $("{0} {1}" -f $([Logger]::GetTimeStamp()), $message)
}
static hidden [string] GetTimeStamp() {
return $(Get-Date -Format "[yyyy-MM-dd HH:mm]")
}
}
# Functions
function Assert-ThatDotnetIsInstalled {
[OutputType([bool])]
param()
try
{
. dotnet | Out-Null
[Logger]::Log("'dotnet.exe' is installed.")
return $true
}
catch {
[Logger]::Log("'dotnet.exe' is not installed.")
return $false
}
}
function Get-CurrentDirectory() {
[OutputType([System.IO.DirectoryInfo])]
param()
[string]$currentDir = $null
if ($PSISE) {
$currentDir = (Split-Path -Path $psISE.CurrentFile.FullPath)
}
elseif ($profile.Contains("VSCode")) {
$currentDir = (Split-Path $PSEditor.GetEditorContext().CurrentFile.Path)
}
elseif (-not $PSScriptRoot) {
$currentDir = (Get-ChildItem | ForEach-Object { $_.DirectoryName } | Select-Object -Unique)
}
else {
$currentDir = $PSScriptRoot
}
return [System.IO.DirectoryInfo]::new($currentDir)
}
function Get-ArtifactsFolder {
[OutputType([System.IO.DirectoryInfo])]
param(
[parameter(Mandatory=$true)] [System.IO.DirectoryInfo]$SolutionFolder,
[parameter(Mandatory=$true)] [bool]$ForcePublishToDesktop
)
# TO-DO: validation
[System.IO.DirectoryInfo]$desktopartifactFolder = [System.IO.Path]::Combine([Environment]::GetFolderPath('Desktop'), "artifacts")
if($ForcePublishToDesktop.Equals($true)) {
return $desktopartifactFolder
}
[System.IO.DirectoryInfo]$artifactsFolder = [System.IO.Path]::Combine($SolutionFolder, "artifacts")
if ($artifactsFolder.Exists.Equals($false)) {
[Logger]::Log("'artifacts' folder doesn't exist: '$artifactsFolder'.")
$artifactsFolder = $desktopartifactFolder
[Logger]::Log("'desktop\artifacts' folder will be used instead: '$artifactsFolder'.")
}
else {
[Logger]::Log("'artifacts' folder: '$artifactsFolder'.")
}
return $artifactsFolder
}
function Get-ProjectFile {
[OutputType([System.IO.FileInfo])]
param(
[parameter(Mandatory=$true)] [System.IO.DirectoryInfo]$SolutionFolder,
[parameter(Mandatory=$true)] [string]$ProjectName
)
# TO-DO: validation
[System.IO.DirectoryInfo]$projectFolder = [System.IO.Path]::Combine($SolutionFolder, "src")
if ($projectFolder.Exists.Equals($false)) {
[Logger]::Log("'src' folder doesn't exist: '$projectFolder'.")
return $null
}
$projectFolder = [System.IO.Path]::Combine($projectFolder, $ProjectName)
if ($projectFolder.Exists.Equals($false)) {
[Logger]::Log("'$ProjectName' folder doesn't exist: '$projectFolder'.")
return $null
}
[string]$projectFileName = "$($projectFolder)\$($ProjectName).csproj"
[System.IO.FileInfo]$projectFile = [System.IO.FileInfo]::new($projectFileName)
[Logger]::Log("Project's file: '$projectFile'.")
return $projectFile
}
function Publish-Project {
[OutputType([System.IO.FileInfo])]
param(
[parameter(Mandatory=$true)] [System.IO.FileInfo]$ProjectFile,
[parameter(Mandatory=$true)] [System.IO.DirectoryInfo]$ArtifactsFolder,
[parameter(Mandatory=$true)] [string]$Runtime
)
# TO-DO: validation
[Logger]::Log("Publishing project for runtime '$Runtime'...")
[Logger]::Log("")
dotnet publish $ProjectFile -r $Runtime -c Release /p:PublishSingleFile=true /p:PublishReadyToRun=false /p:DebugSymbols=false /p:DebugType=None -o $ArtifactsFolder | Out-Host
[Logger]::Log("")
if ($LASTEXITCODE.Equals(1)) {
[Logger]::Log("The project has failed to publish.")
return $null
}
[System.IO.FileInfo]$publishedFile = $(Get-ChildItem $ArtifactsFolder | Sort-Object -Descending -Property LastWriteTime -Top 1)
[Logger]::Log("The project has been successfully published: '$publishedFile'.")
return $publishedFile
}
function Get-ProjectFileAssemblyName {
[OutputType([string])]
param(
[parameter(Mandatory=$true)] [System.IO.FileInfo]$ProjectFile
)
# TO-DO: validation
[xml]$projectFileContent = $(Get-Content -Path $ProjectFile)
return $projectFileContent.Project.PropertyGroup.AssemblyName
}
function Get-ProjectFileVersion {
[OutputType([string])]
param(
[parameter(Mandatory=$true)] [System.IO.FileInfo]$ProjectFile
)
# TO-DO: validation
[xml]$projectFileContent = $(Get-Content -Path $ProjectFile)
return $projectFileContent.Project.PropertyGroup.Version
}
function Get-ZipFileName {
[OutputType([string])]
param(
[parameter(Mandatory=$true)] [string]$AssemblyName,
[parameter(Mandatory=$true)] [string]$Version,
[parameter(Mandatory=$true)] [string]$Runtime
)
# TO-DO: validation
[string]$zipFileName = [string]::Format("{0}_{1}_{2}.zip", $AssemblyName, $Version, $Runtime)
return $zipFileName
}
function New-ZipFile {
[OutputType([System.IO.FileInfo])]
param(
[parameter(Mandatory=$true)] [System.IO.FileInfo]$File,
[parameter(Mandatory=$true)] [string]$ZipFileName
)
# TO-DO: validation
[System.IO.FileInfo]$zipFile = [System.IO.Path]::Combine($File.Directory, $ZipFileName)
[Logger]::Log("Zipping '$File' as '$ZipFileName'...")
Compress-Archive -Path $File -DestinationPath $zipFile -Force
[Logger]::Log("The file has been successfully zipped: '$zipFile'.")
return $zipFile
}
function Remove-AllExceptZip {
[OutputType([System.Void])]
param(
[parameter(Mandatory=$true)] [System.IO.DirectoryInfo]$ArtifactsFolder
)
# TO-DO: validation
[Logger]::Log("Removing all files except *.Zip from '$ArtifactsFolder'...")
Remove-Item -Path "$ArtifactsFolder\*" -Exclude "*.zip" -Force
[Logger]::Log("Removing completed.")
}
function Build-Client {
[OutputType([System.IO.FileInfo])]
param(
[parameter(Mandatory=$true)] [System.IO.DirectoryInfo]$SolutionFolder,
[parameter(Mandatory=$true)] [System.IO.DirectoryInfo]$ArtifactsFolder,
[parameter(Mandatory=$true)] [string]$ProjectName,
[parameter(Mandatory=$true)] [string]$Runtime,
[parameter(Mandatory=$true)] [bool]$RemoveAllExceptZip
)
# TO-DO: validation
[Logger]::Log("Build process started for '$ProjectName' and '$Runtime'...")
[System.IO.FileInfo]$projectFile = $(Get-ProjectFile -SolutionFolder $SolutionFolder -ProjectName $ProjectName)
if (-not $projectFile) {
[Logger]::Log("Aborting.")
break
}
[System.IO.FileInfo]$publishedFile = $(Publish-Project -ProjectFile $projectFile -ArtifactsFolder $ArtifactsFolder -Runtime $Runtime)
if (-not $publishedFile) {
[Logger]::Log("Aborting.")
break
}
[string]$assemblyName = $(Get-ProjectFileAssemblyName -ProjectFile $projectFile)
[string]$version = $(Get-ProjectFileVersion -ProjectFile $projectFile)
[string]$zipFileName = $(Get-ZipFileName -AssemblyName $assemblyName -Version $version -Runtime $Runtime)
[System.IO.FileInfo]$zipFile = $(New-ZipFile -File $publishedFile -ZipFileName $zipFileName)
if ($RemoveAllExceptZip.Equals($true)) {
Remove-AllExceptZip -ArtifactsFolder $ArtifactsFolder
}
[Logger]::Log("Build process for '$ProjectName' and '$Runtime' completed.")
return $zipFile
}
function Build-Clients {
[OutputType([System.Collections.Generic.List[System.IO.FileInfo]])]
param(
[parameter(Mandatory=$true)] [System.IO.DirectoryInfo]$SolutionFolder,
[parameter(Mandatory=$true)] [System.IO.DirectoryInfo]$ArtifactsFolder,
[parameter(Mandatory=$true)] [string]$ProjectName,
[parameter(Mandatory=$true)] [string[]]$Runtimes,
[parameter(Mandatory=$true)] [bool]$RemoveAllExceptZip
)
# TO-DO: validation
[Logger]::Log("Build process started for '$ProjectName' and '$($Runtimes.Count)' runtimes...")
[System.Collections.Generic.List[System.IO.FileInfo]]$zipFiles = [System.Collections.Generic.List[System.IO.FileInfo]]::new()
foreach ($runtime in $runtimes) {
[System.IO.FileInfo]$zipFile = $(Build-Client `
-SolutionFolder $SolutionFolder `
-ArtifactsFolder $ArtifactsFolder `
-ProjectName $ProjectName `
-Runtime $runtime `
-RemoveAllExceptZip $RemoveAllExceptZip)
$zipFiles.Add($zipFile)
}
[Logger]::Log("'$($zipFiles.Count)' zip files have been created.")
[Logger]::Log("Build process for '$ProjectName' and '$($Runtimes.Count)' runtimes completed.")
return $zipFiles
}
function Get-NuGetPackages {
[OutputType([string[]])]
param(
[parameter(Mandatory=$true)] [System.IO.DirectoryInfo]$ArtifactsFolder
)
# TO-DO: validation
[string[]]$packageNames = (Get-ChildItem -Path "$ArtifactsFolder\*" -Include @("*.nupkg") | ForEach-Object { $_.Name} )
[Logger]::Log("'$($packageNames.Count)' NuGet packages have been found in the provided artifacts folder.")
return $packageNames
}
function Build-Library {
<#
By default, this function will create a .nupkg package out of every project found in the .sln file.
If you want to exclude one or more projects, please add the <IsPackable>false</IsPackable> field to the .csproj as shown below:
<Project>
<PropertyGroup>
<IsPackable>false</IsPackable>
</PropertyGroup>
</Project>
#>
[OutputType([string[]])]
param(
[parameter(Mandatory=$true)] [System.IO.DirectoryInfo]$SolutionFolder,
[parameter(Mandatory=$true)] [System.IO.DirectoryInfo]$ArtifactsFolder
)
# TO-DO: validation
try {
[Logger]::Log("The following solution directory has been provided: '$($SolutionFolder.FullName)'.")
[Logger]::Log("The following artifacts directory has been provided: '$($ArtifactsFolder.FullName)'.")
[System.IO.FileInfo[]]$solutionFiles = (Get-ChildItem -Path "$SolutionFolder\*" -Include @("*.sln"))
if ($solutionFiles.Count.Equals(1).Equals($false))
{
[Logger]::Log("An unexpected amount of solution files have been found in the current directory.")
return $null
}
[System.IO.FileInfo]$solutionFileName = $solutionFiles[0]
[Logger]::Log("The following solution file has been found: '$($solutionFileName.Name)'.")
[Logger]::Log("Creating NuGet package(s) using 'dotnet pack'...")
dotnet pack $solutionFileName --output $ArtifactsFolder
[Logger]::Log("Exit code is: '$($LASTEXITCODE)'.")
if ($LASTEXITCODE.Equals(0)) {
[string[]]$packageNames = (Get-NuGetPackages -ArtifactsFolder $ArtifactsFolder)
if ($packageNames) {
[Logger]::Log("The NuGet packages are: '$packageNames'")
}
else {
[Logger]::Log("No NuGet packages found in the artifacts folder (?).")
}
return $packageNames
}
else {
return $null
}
}
catch {
[Logger]::Log($_.Exception.Message)
return $null
}
}
function Invoke-BuildScript {
[OutputType([System.Void])]
param()
$ErrorActionPreference = "Stop"
try {
if ($(Assert-ThatDotnetIsInstalled).Equals($false)) {
[Logger]::Log("Aborting.")
break
}
[System.IO.DirectoryInfo]$solutionFolder = Get-CurrentDirectory
[System.IO.DirectoryInfo]$artifactsFolder = $(Get-ArtifactsFolder -SolutionFolder $solutionFolder -ForcePublishToDesktop $forcePublishToDesktop)
[System.Collections.Generic.List[System.IO.FileInfo]]$clients = `
(Build-Clients `
-SolutionFolder $solutionFolder `
-ArtifactsFolder $artifactsFolder `
-ProjectName $clientProjectName `
-Runtimes $runtimes `
-RemoveAllExceptZip $removeAllExceptZip)
[string[]]$packageNames = (Build-Library -SolutionFolder $solutionFolder -ArtifactsFolder $artifactsFolder)
}
catch {
[Logger]::Log($_.Exception.Message)
}
}
# Main
Clear-Host
Invoke-BuildScript