Marco Blessing
6a314eeb48
#### 📖 Summary - Adds `platyPS` generated docs - Converted CRLF output into LF - linked global readme file in module page #### 📑 Test Plan > 💡 Select your test plan for the code changes. - [x] Tested via Drone.io pipeline - [ ] Custom test - [ ] No test plan ##### Details / Justification <!-- Add your test details or justification for missing tests here. --> #### 📚 Additional Notes <!-- A place for additional detail notes. --> Co-authored-by: OCram85 <marco.blessing@googlemail.com> Reviewed-on: #5
2.4 KiB
| external help file | Module Name | online version | schema |
|---|---|---|---|
| ModuleRoot-help.xml | DroneHelper | 2.0.0 |
Invoke-UnitTest
SYNOPSIS
Runs all Pester tests within this repo.
SYNTAX
Invoke-UnitTest [[-CoverageFormat] <String>] [[-Verbosity] <String>] [-PassThru] [[-Tag] <String[]>]
[[-ExcludeTag] <String[]>] [<CommonParameters>]
DESCRIPTION
This Cmdlet is used in Drone pipeline to perform the Pester based unit tests.
EXAMPLES
EXAMPLE 1
Invoke-UnitTest
PARAMETERS
-CoverageFormat
Pester provides the formats JaCoCo ans CoverageGutters. Default is JaCoCo. These are the known use cases:
- JaCoCo -> Used as standard coverage report used by sonar
- CoverageGutters -> Custom Format to show coverage in VSCode.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: JaCoCo
Accept pipeline input: False
Accept wildcard characters: False
-ExcludeTag
Pester build in exclude filter for tests as string array.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
Tells Invoke-UnitTest to write back the Pester results into your variable / output.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Tag
Pester build in tag filter as string array.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Verbosity
This parameter sets the Pester detail level. Default is 'Normal.' Available values are: 'None', 'Normal', 'Detailed', 'Diagnostic'
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: Normal
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.