Skip to content

The test for empty or auto-generated synopsis corrected. #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
it-praktyk wants to merge 1 commit into
base: main
Choose a base branch
from
+39 −11
Open

The test for empty or auto-generated synopsis corrected. #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions PesterTestsForHelp/InModule.Help.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,22 @@ foreach ($command in $commands)
Describe "Test help for $commandName" {

# If help is not found, synopsis in auto-generated help is the syntax diagram
It "should not be auto-generated" {
(Get-Help $command -ErrorAction SilentlyContinue).Synopsis | Should Not BeLike '*`[`<CommonParameters`>`]*'
It "synopsis should not be empty or auto-generated" {
$HelpSynopsis = (Get-Help $command -ErrorAction SilentlyContinue).Synopsis

$HelpSynopsisBegin = $HelpSynopsis.SubString(0, $HelpSynopsis.IndexOf('[') + 2)

$HelpSynopsisEnd = $HelpSynopsis.SubString($HelpSynopsis.length - 1, 1)

$HelpSynopsis | Should not BeNullOrEmpty

$HelpSynopsisBegin | Should Not Be "$commandName [["

$HelpSynopsisEnd | Should Not Be ']'

$HelpSynopsis | Should Not Be $commandName

}

# Should be a description for every function
It "gets description for $commandName" {
(Get-Help $command -ErrorAction SilentlyContinue).Description | Should Not BeNullOrEmpty
Expand Down
32 changes: 24 additions & 8 deletions PesterTestsForHelp/Module.Help.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<#
.NOTES
===========================================================================
Created with: SAPIEN Technologies, Inc., PowerShell Studio 2016 v5.2.119
Created on: 4/12/2016 1:11 PM
Created by: June Blender
Organization: SAPIEN Technologies, Inc
Created with: SAPIEN Technologies, Inc., PowerShell Studio 2016 v5.2.119
Created on: 4/12/2016 1:11 PM
Created by: June Blender
Organization: SAPIEN Technologies, Inc
Filename: *.Help.Tests.ps1
===========================================================================
.DESCRIPTION
Test help for a module. You can run this Tests file from any location.
To specify the module to test, enter values for the $ModuleName and $RequiredVersion variables.
To specify the module to test, enter values for the $ModuleName and $RequiredVersion variables.

For a help test that is located in a module directory, use https://github.com/juneb/PesterTDD/InModule.Help.Tests.ps1
#>
Expand All @@ -23,7 +23,7 @@ $RequiredVersion = '1.0.0.0'

Get-Module $ModuleName | Remove-Module
Import-Module $ModuleName -RequiredVersion $RequiredVersion -ErrorAction Stop
$commands = Get-Command -FullyQualifiedModule @{ ModuleName = $ModuleName; RequiredVersion=$RequiredVersion}
$commands = Get-Command -FullyQualifiedModule @{ ModuleName = $ModuleName; RequiredVersion=$RequiredVersion}

## When testing help, remember that help is cached at the beginning of each session.
## To test, restart session.
Expand All @@ -35,8 +35,24 @@ foreach ($command in $commands)
Describe "Test help for $commandName" {

# If help is not found, synopsis in auto-generated help is the syntax diagram
It "should not be auto-generated" {
(Get-Help $command -ErrorAction SilentlyContinue).Synopsis | Should Not BeLike '*`[`<CommonParameters`>`]*'
It "synopsis should not be empty or auto-generated" {

$HelpSynopsis = (Get-Help $command -ErrorAction SilentlyContinue).Synopsis

$HelpSynopsisBegin = $HelpSynopsis.SubString(0, $HelpSynopsis.IndexOf('[') + 2)

$HelpSynopsisEnd = $HelpSynopsis.SubString($HelpSynopsis.length - 1, 1)

$HelpSynopsis | Should not BeNullOrEmpty

$HelpSynopsisBegin | Should Not Be "$commandName [["

$HelpSynopsisEnd | Should Not Be ']'

$HelpSynopsis | Should Not Be $commandName


}
}

# Should be a description for every function
Expand Down