Nothing tests the Build-PSBuildUpdatableHelp branch that deletes a consumer's output directory
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- powershell
- Domain
- testing-qa
Research direction
Start with Build-PSBuildUpdatableHelp and tests/Build-PSBuildHelp.tests.ps1, especially the existing New-PSBuildDocsScenario setup and calls around lines 214, 271, and 330. Pre-create UpdatableHelpPath with a sentinel file and subdirectory, run the function, and verify the intended deletion behavior and newly generated cabinet; run the focused test file to confirm the branch is covered.
Written by the indexing model from the issue text.
Description
Build-PSBuildUpdatableHelp contains the only code path in the module that deletes files a consumer may care about, and no test exercises it.
The branch
if (-not (Test-Path -LiteralPath $OutputPath)) {
New-Item @newItemSplat > $null
} else {
Write-Verbose ($LocalizedData.DirectoryAlreadyExists -f $OutputPath)
$removeItemSplat = @{
Recurse = $true
Force = $true
Verbose = ($VerbosePreference -eq 'Continue')
}
Get-ChildItem $OutputPath | Remove-Item @removeItemSplat
}
Get-ChildItem with no -Filter, then Remove-Item -Recurse -Force. Everything in OutputPath goes, whether PowerShellBuild wrote it or not.
Measured
Pointing the function at an OutputPath that already holds a previous build's output plus a directory PowerShellBuild never created:
BEFORE:
\PreviousBuild.cab
\Probe_HelpInfo.xml
\consumer-subfolder
\consumer-subfolder\notes.txt
AFTER:
(empty)
The deletion happens before any cabinet is written, so it also happens on a run that then fails — in the measurement above New-HelpCabinetFile errored afterwards, and the consumer was left with an empty directory and no new cabinet.
Nothing reaches it
Every call site in the suite supplies a fresh OutputPath that does not yet exist, so the New-Item branch is the only one taken:
tests/Build-PSBuildHelp.tests.ps1calls the function three times (lines 214, 271, 330), each with aUpdatableHelpPathfrom a distinctNew-PSBuildDocsScenario. That helper returns<scenario>/Output/UpdatableHelpfrom a freshly copied fixture, and the fixture (tests/fixtures/PSBuildTestFixture) contains noOutputdirectory. Nothing pre-creates the path, and no scenario is used twice.tests/build.tests.ps1runs theGenerateUpdatableHelptask once, in a job, and itsAfterAllremoves the output path afterwards.
There is no assertion anywhere that stale content is removed, and none that content outside PowerShellBuild's own output survives or does not.
Why it matters
$PSBPreference.Docs.UpdatableHelpOutDir is a consumer-set path. A consumer who points it at a directory that holds anything else — a checked-in HelpInfo.xml, a hand-maintained README, a sibling artifact directory, or in the worst case a path chosen carelessly — loses all of it on the next GenerateUpdatableHelp, silently, at Write-Verbose level.
The behaviour itself is defensible: leaving a previous build's cabinets in place would produce an output directory holding cabinets for commands that no longer exist, and the function's own comments explain that half-produced output is what the surrounding guards exist to prevent. What is not defensible is that it is the module's only destructive operation and the one behaviour with no test at all. Every other file-touching path in Build-PSBuildUpdatableHelp — the manifest guard, the HelpInfoUri guard, the missing landing page, the missing locale directory — was covered in #149 and #124. This one was not.
It is also cheap to test. The scenario helper already produces the directory layout; the test is one New-Item on UpdatableHelpPath and one sentinel file before the call.
Options
- Test the branch as written. Pre-create
OutputPath, drop a sentinel file and a sentinel subdirectory in it, run the function, and assert both are gone and the new cabinet is present. Cheap, and it pins the current contract so a future refactor cannot quietly change it in either direction. - Test it and narrow what is deleted. Remove only what this function produces —
*.cab,*.zip,*HelpInfo.xml— rather than the whole directory. Safer for a consumer who shares the directory, and it still solves the stale-cabinet problem the wholesale delete exists for. It does leave a cabinet behind if the locale ever changes, which the current behaviour handles. - Test it and require the directory to be PowerShellBuild's. Refuse, or warn, when
OutputPathalready contains files that do not match the produced set. Most protective, most surprising, and it would break a consumer whose directory legitimately holds something else. - Test it and document it. Keep the behaviour, and say in the README's settings table that
$PSBPreference.Docs.UpdatableHelpOutDiris cleared on every run. Whatever else is done, the table currently says nothing about it, and a consumer cannot learn this except by losing something.
(1) plus (4) is the minimum that makes the behaviour deliberate rather than incidental. (2) is worth weighing on its own merits, but the test should exist regardless of which behaviour is chosen — writing it first is what makes the choice visible.
Related: #149 (which added the rest of this function's coverage), #124 (the docs-tree locale handling immediately above this branch).
- Dominant language
- PowerShell
- Stars
- 145
- Forks
- 27
- Avg merge
- 10h 16m
- Merged PRs (30d)
- 34
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from psake/PowerShellBuild
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
psake/PowerShellBuild#211 · 1 comment ·
-
CI: Install the built module from a local repository to verify install-time dependency behaviour Openenhancement github_actions
Difficulty 4/5 3-5 days Newbie friendliness 68/100
psake/PowerShellBuild#229 ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 55/100
psake/PowerShellBuild#222 ·
-
bug
Difficulty 4/5 3-5 days Newbie friendliness 68/100
psake/PowerShellBuild#221 ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 55/100
psake/PowerShellBuild#220 ·
All issues in psake/PowerShellBuild
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
copse-dev/agent-pane#2953 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
simonw/sqlite-utils#872 ·
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
danielmiessler/LifeOS#2218 ·
-
kind/cleanup
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
kubernetes-sigs/kueue#15947 ·