Skip to content

add OSPlatform.macOS, make OSPlatform.Equal use OrdinalIgnoreCaseComparison #39064

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
adamsitnik wants to merge 11 commits into from
Closed

add OSPlatform.macOS, make OSPlatform.Equal use OrdinalIgnoreCaseComparison #39064

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
5909ffe
introduce new OSPlatforms
adamsitnik Jul 10, 2020
d586408
use OrdinalIgnoreCase instead of Ordinal for os platform name compari…
adamsitnik Jul 10, 2020
76783a6
hide OSX, make sure OSX == macOS
adamsitnik Jul 10, 2020
2d2ed3e
add more tests
adamsitnik Jul 10, 2020
f388f03
Merge remote-tracking branch 'upstream/master' into 33331newOsPlatforms
adamsitnik Jul 10, 2020
7a8f548
simplify the code based on ideas from code review
adamsitnik Jul 10, 2020
8a3277e
add more test cases
adamsitnik Jul 10, 2020
d3e751d
add suggested test cases
adamsitnik Jul 10, 2020
8ae72cf
address code review feedback
adamsitnik Jul 10, 2020
f3c439a
fix a bug that I've introduced
adamsitnik Jul 10, 2020
84d959a
use StringComparison.OrdinalIgnoreCase in GetHashCode as well
adamsitnik Jul 10, 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
1 change: 1 addition & 0 deletions ...teropServices.RuntimeInformation/ref/System.Runtime.InteropServices.RuntimeInformation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ public enum Architecture
public static System.Runtime.InteropServices.OSPlatform Browser { get { throw null; } }
public static System.Runtime.InteropServices.OSPlatform FreeBSD { get { throw null; } }
public static System.Runtime.InteropServices.OSPlatform iOS { get { throw null; } }
public static System.Runtime.InteropServices.OSPlatform macOS { get { throw null; } }
public static System.Runtime.InteropServices.OSPlatform Linux { get { throw null; } }
public static System.Runtime.InteropServices.OSPlatform OSX { get { throw null; } }
public static System.Runtime.InteropServices.OSPlatform tvOS { get { throw null; } }
Expand Down
40 changes: 33 additions & 7 deletions ...es.RuntimeInformation/src/System/Runtime/InteropServices/RuntimeInformation/OSPlatform.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.ComponentModel;

namespace System.Runtime.InteropServices
{
public readonly struct OSPlatform : IEquatable<OSPlatform>
Expand All @@ -15,8 +17,11 @@ namespace System.Runtime.InteropServices

public static OSPlatform Linux { get; } = new OSPlatform("LINUX");

[EditorBrowsable(EditorBrowsableState.Never)] // https://github.com/dotnet/runtime/issues/33331#issuecomment-650326500
Copy link
Member

@jkotas jkotas Jul 10, 2020

Choose a reason for hiding this comment

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

Is this link really useful for context? It points to several screens of API review notes, and it does not say much useful about the OSX.

Should this rather say "// superseded by macOS" ?

public static OSPlatform OSX { get; } = new OSPlatform("OSX");

public static OSPlatform macOS { get; } = new OSPlatform(nameof(macOS));

public static OSPlatform iOS { get; } = new OSPlatform("IOS");

public static OSPlatform tvOS { get; } = new OSPlatform("TVOS");
Expand All @@ -40,17 +45,12 @@ public static OSPlatform Create(string osPlatform)

public bool Equals(OSPlatform other)
{
return Equals(other._osPlatform);
}

internal bool Equals(string? other)
{
return string.Equals(_osPlatform, other, StringComparison.Ordinal);
return string.Equals(_osPlatform, other._osPlatform, StringComparison.OrdinalIgnoreCase) || AreOSXAndMacOS(_osPlatform, other._osPlatform);
}

public override bool Equals(object? obj)
{
return obj is OSPlatform && Equals((OSPlatform)obj);
return obj is OSPlatform osPlatform && Equals(osPlatform);
}

public override int GetHashCode()
Expand All @@ -72,5 +72,31 @@ public override string ToString()
{
return !(left == right);
}

// this ugly method exists to not break backward compatibility
// for cases where users use the old `OSX` property on macOS
private bool AreOSXAndMacOS(string left, string right)
{
if (left == null || right == null)
{
return false;
}

const string OSX = "OSX";
const string macOS = "macOS";

if (left.Length == OSX.Length && right.Length == macOS.Length)
{
return string.Equals(left, OSX, StringComparison.OrdinalIgnoreCase)
&& string.Equals(right, macOS, StringComparison.OrdinalIgnoreCase);
}
else if (left.Length == macOS.Length && right.Length == OSX.Length)
{
return string.Equals(left, macOS, StringComparison.OrdinalIgnoreCase)
&& string.Equals(right, OSX, StringComparison.OrdinalIgnoreCase);
}

return false;
}
}
}
99 changes: 75 additions & 24 deletions src/libraries/System.Runtime.InteropServices.RuntimeInformation/tests/CheckPlatformTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Runtime.InteropServices;
using Xunit;

