feat(tests): add Pester tests for LintingHelpers and Validate-MarkdownFrontmatter (#197, #198) #205

WilliamBerryiii · 2026-01-17T05:46:44Z

Description

This PR adds comprehensive Pester test coverage for the linting modules, implementing 104 tests across two test suites:

LintingHelpers.Tests.ps1 - 37 tests for all 7 exported functions ([Issue]: Add Pester tests for linting scripts (5 scripts) #197)
Validate-MarkdownFrontmatter.Tests.ps1 - 67 tests for all 8 exported functions ([Issue]: Add Pester tests for Validate-MarkdownFrontmatter.ps1 (detailed) #198)

The implementation also includes a production bug fix for regex escaping order in Get-SchemaForFile.

Key Changes

LintingHelpers Tests (#197):

Tests for Get-ChangedFilesFromGit, Get-FilesRecursive, Get-GitIgnorePatterns
Tests for GitHub Actions functions: Write-GitHubAnnotation, Set-GitHubOutput, Set-GitHubEnv, Write-GitHubStepSummary
Leverages GitMocks.psm1 for environment simulation

Validate-MarkdownFrontmatter Tests (#198):

Tests for ConvertFrom-YamlFrontmatter, Get-MarkdownFrontmatter, Get-FileTypeInfo, Test-MarkdownFooter
Tests for Get-SchemaForFile, Test-JsonSchemaValidation, Get-ChangedMarkdownFileGroup, Test-FrontmatterValidation
Production fix: Corrected regex escaping order in Get-SchemaForFile - dots are now escaped BEFORE glob conversion
Added typed return classes (ValidationResult, SchemaValidationResult, FileTypeInfo, FrontmatterResult)
Added 7 markdown fixture files for realistic validation scenarios

Related Issue(s)

Closes #197
Closes #198

Type of Change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Documentation update
GitHub Actions / workflow change
Script/automation improvement
Breaking change (fix or feature that could break existing behavior)
Refactoring (code improvement without changing functionality)

Sample Prompts

Not applicable - infrastructure/testing changes.

Testing

Test Results

All 104 tests pass:

npm run pester

# Output:
# Tests Passed: 104, Failed: 0, Skipped: 0

Test Coverage Summary

Module	Function	Tests
LintingHelpers	`Get-ChangedFilesFromGit`	5
LintingHelpers	`Get-FilesRecursive`	4
LintingHelpers	`Get-GitIgnorePatterns`	5
LintingHelpers	`Write-GitHubAnnotation`	4
LintingHelpers	`Set-GitHubOutput`	4
LintingHelpers	`Set-GitHubEnv`	2
LintingHelpers	`Write-GitHubStepSummary`	3
LintingHelpers Total		37
Validate-MarkdownFrontmatter	`ConvertFrom-YamlFrontmatter`	12
Validate-MarkdownFrontmatter	`Get-MarkdownFrontmatter`	6
Validate-MarkdownFrontmatter	`Get-FileTypeInfo`	12
Validate-MarkdownFrontmatter	`Test-MarkdownFooter`	6
Validate-MarkdownFrontmatter	`Get-SchemaForFile`	7
Validate-MarkdownFrontmatter	`Test-JsonSchemaValidation`	7
Validate-MarkdownFrontmatter	`Get-ChangedMarkdownFileGroup`	6
Validate-MarkdownFrontmatter	`Test-FrontmatterValidation`	11
Validate-MarkdownFrontmatter Total		67

Required Checks

I have performed a self-review of my code
I have tested my changes locally
My changes generate no new warnings
I have added tests that prove my fix is effective or my feature works
New and existing unit tests pass locally with my changes

Security Considerations

No secrets or credentials added
No external API calls introduced
Test fixtures contain only sample markdown content
Git mocking functions properly isolate tests from real repository state

Additional Notes

Schema Validation Mode

Schema validation operates in soft/advisory mode - schema errors produce warnings rather than build failures. Tests are designed with this expectation.

Production Bug Fixed

The regex escaping bug in Get-SchemaForFile caused patterns like docs/**/*.md to fail matching because the dot in .md was being escaped after the glob-to-regex conversion, resulting in invalid patterns like docs/.*/.*.md instead of docs/.*/.*\.md.

Files Changed

File	Change
`scripts/linting/Modules/LintingHelpers.psm1`	Minor updates
`scripts/linting/Validate-MarkdownFrontmatter.ps1`	Bug fix + typed returns
`scripts/tests/Modules/LintingHelpers.Tests.ps1`	NEW - 587 lines
`scripts/tests/Modules/Validate-MarkdownFrontmatter.Tests.ps1`	NEW - 829 lines
`scripts/tests/Mocks/GitMocks.psm1`	NEW - Mock helpers
`scripts/tests/Fixtures/Frontmatter/*.md`	NEW - 7 fixture files

🧪 - Generated by Copilot

github-actions · 2026-01-17T05:46:58Z

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

Copilot

Pull request overview

This pull request adds comprehensive Pester 5.x unit tests for the LintingHelpers.psm1 module, providing coverage for all 7 exported functions. The test suite validates git integration, file enumeration, gitignore pattern parsing, and GitHub Actions workflow command functions using proper mocking patterns.

Changes:

Added 41 test cases across 7 describe blocks covering all exported functions in LintingHelpers.psm1
Implemented proper mocking for git commands with LASTEXITCODE handling
Utilized existing GitMocks.psm1 module for GitHub Actions environment simulation

scripts/tests/Modules/LintingHelpers.Tests.ps1

- Add third fallback test (merge-base + HEAD~1 fail) - Add git diff failure test (LASTEXITCODE -ne 0) - Add exception handling test (catch block coverage) - Fix assertion precision with platform-aware separators - Update comment to be platform-neutral Addresses review comments on PR #205

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 7 comments.

scripts/linting/Validate-MarkdownFrontmatter.ps1

scripts/tests/Modules/Validate-MarkdownFrontmatter.Tests.ps1

scripts/linting/Validate-MarkdownFrontmatter.ps1

scripts/tests/Modules/Validate-MarkdownFrontmatter.Tests.ps1

Copilot

Pull request overview

Copilot reviewed 21 out of 21 changed files in this pull request and generated 1 comment.

scripts/tests/Modules/Validate-MarkdownFrontmatter.Tests.ps1

- add tests for Get-ChangedFilesFromGit, Get-FilesRecursive, Get-GitIgnorePatterns - add tests for Write-GitHubAnnotation, Set-GitHubOutput, Set-GitHubEnv - add tests for Write-GitHubStepSummary with GitHub Actions context handling - leverage GitMocks.psm1 for environment simulation 🧪 - Generated by Copilot

- Add third fallback test (merge-base + HEAD~1 fail) - Add git diff failure test (LASTEXITCODE -ne 0) - Add exception handling test (catch block coverage) - Fix assertion precision with platform-aware separators - Update comment to be platform-neutral Addresses review comments on PR #205

…downFrontmatter - add custom PowerShell classes for FrontmatterResult, SchemaValidationResult, ValidationResult, FileTypeInfo - add ConvertFrom-YamlFrontmatter and Get-FileTypeInfo pure helper functions - add -Content parameter to Get-MarkdownFrontmatter for testing without file I/O - add comprehensive docstrings with OutputType attributes on all functions 🧪 - Generated by Copilot

- Add comprehensive Pester test suite covering all 8 exported functions - Create 7 fixture files for frontmatter validation scenarios - Fix regex escaping order in Get-SchemaForFile (escape dots before glob conversion) Closes #198 🧪 - Generated by Copilot

…tion tests - add npm run test:ps script for running Pester tests - add Initialize-JsonSchemaValidation test coverage 🧪 - Generated by Copilot

…ures - add ExcludePaths parameter to Validate-MarkdownFrontmatter.ps1 script and function - exclude scripts/tests/Fixtures/* from frontmatter and markdown linting - normalize Windows backslash paths for cross-platform pattern matching 🔧 - Generated by Copilot

📝 - Generated by Copilot

🔧 - Generated by Copilot

- update workflow to use ** for recursive matching in subdirectories - fix npm script to use -Command for proper array parameter parsing - remove duplicate Initialize-JsonSchemaValidation test region 🔧 - Generated by Copilot

- Add ExcludePaths check to the Files code path used by ChangedFilesOnly mode - Previously ExcludePaths filtering only applied when using Paths parameter - CI uses ChangedFilesOnly which populates Files, so exclusions were ignored 🔧 - Generated by Copilot

Copilot

Pull request overview

Copilot reviewed 21 out of 21 changed files in this pull request and generated 2 comments.

scripts/tests/Modules/Validate-MarkdownFrontmatter.Tests.ps1

scripts/linting/Validate-MarkdownFrontmatter.ps1

- remove unreachable duplicate elseif block in Get-SchemaForFile - add descriptive comments for pattern matching logic - remove UTF-8 BOM from test file 🧹 - Generated by Copilot

- file contains non-ASCII characters requiring BOM encoding 🔧 - Generated by Copilot

Copilot

Pull request overview

Copilot reviewed 21 out of 21 changed files in this pull request and generated no new comments.

Copilot AI review requested due to automatic review settings January 17, 2026 05:46

WilliamBerryiii requested a review from a team as a code owner January 17, 2026 05:46

Copilot started reviewing on behalf of WilliamBerryiii January 17, 2026 05:47 View session

Copilot AI reviewed Jan 17, 2026

View reviewed changes

WilliamBerryiii requested review from agreaves-ms, auyidi1, bindsi and katriendg January 17, 2026 05:52

WilliamBerryiii changed the title ~~test(scripts): add Pester tests for LintingHelpers module~~ feat(tests): add Pester tests for LintingHelpers and Validate-MarkdownFrontmatter (#197, #198) Jan 18, 2026

Copilot AI review requested due to automatic review settings January 18, 2026 06:50

Copilot started reviewing on behalf of WilliamBerryiii January 18, 2026 06:50 View session

Copilot AI reviewed Jan 18, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings January 18, 2026 21:09

Copilot started reviewing on behalf of WilliamBerryiii January 18, 2026 21:10 View session

Copilot AI reviewed Jan 18, 2026

View reviewed changes

scripts/tests/Modules/Validate-MarkdownFrontmatter.Tests.ps1 Outdated Show resolved Hide resolved

WilliamBerryiii added 10 commits January 18, 2026 18:37

test(scripts): add test:ps npm script and Initialize-JsonSchemaValida…

773ec64

…tion tests - add npm run test:ps script for running Pester tests - add Initialize-JsonSchemaValidation test coverage 🧪 - Generated by Copilot

style(docs): apply markdown table formatting

601eab6

📝 - Generated by Copilot

fix(build): exclude test fixtures from CI frontmatter validation

b346393

🔧 - Generated by Copilot

WilliamBerryiii force-pushed the test/lintinghelpers-pester-tests branch from e39d58e to 5a69873 Compare January 19, 2026 03:33

Copilot AI review requested due to automatic review settings January 19, 2026 03:33

Copilot started reviewing on behalf of WilliamBerryiii January 19, 2026 03:34 View session

Copilot AI reviewed Jan 19, 2026

View reviewed changes

scripts/tests/Modules/Validate-MarkdownFrontmatter.Tests.ps1 Show resolved Hide resolved

scripts/linting/Validate-MarkdownFrontmatter.ps1 Outdated Show resolved Hide resolved

WilliamBerryiii added 2 commits January 18, 2026 21:08

refactor(scripts): address code review feedback

8b19d31

- remove unreachable duplicate elseif block in Get-SchemaForFile - add descriptive comments for pattern matching logic - remove UTF-8 BOM from test file 🧹 - Generated by Copilot

fix(scripts): restore UTF-8 BOM for PSScriptAnalyzer compliance

f875cbb

- file contains non-ASCII characters requiring BOM encoding 🔧 - Generated by Copilot

Copilot AI review requested due to automatic review settings January 19, 2026 05:09

Copilot started reviewing on behalf of WilliamBerryiii January 19, 2026 05:10 View session

Copilot AI reviewed Jan 19, 2026

View reviewed changes

agreaves-ms approved these changes Jan 19, 2026

View reviewed changes

katriendg approved these changes Jan 19, 2026

View reviewed changes

feat(tests): add Pester tests for LintingHelpers and Validate-MarkdownFrontmatter (#197, #198) #205

Are you sure you want to change the base?

feat(tests): add Pester tests for LintingHelpers and Validate-MarkdownFrontmatter (#197, #198) #205

Conversation

WilliamBerryiii commented Jan 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Key Changes

Related Issue(s)

Type of Change

Sample Prompts

Testing

Test Results

Test Coverage Summary

Required Checks

Security Considerations

Additional Notes

Schema Validation Mode

Production Bug Fixed

Files Changed

Uh oh!

github-actions bot commented Jan 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Dependency Review

Scanned Files

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

WilliamBerryiii commented Jan 17, 2026 •

edited

Loading

github-actions bot commented Jan 17, 2026 •

edited

Loading