Skip to content

Add Unicode formatting tests #12639

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
xtqqczze wants to merge 2 commits into from
Closed

Add Unicode formatting tests #12639

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f4ee00
Add FileEncoding tests
xtqqczze May 27, 2020
8fbb20b
Genericise `hasUtf8Bom` implementation
xtqqczze May 31, 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
30 changes: 30 additions & 0 deletions test/common/FileEncoding/FileEncoding.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Copyright (c) Microsoft Corporation.
Copy link
Member

@TravisEz13 TravisEz13 May 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should actually run this test somewhere

Copy link
Member

@TravisEz13 TravisEz13 May 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps, add another job to here
https://github.com/PowerShell/PowerShell/blob/master/.vsts-ci/misc-analysis.yml

Or add another workflow:

workflows

Whichever you are more comfortable with

# Licensed under the MIT License.

using namespace System

Describe 'Verify file encoding' {
BeforeAll {
Push-Location $PSScriptRoot\..\..\..
$nonBinaryFiles = (git grep -I --files-with-matches -e $'')
}

AfterAll {
Pop-Location
}

It 'No UTF-8 BOM' {
filter hasUtf8Bom {
$_.Where{
$bom = [Text.UnicodeEncoding]::UTF8.GetPreamble()
Copy link
Collaborator

@iSazonov iSazonov Nov 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it is better to detect the encoding. C# code:

            Encoding GetPathEncoding()
            {
                using (StreamReader reader = new StreamReader(this.Path, Utils.utf8NoBom, detectEncodingFromByteOrderMarks: true))
                {
                    _ = reader.Read();
                    return reader.CurrentEncoding;
                }
            }

$bytes = [byte[]]::new($bom.Length)
$stream = [IO.File]::OpenRead($_)
$stream.Read($bytes, 0, $bytes.Length) > $null
$stream.Close()
[Linq.Enumerable]::SequenceEqual($bom, $bytes)
}
}

$nonBinaryFiles | hasUtf8Bom | Should -BeNullOrEmpty
}
}