build: annotate platform-specific code

mjcheetham · mjcheetham · commit 3c1406e0780c · 2023-10-25T11:45:42.000-07:00
Annotate any OS or platform specific code with the new
(Un)SupportedOSPlatform(Guard) attributes and update various platform
util methods to use the OperatingSystem.Is&lt;platform&gt; methods.

This will help ensure we're not missing any OS checks in the future.

For test projects we ignore these warnings since we're using skipping
Xunit tests that are not applicable for the current platform already,
making these warnings just noise.
diff --git a/Directory.Build.targets b/Directory.Build.targets
@@ -33,4 +33,9 @@
     </ItemGroup>
   </Target>
 
+  <PropertyGroup>
+    <!-- Ignore platform API compatibilty checks in test projects -->
+    <NoWarn Condition="'$(IsTestProject)'=='true'">$(NoWarn);CA1416</NoWarn>
+  </PropertyGroup>
+
 </Project>
diff --git a/src/shared/Core/Constants.cs b/src/shared/Core/Constants.cs
@@ -16,6 +16,10 @@ public static class Constants
 
         public const string GcmDataDirectoryName = ".gcm";
 
+        public const string WindowsPlatformName = "windows";
+        public const string LinuxPlatformName = "linux";
+        public const string MacOSPlatformName = "osx";
+
         public static readonly Guid DevBoxPartnerId = new("e3171dd9-9a5f-e5be-b36c-cc7c4f3f3bcf");
 
         /// <summary>
diff --git a/src/shared/Core/Interop/Linux/LinuxFileSystem.cs b/src/shared/Core/Interop/Linux/LinuxFileSystem.cs
@@ -1,9 +1,11 @@
 using System;
 using System.IO;
