mirror of
https://github.com/GoodOlClint/PSProxmoxVE.git
synced 2026-09-06 20:19:01 +00:00
goodolclint-claude[bot]
cebfdc530c
* ci: fail the PR when the generated help is out of date docs/cmdlets/ and the MAML are outputs of generate-help.ps1, but no workflow ran it, so the help drifted 25 cmdlets behind the source (#153) and the stale MAML shipped in every PSGallery release. A help-current job regenerates and fails on a dirty tree, comparing content rather than the CRLF platyPS writes. Depends on #205, which commits the regenerated help; before that merges this job fails on its first run. * ci: normalize untracked help stubs too, and quote the pathspecs --------- Co-authored-by: goodolclint-claude[bot] <323206664+goodolclint-claude[bot]@users.noreply.github.com>
245 lines
9.3 KiB
YAML
245 lines
9.3 KiB
YAML
name: Unit Tests
|
|
|
|
# Pinned, not floored. Pester is installed fresh on every run, so a version range
|
|
# lets a new major reach the required checks with no commit to this repo (#112).
|
|
# Keep in step with PESTER_VERSION in tests/Dockerfile.test.
|
|
env:
|
|
PESTER_VERSION: 6.1.0
|
|
|
|
on:
|
|
push:
|
|
branches: [ main ]
|
|
pull_request:
|
|
branches: [ main ]
|
|
|
|
jobs:
|
|
# ── Build module artifacts (only job that needs .NET SDK) ──────────
|
|
build:
|
|
runs-on: ${{ matrix.os }}
|
|
timeout-minutes: 10
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
include:
|
|
- os: windows-latest
|
|
framework: netstandard2.0
|
|
- os: ubuntu-latest
|
|
framework: netstandard2.0
|
|
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
|
|
- name: Setup .NET
|
|
uses: actions/setup-dotnet@v6
|
|
with:
|
|
dotnet-version: '10.0.x'
|
|
|
|
- name: Build module
|
|
run: dotnet publish src/PSProxmoxVE/PSProxmoxVE.csproj --configuration Release --framework ${{ matrix.framework }} --output ./publish/${{ matrix.framework }}
|
|
|
|
- name: Clean publish output for PS module loading
|
|
shell: bash
|
|
run: rm -f ./publish/${{ matrix.framework }}/*.deps.json ./publish/${{ matrix.framework }}/*.runtimeconfig.json
|
|
|
|
- name: Upload module artifact
|
|
uses: actions/upload-artifact@v7
|
|
with:
|
|
name: module-${{ matrix.framework }}-${{ matrix.os }}
|
|
path: ./publish/${{ matrix.framework }}/
|
|
|
|
# ── Pester tests (no .NET SDK — just PowerShell + Pester) ─────────
|
|
pester-tests:
|
|
needs: build
|
|
timeout-minutes: 15
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
include:
|
|
- os: windows-latest
|
|
ps_version: '5.1'
|
|
framework: netstandard2.0
|
|
artifact_os: windows-latest
|
|
shell: powershell
|
|
- os: windows-latest
|
|
ps_version: '7.5'
|
|
framework: netstandard2.0
|
|
artifact_os: windows-latest
|
|
shell: pwsh
|
|
- os: ubuntu-latest
|
|
ps_version: '7.5'
|
|
framework: netstandard2.0
|
|
artifact_os: ubuntu-latest
|
|
shell: pwsh
|
|
- os: macos-latest
|
|
ps_version: '7.5'
|
|
framework: netstandard2.0
|
|
artifact_os: ubuntu-latest
|
|
shell: pwsh
|
|
|
|
runs-on: ${{ matrix.os }}
|
|
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
|
|
- name: Download module artifact
|
|
uses: actions/download-artifact@v8
|
|
with:
|
|
name: module-${{ matrix.framework }}-${{ matrix.artifact_os }}
|
|
path: ./publish/${{ matrix.framework }}/
|
|
|
|
# -RequiredVersion accepts an empty value and degrades to "latest" with
|
|
# exit 0, so an unset variable would silently restore the float this pin
|
|
# removes. Fail the job instead.
|
|
- name: Verify PESTER_VERSION is set
|
|
shell: pwsh
|
|
run: |
|
|
if ([string]::IsNullOrWhiteSpace($env:PESTER_VERSION)) { throw 'PESTER_VERSION is not set' }
|
|
"Pinning Pester to $env:PESTER_VERSION"
|
|
|
|
- name: Install Pester (PS 5.1)
|
|
if: matrix.ps_version == '5.1'
|
|
shell: powershell
|
|
run: |
|
|
Install-Module -Name Pester -RequiredVersion $env:PESTER_VERSION -Force -Scope CurrentUser -SkipPublisherCheck
|
|
|
|
- name: Install Pester (PS 7.x)
|
|
if: matrix.ps_version != '5.1'
|
|
shell: pwsh
|
|
run: |
|
|
Install-Module -Name Pester -RequiredVersion $env:PESTER_VERSION -Force -Scope CurrentUser
|
|
|
|
- name: Copy module to module path (PS 5.1)
|
|
if: matrix.ps_version == '5.1'
|
|
shell: powershell
|
|
run: |
|
|
$modulePath = "$env:USERPROFILE\Documents\WindowsPowerShell\Modules\PSProxmoxVE"
|
|
New-Item -ItemType Directory -Path $modulePath -Force | Out-Null
|
|
Copy-Item -Path .\publish\${{ matrix.framework }}\* -Destination $modulePath -Recurse -Force
|
|
|
|
- name: Copy module to module path (PS 7.x, Windows)
|
|
if: matrix.ps_version != '5.1' && matrix.os == 'windows-latest'
|
|
shell: pwsh
|
|
run: |
|
|
$modulePath = "$env:USERPROFILE\Documents\PowerShell\Modules\PSProxmoxVE"
|
|
New-Item -ItemType Directory -Path $modulePath -Force | Out-Null
|
|
Copy-Item -Path .\publish\${{ matrix.framework }}\* -Destination $modulePath -Recurse -Force
|
|
|
|
- name: Copy module to module path (PS 7.x, non-Windows)
|
|
if: matrix.ps_version != '5.1' && matrix.os != 'windows-latest'
|
|
shell: pwsh
|
|
run: |
|
|
$modulePath = "$HOME/.local/share/powershell/Modules/PSProxmoxVE"
|
|
New-Item -ItemType Directory -Path $modulePath -Force | Out-Null
|
|
Copy-Item -Path ./publish/${{ matrix.framework }}/* -Destination $modulePath -Recurse -Force
|
|
|
|
- name: Run Pester tests (PS 5.1)
|
|
if: matrix.ps_version == '5.1'
|
|
shell: powershell
|
|
run: |
|
|
Import-Module Pester -RequiredVersion $env:PESTER_VERSION
|
|
$config = New-PesterConfiguration
|
|
$config.Run.Path = "tests/PSProxmoxVE.Tests"
|
|
$config.Run.Exit = $true
|
|
$config.Filter.ExcludeTag = @("Integration")
|
|
$config.Output.Verbosity = "Detailed"
|
|
$config.TestResult.Enabled = $true
|
|
$config.TestResult.OutputFormat = "NUnitXml"
|
|
$config.TestResult.OutputPath = "TestResults/pester-results.xml"
|
|
Invoke-Pester -Configuration $config
|
|
|
|
- name: Run Pester tests (PS 7.x)
|
|
if: matrix.ps_version != '5.1'
|
|
shell: pwsh
|
|
run: |
|
|
Import-Module Pester -RequiredVersion $env:PESTER_VERSION
|
|
$config = New-PesterConfiguration
|
|
$config.Run.Path = "tests/PSProxmoxVE.Tests"
|
|
$config.Run.Exit = $true
|
|
$config.Filter.ExcludeTag = @("Integration")
|
|
$config.Output.Verbosity = "Detailed"
|
|
$config.TestResult.Enabled = $true
|
|
$config.TestResult.OutputFormat = "NUnitXml"
|
|
$config.TestResult.OutputPath = "TestResults/pester-results.xml"
|
|
Invoke-Pester -Configuration $config
|
|
|
|
- name: Upload test results
|
|
if: always()
|
|
uses: actions/upload-artifact@v7
|
|
with:
|
|
name: pester-results-${{ matrix.os }}-ps${{ matrix.ps_version }}
|
|
path: TestResults/
|
|
|
|
# ── Generated help matches the source ───────────────────────────────
|
|
# docs/cmdlets/ and the MAML are outputs of generate-help.ps1, but no
|
|
# workflow ran it, so cmdlets shipped undocumented until someone noticed:
|
|
# at #153 the module had 194 cmdlets and 169 help entries, and the stale
|
|
# MAML went out in every PSGallery release.
|
|
help-current:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 15
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
with:
|
|
persist-credentials: false
|
|
|
|
- name: Setup .NET
|
|
uses: actions/setup-dotnet@v6
|
|
with:
|
|
dotnet-version: '10.0.x'
|
|
|
|
- name: Regenerate help
|
|
shell: pwsh
|
|
run: ./generate-help.ps1
|
|
|
|
# platyPS writes CRLF into every file it produces, so compare content,
|
|
# not line endings. Untracked files count: a new cmdlet's stub is
|
|
# exactly the miss this job exists to catch.
|
|
- name: Fail if the generated help is out of date
|
|
shell: bash
|
|
run: |
|
|
paths=(docs/cmdlets src/PSProxmoxVE/PSProxmoxVE.dll-Help.xml)
|
|
find "${paths[@]}" -type f -print0 | xargs -0 -r perl -pi -e 's/\r\n/\n/g'
|
|
if [ -n "$(git status --porcelain -- "${paths[@]}")" ]; then
|
|
echo "::error::generated help is out of date - run ./generate-help.ps1 and commit the result"
|
|
git status --porcelain -- "${paths[@]}"
|
|
git diff --stat -- "${paths[@]}"
|
|
exit 1
|
|
fi
|
|
|
|
# ── CI infrastructure shell self-checks ─────────────────────────────
|
|
# These guard the provisioning and reporting scripts, whose real exercise is
|
|
# a ~45-minute nested-PVE run. They stub ssh/gh/git and finish in seconds, so
|
|
# a regression in them is caught on the PR rather than a week later.
|
|
shell-selfchecks:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 5
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
with:
|
|
persist-credentials: false
|
|
|
|
- name: prepare-test-environment self-check
|
|
run: bash tests/infrastructure/scripts/prepare-test-environment.test.sh
|
|
|
|
- name: report-package-currency self-check
|
|
run: bash tests/infrastructure/scripts/report-package-currency.test.sh
|
|
|
|
- name: preflight-cleanup self-check
|
|
run: bash tests/infrastructure/scripts/preflight-cleanup.test.sh
|
|
|
|
# The pin lives in two files; split-brain is exactly the unexplained
|
|
# breakage ADR 0022 exists to prevent, so assert they agree.
|
|
- name: Pester pin agrees across workflow and image
|
|
run: |
|
|
wf=$(sed -n 's/^ PESTER_VERSION: *//p' .github/workflows/unit-tests.yml)
|
|
img=$(sed -n 's/^ARG PESTER_VERSION=//p' tests/Dockerfile.test)
|
|
echo "workflow=$wf image=$img"
|
|
[ -n "$wf" ] && [ -n "$img" ] || { echo "could not read one of the pins" >&2; exit 1; }
|
|
[ "$wf" = "$img" ] || { echo "PESTER_VERSION differs: workflow=$wf image=$img" >&2; exit 1; }
|
|
|
|
- name: Shell syntax check
|
|
run: |
|
|
for f in tests/infrastructure/scripts/*.sh; do
|
|
bash -n "$f" || exit 1
|
|
done
|