Ansible
PS DSC
Downloads:
9
Downloads of v 1.0.0:
9
Last Update:
24 Apr 2024
Published Date:
24 Apr 2024
Package Maintainer(s):
Software Author(s):
- jpruskin schusterfredl lindbergbrewery
Tags:
debug extension package development- Software Specific:
- Software Site
- Software Source
- Software License
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Chocolatey Package Debug Extension
(Waiting for Maintainer to take corrective action)
- 1
- 2
- 3
1.0.0 | Updated: 24 Apr 2024
- Software Specific:
- Software Site
- Software Source
- Software License
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Downloads:
9
Downloads of v 1.0.0:
9
Published:
24 Apr 2024
Maintainer(s):
Software Author(s):
- jpruskin schusterfredl lindbergbrewery
Chocolatey Package Debug Extension 1.0.0
(Waiting for Maintainer to take corrective action)
- 1
- 2
- 3
Some Checks Have Failed or Are Not Yet Complete
Not All Tests Have Passed
Validation Testing Failed
Verification Testing Pending
Scan Testing Pending
This version is in moderation and has not yet been approved. This means it doesn't show up under normal search.
- Until approved, you should consider this package version unsafe - it could do very bad things to your system (it probably doesn't but you have been warned, that's why we have moderation).
- This package version can change wildly over the course of moderation until it is approved. If you install it and it later has changes to this version, you will be out of sync with any changes that have been made to the package. Until approved, you should consider that this package version doesn't even exist.
- You cannot install this package under normal scenarios. See How to install package version under moderation for more information.
- There are also no guarantees that it will be approved.
There are versions of this package awaiting moderation (possibly just this one). See the Version History section below.
This extension provides logic that can be used to debug Chocolatey packages during development.
### Triggering Debug
To initiate debugging during package runtime, either pass a debug parameter (as shown below) or set $env:ChocoPackageDebug to any non-false value.
Example:
powershell choco install <package-name> --params="'/Debug'"
You can trigger the breakpoint at various different parts of the package by providing a specific value via /Debug or $env:ChocoPackageDebug.
> NB: Values passed to the package parameter will override the environment variable.
You can set the breakpoint to a variety of predefined locations:
- Prehook: Waits before any prehook scripts are evaluated
- Posthook: Waits before any posthook scripts are evaluated
- Package: Waits before any package scripts (e.g. chocolateyInstall.ps1) are evaluated
You can provide these values by setting the environment variable, or passing them as the value of the /Debug parameter:
```powershell
$env:ChocoPackageDebug = "Prehook"
choco install <package-name>
# or
$env:ChocoPackageDebug = $null
choco install <package-name> --params"/Debug=Posthook"
```
You can also set a specific line number in the chocolateyScriptRunner.ps1 file, by setting a line number.
### Entering the Debug Session
When your package waits for your debugger, you should see output similar to the following:
plaintext Now waiting for debug connection. To enter debugging write: Enter-PSHostProcess -Id '38832' Debug-Runspace -Id '1'
You can then connect to that debugger by running those lines in a terminal.
You can also connect to this debug runtime in the PowerShell ISE or Visual Studio Code by using the PowerShell extension.
This will provide a more in-depth debugging experience, including showing the script.
#### Windows PowerShell ISE
As in the terminal above, to debug using Windows PowerShell ISE, use Enter-PSHostProcess and Debug-Runspace to enter the debugger.
#### VSCode
For VSCode, you will require the PowerShell VSCode extension.
If you then create a launch.json file within a .vscode folder in your workspace (or open the Command Palette and select Debug: Add Configuration) and create something similar to the following:
json { "version": "0.2.0", "configurations": [ { "name": "PowerShell Attach Interactive Session Runspace", "type": "PowerShell", "request": "attach", "runspaceId": 1 } ] }
You can then enter debug with F5 (by default), and select the choco PID.
> NB: Your debug tool must match the elevation of the Chocolatey process.
function Test-DebugRequest {
# We need to use $env:ChocolateyPackageParameters because Get-PackageParameters is not available here
[bool]($env:ChocoPackageDebug) -or $env:ChocolateyPackageParameters -match '/Debug[:=]?["'']?(?<Value>.+)?["'']?\b'
if ($Matches.Value) { $env:ChocoPackageDebug = $Matches.Value }
}
function Get-PatternLineNumberOrDefault($File, $Pattern, $Default) {
$m = Select-String -Path $File -Pattern $Pattern
if ($m.Count) {
$m = $m | Select-Object -First 1
$m.LineNumber
}
else {
$Default
}
}
if (Test-DebugRequest) {
$ScriptRunnerFile = Join-Path $env:ChocolateyInstall 'helpers\chocolateyScriptRunner.ps1'
$Breakpoint = switch -Regex ($env:ChocoPackageDebug) {
'^(Line[:=]?)?\d+$' { @{Line = $env:ChocoPackageDebug -replace '^(Line[:=]?)?' } }
# NOTE: default line numbers are according to chocolateyScriptRunner of Chocolatey version 2.1
# This waits before evaluating Prehook scripts
'^Prehook$' { @{Line = Get-PatternLineNumberOrDefault $ScriptRunnerFile @('if \(\$preRunHookScripts\)', '& "\$prehookscript"') 54 } }
# This waits before evaluating Package scripts
'^Package$' { @{Line = Get-PatternLineNumberOrDefault $ScriptRunnerFile @('if \(\$packageScript\)', '& "\$packageScript"') 61 } }
# This waits before evaluating Posthook scripts
'^Posthook$' { @{Line = Get-PatternLineNumberOrDefault $ScriptRunnerFile @('if \(\$postRunHookScripts\)', '& "\$postRunHookScripts"') 89 } }
# This waits at the start of Package scripts
default { @{Line = Get-PatternLineNumberOrDefault $ScriptRunnerFile '& "\$packageScript"' 63 } }
'^Debug$' {
@{Line = 1} # This is for debugging the extension.
Wait-Debugger
}
}
Set-PSBreakpoint -Script $ScriptRunnerFile @Breakpoint -Action {
Write-Host 'Now waiting for debug connection. To enter debugging write:'
Write-Host "Enter-PSHostProcess -Id '$($PID)'"
Write-Host "Debug-Runspace -Id '$([System.Management.Automation.Runspaces.Runspace]::DefaultRunSpace.Id)'"
Wait-Debugger
}
}No results available for this package. We are building up results for older packages over time so expect to see results. If this is a new package, it should have results within a day or two.
© 2023 Chocolatey Community Maintainers
This package has no dependencies.
Ground Rules:
- This discussion is only about Chocolatey Package Debug Extension and the Chocolatey Package Debug Extension package. If you have feedback for Chocolatey, please contact the Google Group.
- This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
- The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
- Tell us what you love about the package or Chocolatey Package Debug Extension, or tell us what needs improvement.
- Share your experiences with the package, or extra configuration or gotchas that you've found.
- If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
jpruskin (maintainer) on 24 Apr 2024 09:44:56 +00:00:
User 'jpruskin' (maintainer) submitted package.
chocolatey-ops (reviewer) on 24 Apr 2024 10:18:47 +00:00:
package-debug.extension has failed automated validation.
Requirements
Requirements represent the minimum quality of a package that is acceptable. When a package version has failed requirements, the package version requires fixing and/or response by the maintainer. Provided a Requirement has flagged correctly, it must be fixed before the package version can be approved. The exact same version should be uploaded during moderation review.
Guidelines
Guidelines are strong suggestions that improve the quality of a package version. These are considered something to fix for next time to increase the quality of the package. Over time Guidelines can become Requirements. A package version can be approved without addressing Guideline comments but will reduce the quality of the package.
packageSourceUrl, pointing to the url where the package source resides. This is a strong guideline because it simplifies collaboration. Please add it to the nuspec. More...jpruskin (maintainer) on 24 Apr 2024 11:03:53 +00:00:
User 'jpruskin' (maintainer) submitted package.
chocolatey-ops (reviewer) on 24 Apr 2024 11:38:53 +00:00:
package-debug.extension has failed automated validation.
Requirements
Requirements represent the minimum quality of a package that is acceptable. When a package version has failed requirements, the package version requires fixing and/or response by the maintainer. Provided a Requirement has flagged correctly, it must be fixed before the package version can be approved. The exact same version should be uploaded during moderation review.
Guidelines
Guidelines are strong suggestions that improve the quality of a package version. These are considered something to fix for next time to increase the quality of the package. Over time Guidelines can become Requirements. A package version can be approved without addressing Guideline comments but will reduce the quality of the package.