+using System.Runtime.Versioning;
 using GitCredentialManager.Interop.Posix;
 
 namespace GitCredentialManager.Interop.Linux
 {
+    [SupportedOSPlatform(Constants.LinuxPlatformName)]
     public class LinuxFileSystem : PosixFileSystem
     {
         public override bool IsSamePath(string a, string b)
diff --git a/src/shared/Core/Interop/Linux/LinuxSessionManager.cs b/src/shared/Core/Interop/Linux/LinuxSessionManager.cs
@@ -1,7 +1,9 @@
+using System.Runtime.Versioning;
 using GitCredentialManager.Interop.Posix;
 
 namespace GitCredentialManager.Interop.Linux;
 
+[SupportedOSPlatform(Constants.LinuxPlatformName)]
 public class LinuxSessionManager : PosixSessionManager
 {
     private bool? _isWebBrowserAvailable;
diff --git a/src/shared/Core/Interop/Linux/LinuxTerminal.cs b/src/shared/Core/Interop/Linux/LinuxTerminal.cs
@@ -1,10 +1,12 @@
 using System;
+using System.Runtime.Versioning;
 using GitCredentialManager.Interop.Linux.Native;
 using GitCredentialManager.Interop.Posix;
 using GitCredentialManager.Interop.Posix.Native;
 
 namespace GitCredentialManager.Interop.Linux
 {
+    [SupportedOSPlatform(Constants.LinuxPlatformName)]
     public class LinuxTerminal : PosixTerminal
     {
         public LinuxTerminal(ITrace trace, ITrace2 trace2)
diff --git a/src/shared/Core/Interop/MacOS/MacOSEnvironment.cs b/src/shared/Core/Interop/MacOS/MacOSEnvironment.cs
@@ -2,11 +2,13 @@
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
+using System.Runtime.Versioning;
 using System.Threading;
 using GitCredentialManager.Interop.Posix;
 
 namespace GitCredentialManager.Interop.MacOS
 {
+    [SupportedOSPlatform(Constants.MacOSPlatformName)]
     public class MacOSEnvironment : PosixEnvironment
     {
         private ICollection<string> _pathsToIgnore;
diff --git a/src/shared/Core/Interop/MacOS/MacOSFileSystem.cs b/src/shared/Core/Interop/MacOS/MacOSFileSystem.cs
@@ -1,9 +1,11 @@
 using System;
 using System.IO;
+using System.Runtime.Versioning;
 using GitCredentialManager.Interop.Posix;
 
 namespace GitCredentialManager.Interop.MacOS
 {
+    [SupportedOSPlatform(Constants.MacOSPlatformName)]
     public class MacOSFileSystem : PosixFileSystem
     {
         public override bool IsSamePath(string a, string b)
diff --git a/src/shared/Core/Interop/MacOS/MacOSSessionManager.cs b/src/shared/Core/Interop/MacOS/MacOSSessionManager.cs
@@ -1,8 +1,10 @@
+using System.Runtime.Versioning;
 using GitCredentialManager.Interop.MacOS.Native;
 using GitCredentialManager.Interop.Posix;
 
 namespace GitCredentialManager.Interop.MacOS
 {
+    [SupportedOSPlatform(Constants.MacOSPlatformName)]
     public class MacOSSessionManager : PosixSessionManager
     {
         public MacOSSessionManager(IEnvironment env, IFileSystem fs) : base(env, fs)
diff --git a/src/shared/Core/Interop/MacOS/MacOSTerminal.cs b/src/shared/Core/Interop/MacOS/MacOSTerminal.cs
@@ -1,10 +1,12 @@
 using System;
+using System.Runtime.Versioning;
 using GitCredentialManager.Interop.MacOS.Native;
 using GitCredentialManager.Interop.Posix;
 using GitCredentialManager.Interop.Posix.Native;
 
 namespace GitCredentialManager.Interop.MacOS
 {
+    [SupportedOSPlatform(Constants.MacOSPlatformName)]
     public class MacOSTerminal : PosixTerminal
     {
         public MacOSTerminal(ITrace trace, ITrace2 trace2)
diff --git a/src/shared/Core/Interop/Posix/PosixEnvironment.cs b/src/shared/Core/Interop/Posix/PosixEnvironment.cs
@@ -1,9 +1,12 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Runtime.Versioning;
 
 namespace GitCredentialManager.Interop.Posix
 {
+    [SupportedOSPlatform(Constants.LinuxPlatformName)]
+    [SupportedOSPlatform(Constants.MacOSPlatformName)]
     public class PosixEnvironment : EnvironmentBase
     {
         public PosixEnvironment(IFileSystem fileSystem)
diff --git a/src/shared/Core/Interop/Windows/WindowsEnvironment.cs b/src/shared/Core/Interop/Windows/WindowsEnvironment.cs
@@ -3,10 +3,12 @@
 using System.Diagnostics;
 using System.IO;
 using System.Linq;
+using System.Runtime.Versioning;
 using System.Text;
 
 namespace GitCredentialManager.Interop.Windows
 {
+    [SupportedOSPlatform(Constants.WindowsPlatformName)]
     public class WindowsEnvironment : EnvironmentBase
     {
         public WindowsEnvironment(IFileSystem fileSystem)
diff --git a/src/shared/Core/Interop/Windows/WindowsFileSystem.cs b/src/shared/Core/Interop/Windows/WindowsFileSystem.cs
@@ -1,8 +1,10 @@
 using System;
 using System.IO;
+using System.Runtime.Versioning;
 
 namespace GitCredentialManager.Interop.Windows
 {
+    [SupportedOSPlatform(Constants.WindowsPlatformName)]
     public class WindowsFileSystem : FileSystem
     {
         public override bool IsSamePath(string a, string b)
diff --git a/src/shared/Core/Interop/Windows/WindowsProcessManager.cs b/src/shared/Core/Interop/Windows/WindowsProcessManager.cs
@@ -1,5 +1,8 @@
+using System.Runtime.Versioning;
+
 namespace GitCredentialManager.Interop.Windows;
 
+[SupportedOSPlatform(Constants.WindowsPlatformName)]
 public class WindowsProcessManager : ProcessManager
 {
     public WindowsProcessManager(ITrace2 trace2) : base(trace2)
diff --git a/src/shared/Core/Interop/Windows/WindowsSessionManager.cs b/src/shared/Core/Interop/Windows/WindowsSessionManager.cs
@@ -1,8 +1,10 @@
 using System;
+using System.Runtime.Versioning;
 using GitCredentialManager.Interop.Windows.Native;
 
 namespace GitCredentialManager.Interop.Windows
 {
+    [SupportedOSPlatform(Constants.WindowsPlatformName)]
     public class WindowsSessionManager : SessionManager
     {
         public WindowsSessionManager(IEnvironment env, IFileSystem fs) : base(env, fs)
diff --git a/src/shared/Core/Interop/Windows/WindowsSettings.cs b/src/shared/Core/Interop/Windows/WindowsSettings.cs
@@ -1,9 +1,12 @@
 
+using System.Runtime.Versioning;
+
 namespace GitCredentialManager.Interop.Windows
 {
     /// <summary>
     /// Reads settings from Git configuration, environment variables, and defaults from the Windows Registry.
     /// </summary>
+    [SupportedOSPlatform(Constants.WindowsPlatformName)]
     public class WindowsSettings : Settings
     {
         private readonly ITrace _trace;
diff --git a/src/shared/Core/Interop/Windows/WindowsTerminal.cs b/src/shared/Core/Interop/Windows/WindowsTerminal.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Runtime.InteropServices;
+using System.Runtime.Versioning;
 using System.Text;
 using GitCredentialManager.Interop.Windows.Native;
 using Microsoft.Win32.SafeHandles;
@@ -9,6 +10,7 @@ namespace GitCredentialManager.Interop.Windows
     /// <summary>
     /// Represents a thin wrapper around the Windows console device.
     /// </summary>
+    [SupportedOSPlatform(Constants.WindowsPlatformName)]
     public class WindowsTerminal : ITerminal
     {
         // ReadConsole 32768 fail, 32767 OK @linquize [https://github.com/Microsoft/Git-Credential-Manager-for-Windows/commit/a62b9a19f430d038dcd85a610d97e5f763980f85]
diff --git a/src/shared/Core/PlatformUtils.cs b/src/shared/Core/PlatformUtils.cs
@@ -1,9 +1,11 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Linq;
 using System.Runtime.InteropServices;
+using System.Runtime.Versioning;
 using GitCredentialManager.Interop.Posix.Native;
 
 namespace GitCredentialManager
@@ -24,6 +26,7 @@ public static PlatformInformation GetPlatformInformation(ITrace2 trace2)
             return new PlatformInformation(osType, osVersion, cpuArch, clrVersion);
         }
 
+        [SupportedOSPlatformGuard(Constants.WindowsPlatformName)]
         public static bool IsDevBox()
         {
             if (!IsWindows())
@@ -49,6 +52,7 @@ public static bool IsDevBox()
             }
         }
 
+        [SupportedOSPlatformGuard(Constants.WindowsPlatformName)]
         public static bool IsWindowsBrokerSupported()
         {
             if (!IsWindows())
@@ -93,33 +97,38 @@ public static bool IsWindowsBrokerSupported()
         /// Check if the current Operating System is macOS.
         /// </summary>
         /// <returns>True if running on macOS, false otherwise.</returns>
+        [SupportedOSPlatformGuard(Constants.MacOSPlatformName)]
         public static bool IsMacOS()
         {
-            return RuntimeInformation.IsOSPlatform(OSPlatform.OSX);
+            return OperatingSystem.IsMacOS();
         }
 
         /// <summary>
         /// Check if the current Operating System is Windows.
         /// </summary>
         /// <returns>True if running on Windows, false otherwise.</returns>
+        [SupportedOSPlatformGuard(Constants.WindowsPlatformName)]
         public static bool IsWindows()
         {
-            return RuntimeInformation.IsOSPlatform(OSPlatform.Windows);
+            return OperatingSystem.IsWindows();
         }
 
         /// <summary>
         /// Check if the current Operating System is Linux-based.
         /// </summary>
         /// <returns>True if running on a Linux distribution, false otherwise.</returns>
+        [SupportedOSPlatformGuard(Constants.LinuxPlatformName)]
         public static bool IsLinux()
         {
-            return RuntimeInformation.IsOSPlatform(OSPlatform.Linux);
+            return OperatingSystem.IsLinux();
         }
 
         /// <summary>
         /// Check if the current Operating System is POSIX-compliant.
         /// </summary>
         /// <returns>True if running on a POSIX-compliant Operating System, false otherwise.</returns>
+        [SupportedOSPlatformGuard(Constants.LinuxPlatformName)]
+        [SupportedOSPlatformGuard(Constants.MacOSPlatformName)]
         public static bool IsPosix()
         {
             return IsMacOS() || IsLinux();
@@ -129,6 +138,7 @@ public static bool IsPosix()
         /// Ensure the current Operating System is macOS, fail otherwise.
         /// </summary>
         /// <exception cref="PlatformNotSupportedException">Thrown if the current OS is not macOS.</exception>
+        [SupportedOSPlatformGuard(Constants.MacOSPlatformName)]
         public static void EnsureMacOS()
         {
             if (!IsMacOS())
@@ -141,6 +151,7 @@ public static void EnsureMacOS()
         /// Ensure the current Operating System is Windows, fail otherwise.
         /// </summary>
         /// <exception cref="PlatformNotSupportedException">Thrown if the current OS is not Windows.</exception>
+        [SupportedOSPlatformGuard(Constants.WindowsPlatformName)]
         public static void EnsureWindows()
         {
             if (!IsWindows())
@@ -153,6 +164,7 @@ public static void EnsureWindows()
         /// Ensure the current Operating System is Linux-based, fail otherwise.
         /// </summary>
         /// <exception cref="PlatformNotSupportedException">Thrown if the current OS is not Linux-based.</exception>
+        [SupportedOSPlatformGuard(Constants.LinuxPlatformName)]
         public static void EnsureLinux()
         {
             if (!IsLinux())
@@ -165,6 +177,8 @@ public static void EnsureLinux()
         /// Ensure the current Operating System is POSIX-compliant, fail otherwise.
         /// </summary>
         /// <exception cref="PlatformNotSupportedException">Thrown if the current OS is not POSIX-compliant.</exception>
+        [SupportedOSPlatformGuard(Constants.LinuxPlatformName)]
+        [SupportedOSPlatformGuard(Constants.MacOSPlatformName)]
         public static void EnsurePosix()
         {
             if (!IsPosix())

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,11 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.IO;`
	`3`	`+using System.Runtime.Versioning;`
`3`	`4`	`using GitCredentialManager.Interop.Posix;`
`4`	`5`
`5`	`6`	`namespace GitCredentialManager.Interop.Linux`
`6`	`7`	`{`
	`8`	`+ [SupportedOSPlatform(Constants.LinuxPlatformName)]`
`7`	`9`	`public class LinuxFileSystem : PosixFileSystem`
`8`	`10`	`{`
`9`	`11`	`public override bool IsSamePath(string a, string b)`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
	`1`	`+using System.Runtime.Versioning;`
`1`	`2`	`using GitCredentialManager.Interop.Posix;`
`2`	`3`
`3`	`4`	`namespace GitCredentialManager.Interop.Linux;`
`4`	`5`
	`6`	`+[SupportedOSPlatform(Constants.LinuxPlatformName)]`
`5`	`7`	`public class LinuxSessionManager : PosixSessionManager`
`6`	`8`	`{`
`7`	`9`	`private bool? _isWebBrowserAvailable;`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,12 @@`
`1`	`1`	`using System;`
	`2`	`+using System.Runtime.Versioning;`
`2`	`3`	`using GitCredentialManager.Interop.Linux.Native;`
`3`	`4`	`using GitCredentialManager.Interop.Posix;`
`4`	`5`	`using GitCredentialManager.Interop.Posix.Native;`
`5`	`6`
`6`	`7`	`namespace GitCredentialManager.Interop.Linux`
`7`	`8`	`{`
	`9`	`+ [SupportedOSPlatform(Constants.LinuxPlatformName)]`
`8`	`10`	`public class LinuxTerminal : PosixTerminal`
`9`	`11`	`{`
`10`	`12`	`public LinuxTerminal(ITrace trace, ITrace2 trace2)`
Original file line number	Diff line number	Diff line change
`@@ -2,11 +2,13 @@`
`2`	`2`	`using System.Collections.Generic;`
`3`	`3`	`using System.Diagnostics;`
`4`	`4`	`using System.IO;`
	`5`	`+using System.Runtime.Versioning;`
`5`	`6`	`using System.Threading;`
`6`	`7`	`using GitCredentialManager.Interop.Posix;`
`7`	`8`
`8`	`9`	`namespace GitCredentialManager.Interop.MacOS`
`9`	`10`	`{`
	`11`	`+ [SupportedOSPlatform(Constants.MacOSPlatformName)]`
`10`	`12`	`public class MacOSEnvironment : PosixEnvironment`
`11`	`13`	`{`
`12`	`14`	`private ICollection<string> _pathsToIgnore;`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,10 @@`
	`1`	`+using System.Runtime.Versioning;`
`1`	`2`	`using GitCredentialManager.Interop.MacOS.Native;`
`2`	`3`	`using GitCredentialManager.Interop.Posix;`
`3`	`4`
`4`	`5`	`namespace GitCredentialManager.Interop.MacOS`
`5`	`6`	`{`
	`7`	`+ [SupportedOSPlatform(Constants.MacOSPlatformName)]`
`6`	`8`	`public class MacOSSessionManager : PosixSessionManager`
`7`	`9`	`{`
`8`	`10`	`public MacOSSessionManager(IEnvironment env, IFileSystem fs) : base(env, fs)`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,12 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.Collections.Generic;`
`3`	`3`	`using System.Linq;`
	`4`	`+using System.Runtime.Versioning;`
`4`	`5`
`5`	`6`	`namespace GitCredentialManager.Interop.Posix`
`6`	`7`	`{`
	`8`	`+ [SupportedOSPlatform(Constants.LinuxPlatformName)]`
	`9`	`+ [SupportedOSPlatform(Constants.MacOSPlatformName)]`
`7`	`10`	`public class PosixEnvironment : EnvironmentBase`
`8`	`11`	`{`
`9`	`12`	`public PosixEnvironment(IFileSystem fileSystem)`