Skip to content

Change New-ModuleManifest encoding to UTF8NoBOM on non-Windows platforms #3940

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

Merged
TravisEz13 merged 4 commits into from
Jun 27, 2017
Merged

Change New-ModuleManifest encoding to UTF8NoBOM on non-Windows platforms #3940

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cd06655
Change New-ModuleManifest encoding to UTF8NoBOM
Jun 5, 2017
85cde4c
Addressed PR feedback
Jun 6, 2017
880f9b5
Fixed test for Travis CI
Jun 6, 2017
dc92b32
Updated tests
Jun 16, 2017
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
10 changes: 7 additions & 3 deletions src/System.Management.Automation/engine/Modules/NewModuleManifestCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -940,8 +940,12 @@ protected override void EndProcessing()
// Now open the output file...
PathUtils.MasterStreamOpen(
this,
filePath,
EncodingConversion.Unicode,
filePath,
#if UNIX
new UTF8Encoding(false), // UTF-8, no BOM
#else
EncodingConversion.Unicode, // UTF-16 with BOM
#endif
/* defaultEncoding */ false,
/* Append */ false,
/* Force */ false,
Expand Down Expand Up @@ -1167,5 +1171,5 @@ private void ValidateUriParameterValue(Uri uri, string parameterName)
}
}

#endregion
#endregion
} // Microsoft.PowerShell.Commands
25 changes: 25 additions & 0 deletions test/powershell/engine/Module/NewModuleManifest.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,17 @@ Describe "New-ModuleManifest tests" -tags "CI" {
Remove-Item -Recurse -Force -ErrorAction SilentlyContinue testdrive:/module
}

BeforeAll {
if ($IsWindows)
{
$ExpectedManifestBytes = @(255,254,35,0,13,0,10,0)
}
else
{
$ExpectedManifestBytes = @(35,10)
}
}

It "Uris with spaces are allowed and escaped correctly" {
$testUri = [Uri]"http://foo.com/hello world"
$absoluteUri = $testUri.AbsoluteUri
Expand All @@ -20,6 +31,20 @@ Describe "New-ModuleManifest tests" -tags "CI" {
$module.PrivateData.PSData.ProjectUri | Should BeExactly $absoluteUri
}

function TestNewModuleManifestEncoding {
param ([byte[]]$expected)
New-ModuleManifest -Path $testModulePath
(Get-Content -Encoding Byte -Path $testModulePath -TotalCount $expected.Length) -join ',' | Should Be ($expected -join ',')
}

It "Verify module manifest encoding" {

# verify first line of the manifest:
# on Windows platforms - 3 characters - '#' '\r' '\n' - in UTF-16 with BOM - this should be @(255,254,35,0,13,0,10,0)
# on non-Windows platforms - 2 characters - '#' '\n' - in UTF-8 no BOM - this should be @(35,10)
TestNewModuleManifestEncoding -expected $ExpectedManifestBytes
}

It "Relative URIs are not allowed" {
$testUri = [Uri]"../foo"

Expand Down