Merge pull request #216 from WeihanLi/dev

1.0.69

Author: WeihanLi

build/version.props

@@ -2,7 +2,7 @@
   <PropertyGroup>
     <VersionMajor>1</VersionMajor>
     <VersionMinor>0</VersionMinor>
-    <VersionPatch>68</VersionPatch>
+    <VersionPatch>69</VersionPatch>
     <VersionPrefix>$(VersionMajor).$(VersionMinor).$(VersionPatch)</VersionPrefix>
   </PropertyGroup>
 </Project>

src/WeihanLi.Common/Helpers/ApplicationHelper.cs

@@ -63,22 +63,34 @@ public static LibraryInfo GetLibraryInfo(Assembly assembly)
     /// </summary>
     public static string? GetDotnetPath()
     {
+        var environmentOverride = Environment.GetEnvironmentVariable("DOTNET_ROOT");
+        if (!string.IsNullOrEmpty(environmentOverride) && Directory.Exists(environmentOverride))
+        {
+            var execFileName =
+#if NET6_0_OR_GREATER
+                OperatingSystem.IsWindows()
+#else
+                RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
+#endif
+                ? "dotnet.exe"
+                : "dotnet"
+                ;
+            var dotnetExePath = Path.Combine(environmentOverride, execFileName);
+            if (File.Exists(dotnetExePath))
+                return dotnetExePath;
+
+            throw new InvalidOperationException($"dotnet executable file not found under specified DOTNET_ROOT {environmentOverride}");
+        }
         return ResolvePath("dotnet");
     }
 
     public static string GetDotnetDirectory()
     {
-        var environmentOverride = Environment.GetEnvironmentVariable("DOTNET_MSBUILD_SDK_RESOLVER_CLI_DIR");
-        if (!string.IsNullOrEmpty(environmentOverride))
-        {
-            return environmentOverride;
-        }
-
         var dotnetExe = GetDotnetPath();
 
         if (dotnetExe.IsNotNullOrEmpty() && !InteropHelper.RunningOnWindows)
         {
-            // e.g. on Linux the 'dotnet' command from PATH is a symlink so we need to
+            // e.g. on Linux the 'dotnet' command from PATH is a symbol link so we need to
             // resolve it to get the actual path to the binary
             dotnetExe = InteropHelper.Unix.RealPath(dotnetExe) ?? dotnetExe;
         }
@@ -97,15 +109,15 @@ public static string GetDotnetDirectory()
 
     public static string? ResolvePath(string execName) => ResolvePath(execName, ".exe");
 
-    public static string? ResolvePath(string execName, string? ext)
+    public static string? ResolvePath(string execName, string? windowsExt)
     {
         var executableName = execName;
         if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
             && !Path.HasExtension(execName)
-            && string.IsNullOrEmpty(ext)
+            && !string.IsNullOrEmpty(windowsExt)
             )
         {
-            executableName += ext;
+            executableName = $"{executableName}{windowsExt}";
         }
         var searchPaths = Guard.NotNull(Environment.GetEnvironmentVariable("PATH"))
             .Split(new[] { Path.PathSeparator }, options: StringSplitOptions.RemoveEmptyEntries)
@@ -125,7 +137,7 @@ private static RuntimeInfo GetRuntimeInfo()
 #else
         var currentProcess = System.Diagnostics.Process.GetCurrentProcess();
 #endif
-        return new RuntimeInfo()
+        var runtimeInfo = new RuntimeInfo()
         {
             Version = Environment.Version.ToString(),
             ProcessorCount = Environment.ProcessorCount,
@@ -144,33 +156,45 @@ private static RuntimeInfo GetRuntimeInfo()
             OSDescription = RuntimeInformation.OSDescription,
             OSVersion = Environment.OSVersion.ToString(),
             MachineName = Environment.MachineName,
+            UserName = Environment.UserName,
 
             IsInContainer = IsInContainer(),
             IsInKubernetes = IsInKubernetesCluster(),
+            KubernetesNamespace = GetKubernetesNamespace(),
 
             LibraryVersion = libInfo.LibraryVersion,
             LibraryHash = libInfo.LibraryHash,
             RepositoryUrl = libInfo.RepositoryUrl,
         };
+        return runtimeInfo;
     }
 
     #region ContainerEnvironment
