Skip to content

Support test files alongside source like Pester suggests #108

Description

@sjwestern

Is it possible to have test files next to their source files instead of in a separate directory?
This seems to be pretty standard and is the Pester docs recommended way of doing it.

Activity

  1. Jaykul commented on Oct 9, 2021

    @Jaykul
    Member

    Well, obviously I disagree that it's standard or the best way (and Pester itself certainly doesn't do that) but I would be happy to add support for Exclude. Honestly, I think we could even add a default Exclude = "*.Tests.ps1" although it would technically be a breaking change, so maybe not worth it.

    You can easily hard code that in a fork for yourself though. You would just need to change line 206 of Build-Module.ps1

                # SilentlyContinue because there don't *HAVE* to be functions at all
                $AllScripts = Get-ChildItem -Path @($ModuleInfo.SourceDirectories).ForEach{ Join-Path $ModuleInfo.ModuleBase $_ } -Filter *.ps1 -Recurse -ErrorAction SilentlyContinue

    to add -Exclude *.tests.ps1 like:

                # SilentlyContinue because there don't *HAVE* to be functions at all
                $AllScripts = Get-ChildItem -Path @($ModuleInfo.SourceDirectories).ForEach{ Join-Path $ModuleInfo.ModuleBase $_ } -Filter *.ps1 -Exclude *.tests.ps1 -Recurse -ErrorAction SilentlyContinue
  2. Jaykul commented on Oct 9, 2021

    @Jaykul
    Member

    I filed an issue against the Pester docs, because I can't find anyone who does that. I think they're talking about it from a "my first PowerShell script" practice, not module developers.

  3. nohwnd commented on Oct 12, 2021

    @nohwnd

    @sjwestern putting test files next to your production files is just one of the ways to structure your projects. Pester suggests it as an option, because it is the simplest way to do it for simple projects. More advanced projects are usually split their code into src and tst / test / tests folder. The guidance in Pester docs was updated to reflect that.

  4. sjwestern commented on Oct 14, 2021

    @sjwestern
    Author

    Thanks @Jaykul and @nohwnd appreciate your time.
    If that's what most PowerShell module projects do then I'll stick with that.
    I had just noticed the suggestion in Pester docs, which is similar to what Angular does - putting test files for components in the same location as the component files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    20 - Enhancement21 - HacktoberfestThese tickets are particularly easy to do without understanding the whole codebase

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions