Skip to content

Invoke-ModuleTestSuite.md

Latest commit

 

History

History
301 lines (238 loc) · 6.44 KB

Invoke-ModuleTestSuite.md

File metadata and controls

301 lines (238 loc) · 6.44 KB
Raw
external help file PSPublishModule-help.xml
Module Name PSPublishModule
online version https://github.com/EvotecIT/PSPublishModule
schema 2.0.0

Invoke-ModuleTestSuite

SYNOPSIS

Complete module testing suite that handles dependencies, imports, and test execution.

SYNTAX

__AllParameterSets

Invoke-ModuleTestSuite [-ProjectPath <string>] [-AdditionalModules <string[]>] [-SkipModules <string[]>] [-TestPath <string>] [-OutputFormat <ModuleTestSuiteOutputFormat>] [-TimeoutSeconds <int>] [-EnableCodeCoverage] [-Force] [-ExitOnFailure] [-SkipDependencies] [-SkipImport] [-PassThru] [-CICD] [-ShowFailureSummary] [-FailureSummaryFormat <ModuleTestSuiteFailureSummaryFormat>] [<CommonParameters>]

DESCRIPTION

Executes module tests out-of-process, installs required dependencies, and provides a summary that is suitable for both local development and CI pipelines.

For post-processing failures (e.g. emitting JSON summaries), combine it with Get-ModuleTestFailures.

EXAMPLES

EXAMPLE 1

PS> Invoke-ModuleTestSuite -ProjectPath 'C:\Git\MyModule'

Runs tests under the module project folder, installs dependencies, and prints a summary.

EXAMPLE 2

PS> Invoke-ModuleTestSuite -ProjectPath 'C:\Git\MyModule' -CICD -PassThru

Optimizes output for CI and returns a structured result object.

EXAMPLE 3

PS> Invoke-ModuleTestSuite -ProjectPath 'C:\Git\MyModule' -PassThru | Get-ModuleTestFailures -OutputFormat Summary

Produces a concise failure summary that can be used in CI logs.

PARAMETERS

-AdditionalModules

Additional modules to install beyond those specified in the manifest.

Type: String[]
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-CICD

Enable CI/CD mode with optimized settings and output.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-EnableCodeCoverage

Enable code coverage analysis during tests.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-ExitOnFailure

Set a non-zero process exit code when tests fail.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-FailureSummaryFormat

Format for failure summary display.

Type: ModuleTestSuiteFailureSummaryFormat
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Summary, Detailed

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Force

Force reinstall of modules and reimport of the target module.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-OutputFormat

Test output format.

Type: ModuleTestSuiteOutputFormat
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Detailed, Normal, Minimal

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PassThru

Return the test suite result object.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-ProjectPath

Path to the PowerShell module project directory.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-ShowFailureSummary

Display detailed failure analysis when tests fail.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-SkipDependencies

Skip dependency checking and installation.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-SkipImport

Skip module import step.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-SkipModules

Array of module names to skip during installation.

Type: String[]
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-TestPath

Custom path to test files (defaults to Tests folder in project).

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-TimeoutSeconds

Timeout for the out-of-process test execution, in seconds.

Type: Int32
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

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

  • None

OUTPUTS

  • System.Object

RELATED LINKS

  • None