Export (0) Print
Expand All

Test-ModuleManifest

Updated: August 9, 2015

Test-ModuleManifest

Verifies that a module manifest file accurately describes the contents of a module.

Syntax

Parameter Set: Default
Test-ModuleManifest [-Path] <String> [ <CommonParameters>]




Detailed Description

The Test-ModuleManifest cmdlet verifies that the files that are listed in the module manifest (.psd1) file are actually in the specified paths.

This cmdlet is designed to help module authors test their manifest files. Module users can also use this cmdlet in scripts and commands to detect errors before they run scripts that depend on the module.

Test-ModuleManifest returns an object that represents the module. This is the same type of object that Get-Module returns. If any files are not in the locations specified in the manifest, the cmdlet also generates an error for each missing file.

Parameters

-Path<String>

Specifies a path and file name for the manifest file. Enter an optional path and name of the module manifest file that has the .psd1 file name extension. The default location is the current directory. Wildcard characters are supported, but must resolve to a single module manifest file. This parameter is required. You can also pipe a path to Test-ModuleManifest.


Aliases

none

Required?

true

Position?

1

Default Value

None

Accept Pipeline Input?

true (ByValue, ByPropertyName)

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

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String

    You can pipe the path to a module manifest to this cmdlet.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.Management.Automation.PSModuleInfo

    This cmdlet returns a PSModuleInfo object that represents the module. It returns this object even if the manifest has errors.


Examples

Example 1: Test a manifest

This command tests the TestModule.psd1 module manifest.


PS C:\> test-ModuleManifest -Path "$pshome\Modules\TestModule.psd1"

Example 2: Test a manifest by using the pipeline

This command uses a pipeline operator (|) to send a path string to Test-ModuleManifest.

The command output shows that the test failed, because the TestTypes.ps1xml file, which was listed in the manifest, was not found.


PS C:\> "$pshome\Modules\TestModule.psd1" | test-modulemanifest

Example 3: Write a function to test a module manifest

This function is like Test-ModuleManifest, but it returns a Boolean value. The function returns $True if the manifest passed the test and $False otherwise.

The function uses the Get-ChildItem cmdlet, alias = dir, to get the module manifest specified by the $path variable. The command uses a pipeline operator (|) to pass the file object to Test-ModuleManifest.

Test-ModuleManifest uses the ErrorAction common parameter with a value of SilentlyContinue to suppress the display of any errors that the command generates. It also saves the PSModuleInfo object that Test-ModuleManifest returns in the $a variable. Therefore, the object is not displayed.

Then, in a separate command, the function displays the value of the $? automatic variable. If the previous command generates no error, the command displays $True, and $False otherwise.

You can use this function in conditional statements, such as those that might precede an Import-Module command or a command that uses the module.


PS C:\> function Test-ManifestBool ($path)
{$a = dir $path | Test-ModuleManifest -ErrorAction SilentlyContinue $?}

Related topics

Community Additions

ADD
Show:
© 2016 Microsoft