Mock函数应如何在Pester中接受管道输入?

时间:2017-01-27 11:26:16

标签: powershell pester

我是Pester的新手,我正在尝试在PowerShell中为一个非常小而简单的函数构建测试:

function Toggle-Notepad {
    if (-not ( Get-Process notepad -ErrorAction SilentlyContinue ) )
    {
        Start-Process -FilePath Notepad
    }
    else
    {
        get-process notepad | stop-process
    }

}

如果它没有运行,这个函数就会启动记事本,否则如果它正在运行它会停止它。

我设计的测试是:

$here = Split-Path -Parent $MyInvocation.MyCommand.Path
$sut = (Split-Path -Leaf $MyInvocation.MyCommand.Path) -replace '\.Tests\.', '.'
. "$here\$sut"

Describe "Toggle-Notepad" {
    Mock Stop-Process { "Process object passed! Stopping notepad!" }
    Mock Start-Process { "Notepad is not running,starting it!" } -ParameterFilter { $Filepath -eq "Notepad" }

    It "Starts notepad if it is not running" {
        Toggle-Notepad | Should be "Notepad is not running,starting it!"
    }

    It "Stops notepad if it is running" {
        Toggle-Notepad | Should be "Process object passed ! Stopping notepad!"
    }
}

上述测试按预期运行。

如何重写Stop-Process函数以便我可以指定此版本用于接受管道输入?

我尝试了这个,但它不起作用:

$here = Split-Path -Parent $MyInvocation.MyCommand.Path
$sut = (Split-Path -Leaf $MyInvocation.MyCommand.Path) -replace '\.Tests\.', '.'
. "$here\$sut"

Describe "Toggle-Notepad" {
    Mock stop-process { "Process object passed ! Stopping notepad" } -ParameterFilter { $InputObject -is "System.Diagnostics.Process" }
    Mock Start-Process {"Notepad is not running,starting it!"} -ParameterFilter { $Filepath -eq "Notepad" }

    It "Starts notepad if it is not running" {
        Toggle-Notepad | Should be "Notepad is not running,starting it!"
    }

    It "Stops notepad if it is running" {
        Toggle-Notepad | Should be "Process object passed ! Stopping notepad!"
    }
}

由于Stop-Process函数接受管道输入,我的目标是模拟与此类似的函数,而不是创建一个不接受参数的通用Stop-Process函数。

有没有Pester专家可以提供帮助?

2 个答案:

答案 0 :(得分:1)

您通常不需要在Mock内手动定义参数,因为被模拟的函数的参数是在Mock中自动创建的。

你的Stop-Process模拟不起作用的原因是你用-ParameterFilter属性定义了它,导致只有在定义的参数为真时才调用它。您的过滤器无法正常工作,因为您将对象类型引用为字符串("System.Diagnostics.Process")而不是类型(使用方括号声明)。

模拟的正确代码是:

Mock stop-process { "Process object passed ! Stopping notepad!" } -ParameterFilter { $InputObject -is [System.Diagnostics.Process[]] }

asked this question of the Pester development team directly他们提出了一个简单的-ParameterFilter { $InputObject }解决方案,因为如果它没有填充该类型的有效对象,它将为null。

这是一个完整的例子:

Describe 'Mocking stop-process' {

    Mock Stop-Process { 
        Write-Host "Mock stopping: $InputObject"
    } -ParameterFilter { $InputObject }

    It 'Should mock stopping the notepad process' {
        Get-Process notepad | Stop-Process | Should Be $null
    }

}

另外FYI,因为Pester 3.4.4现在有一个New-MockObject命令,允许你创建任何类型的假对象:

  

New-MockObject是一个Pester函数(在Pester 3.4.4中引入)   允许您创建几乎任何类型的“假”对象来运行   Pester嘲笑。这些“虚假物品”允许你的嘲笑返回相同的东西   键入作为模拟将结果传递给实体的函数   这是强类型的。

在您的方案中没有必要,但我认为您可能会发现它相关/有趣。

答案 1 :(得分:0)

您可以像任何其他函数一样模拟接受管道值的函数:

Describe "Toggle-Notepad" {
    Mock Stop-Process {
        [CmdletBinding()]
        param(
            [Parameter(ValueFromPipeline = $true)]
            $InputObject
        )
        return "Process object passed! Stopping notepad"
    } -ParameterFilter { $InputObject -is "System.Diagnostics.Process" }

    Mock Start-Process {
        return "Notepad is not running, starting it!"
    } -ParameterFilter { $Filepath -eq "Notepad" }

    It "Starts notepad if it is not running" {
        Toggle-Notepad | Should be "Notepad is not running, starting it!"
    }

    It "Stops notepad if it is running" {
        Toggle-Notepad | Should be "Process object passed! Stopping notepad!"
    }
}

另请注意,您的嘲笑Stop-Process中存在拼写错误,因此无法正常工作。