PowerShell Debugging Examples

_README.MD

Debugging Examples

Maslow's Hierarchy of PowerShell Debugging

Debug.Tests.ps1

Describe "Debugging Examples" {
	It 'Labs get Treats' {
		$recommendedTreat = & $PSScriptRoot/Get-DogTreat.ps1 -DogBreed 'Labrador' -SuperBugged
		$recommendedTreat.Calories | Should -BeGreaterThan 0
	}
}

debugMe.ps1

# Example 1: Using Write-Host for basic debugging
Write-Host 'Debug: Starting script execution' -ForegroundColor Yellow
$someVariable = 'Test Value'
Write-Host "Debug: someVariable = $someVariable" -ForegroundColor Cyan

# Example 2: Using [Console]::WriteLine (useful in non-console contexts)
[Console]::WriteLine('Debug: Direct console output')
[Console]::WriteLine('Debug: Current time: {0}', (Get-Date))

# Example 3: Using Wait-Debugger (PowerShell 5.0+)
$i = 1
while ($i -le 3) {
	Write-Output "Current iteration: $i"
	Wait-Debugger # Script will break here
	$i++
}

# Example 4: Using Set-PSBreakpoint
# Break on line
$breakOnLine = Set-PSBreakpoint -Line 20 -Script $PSCommandPath

# Break when variable changes
$breakOnVariable = Set-PSBreakpoint -Variable someVariable -Mode Write

# Break when a command is called
$breakOnCommand = Set-PSBreakpoint -Command Write-Output

# Break when expression evaluates to true
$breakOnExpression = Set-PSBreakpoint -Script $PSCommandPath -Action {
	if ($someVariable -eq 'New Value') { break }
}

# Break on specific script block
$breakOnScriptBlock = Set-PSBreakpoint -Script $PSCommandPath -Action {
	Write-Host 'Breakpoint hit!' -ForegroundColor Red
	break
} -Line 1 -Column 1

# Break when accessing a property
$breakOnProperty = Set-PSBreakpoint -Script $PSCommandPath -Variable someVariable -Mode Read, Write

# Example function to demonstrate debugging
function Test-Debugging {
	Write-Output 'Starting function'
	$someVariable = 'New Value'
	Write-Output 'Ending function'
}

# Run the function
Test-Debugging

# Cleanup breakpoints
Get-PSBreakpoint | Remove-PSBreakpoint

Get-DogTreat.ps1

param(
	[Parameter(Mandatory)][string]$DogBreed,
	[switch]$Bugged,
	[switch]$SuperBugged
)

$DogTreats = @{
	'labrador'        = @{
		Name            = 'Large Milk Bone'
		Calories        = 100
		MeatIngredients = @('🍗', '🥩')
	}
	'chihuahua'       = @{
		Name            = 'Small Dental Chew'
		Calories        = 50
		MeatIngredients = @('🐑')
	}
	'german shepherd' = @{
		Name            = 'Large Rawhide Bone'
		Calories        = 120
		MeatIngredients = @('🍗')
	}
	'poodle'          = @{
		Name            = 'Medium Dental Stick'
		Calories        = 80
		MeatIngredients = @('🐑', '🍗')
	}
}

$DogTreats | ForEach-Object {
	# Add some 🧈
	$PSItem.Calories += 200
}

function Get-🍬for🐶 ($DogBreed) {
	$breed = $DogBreed.ToLower()
	if ($DogTreats.ContainsKey($breed)) {
		return $DogTreats[$breed]
	} else {
		return @{
			Name            = 'Standard Dog Biscuit'
			Calories        = 70
			MeatIngredients = @('🍗')
		}
	}
}

$recommendedTreat = Get-🍬for🐶 -DogBreed $DogBreed

if ($bugged) {
	$recommendedTreat = @{
		Name            = 'Nasty Gross Things 🤮'
		Calories        = 0
		MeatIngredients = @('Not 🥩', 'Lots of 🥦')
	}
}

if ($SuperBugged) {
	$recommendedTreat.Calories = -1
}

if ($recommendedTreat.Calories -le 0) {
	throw "😈😈😈Dogs Don't Deserve Treats😈😈😈"
}


return $recommendedTreat

zImage.png