mirror of
https://github.com/PowerShell/PowerShell
synced 2026-06-08 12:12:50 +00:00
560 lines
16 KiB
PowerShell
560 lines
16 KiB
PowerShell
Describe 'get-help HelpFunc1' -Tags "CI" {
|
||
|
||
BeforeAll {
|
||
function TestHelpError {
|
||
[CmdletBinding()]
|
||
param(
|
||
$x,
|
||
[System.Management.Automation.ErrorRecord[]]$e,
|
||
[string] $expectedError
|
||
)
|
||
It 'Help result should be $null' { $x | Should Be $null }
|
||
It '$e.Count' { $e.Count | Should BeGreaterThan 0 }
|
||
It 'FullyQualifiedErrorId' { $e[0].FullyQualifiedErrorId | Should Be $expectedError }
|
||
}
|
||
|
||
function TestHelpFunc1 {
|
||
[CmdletBinding()]
|
||
param( $x )
|
||
It '$x should not be $null' { $x | Should Not Be $null }
|
||
It '$x.Synopsis' { $x.Synopsis | Should Be "A relatively useless function." }
|
||
It '$x.Description' { $x.Description[0].Text | Should Be "A description`n`n with indented text and a blank line." }
|
||
It '$x.alertSet.alert' { $x.alertSet.alert[0].Text | Should Be "This function is mostly harmless." }
|
||
It '$x.relatedLinks.navigationLink[0].uri' { $x.relatedLinks.navigationLink[0].uri | Should Be "http://blogs.msdn.com/powershell" }
|
||
It '$x.relatedLinks.navigationLink[1].linkText' { $x.relatedLinks.navigationLink[1].linkText | Should Be "other commands" }
|
||
It '$x.examples.example.code' { $x.examples.example.code | Should Be "If you need an example, you're hopeless." }
|
||
It '$x.inputTypes.inputType.type.name‘ { $x.inputTypes.inputType.type.name | Should Be "Anything you like." }
|
||
It '$x.returnValues.returnValue.type.name' { $x.returnValues.returnValue.type.name | Should Be "Nothing." }
|
||
It '$x.Component' { $x.Component | Should Be "Something" }
|
||
It '$x.Role' { $x.Role | Should Be "CrazyUser" }
|
||
It '$x.Functionality' { $x.Functionality | Should Be "Useless" }
|
||
}
|
||
|
||
# .SYNOPSIS
|
||
#
|
||
# A relatively useless function.
|
||
#
|
||
# .DESCRIPTION
|
||
#
|
||
# A description
|
||
#
|
||
# with indented text and a blank line.
|
||
#
|
||
# .NOTES
|
||
#
|
||
# This function is mostly harmless.
|
||
#
|
||
# .LINK
|
||
#
|
||
# http://blogs.msdn.com/powershell
|
||
#
|
||
# .LINK
|
||
#
|
||
# other commands
|
||
#
|
||
# .EXAMPLE
|
||
#
|
||
# If you need an example, you're hopeless.
|
||
#
|
||
# .INPUTS
|
||
#
|
||
# Anything you like.
|
||
#
|
||
# .OUTPUTS
|
||
#
|
||
# Nothing.
|
||
#
|
||
# .COMPONENT
|
||
#
|
||
# Something
|
||
#
|
||
# .ROLE
|
||
#
|
||
# CrazyUser
|
||
#
|
||
# .FUNCTIONALITY
|
||
#
|
||
# Useless
|
||
#
|
||
function helpFunc1 {}
|
||
}
|
||
|
||
|
||
Context 'Get-Help helpFunc1' {
|
||
$x = get-help helpFunc1
|
||
TestHelpFunc1 $x
|
||
}
|
||
|
||
Context 'get-help helpFunc1 -component blah' {
|
||
$x = get-help helpFunc1 -component blah -ea SilentlyContinue -ev e
|
||
TestHelpError $x $e 'HelpNotFound,Microsoft.PowerShell.Commands.GetHelpCommand'
|
||
}
|
||
|
||
Context 'get-help helpFunc1 -component Something' {
|
||
$x = get-help helpFunc1 -component Something -ea SilentlyContinue -ev e
|
||
TestHelpFunc1 $x
|
||
It '$e should be empty' { $e.Count | Should Be 0 }
|
||
}
|
||
|
||
Context 'get-help helpFunc1 -role blah' {
|
||
$x = get-help helpFunc1 -component blah -ea SilentlyContinue -ev e
|
||
TestHelpError $x $e 'HelpNotFound,Microsoft.PowerShell.Commands.GetHelpCommand'
|
||
}
|
||
|
||
Context 'get-help helpFunc1 -role CrazyUser' {
|
||
$x = get-help helpFunc1 -role CrazyUser -ea SilentlyContinue -ev e
|
||
TestHelpFunc1 $x
|
||
It '$e should be empty' { $e.Count | Should Be 0 }
|
||
}
|
||
|
||
Context '$x = get-help helpFunc1 -functionality blah' {
|
||
$x = get-help helpFunc1 -functionality blah -ea SilentlyContinue -ev e
|
||
TestHelpError $x $e 'HelpNotFound,Microsoft.PowerShell.Commands.GetHelpCommand'
|
||
}
|
||
|
||
Context '$x = get-help helpFunc1 -functionality Useless' {
|
||
$x = get-help helpFunc1 -functionality Useless -ea SilentlyContinue -ev e
|
||
TestHelpFunc1 $x
|
||
It '$e should be empty' { $e.Count | Should Be 0 }
|
||
}
|
||
}
|
||
|
||
Describe 'get-help file' -Tags "CI" {
|
||
BeforeAll {
|
||
try {
|
||
$tmpfile = [IO.Path]::ChangeExtension([IO.Path]::GetTempFileName(), "ps1")
|
||
} catch {
|
||
return
|
||
}
|
||
}
|
||
|
||
AfterAll {
|
||
remove-item $tmpfile -Force -ea silentlycontinue
|
||
}
|
||
|
||
Context 'get-help file1' {
|
||
|
||
@'
|
||
# .SYNOPSIS
|
||
# Function help, not script help
|
||
function foo
|
||
{
|
||
}
|
||
|
||
get-help foo
|
||
'@ > $tmpfile
|
||
|
||
$x = get-help $tmpfile
|
||
It '$x should not be $null' { $x | Should Not Be $null }
|
||
$x = & $tmpfile
|
||
It '$x.Synopsis' { $x.Synopsis | Should Be 'Function help, not script help' }
|
||
}
|
||
|
||
Context 'get-help file2' {
|
||
|
||
# Note - 2 blank lines below are intentional, do not delete
|
||
@'
|
||
# .SYNOPSIS
|
||
# Script help, not function help
|
||
|
||
|
||
function foo
|
||
{
|
||
}
|
||
|
||
get-help foo
|
||
'@ > $tmpfile
|
||
|
||
$x = get-help $tmpfile
|
||
It '$x.Synopsis' { $x.Synopsis | Should Be 'Script help, not function help' }
|
||
$x = & $tmpfile
|
||
It '$x should not be $null' { $x | Should Not Be $null }
|
||
}
|
||
}
|
||
|
||
Describe 'get-help other tests' -Tags "CI" {
|
||
|
||
BeforeAll {
|
||
try {
|
||
$tempFile = [IO.Path]::ChangeExtension([IO.Path]::GetTempFileName(), "ps1")
|
||
} catch {
|
||
return
|
||
}
|
||
}
|
||
|
||
AfterAll {
|
||
remove-item $tempFile -Force -ea silentlycontinue
|
||
}
|
||
|
||
Context 'get-help missingHelp' {
|
||
# Blank lines here are important, do not adjust the formatting, remove blank lines, etc.
|
||
|
||
<#
|
||
.SYNOPSIS
|
||
This help block doesn't belong to any function because it is more than 1 line away from the function.
|
||
#>
|
||
|
||
|
||
function missingHelp { param($abc) }
|
||
$x = get-help missingHelp
|
||
It '$x should not be $null' { $x | Should Not Be $null }
|
||
It '$x.Synopsis' { $x.Synopsis.Trim() | Should Be 'missingHelp [[-abc] <Object>]' }
|
||
}
|
||
|
||
Context 'get-help helpFunc2' {
|
||
|
||
<#
|
||
.SYNOPSIS
|
||
This help block goes on helpFunc2
|
||
#>
|
||
|
||
function helpFunc2 { param($abc) }
|
||
|
||
$x = get-help helpFunc2
|
||
It '$x should not be $null' { $x | Should Not Be $null }
|
||
It '$x.Synopsis' { $x.Synopsis.Trim() | Should Be 'This help block goes on helpFunc2' }
|
||
}
|
||
|
||
Context 'get-help file and get-help helpFunc2' {
|
||
$script = @"
|
||
<#
|
||
.SYNOPSIS
|
||
This is script help
|
||
#>
|
||
|
||
<#
|
||
.SYNOPSIS
|
||
This is function help for helpFunc2
|
||
#>
|
||
function helpFunc2 {}
|
||
|
||
get-help helpFunc2
|
||
"@
|
||
|
||
Set-Content $tempFile $script
|
||
$x = get-help $tempFile
|
||
It '$x.Synopsis' { $x.Synopsis | Should Be "This is script help" }
|
||
|
||
$x = & $tempFile
|
||
It '$x.Synopsis' { $x.Synopsis | Should Be "This is function help for helpFunc2" }
|
||
}
|
||
|
||
Context 'get-help file and get-help helpFunc2' {
|
||
$script = @"
|
||
#
|
||
# .SYNOPSIS
|
||
# This is script help
|
||
#
|
||
|
||
#
|
||
# .SYNOPSIS
|
||
# This is function help for helpFunc2
|
||
#
|
||
function helpFunc2 {}
|
||
|
||
get-help helpFunc2
|
||
"@
|
||
|
||
Set-Content $tempFile $script
|
||
$x = get-help $tempFile
|
||
It $x.Synopsis { $x.Synopsis | Should Be "This is script help" }
|
||
|
||
$x = & $tempFile
|
||
It $x.Synopsis { $x.Synopsis | Should Be "This is function help for helpFunc2" }
|
||
}
|
||
|
||
Context 'get-help psuedo file' {
|
||
|
||
$script = @'
|
||
###########################################
|
||
#
|
||
# Psuedo-Copyright header comment
|
||
#
|
||
###########################################
|
||
|
||
#requires -version 2.0
|
||
|
||
#
|
||
# .Synopsis
|
||
# Changes Admin passwords across all KDE servers.
|
||
#
|
||
[CmdletBinding(DefaultParameterSetName="Live")]
|
||
param(
|
||
[Parameter(
|
||
ParameterSetName="Live",
|
||
Mandatory=$true)]
|
||
$live,
|
||
[Parameter(
|
||
ParameterSetName="Test",
|
||
Mandatory=$true)]
|
||
$test)
|
||
'@
|
||
|
||
Set-Content $tempFile $script
|
||
$x = get-help $tempFile
|
||
|
||
It '$x.Synopsis' { $x.Synopsis | Should Be "Changes Admin passwords across all KDE servers." }
|
||
It '$x.parameters.parameter[0].required' { $x.parameters.parameter[0].required | Should Be $true}
|
||
It '$x.syntax.syntaxItem[0].parameter.required' { $x.syntax.syntaxItem[0].parameter.required | Should Be $true}
|
||
It '$x.syntax.syntaxItem[0].parameter.parameterValue.required' { $x.syntax.syntaxItem[0].parameter.parameterValue.required | Should Be $true}
|
||
It 'Common parameters should not be appear in the syntax' { $x.Syntax -like "*verbose*" | Should Be $false }
|
||
It 'Common parameters should not be in syntax maml' {@($x.syntax.syntaxItem[0].parameter).Count | Should Be 1}
|
||
It 'Common parameters should also not appear in parameters maml' { $x.parameters.parameter.Count | Should Be 2}
|
||
}
|
||
|
||
It 'helpFunc3 -?' {
|
||
|
||
##############################################
|
||
|
||
function helpFunc3()
|
||
{
|
||
#
|
||
#
|
||
#.Synopsis
|
||
#
|
||
# A synopsis of helpFunc3.
|
||
#
|
||
#
|
||
}
|
||
|
||
$x = helpFunc3 -?
|
||
$x.Synopsis | Should Be "A synopsis of helpFunc3."
|
||
}
|
||
|
||
It 'get-help helpFunc4' {
|
||
|
||
<#
|
||
.Description
|
||
description
|
||
|
||
.Synopsis
|
||
|
||
|
||
.Component
|
||
component
|
||
#>
|
||
function helpFunc4()
|
||
{
|
||
}
|
||
|
||
$x = get-help helpFunc4
|
||
$x.Synopsis | Should Be ""
|
||
}
|
||
|
||
Context 'get-help helpFunc5' {
|
||
|
||
function helpFunc5
|
||
{
|
||
# .EXTERNALHELP scriptHelp.Tests.xml
|
||
}
|
||
$x = get-help helpFunc5
|
||
It '$x should not be $null' { $x | Should Not Be $null }
|
||
It '$x.Synopsis' { $x.Synopsis | Should Be "A useless function, really." }
|
||
}
|
||
|
||
Context 'get-help helpFunc6 script help xml' {
|
||
function helpFunc6
|
||
{
|
||
# .EXTERNALHELP scriptHelp1.xml
|
||
}
|
||
if ($PSUICulture -ieq "en-us")
|
||
{
|
||
$x = get-help helpFunc6
|
||
It '$x should not be $null' { $x | Should Not Be $null }
|
||
It '$x.Synopsis' { $x.Synopsis | Should Be "Useless. Really, trust me on this one." }
|
||
}
|
||
}
|
||
|
||
Context 'get-help helpFunc6 script help xml' {
|
||
function helpFunc6
|
||
{
|
||
# .EXTERNALHELP newbase/scriptHelp1.xml
|
||
}
|
||
if ($PSUICulture -ieq "en-us")
|
||
{
|
||
$x = get-help helpFunc6
|
||
It '$x should not be $null' { $x | Should Not Be $null }
|
||
It '$x.Synopsis' { $x.Synopsis | Should Be "Useless in newbase. Really, trust me on this one." }
|
||
}
|
||
}
|
||
|
||
Context 'get-help helpFunc7' {
|
||
|
||
function helpFunc7
|
||
{
|
||
# .FORWARDHELPTARGETNAME Get-Help
|
||
# .FORWARDHELPCATEGORY Cmdlet
|
||
}
|
||
$x = Get-Help helpFunc7
|
||
It '$x.Name' { $x.Name | Should Be 'Get-Help' }
|
||
It '$x.Category' { $x.Category | Should Be 'Cmdlet' }
|
||
|
||
# Make sure help is a function, or the test would fail
|
||
if ($null -ne (get-command -type Function help))
|
||
{
|
||
if ((get-content function:help) -match "FORWARDHELP")
|
||
{
|
||
$x = Get-Help help
|
||
It '$x.Name' { $x.Name | Should Be 'Get-Help' }
|
||
It '$x.Category' { $x.Category | Should Be 'Cmdlet' }
|
||
}
|
||
}
|
||
}
|
||
|
||
Context 'get-help helpFunc8' {
|
||
|
||
function func8
|
||
{
|
||
# .SYNOPSIS
|
||
# Help on helpFunc8, not func8
|
||
function helpFunc8
|
||
{
|
||
}
|
||
get-help helpFunc8
|
||
}
|
||
|
||
$x = Get-Help func8
|
||
It '$x should not be $null' { $x | Should Not Be $null }
|
||
|
||
$x = func8
|
||
It '$x.Synopsis' { $x.Synopsis | Should Be 'Help on helpFunc8, not func8' }
|
||
}
|
||
|
||
Context 'get-help helpFunc9' {
|
||
function helpFunc9
|
||
{
|
||
# .SYNOPSIS
|
||
# Help on helpFunc9, not func9
|
||
param($x)
|
||
|
||
function func9
|
||
{
|
||
}
|
||
get-help func9
|
||
}
|
||
$x = Get-Help helpFunc9
|
||
It 'help is on the outer functon' { $x.Synopsis | Should Be 'Help on helpFunc9, not func9' }
|
||
$x = helpFunc9
|
||
It '$x should not be $null' { $x | Should Not Be $null }
|
||
}
|
||
|
||
It 'get-help helpFunc10' {
|
||
#######################################################
|
||
# .SYNOPSIS
|
||
# Help on helpFunc10
|
||
#######################################################
|
||
function helpFunc10
|
||
{
|
||
}
|
||
|
||
$x = get-help helpFunc10
|
||
$x.Synopsis | Should Be 'Help on helpFunc10'
|
||
}
|
||
|
||
Context 'get-help helpFunc11' {
|
||
function helpFunc11
|
||
{
|
||
# .Synopsis
|
||
#
|
||
# useless, sorry
|
||
|
||
param(
|
||
|
||
# not in help
|
||
|
||
<# abc #><# help #> [parameter()] [string]
|
||
$abc,
|
||
|
||
[string]
|
||
# def help
|
||
$def,
|
||
|
||
[parameter()]
|
||
# ghi help
|
||
$ghi,
|
||
|
||
# jkl help
|
||
|
||
$jkl,
|
||
|
||
<#mno help#>$mno,
|
||
<#pqr help#>[int]$pqr
|
||
|
||
)
|
||
}
|
||
|
||
$x = get-help helpFunc11 -det
|
||
$x.Parameters.parameter | % {
|
||
It '$_.description' { $_.description[0].text | Should match "^$($_.Name)\s+help" }
|
||
}
|
||
}
|
||
|
||
Context 'get-help helpFunc12' {
|
||
# Test case w/ cmdlet binding, but no parameter sets.
|
||
function helpFunc12 {
|
||
Param ([Parameter(Mandatory=$true)][String]$Name,
|
||
[string]$Extension = "txt",
|
||
$NoType,
|
||
[switch]$ASwitch,
|
||
[System.Management.Automation.CommandTypes]$AnEnum)
|
||
$name = $name + "." + $extension
|
||
$name
|
||
|
||
<#
|
||
.SYNOPSIS
|
||
Adds a file name extension to a supplied name.
|
||
|
||
.EXAMPLE
|
||
|
||
PS>helpFunc12 -Name foo
|
||
|
||
Adds .txt to foo
|
||
|
||
.EXAMPLE
|
||
|
||
C:\PS>helpFunc12 bar txt
|
||
|
||
Adds .txt to bar
|
||
#>
|
||
}
|
||
$x = get-help helpFunc12
|
||
It '$x.syntax' { ($x.syntax | Out-String -width 250) | Should match "helpFunc12 \[-Name] <String> \[\[-Extension] <String>] \[\[-NoType] <Object>] \[-ASwitch] \[\[-AnEnum] \{Alias.*All}] \[<CommonParameters>]" }
|
||
It '$x.syntax.syntaxItem.parameter[3].position' { $x.syntax.syntaxItem.parameter[3].position | Should Be 'named' }
|
||
It '$x.syntax.syntaxItem.parameter[3].parameterValue' { $x.syntax.syntaxItem.parameter[3].parameterValue | Should Be $null }
|
||
It '$x.parameters.parameter[3].parameterValue' { $x.parameters.parameter[3].parameterValue | Should Not Be $null }
|
||
It '$x.syntax.syntaxItem.parameter[4].parameterValueGroup' { $x.syntax.syntaxItem.parameter[4].parameterValueGroup | Should Not be $null }
|
||
It '$x.parameters.parameter[4].parameterValueGroup' { $x.parameters.parameter[4].parameterValueGroup | Should Not be $null }
|
||
It '$x.examples.example[0].introduction[0].text' { $x.examples.example[0].introduction[0].text | Should Be 'PS>' }
|
||
It '$x.examples.example[0].code' { $x.examples.example[0].code | Should Be 'helpFunc12 -Name foo' }
|
||
It '$x.examples.example[0].remarks[0].text' { $x.examples.example[0].remarks[0].text | Should Be 'Adds .txt to foo' }
|
||
It '$x.examples.example[0].remarks.length' { $x.examples.example[0].remarks.length | Should Be 5 }
|
||
It '$x.examples.example[1].introduction[0].text' { $x.examples.example[1].introduction[0].text | Should Be 'C:\PS>' }
|
||
It '$x.examples.example[1].code' { $x.examples.example[1].code | Should Be 'helpFunc12 bar txt' }
|
||
It '$x.examples.example[1].remarks[0].text' { $x.examples.example[1].remarks[0].text | Should Be 'Adds .txt to bar' }
|
||
It '$x.examples.example[1].remarks.length' { $x.examples.example[1].remarks.length | Should Be 5 }
|
||
}
|
||
|
||
Context 'get-help helpFunc12' {
|
||
function helpFunc13
|
||
{
|
||
<#
|
||
.Synopsis
|
||
|
||
empty synopsis
|
||
#>
|
||
param(
|
||
[SupportsWildcards()]
|
||
$p1,
|
||
$p2 = 42,
|
||
[PSDefaultValue(Help="parameter is mandatory")]
|
||
$p3 = $(throw "parameter p3 is not specified")
|
||
)
|
||
}
|
||
|
||
$x = get-help helpFunc13
|
||
|
||
It '$x.Parameters.parameter[0].globbing' { $x.Parameters.parameter[0].globbing | Should Be 'true' }
|
||
It '$x.Parameters.parameter[1].defaultValue' { $x.Parameters.parameter[1].defaultValue | Should Be '42' }
|
||
It '$x.Parameters.parameter[2].defaultValue' { $x.Parameters.parameter[2].defaultValue | Should Be 'parameter is mandatory' }
|
||
}
|
||
} |