Add RuntimeInformation.RuntimeIdentifier

This value returns the Runtime Identifier (RID) of the current machine. Contributes to dotnet#26780
eerhardt · Mar 27, 2020 · 6ef78bc · 6ef78bc
1 parent ab3d9ae
commit 6ef78bc
Show file tree

Hide file tree

Showing 8 changed files with 97 additions and 2 deletions.
diff --git a/src/installer/corehost/cli/hostpolicy/coreclr.cpp b/src/installer/corehost/cli/hostpolicy/coreclr.cpp
@@ -203,7 +203,8 @@ namespace
         _X("JIT_PATH"),
         _X("STARTUP_HOOKS"),
         _X("APP_PATHS"),
-        _X("APP_NI_PATHS")
+        _X("APP_NI_PATHS"),
+        _X("RUNTIME_IDENTIFIER")
     };
 
     static_assert((sizeof(PropertyNameMapping) / sizeof(*PropertyNameMapping)) == static_cast<size_t>(common_property::Last), "Invalid property count");

diff --git a/src/installer/corehost/cli/hostpolicy/coreclr.h b/src/installer/corehost/cli/hostpolicy/coreclr.h
@@ -67,6 +67,7 @@ enum class common_property
     StartUpHooks,
     AppPaths,
     AppNIPaths,
+    RuntimeIdentifier,
 
     // Sentinel value - new values should be defined above
     Last

diff --git a/src/installer/corehost/cli/hostpolicy/hostpolicy_context.cpp b/src/installer/corehost/cli/hostpolicy/hostpolicy_context.cpp
@@ -145,6 +145,7 @@ int hostpolicy_context_t::initialize(hostpolicy_init_t &hostpolicy_init, const a
     coreclr_properties.add(common_property::FxDepsFile, fx_deps_str.c_str());
     coreclr_properties.add(common_property::ProbingDirectories, resolver.get_lookup_probe_directories().c_str());
     coreclr_properties.add(common_property::FxProductVersion, clr_library_version.c_str());
+    coreclr_properties.add(common_property::RuntimeIdentifier, get_current_runtime_id(true /*use_fallback*/).c_str());
 
     if (!clrjit_path.empty())
         coreclr_properties.add(common_property::JitPath, clrjit_path.c_str());

diff --git a/...teropServices.RuntimeInformation/ref/System.Runtime.InteropServices.RuntimeInformation.cs b/...teropServices.RuntimeInformation/ref/System.Runtime.InteropServices.RuntimeInformation.cs
@@ -32,6 +32,7 @@ public enum Architecture
     }
     public static partial class RuntimeInformation
     {
+        public static string RuntimeIdentifier { get { throw null; } }
         public static string FrameworkDescription { get { throw null; } }
         public static System.Runtime.InteropServices.Architecture OSArchitecture { get { throw null; } }
         public static string OSDescription { get { throw null; } }

diff --git a/...meInformation/src/System/Runtime/InteropServices/RuntimeInformation/RuntimeInformation.cs b/...meInformation/src/System/Runtime/InteropServices/RuntimeInformation/RuntimeInformation.cs
@@ -10,6 +10,7 @@ public static partial class RuntimeInformation
     {
         private const string FrameworkName = ".NET Core";
         private static string? s_frameworkDescription;
+        private static string? s_runtimeIdentifier;
 
         public static string FrameworkDescription
         {
@@ -41,5 +42,18 @@ public static string FrameworkDescription
                 return s_frameworkDescription;
             }
         }
+
+        public static string RuntimeIdentifier
+        {
+            get
+            {
+                if (s_runtimeIdentifier == null)
+                {
+                    s_runtimeIdentifier = (string?)AppContext.GetData("RUNTIME_IDENTIFIER") ?? "unknown";
+                }
+
+                return s_runtimeIdentifier;
+            }
+        }
     }
 }
diff --git a/...libraries/System.Runtime.InteropServices.RuntimeInformation/tests/DescriptionNameTests.cs b/...libraries/System.Runtime.InteropServices.RuntimeInformation/tests/DescriptionNameTests.cs
@@ -22,7 +22,8 @@ public void DumpRuntimeInformationToConsole()
             string osd = RuntimeInformation.OSDescription.Trim();
             string osv = Environment.OSVersion.ToString();
             string osa = RuntimeInformation.OSArchitecture.ToString();
-            Console.WriteLine($"### OS: Distro={dvs} Description={osd} Version={osv} Arch={osa}");
+            string rid = RuntimeInformation.RuntimeIdentifier;
+            Console.WriteLine($"### OS: Distro={dvs} Description={osd} Version={osv} Arch={osa} Rid={rid}");
 
             string lcr = PlatformDetection.LibcRelease;
             string lcv = PlatformDetection.LibcVersion;

