Add ability to exclude Example folders from tests

[ykuijs]

It would be nice if there was an option to exclude certain Example files or folders from being checked for validity by the Examples test.

For SharePointDsc I have added an example, which also includes some additional, non-DSC scripts. The Examples test is now trying to run these as a DSC configuration, which of course fails. Would be great if I could exclude these files or the folder from this test.

[johlju]

Actually, the v5 (Pester 5 version) does exclude files that are added to the build config, for example

  ExcludeSourceFile:
    - source/Examples

DscResource.Test/source/Tests/QA/ExampleFiles.common.v5.Tests.ps1

Line 55 in 27c70ec

$exampleFiles = @(Get-ChildItem -Path $examplesPath -Filter '*.ps1' -Recurse | WhereSourceFileNotExcluded -ExcludeSourceFile $ExcludeSourceFile)

But that is missing for the Pester 4 tests:

DscResource.Test/source/Tests/QA/ExampleFiles.common.v4.Tests.ps1

Line 31 in 27c70ec

$examples = Get-ChildItem -Path $examplesPath -Filter '*.ps1' -Recurse

But other Pester 4 tests are using it, like:

DscResource.Test/source/Tests/QA/FileFormatting.common.v4.Tests.ps1

Line 32 in 27c70ec

$textFiles += Get-TextFilesList -Root $SourcePath | WhereSourceFileNotExcluded

@ykuijs you could try adding that to the v4 test in you local copy and see if it works just adding that extra pipe in the code, and then adding the correct path to the build config.