Merge pull request #406 from vdye/356-manually-specify-gpg-path

Add option for `GCM_GPG_PATH` environment variable (Linux-only)

Author: mjcheetham

docs/environment.md

@@ -398,6 +398,20 @@ export GCM_PLAINTEXT_STORE_PATH=/mnt/external-drive/credentials
 
 ---
 
+### GCM_GPG_PATH
+
+Specify the path (_including_ the executable name) to the version of `gpg` used by `pass` (`gpg2` if present, otherwise `gpg`). This is primarily meant to allow manual resolution of the conflict that occurs on legacy Linux systems with parallel installs of `gpg` and `gpg2`.
+
+If not specified, GCM Core defaults to using the version of `gpg2` on the `$PATH`, falling back on `gpg` if `gpg2` is not found.
+
+##### Linux
+
+```bash
+export GCM_GPG_PATH="/usr/local/bin/gpg2"
+```
+
+---
+
 ### GCM_MSAUTH_FLOW
 
 Specify which authentication flow should be used when performing Microsoft authentication and an interactive flow is required.

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

@@ -95,7 +95,7 @@ public CommandContext(string appPath)
                 SystemPrompts     = new WindowsSystemPrompts();
                 Environment       = new WindowsEnvironment(FileSystem);
                 Terminal          = new WindowsTerminal(Trace);
-                string gitPath    = GetGitPath(Environment, FileSystem);
+                string gitPath    = GetGitPath(Environment, FileSystem, Trace);
                 Git               = new GitProcess(
                                             Trace,
                                             gitPath,
@@ -111,14 +111,15 @@ public CommandContext(string appPath)
                 SystemPrompts     = new MacOSSystemPrompts();
                 Environment       = new PosixEnvironment(FileSystem);
                 Terminal          = new PosixTerminal(Trace);
-                string gitPath    = GetGitPath(Environment, FileSystem);
+                string gitPath    = GetGitPath(Environment, FileSystem, Trace);
                 Git               = new GitProcess(
                                             Trace,
                                             gitPath,
                                             FileSystem.GetCurrentDirectory()
                                         );
                 Settings          = new Settings(Environment, Git);
                 CredentialStore   = new MacOSKeychain(Settings.CredentialNamespace);
+
             }
             else if (PlatformUtils.IsLinux())
             {
@@ -128,17 +129,16 @@ public CommandContext(string appPath)
                 SystemPrompts     = new LinuxSystemPrompts();
                 Environment       = new PosixEnvironment(FileSystem);
                 Terminal          = new PosixTerminal(Trace);
-                string gitPath    = GetGitPath(Environment, FileSystem);
+                string gitPath    = GetGitPath(Environment, FileSystem, Trace);
                 Git               = new GitProcess(
                                             Trace,
                                             gitPath,
                                             FileSystem.GetCurrentDirectory()
                                         );
                 Settings          = new Settings(Environment, Git);
-                IGpg gpg          = new Gpg(
-                                            Environment.LocateExecutable("gpg"),
-                                            SessionManager
-                                        );
+
+                string gpgPath    = GetGpgPath(Environment, FileSystem, Trace);
+                IGpg gpg          = new Gpg(gpgPath, SessionManager);
                 CredentialStore   = new LinuxCredentialStore(FileSystem, Settings, SessionManager, gpg, Environment, Git);
             }
             else
@@ -152,23 +152,62 @@ public CommandContext(string appPath)
             SystemPrompts.ParentWindowId = Settings.ParentWindowId;
         }
 
-        private static string GetGitPath(IEnvironment environment, IFileSystem fileSystem)
+        private static string GetGitPath(IEnvironment environment, IFileSystem fileSystem, ITrace trace)
         {
+            string gitExecPath;
             string programName = PlatformUtils.IsWindows() ? "git.exe" : "git";
 
             // Use the GIT_EXEC_PATH environment variable if set
             if (environment.Variables.TryGetValue(Constants.EnvironmentVariables.GitExecutablePath,
-                out string gitExecPath))
+                out gitExecPath))
             {
                 string candidatePath = Path.Combine(gitExecPath, programName);
                 if (fileSystem.FileExists(candidatePath))
                 {
+                    trace.WriteLine($"Using Git executable from GIT_EXEC_PATH: {candidatePath}");
                     return candidatePath;
                 }
             }
 
             // Otherwise try to locate the git(.exe) on the current PATH
-            return environment.LocateExecutable(programName);
+            gitExecPath = environment.LocateExecutable(programName);
+            trace.WriteLine($"Using PATH-located Git executable: {gitExecPath}");
+            return gitExecPath;
+        }
+
+        private static string GetGpgPath(IEnvironment environment, IFileSystem fileSystem, ITrace trace)
+        {
+            string gpgPath;
+
+            // Use the GCM_GPG_PATH environment variable if set
+            if (environment.Variables.TryGetValue(Constants.EnvironmentVariables.GpgExecutablePath,
+                out gpgPath))
+            {
+                if (fileSystem.FileExists(gpgPath))
+                {
+                    trace.WriteLine($"Using Git executable from GCM_GPG_PATH: {gpgPath}");
+                    return gpgPath;
+                }
+                else
+                {
+                    throw new Exception($"GPG executable does not exist with path '{gpgPath}'");
+                }
+
+            }
+
+            // If no explicit GPG path is specified, mimic the way `pass`
+            // determines GPG dependency (use gpg2 if available, otherwise gpg)
+            if (environment.TryLocateExecutable("gpg2", out string gpg2Path))
+            {
+                trace.WriteLine($"Using PATH-located GPG (gpg2) executable: {gpg2Path}");
+                return gpg2Path;
+            }
+            else
+            {
+                gpgPath = environment.LocateExecutable("gpg");
+                trace.WriteLine($"Using PATH-located GPG (gpg) executable: {gpgPath}");
+                return gpgPath;
+            }
         }
 
         #region ICommandContext

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

@@ -58,6 +58,7 @@ public static class EnvironmentVariables
             public const string GcmCredCacheOptions   = "GCM_CREDENTIAL_CACHE_OPTIONS";
             public const string GcmPlaintextStorePath = "GCM_PLAINTEXT_STORE_PATH";
             public const string GitExecutablePath     = "GIT_EXEC_PATH";
+            public const string GpgExecutablePath     = "GCM_GPG_PATH";
         }
 
         public static class Http