[英]Testing with Pester 5.3.3
I have written a function to write the errors that occur in my functions in a csv file, this function is called in the catch block of my functions.我编写了一个函数来将函数中发生的错误写入 csv 文件,该函数在函数的 catch 块中调用。 I would like to write a Test in Pester to check that my function works correctly, but to be honest I don't know where to start, I have tried some things but they don't work for me, I have also been reading in the documentation but I am still not clear, I would appreciate any help/comments.
我想在 Pester 中编写一个测试来检查我的功能是否正常工作,但老实说我不知道从哪里开始,我尝试了一些东西但它们对我不起作用,我也一直在阅读文档,但我仍然不清楚,我将不胜感激任何帮助/意见。
Here is the function for which I want to write a Test in Pester:这是我想在 Pester 中编写测试的函数:
function Write-Logs {
param (
[ValidateSet("Error")]$MessageType,
[string][Parameter(Mandatory=$true)]$Message,
$LogFilePath,
$Source
)
$CSVLogPath = Join-Path -Path $PSScriptRoot -ChildPath ".\errorslog.csv"
$CSVLogObject = [PSCustomObject] @{
Date = Get-Date
Message = $Message
MessageType = $MessageType
Source = $Source
}
$CSVLogObject | Export-Csv -Path $CSVLogPath -NoTypeInformation -Encoding UTF8 -Append
}
and so I´m calling the function in the catch block:所以我在 catch 块中调用函数:
catch {
Write-Logs -LogFilePath:$CSVLogPath -Message:$Error[0].Exception.Message `
-Source:"FunctionName()" -MessageType:"Error"
return
}
Continuing from my comments, here is some code.继续我的评论,这里有一些代码。
First make the function testable, by actually using the -LogFilePath
parameter.首先通过实际使用
-LogFilePath
参数使函数可测试。 This way you can write the log to a temporay file during testing.这样,您可以在测试期间将日志写入临时文件。 Due to the default value you can still use it without
-LogFilePath
when calling it from normal code.由于默认值,当从普通代码调用它时,您仍然可以在没有
-LogFilePath
的情况下使用它。
function Write-Logs {
param (
[ValidateSet("Error")]$MessageType,
[string][Parameter(Mandatory=$true)]$Message,
$LogFilePath = (Join-Path -Path $PSScriptRoot -ChildPath ".\errorslog.csv"),
$Source
)
$CSVLogObject = [PSCustomObject] @{
Date = Get-Date
Message = $Message
MessageType = $MessageType
Source = $Source
}
$CSVLogObject | Export-Csv -Path $LogFilePath -NoTypeInformation -Encoding UTF8 -Append
}
Test code:测试代码:
BeforeAll {
. $PSCommandPath.Replace('.Tests.ps1','.ps1')
}
Describe "Write-Logs" {
BeforeEach{
# Mock Get-Date so it returns a constant value suitable for testing
$expectedDate = [DateTime]::new( 2022, 06, 28, 12, 36, 21 )
Mock Get-Date { return $expectedDate }
}
It "writes the expected CSV" {
# You might read this from a file using Import-Csv
$expectedCsv = [PSCustomObject]@{
Date = $expectedDate
Message = 'test message'
MessageType = 'Error'
Source = 'test source'
}
# Write log to temp file (Pester cleans it automatically, when It block ends)
$testLogPath = "TestDrive:\test.log"
Write-Logs -LogFilePath $testLogPath -MessageType $expectedCsv.MessageType -Message $expectedCsv.Message -Source $expectedCsv.Source
$actualCsv = Import-Csv $testLogPath
# Test if $expectedCsv equals $actualCsv
Compare-Object $expectedCsv $actualCsv -Property Date, Message, MessageType, Source | Should -BeNullOrEmpty
}
}
TestDrive:
is a temporary drive created by Pester for each script block. TestDrive:
是 Pester 为每个脚本块创建的临时驱动器。 It is very convenient for writing temporary files because Pester cleans it automatically when the script block ends.
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.