+    // container environment
+    // https://github.com/dotnet/dotnet-docker/blob/d90d458deada9057d7889f76d58fc0a7194a0c06/src/runtime-deps/6.0/alpine3.20/amd64/Dockerfile#L7
+
+    /// <summary>
+    /// Whether running inside a container
+    /// </summary>
     private static bool IsInContainer()
     {
-        // https://github.com/dotnet/dotnet-docker/blob/9b731e901dd4a343fc30da7b8b3ab7d305a4aff9/src/runtime-deps/7.0/cbl-mariner2.0/amd64/Dockerfile#L18
         return "true".Equals(Environment.GetEnvironmentVariable("DOTNET_RUNNING_IN_CONTAINER"),
             StringComparison.OrdinalIgnoreCase);
     }
 
+    // Kubernetes environment
+    // https://github.com/kubernetes-client/csharp/blob/36a02046439d01f1256aed4e5071cb7f1b57d6eb/src/KubernetesClient/KubernetesClientConfiguration.InCluster.cs#L41
     private static readonly string ServiceAccountPath =
         Path.Combine(
         [
             $"{Path.DirectorySeparatorChar}var", "run", "secrets", "kubernetes.io", "serviceaccount",
         ]);
     private const string ServiceAccountTokenKeyFileName = "token";
     private const string ServiceAccountRootCAKeyFileName = "ca.crt";
+    private const string ServiceAccountNamespaceFileName = "namespace";
+
     /// <summary>
-    /// Whether running in k8s cluster
+    /// Whether running inside a k8s cluster
     /// </summary>
     /// <returns></returns>
     private static bool IsInKubernetesCluster()
@@ -191,8 +215,17 @@ private static bool IsInKubernetesCluster()
         var certPath = Path.Combine(ServiceAccountPath, ServiceAccountRootCAKeyFileName);
         return File.Exists(certPath);
     }
-    #endregion ContainerEnvironment
 
+    /// <summary>
+    /// Get Kubernetes namespace
+    /// </summary>
+    /// <returns>The namespace current workload in</returns>
+    private static string? GetKubernetesNamespace()
+    {
+        var namespaceFilePath = Path.Combine(ServiceAccountPath, ServiceAccountNamespaceFileName);
+        return File.Exists(namespaceFilePath) ? File.ReadAllText(namespaceFilePath).Trim() : null;
+    }
+    #endregion ContainerEnvironment
 }
 
 public class LibraryInfo
@@ -202,7 +235,7 @@ public class LibraryInfo
     public required string RepositoryUrl { get; init; }
 }
 
-public sealed class RuntimeInfo : LibraryInfo
+public class RuntimeInfo : LibraryInfo
 {
     public required string Version { get; init; }
     public required string FrameworkDescription { get; init; }
@@ -211,6 +244,7 @@ public sealed class RuntimeInfo : LibraryInfo
     public required string OSDescription { get; init; }
     public required string OSVersion { get; init; }
     public required string MachineName { get; init; }
+    public required string UserName { get; init; }
 
 #if NET6_0_OR_GREATER
     public required string RuntimeIdentifier { get; init; }
@@ -229,4 +263,9 @@ public sealed class RuntimeInfo : LibraryInfo
     /// Is running in a Kubernetes cluster
     /// </summary>
     public required bool IsInKubernetes { get; init; }
+
+    /// <summary>
+    /// Kubernetes namespace when running in a Kubernetes cluster
+    /// </summary>
+    public string? KubernetesNamespace { get; init; }
 }

test/WeihanLi.Common.Test/HelpersTest/ApplicationHelperTest.cs

@@ -0,0 +1,18 @@
+// Copyright (c) Weihan Li. All rights reserved.
+// Licensed under the Apache license.
+
+using WeihanLi.Common.Helpers;
+using Xunit;
+
+namespace WeihanLi.Common.Test.HelpersTest;
+public class ApplicationHelperTest
+{
+    [Fact]
+    public void DotnetPathTest()
+    {
+        var dotnetPath = ApplicationHelper.GetDotnetPath();
+        Assert.NotNull(dotnetPath);
+        Assert.NotEmpty(dotnetPath);
+        Assert.True(File.Exists(dotnetPath));
+    }
+}