mirror of
https://github.com/OrcaSlicer/OrcaSlicer.git
synced 2026-09-08 09:46:55 +00:00
Merge branch 'main' into feature/filament_id
This commit is contained in:
SoftFever
6
scripts/check_profile.bat
Normal file
6
scripts/check_profile.bat
Normal file
@@ -0,0 +1,6 @@
|
||||
@echo off
|
||||
REM Runs check_profile.ps1, the Windows twin of check_profile.sh, from cmd.
|
||||
REM -ExecutionPolicy Bypass is needed because a Windows client defaults to Restricted,
|
||||
REM which refuses to run a checked-out .ps1 at all.
|
||||
powershell -NoProfile -ExecutionPolicy Bypass -File "%~dp0check_profile.ps1" %*
|
||||
exit /b %ERRORLEVEL%
|
||||
564
scripts/check_profile.ps1
Normal file
564
scripts/check_profile.ps1
Normal file
@@ -0,0 +1,564 @@
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Local twin of the "Check profiles" CI job (.github/workflows/check_profiles.yml), for Windows.
|
||||
|
||||
.DESCRIPTION
|
||||
The Windows counterpart of scripts/check_profile.sh, and kept deliberately close to it.
|
||||
|
||||
Runs the same five checks, in the same order, with the same validator flags, and with the
|
||||
same semantics: every check runs even after an earlier one fails (the workflow's
|
||||
continue-on-error), then the script exits non-zero once at the end.
|
||||
|
||||
extra_json_check scripts/orca_extra_profile_check.py
|
||||
validate_system validator -p <profiles> -l <level>
|
||||
validate_slice validator -p <profiles> -s -l <level>
|
||||
validate_filament_subtypes validator -p <profiles> -l <level> -f
|
||||
validate_custom validator against every released custom-preset fixture
|
||||
|
||||
Everything that has to be downloaded - the profile validator and the custom-preset fixture
|
||||
archives - lands under <repo>\.test\check_profiles and is reused on the next run. That
|
||||
directory also holds one log per check plus a copy of the comment CI would post on the PR.
|
||||
|
||||
resources\profiles\user, which the validator creates as its data dir but a CI checkout never
|
||||
has, is moved aside for the duration of the run and restored on exit. Only one run per work
|
||||
dir at a time.
|
||||
|
||||
x64 and ARM64 hosts are both supported. A locally built validator is chosen by the machine
|
||||
type in its PE header rather than by the name of its build tree, so build\ (x64) and
|
||||
build-arm64\ side by side resolve correctly; the published nightly is x64 only and runs
|
||||
under emulation on ARM64.
|
||||
|
||||
.PARAMETER ProfilesDir
|
||||
Profile tree to validate (default: resources\profiles). extra_json_check always looks at the
|
||||
tree next to the script, so this only redirects the validator checks.
|
||||
|
||||
.PARAMETER Validator
|
||||
OrcaSlicer_profile_validator.exe to use; also $env:ORCA_PROFILE_VALIDATOR. Default: the local
|
||||
build*\ Release build (then RelWithDebInfo, MinSizeRel, Debug) for this architecture, else
|
||||
the nightly release build is downloaded.
|
||||
|
||||
.PARAMETER Download
|
||||
Ignore local builds and use the downloaded nightly validator.
|
||||
|
||||
.PARAMETER Refresh
|
||||
Re-download the validator and fixtures instead of using the cache.
|
||||
|
||||
.PARAMETER WorkDir
|
||||
Downloads, logs and fixture trees (default: .test\check_profiles). Point it somewhere short,
|
||||
such as D:\t, if a fixture tree trips Windows' 260-character path limit.
|
||||
|
||||
.PARAMETER LogLevel
|
||||
Validator log level (default: 2, as in CI).
|
||||
|
||||
.PARAMETER Checks
|
||||
Checks to run, by name (default: all of them, in the order listed above).
|
||||
|
||||
.EXAMPLE
|
||||
scripts\check_profile.bat
|
||||
|
||||
.EXAMPLE
|
||||
powershell -ExecutionPolicy Bypass -File scripts\check_profile.ps1 validate_system validate_slice
|
||||
#>
|
||||
|
||||
# PositionalBinding is off so that the check names are the only positional arguments; left on,
|
||||
# a bare "validate_system" would bind to whichever named parameter came next in this block.
|
||||
[CmdletBinding(PositionalBinding = $false)]
|
||||
param(
|
||||
[Alias('p')] [string] $ProfilesDir,
|
||||
[string] $Validator,
|
||||
[string] $WorkDir,
|
||||
[Alias('l')] [int] $LogLevel = 2,
|
||||
[switch] $Download,
|
||||
[switch] $Refresh,
|
||||
[Alias('h')] [switch] $Help,
|
||||
[Parameter(Position = 0, ValueFromRemainingArguments = $true)] [string[]] $Checks
|
||||
)
|
||||
|
||||
$ErrorActionPreference = 'Stop'
|
||||
|
||||
# Windows PowerShell 5.1 still negotiates TLS 1.0/1.1, which github.com refuses.
|
||||
[Net.ServicePointManager]::SecurityProtocol =
|
||||
[Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls12
|
||||
|
||||
$ValidatorReleaseUrl = 'https://github.com/OrcaSlicer/OrcaSlicer/releases/download/nightly-builds'
|
||||
$FixtureReleaseUrl = 'https://github.com/OrcaSlicer/OrcaSlicer-profile-validator/releases/download/fixture-archive'
|
||||
|
||||
$RepoRoot = Split-Path -Parent $PSScriptRoot
|
||||
|
||||
# PROCESSOR_ARCHITECTURE reports the architecture of the *shell*, so a 32-bit PowerShell on a
|
||||
# 64-bit OS says x86; ARCHITEW6432 is the machine's own in that case.
|
||||
$HostArch = if ($env:PROCESSOR_ARCHITEW6432) { $env:PROCESSOR_ARCHITEW6432 } else { $env:PROCESSOR_ARCHITECTURE }
|
||||
$HostArch = switch ($HostArch) {
|
||||
'ARM64' { 'arm64' }
|
||||
'AMD64' { 'x64' }
|
||||
default { 'x86' }
|
||||
}
|
||||
|
||||
$AllChecks = @('extra_json_check', 'validate_system', 'validate_slice', 'validate_filament_subtypes', 'validate_custom')
|
||||
|
||||
$script:LogWriter = $null
|
||||
$script:Python = ''
|
||||
|
||||
# ---------------------------------------------------------------------------- helpers
|
||||
|
||||
function Die([string] $Message) {
|
||||
Write-Host "check_profile.ps1: $Message" -ForegroundColor Red
|
||||
exit 2
|
||||
}
|
||||
|
||||
# UTF-8 without a BOM, so a log reads the same here as the artifact CI uploads.
|
||||
function New-LogWriter([string] $Path) {
|
||||
New-Object IO.StreamWriter($Path, $false, (New-Object Text.UTF8Encoding($false)))
|
||||
}
|
||||
|
||||
# Output of the check being run: shown, and kept in that check's log.
|
||||
function Write-CheckLog([string] $Text) {
|
||||
Write-Host $Text
|
||||
if ($script:LogWriter) { $script:LogWriter.WriteLine($Text) }
|
||||
}
|
||||
|
||||
# Runs a program and returns its exit code, streaming stdout and stderr into the current check's
|
||||
# log. -OutFile sends that output to a file of its own instead, silently.
|
||||
function Invoke-Tool {
|
||||
param([string] $Exe, [string[]] $Arguments, [string] $OutFile)
|
||||
|
||||
# Under 'Stop', 2>&1 turns every stderr line of a native command into a terminating error.
|
||||
# Assigning the preference here scopes it to this function, so it undoes itself on return.
|
||||
$ErrorActionPreference = 'Continue'
|
||||
|
||||
$writer = if ($OutFile) { New-LogWriter $OutFile } else { $null }
|
||||
try {
|
||||
& $Exe @Arguments 2>&1 | ForEach-Object {
|
||||
if ($writer) { $writer.WriteLine("$_") } else { Write-CheckLog "$_" }
|
||||
}
|
||||
return $LASTEXITCODE
|
||||
} catch {
|
||||
if ($writer) { $writer.WriteLine("$_") } else { Write-CheckLog "$_" }
|
||||
return 1
|
||||
} finally {
|
||||
if ($writer) { $writer.Dispose() }
|
||||
}
|
||||
}
|
||||
|
||||
# The first $Limit characters of a log, as CI truncates them for the PR comment.
|
||||
function Get-LogHead([string] $Path, [int] $Limit) {
|
||||
$text = if (Test-Path -LiteralPath $Path) { [IO.File]::ReadAllText($Path) } else { '' }
|
||||
if (-not $text) { return 'No output captured' }
|
||||
if ($text.Length -gt $Limit) { return $text.Substring(0, $Limit) }
|
||||
return $text
|
||||
}
|
||||
|
||||
# ---------------------------------------------------------------------------- arguments
|
||||
|
||||
if ($Help) { Get-Help $PSCommandPath -Detailed; exit 0 }
|
||||
|
||||
foreach ($name in $Checks) {
|
||||
if ($name -like '-*') { Die "unknown option '$name' (try -Help)" }
|
||||
if ($AllChecks -notcontains $name) { Die "unknown check '$name' (try -Help)" }
|
||||
}
|
||||
if (-not $Checks) { $Checks = $AllChecks }
|
||||
|
||||
if (-not $ProfilesDir) { $ProfilesDir = Join-Path $RepoRoot 'resources\profiles' }
|
||||
if (-not (Test-Path -LiteralPath $ProfilesDir -PathType Container)) { Die "profile directory not found: $ProfilesDir" }
|
||||
$ProfilesDir = (Resolve-Path -LiteralPath $ProfilesDir).Path
|
||||
|
||||
if (-not $WorkDir) { $WorkDir = Join-Path $RepoRoot '.test\check_profiles' }
|
||||
$LogDir = Join-Path $WorkDir 'logs'
|
||||
try { New-Item -ItemType Directory -Force -Path $LogDir | Out-Null } catch { Die "cannot create ${LogDir}: $_" }
|
||||
$WorkDir = (Resolve-Path -LiteralPath $WorkDir).Path
|
||||
$LogDir = Join-Path $WorkDir 'logs'
|
||||
|
||||
if (-not $Validator) { $Validator = $env:ORCA_PROFILE_VALIDATOR }
|
||||
|
||||
# ------------------------------------------------------------------- clean profile tree
|
||||
|
||||
# The validator points its data dir at the profile tree, so it creates - and, with -g, fills -
|
||||
# <profiles>\user. A CI checkout never has that directory, and anything left in it from an
|
||||
# earlier local run would be loaded as user presets and validated too. Move it aside for the
|
||||
# duration of the run so what gets checked is what CI checks.
|
||||
$script:StashedUserDir = ''
|
||||
|
||||
function Push-UserPresets {
|
||||
$user = Join-Path $ProfilesDir 'user'
|
||||
if (-not (Test-Path -LiteralPath $user -PathType Container)) { return }
|
||||
$script:StashedUserDir = Join-Path $WorkDir "user-presets-$PID"
|
||||
Remove-Item -LiteralPath $script:StashedUserDir -Recurse -Force -ErrorAction SilentlyContinue
|
||||
try { Move-Item -LiteralPath $user -Destination $script:StashedUserDir }
|
||||
catch { $script:StashedUserDir = ''; Die "cannot move $user aside: $_" }
|
||||
Write-Host "moved $user aside for the run (restored on exit)"
|
||||
}
|
||||
|
||||
function Pop-UserPresets {
|
||||
# The validator leaves an empty user\default\{filament,machine,process} skeleton behind.
|
||||
# Prune it directory by directory, never wholesale: one that holds a real file survives and
|
||||
# is reported instead of being deleted. Runs even when nothing was stashed, so a tree that
|
||||
# had no user\ before the run does not gain one.
|
||||
$user = Join-Path $ProfilesDir 'user'
|
||||
Remove-EmptyDirs $user
|
||||
if (-not $script:StashedUserDir) { return }
|
||||
if (Test-Path -LiteralPath $user) {
|
||||
Write-Host "$user is not empty; your presets stay in $($script:StashedUserDir)"
|
||||
} else {
|
||||
Move-Item -LiteralPath $script:StashedUserDir -Destination $user
|
||||
}
|
||||
$script:StashedUserDir = ''
|
||||
}
|
||||
|
||||
function Remove-EmptyDirs([string] $Path) {
|
||||
if (-not (Test-Path -LiteralPath $Path -PathType Container)) { return }
|
||||
Get-ChildItem -LiteralPath $Path -Recurse -Directory -Force |
|
||||
Sort-Object { $_.FullName.Length } -Descending |
|
||||
ForEach-Object {
|
||||
if (-not (Get-ChildItem -LiteralPath $_.FullName -Force)) {
|
||||
Remove-Item -LiteralPath $_.FullName -Force
|
||||
}
|
||||
}
|
||||
if (-not (Get-ChildItem -LiteralPath $Path -Force)) { Remove-Item -LiteralPath $Path -Force }
|
||||
}
|
||||
|
||||
# ---------------------------------------------------------------------------- downloads
|
||||
|
||||
# Cached; -Refresh, or -Force, pulls a new copy. Release assets never change, so caching them is
|
||||
# safe; the fixture manifest is the index that grows with every release, and CI re-reads it on
|
||||
# every run.
|
||||
function Save-Asset {
|
||||
param([string] $Url, [string] $Dest, [switch] $Force)
|
||||
|
||||
if (-not $Refresh -and -not $Force -and (Test-Path -LiteralPath $Dest -PathType Leaf) -and
|
||||
(Get-Item -LiteralPath $Dest).Length -gt 0) {
|
||||
return
|
||||
}
|
||||
New-Item -ItemType Directory -Force -Path (Split-Path -Parent $Dest) | Out-Null
|
||||
Write-Host "downloading $(Split-Path -Leaf $Dest) ..."
|
||||
|
||||
# Invoke-WebRequest spends most of a large download repainting its progress bar.
|
||||
$ProgressPreference = 'SilentlyContinue'
|
||||
$part = "$Dest.part"
|
||||
for ($attempt = 1; ; $attempt++) {
|
||||
try {
|
||||
Invoke-WebRequest -Uri $Url -OutFile $part -UseBasicParsing
|
||||
break
|
||||
} catch {
|
||||
if ($attempt -ge 3) {
|
||||
Remove-Item -LiteralPath $part -Force -ErrorAction SilentlyContinue
|
||||
throw "download failed: $Url"
|
||||
}
|
||||
}
|
||||
}
|
||||
Move-Item -LiteralPath $part -Destination $Dest -Force
|
||||
}
|
||||
|
||||
function Get-Sha256([string] $Path) {
|
||||
return (Get-FileHash -LiteralPath $Path -Algorithm SHA256).Hash
|
||||
}
|
||||
|
||||
# Directories a built validator can sit in, best first: build_win.bat names its trees build,
|
||||
# build-dbginfo, build-minsize and build-dbg, each optionally -clang and -arm64 suffixed, and
|
||||
# CMake puts the binary in src\<config>. Each pattern is matched both directly under a build root
|
||||
# and one level down (build\x64), for trees laid out the way the macOS ones are.
|
||||
function Get-ValidatorSearchDirs {
|
||||
foreach ($config in 'Release', 'RelWithDebInfo', 'MinSizeRel', 'Debug') {
|
||||
Join-Path $RepoRoot "build*\src\$config"
|
||||
Join-Path $RepoRoot "build*\*\src\$config"
|
||||
}
|
||||
Join-Path $RepoRoot 'build*\src'
|
||||
Join-Path $RepoRoot 'build*\*\src'
|
||||
}
|
||||
|
||||
# The machine type from the PE header, which is what actually decides whether an .exe can run
|
||||
# here - the name of the build tree only says what it was meant to be.
|
||||
function Get-ExeArch([string] $Path) {
|
||||
try {
|
||||
$stream = [IO.File]::OpenRead($Path)
|
||||
try {
|
||||
$reader = New-Object IO.BinaryReader($stream)
|
||||
$stream.Position = 0x3C # e_lfanew: offset of the PE header
|
||||
$stream.Position = $reader.ReadInt32()
|
||||
if ($reader.ReadUInt32() -ne 0x00004550) { return '' } # "PE\0\0"
|
||||
switch ($reader.ReadUInt16()) {
|
||||
0x8664 { 'x64' }
|
||||
0xAA64 { 'arm64' }
|
||||
0x014C { 'x86' }
|
||||
default { '' }
|
||||
}
|
||||
} finally { $stream.Dispose() }
|
||||
} catch { '' }
|
||||
}
|
||||
|
||||
# First locally built OrcaSlicer_profile_validator.exe, in the order above. An x86 build, and on
|
||||
# ARM64 an x64 one, is kept only as a fallback: it runs, but emulated. An ARM64 build on an x64
|
||||
# host does not run at all and is never offered.
|
||||
function Find-LocalValidator {
|
||||
$emulated = ''
|
||||
foreach ($pattern in (Get-ValidatorSearchDirs)) {
|
||||
foreach ($dir in @(Resolve-Path -Path $pattern -ErrorAction SilentlyContinue)) {
|
||||
$candidate = Join-Path $dir.Path 'OrcaSlicer_profile_validator.exe'
|
||||
if (-not (Test-Path -LiteralPath $candidate -PathType Leaf)) { continue }
|
||||
$arch = Get-ExeArch $candidate
|
||||
if (-not $arch -or $arch -eq $HostArch) { return $candidate }
|
||||
if (-not $emulated -and ($arch -eq 'x86' -or $HostArch -eq 'arm64')) { $emulated = $candidate }
|
||||
}
|
||||
}
|
||||
if ($emulated) { Write-Host "no $HostArch build found, falling back to $emulated (emulated)" }
|
||||
return $emulated
|
||||
}
|
||||
|
||||
# The nightly release build, same one CI uses. Windows ships the bare .exe, x64 only.
|
||||
function Save-NightlyValidator {
|
||||
if ($HostArch -ne 'x64') {
|
||||
Write-Host "the nightly Windows validator is x64; it runs here under emulation"
|
||||
}
|
||||
$exe = Join-Path $WorkDir 'validator\OrcaSlicer_profile_validator.exe'
|
||||
Save-Asset -Url "$ValidatorReleaseUrl/OrcaSlicer_profile_validator_Windows_nightly.exe" -Dest $exe
|
||||
return $exe
|
||||
}
|
||||
|
||||
function Resolve-Validator {
|
||||
if ($Validator) {
|
||||
if (-not (Test-Path -LiteralPath $Validator -PathType Leaf)) { Die "validator not found: $Validator" }
|
||||
return (Resolve-Path -LiteralPath $Validator).Path
|
||||
}
|
||||
if (-not $Download) {
|
||||
$local = Find-LocalValidator
|
||||
if ($local) {
|
||||
Write-Host "using locally built validator: $local"
|
||||
return $local
|
||||
}
|
||||
}
|
||||
try { $downloaded = Save-NightlyValidator } catch { Die "could not obtain a profile validator: $_" }
|
||||
Write-Host "using downloaded validator: $downloaded"
|
||||
return $downloaded
|
||||
}
|
||||
|
||||
# python3 is rarely on PATH on Windows: the py launcher is the reliable way in, and a bare
|
||||
# `python` may be the Store stub, which prints an advert and exits non-zero. Probe each for the
|
||||
# interpreter it actually resolves to, and use that.
|
||||
function Resolve-Python {
|
||||
$ErrorActionPreference = 'Continue'
|
||||
if ($script:Python) { return $script:Python }
|
||||
foreach ($candidate in 'py -3', 'python', 'python3') {
|
||||
$words = $candidate -split ' '
|
||||
$exe = Get-Command $words[0] -CommandType Application -ErrorAction SilentlyContinue | Select-Object -First 1
|
||||
if (-not $exe) { continue }
|
||||
$leading = @($words | Select-Object -Skip 1)
|
||||
$found = & $exe.Source @leading -c 'import sys; print(sys.executable)' 2>$null
|
||||
if ($LASTEXITCODE -eq 0 -and $found) {
|
||||
$script:Python = "$found"
|
||||
return $script:Python
|
||||
}
|
||||
}
|
||||
Die 'no Python 3 found; install it (or the py launcher) and re-run'
|
||||
}
|
||||
|
||||
# ---------------------------------------------------------------------------- checks
|
||||
|
||||
$CheckBodies = @{
|
||||
|
||||
extra_json_check = {
|
||||
Invoke-Tool -Exe (Resolve-Python) -Arguments @((Join-Path $RepoRoot 'scripts\orca_extra_profile_check.py'))
|
||||
}
|
||||
|
||||
validate_system = {
|
||||
Invoke-Tool -Exe $Validator -Arguments @('-p', $ProfilesDir, '-l', "$LogLevel")
|
||||
}
|
||||
|
||||
# Slices a two-colour cube through every printer so all custom g-code (incl.
|
||||
# change_filament_gcode) is expanded - catches undefined-placeholder / invalid-flow bugs the
|
||||
# static checks cannot see.
|
||||
validate_slice = {
|
||||
Invoke-Tool -Exe $Validator -Arguments @('-p', $ProfilesDir, '-s', '-l', "$LogLevel")
|
||||
}
|
||||
|
||||
validate_filament_subtypes = {
|
||||
Invoke-Tool -Exe $Validator -Arguments @('-p', $ProfilesDir, '-l', "$LogLevel", '-f')
|
||||
}
|
||||
|
||||
# Every released fixture is a snapshot of user presets saved by that OrcaSlicer version; each
|
||||
# is unpacked over the current system profiles and validated, so a profile change that would
|
||||
# break an existing user's presets fails here.
|
||||
validate_custom = {
|
||||
$fixturesDir = Join-Path $WorkDir 'profile-fixtures'
|
||||
$outputDir = Join-Path $WorkDir 'custom-preset-validation'
|
||||
New-Item -ItemType Directory -Force -Path $fixturesDir, $outputDir | Out-Null
|
||||
|
||||
$manifestPath = Join-Path $fixturesDir 'manifest.json'
|
||||
Save-Asset -Url "$FixtureReleaseUrl/manifest.json" -Dest $manifestPath -Force
|
||||
|
||||
$manifest = Get-Content -LiteralPath $manifestPath -Raw | ConvertFrom-Json
|
||||
$entries = if ($manifest -is [array]) { $manifest } else { $manifest.fixtures }
|
||||
$fixtures = @($entries | Where-Object { $_.version -and $_.asset })
|
||||
if (-not $fixtures) {
|
||||
Write-CheckLog "No custom preset fixtures found in $FixtureReleaseUrl/manifest.json"
|
||||
return 1
|
||||
}
|
||||
|
||||
$status = 0
|
||||
$failedLogs = @()
|
||||
$summary = @('## Custom Preset Fixture Validation', '', '| Version | Status | Log |', '| --- | --- | --- |')
|
||||
|
||||
foreach ($fixture in $fixtures) {
|
||||
$version = $fixture.version
|
||||
$asset = $fixture.asset
|
||||
$fixtureZip = Join-Path $fixturesDir $asset
|
||||
$profileTree = Join-Path $outputDir "profiles-$version"
|
||||
$logPath = Join-Path $outputDir "$version.log"
|
||||
$assetUrl = "$FixtureReleaseUrl/$([uri]::EscapeDataString($asset))"
|
||||
|
||||
Save-Asset -Url $assetUrl -Dest $fixtureZip
|
||||
|
||||
$expected = $fixture.asset_sha256
|
||||
if ($expected -and $expected -ne '<sha256>' -and (Get-Sha256 $fixtureZip) -ne $expected.ToUpperInvariant()) {
|
||||
# A cached zip can be stale or truncated; the release asset itself is immutable,
|
||||
# so deleting it forces Save-Asset to pull a fresh copy.
|
||||
Write-Host "checksum mismatch for $asset, re-downloading"
|
||||
Remove-Item -LiteralPath $fixtureZip -Force
|
||||
Save-Asset -Url $assetUrl -Dest $fixtureZip
|
||||
$actual = Get-Sha256 $fixtureZip
|
||||
if ($actual -ne $expected.ToUpperInvariant()) {
|
||||
Write-CheckLog "${asset}: expected $expected, got $actual"
|
||||
return 1
|
||||
}
|
||||
}
|
||||
|
||||
Write-Host "validating custom presets from $version ..."
|
||||
Remove-Item -LiteralPath $profileTree -Recurse -Force -ErrorAction SilentlyContinue
|
||||
New-Item -ItemType Directory -Force -Path $profileTree | Out-Null
|
||||
# Piped rather than copied through <profiles>\*, so a vendor directory whose name
|
||||
# holds a wildcard character is still copied by its literal path.
|
||||
Get-ChildItem -LiteralPath $ProfilesDir -Force | Copy-Item -Destination $profileTree -Recurse -Force
|
||||
Remove-Item -LiteralPath (Join-Path $profileTree 'user') -Recurse -Force -ErrorAction SilentlyContinue
|
||||
Expand-Archive -LiteralPath $fixtureZip -DestinationPath $profileTree -Force
|
||||
|
||||
$result = Invoke-Tool -Exe $Validator -Arguments @('-p', $profileTree, '-l', "$LogLevel") -OutFile $logPath
|
||||
if ($result -eq 0) {
|
||||
$summary += "| $version | PASS | $version.log |"
|
||||
# Only failures are worth keeping; each tree is a full copy of resources\profiles.
|
||||
Remove-Item -LiteralPath $profileTree -Recurse -Force
|
||||
} else {
|
||||
$summary += "| $version | FAIL | $version.log |"
|
||||
$failedLogs += $logPath
|
||||
$status = 1
|
||||
}
|
||||
}
|
||||
|
||||
[IO.File]::WriteAllLines((Join-Path $outputDir 'summary.md'), [string[]] $summary)
|
||||
$summary | ForEach-Object { Write-CheckLog $_ }
|
||||
|
||||
if ($failedLogs) {
|
||||
Write-CheckLog ''
|
||||
Write-CheckLog '## Failed Fixture Logs'
|
||||
foreach ($logPath in $failedLogs) {
|
||||
Write-CheckLog ''
|
||||
Write-CheckLog "### $([IO.Path]::GetFileNameWithoutExtension($logPath))"
|
||||
Write-CheckLog '```'
|
||||
Write-CheckLog (Get-LogHead $logPath 12000)
|
||||
Write-CheckLog '```'
|
||||
}
|
||||
}
|
||||
return $status
|
||||
}
|
||||
}
|
||||
|
||||
# Heading CI puts above this check's log in the PR comment.
|
||||
$CommentHeadings = @{
|
||||
extra_json_check = '### Extra JSON Check Failed'
|
||||
validate_system = '### System Profile Validation Failed'
|
||||
validate_slice = '### Slice Validation Failed (custom g-code expansion)'
|
||||
validate_filament_subtypes = '### Filament Subtype Validation Failed'
|
||||
validate_custom = '### Custom Preset Validation Failed'
|
||||
}
|
||||
|
||||
# ---------------------------------------------------------------------------- run
|
||||
|
||||
function Invoke-Check([string] $Name) {
|
||||
$log = Join-Path $LogDir "$Name.log"
|
||||
Write-Host ''
|
||||
Write-Host "==> $Name" -ForegroundColor Cyan
|
||||
|
||||
$script:LogWriter = New-LogWriter $log
|
||||
try {
|
||||
$result = & $CheckBodies[$Name] | Select-Object -Last 1
|
||||
} catch {
|
||||
Write-CheckLog "$_"
|
||||
$result = 1
|
||||
} finally {
|
||||
$script:LogWriter.Dispose()
|
||||
$script:LogWriter = $null
|
||||
}
|
||||
|
||||
if ([int] $result -eq 0) {
|
||||
Write-Host " $Name passed" -ForegroundColor Green
|
||||
return $true
|
||||
}
|
||||
Write-Host " $Name failed (exit $result)" -ForegroundColor Red
|
||||
return $false
|
||||
}
|
||||
|
||||
# The fixture trees under the work dir are shared scratch space keyed by fixture version, so a
|
||||
# second run would delete a tree the first one is validating.
|
||||
$LockDir = Join-Path $WorkDir '.lock'
|
||||
try { New-Item -ItemType Directory -Path $LockDir -ErrorAction Stop | Out-Null }
|
||||
catch { Die "another run is using $WorkDir (pass -WorkDir, or remove $LockDir if no run is active)" }
|
||||
|
||||
# The validator writes UTF-8, but PowerShell decodes a child process's output using the console
|
||||
# code page, which mangles the accented and CJK preset names in its messages.
|
||||
$PreviousOutputEncoding = [Console]::OutputEncoding
|
||||
|
||||
try {
|
||||
[Console]::OutputEncoding = New-Object Text.UTF8Encoding($false)
|
||||
Push-UserPresets
|
||||
|
||||
if ($Checks | Where-Object { $_ -ne 'extra_json_check' }) { $Validator = Resolve-Validator }
|
||||
|
||||
$results = [ordered] @{}
|
||||
foreach ($name in $AllChecks) {
|
||||
if ($Checks -contains $name) { $results[$name] = Invoke-Check $name }
|
||||
}
|
||||
|
||||
Write-Host ''
|
||||
Write-Host '==> summary' -ForegroundColor Cyan
|
||||
foreach ($name in $results.Keys) {
|
||||
if ($results[$name]) {
|
||||
Write-Host " PASS $name" -ForegroundColor Green
|
||||
} else {
|
||||
Write-Host " FAIL $name ($(Join-Path $LogDir "$name.log"))" -ForegroundColor Red
|
||||
}
|
||||
}
|
||||
|
||||
$failed = @($results.Keys | Where-Object { -not $results[$_] })
|
||||
if (-not $failed) {
|
||||
Remove-Item -LiteralPath (Join-Path $WorkDir 'pr_comment.md') -Force -ErrorAction SilentlyContinue
|
||||
Write-Host ''
|
||||
Write-Host "All checks passed. Logs: $LogDir" -ForegroundColor Green
|
||||
exit 0
|
||||
}
|
||||
|
||||
# The comment check_profiles_comment.yml would post when something fails.
|
||||
$comment = @(
|
||||
# Marker matched by check_profiles_comment.yml to delete prior comments.
|
||||
'<!-- profile-validation-comment -->'
|
||||
'## :x: Profile Validation Errors'
|
||||
''
|
||||
foreach ($name in $failed) {
|
||||
$CommentHeadings[$name]
|
||||
''
|
||||
'```'
|
||||
Get-LogHead (Join-Path $LogDir "$name.log") 30000
|
||||
'```'
|
||||
''
|
||||
}
|
||||
'---'
|
||||
'*Please fix the above errors and push a new commit.*'
|
||||
)
|
||||
$commentPath = Join-Path $WorkDir 'pr_comment.md'
|
||||
[IO.File]::WriteAllLines($commentPath, [string[]] $comment)
|
||||
|
||||
Write-Host ''
|
||||
Write-Host "One or more profile checks failed. Logs: $LogDir" -ForegroundColor Red
|
||||
Write-Host "The comment CI would post: $commentPath"
|
||||
exit 1
|
||||
} finally {
|
||||
Pop-UserPresets
|
||||
Remove-Item -LiteralPath $LockDir -Force -ErrorAction SilentlyContinue
|
||||
[Console]::OutputEncoding = $PreviousOutputEncoding
|
||||
}
|
||||
527
scripts/check_profile.sh
Executable file
527
scripts/check_profile.sh
Executable file
@@ -0,0 +1,527 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# Local twin of the "Check profiles" CI job (.github/workflows/check_profiles.yml).
|
||||
#
|
||||
# Runs the same five checks, in the same order, with the same validator flags, and with the
|
||||
# same semantics: every check runs even after an earlier one fails (the workflow's
|
||||
# continue-on-error), then the script exits non-zero once at the end.
|
||||
#
|
||||
# Everything that has to be downloaded - the profile validator and the custom-preset fixture
|
||||
# archives - lands under <repo>/.test/check_profiles/ and is reused on the next run. That
|
||||
# directory also holds one log per check plus a copy of the comment CI would post on the PR.
|
||||
#
|
||||
# resources/profiles/user, which the validator creates as its data dir but a CI checkout never
|
||||
# has, is moved aside for the duration of the run and restored on exit. Only one run per work
|
||||
# dir at a time.
|
||||
#
|
||||
# Usage: scripts/check_profile.sh [OPTION]... [CHECK]...
|
||||
|
||||
# The check_* functions run through run_check, which dispatches on the check name, so
|
||||
# ShellCheck cannot see that they (and what they call) are used.
|
||||
# shellcheck disable=SC2329
|
||||
|
||||
set -uo pipefail
|
||||
|
||||
VALIDATOR_RELEASE_URL="https://github.com/OrcaSlicer/OrcaSlicer/releases/download/nightly-builds"
|
||||
FIXTURE_RELEASE_URL="https://github.com/OrcaSlicer/OrcaSlicer-profile-validator/releases/download/fixture-archive"
|
||||
|
||||
SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)"
|
||||
REPO_ROOT="$(cd -- "${SCRIPT_DIR}/.." && pwd)"
|
||||
|
||||
HOST_ARCH="$(uname -m)"
|
||||
|
||||
PROFILES_DIR="${REPO_ROOT}/resources/profiles"
|
||||
WORK_DIR="${REPO_ROOT}/.test/check_profiles"
|
||||
VALIDATOR="${ORCA_PROFILE_VALIDATOR:-}"
|
||||
LOG_LEVEL=2
|
||||
PREFER_DOWNLOAD=0
|
||||
REFRESH=0
|
||||
|
||||
ALL_CHECKS=(extra_json_check validate_system validate_slice validate_filament_subtypes validate_custom)
|
||||
CHECKS=()
|
||||
# "<check><TAB>pass|fail" per check that ran; a string rather than an array because bash 3.2
|
||||
# (still the /bin/bash on macOS) cannot expand an empty array under `set -u`.
|
||||
RESULTS=""
|
||||
|
||||
usage() {
|
||||
cat <<EOF
|
||||
Run the profile checks from .github/workflows/check_profiles.yml locally.
|
||||
|
||||
Usage: scripts/check_profile.sh [OPTION]... [CHECK]...
|
||||
|
||||
Checks (default: all, in this order):
|
||||
extra_json_check scripts/orca_extra_profile_check.py
|
||||
validate_system validator -p <profiles> -l <level>
|
||||
validate_slice validator -p <profiles> -s -l <level>
|
||||
validate_filament_subtypes validator -p <profiles> -l <level> -f
|
||||
validate_custom validator against every released custom-preset fixture
|
||||
|
||||
Options:
|
||||
-p, --profiles DIR profile tree to validate (default: resources/profiles)
|
||||
--validator BIN OrcaSlicer_profile_validator to use; also \$ORCA_PROFILE_VALIDATOR.
|
||||
Default: the local build*/ Release build (then RelWithDebInfo, then
|
||||
Debug) for this architecture, else the nightly release build is
|
||||
downloaded for this platform
|
||||
--download ignore local builds and use the downloaded nightly validator
|
||||
--refresh re-download the validator and fixtures instead of using the cache
|
||||
--work-dir DIR downloads, logs and fixture trees (default: .test/check_profiles)
|
||||
-l, --log-level N validator log level (default: ${LOG_LEVEL}, as in CI)
|
||||
-h, --help show this help
|
||||
|
||||
Note: extra_json_check always looks at the tree next to the script
|
||||
(<repo>/resources/profiles); --profiles only redirects the validator checks.
|
||||
EOF
|
||||
}
|
||||
|
||||
msg() { printf '%s\n' "$*" >&2; }
|
||||
die() { printf 'check_profile.sh: %s\n' "$*" >&2; exit 2; }
|
||||
|
||||
if [ -t 1 ]; then
|
||||
C_RED=$'\033[91m'; C_GREEN=$'\033[92m'; C_BOLD=$'\033[1m'; C_RESET=$'\033[0m'
|
||||
else
|
||||
C_RED=''; C_GREEN=''; C_BOLD=''; C_RESET=''
|
||||
fi
|
||||
|
||||
# ---------------------------------------------------------------------------- arguments
|
||||
|
||||
while [ $# -gt 0 ]; do
|
||||
case "$1" in
|
||||
-h|--help) usage; exit 0 ;;
|
||||
-p|--profiles) [ $# -ge 2 ] || die "$1 needs a directory"; PROFILES_DIR="$2"; shift 2 ;;
|
||||
--validator) [ $# -ge 2 ] || die "$1 needs a path"; VALIDATOR="$2"; shift 2 ;;
|
||||
--work-dir) [ $# -ge 2 ] || die "$1 needs a directory"; WORK_DIR="$2"; shift 2 ;;
|
||||
-l|--log-level) [ $# -ge 2 ] || die "$1 needs a number"; LOG_LEVEL="$2"; shift 2 ;;
|
||||
--download) PREFER_DOWNLOAD=1; shift ;;
|
||||
--refresh) REFRESH=1; shift ;;
|
||||
-*) die "unknown option '$1' (try --help)" ;;
|
||||
*)
|
||||
known=0
|
||||
for check in "${ALL_CHECKS[@]}"; do
|
||||
[ "$1" = "${check}" ] && known=1
|
||||
done
|
||||
[ "${known}" -eq 1 ] || die "unknown check '$1' (try --help)"
|
||||
CHECKS[${#CHECKS[@]}]="$1"
|
||||
shift
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
[ "${#CHECKS[@]}" -gt 0 ] || CHECKS=("${ALL_CHECKS[@]}")
|
||||
|
||||
[ -d "${PROFILES_DIR}" ] || die "profile directory not found: ${PROFILES_DIR}"
|
||||
PROFILES_DIR="$(cd -- "${PROFILES_DIR}" && pwd)"
|
||||
|
||||
LOG_DIR="${WORK_DIR}/logs"
|
||||
mkdir -p "${LOG_DIR}" || die "cannot create ${LOG_DIR}"
|
||||
WORK_DIR="$(cd -- "${WORK_DIR}" && pwd)"
|
||||
LOG_DIR="${WORK_DIR}/logs"
|
||||
|
||||
wants() {
|
||||
local check
|
||||
for check in "${CHECKS[@]}"; do
|
||||
[ "${check}" = "$1" ] && return 0
|
||||
done
|
||||
return 1
|
||||
}
|
||||
|
||||
# ------------------------------------------------------------------- clean profile tree
|
||||
|
||||
# The validator points its data dir at the profile tree, so it creates - and, with -g, fills -
|
||||
# <profiles>/user. A CI checkout never has that directory, and anything left in it from an
|
||||
# earlier local run would be loaded as user presets and validated too. Move it aside for the
|
||||
# duration of the run so what gets checked is what CI checks.
|
||||
STASHED_USER_DIR=""
|
||||
|
||||
stash_user_presets() {
|
||||
[ -d "${PROFILES_DIR}/user" ] || return 0
|
||||
STASHED_USER_DIR="${WORK_DIR}/user-presets-$$"
|
||||
rm -rf "${STASHED_USER_DIR}"
|
||||
mv "${PROFILES_DIR}/user" "${STASHED_USER_DIR}" || { STASHED_USER_DIR=""; die "cannot move ${PROFILES_DIR}/user aside"; }
|
||||
msg "moved ${PROFILES_DIR}/user aside for the run (restored on exit)"
|
||||
}
|
||||
|
||||
restore_user_presets() {
|
||||
# The validator leaves an empty user/default/{filament,machine,process} skeleton behind.
|
||||
# Prune it with rmdir, never rm -rf: a directory that holds a real file survives and is
|
||||
# reported instead of being deleted. Runs even when nothing was stashed, so a tree that had
|
||||
# no user/ before the run does not gain one.
|
||||
find "${PROFILES_DIR}/user" -depth -type d -exec rmdir {} + 2>/dev/null
|
||||
[ -n "${STASHED_USER_DIR}" ] || return 0
|
||||
if [ -d "${PROFILES_DIR}/user" ]; then
|
||||
msg "${PROFILES_DIR}/user is not empty; your presets stay in ${STASHED_USER_DIR}"
|
||||
STASHED_USER_DIR=""
|
||||
return 0
|
||||
fi
|
||||
mv "${STASHED_USER_DIR}" "${PROFILES_DIR}/user"
|
||||
STASHED_USER_DIR=""
|
||||
}
|
||||
|
||||
# The fixture trees under the work dir are shared scratch space keyed by fixture version, so a
|
||||
# second run would delete a tree the first one is validating.
|
||||
LOCK_DIR="${WORK_DIR}/.lock"
|
||||
mkdir "${LOCK_DIR}" 2>/dev/null ||
|
||||
die "another run is using ${WORK_DIR} (pass --work-dir, or remove ${LOCK_DIR} if no run is active)"
|
||||
|
||||
cleanup() {
|
||||
restore_user_presets
|
||||
rmdir "${LOCK_DIR}" 2>/dev/null
|
||||
}
|
||||
|
||||
# Installed only once the lock is ours, so a refused start never releases someone else's.
|
||||
trap cleanup EXIT
|
||||
trap 'cleanup; exit 130' INT TERM
|
||||
|
||||
stash_user_presets
|
||||
|
||||
# ---------------------------------------------------------------------------- downloads
|
||||
|
||||
# fetch URL DEST [force] - cached; --refresh, or a non-empty third argument, forces a new
|
||||
# download. Release assets never change, so caching them is safe; the fixture manifest is the
|
||||
# index that grows with every release, and CI re-reads it on every run.
|
||||
fetch() {
|
||||
local url="$1" dest="$2" force="${3:-}"
|
||||
if [ "${REFRESH}" -eq 0 ] && [ -z "${force}" ] && [ -s "${dest}" ]; then
|
||||
return 0
|
||||
fi
|
||||
mkdir -p "$(dirname -- "${dest}")" || return 1
|
||||
msg "downloading $(basename -- "${dest}") ..."
|
||||
if ! curl -fsSL --retry 3 -o "${dest}.part" "${url}"; then
|
||||
rm -f "${dest}.part"
|
||||
msg "download failed: ${url}"
|
||||
return 1
|
||||
fi
|
||||
mv -f "${dest}.part" "${dest}"
|
||||
}
|
||||
|
||||
sha256_of() {
|
||||
if command -v sha256sum >/dev/null 2>&1; then
|
||||
sha256sum "$1" | cut -d' ' -f1
|
||||
elif command -v shasum >/dev/null 2>&1; then
|
||||
shasum -a 256 "$1" | cut -d' ' -f1
|
||||
else
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
# Directories a built validator can sit in, best first: every Ninja Multi-Config Release tree,
|
||||
# then RelWithDebInfo, then Debug, then a single-config generator's plain src/. Each pattern is
|
||||
# matched both directly under a build root (build/) and one level down (build/arm64, build/x64),
|
||||
# and unmatched globs are dropped by the caller's -d test.
|
||||
validator_search_dirs() {
|
||||
local config
|
||||
for config in Release RelWithDebInfo Debug; do
|
||||
printf '%s\n' "${REPO_ROOT}"/build*/src/"${config}" "${REPO_ROOT}"/build*/*/src/"${config}"
|
||||
done
|
||||
printf '%s\n' "${REPO_ROOT}"/build*/src "${REPO_ROOT}"/build*/*/src
|
||||
}
|
||||
|
||||
# A build tree named for the other architecture (build/x86_64 on an arm64 host, build/arm64 on
|
||||
# an x64 one) is a last resort: on Linux it will not run at all, on macOS it goes via Rosetta.
|
||||
# Takes a repo-relative path - an absolute one would also match an arch name in the checkout path.
|
||||
is_foreign_arch_dir() {
|
||||
case "${HOST_ARCH}" in
|
||||
arm64|aarch64) case "$1" in *x86_64*|*x86-64*|*x64*|*amd64*) return 0 ;; esac ;;
|
||||
x86_64|amd64) case "$1" in *arm64*|*aarch64*) return 0 ;; esac ;;
|
||||
esac
|
||||
return 1
|
||||
}
|
||||
|
||||
# First locally built OrcaSlicer_profile_validator, in the order above. macOS puts it in an .app
|
||||
# bundle, Linux and Windows next to the other binaries.
|
||||
find_local_validator() {
|
||||
local dir candidate foreign=""
|
||||
while IFS= read -r dir; do
|
||||
[ -d "${dir}" ] || continue
|
||||
for candidate in \
|
||||
"${dir}/OrcaSlicer_profile_validator" \
|
||||
"${dir}/OrcaSlicer_profile_validator.exe" \
|
||||
"${dir}/OrcaSlicer_profile_validator.app/Contents/MacOS/OrcaSlicer_profile_validator"; do
|
||||
[ -f "${candidate}" ] && [ -x "${candidate}" ] || continue
|
||||
if ! is_foreign_arch_dir "${dir#"${REPO_ROOT}"/}"; then
|
||||
printf '%s\n' "${candidate}"
|
||||
return 0
|
||||
fi
|
||||
[ -n "${foreign}" ] || foreign="${candidate}"
|
||||
done
|
||||
done <<EOF
|
||||
$(validator_search_dirs)
|
||||
EOF
|
||||
[ -n "${foreign}" ] || return 1
|
||||
msg "no ${HOST_ARCH} build found, falling back to ${foreign}"
|
||||
printf '%s\n' "${foreign}"
|
||||
}
|
||||
|
||||
# The nightly release build, same one CI uses. Linux ships the bare binary, macOS a .dmg
|
||||
# holding the signed .app, Windows an .exe.
|
||||
download_validator() {
|
||||
local dest="${WORK_DIR}/validator" binary dmg app mounted app_src
|
||||
case "$(uname -s)" in
|
||||
Linux*)
|
||||
case "${HOST_ARCH}" in
|
||||
arm64|aarch64) msg "the nightly Linux validator is x86_64; build it locally for ${HOST_ARCH}" ;;
|
||||
esac
|
||||
binary="${dest}/OrcaSlicer_profile_validator"
|
||||
fetch "${VALIDATOR_RELEASE_URL}/OrcaSlicer_profile_validator_Linux_Ubuntu2404_nightly" "${binary}" || return 1
|
||||
chmod +x "${binary}" || return 1
|
||||
;;
|
||||
Darwin*)
|
||||
dmg="${dest}/OrcaSlicer_profile_validator.dmg"
|
||||
app="${dest}/OrcaSlicer_profile_validator.app"
|
||||
binary="${app}/Contents/MacOS/OrcaSlicer_profile_validator"
|
||||
fetch "${VALIDATOR_RELEASE_URL}/OrcaSlicer_profile_validator_Mac_universal_nightly.dmg" "${dmg}" || return 1
|
||||
if [ ! -x "${binary}" ] || [ "${REFRESH}" -eq 1 ]; then
|
||||
mounted="${dest}/mnt"
|
||||
rm -rf "${mounted}" "${app}"
|
||||
mkdir -p "${mounted}" || return 1
|
||||
hdiutil attach -nobrowse -readonly -mountpoint "${mounted}" "${dmg}" >/dev/null || return 1
|
||||
app_src="$(find "${mounted}" -maxdepth 1 -name '*.app' -print 2>/dev/null | head -n 1)"
|
||||
if [ -n "${app_src}" ]; then
|
||||
cp -R "${app_src}" "${app}"
|
||||
fi
|
||||
hdiutil detach "${mounted}" >/dev/null 2>&1
|
||||
rmdir "${mounted}" 2>/dev/null
|
||||
[ -x "${binary}" ] || { msg "no validator app inside ${dmg}"; return 1; }
|
||||
fi
|
||||
;;
|
||||
MINGW*|MSYS*|CYGWIN*)
|
||||
binary="${dest}/OrcaSlicer_profile_validator.exe"
|
||||
fetch "${VALIDATOR_RELEASE_URL}/OrcaSlicer_profile_validator_Windows_nightly.exe" "${binary}" || return 1
|
||||
chmod +x "${binary}" || return 1
|
||||
;;
|
||||
*)
|
||||
msg "no nightly validator published for $(uname -s); build it (-DORCA_TOOLS=ON) and pass --validator"
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
printf '%s\n' "${binary}"
|
||||
}
|
||||
|
||||
resolve_validator() {
|
||||
if [ -n "${VALIDATOR}" ]; then
|
||||
[ -x "${VALIDATOR}" ] || die "validator not executable: ${VALIDATOR}"
|
||||
return 0
|
||||
fi
|
||||
if [ "${PREFER_DOWNLOAD}" -eq 0 ]; then
|
||||
VALIDATOR="$(find_local_validator)"
|
||||
if [ -n "${VALIDATOR}" ]; then
|
||||
msg "using locally built validator: ${VALIDATOR}"
|
||||
return 0
|
||||
fi
|
||||
fi
|
||||
VALIDATOR="$(download_validator)" || die "could not obtain a profile validator"
|
||||
msg "using downloaded validator: ${VALIDATOR}"
|
||||
}
|
||||
|
||||
# ---------------------------------------------------------------------------- checks
|
||||
|
||||
check_extra_json_check() {
|
||||
python3 "${REPO_ROOT}/scripts/orca_extra_profile_check.py"
|
||||
}
|
||||
|
||||
check_validate_system() {
|
||||
"${VALIDATOR}" -p "${PROFILES_DIR}" -l "${LOG_LEVEL}"
|
||||
}
|
||||
|
||||
# Slices a two-colour cube through every printer so all custom g-code (incl. change_filament_gcode)
|
||||
# is expanded - catches undefined-placeholder / invalid-flow bugs the static checks cannot see.
|
||||
check_validate_slice() {
|
||||
"${VALIDATOR}" -p "${PROFILES_DIR}" -s -l "${LOG_LEVEL}"
|
||||
}
|
||||
|
||||
check_validate_filament_subtypes() {
|
||||
"${VALIDATOR}" -p "${PROFILES_DIR}" -l "${LOG_LEVEL}" -f
|
||||
}
|
||||
|
||||
# Every released fixture is a snapshot of user presets saved by that OrcaSlicer version; each is
|
||||
# unpacked over the current system profiles and validated, so a profile change that would break
|
||||
# an existing user's presets fails here.
|
||||
check_validate_custom() {
|
||||
local fixtures_dir="${WORK_DIR}/profile-fixtures"
|
||||
local output_dir="${WORK_DIR}/custom-preset-validation"
|
||||
local summary="${output_dir}/summary.md"
|
||||
local status=0 failed_logs=""
|
||||
local version asset expected_sha256 asset_url fixture_zip profile_tree log_path actual_sha256 result
|
||||
|
||||
command -v unzip >/dev/null 2>&1 || { msg "unzip is required for validate_custom"; return 1; }
|
||||
mkdir -p "${fixtures_dir}" "${output_dir}" || return 1
|
||||
|
||||
fetch "${FIXTURE_RELEASE_URL}/manifest.json" "${fixtures_dir}/manifest.json" force || return 1
|
||||
|
||||
MANIFEST_PATH="${fixtures_dir}/manifest.json" python3 - > "${fixtures_dir}/fixtures.tsv" <<'PY'
|
||||
import json
|
||||
import os
|
||||
|
||||
with open(os.environ["MANIFEST_PATH"], encoding="utf-8") as fh:
|
||||
manifest = json.load(fh)
|
||||
|
||||
if isinstance(manifest, dict):
|
||||
entries = manifest.get("fixtures", [])
|
||||
else:
|
||||
entries = manifest
|
||||
|
||||
for entry in entries:
|
||||
version = entry.get("version", "")
|
||||
asset = entry.get("asset", "")
|
||||
sha256 = entry.get("asset_sha256", "")
|
||||
if not version or not asset:
|
||||
continue
|
||||
print(f"{version}\t{asset}\t{sha256}")
|
||||
PY
|
||||
|
||||
if [ ! -s "${fixtures_dir}/fixtures.tsv" ]; then
|
||||
echo "No custom preset fixtures found in ${FIXTURE_RELEASE_URL}/manifest.json"
|
||||
return 1
|
||||
fi
|
||||
|
||||
{
|
||||
echo "## Custom Preset Fixture Validation"
|
||||
echo ""
|
||||
echo "| Version | Status | Log |"
|
||||
echo "| --- | --- | --- |"
|
||||
} > "${summary}"
|
||||
|
||||
while IFS=$'\t' read -r version asset expected_sha256; do
|
||||
[ -n "${version}" ] || continue
|
||||
fixture_zip="${fixtures_dir}/${asset}"
|
||||
profile_tree="${output_dir}/profiles-${version}"
|
||||
log_path="${output_dir}/${version}.log"
|
||||
|
||||
asset_url="${FIXTURE_RELEASE_URL}/$(python3 -c 'import sys, urllib.parse; print(urllib.parse.quote(sys.argv[1], safe=""))' "${asset}")"
|
||||
fetch "${asset_url}" "${fixture_zip}" || return 1
|
||||
|
||||
if [ -n "${expected_sha256}" ] && [ "${expected_sha256}" != "<sha256>" ]; then
|
||||
actual_sha256="$(sha256_of "${fixture_zip}")"
|
||||
if [ -z "${actual_sha256}" ]; then
|
||||
msg "no sha256 tool available, skipping checksum of ${asset}"
|
||||
elif [ "${actual_sha256}" != "${expected_sha256}" ]; then
|
||||
# A cached zip can be stale or truncated; the release asset itself is immutable,
|
||||
# so deleting it forces fetch to pull a fresh copy.
|
||||
msg "checksum mismatch for ${asset}, re-downloading"
|
||||
rm -f "${fixture_zip}"
|
||||
fetch "${asset_url}" "${fixture_zip}" || return 1
|
||||
actual_sha256="$(sha256_of "${fixture_zip}")"
|
||||
[ "${actual_sha256}" = "${expected_sha256}" ] || { msg "${asset}: expected ${expected_sha256}, got ${actual_sha256}"; return 1; }
|
||||
fi
|
||||
fi
|
||||
|
||||
msg "validating custom presets from ${version} ..."
|
||||
rm -rf "${profile_tree}"
|
||||
mkdir -p "${profile_tree}" || return 1
|
||||
cp -a "${PROFILES_DIR}/." "${profile_tree}/" || return 1
|
||||
rm -rf "${profile_tree}/user"
|
||||
unzip -q "${fixture_zip}" -d "${profile_tree}" || return 1
|
||||
|
||||
"${VALIDATOR}" -p "${profile_tree}" -l "${LOG_LEVEL}" > "${log_path}" 2>&1
|
||||
result=$?
|
||||
|
||||
if [ "${result}" -eq 0 ]; then
|
||||
echo "| ${version} | PASS | ${version}.log |" >> "${summary}"
|
||||
# Only failures are worth keeping; each tree is a full copy of resources/profiles.
|
||||
rm -rf "${profile_tree}"
|
||||
else
|
||||
echo "| ${version} | FAIL | ${version}.log |" >> "${summary}"
|
||||
failed_logs="${failed_logs}${log_path}"$'\n'
|
||||
status=1
|
||||
fi
|
||||
done < "${fixtures_dir}/fixtures.tsv"
|
||||
|
||||
cat "${summary}"
|
||||
if [ -n "${failed_logs}" ]; then
|
||||
echo ""
|
||||
echo "## Failed Fixture Logs"
|
||||
while IFS= read -r log_path; do
|
||||
[ -n "${log_path}" ] || continue
|
||||
echo ""
|
||||
echo "### $(basename "${log_path}" .log)"
|
||||
echo '```'
|
||||
head -c 12000 "${log_path}" || echo "No output captured"
|
||||
echo '```'
|
||||
done <<EOF
|
||||
${failed_logs}
|
||||
EOF
|
||||
fi
|
||||
|
||||
return "${status}"
|
||||
}
|
||||
|
||||
# Heading CI puts above this check's log in the PR comment.
|
||||
comment_heading() {
|
||||
case "$1" in
|
||||
extra_json_check) echo "### Extra JSON Check Failed" ;;
|
||||
validate_system) echo "### System Profile Validation Failed" ;;
|
||||
validate_slice) echo "### Slice Validation Failed (custom g-code expansion)" ;;
|
||||
validate_filament_subtypes) echo "### Filament Subtype Validation Failed" ;;
|
||||
validate_custom) echo "### Custom Preset Validation Failed" ;;
|
||||
esac
|
||||
}
|
||||
|
||||
# ---------------------------------------------------------------------------- run
|
||||
|
||||
run_check() {
|
||||
local name="$1"
|
||||
local log="${LOG_DIR}/${name}.log"
|
||||
local result
|
||||
printf '\n%s==> %s%s\n' "${C_BOLD}" "${name}" "${C_RESET}"
|
||||
"check_${name}" 2>&1 | tee "${log}"
|
||||
result="${PIPESTATUS[0]}"
|
||||
if [ "${result}" -eq 0 ]; then
|
||||
printf '%s %s passed%s\n' "${C_GREEN}" "${name}" "${C_RESET}"
|
||||
RESULTS="${RESULTS}${name}"$'\t'"pass"$'\n'
|
||||
else
|
||||
printf '%s %s failed (exit %s)%s\n' "${C_RED}" "${name}" "${result}" "${C_RESET}"
|
||||
RESULTS="${RESULTS}${name}"$'\t'"fail"$'\n'
|
||||
fi
|
||||
}
|
||||
|
||||
if wants validate_system || wants validate_slice || wants validate_filament_subtypes || wants validate_custom; then
|
||||
resolve_validator
|
||||
fi
|
||||
|
||||
for check in "${ALL_CHECKS[@]}"; do
|
||||
wants "${check}" && run_check "${check}"
|
||||
done
|
||||
|
||||
# Summary, plus the comment check_profiles_comment.yml would post when something fails.
|
||||
failed=0
|
||||
printf '\n%s==> summary%s\n' "${C_BOLD}" "${C_RESET}"
|
||||
while IFS=$'\t' read -r name result; do
|
||||
[ -n "${name}" ] || continue
|
||||
if [ "${result}" = "pass" ]; then
|
||||
printf '%s PASS%s %s\n' "${C_GREEN}" "${C_RESET}" "${name}"
|
||||
else
|
||||
printf '%s FAIL%s %s (%s)\n' "${C_RED}" "${C_RESET}" "${name}" "${LOG_DIR}/${name}.log"
|
||||
failed=1
|
||||
fi
|
||||
done <<EOF
|
||||
${RESULTS}
|
||||
EOF
|
||||
|
||||
if [ "${failed}" -eq 0 ]; then
|
||||
rm -f "${WORK_DIR}/pr_comment.md"
|
||||
printf '\n%sAll checks passed.%s Logs: %s\n' "${C_GREEN}" "${C_RESET}" "${LOG_DIR}"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
{
|
||||
# Marker matched by check_profiles_comment.yml to delete prior comments.
|
||||
echo "<!-- profile-validation-comment -->"
|
||||
echo "## :x: Profile Validation Errors"
|
||||
echo ""
|
||||
while IFS=$'\t' read -r name result; do
|
||||
[ "${result}" = "fail" ] || continue
|
||||
comment_heading "${name}"
|
||||
echo ""
|
||||
echo '```'
|
||||
head -c 30000 "${LOG_DIR}/${name}.log" || echo "No output captured"
|
||||
echo '```'
|
||||
echo ""
|
||||
done <<INNER
|
||||
${RESULTS}
|
||||
INNER
|
||||
echo "---"
|
||||
echo "*Please fix the above errors and push a new commit.*"
|
||||
} > "${WORK_DIR}/pr_comment.md"
|
||||
|
||||
printf '\n%sOne or more profile checks failed.%s Logs: %s\n' "${C_RED}" "${C_RESET}" "${LOG_DIR}"
|
||||
printf 'The comment CI would post: %s\n' "${WORK_DIR}/pr_comment.md"
|
||||
exit 1
|
||||
847
scripts/test_build_win.ps1
Normal file
847
scripts/test_build_win.ps1
Normal file
@@ -0,0 +1,847 @@
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Tests build_win.bat's option handling and the commands it generates.
|
||||
|
||||
.DESCRIPTION
|
||||
Cases run the script with --dry-run, so nothing is configured, built or
|
||||
deleted and the suite finishes in seconds. Each case asserts on the exit
|
||||
code and on the command lines the script echoes.
|
||||
|
||||
Adding a case means adding one row to $cases. A bare string starts a new
|
||||
group. Defaults: ExpectExit is 0 and --dry-run is appended, so a row only
|
||||
states what is unusual about it.
|
||||
|
||||
Name what the case proves, in words
|
||||
Args arguments, as an array
|
||||
ExpectExit expected exit code (default 0)
|
||||
DryRun append --dry-run (default $true)
|
||||
First regex the first output line must match
|
||||
Env environment for this case only
|
||||
Contains literal strings the output must have
|
||||
NotContains literal strings it must not have
|
||||
Match regexes; each must match at least one output line
|
||||
NotMatch regexes; none may match any output line
|
||||
NotExists paths that must not exist after the case runs
|
||||
|
||||
.PARAMETER Name
|
||||
Run only the cases whose name matches this regex. Headings with no
|
||||
matching case are not printed, and a pattern that matches nothing is a
|
||||
failure rather than an empty pass.
|
||||
|
||||
.EXAMPLE
|
||||
powershell -File scripts/test_build_win.ps1
|
||||
|
||||
.EXAMPLE
|
||||
powershell -File scripts/test_build_win.ps1 -Name solution
|
||||
#>
|
||||
[CmdletBinding()]
|
||||
param(
|
||||
[string] $Script,
|
||||
[string] $Name
|
||||
)
|
||||
|
||||
$ErrorActionPreference = 'Stop'
|
||||
|
||||
if (-not $Script) {
|
||||
$here = $PSScriptRoot
|
||||
if (-not $here) { $here = Split-Path -Parent $MyInvocation.MyCommand.Path }
|
||||
$Script = Join-Path (Split-Path -Parent $here) 'build_win.bat'
|
||||
}
|
||||
if (-not (Test-Path $Script)) { throw "build_win.bat not found at $Script" }
|
||||
|
||||
# cmd resumes a batch file by byte offset after `call :label`, and with LF
|
||||
# endings that offset lands wrong and the label lookup fails. .gitattributes
|
||||
# pins CRLF; this catches a checkout or an editor that did not honour it.
|
||||
if ((Get-Content -Raw $Script) -match "(?<!`r)`n") {
|
||||
throw "$Script has LF line endings; cmd needs CRLF to resume after call :label"
|
||||
}
|
||||
$Script = (Resolve-Path $Script).Path
|
||||
|
||||
# Read the long options out of the script itself, so this cannot go stale when
|
||||
# an option is added. Field order is: add_arg <var> <type> <short> <long>.
|
||||
$longFlags = @(
|
||||
Select-String -Path $Script -Pattern '^call :add_arg \S+ \S+ \S+ (\S+) ' |
|
||||
ForEach-Object { '--' + $_.Matches[0].Groups[1].Value }
|
||||
)
|
||||
if ($longFlags.Count -lt 20) { throw "only found $($longFlags.Count) options in $Script; the parser above is wrong" }
|
||||
|
||||
# A winget that always fails, so the prerequisite failure path runs without
|
||||
# touching the machine. It has to be an .exe: a .bat invoked without `call`
|
||||
# transfers control and never comes back, which would end the script instead.
|
||||
# where.exe returns 1 when its patterns match nothing and never prompts.
|
||||
$fixtures = Join-Path ([IO.Path]::GetTempPath()) 'build_win_test_fixtures'
|
||||
New-Item -ItemType Directory -Force -Path $fixtures | Out-Null
|
||||
Copy-Item "$env:SystemRoot\System32\where.exe" (Join-Path $fixtures 'winget.exe') -Force
|
||||
$stubPath = "$fixtures;C:\Windows\system32;C:\Windows"
|
||||
|
||||
# Stand-in ninjas that only report a version, so the 1.12 boundary in the
|
||||
# progress format can be exercised on a machine whose real ninja is newer.
|
||||
# A dry run skips the dev shell, so PATH here is what the script sees.
|
||||
$ninjaPaths = @{}
|
||||
foreach ($v in @{ old = '1.11.1'; new = '1.12.0' }.GetEnumerator()) {
|
||||
$d = Join-Path $fixtures "ninja-$($v.Key)"
|
||||
New-Item -ItemType Directory -Force -Path $d | Out-Null
|
||||
Set-Content -Path (Join-Path $d 'ninja.bat') -Encoding ascii -Value @('@echo off', "echo $($v.Value)")
|
||||
$ninjaPaths[$v.Key] = "$d;$env:PATH"
|
||||
}
|
||||
|
||||
# The pack stamp is checked against real dates, so a locale-dependent parse
|
||||
# in the script cannot pass by looking date-shaped. Yesterday is accepted too,
|
||||
# so a run that crosses midnight does not flake.
|
||||
$dateStamps = @((Get-Date -Format 'yyyyMMdd'), (Get-Date).AddDays(-1).ToString('yyyyMMdd'))
|
||||
$stampPattern = '_(' + ($dateStamps -join '|') + ')\.zip$'
|
||||
|
||||
$cases = @(
|
||||
'argument handling'
|
||||
@{ Name = 'no arguments prints help'; Args = @(); DryRun = $false
|
||||
Contains = @('Usage: build_win.bat [options]', '--clang-cl') }
|
||||
@{ Name = "--help lists all $($longFlags.Count) options the script defines"; Args = @('--help'); DryRun = $false
|
||||
Contains = $longFlags }
|
||||
@{ Name = 'help is grouped and shows usage, examples and environment'; Args = @('--help'); DryRun = $false
|
||||
Contains = @('Usage: build_win.bat [options]', 'Actions:', 'Build configuration:', 'Toolchain:',
|
||||
'How much gets rebuilt:', 'Paths and extra arguments:', 'Diagnostics:',
|
||||
'Examples:', 'Environment:') }
|
||||
@{ Name = 'the environment section shows what to set'; Args = @('--help'); DryRun = $false
|
||||
Contains = @('ORCA_DEPS_CMAKE_ARGS', 'ORCA_SLICER_CMAKE_ARGS', 'ORCA_UPDATER_SIG_KEY', 'NINJA_STATUS',
|
||||
'set ORCA_SLICER_CMAKE_ARGS=-DSLIC3R_PCH=OFF', '(PowerShell)', 'debugscript') }
|
||||
@{ Name = 'section headers do not widen the flag column'; Args = @('--help'); DryRun = $false
|
||||
Match = @('^ -d, --deps +Download') }
|
||||
# Windows Terminal opens at 120 columns and wraps at 120, so 119 is the
|
||||
# limit. Anyone still on the old conhost gets 80 and will see wrapping.
|
||||
@{ Name = 'every help line fits a 120 column console'; Args = @('--help'); DryRun = $false
|
||||
NotMatch = @('^.{120,}$') }
|
||||
@{ Name = 'an unknown long option is rejected'; Args = @('--nonsense'); ExpectExit = 1
|
||||
Contains = @('Failed to find arg') }
|
||||
@{ Name = 'an unknown short option is rejected'; Args = @('-Z'); ExpectExit = 1
|
||||
Contains = @('Failed to find arg') }
|
||||
@{ Name = 'a bare argument is rejected'; Args = @('deps'); ExpectExit = 1
|
||||
Contains = @('Unknown argument') }
|
||||
@{ Name = 'an unknown architecture is rejected'; Args = @('-d', '--arch', 'sparc'); ExpectExit = 1
|
||||
Contains = @('Unknown architecture') }
|
||||
@{ Name = 'a string option without a value is rejected'; Args = @('-d', '--arch'); ExpectExit = 1
|
||||
Contains = @('requires a value') }
|
||||
@{ Name = 'short options can be bundled'; Args = @('-dx')
|
||||
Contains = @('-G "Ninja Multi-Config"', '--target deps') }
|
||||
|
||||
'generator and compiler selection'
|
||||
@{ Name = 'deps default to the Visual Studio generator'; Args = @('-d')
|
||||
Contains = @('-G "Visual Studio', '-A x64', '--target deps')
|
||||
NotContains = @('Ninja', 'clang-cl') }
|
||||
@{ Name = '-x selects Ninja without changing compiler'; Args = @('-d', '-x')
|
||||
Contains = @('-G "Ninja Multi-Config"')
|
||||
NotContains = @('clang-cl', '-A x64') }
|
||||
@{ Name = '-l -x builds with clang-cl under Ninja'; Args = @('-d', '-l', '-x')
|
||||
Contains = @('-G "Ninja Multi-Config"', '-DCMAKE_C_COMPILER=clang-cl.exe', '-DCMAKE_CXX_COMPILER=clang-cl.exe') }
|
||||
@{ Name = '-l alone uses the ClangCL toolset on the VS generator'; Args = @('-d', '-l')
|
||||
Contains = @('-G "Visual Studio', '-T ClangCL')
|
||||
NotContains = @('-DCMAKE_C_COMPILER') }
|
||||
# --msvc and --msbuild name the defaults, so a caller can be explicit and a
|
||||
# contradictory pair can be caught rather than silently resolved.
|
||||
@{ Name = '--msvc is the compiler default spelled out'; Args = @('-d', '--msvc')
|
||||
Contains = @('-G "Visual Studio', '-A x64')
|
||||
NotContains = @('clang-cl') }
|
||||
@{ Name = '--msbuild is the generator default spelled out'; Args = @('-d', '--msbuild')
|
||||
Contains = @('-G "Visual Studio')
|
||||
NotContains = @('Ninja') }
|
||||
@{ Name = '--msvc with -x gives Ninja driving cl'; Args = @('-d', '--msvc', '-x')
|
||||
Contains = @('-G "Ninja Multi-Config"')
|
||||
NotContains = @('clang-cl') }
|
||||
@{ Name = '--msbuild with -l gives the VS generator and the ClangCL toolset'; Args = @('-d', '--msbuild', '-l')
|
||||
Contains = @('-G "Visual Studio', '-T ClangCL') }
|
||||
# A developer with a standalone LLVM points at it; the VS-bundled clang
|
||||
# is what a bare clang-cl.exe resolves to after the dev shell runs.
|
||||
@{ Name = '--clang-path names the compiler, quoted for its spaces'; Args = @('-d', '-x', '--clang-path', 'C:\Program Files\LLVM\bin\clang-cl.exe')
|
||||
Contains = @('-DCMAKE_C_COMPILER="C:\Program Files\LLVM\bin\clang-cl.exe"',
|
||||
'-DCMAKE_CXX_COMPILER="C:\Program Files\LLVM\bin\clang-cl.exe"') }
|
||||
@{ Name = '--clang-path is a clang request on its own'; Args = @('-d', '-x', '--clang-path', 'C:\Program Files\LLVM\bin\clang-cl.exe')
|
||||
Contains = @('deps/build-clang') }
|
||||
@{ Name = '--clang-path needs Ninja to take effect'; Args = @('-d', '--clang-path', 'C:\Program Files\LLVM\bin\clang-cl.exe'); ExpectExit = 1
|
||||
Contains = @('needs the Ninja generator') }
|
||||
# `exist` is true for a directory too, and a directory would reach CMake
|
||||
# as the compiler.
|
||||
@{ Name = '--clang-path must name the exe, not its folder'; Args = @('-d', '-x', '--clang-path', 'C:\Program Files\LLVM'); ExpectExit = 1
|
||||
Contains = @('is a directory') }
|
||||
@{ Name = 'a clang-cl that is not there is caught early'; Args = @('-d', '-x', '--clang-path', 'C:\nope\clang-cl.exe'); ExpectExit = 1
|
||||
Contains = @('No clang-cl at')
|
||||
NotContains = @('cmake -S deps') }
|
||||
@{ Name = '--clang-path contradicting --msvc is rejected'; Args = @('-d', '-x', '--msvc', '--clang-path', 'C:\Program Files\LLVM\bin\clang-cl.exe'); ExpectExit = 1
|
||||
Contains = @('select different compilers') }
|
||||
@{ Name = '--clang-cl and --msvc together are rejected'; Args = @('-d', '-l', '--msvc'); ExpectExit = 1
|
||||
Contains = @('select different compilers') }
|
||||
@{ Name = '--ninja and --msbuild together are rejected'; Args = @('-d', '-x', '--msbuild'); ExpectExit = 1
|
||||
Contains = @('select different generators') }
|
||||
# One option with a value, driven by a table, rather than a flag per
|
||||
# release. Adding a release should not need a new flag.
|
||||
@{ Name = '--vs 2019 pins that release and skips autodetect'; Args = @('-d', '--vs', '2019')
|
||||
Contains = @('-G "Visual Studio 16 2019"')
|
||||
NotContains = @('Detecting Visual Studio') }
|
||||
@{ Name = '--vs 2022 pins that release'; Args = @('-d', '--vs', '2022')
|
||||
Contains = @('-G "Visual Studio 17 2022"') }
|
||||
@{ Name = '--vs 2026 pins that release'; Args = @('-d', '--vs', '2026')
|
||||
Contains = @('-G "Visual Studio 18 2026"') }
|
||||
@{ Name = 'an unknown release is rejected and the known ones listed'; Args = @('-d', '--vs', '2015'); ExpectExit = 1
|
||||
Contains = @('Unknown Visual Studio release', '2019, 2022, 2026') }
|
||||
@{ Name = '--vs and --ninja together are rejected'; Args = @('-d', '--vs', '2022', '-x'); ExpectExit = 1
|
||||
Contains = @('select different generators') }
|
||||
@{ Name = 'without --vs the release is autodetected'; Args = @('-d')
|
||||
Contains = @('Detecting Visual Studio') }
|
||||
|
||||
'architecture'
|
||||
@{ Name = 'x64 is the default'; Args = @('-d')
|
||||
Contains = @('Configuration: Release, x64')
|
||||
NotContains = @('build-arm64') }
|
||||
@{ Name = 'arm64 sets the generator platform and deps tree'; Args = @('-d', '--arch', 'arm64')
|
||||
Contains = @('-A ARM64', 'deps/build-arm64') }
|
||||
@{ Name = 'the architecture is matched case-insensitively'; Args = @('-d', '--arch', 'ARM64')
|
||||
Contains = @('-A ARM64', 'deps/build-arm64') }
|
||||
@{ Name = 'arm64 under Ninja has no -A but keeps the arm64 tree'; Args = @('-d', '--arch', 'arm64', '-x', '-l')
|
||||
Contains = @('deps/build-clang-arm64', '-DCMAKE_C_COMPILER=clang-cl.exe')
|
||||
NotContains = @('-A ') }
|
||||
|
||||
'build configurations'
|
||||
# One option with a value, driven by a table, so Release is named rather
|
||||
# than being whatever is left when no flag is passed.
|
||||
@{ Name = 'release is the default'; Args = @('-s')
|
||||
Contains = @('-DCMAKE_BUILD_TYPE=Release', 'cmake -B "build" ') }
|
||||
@{ Name = '--config release is the default spelled out'; Args = @('-s', '--config', 'release')
|
||||
Contains = @('-DCMAKE_BUILD_TYPE=Release', 'cmake -B "build" ') }
|
||||
@{ Name = '--config debug builds into build-dbg'; Args = @('-s', '--config', 'debug')
|
||||
Contains = @('-DCMAKE_BUILD_TYPE=Debug', 'cmake -B "build-dbg" ') }
|
||||
@{ Name = '--config relwithdebinfo builds into build-dbginfo'; Args = @('-s', '--config', 'relwithdebinfo')
|
||||
Contains = @('-DCMAKE_BUILD_TYPE=RelWithDebInfo', 'cmake -B "build-dbginfo" ') }
|
||||
@{ Name = '--config minsizerel builds into build-minsize'; Args = @('-s', '--config', 'minsizerel')
|
||||
Contains = @('-DCMAKE_BUILD_TYPE=MinSizeRel', 'cmake -B "build-minsize" ') }
|
||||
# Batch variable names are case-insensitive, so the table lookup is too.
|
||||
@{ Name = 'the configuration name is matched case-insensitively'; Args = @('-s', '--config', 'RelWithDebInfo')
|
||||
Contains = @('-DCMAKE_BUILD_TYPE=RelWithDebInfo') }
|
||||
@{ Name = 'an unknown configuration is rejected and the known ones listed'; Args = @('-s', '--config', 'bogus'); ExpectExit = 1
|
||||
Contains = @('Unknown configuration', 'release, debug, relwithdebinfo, minsizerel') }
|
||||
# Release, RelWithDebInfo and MinSizeRel all link the /MD dependencies, so
|
||||
# one tree serves all three. Debug is /MDd and cannot share.
|
||||
@{ Name = 'minsizerel builds against the release deps'; Args = @('-d', '-s', '--config', 'minsizerel')
|
||||
Contains = @('cmake -S deps -B "deps/build"', 'cmake -B "build-minsize" ')
|
||||
NotContains = @('deps/build-minsize') }
|
||||
@{ Name = 'relwithdebinfo builds against them too'; Args = @('-d', '-s', '-l', '--config', 'relwithdebinfo')
|
||||
Contains = @('cmake -S deps -B "deps/build-clang"', 'cmake -B "build-dbginfo-clang" ')
|
||||
NotContains = @('deps/build-dbginfo') }
|
||||
@{ Name = 'debug keeps a dependency tree of its own'; Args = @('-d', '--config', 'debug')
|
||||
Contains = @('cmake -S deps -B "deps/build-dbg"') }
|
||||
# The build tree and the deps tree now have different names, so the
|
||||
# derivation from the binary directory name cannot work and it is named.
|
||||
@{ Name = 'a shared deps tree is named outright'; Args = @('-s', '-l', '--config', 'relwithdebinfo')
|
||||
Match = @('-DDEP_BUILD_DIR="[A-Za-z]:\\.*\\deps\\build-clang"') }
|
||||
@{ Name = 'configuration and arch combine into build-dbg-arm64'; Args = @('-s', '--config', 'debug', '--arch', 'arm64')
|
||||
Contains = @('cmake -B "build-dbg-arm64" ') }
|
||||
|
||||
'what gets built'
|
||||
@{ Name = 'the deps target defaults to deps'; Args = @('-d')
|
||||
Contains = @('--target deps') }
|
||||
@{ Name = '-t overrides the deps target'; Args = @('-d', '-t', 'dep_Boost')
|
||||
Contains = @('--target dep_Boost') }
|
||||
@{ Name = 'unit tests are off unless asked for'; Args = @('-s')
|
||||
Contains = @('-DBUILD_TESTS=OFF') }
|
||||
@{ Name = '--tests turns the unit tests on'; Args = @('-s', '--tests')
|
||||
Contains = @('-DBUILD_TESTS=ON') }
|
||||
@{ Name = '-a enables ASAN for the slicer'; Args = @('-s', '-a')
|
||||
Contains = @('-DSLIC3R_ASAN=ON') }
|
||||
@{ Name = 'the slicer build runs gettext'; Args = @('-s')
|
||||
Contains = @('run_gettext.bat') }
|
||||
# tools\7z.exe needs a 7z.dll beside it, which the repo does not carry,
|
||||
# so the pack falls back to the bsdtar Windows ships. Either is correct;
|
||||
# what matters is that one is chosen and handed the right names.
|
||||
@{ Name = '-p packs the deps tree with whichever archiver is usable'; Args = @('-d', '-p')
|
||||
Match = @('^\+ .*(7z\.exe a|tar\.exe -a -c -f) OrcaSlicer_dep_win-\S+\.zip OrcaSlicer_dep$') }
|
||||
# The bundle is only good for what built it, so it carries the same three
|
||||
# axes as the tree. Release x64 on cl keeps the historical plain name.
|
||||
@{ Name = 'the bundle name carries compiler and deps flavour'; Args = @('-p', '-l', '--config', 'debug', '--arch', 'arm64')
|
||||
Contains = @('OrcaSlicer_dep_win-ARM64-clang-dbg_') }
|
||||
@{ Name = 'a relwithdebinfo pack is the release bundle'; Args = @('-p', '--config', 'relwithdebinfo')
|
||||
Contains = @('OrcaSlicer_dep_win-x64_')
|
||||
NotContains = @('-dbg', 'dbginfo') }
|
||||
@{ Name = 'a plain release bundle keeps its old name'; Args = @('-p')
|
||||
Contains = @('OrcaSlicer_dep_win-x64_')
|
||||
NotContains = @('-clang', '-Release') }
|
||||
@{ Name = 'the bundle is stamped with today, not a shuffled date'; Args = @('-p')
|
||||
Match = @($stampPattern) }
|
||||
# powershell.exe is not in System32 itself, so a trimmed PATH used to
|
||||
# leave the stamp empty and the bundle named OrcaSlicer_dep_win-x64_.zip.
|
||||
@{ Name = 'the bundle is stamped even with a bare PATH'; Args = @('-p')
|
||||
Env = @{ PATH = 'C:\Windows\system32;C:\Windows' }
|
||||
Match = @($stampPattern) }
|
||||
@{ Name = '-p packs without rebuilding'; Args = @('-p')
|
||||
Match = @('^\+ .*(7z\.exe a|tar\.exe -a -c -f) ')
|
||||
NotContains = @('cmake -S deps') }
|
||||
@{ Name = 'deps and slicer build in one invocation'; Args = @('-d', '-s', '-x', '-l')
|
||||
Contains = @('cmake -S deps', 'cmake -B "build-clang" ') }
|
||||
|
||||
'the developer loop'
|
||||
@{ Name = '--slicer-target builds one target'; Args = @('-s', '--slicer-target', 'libslic3r')
|
||||
Contains = @('--config Release --target libslic3r') }
|
||||
@{ Name = '--no-configure skips the slicer configure'; Args = @('-s', '--no-configure')
|
||||
Contains = @('cmake --build "build"')
|
||||
NotContains = @('cmake -B "build" ') }
|
||||
@{ Name = '--no-configure skips the deps configure'; Args = @('-d', '--no-configure')
|
||||
Contains = @('cmake --build "deps/build"')
|
||||
NotContains = @('cmake -S deps') }
|
||||
@{ Name = '--no-gettext skips the translation step'; Args = @('-s', '--no-gettext')
|
||||
Contains = @('cmake --build "build"')
|
||||
NotContains = @('run_gettext') }
|
||||
# Installing copies the whole tree again for a layout only releases need,
|
||||
# so it is asked for rather than assumed.
|
||||
@{ Name = 'nothing is installed unless asked'; Args = @('-s')
|
||||
Contains = @('run_gettext')
|
||||
NotContains = @('--target install') }
|
||||
@{ Name = '-i adds the install step'; Args = @('-s', '-i')
|
||||
Contains = @('--target install') }
|
||||
# install(TARGETS OrcaSlicer) has no OPTIONAL, so this would fail partway
|
||||
# through a build instead of before it.
|
||||
@{ Name = 'installing a tree with no executable is refused'; Args = @('-s', '-i', '--slicer-target', 'glad'); ExpectExit = 1
|
||||
Contains = @('--install needs the executable')
|
||||
NotContains = @('cmake --build') }
|
||||
# Without -s there is no install step, so there is nothing to refuse.
|
||||
@{ Name = 'the same flags without a slicer build are left alone'; Args = @('-d', '-i', '--slicer-target', 'glad')
|
||||
Contains = @('cmake -S deps')
|
||||
NotContains = @('--install needs the executable') }
|
||||
@{ Name = 'naming the executable target is allowed'; Args = @('-s', '-i', '--slicer-target', 'OrcaSlicer')
|
||||
Contains = @('--target install') }
|
||||
# Ninja counts compilers, so -j goes on the command line. MSBuild's -j
|
||||
# counts projects while /MP still runs one cl per core inside each, so the
|
||||
# cap goes to CL_MPCount in the environment instead. A dry run can only
|
||||
# show that no -j is passed.
|
||||
@{ Name = '-j on Ninja passes -j to cmake'; Args = @('-s', '-x', '-j', '4')
|
||||
Contains = @('Parallel jobs: 4', '--config Release -j 4') }
|
||||
@{ Name = '-j on Ninja reaches the deps build'; Args = @('-d', '-x', '-j', '2')
|
||||
Contains = @('--target deps -j 2') }
|
||||
@{ Name = '-j on MSBuild does not pass -j, which would count projects'; Args = @('-s', '-j', '4')
|
||||
Contains = @('Parallel jobs: 4')
|
||||
NotContains = @('-j 4') }
|
||||
@{ Name = '-j on MSBuild leaves the deps build without -j too'; Args = @('-d', '-j', '2')
|
||||
Contains = @('--target deps')
|
||||
NotContains = @('-j 2') }
|
||||
@{ Name = 'no -j means no job limit'; Args = @('-s')
|
||||
NotContains = @('parallel jobs', '-j ') }
|
||||
@{ Name = 'a non-numeric -j is rejected'; Args = @('-s', '-j', 'abc'); ExpectExit = 1
|
||||
Contains = @('Invalid --jobs value') }
|
||||
@{ Name = 'a zero -j is rejected'; Args = @('-s', '-j', '0'); ExpectExit = 1
|
||||
Contains = @('Invalid --jobs value') }
|
||||
@{ Name = 'the loop options combine into a single build command'; Args = @('-s', '-x', '--no-configure', '--no-gettext', '--slicer-target', 'libslic3r_tests', '-j', '8')
|
||||
Contains = @('--target libslic3r_tests -j 8')
|
||||
NotContains = @('cmake -B "build" ', 'run_gettext', '--target install') }
|
||||
|
||||
'one tree per configuration, compiler and architecture'
|
||||
# CMake resets its cache and carries on when the compiler changes under an
|
||||
# existing tree, leaving stamps from the old toolchain. Give each its own.
|
||||
@{ Name = 'clang builds land in their own trees'; Args = @('-d', '-s', '-l')
|
||||
Contains = @('cmake -S deps -B "deps/build-clang"', 'cmake -B "build-clang" ') }
|
||||
@{ Name = 'MSVC keeps the historical plain names'; Args = @('-d', '-s', '--msvc')
|
||||
Contains = @('cmake -S deps -B "deps/build"', 'cmake -B "build" ')
|
||||
NotContains = @('build-clang') }
|
||||
@{ Name = 'configuration, compiler and arch all name the tree'; Args = @('-d', '-s', '-l', '--config', 'debug', '--arch', 'arm64')
|
||||
Contains = @('cmake -S deps -B "deps/build-dbg-clang-arm64"', 'cmake -B "build-dbg-clang-arm64" ') }
|
||||
|
||||
'locating the dependency tree'
|
||||
# Without --deps-dir nothing is passed, so CMakeLists derives the path from
|
||||
# the binary directory name as it always has.
|
||||
@{ Name = 'the deps path is left to CMake by default'; Args = @('-s')
|
||||
NotContains = @('-DDEP_BUILD_DIR') }
|
||||
@{ Name = '--deps-dir tells the slicer where the deps are'; Args = @('-s', '--deps-dir', 'D:\orca-deps')
|
||||
Contains = @('-DDEP_BUILD_DIR="D:\orca-deps"') }
|
||||
@{ Name = '--deps-dir also redirects the deps build'; Args = @('-d', '--deps-dir', 'D:\orca-deps')
|
||||
Contains = @('cmake -S deps -B "D:\orca-deps"', 'cmake --build "D:\orca-deps"')
|
||||
NotContains = @('deps/build') }
|
||||
# Paths are quoted throughout, so one with spaces survives the whole run.
|
||||
@{ Name = 'a deps path with spaces survives'; Args = @('-d', '-s', '--deps-dir', 'C:\Program Files\deps')
|
||||
Contains = @('-B "C:\Program Files\deps"', '-DDEP_BUILD_DIR="C:\Program Files\deps"') }
|
||||
@{ Name = '--deps-dir also redirects the pack'; Args = @('-p', '--deps-dir', 'D:\orca-deps')
|
||||
Contains = @('cd /d "D:\orca-deps"') }
|
||||
@{ Name = 'pack uses an absolute default path'; Args = @('-p')
|
||||
Match = @('^\+ cd /d "[A-Za-z]:\\.*\\deps\\build"') }
|
||||
# CMakeLists derives DEP_BUILD_DIR from the build directory's name, so
|
||||
# pointing the build elsewhere has to name the deps tree outright.
|
||||
@{ Name = '--build-dir moves the slicer build'; Args = @('-s', '-l', '-x', '--build-dir', 'out/build/x64-clang')
|
||||
Contains = @('cmake -B "out/build/x64-clang" ') }
|
||||
@{ Name = '--build-dir still names the deps tree'; Args = @('-s', '-l', '-x', '--build-dir', 'out/build/x64-clang')
|
||||
Match = @('-DDEP_BUILD_DIR="[A-Za-z]:\\.*\\deps\\build-clang"') }
|
||||
@{ Name = '--deps-dir wins over the derived tree'; Args = @('-s', '--build-dir', 'out/build/x64-clang', '--deps-dir', 'D:\orca-deps')
|
||||
Contains = @('-DDEP_BUILD_DIR="D:\orca-deps"') }
|
||||
# A value ending in a backslash escapes the closing quote it is spliced
|
||||
# into, so cmake would receive D:\tree" and swallow the next argument.
|
||||
@{ Name = 'a trailing backslash is trimmed off a path'; Args = @('-s', '--build-dir', 'D:\tree\')
|
||||
Contains = @('cmake -B "D:\tree" ') }
|
||||
@{ Name = 'a build directory with spaces survives'; Args = @('-s', '--build-dir', 'C:\Program Files\tree')
|
||||
Contains = @('cmake -B "C:\Program Files\tree" ') }
|
||||
@{ Name = 'the default build names no deps tree'; Args = @('-s')
|
||||
NotContains = @('DEP_BUILD_DIR') }
|
||||
|
||||
'saying what mode and toolchain are in play'
|
||||
@{ Name = 'a dry run announces itself before the first command'; Args = @('-u')
|
||||
First = '^Dry run: printing commands without running them\.$' }
|
||||
@{ Name = 'the announcement leads even a full build'; Args = @('-ds')
|
||||
First = '^Dry run: ' }
|
||||
# Autodetect only runs for the Visual Studio generator, and only when no
|
||||
# release was pinned, so it needs a Visual Studio on the machine.
|
||||
@{ Name = 'the detected Visual Studio names its release year'; Args = @('-s')
|
||||
Match = @('^Detected Visual Studio \d+ \(20\d\d\)$') }
|
||||
@{ Name = 'pinning a release skips detection'; Args = @('-s', '--vs', '2022')
|
||||
NotContains = @('Detected Visual Studio') }
|
||||
|
||||
'an action has to be asked for'
|
||||
# Neither can happen without building the slicer, so they stand alone the
|
||||
# way --install-vs does.
|
||||
@{ Name = '--run-tests is an action on its own'; Args = @('--run-tests')
|
||||
Contains = @('-DBUILD_TESTS=ON', 'ctest --test-dir')
|
||||
NotContains = @('Nothing to do') }
|
||||
@{ Name = '--tests is too'; Args = @('--tests')
|
||||
Contains = @('-DBUILD_TESTS=ON')
|
||||
NotContains = @('Nothing to do', 'ctest --test-dir') }
|
||||
# Naming an action means that action, not a fuller build.
|
||||
@{ Name = 'they do not add a slicer build to one already asked for'; Args = @('-d', '--tests')
|
||||
Contains = @('cmake -S deps')
|
||||
NotContains = @('cmake -B "build"') }
|
||||
@{ Name = 'shaping options alone are not an action'; Args = @('--config', 'debug'); ExpectExit = 1
|
||||
Contains = @('Nothing to do.')
|
||||
NotContains = @('Build completed') }
|
||||
@{ Name = '-j alone is not an action either'; Args = @('-j', '4'); ExpectExit = 1
|
||||
Contains = @('Nothing to do.') }
|
||||
@{ Name = '--install-vs counts as an action on its own'; Args = @('--install-vs', 'ide')
|
||||
NotContains = @('Nothing to do.') }
|
||||
|
||||
'diagnostics'
|
||||
@{ Name = '-v asks cmake for the command lines'; Args = @('-s', '-v')
|
||||
Contains = @('--verbose') }
|
||||
@{ Name = '-v applies to the deps build too'; Args = @('-d', '-v')
|
||||
Contains = @('--target deps', '--verbose') }
|
||||
# ninja's own default shows neither a percentage nor a time. %w and %W
|
||||
# need ninja 1.12, and an unknown placeholder is fatal, so the format is
|
||||
# chosen from the version rather than hardcoded.
|
||||
@{ Name = '-v names the ninja progress format'; Args = @('-s', '-x', '-v')
|
||||
Match = @('^Ninja progress format: \[.*%p.*\]') }
|
||||
@{ Name = 'a ninja older than 1.12 gets the format it understands'; Args = @('-s', '-x', '-v')
|
||||
Env = @{ PATH = $ninjaPaths['old'] }
|
||||
Contains = @('Ninja progress format: [%s/%t %p :: %e]') }
|
||||
@{ Name = 'ninja 1.12 gets elapsed and remaining'; Args = @('-s', '-x', '-v')
|
||||
Env = @{ PATH = $ninjaPaths['new'] }
|
||||
Contains = @('Ninja progress format: [%f/%t %p :: %w / %W]') }
|
||||
@{ Name = 'a format you set yourself is left alone'; Args = @('-s', '-x', '-v')
|
||||
Env = @{ NINJA_STATUS = '[mine] ' }
|
||||
Contains = @('Ninja progress format: [mine]') }
|
||||
@{ Name = 'MSBuild builds mention no ninja format'; Args = @('-s', '-v')
|
||||
NotContains = @('Ninja progress format') }
|
||||
@{ Name = 'builds are quiet without -v'; Args = @('-s')
|
||||
NotContains = @('--verbose') }
|
||||
|
||||
'installing prerequisites'
|
||||
# -u installs CMake, Perl and Git. Visual Studio is a separate ask, because
|
||||
# most people already have it, and which one you want is a real choice.
|
||||
@{ Name = '-u alone installs no Visual Studio'; Args = @('-u')
|
||||
Contains = @('Kitware.CMake', 'StrawberryPerl', 'Git.Git')
|
||||
NotContains = @('Microsoft.VisualStudio') }
|
||||
# Asking for Visual Studio is asking to install prerequisites, so it does
|
||||
# not also need -u; requiring both meant --install-vs alone did nothing.
|
||||
@{ Name = '--install-vs works without -u'; Args = @('--install-vs', 'ide')
|
||||
Contains = @('id=Microsoft.VisualStudio.Community', 'Kitware.CMake', 'Git.Git') }
|
||||
@{ Name = '--install-vs buildtools asks for the build tools'; Args = @('-u', '--install-vs', 'buildtools')
|
||||
Contains = @('id=Microsoft.VisualStudio.BuildTools')
|
||||
NotContains = @('VC.CoreIde') }
|
||||
@{ Name = '--install-vs ide asks for Community with the IDE component'; Args = @('-u', '--install-vs', 'ide')
|
||||
Contains = @('id=Microsoft.VisualStudio.Community', 'VC.CoreIde') }
|
||||
@{ Name = 'an unknown edition is rejected and the known ones listed'; Args = @('-u', '--install-vs', 'bogus'); ExpectExit = 1
|
||||
Contains = @('Unknown Visual Studio edition', 'buildtools, ide') }
|
||||
@{ Name = '--vs picks which release to install'; Args = @('-u', '--vs', '2022', '--install-vs', 'buildtools')
|
||||
Contains = @('id=Microsoft.VisualStudio.2022.BuildTools') }
|
||||
@{ Name = '-l adds the clang compiler and the MSBuild toolset'; Args = @('-u', '--install-vs', 'buildtools', '-l')
|
||||
Contains = @('VC.Llvm.Clang ', 'VC.Llvm.ClangToolset') }
|
||||
# CMake 4.x breaks Boost.Context on ARM64, so the installer pins 3.31 there
|
||||
# and leaves x64 on the current release.
|
||||
@{ Name = 'CMake is pinned to 3.31 when installing for arm64'; Args = @('-u', '--arch', 'arm64')
|
||||
Contains = @('Kitware.CMake --version 3.31.8') }
|
||||
@{ Name = 'CMake is not pinned for x64'; Args = @('-u', '--arch', 'x64')
|
||||
Contains = @('Kitware.CMake')
|
||||
NotContains = @('--version') }
|
||||
@{ Name = 'installing for arm64 asks for the ARM64 toolset'; Args = @('--install-vs', 'buildtools', '--arch', 'arm64')
|
||||
Contains = @('Microsoft.VisualStudio.Component.VC.Tools.ARM64') }
|
||||
@{ Name = 'an x64 install asks only for the x64 toolset'; Args = @('--install-vs', 'buildtools')
|
||||
Contains = @('Microsoft.VisualStudio.Component.VC.Tools.x86.x64')
|
||||
NotContains = @('VC.Tools.ARM64') }
|
||||
|
||||
'dry run changes nothing'
|
||||
# clean_tree resolves the path before removing it, so the line echoed is
|
||||
# absolute. It is the last thing printed before a directory goes.
|
||||
@{ Name = '-c echoes the deps rmdir rather than running it'; Args = @('-d', '-c')
|
||||
Match = @('^\+ rmdir /S /Q "[A-Za-z]:\\.*\\deps\\build"$') }
|
||||
@{ Name = '-c removes the tree --deps-dir named, not the default one'; Args = @('-d', '-c', '--deps-dir', 'D:\orca-deps')
|
||||
Match = @('^\+ rmdir /S /Q "D:\\orca-deps"$')
|
||||
NotContains = @('\deps\build') }
|
||||
@{ Name = '-c echoes the slicer rmdir rather than running it'; Args = @('-s', '-c')
|
||||
Match = @('^\+ rmdir /S /Q "[A-Za-z]:\\.*\\build"$') }
|
||||
@{ Name = 'cleaning a slicer build leaves the deps tree alone'; Args = @('-s', '-c')
|
||||
NotMatch = @('rmdir.*\\deps\\') }
|
||||
@{ Name = 'cleaning both builds removes both trees'; Args = @('-d', '-s', '-c')
|
||||
Match = @('^\+ rmdir /S /Q "[A-Za-z]:\\[^"]*\\deps\\build"$',
|
||||
'^\+ rmdir /S /Q "[A-Za-z]:\\(?!.*\\deps\\)[^"]*\\build"$') }
|
||||
|
||||
# Nothing below should be reachable. They are a floor under a bug that
|
||||
# hands clean_tree a path far shorter than it looks.
|
||||
@{ Name = 'a configuration whose lookup comes back empty is rejected'; Args = @('-d', '-c', '--config', 'release '); ExpectExit = 1
|
||||
Contains = @('Unknown configuration')
|
||||
NotContains = @('rmdir') }
|
||||
@{ Name = 'a drive root is refused'; Args = @('-d', '-c', '--deps-dir', 'D:\'); ExpectExit = 1
|
||||
Contains = @('that is a drive root')
|
||||
NotContains = @('+ rmdir') }
|
||||
@{ Name = 'the repository itself is refused'; Args = @('-d', '-c', '--deps-dir', '.'); ExpectExit = 1
|
||||
Contains = @('that is the repository itself')
|
||||
NotContains = @('+ rmdir') }
|
||||
@{ Name = '-k echoes the taskkills rather than running them'; Args = @('-k')
|
||||
Contains = @('+ taskkill /F /IM MSBuild.exe', '+ taskkill /F /IM cl.exe') }
|
||||
@{ Name = '-k also covers the Ninja toolchain'; Args = @('-k')
|
||||
Contains = @('+ taskkill /F /IM ninja.exe', '+ taskkill /F /IM clang-cl.exe') }
|
||||
@{ Name = '-k announces the dry run like every other action'; Args = @('-k')
|
||||
First = '^Dry run: ' }
|
||||
@{ Name = '-u echoes the winget installs rather than running them'; Args = @('-u')
|
||||
Contains = @('+ winget install', 'Kitware.CMake')
|
||||
NotContains = @('cmake -S deps') }
|
||||
# Not a dry run: winget is a stub that fails, so nothing is installed.
|
||||
@{ Name = 'a failed install is reported, not claimed as success'; Args = @('-u')
|
||||
DryRun = $false; ExpectExit = 1
|
||||
Env = @{ PATH = $stubPath }
|
||||
Contains = @('Failed to install:', 'CMake', 'Perl', 'Git')
|
||||
NotContains = @('Installed the prerequisites') }
|
||||
# The reason belongs inside the frame. Every command this path ran had
|
||||
# already succeeded, so naming the last one would point at the wrong thing.
|
||||
@{ Name = 'a failed install names the reason, not the last command'; Args = @('-u')
|
||||
DryRun = $false; ExpectExit = 1
|
||||
Env = @{ PATH = $stubPath }
|
||||
Contains = @('####', 'Failed to install:')
|
||||
NotContains = @('Failed: winget') }
|
||||
@{ Name = 'a dry run does not claim the install happened'; Args = @('-u')
|
||||
Contains = @('Dry run: nothing was installed.')
|
||||
NotContains = @('are in place') }
|
||||
@{ Name = '-u with a build defers that build, not a fuller one'; Args = @('-u', '-d')
|
||||
Contains = @('build_win.bat -d')
|
||||
NotContains = @('build_win.bat -ds') }
|
||||
@{ Name = '-u on its own suggests the whole build'; Args = @('-u')
|
||||
Contains = @('build_win.bat -ds') }
|
||||
@{ Name = 'a dry run only echoes, it never configures'; Args = @('-d')
|
||||
Contains = @('+ cmake')
|
||||
NotContains = @('CMake Error', 'Configuring done') }
|
||||
|
||||
'extra configure arguments'
|
||||
# --deps-args and --slicer-args are declared "rawstring", so a value that
|
||||
# looks like an option is allowed through. Plain string options still
|
||||
# reject one, since there it almost always means a forgotten value.
|
||||
@{ Name = '--deps-args reaches the deps configure'; Args = @('-d', '--deps-args', 'FOO')
|
||||
Contains = @('-DCMAKE_BUILD_TYPE=Release FOO') }
|
||||
@{ Name = '--slicer-args reaches the slicer configure'; Args = @('-s', '--slicer-args', 'BAZ')
|
||||
Contains = @('BAZ') }
|
||||
@{ Name = '--deps-args accepts a value that starts with a dash'; Args = @('-d', '--deps-args', '-DFOO')
|
||||
Contains = @('-DFOO') }
|
||||
@{ Name = 'a plain string option still rejects a dash-leading value'; Args = @('-d', '--deps-target', '--tests'); ExpectExit = 1
|
||||
Contains = @('looks like another option') }
|
||||
# cmd splits arguments on "=" as well as spaces, so an unquoted -D reaches
|
||||
# the script as two arguments however it was invoked.
|
||||
@{ Name = 'an unquoted value containing = is rejected'; Args = @('-d', '--deps-args', 'FOO=BAR'); ExpectExit = 1
|
||||
Contains = @('Unknown argument') }
|
||||
# The environment overrides exist for that reason; nothing tokenises them.
|
||||
@{ Name = 'ORCA_DEPS_CMAKE_ARGS reaches the deps configure'; Args = @('-d')
|
||||
Env = @{ ORCA_DEPS_CMAKE_ARGS = '-DFOO=BAR -DBAZ=QUX' }
|
||||
Contains = @('-DFOO=BAR -DBAZ=QUX') }
|
||||
@{ Name = 'ORCA_SLICER_CMAKE_ARGS reaches the slicer configure'; Args = @('-s')
|
||||
Env = @{ ORCA_SLICER_CMAKE_ARGS = '-DWANTED=1' }
|
||||
Contains = @('-DWANTED=1') }
|
||||
@{ Name = 'the deps override does not leak into the slicer configure'; Args = @('-s')
|
||||
Env = @{ ORCA_DEPS_CMAKE_ARGS = '-DDEPSONLY=1' }
|
||||
NotContains = @('-DDEPSONLY=1') }
|
||||
@{ Name = 'the help points at the environment for a spaced argument'; Args = @('--help'); DryRun = $false
|
||||
Contains = @('Neither form supports a value containing an ampersand') }
|
||||
@{ Name = 'the help lists the environment overrides'; Args = @('--help'); DryRun = $false
|
||||
Contains = @('Environment:', 'ORCA_DEPS_CMAKE_ARGS', 'ORCA_SLICER_CMAKE_ARGS') }
|
||||
|
||||
'running the unit tests'
|
||||
@{ Name = '--tests builds them without running them'; Args = @('-s', '--tests')
|
||||
Contains = @('-DBUILD_TESTS=ON')
|
||||
NotContains = @('ctest') }
|
||||
@{ Name = '--run-tests builds and runs them'; Args = @('-s', '--run-tests')
|
||||
Contains = @('-DBUILD_TESTS=ON', 'ctest --test-dir "build/tests" -C Release --output-on-failure') }
|
||||
@{ Name = '--run-tests follows the build type and directory'; Args = @('-s', '--run-tests', '--config', 'debug')
|
||||
Contains = @('ctest --test-dir "build-dbg/tests" -C Debug') }
|
||||
@{ Name = 'no tests are run by default'; Args = @('-s')
|
||||
NotContains = @('ctest') }
|
||||
|
||||
'failures are reported'
|
||||
@{ Name = 'a missing cmake is caught and exits non-zero'; Args = @('-d'); ExpectExit = 1
|
||||
Env = @{ PATH = 'C:\Windows\system32;C:\Windows' }
|
||||
Contains = @('CMake was not found') }
|
||||
@{ Name = 'packing does not need cmake, only an archiver'; Args = @('-p')
|
||||
Env = @{ PATH = 'C:\Windows\system32;C:\Windows' }
|
||||
NotContains = @('CMake was not found') }
|
||||
# Not a dry run: a cd to a missing drive is a real failure inside a
|
||||
# parenthesised block, which is where exit /b silently loses its code.
|
||||
# Without the jump to :die this exits 0 and a failed build reads as a
|
||||
# successful one.
|
||||
@{ Name = 'a failure inside a build block reaches the caller'; Args = @('-p', '--deps-dir', 'Z:\nope')
|
||||
DryRun = $false; ExpectExit = 1
|
||||
Contains = @('Exit code 1.', '####')
|
||||
NotContains = @('Build completed', 'Try') }
|
||||
# The retry follows the stage that failed. Offering it for the whole run
|
||||
# would clean a dependency tree that was not at fault.
|
||||
@{ Name = 'a failure names a retry scoped to the stage that failed'; Args = @('-d', '-s', '--deps-dir', 'Z:\nope')
|
||||
DryRun = $false; ExpectExit = 1
|
||||
Contains = @('build_win.bat -d --deps-dir "Z:\nope" -c')
|
||||
NotContains = @('build_win.bat -ds') }
|
||||
# CMake's own failure here is hundreds of lines about package resolution.
|
||||
@{ Name = 'a missing dependency tree is named, not left to CMake'; Args = @('-s', '--deps-dir', 'Z:\nope')
|
||||
DryRun = $false; ExpectExit = 1
|
||||
Contains = @('Dependencies not found at', 'Build them with build_win.bat -d --deps-dir "Z:\nope"')
|
||||
NotContains = @('cmake -B', 'Try') }
|
||||
# Every other suggestion carries the flags that reproduce the run; a bare
|
||||
# -d would point at the MSVC tree after a clang build.
|
||||
@{ Name = 'the missing-deps hint names this toolchain'; Args = @('-s', '-l', '-x', '--deps-dir', 'deps/not-built')
|
||||
DryRun = $false; ExpectExit = 1
|
||||
Contains = @('Build them with build_win.bat -d -l -x --deps-dir "deps/not-built"')
|
||||
NotExists = @('deps/not-built') }
|
||||
# A dry run configures nothing, so it must not depend on which trees happen
|
||||
# to exist on the machine running the suite.
|
||||
@{ Name = 'a dry run does not check for the deps tree'; Args = @('-s', '--deps-dir', 'Z:\nope')
|
||||
Contains = @('cmake -B "build"')
|
||||
NotContains = @('Dependencies not found') }
|
||||
# -d is about to build them, so there is nothing to report yet.
|
||||
@{ Name = 'building the deps in the same run skips the check'; Args = @('-d', '-s', '--deps-dir', 'Z:\nope')
|
||||
DryRun = $false; ExpectExit = 1
|
||||
NotContains = @('Dependencies not found') }
|
||||
# A configure fails before any compiler runs, so -v has nothing to show.
|
||||
@{ Name = 'a configure failure is not offered a verbose rebuild'; Args = @('-d', '--deps-dir', 'Z:\nope')
|
||||
DryRun = $false; ExpectExit = 1
|
||||
Contains = @('-c discard that tree')
|
||||
NotContains = @('-v show the failing') }
|
||||
# A bare --no-configure succeeds on a machine that already has a usable
|
||||
# build tree, so name one that cannot exist instead.
|
||||
@{ Name = 'a build failure is'; Args = @('-s', '--no-configure', '--build-dir', 'deps/no-such-tree')
|
||||
DryRun = $false; ExpectExit = 1
|
||||
Contains = @('-v show the failing')
|
||||
NotExists = @('deps/no-such-tree') }
|
||||
# --build-dir names the slicer tree, which a deps failure has nothing to do
|
||||
# with. --deps-dir stays, because that is the tree that failed.
|
||||
@{ Name = 'a deps retry leaves out the slicer tree'; Args = @('-d', '-s', '--deps-dir', 'Z:\nope', '--build-dir', 'D:\b')
|
||||
DryRun = $false; ExpectExit = 1
|
||||
Contains = @('build_win.bat -d --deps-dir "Z:\nope" -c')
|
||||
NotContains = @('--build-dir') }
|
||||
@{ Name = 'an unknown configuration stays a single line'; Args = @('-s', '--config', 'bogus'); ExpectExit = 1
|
||||
Contains = @('Unknown configuration')
|
||||
NotContains = @('####', 'Try') }
|
||||
@{ Name = 'a bad --jobs value is not framed either'; Args = @('-s', '-j', 'x'); ExpectExit = 1
|
||||
Contains = @('Invalid --jobs value')
|
||||
NotContains = @('####') }
|
||||
|
||||
'the summary says what to do next'
|
||||
# Every suggested command carries the flags that reproduce this run.
|
||||
@{ Name = 'a deps build points at the slicer build'; Args = @('-d', '-l')
|
||||
Contains = @('Build the slicer build_win.bat -s -l')
|
||||
NotContains = @('Run it') }
|
||||
@{ Name = 'a ninja slicer build offers a single target'; Args = @('-s', '-l', '-x')
|
||||
Contains = @('Rebuild after edits build_win.bat -s -l -x --no-configure', 'Rebuild one target')
|
||||
NotContains = @('Solution', 'Open in Visual Studio') }
|
||||
@{ Name = 'a visual studio build names the solution instead'; Args = @('-s')
|
||||
Contains = @('Solution ', 'Open in Visual Studio build\OrcaSlicer.sln',
|
||||
'Rebuild after edits build_win.bat -s --no-configure')
|
||||
NotContains = @('Rebuild one target') }
|
||||
@{ Name = 'the configuration and architecture come back'; Args = @('-s', '-l', '-x', '--config', 'debug', '--arch', 'arm64')
|
||||
Contains = @('build_win.bat -s -l -x --config debug --arch arm64 --no-configure') }
|
||||
@{ Name = 'the tree overrides come back quoted'; Args = @('-s', '--deps-dir', 'D:\d', '--build-dir', 'D:\b')
|
||||
Contains = @('--deps-dir "D:\d" --build-dir "D:\b"') }
|
||||
@{ Name = 'a pinned visual studio release comes back'; Args = @('-s', '--vs', '2022')
|
||||
Contains = @('build_win.bat -s --vs 2022 --no-configure') }
|
||||
# Autodetection writes what it found into the same variable, so a detected
|
||||
# release must not come back as though it had been asked for.
|
||||
@{ Name = 'a detected release does not'; Args = @('-s')
|
||||
NotContains = @('--vs') }
|
||||
@{ Name = 'the binary is named in the build tree it was built in'; Args = @('-s', '-l', '-x')
|
||||
Contains = @('build-clang\src\Release\orca-slicer.exe') }
|
||||
@{ Name = 'installing names the installed copy instead'; Args = @('-s', '-l', '-x', '-i')
|
||||
Contains = @('build-clang\OrcaSlicer\orca-slicer.exe') }
|
||||
# -i changes where the binary lands, so a rebuild that dropped it would
|
||||
# leave the path above pointing at a stale copy.
|
||||
@{ Name = 'the rebuild suggestion keeps -i'; Args = @('-s', '-l', '-x', '-i')
|
||||
Contains = @('Rebuild after edits build_win.bat -s -l -x -i --no-configure') }
|
||||
# A deps retry has no install step to repeat.
|
||||
@{ Name = 'a deps retry drops it'; Args = @('-d', '-s', '-i', '--deps-dir', 'Z:\nope')
|
||||
DryRun = $false; ExpectExit = 1
|
||||
Contains = @('build_win.bat -d --deps-dir "Z:\nope" -c')
|
||||
NotContains = @('-d -i') }
|
||||
# Naming a target builds it and its dependencies, not its dependents, so
|
||||
# the binary on disk is whatever the last full build left there.
|
||||
@{ Name = 'a single-target build does not claim the whole binary'; Args = @('-s', '-l', '-x', '--slicer-target', 'glad')
|
||||
Contains = @('Target glad', 'Relink the binary build_win.bat -s -l -x --no-configure')
|
||||
NotContains = @('Run it', 'orca-slicer.exe', 'Rebuild after edits') }
|
||||
# The executable has a target of its own, and naming that one does relink.
|
||||
@{ Name = 'naming the executable target still claims the binary'; Args = @('-s', '-l', '-x', '--slicer-target', 'OrcaSlicer')
|
||||
Contains = @('Run it', 'orca-slicer.exe', 'Rebuild after edits')
|
||||
NotContains = @('Target OrcaSlicer', 'Relink the binary') }
|
||||
@{ Name = '--run-tests offers the ctest line'; Args = @('-s', '-l', '-x', '--run-tests')
|
||||
Contains = @('Re-run the tests ctest --test-dir build-clang/tests -C Release') }
|
||||
@{ Name = 'packing names the bundle and how to use it'; Args = @('-p', '-l')
|
||||
Contains = @('Bundle ', 'Share the bundle') }
|
||||
# The line supplies its own tree, so the one this run used must not ride
|
||||
# along and contradict it.
|
||||
@{ Name = 'the bundle line names one tree, not two'; Args = @('-s', '-p', '-l', '-x', '--deps-dir', 'D:\shared')
|
||||
Contains = @('then build_win.bat -s -l -x --deps-dir <path>')
|
||||
NotContains = @('--deps-dir "D:\shared" --deps-dir') }
|
||||
@{ Name = 'installing prerequisites suggests the build that follows'; Args = @('-u', '-l')
|
||||
Contains = @('Restart this shell', 'build_win.bat -ds -l')
|
||||
NotContains = @('Run it') }
|
||||
# Everything below the header line is worked out the same way in either
|
||||
# run, which is why a dry run can cover it.
|
||||
@{ Name = 'a dry run does not claim a build happened'; Args = @('-s', '-l', '-x')
|
||||
Contains = @('Dry run: nothing was built.')
|
||||
NotContains = @('Build completed in') }
|
||||
# --no-configure is the iteration loop and still gets the block; four
|
||||
# lines after a rebuild is not enough to be worth suppressing.
|
||||
@{ Name = '--no-configure still gets the summary'; Args = @('-s', '-l', '-x', '--no-configure')
|
||||
Contains = @('Next', 'Rebuild after edits') }
|
||||
|
||||
'pointing at the solution'
|
||||
@{ Name = 'the VS generator says where the solution is'; Args = @('-s')
|
||||
Match = @('^ Solution .*\\build\\OrcaSlicer\.sln$') }
|
||||
@{ Name = 'the solution path follows the configuration'; Args = @('-s', '--config', 'debug')
|
||||
Match = @('^ Solution .*\\build-dbg\\OrcaSlicer\.sln$') }
|
||||
@{ Name = 'the solution line survives an install'; Args = @('-s', '-i')
|
||||
Contains = @(' Solution ') }
|
||||
# The path is resolved, not pasted onto the repository root, so it is
|
||||
# right whether --build-dir came absolute or with forward slashes.
|
||||
@{ Name = 'a moved build still prints one real path'; Args = @('-s', '--build-dir', 'out/build/x64-clang')
|
||||
Match = @('^ Solution [A-Za-z]:\\[^/]+\\OrcaSlicer\.sln$') }
|
||||
@{ Name = 'an absolute --build-dir is not glued onto the repo root'; Args = @('-s', '--build-dir', 'D:\tree')
|
||||
Contains = @('Solution D:\tree\OrcaSlicer.sln') }
|
||||
)
|
||||
|
||||
function Invoke-BuildScript {
|
||||
param([string[]] $Arguments, [hashtable] $Environment)
|
||||
|
||||
$saved = @{}
|
||||
if ($Environment) {
|
||||
foreach ($key in $Environment.Keys) {
|
||||
$saved[$key] = [Environment]::GetEnvironmentVariable($key)
|
||||
Set-Item -Path "env:$key" -Value $Environment[$key]
|
||||
}
|
||||
}
|
||||
try {
|
||||
# 'Stop' turns a native command's stderr into a terminating error, and
|
||||
# a case that exercises a real failure writes to stderr. Let the output
|
||||
# through and judge the run by its exit code instead. The assignment is
|
||||
# scoped to this function, so the rest of the suite keeps 'Stop'.
|
||||
$ErrorActionPreference = 'Continue'
|
||||
if ($Arguments.Count -eq 0) {
|
||||
$out = & $Script 2>&1 | Out-String
|
||||
} else {
|
||||
$out = & $Script @Arguments 2>&1 | Out-String
|
||||
}
|
||||
return [pscustomobject]@{ Output = $out; Exit = $LASTEXITCODE }
|
||||
} finally {
|
||||
foreach ($key in $saved.Keys) {
|
||||
if ($null -eq $saved[$key]) { Remove-Item -Path "env:$key" -ErrorAction SilentlyContinue }
|
||||
else { Set-Item -Path "env:$key" -Value $saved[$key] }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$knownFields = @(
|
||||
'Name', 'Args', 'ExpectExit', 'DryRun', 'First', 'Env',
|
||||
'Contains', 'NotContains', 'Match', 'NotMatch', 'NotExists'
|
||||
)
|
||||
|
||||
function Test-Case {
|
||||
param([hashtable] $Case)
|
||||
|
||||
# Read fields with the indexer, not dot notation. A hashtable exposes its
|
||||
# own members too, so $Case.Contains returns the Contains *method* whenever
|
||||
# the case has no key by that name.
|
||||
$argv = @($Case['Args'])
|
||||
if (-not $Case.ContainsKey('DryRun') -or $Case['DryRun']) { $argv += '--dry-run' }
|
||||
|
||||
$expect = 0
|
||||
if ($Case.ContainsKey('ExpectExit')) { $expect = $Case['ExpectExit'] }
|
||||
|
||||
$result = Invoke-BuildScript -Arguments $argv -Environment $Case['Env']
|
||||
|
||||
$problems = @()
|
||||
|
||||
# A misspelled field is silently ignored by the checks below, which
|
||||
# leaves the case asserting nothing at all and passing.
|
||||
foreach ($field in $Case.Keys) {
|
||||
if ($knownFields -notcontains $field) { $problems += "unknown field '$field'" }
|
||||
}
|
||||
|
||||
if ($result.Exit -ne $expect) { $problems += "exit $($result.Exit), expected $expect" }
|
||||
foreach ($needle in $Case['Contains']) {
|
||||
if (-not $result.Output.Contains($needle)) { $problems += "missing '$needle'" }
|
||||
}
|
||||
foreach ($needle in $Case['NotContains']) {
|
||||
if ($result.Output.Contains($needle)) { $problems += "unexpected '$needle'" }
|
||||
}
|
||||
$lines = $result.Output -split "`r?`n"
|
||||
if ($Case['First'] -and $lines[0] -notmatch $Case['First']) {
|
||||
$problems += "first line was '$($lines[0])'"
|
||||
}
|
||||
foreach ($pattern in $Case['Match']) {
|
||||
if (@($lines | Where-Object { $_ -match $pattern }).Count -eq 0) {
|
||||
$problems += "no line matching /$pattern/"
|
||||
}
|
||||
}
|
||||
foreach ($pattern in $Case['NotMatch']) {
|
||||
foreach ($line in @($lines | Where-Object { $_ -match $pattern })) {
|
||||
$problems += "line matches /$pattern/: $line"
|
||||
}
|
||||
}
|
||||
# Output cannot show what a run did not create.
|
||||
foreach ($path in $Case['NotExists']) {
|
||||
$full = Join-Path (Split-Path -Parent $Script) $path
|
||||
if (Test-Path $full) {
|
||||
$problems += "created '$path'"
|
||||
}
|
||||
}
|
||||
return ,$problems
|
||||
}
|
||||
|
||||
$pass = 0
|
||||
$failed = @()
|
||||
# Held back so a filtered run does not print headings for groups it skipped.
|
||||
$heading = $null
|
||||
|
||||
foreach ($case in $cases) {
|
||||
if ($case -is [string]) {
|
||||
$heading = $case
|
||||
continue
|
||||
}
|
||||
if ($Name -and $case['Name'] -notmatch $Name) { continue }
|
||||
if ($heading) {
|
||||
Write-Host ''
|
||||
Write-Host $heading -ForegroundColor Cyan
|
||||
$heading = $null
|
||||
}
|
||||
|
||||
$problems = Test-Case -Case $case
|
||||
if ($problems.Count -eq 0) {
|
||||
$pass++
|
||||
Write-Host (' ok ' + $case['Name'])
|
||||
} else {
|
||||
$failed += $case['Name']
|
||||
Write-Host (' FAIL ' + $case['Name']) -ForegroundColor Red
|
||||
foreach ($problem in $problems) { Write-Host (' ' + $problem) -ForegroundColor Red }
|
||||
Write-Host (' args: ' + (@($case['Args']) -join ' '))
|
||||
}
|
||||
}
|
||||
|
||||
Remove-Item -Recurse -Force $fixtures -ErrorAction SilentlyContinue
|
||||
|
||||
Write-Host ''
|
||||
# A pattern that matched nothing has proved nothing, so do not report it as
|
||||
# a clean run.
|
||||
if ($Name -and $pass -eq 0 -and $failed.Count -eq 0) {
|
||||
Write-Host "no case matched /$Name/" -ForegroundColor Red
|
||||
exit 1
|
||||
}
|
||||
Write-Host "$pass passed, $($failed.Count) failed"
|
||||
if ($failed.Count -gt 0) {
|
||||
foreach ($name in $failed) { Write-Host " failed: $name" -ForegroundColor Red }
|
||||
exit 1
|
||||
}
|
||||
exit 0
|
||||
Reference in New Issue
Block a user