Introduce InteropException for all P/Invoke errors

Add a new custom exception type `InteropException` that wraps up
failures from interop (P/Invoke) code. `Win32Exception`s, macOS and
POSIX error codes are now wrapped in `InteropException`.

Author: mjcheetham

src/shared/Microsoft.Git.CredentialManager/Application.cs

@@ -4,6 +4,7 @@
 using System.ComponentModel;
 using System.Threading.Tasks;
 using Microsoft.Git.CredentialManager.Commands;
+using Microsoft.Git.CredentialManager.Interop;
 
 namespace Microsoft.Git.CredentialManager
 {
@@ -81,8 +82,8 @@ protected bool WriteException(Exception ex)
             // Try and use a nicer format for some well-known exception types
             switch (ex)
             {
-                case Win32Exception w32Ex:
-                    Context.StdError.WriteLine("fatal: {0} [0x{1:x}]", w32Ex.Message, w32Ex.NativeErrorCode);
+                case InteropException interopEx:
+                    Context.StdError.WriteLine("fatal: {0} [0x{1:x}]", interopEx.Message, interopEx.ErrorCode);
                     break;
                 default:
                     Context.StdError.WriteLine("fatal: {0}", ex.Message);

src/shared/Microsoft.Git.CredentialManager/Interop/InteropException.cs

@@ -0,0 +1,41 @@
+using System;
+using System.ComponentModel;
+using System.Diagnostics;
+
+namespace Microsoft.Git.CredentialManager.Interop
+{
+    /// <summary>
+    /// An unexpected error occurred in interop-code.
+    /// </summary>
+    [DebuggerDisplay("{DebuggerDisplay}")]
+    public class InteropException : Exception
+    {
+        public InteropException()
+            : base() { }
+
+        public InteropException(string message, int errorCode)
+            : base(message)
+        {
+            ErrorCode = errorCode;
+        }
+
+        public InteropException(string message, int errorCode, Exception innerException)
+            : base(message, innerException)
+        {
+            ErrorCode = errorCode;
+        }
+
+        public InteropException(string message, Win32Exception w32Exception)
+            : base(message, w32Exception)
+        {
+            ErrorCode = w32Exception.NativeErrorCode;
+        }
+
+        /// <summary>
+        /// Native error code.
+        /// </summary>
+        public int ErrorCode { get; }
+
+        private string DebuggerDisplay => $"{Message} [0x{ErrorCode:x}]";
+    }
+}

src/shared/Microsoft.Git.CredentialManager/Interop/MacOS/Native/SecurityFramework.cs

@@ -80,23 +80,23 @@ public static void ThrowIfError(int error, string defaultErrorMessage = "Unknown
                 case OK:
                     return;
                 case ErrorSecNoSuchKeychain:
-                    throw new InvalidOperationException($"The keychain does not exist. ({ErrorSecNoSuchKeychain})");
+                    throw new InteropException("The keychain does not exist.", error);
                 case ErrorSecInvalidKeychain:
-                    throw new InvalidOperationException($"The keychain is not valid. ({ErrorSecInvalidKeychain})");
+                    throw new InteropException("The keychain is not valid.", error);
                 case ErrorSecAuthFailed:
-                    throw new InvalidOperationException($"Authorization/Authentication failed. ({ErrorSecAuthFailed})");
+                    throw new InteropException("Authorization/Authentication failed.", error);
                 case ErrorSecDuplicateItem:
-                    throw new InvalidOperationException($"The item already exists. ({ErrorSecDuplicateItem})");
+                    throw new InteropException("The item already exists.", error);
                 case ErrorSecItemNotFound:
-                    throw new InvalidOperationException($"The item cannot be found. ({ErrorSecItemNotFound})");
+                    throw new InteropException("The item cannot be found.", error);
                 case ErrorSecInteractionNotAllowed:
-                    throw new InvalidOperationException($"Interaction with the Security Server is not allowed. ({ErrorSecInteractionNotAllowed})");
+                    throw new InteropException("Interaction with the Security Server is not allowed.", error);
                 case ErrorSecInteractionRequired:
-                    throw new InvalidOperationException($"User interaction is required. ({ErrorSecInteractionRequired})");
+                    throw new InteropException("User interaction is required.", error);
                 case ErrorSecNoSuchAttr:
-                    throw new InvalidOperationException($"The attribute does not exist. ({ErrorSecNoSuchAttr})");
+                    throw new InteropException("The attribute does not exist.", error);
                 default:
-                    throw new Exception($"{defaultErrorMessage} ({error})");
+                    throw new InteropException(defaultErrorMessage, error);
             }
         }
     }