Powershell Core + Pester - 将测试与 src 分离

Hop*_*rka 5 powershell unit-testing pester powershell-core

问题:

将函数导入到不在同一目录中的测试的最佳方法是什么?

例子

 src
       Get-Emoji.ps1
 test
       Get-Emoji.Tests.ps1
Run Code Online (Sandbox Code Playgroud)

因b4

  • Pester 文档[1] 建议将测试文件放置在与其测试的代码相同的目录中。没有提供替代方案的示例。
  • Pester 文档[2] 建议使用点源来导入文件。仅包含同一目录中的示例
  • 从 src 中进行测试是否是一种好的做法,将在其他地方讨论
  • 使用 Powershell Core 在不同操作系统文件系统上提供跨平台支持(正斜杠与反斜杠)

[1]文件放置和命名约定

Pester 认为所有名为 .Tests.ps1 的文件都是测试文件。这是几乎所有项目都使用的默认命名约定。

测试文件放置在与其测试的代码相同的目录中。每个文件都作为它测试的函数被调用。这意味着对于 Get-Emoji 函数,我们会将 Get-Emoji.Tests.ps1 和 Get-Emoji.ps1 放在同一目录中。将测试引用到 Pester 中的函数的最佳方式是什么?

[2]导入测试的函数

Pester 测试放置在 .Tests.ps1 文件中,例如 Get-Emoji.Tests.ps1。代码位于Get-Emoji.ps1中。

为了使测试代码可供测试,我们需要导入代码文件。这是通过将文件点源到当前范围来完成的,如下所示:

实施例1

# at the top of Get-Emoji.Tests.ps1
BeforeAll { 
    . $PSScriptRoot/Get-Emoji.ps1
}
Run Code Online (Sandbox Code Playgroud)

实施例2

# at the top of Get-Emoji.Tests.ps1
BeforeAll { 
    . $PSCommandPath.Replace('.Tests.ps1','.ps1')
}
Run Code Online (Sandbox Code Playgroud)

Mar*_*agg 7

我倾向于将测试放在一个文件夹中,该文件夹距离脚本所在位置一到两个父级别(通常位于指定的模块目录下,然后位于名为 Private 或 Public 的文件夹中)。我只是点源我的脚本或模块,并使用(当前脚本路径)作为参考点来..引用父路径。$PSScriptRoot例如:

  • 脚本在\SomeModule\Public\get-something.ps1
  • 测试于\Tests\get-something.tests.ps1
BeforeAll { 
    . $PSScriptRoot\..\SomeModule\Public\get-something.ps1    
}
Run Code Online (Sandbox Code Playgroud)

如果考虑跨平台兼容性,请使用正斜杠,Windows 不介意路径分隔符是正斜杠还是反斜杠。Resolve-Path如果您想确定使用了有效的完整路径,您也可以首先运行此路径,但我通常认为没有必要。