Skip to content

Fix non append encoding to UTF8 No BOM in Start Transcript #13899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Gimly wants to merge 5 commits into from
Closed

Fix non append encoding to UTF8 No BOM in Start Transcript #13899

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8ca9c6d
Start transcript fix non append encoding
Gimly Oct 26, 2020
4758b70
Add unit test to check encoding of start-transcript files
Gimly Oct 29, 2020
39b2203
Use BeExactly to compare strings
Gimly Oct 30, 2020
c1e8e82
Change the syntax used to create the UTF8Encoding in unit tests
Gimly Dec 15, 2020
353acdb
Remove the creation of the random test file path
Gimly Dec 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Microsoft.PowerShell.ConsoleHost/host/msh/StartTranscriptCmdlet.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ protected override void BeginProcessing()
// If they didn't specify -Append, empty the file
if (!_shouldAppend)
{
System.IO.File.WriteAllText(effectiveFilePath, string.Empty);
System.IO.File.WriteAllText(effectiveFilePath, string.Empty, Utils.utf8NoBom);
}
}

Expand Down
36 changes: 36 additions & 0 deletions test/powershell/Modules/Microsoft.Powershell.Host/Start-Transcript.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,17 @@ Describe "Start-Transcript, Stop-Transcript tests" -tags "CI" {
}
## function ends here

$defaultEncoding = [System.Text.UTF8Encoding]::new($true)
function GetFileEncoding {
param (
[string] $filePath
)

$reader = [System.IO.StreamReader]::new($filePath, $defaultEncoding, $true)
$reader.Read() | Out-Null
return $reader.CurrentEncoding.BodyName
}

$transcriptFilePath = Join-Path $TestDrive "transcriptdata.txt"
Remove-Item $transcriptFilePath -Force -ErrorAction SilentlyContinue
}
Expand Down Expand Up @@ -129,6 +140,31 @@ Describe "Start-Transcript, Stop-Transcript tests" -tags "CI" {
# Nothing should have been returned by the FileSystemWatcher
Receive-Job $job | Should -Be $null
}
It "Should keep the existing file's encoding if the 'Append' parameter is used"{
"Text" | Out-File -Encoding unicode $transcriptFilePath

Start-Transcript -Append -Path $transcriptFilePath
Get-Date | Out-Null
Stop-Transcript

GetFileEncoding $transcriptFilePath | Should -BeExactly 'utf-16'
}
It "Should default to utf8 with 'Append' parameter and file doesn't exist"{
Start-Transcript -Append -Path $transcriptFilePath
Get-Date | Out-Null
Stop-Transcript

GetFileEncoding $transcriptFilePath | Should -BeExactly 'utf-8'
}
It "Should create a new utf8 encoded file if no 'Append' parameter is set regardless of existing file's encoding"{
"Text" | Out-File -Encoding unicode $transcriptFilePath

Start-Transcript -Path $transcriptFilePath
Get-Date | Out-Null
Stop-Transcript

GetFileEncoding $transcriptFilePath | Should -BeExactly 'utf-8'
}
It "Transcription should remain active if other runspace in the host get closed" {
try {
$ps = [powershell]::Create()
Expand Down