Fix Start-Transcript error when $Transcript is a PSObject wrapped string
#24963
Conversation
| Start-Transcript | ||
| Write-Host -Message $message -InformationAction Ignore | ||
| Stop-Transcript | ||
| } |
There was a problem hiding this comment.
Can we use ValidateTranscription function?
There was a problem hiding this comment.
Not without a bit of refactoring. We would need to implement extra support just for this case, so I have chosen to follow similar existing tests, like:
It "Transcription should record Write-Host output when InformationAction is set to SilentlyContinue" {
[String]$message = New-Guid
$script = {
Start-Transcript -Path $transcriptFilePath
Write-Host -Message $message -InformationAction SilentlyContinue
Stop-Transcript
}
& $script
$transcriptFilePath | Should -Exist
$transcriptFilePath | Should -FileContentMatch $message
}There was a problem hiding this comment.
Why won't it work?
$script = "Start-Transcript"
$outputFilePath = expected_file_path
ValidateTranscription -scriptToExecute $script -outputFilePath $outputFilePathThere was a problem hiding this comment.
I need to test if PSObject wrapped string in $Transcript preference variable works with Start-Transcript. This will not work, because when $Transcript is not defined, the Start-Transcript will create the transcript file automatically either in:
- on Windows:
$HOME\Documents - on Linux or macOS:
$HOME
and unwrapping will not be tested at all.
I would have to refactor ValidateTranscription to support this case. It would need to be something like this:
$ps.AddScript({
param([PSObject]$filePath)
$Global:Transcript = $filePath
}).AddArgument(
$outputFilePath
).Invoke()plus some extra logic to handle this case
There was a problem hiding this comment.
$script = "$Global:Transcript = testfile; Start-Transcript"
$outputFilePath = expected_file_path
ValidateTranscription -scriptToExecute $script -outputFilePath $outputFilePathThere was a problem hiding this comment.
OK, now you are just flexing 😂, how did I miss that 😉
BTW, Pester does not like this:
It "Should create Transcript file with 'Transcript' preference variable" {
$script = "$Global:Transcript = $transcriptFilePath; Start-Transcript"
ValidateTranscription -scriptToExecute $script -outputFilePath $transcriptFilePath
}
Thankfully, this works:
It "Should create Transcript file with 'Transcript' preference variable" {
$script = "Set-Variable -Scope Global -Name Transcript -Value $transcriptFilePath; Start-Transcript"
ValidateTranscription -scriptToExecute $script -outputFilePath $transcriptFilePath
}Will update PR ASAP.
There was a problem hiding this comment.
One more change. We need to cast the $transcriptFilePath string to the PSObject, otherwise it defeats the purpose:
It "Should create Transcript file with 'Transcript' preference variable" {
$script = "Set-Variable -Scope Global -Name Transcript -Value ([PSObject]'$transcriptFilePath'); Start-Transcript"
ValidateTranscription -scriptToExecute $script -outputFilePath $transcriptFilePath
}There was a problem hiding this comment.
I'd expect if we assign to psvariable it is already wrapped in PSObject. It seems the original issue is about this.
There was a problem hiding this comment.
Yeah, when you assign it does, but when you use Set-Variable it does not. I had to do the cast, otherwise the test was passing on current release without fix.
There was a problem hiding this comment.
Please add a comment in the test line to exclude regression.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
|
📣 Hey @kborowinski, how did we do? We would love to hear your feedback with the link below! 🗣️ 🔗 https://aka.ms/PSRepoFeedback |
PR Summary
Fix #24740
PR Context
Unwrap transcript filename stored as
PSObjectin$Transcriptpreference variable.PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerWIP:or[ WIP ]to the beginning of the title (theWIPbot will keep its status check atPendingwhile the prefix is present) and remove the prefix when the PR is ready.- [ ] Issue filed:
(which runs in a different PS Host).