Skip to content

Platform should return cross platform values under PSUserAgent #4945

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
chunqingchen wants to merge 1 commit into from
Closed

Platform should return cross platform values under PSUserAgent #4945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/PSUserAgent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,8 @@ internal static string Platform
{
get
{
return ("Windows NT");
OperatingSystem osInfo = Environment.OSVersion;
return (osInfo.Platform.ToString());
Copy link
Contributor

@markekraus markekraus Sep 29, 2017

Choose a reason for hiding this comment

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

This wont work. System.Platformid does not contain commonly accepted values for the platform part of a User-Agent header. For example, macOS should be Macintosh and all (recent) Windows should be Windows NT, and most Linux should be Linux or X11.

}
}

Expand Down
6 changes: 6 additions & 0 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/Environment-Variables.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,10 @@ Describe "Environment-Variables" -Tags "CI" {
$ENV:TESTENVIRONMENTVARIABLE | Should Be $expected

}

It "User Agent should reflect current plafformID" {
Copy link
Contributor

@markekraus markekraus Sep 29, 2017

Choose a reason for hiding this comment

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

This test should be in test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1

$bingdings = [System.Reflection.BindingFlags]::NonPublic -bxor [System.Reflection.BindingFlags]::Static
$platform = [Microsoft.PowerShell.Commands.PSUserAgent].GetProperty('Platform',$bingdings).GetValue($null,$null)
Copy link
Contributor

@markekraus markekraus Sep 29, 2017

Choose a reason for hiding this comment

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

We should probably not use reflection. Instead we should make a web call and ensure the User-Agent request header contains the desired data.

PowerShell/test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1

Lines 456 to 467 in b07f24e

It "Invoke-WebRequest returns User-Agent" {
$uri = Get-WebListenerUrl -Test 'Get'
$command = "Invoke-WebRequest -Uri '$uri' -TimeoutSec 5"
$result = ExecuteWebCommand -command $command
ValidateResponse -response $result
# Validate response content
$jsonContent = $result.Output.Content | ConvertFrom-Json
$jsonContent.headers.'User-Agent' | Should MatchExactly '(?<!Windows)PowerShell\/\d+\.\d+\.\d+.*'
}

$platform | Should BeExactly $PSVersionTable.platform
}
}