Expose OperatingSystem APIs as intrinsic property functions

[akoeplinger]

These are new in .NET 5.0: https://docs.microsoft.com/en-us/dotnet/api/system.operatingsystem?view=net-5.0

They expose methods for all the common operating systems like OperatingSystem.IsWindows() but also still support the API where you pass in a string: OperatingSystem.IsOSPlatform(string platform).

The new APIs are easier to understand so we should consider exposing them.

[vijaya-lakshmi-venkatraman]

Hi,
I would like to take this up if still available.
I am a newbie to MSBuild and appreciate any pointers to fix this issue

Thanks.

[akoeplinger]

@vijaya-lakshmi-venkatraman sure, I assigned the issue to you so you can give it a try :)

I think adding an entry similar to RuntimeInformation here should be enough:

msbuild/src/Build/Resources/Constants.cs

Line 379 in 5b9216a

availableStaticMethods.TryAdd("System.Runtime.InteropServices.RuntimeInformation", runtimeInformationType);

You'll probably need to wrap it in some ifdef, e.g. FEATURE_OS_APIS, since the API is only available from .NET 5+, so add the define here in a new PropertyGroup for net5.0 here:

msbuild/src/Directory.BeforeCommon.targets

Line 127 in 5b9216a

<PropertyGroup Condition="'$(TargetFramework)' == 'netcoreapp2.1' or '$(TargetFramework)' == 'net5.0'">

Also tests would be good :)

[vijaya-lakshmi-venkatraman]

Thank you for assigning the issue.
I will add a new PropertyGroup as below:

 <PropertyGroup Condition="'$(TargetFramework)' == 'net5.0'">
    <DefineConstants>$(DefineConstants);FEATURE_OS_APIS</DefineConstants>
  </PropertyGroup>

Please can you explain a bit on the change related to adding an entry similar to RuntimeInformation.
I am afraid I did not get that part :(

[akoeplinger]

It would look something like this:

                        var fileType = new Tuple<string, Type>(null, typeof(File));
                        var runtimeInformationType = new Tuple<string, Type>(null, typeof(RuntimeInformation));
                        var osPlatformType = new Tuple<string, Type>(null, typeof(OSPlatform));
+#if FEATURE_OS_APIS
+                       var operatingSystemType = new Tuple<string, Type>(null, typeof(OperatingSystem));
+#endif

                        // Make specific static methods available (Assembly qualified type names are *NOT* supported, only null which means mscorlib):
                        availableStaticMethods.TryAdd("System.Environment::ExpandEnvironmentVariables", environmentType);
@@ -378,6 +381,9 @@ private static void InitializeAvailableMethods()
                        availableStaticMethods.TryAdd("Microsoft.Build.Utilities.ToolLocationHelper", new Tuple<string, Type>("Microsoft.Build.Utilities.ToolLocationHelper, Microsoft.Build.Utilities.Core, Version=" + MSBuildConstants.CurrentAssemblyVersion + ", Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", null));
                        availableStaticMethods.TryAdd("System.Runtime.InteropServices.RuntimeInformation", runtimeInformationType);
                        availableStaticMethods.TryAdd("System.Runtime.InteropServices.OSPlatform", osPlatformType);
+#if FEATURE_OS_APIS
+                       availableStaticMethods.TryAdd("System.OperatingSystem", operatingSystemType);
+#endif

                        s_availableStaticMethods = availableStaticMethods;
                    }

[akoeplinger]

@vijaya-lakshmi-venkatraman do you still plan to work on this issue or should we put it back into the backlog?

[vijaya-lakshmi-venkatraman]

Hi @akoeplinger
yes, I have the changes locally but been trying to figure out reg CLA.
Hoping to merge and raise a PR soon.

[vijaya-lakshmi-venkatraman]

Hi @akoeplinger
Do you know how to get the Corporate CLA signed for contributions?

[akoeplinger]

@vijaya-lakshmi-venkatraman if you open a PR then you'll see a GitHub check with the CLA link and instructions on how to sign it.

[vijaya-lakshmi-venkatraman]

It'd be my manager that'd sign the CLA.
So can I request him to sign on the CLA link?

[danmoseley]

@vijaya-lakshmi-venkatraman as engineers, we unfortunately can't offer legal advice beyond the CLA bot instructions.

[akoeplinger]

From what I remember when signing the CLA five years ago before I started working for Microsoft you just had to acknowledge that your employer is fine with the contribution, i.e. you're responsible for checking with them but no separate signature required for the CLA. Not sure if it has changed since then so best to check with legal if you're unsure.

@akoeplinger @vijaya-lakshmi-venkatraman @danmoseley

Is anyone currently working on this?

The above collaboration makes sense for this specific issue, these Operating Systems APIs are only available in .NET 5.0 so adding the const FEATURE_OS_APIS only when it is available in .NET 5.0 and defining those ifdefs in the constant file to ensure it only gets added to the dictionary at that point in time.