Public/New-PSPesterTest.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<#
.SYNOPSIS
Creates a new Pester Test file.
 
.DESCRIPTION
Function to scaffold the structure of a test file for Pester tests.
 
.PARAMETER Name
The name of the function to create a test for.
 
.PARAMETER Module
The name of a module, or the parent path of a module manifest.
 
.PARAMETER Scope
The scope of the function according to Redeploy scaffolding standards. Allowed values: Private and Public. Default: Public.
 
.EXAMPLE
To create a new Pester test for the function New-Action in Module 'MyModule', by Module name, and place it in the public scope.
 
New-REPesterTest -Name New-Action -Module MyModule
 
.EXAMPLE
To create a new Pester test for the function New-Action in Module 'MyModule', by Module path, and place it in the public scope.
 
New-PSPesterTest -Name New-Action -Module C:\Users\JohnSmith\Documents\Projects\Modules\MyModule
 
.NOTES
    Written by Karl Wallenius, Redeploy AB.
#>

function New-PSPesterTest {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory = $true, Position = 0)]
        [string]
        $Name,
        [Parameter(Mandatory = $false, Position = 1)]
        [string]
        $Module,
        [Parameter(Mandatory = $false, Position = 2)]
        [ValidateSet('Private', 'Public')]
        [string]
        $Scope = "Public"
    )

    process {

        $TemplatesPath = Merge-Path $PSScriptRoot, "..", "templates"
        . (Merge-Path $TemplatesPath, "t_pestertest.ps1")

        $modulePath = Get-ModulePath -Path $Module
        $moduleName = Split-Path $modulePath -Leaf
        
        $fileName = $Name + ".Tests.ps1"
        $filePath = Merge-Path $modulePath, "Tests", $Scope, $fileName

        Write-Verbose "Creating test file template..."
        $PesterFileContent -replace "<module>", "$moduleName" -replace "<scope>","$Scope" -replace "<name>", "$Name" | 
            Out-File $filePath -Encoding utf8
        Write-Verbose "Test file template is done."
    }
}