File size: 13,627 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 | # Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
Describe "Start-Transcript, Stop-Transcript tests" -tags "CI" {
BeforeAll {
function ValidateTranscription {
param (
[string] $scriptToExecute,
[string] $outputFilePath,
[switch] $append,
[switch] $noClobber,
[string] $expectedError
)
if($append -or $noClobber) {
#Add sample text to the file
$content = "This is sample text!"
$content | Out-File -FilePath $outputFilePath
Test-Path $outputFilePath | Should -BeTrue
}
try {
#execute script
$ps = [powershell]::Create()
$ps.addscript($scriptToExecute).Invoke()
$ps.commands.clear()
if($expectedError) {
$ps.hadErrors | Should -BeTrue
$ps.Streams.Error.FullyQualifiedErrorId | Should -Be $expectedError
} else {
$ps.addscript("Get-Date").Invoke()
$ps.commands.clear()
$ps.addscript("Stop-Transcript").Invoke()
Test-Path $outputFilePath | Should -BeTrue
$outputFilePath | Should -FileContentMatch "Get-Date"
if($append) {
$outputFilePath | Should -FileContentMatch $content
}
}
} finally {
if ($null -ne $ps) {
$ps.Dispose()
}
}
}
## function ends here
$transcriptFilePath = Join-Path $TestDrive "transcriptdata.txt"
Remove-Item $transcriptFilePath -Force -ErrorAction SilentlyContinue
}
AfterEach {
Remove-Item $transcriptFilePath -ErrorAction SilentlyContinue
[System.Management.Automation.Internal.InternalTestHooks]::SetTestHook('ForcePromptForChoiceDefaultOption', $false)
}
It "Should create Transcript file at default path" {
$script = "Start-Transcript"
if ($IsWindows) {
$defaultTranscriptFilePath = [io.path]::Combine($env:USERPROFILE, "Documents", "PowerShell_transcript*")
} else {
$defaultTranscriptFilePath = [io.path]::Combine($env:HOME, "PowerShell_transcript*")
}
try {
#Make sure there is no stale data
Remove-Item $defaultTranscriptFilePath -Force -ErrorAction SilentlyContinue
ValidateTranscription -scriptToExecute $script -outputFilePath $defaultTranscriptFilePath
} finally {
#Remove test data
Remove-Item $defaultTranscriptFilePath -ErrorAction SilentlyContinue
}
}
It "Should create Transcript file with 'Path' parameter" {
$script = "Start-Transcript -path $transcriptFilePath"
ValidateTranscription -scriptToExecute $script -outputFilePath $transcriptFilePath
}
It "Should create Transcript file with 'LiteralPath' parameter" {
$script = "Start-Transcript -LiteralPath $transcriptFilePath"
ValidateTranscription -scriptToExecute $script -outputFilePath $transcriptFilePath
}
It "Should create Transcript file with 'OutputDirectory' parameter" {
$script = "Start-Transcript -OutputDirectory $TestDrive"
$outputFilePath = Join-Path $TestDrive "PowerShell_transcript*"
ValidateTranscription -scriptToExecute $script -outputFilePath $outputFilePath
}
It "Should create Transcript file with 'Transcript' preference variable" {
# Casting to PSObject is necessary because Set-Variable does not automatically wrap the value in a PSObject
$script = "Set-Variable -Scope Global -Name Transcript -Value ([PSObject]'$transcriptFilePath'); Start-Transcript"
ValidateTranscription -scriptToExecute $script -outputFilePath $transcriptFilePath
}
It "Should Append Transcript data in existing file if 'Append' parameter is used with Path parameter" {
$script = "Start-Transcript -path $transcriptFilePath -Append"
ValidateTranscription -scriptToExecute $script -outputFilePath $transcriptFilePath -append
}
It "Should return an error if the file exists and NoClobber is used" {
$script = "Start-Transcript -path $transcriptFilePath -NoClobber"
$expectedError = "NoClobber,Microsoft.PowerShell.Commands.StartTranscriptCommand"
ValidateTranscription -scriptToExecute $script -outputFilePath $transcriptFilePath -noClobber -expectedError $expectedError
}
It "Should return an error if the path resolves to an existing directory" {
$script = "Start-Transcript -path $TestDrive"
$expectedError = "CannotStartTranscription,Microsoft.PowerShell.Commands.StartTranscriptCommand"
ValidateTranscription -scriptToExecute $script -outputFilePath $null -expectedError $expectedError
}
It "Should return an error if file path is invalid" {
$fileName = (Get-Random).ToString()
$inputPath = Join-Path $TestDrive $fileName
$null = New-Item -Path $inputPath -ItemType File -Force -ErrorAction SilentlyContinue
$script = "Start-Transcript -OutputDirectory $inputPath"
$expectedError = "CannotStartTranscription,Microsoft.PowerShell.Commands.StartTranscriptCommand"
ValidateTranscription -scriptToExecute $script -outputFilePath $null -expectedError $expectedError
}
It "Should not delete the file if it already exist" {
# Create an existing file
$transcriptFilePath = Join-Path $TestDrive ([System.IO.Path]::GetRandomFileName())
Out-File $transcriptFilePath
$FileSystemWatcher = [System.IO.FileSystemWatcher]::new((Split-Path -Parent $transcriptFilePath), (Split-Path -Leaf $transcriptFilePath))
$Job = Register-ObjectEvent -InputObject $FileSystemWatcher -EventName "Deleted" -SourceIdentifier "FileDeleted" -Action {
return "FileDeleted"
}
try {
Start-Transcript -Path $transcriptFilePath
Stop-Transcript
} finally {
Unregister-Event -SourceIdentifier "FileDeleted"
}
# Nothing should have been returned by the FileSystemWatcher
Receive-Job $job | Should -Be $null
}
It "Transcription should remain active if other runspace in the host get closed" {
try {
$ps = [powershell]::Create()
$ps.addscript("Start-Transcript -path $transcriptFilePath").Invoke()
$ps.addscript('$rs = [system.management.automation.runspaces.runspacefactory]::CreateRunspace()').Invoke()
$ps.addscript('$rs.open()').Invoke()
$ps.addscript('$rs.Dispose()').Invoke()
$ps.addscript('Write-Host "After Dispose"').Invoke()
$ps.addscript("Stop-Transcript").Invoke()
} finally {
if ($null -ne $ps) {
$ps.Dispose()
}
}
$transcriptFilePath | Should -Exist
$transcriptFilePath | Should -FileContentMatch "After Dispose"
}
It "Transcription should be closed if the only runspace gets closed" {
& "$PSHOME/pwsh" -c "start-transcript $transcriptFilePath; Write-Host ''Before Dispose'';"
$transcriptFilePath | Should -Exist
$transcriptFilePath | Should -FileContentMatch "Before Dispose"
$transcriptFilePath | Should -FileContentMatch "PowerShell transcript end"
}
It "Transcription should record native command output" {
$script = {
Start-Transcript -Path $transcriptFilePath
hostname
Stop-Transcript
}
& $script
$transcriptFilePath | Should -Exist
$machineName = [System.Environment]::MachineName
$transcriptFilePath | Should -FileContentMatch $machineName
}
It "Transcription should record Write-Information output when InformationAction is set to Continue" {
[String]$message = New-Guid
$script = {
Start-Transcript -Path $transcriptFilePath
Write-Information -Message $message -InformationAction Continue
Stop-Transcript
}
& $script
$transcriptFilePath | Should -Exist
$transcriptFilePath | Should -Not -FileContentMatch "INFO: "
$transcriptFilePath | Should -FileContentMatch $message
}
It "Transcription should not record Write-Information output when InformationAction is set to SilentlyContinue" {
[String]$message = New-Guid
$traceData = Join-Path $TESTDRIVE tracedata.txt
$script = {
Start-Transcript -Path $transcriptFilePath
Trace-Command -File $traceData -Name param* { Write-Information -Message $message -InformationAction SilentlyContinue }
Stop-Transcript
}
& $script
$transcriptFilePath | Should -Exist
$transcriptFilePath | Should -Not -FileContentMatch "INFO: "
$transcriptFilePath | Should -Not -FileContentMatch $message -Because (get-content $transcriptFilePath,$traceData)
}
It "Transcription should not record Write-Information output when InformationAction is set to Ignore" {
[String]$message = New-Guid
$script = {
Start-Transcript -Path $transcriptFilePath
Write-Information -Message $message -InformationAction Ignore
Stop-Transcript
}
& $script
$transcriptFilePath | Should -Exist
$transcriptFilePath | Should -Not -FileContentMatch "INFO: "
$transcriptFilePath | Should -Not -FileContentMatch $message
}
It "Transcription should record Write-Information output in correct order when InformationAction is set to Inquire" {
[String]$message = New-Guid
$newLine = [System.Environment]::NewLine
$expectedContent = "$message$($newLine)Confirm$($newLine)Continue with this operation?"
$script = {
[System.Management.Automation.Internal.InternalTestHooks]::SetTestHook('ForcePromptForChoiceDefaultOption', $true)
Start-Transcript -Path $transcriptFilePath
Write-Information -Message $message -InformationAction Inquire
Stop-Transcript
}
& $script
$transcriptFilePath | Should -Exist
$transcriptFilePath | Should -Not -FileContentMatch "INFO: "
$transcriptFilePath | Should -FileContentMatchMultiline $expectedContent
}
It "Transcription should record Write-Host output when InformationAction is set to Continue" {
[String]$message = New-Guid
$script = {
Start-Transcript -Path $transcriptFilePath
Write-Host -Message $message -InformationAction Continue
Stop-Transcript
}
& $script
$transcriptFilePath | Should -Exist
$transcriptFilePath | Should -FileContentMatch $message
}
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
}
It "Transcription should not record Write-Host output when InformationAction is set to Ignore" {
[String]$message = New-Guid
$script = {
Start-Transcript -Path $transcriptFilePath
Write-Host -Message $message -InformationAction Ignore
Stop-Transcript
}
& $script
$transcriptFilePath | Should -Exist
$transcriptFilePath | Should -Not -FileContentMatch $message
}
It "Transcription should record Write-Host output in correct order when InformationAction is set to Inquire" {
[String]$message = New-Guid
$newLine = [System.Environment]::NewLine
$expectedContent = "$message$($newLine)Confirm$($newLine)Continue with this operation?"
$script = {
[System.Management.Automation.Internal.InternalTestHooks]::SetTestHook('ForcePromptForChoiceDefaultOption', $true)
Start-Transcript -Path $transcriptFilePath
Write-Host -Message $message -InformationAction Inquire
Stop-Transcript
}
& $script
$transcriptFilePath | Should -Exist
$transcriptFilePath | Should -FileContentMatchMultiline $expectedContent
}
It "UseMinimalHeader should reduce length of transcript header" {
$script = {
Start-Transcript -Path $transcriptFilePath
Stop-Transcript
}
$transcriptMinHeaderFilePath = $transcriptFilePath + "_minimal"
$scriptMinHeader = {
Start-Transcript -Path $transcriptMinHeaderFilePath -UseMinimalHeader
Stop-Transcript
}
& $script
$transcriptFilePath | Should -Exist
$transcriptLength = (Get-Content -Path $transcriptFilePath -Raw).Length
& $scriptMinHeader
$transcriptMinHeaderFilePath | Should -Exist
$transcriptMinHeaderLength = (Get-Content -Path $transcriptMinHeaderFilePath -Raw).Length
Remove-Item $transcriptMinHeaderFilePath -ErrorAction SilentlyContinue
$transcriptMinHeaderLength | Should -BeLessThan $transcriptLength
}
}
|