FilesExpand file tree

main

/

ScriptValidation.Tests.ps1

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

89 lines (74 loc) · 2.93 KB

main

/

ScriptValidation.Tests.ps1

Copy path

Top

File metadata and controls

• Code
• Blame

89 lines (74 loc) · 2.93 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

#Requires -Modules Pester

<#

.SYNOPSIS

Pester tests for validating PowerShell scripts in the repository.

.DESCRIPTION

Validates script syntax, parameter declarations, help documentation,

and coding standards across all scripts in the Scripts directory.

#>

BeforeDiscovery {

$ScriptFiles = Get-ChildItem -Path "$PSScriptRoot\..\Scripts" -Recurse -Filter "*.ps1"

}

Describe "Script Validation: <_.Name>" -ForEach $ScriptFiles {

BeforeAll {

$ScriptPath = $_.FullName

$ScriptContent = Get-Content $ScriptPath -Raw

$ScriptHelp = Get-Help $ScriptPath -ErrorAction SilentlyContinue

}

Context "Syntax" {

It "Should have valid PowerShell syntax" {

$errors = $null

[System.Management.Automation.PSParser]::Tokenize($ScriptContent, [ref]$errors)

$errors.Count | Should -Be 0

}

}

Context "Help Documentation" {

It "Should have a SYNOPSIS" {

$ScriptContent | Should -Match '\.SYNOPSIS'

}

It "Should have a DESCRIPTION" {

$ScriptContent | Should -Match '\.DESCRIPTION'

}

It "Should have at least one EXAMPLE" {

$ScriptContent | Should -Match '\.EXAMPLE'

}

It "Should have NOTES" {

$ScriptContent | Should -Match '\.NOTES'

}

It "Should have a LINK" {

$ScriptContent | Should -Match '\.LINK'

}

It "Should have a Version in NOTES" {

$ScriptContent | Should -Match 'Version\s*:'

}

}

Context "Coding Standards" {

It "Should use CmdletBinding" {

$ScriptContent | Should -Match '\[CmdletBinding'

}

It "Should not have trailing whitespace on lines" {

$lines = $ScriptContent -split '\r?\n'

$trailingWhitespace = $lines | Where-Object { $_ -match '\S[ \t]+$' }

$trailingWhitespace.Count | Should -Be 0

}

It "Should use UTF-8 encoding for CSV exports" {

if ($ScriptContent -match 'Export-Csv') {

$ScriptContent | Should -Match 'Encoding\s+(UTF8|utf8)'

}

}

}

Context "Parameter Validation" {

It "Should declare parameters documented in help" {

if ($ScriptHelp.parameters.parameter) {

foreach ($param in $ScriptHelp.parameters.parameter) {

$paramName = $param.Name

# Skip common parameters provided by CmdletBinding

if ($paramName -in @('WhatIf', 'Confirm', 'Verbose', 'Debug', 'ErrorAction', 'WarningAction', 'InformationAction', 'ErrorVariable', 'WarningVariable', 'InformationVariable', 'OutVariable', 'OutBuffer', 'PipelineVariable')) {

continue

}

$ScriptContent | Should -Match "\`$$paramName" -Because "Parameter '$paramName' is documented but should be declared"

}

}

}

}

}