diff --git a/...braries/System.Runtime.InteropServices.RuntimeInformation/tests/RuntimeIdentifierTests.cs b/...braries/System.Runtime.InteropServices.RuntimeInformation/tests/RuntimeIdentifierTests.cs
@@ -0,0 +1,74 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.IO;
+using System.Linq;
+using Microsoft.DotNet.RemoteExecutor;
+using Xunit;
+
+namespace System.Runtime.InteropServices.RuntimeInformationTests
+{
+    public class RuntimeIdentifierTests
+    {
+        [Fact(Skip = "#26780 Need new testhost")]
+        public void VerifyOSRid()
+        {
+            Assert.NotNull(RuntimeInformation.RuntimeIdentifier);
+            Assert.Same(RuntimeInformation.RuntimeIdentifier, RuntimeInformation.RuntimeIdentifier);
+            Assert.EndsWith(RuntimeInformation.ProcessArchitecture.ToString(), RuntimeInformation.RuntimeIdentifier, StringComparison.OrdinalIgnoreCase);
+        }
+
+        [Fact(Skip = "#26780 Need new testhost")]
+        public void VerifyEnvironmentVariable()
+        {
+            RemoteInvokeOptions options = new RemoteInvokeOptions();
+            options.StartInfo.EnvironmentVariables.Add("DOTNET_RUNTIME_ID", "overridenFromEnv-rid");
+
+            RemoteExecutor.Invoke(() =>
+            {
+                Assert.Equal("overridenFromEnv-rid", RuntimeInformation.RuntimeIdentifier);
+            }, options).Dispose();
+        }
+
+        [Fact]
+        public void VerifyAppContextVariable()
+        {
+            RemoteExecutor.Invoke(() =>
+            {
+                AppDomain.CurrentDomain.SetData("RUNTIME_IDENTIFIER", "overriden-rid");
+
+                Assert.Equal("overriden-rid", RuntimeInformation.RuntimeIdentifier);
+            }).Dispose();
+        }
+
+        [Fact(Skip = "#26780 Need new testhost"), PlatformSpecific(TestPlatforms.Windows)]
+        public void VerifyWindowsRid()
+        {
+            Assert.StartsWith("win", RuntimeInformation.RuntimeIdentifier, StringComparison.OrdinalIgnoreCase);
+        }
+
+        [Fact(Skip = "#26780 Need new testhost"), PlatformSpecific(TestPlatforms.Linux)]
+        public void VerifyLinuxRid()
+        {
+            string expectedOSName = File.ReadAllLines("/etc/os-release")
+                .First(line => line.StartsWith("ID=", StringComparison.OrdinalIgnoreCase))
+                .Substring("ID=".Length)
+                .Trim();
+
+            Assert.StartsWith(expectedOSName, RuntimeInformation.RuntimeIdentifier, StringComparison.OrdinalIgnoreCase);
+        }
+
+        [Fact(Skip = "#26780 Need new testhost"), PlatformSpecific(TestPlatforms.FreeBSD)]
+        public void VerifyFreeBSDRid()
+        {
+            Assert.StartsWith("freebsd", RuntimeInformation.RuntimeIdentifier, StringComparison.OrdinalIgnoreCase);
+        }
+
+        [Fact(Skip = "#26780 Need new testhost"), PlatformSpecific(TestPlatforms.OSX)]
+        public void VerifyOSXRid()
+        {
+            Assert.StartsWith("osx", RuntimeInformation.RuntimeIdentifier, StringComparison.OrdinalIgnoreCase);
+        }
+    }
+}
diff --git a/...s.RuntimeInformation/tests/System.Runtime.InteropServices.RuntimeInformation.Tests.csproj b/...s.RuntimeInformation/tests/System.Runtime.InteropServices.RuntimeInformation.Tests.csproj
@@ -1,10 +1,12 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
+    <IncludeRemoteExecutor>true</IncludeRemoteExecutor>
     <TargetFrameworks>$(NetCoreAppCurrent)-Windows_NT;$(NetCoreAppCurrent)-Unix</TargetFrameworks>
   </PropertyGroup>
   <ItemGroup>
     <Compile Include="CheckArchitectureTests.cs" />
     <Compile Include="CheckPlatformTests.cs" />
+    <Compile Include="RuntimeIdentifierTests.cs" />
     <Compile Include="DescriptionNameTests.cs" />
     <Compile Include="$(CommonPath)Interop\Linux\cgroups\Interop.cgroups.cs">
       <Link>Common\Interop\Linux\Interop.cgroups.cs</Link>