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

Question

问题：

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

例子

📁 src
      📄 Get-Emoji.ps1
📁 test
      📄 Get-Emoji.Tests.ps1

Inb4

• Pester 文档[1] 建议将测试文件放在与他们测试的代码相同的目录中。 没有提供替代品的例子。
• Pester 文档[2] 建议使用 dot-sourcing 来导入文件。 仅来自同一目录中的示例
• 从 src 中拆分测试是否是好的做法，将在别处讨论
• 使用 Powershell 内核在不同的操作系统文件系统上提供跨平台支持（正斜杠与反斜杠）

---

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

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

测试文件与它们测试的代码放置在同一目录中。 每个文件都称为它测试的 function。 这意味着对于 function Get-Emoji，我们将在同一目录中拥有 Get-Emoji.Tests.ps1 和 Get-Emoji.ps1。 将测试引用到 Pester 中的函数的最佳方法是什么。

[2] 导入测试函数

Pester 测试放在 .Tests.ps1 文件中，例如 Get-Emoji.Tests.ps1。 代码放在 Get-Emoji.ps1 中。

为了使测试代码可用于测试，我们需要导入代码文件。 这是通过将文件点源到当前的 scope 来完成的，如下所示：

示例 1

 # at the top of Get-Emoji.Tests.ps1 BeforeAll {. $PSScriptRoot/Get-Emoji.ps1 }

示例 2

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

Answer 1

我倾向于将我的测试放在一个文件夹中，该文件夹与脚本所在的位置相距一两个父级别（通常位于命名模块目录下，然后位于名为 Private 或 Public 的文件夹中）。 我只是点源我的脚本或模块，并使用..以$PSScriptRoot （当前脚本路径）作为参考点来引用父路径。 例如：

• \SomeModule\Public\get-something.ps1中的脚本
• \Tests\get-something.tests.ps1中的测试

BeforeAll { 
    . $PSScriptRoot\..\SomeModule\Public\get-something.ps1    
}

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