Version: v5

New-Fixture

SYNOPSIS#

This function generates two scripts, one that defines a function and another one that contains its tests.

SYNTAX#

New-Fixture [-Name] <String> [[-Path] <String>] [<CommonParameters>]

DESCRIPTION#

This function generates two scripts, one that defines a function and another one that contains its tests. The files are by default placed in the current directory and are called and populated as such:

The script defining the function: .\Clean.ps1:

function Clean {
#Do something
$true
}

The script containing the example test .\Clean.Tests.ps1:

BeforeAll {
.
$PSCommandPath.Replace('.Tests.ps1', '.ps1')
}
Describe "Clean" {
It "Returns expected output" {
Clean | Should -Be $true
}
}

EXAMPLES#

EXAMPLE 1#

New-Fixture -Name Clean

Creates the scripts in the current directory.

EXAMPLE 2#

New-Fixture C:\Projects\Cleaner Clean

Creates the scripts in the C:\Projects\Cleaner directory.

EXAMPLE 3#

New-Fixture Cleaner Clean

Creates a new folder named Cleaner in the current directory and creates the scripts in it.

PARAMETERS#

-Name#

Defines the name of the function and the name of the test to be created.

Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Path#

Defines path where the test and the function should be created, you can use full or relative path. If the parameter is not specified the scripts are created in the current directory.

Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: $PWD
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters#

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS#

OUTPUTS#

NOTES#

RELATED LINKS#

https://pester.dev/docs/commands/New-Fixture

https://pester.dev/docs/commands/Describe

https://pester.dev/docs/commands/Context

https://pester.dev/docs/commands/It

https://pester.dev/docs/commands/Should

EDIT THIS PAGE#

This page was auto-generated using the comment based help in Pester 5.1.1. To edit the content of this page, change the corresponding help in the pester/Pester repository. See our contribution guide for more information.