-
Notifications
You must be signed in to change notification settings - Fork 0
/
build.ps1
248 lines (224 loc) · 10.5 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
<#
.DESCRIPTION
Wrapper for installing dependencies and building the product.
.Notes
On Windows, it may be required to call this script with the proper execution policy.
You can do this by issuing the following PowerShell command:
PS C:\> powershell -ExecutionPolicy Bypass -File .\build.ps1
For more information on Execution Policies:
https://go.microsoft.com/fwlink/?LinkID=135170
#>
param(
[Parameter(Mandatory = $false, HelpMessage = 'Install all dependencies required to build. (Switch, default: false)')]
[switch]$install = $false,
[Parameter(Mandatory = $false, HelpMessage = 'Clean build, wipe out all build artifacts. (Switch, default: false)')]
[switch]$clean = $false,
[Parameter(Mandatory = $false, HelpMessage = 'Build kit to be used. (String, default: "prod")')]
[string]$buildKit = "prod",
[Parameter(Mandatory = $false, HelpMessage = 'Target to be built. (String, default: "all")')]
[string]$target = "all",
[Parameter(Mandatory = $false, HelpMessage = 'Variants (of the product) to be built (List of strings, leave empty to be asked or "all" for automatic build of all variants)')]
[string[]]$variants = $null,
[Parameter(Mandatory = $false, HelpMessage = 'filter for selftests; define in pytest syntax: https://docs.pytest.org/en/6.2.x/usage.html; e.g. "Disco or test_CustA__Var1.py"')]
[string]$filter = "",
[Parameter(Mandatory = $false, HelpMessage = 'Additional build arguments for Ninja (e.g., "-d explain -d keepdepfile" for debugging purposes)')]
[string]$ninjaArgs = "",
[Parameter(Mandatory = $false, HelpMessage = 'Delete CMake cache and reconfigure. (Switch, default: false)')]
[switch]$reconfigure = $false
)
# Call a command and handle its exit code
Function Invoke-CommandLine {
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingInvokeExpression', '', Justification = 'Usually this statement must be avoided (https://learn.microsoft.com/en-us/powershell/scripting/learn/deep-dives/avoid-using-invoke-expression?view=powershell-7.3), here it is OK as it does not execute unknown code.')]
param (
[Parameter(Mandatory = $true, Position = 0)]
[string]$CommandLine,
[Parameter(Mandatory = $false, Position = 1)]
[bool]$StopAtError = $true,
[Parameter(Mandatory = $false, Position = 2)]
[bool]$Silent = $false
)
if (-Not $Silent) {
Write-Output "Executing: $CommandLine"
}
$global:LASTEXITCODE = 0
Invoke-Expression $CommandLine
if ($global:LASTEXITCODE -ne 0) {
if ($StopAtError) {
Write-Error "Command line call `"$CommandLine`" failed with exit code $global:LASTEXITCODE"
}
else {
if (-Not $Silent) {
Write-Output "Command line call `"$CommandLine`" failed with exit code $global:LASTEXITCODE, continuing ..."
}
}
}
}
# Update/Reload current environment variable PATH with settings from registry
Function Initialize-EnvPath {
# workaround for system-wide installations
if ($Env:USER_PATH_FIRST) {
$Env:Path = [System.Environment]::GetEnvironmentVariable("Path", "User") + ";" + [System.Environment]::GetEnvironmentVariable("Path", "Machine")
}
else {
$Env:Path = [System.Environment]::GetEnvironmentVariable("Path", "Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path", "User")
}
}
function Test-RunningInCIorTestEnvironment {
return [Boolean]($Env:JENKINS_URL -or $Env:PYTEST_CURRENT_TEST -or $Env:GITHUB_ACTIONS)
}
# Build with given parameters
Function Invoke-Build {
param (
[Parameter(Mandatory = $false)]
[bool]$clean = $false,
[Parameter(Mandatory = $false)]
[string]$buildKit = "prod",
[Parameter(Mandatory = $true)]
[string]$target = "all",
[Parameter(Mandatory = $false)]
[string[]]$variants = $null,
[Parameter(Mandatory = $false)]
[string]$filter = "",
[Parameter(Mandatory = $false)]
[string]$ninjaArgs = "",
[Parameter(Mandatory = $false)]
[bool]$reconfigure = $false
)
if ("selftests" -eq $target) {
# Run python tests to test all relevant variants and platforms (build kits)
# (normally run in CI environment/Jenkins)
Write-Output "Running all selfstests ..."
# Build folder for CMake builds
$buildFolder = "build"
# fresh and clean CMake builds
if ($clean) {
if (Test-Path -Path $buildFolder) {
Write-Output "Removing build folder '$buildFolder' ..."
Remove-Item $buildFolder -Force -Recurse
}
}
# Filter pytest test cases
$filterCmd = ''
# Consider environment variable BRANCH_NAME (e.g. on Jenkins) to filter tests in release branch builds
if ($Env:BRANCH_NAME -and ($Env:BRANCH_NAME -match 'release/([^/]+/[^/]+)(.*)')) {
$filterCmd = "-k " + $Matches[1]
}
# otherwise consider command line option '-filter' if given
elseif ($filter) {
$filterCmd = "-k '$filter'"
}
# Test result of pytest
$pytestJunitXml = "test/output/test-report.xml"
# Delete any old pytest result
if (Test-Path -Path $pytestJunitXml) {
Remove-Item $pytestJunitXml -Force
}
# Finally run pytest
Invoke-CommandLine -CommandLine "python -m pipenv run python -m pytest test --junitxml=$pytestJunitXml $filterCmd"
}
else {
if ((-Not $variants) -or ($variants -eq 'all')) {
$dirs = Get-Childitem -Include config.cmake -Path variants -Recurse | Resolve-Path -Relative
$variantsList = @()
Foreach ($dir in $dirs) {
$variant = (get-item $dir).Directory.Parent.BaseName + "/" + (get-item $dir).Directory.BaseName
$variantsList += $variant
}
$variantsSelected = @()
if (-Not $variants) {
# variant selection by user if not specified
Write-Information -Tags "Info:" -MessageData "no '--variant <variant>' was given, please select from list:"
Foreach ($variant in $variantsList) {
Write-Information -Tags "Info:" -MessageData ("(" + [array]::IndexOf($variantsList, $variant) + ") " + $variant)
}
$variantsSelected += $variantsList[[int](Read-Host "Please enter selected variant number")]
Write-Information -Tags "Info:" -MessageData "Selected variant is: $variantsSelected"
}
else {
# otherwise build all variants
$variantsSelected = $variantsList
}
}
else {
$variantsSelected = $Variants.Replace('\', '/').Replace('./variant/', '').Replace('./variants/', '').Split(',')
}
# Select 'test' build kit based on target
if ($target.Contains("unittests") -or $target.Contains("reports")) {
$buildKit = "test"
}
Foreach ($variant in $variantsSelected) {
Write-Output "Building target '$target' with build kit '$buildKit' for variant '$variant' ..."
$buildFolder = "build/$variant/$buildKit"
# fresh and clean build
if ($clean) {
if (Test-Path -Path $buildFolder) {
Write-Output "Removing build folder '$buildFolder' ..."
Remove-Item $buildFolder -Force -Recurse
}
}
# delete CMake cache and reconfigure
if ($reconfigure) {
if (Test-Path -Path "$buildFolder/CMakeCache.txt") {
Remove-Item "$buildFolder/CMakeCache.txt" -Force
}
if (Test-Path -Path "$buildFolder/CMakeFiles") {
Remove-Item "$buildFolder/CMakeFiles" -Force -Recurse
}
}
# CMake configure
$variantDetails = $variant.Split('/')
$platform = $variantDetails[0]
$subsystem = $variantDetails[1]
$additionalConfig = "-DBUILD_KIT=`"$buildKit`""
if ($buildKit -eq "test") {
$additionalConfig += " -DCMAKE_TOOLCHAIN_FILE=`"tools/toolchains/gcc/toolchain.cmake`""
}
Invoke-CommandLine -CommandLine "python -m pipenv run cmake -B '$buildFolder' -G Ninja -DFLAVOR=`"$platform`" -DSUBSYSTEM=`"$subsystem`" $additionalConfig"
# CMake clean all dead artifacts. Required when running incremented builds to delete obsolete artifacts.
Invoke-CommandLine -CommandLine "python -m pipenv run cmake --build '$buildFolder' --target $target -- -t cleandead"
# CMake build
Invoke-CommandLine -CommandLine "python -m pipenv run cmake --build '$buildFolder' --target $target -- $ninjaArgs"
}
}
}
## start of script
# Always set the $InformationPreference variable to "Continue" globally,
# this way it gets printed on execution and continues execution afterwards.
$InformationPreference = "Continue"
# Stop on first error
$ErrorActionPreference = "Stop"
Push-Location $PSScriptRoot
Write-Output "Running in ${pwd}"
try {
if ($install) {
# Installation of Scoop, Python and pipenv via bootstrap
if (-Not (Test-Path -Path '.bootstrap')) {
New-Item -ItemType Directory '.bootstrap'
}
Invoke-RestMethod "https://raw.githubusercontent.com/avengineers/bootstrap/v1.1.0/bootstrap.ps1" -OutFile ".\.bootstrap\bootstrap.ps1"
Invoke-CommandLine ". .\.bootstrap\bootstrap.ps1" -Silent $true
Write-Output "For installation changes to take effect, please close and re-open your current shell."
}
else {
# Call build system
if (Test-RunningInCIorTestEnvironment -or $Env:USER_PATH_FIRST) {
Initialize-EnvPath
}
# Call CMake
Invoke-Build `
-target $target `
-buildKit $buildKit `
-variants $variants `
-clean $clean `
-reconfigure $reconfigure `
-ninjaArgs $ninjaArgs `
-filter $filter
}
}
finally {
Pop-Location
if (-Not (Test-RunningInCIorTestEnvironment)) {
Read-Host -Prompt "Press Enter to continue ..."
}
}
## end of script