命令行与文本处理 / 系统课时

隔离外部依赖

隔离外部依赖

本课把文件读取和 HTTP 请求封装为独立依赖,再用 Pester Mock 替换真实调用。最终测试既不会访问磁盘和网络,又能验证业务结果、异常转换以及依赖调用次数。

学习目标

  • 识别会降低测试稳定性的外部依赖
  • 通过依赖封装为测试建立替换边界
  • 使用 Mock 和 Should -Invoke 验证结果与交互

为什么依赖要隔离

文件、网络、远程服务和系统命令都可能因权限、延迟或环境差异而失败。如果单元测试直接调用它们,失败结果就无法说明是业务逻辑错误,还是外部环境不可用。Pester 的 Mock 可用替代实现拦截命令,Should -Invoke 可验证调用次数和参数。:contentReference[oaicite:1]{index=1}

被测函数与外部依赖的隔离结构

先封装外部调用

将下面内容保存为 AppHealth.ps1。业务函数不直接调用 Get-Content 和 Invoke-RestMethod,而是依赖两个职责单一的包装函数。测试只需替换包装层,不必了解底层命令的全部参数。

powershell
function Read-AppConfig {
    param(
        [Parameter(Mandatory)]
        [string]$Path
    )

    Get-Content -Path $Path -Raw | ConvertFrom-Json
}

function Invoke-HealthRequest {
    param(
        [Parameter(Mandatory)]
        [string]$Uri
    )

    Invoke-RestMethod -Uri $Uri -Method Get -TimeoutSec 5
}

function Get-AppHealth {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory)]
        [string]$ConfigPath
    )

    $config = Read-AppConfig -Path $ConfigPath

    try {
        $response = Invoke-HealthRequest -Uri $config.HealthUri
    }
    catch {
        # 将底层网络异常转换成调用方可理解的业务异常
        throw "Health service unavailable: $($_.Exception.Message)"
    }

    [pscustomobject]@{
        Uri       = $config.HealthUri
        IsHealthy = $response.Status -eq 'ok'
    }
}

这段脚本定义了生产行为,不会主动输出结果。真实运行时读取 JSON 配置并访问健康检查地址;单元测试则在包装函数处截断外部调用。

用 Mock 替换依赖

将下面内容保存为 AppHealth.Tests.ps1。正常场景返回固定配置和响应,失败场景让网络替身主动抛出超时异常。BeforeEach 中的 Mock 会为每个 It 重新建立,减少用例之间的状态污染。Mock 的作用域与放置位置有关,因此应把共享 Mock 放在能覆盖目标用例的 BeforeEach 或 BeforeAll 中。:contentReference[oaicite:2]{index=2}

powershell
BeforeAll {
    . "$PSScriptRoot/AppHealth.ps1"
}

Describe 'Get-AppHealth' {
    Context '外部依赖返回正常结果' {
        BeforeEach {
            Mock Read-AppConfig {
                [pscustomobject]@{
                    HealthUri = 'https://example.invalid/health'
                }
            }

            Mock Invoke-HealthRequest {
                [pscustomobject]@{
                    Status = 'ok'
                }
            }
        }

        It '返回健康状态并仅调用一次依赖' {
            $configPath = Join-Path $TestDrive 'appsettings.json'
            $result = Get-AppHealth -ConfigPath $configPath

            $result.IsHealthy | Should -BeTrue
            $result.Uri | Should -Be 'https://example.invalid/health'

            Should -Invoke -CommandName Read-AppConfig -Times 1 -Exactly `
                -ParameterFilter { $Path -eq $configPath }

            Should -Invoke -CommandName Invoke-HealthRequest -Times 1 -Exactly `
                -ParameterFilter { $Uri -eq 'https://example.invalid/health' }
        }
    }

    Context '远程服务调用失败' {
        BeforeEach {
            Mock Read-AppConfig {
                [pscustomobject]@{
                    HealthUri = 'https://example.invalid/health'
                }
            }

            Mock Invoke-HealthRequest {
                throw 'timeout'
            }
        }

        It '转换为业务可理解的异常' {
            { Get-AppHealth -ConfigPath 'unused.json' } |
                Should -Throw '*Health service unavailable*'
        }
    }
}

这里的配置对象属于 Stub:它只提供固定数据;带调用记录的 Mock 既返回结果,也支持验证交互。测试没有创建配置文件,也没有发送 HTTP 请求,因此可在离线环境重复执行。

运行并验证交互

在脚本目录执行测试。正常用例除了检查返回值,还要求两个依赖各调用一次,并核对实际参数;这能发现“结果碰巧正确,但调用了错误地址”一类问题。

powershell
Invoke-Pester -Path ./AppHealth.Tests.ps1 -Output Detailed

预期输出

text
Describing Get-AppHealth
 Context 外部依赖返回正常结果
   [+] 返回健康状态并仅调用一次依赖
 Context 远程服务调用失败
   [+] 转换为业务可理解的异常
Tests completed in <TIME>
Tests Passed: 2, Failed: 0, Skipped: 0

<TIME> 是动态执行耗时。若 Should -Invoke 失败,应先检查 Mock 是否位于正确作用域,再检查 -ParameterFilter 使用的参数名是否与被替换函数一致。

选择合适的隔离边界

优先 Mock 自己封装的依赖函数,而不是在大量测试中直接 Mock Get-Content、Invoke-RestMethod 或复杂系统命令。包装层参数更少、语义更稳定,也能降低测试与 PowerShell 内部实现细节的耦合。

只有确实需要验证文件格式、HTTP 序列化或真实命令兼容性时,才编写少量集成测试访问外部资源。单元测试负责快速验证业务分支,集成测试负责确认边界能真实工作,两者不应互相替代。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

隔离外部依赖

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通