[Resources.OperatingSystem] Fix issue with detecting MacOS (#1965)

open-telemetry · Jul 22, 2024 · 269a3b8 · 269a3b8
1 parent b4d9029
commit 269a3b8
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 15 deletions.
diff --git a/.github/workflows/Component.BuildTest.yml b/.github/workflows/Component.BuildTest.yml
@@ -33,6 +33,8 @@ jobs:
         exclude:
         - os: ubuntu-latest
           version: net462
+        - os: macos-latest
+          version: net462
 
     runs-on: ${{ matrix.os }}
 
@@ -73,6 +75,11 @@ jobs:
 
     - name: Setup dotnet
       uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: |
+          6.0.x
+          7.0.x
+          8.0.x
 
     - name: dotnet restore ${{ steps.resolve-project.outputs.title }}
       run: dotnet restore ${{ steps.resolve-project.outputs.project }} -p:EnablePackageValidation=true

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -496,6 +496,7 @@ jobs:
     with:
       project-name: Component[OpenTelemetry.Resources.OperatingSystem]
       code-cov-name: Resources.OperatingSystem
+      os-list: '[ "windows-latest", "ubuntu-latest", "macos-latest" ]'
 
   build-test-resources-process:
     needs: detect-changes

diff --git a/src/OpenTelemetry.Resources.OperatingSystem/CHANGELOG.md b/src/OpenTelemetry.Resources.OperatingSystem/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+* Fix detection of macOS which was wrongly identified as Linux.
+  ([#1965](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/1965))
+
 ## 0.1.0-alpha.1
 
 Released 2024-Jul-11

diff --git a/src/OpenTelemetry.Resources.OperatingSystem/OperatingSystemDetector.cs b/src/OpenTelemetry.Resources.OperatingSystem/OperatingSystemDetector.cs
@@ -1,6 +1,9 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#if !NETFRAMEWORK
+using System.Runtime.InteropServices;
+#endif
 using static OpenTelemetry.Resources.OperatingSystem.OperatingSystemSemanticConventions;
 
 namespace OpenTelemetry.Resources.OperatingSystem;
@@ -31,22 +34,25 @@ public Resource Detect()
 
     private static string? GetOSType()
     {
-        var platform = Environment.OSVersion.Platform;
-        if (platform == PlatformID.Win32NT)
+#if NETFRAMEWORK
+        return OperatingSystemsValues.Windows;
+#else
+        if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
         {
             return OperatingSystemsValues.Windows;
         }
-
-        if (platform == PlatformID.MacOSX)
+        else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
+        {
+            return OperatingSystemsValues.Linux;
+        }
+        else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
         {
             return OperatingSystemsValues.Darwin;
         }
-
-        if (platform == PlatformID.Unix)
+        else
         {
-            return OperatingSystemsValues.Linux;
+            return null;
         }
-
-        return null;
+#endif
     }
 }
diff --git a/test/OpenTelemetry.Resources.OperatingSystem.Tests/OperatingSystemDetectorTests.cs b/test/OpenTelemetry.Resources.OperatingSystem.Tests/OperatingSystemDetectorTests.cs
@@ -1,6 +1,7 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+using System.Runtime.InteropServices;
 using Xunit;
 
 namespace OpenTelemetry.Resources.OperatingSystem.Test;
@@ -14,17 +15,29 @@ public void TestOperatingSystemAttributes()
 
         var resourceAttributes = resource.Attributes.ToDictionary(x => x.Key, x => (string)x.Value);
 
-        var operatingSystems = new[]
+        string expectedPlatform;
+
+        if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+        {
+            expectedPlatform = OperatingSystemSemanticConventions.OperatingSystemsValues.Windows;
+        }
+        else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
+        {
+            expectedPlatform = OperatingSystemSemanticConventions.OperatingSystemsValues.Linux;
+        }
+        else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
+        {
+            expectedPlatform = OperatingSystemSemanticConventions.OperatingSystemsValues.Darwin;
+        }
+        else
         {
-            OperatingSystemSemanticConventions.OperatingSystemsValues.Windows,
-            OperatingSystemSemanticConventions.OperatingSystemsValues.Linux,
-            OperatingSystemSemanticConventions.OperatingSystemsValues.Darwin,
-        };
+            throw new PlatformNotSupportedException("Unknown platform");
+        }
 
         Assert.Single(resourceAttributes);
 
         Assert.True(resourceAttributes.ContainsKey(OperatingSystemSemanticConventions.AttributeOperatingSystemType));
 
-        Assert.Contains(resourceAttributes[OperatingSystemSemanticConventions.AttributeOperatingSystemType], operatingSystems);
+        Assert.Equal(resourceAttributes[OperatingSystemSemanticConventions.AttributeOperatingSystemType], expectedPlatform);
     }
 }