namespace System.Runtime.InteropServices.RuntimeInformationTests
Expand All @@ -13,10 +12,10 @@ public void CheckLinux()
{
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Linux));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("LINUX")));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("linux")));

Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("DARWIN")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("FREEBSD")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("linux")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("NETBSD")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("NetBSD")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("netbsd")));
Expand All @@ -25,15 +24,20 @@ public void CheckLinux()
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.OSX));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Android));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.macOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.iOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.tvOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.watchOS));
}

[Fact, PlatformSpecific(TestPlatforms.NetBSD)] // Tests RuntimeInformation OS platform
public void CheckNetBSD()
{
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("NETBSD")));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("NetBSD")));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("netbsd")));

Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("NetBSD")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("netbsd")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("DARWIN")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("FREEBSD")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("LINUX")));
Expand All @@ -44,32 +48,60 @@ public void CheckNetBSD()
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.OSX));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Android));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.macOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.iOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.tvOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.watchOS));
}

[Fact, PlatformSpecific(TestPlatforms.OSX)] // Tests RuntimeInformation OS platform
public void CheckOSX()
{
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.OSX));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("osx")));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.macOS));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("macos")));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("OSX")));

Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("FREEBSD")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("NETBSD")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("NetBSD")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("netbsd")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("osx")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("mac")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("DARWIN")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("MACOSX")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Linux));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Android));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.iOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.tvOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.watchOS));
}

[Fact, PlatformSpecific(TestPlatforms.Android)]
public void CheckAndroid()
{
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Android));

Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.OSX));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.macOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Linux));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Browser));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.iOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.tvOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.watchOS));
}

[Fact, PlatformSpecific(TestPlatforms.iOS)] // Tests RuntimeInformation OS platform
public void CheckiOS()
{
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.iOS));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("IOS")));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("iOS")));

Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("FREEBSD")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("NETBSD")));
Expand All @@ -82,13 +114,17 @@ public void CheckiOS()
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Linux));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.OSX));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.macOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Android));
}

[Fact, PlatformSpecific(TestPlatforms.tvOS)] // Tests RuntimeInformation OS platform
public void ChecktvOS()
{
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.tvOS));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("TVOS")));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("tvOS")));

Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("FREEBSD")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("NETBSD")));
Expand All @@ -101,26 +137,11 @@ public void ChecktvOS()
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Linux));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.OSX));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.macOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Android));
}

[Fact, PlatformSpecific(TestPlatforms.Android)] // Tests RuntimeInformation OS platform
public void CheckAndroid()
{
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Android));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("ANDROID")));

Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("FREEBSD")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("NETBSD")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("NetBSD")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("netbsd")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("osx")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("mac")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("DARWIN")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("MACOSX")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Linux));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD));
}

[Fact, PlatformSpecific(TestPlatforms.Browser)] // Tests RuntimeInformation OS platform
public void CheckBrowser()
Expand All @@ -139,30 +160,40 @@ public void CheckBrowser()
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Linux));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.OSX));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.macOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Android));
}

[Fact, PlatformSpecific(TestPlatforms.Windows)] // Tests RuntimeInformation OS platform
public void CheckWindows()
{
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("WINDOWS")));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("windows")));

Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("FREEBSD")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("NETBSD")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("NetBSD")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("netbsd")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("windows")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("Windows NT")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Linux));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.OSX));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Android));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.macOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.iOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.tvOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.watchOS));

}

[Fact, PlatformSpecific(TestPlatforms.FreeBSD)] // Tests RuntimeInformation OS platform
public void CheckFreeBSD()
{
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("FREEBSD")));
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Create("freebsd")));

Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("DARWIN")));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Create("LINUX")));
Expand All @@ -173,6 +204,11 @@ public void CheckFreeBSD()
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Linux));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.OSX));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Windows));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.macOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.iOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.tvOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.watchOS));
Assert.False(RuntimeInformation.IsOSPlatform(OSPlatform.Android));
}

[Fact]
Expand Down Expand Up @@ -213,5 +249,20 @@ public void CheckOSPlatform()
Assert.Equal(0, defaultObj.GetHashCode());
Assert.Equal(defaultObj.GetHashCode(), conObj.GetHashCode());
}

[Fact]
public void PlatformNamesAreComparedUsingOrdinalIgnoreCase()
{
Assert.Equal(OSPlatform.Create("ab"), OSPlatform.Create("ab"));
Assert.Equal(OSPlatform.Create("AB"), OSPlatform.Create("AB"));
Assert.Equal(OSPlatform.Create("AB"), OSPlatform.Create("ab"));
Assert.Equal(OSPlatform.Create("aB"), OSPlatform.Create("Ab"));
}

[Fact]
public void OSX_equals_macOS()
{
Assert.Equal(OSPlatform.OSX, OSPlatform.macOS);
}
}
}