Ansible
PS DSC
Downloads:
64
Downloads of v 1.0.0:
64
Last Update:
17 Jun 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
Package Debug Extension
- 1
- 2
- 3
1.0.0 | Updated: 17 Jun 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:
64
Downloads of v 1.0.0:
64
Maintainer(s):
Software Author(s):
- jpruskin schusterfredl lindbergbrewery
Package Debug Extension 1.0.0
Legal Disclaimer: Neither this package nor Chocolatey Software, Inc. are affiliated with or endorsed by jpruskin schusterfredl lindbergbrewery. The inclusion of jpruskin schusterfredl lindbergbrewery trademark(s), if any, upon this webpage is solely to identify jpruskin schusterfredl lindbergbrewery goods or services and not for commercial purposes.
- 1
- 2
- 3
All Checks are Passing
3 Passing Tests
Deployment Method: Individual Install, Upgrade, & Uninstall
To install Package Debug Extension, run the following command from the command line or from PowerShell:
To upgrade Package Debug Extension, run the following command from the command line or from PowerShell:
To uninstall Package Debug Extension, run the following command from the command line or from PowerShell:
Deployment Method:
This applies to both open source and commercial editions of Chocolatey.
1. Enter Your Internal Repository Url
(this should look similar to https://community.chocolatey.org/api/v2/)
2. Setup Your Environment
1. Ensure you are set for organizational deployment
Please see the organizational deployment guide
2. Get the package into your environment
Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)-
Open Source or Commercial:
- Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
- You can also just download the package and push it to a repository Download
-
Open Source
-
Download the package:
Download - Follow manual internalization instructions
-
-
Package Internalizer (C4B)
-
Run: (additional options)
choco download package-debug.extension --internalize --source=https://community.chocolatey.org/api/v2/ -
For package and dependencies run:
choco push --source="'INTERNAL REPO URL'" - Automate package internalization
-
Run: (additional options)
3. Copy Your Script
choco upgrade package-debug.extension -y --source="'INTERNAL REPO URL'" [other options]See options you can pass to upgrade.
See best practices for scripting.
Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.
If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:
choco upgrade package-debug.extension -y --source="'INTERNAL REPO URL'"
$exitCode = $LASTEXITCODE
Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
Exit 0
}
Exit $exitCode
- name: Install package-debug.extension
win_chocolatey:
name: package-debug.extension
version: '1.0.0'
source: INTERNAL REPO URL
state: present
See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.
chocolatey_package 'package-debug.extension' do
action :install
source 'INTERNAL REPO URL'
version '1.0.0'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
cChocoPackageInstaller package-debug.extension
{
Name = "package-debug.extension"
Version = "1.0.0"
Source = "INTERNAL REPO URL"
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'package-debug.extension':
ensure => '1.0.0',
provider => 'chocolatey',
source => 'INTERNAL REPO URL',
}
Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.
4. If applicable - Chocolatey configuration/installation
See infrastructure management matrix for Chocolatey configuration elements and examples.
This package was approved by moderator flcdrg on 18 Jun 2024.
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:
choco install package-id --params="'/Debug'"
You can trigger the breakpoint at various different parts of the package by providing a specific value via /Debug or $env:ChocoPackageDebug.
Note: 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 evaluatedPosthook: Waits before any posthook scripts are evaluatedPackage: 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:
$env:ChocoPackageDebug = "Prehook"
choco install package-id
# or
$env:ChocoPackageDebug = $null
choco install package-id --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:
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:
{
"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.
Note: 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
}
}Log in or click on link to see number of positives.
In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).
Chocolatey Pro provides runtime protection from possible malware.
This package has no dependencies.
Ground Rules:
- This discussion is only about Package Debug Extension and the 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 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.