New-PesterTests.ps1

<#
.SYNOPSIS
Creates a new Pester testing script from a script's examples and parameter sets.

.FUNCTIONALITY
Scripts

.EXAMPLE
New-PesterTests.ps1 New-PesterTests.ps1

Creates .\test\New-PesterTests.Tests.ps1 with some boilerplate Pester code.
#>

#Requires -Version 3
#Requires -Modules ModernConveniences
using module ModernConveniences
[CmdletBinding()] Param(
# The script to generate tests for.
[Parameter(ParameterSetName='Script',Position=0,Mandatory=$true,ValueFromPipeline=$true)]
[ValidateScript({Test-Path $_ -Type Leaf})][string] $Script,
# The directory to generate tests in.
[ValidateScript({Test-Path $_ -Type Container})][string] $Directory = 'test',
# Overwrite an existing tests file.
[Parameter(ParameterSetName='Script')][switch] $Force,
# Indicates that the next script that's missing a test script file should have one created.
[Parameter(ParameterSetName='Next',Mandatory=$true)][switch] $Next
)
Begin
{
	if($PSCmdlet.ParameterSetName -eq 'Next')
	{
		if(!$Next) {return}
		else
		{
			$nextScript = Get-Item *.ps1 |
				Where-Object {!(Join-Path $Directory ([io.path]::ChangeExtension($_.Name,'Tests.ps1')) |Test-Path -Type Leaf)} |
				Select-Object -First 1
			if(!$nextScript)
			{
				ModernConveniences\Write-Info 'Congratulations, all of the scripts in this directory have test files.' -ForegroundColor Green
				return
			}
			else
			{
				ModernConveniences\Write-Info "Creating new tests script for $nextScript" -ForegroundColor Green
				return &$PSCommandPath -Script $nextScript -Directory $Directory
			}
		}
	}
	$Script:NL = [Environment]::NewLine

	filter Format-ExampleTest
	{
		Param(
		[Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true)][string] $Title,
		[Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true)][psobject[]] $Introduction,
		[Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true)][string] $Code,
		[Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true)][psobject[]] $Remarks
		)
		$cmdtext = (($Introduction |Where-Object Text -notin 'PS > ',' ','',$null |Select-Object -ExpandProperty Text) -join $NL) + $Code
		$output = ($Remarks |Where-Object {$_.Text} |Select-Object -ExpandProperty Text) -join $NL
		return @"
		It "$($Title.Trim(' -'))" -Skip {
			$cmdtext |Should -BeExactly @"
$output
$('"@')
		}
"@
	}

	filter Format-ParameterSetContext
	{
		Param(
		[Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true)][ValidateNotNullOrEmpty()][string] $Name
		)
		if([string]::IsNullOrWhiteSpace($Name)) {return}
		return @"
	Context '$Name' -Tag $Name {
		It "test" -Skip {
			1 |Should -Be 1
		}
	}
"@
	}

	filter Format-ScriptPesterTest
	{
		Param(
		[Parameter(Position=0,Mandatory=$true)][string] $Name,
		[Parameter(Position=0,Mandatory=$true)][Management.Automation.CommandInfo] $CmdInfo,
		[Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true)][string] $Synopsis,
		[Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true)][psobject[]] $Examples
		)
		$shortname = Split-Path $Name -LeafBase
		$Local:OFS = $NL
		return @"
<#
.SYNOPSIS
Tests $Synopsis
#>

`$basename = "`$((`$MyInvocation.MyCommand.Name -split '\.',2)[0])."
`$skip = !(Test-Path .changes -Type Leaf) ? `$false :
	!@(Get-Content .changes |Get-Item |Select-Object -ExpandProperty Name |Where-Object {`$_.StartsWith(`$basename)})
if(`$skip) {Write-Information "No changes to `$basename" -infa Continue}
Describe '$shortname' -Tag $shortname -Skip:`$skip {
	BeforeAll {
		`$scriptsdir,`$sep = (Split-Path `$PSScriptRoot),[io.path]::PathSeparator
		if(`$scriptsdir -notin (`$env:Path -split `$sep)) {`$env:Path += "`$sep`$scriptsdir"}
	}
	Context '$($Synopsis -replace "'","''")' -Tag Example {
$($Examples.example |Format-ExampleTest)
	}
$($CmdInfo.ParameterSets |Where-Object Name -ne __AllParameterSets |Format-ParameterSetContext)
}
"@
	}
}
Process
{
	if($PSCmdlet.ParameterSetName -eq 'Next') {return}
	$name = Split-Path $Script -Leaf
	$cmd = Resolve-Path $Script |Get-Command
	$testfile = Join-Path $Directory ([io.path]::ChangeExtension($name,'Tests.ps1'))
	if((Test-Path $testfile -Type Leaf) -and !$Force)
	{
		ModernConveniences\Stop-ThrowError "File '$testfile' already exists" -Argument Script
	}
	Get-Help (Resolve-Path $Script) |
		Format-ScriptPesterTest -Name $name -CmdInfo $cmd |
		Out-File $testfile -Encoding utf8BOM
	if((Get-Variable psEditor -Scope Global -ErrorAction Ignore) -and (Test-Path $testfile -Type Leaf))
	{
		$psEditor.Workspace.OpenFile($Script, $false)
		$psEditor.Workspace.OpenFile($testfile, $false)
	}
}