Merge pull request #74 from mjcheetham/new-install

New Install 6/6: Implement (un)configuration for GCM Core

Author: mjcheetham

.azure-pipelines/templates/windows/pack.yml

@@ -1,7 +1,7 @@
 steps:
   - script: |
       xcopy "out\windows\Installer.Windows\bin\$(configuration)\net461"       "$(Build.StagingDirectory)\publish\"
-      xcopy "out\windows\Payload.Windows\bin\$(configuration)\net461\win-x64" "$(Build.StagingDirectory)\publish\payload\"
+      xcopy "out\windows\Payload.Windows\bin\$(configuration)\net461\win-x86" "$(Build.StagingDirectory)\publish\payload\"
       mkdir "$(Build.StagingDirectory)\publish\payload.sym\"
       move  "$(Build.StagingDirectory)\publish\payload\*.pdb"                 "$(Build.StagingDirectory)\publish\payload.sym\"
     displayName: Prepare final build artifact

src/shared/Git-Credential-Manager/Git-Credential-Manager.csproj

@@ -2,9 +2,9 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFrameworks>netcoreapp2.1</TargetFrameworks>
-    <TargetFrameworks Condition="'$(OSPlatform)'=='windows'">netcoreapp2.1;net461</TargetFrameworks>
-    <RuntimeIdentifiers>win-x64;osx-x64</RuntimeIdentifiers>
+    <TargetFramework>netcoreapp2.1</TargetFramework>
+    <TargetFramework Condition="'$(OSPlatform)'=='windows'">net461</TargetFramework>
+    <RuntimeIdentifiers>win-x86;osx-x64</RuntimeIdentifiers>
     <AssemblyName>git-credential-manager-core</AssemblyName>
     <RootNamespace>Microsoft.Git.CredentialManager</RootNamespace>
     <ApplicationIcon>$(RepoAssetsPath)gcmicon.ico</ApplicationIcon>
@@ -13,6 +13,12 @@
     <TargetLatestRuntimePatch>true</TargetLatestRuntimePatch>
   </PropertyGroup>
 
+  <!-- On Windows we target 32-bit because the WinForms authentication helpers are 32-bit
+       and also need to use the native libgit2 library (we use the 32-bit version on Windows) -->
+  <PropertyGroup Condition="'$(OSPlatform)'=='windows'">
+    <Prefer32Bit>true</Prefer32Bit>
+  </PropertyGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\GitHub\GitHub.csproj" />
     <ProjectReference Include="..\Microsoft.AzureRepos\Microsoft.AzureRepos.csproj" />

src/shared/Git-Credential-Manager/Program.cs

@@ -1,6 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 using System;
+using System.IO;
+using System.Reflection;
 using GitHub;
 using Microsoft.AzureRepos;
 
@@ -10,8 +12,9 @@ public static class Program
     {
         public static void Main(string[] args)
         {
+            string appPath = GetApplicationPath();
             using (var context = new CommandContext())
-            using (var app = new Application(context))
+            using (var app = new Application(context, appPath))
             {
                 // Register all supported host providers
                 app.RegisterProviders(
@@ -29,5 +32,24 @@ public static void Main(string[] args)
                 Environment.Exit(exitCode);
             }
         }
+
+        private static string GetApplicationPath()
+        {
+            Assembly entryAssembly = Assembly.GetExecutingAssembly();
+            if (entryAssembly is null)
+            {
+                throw new InvalidOperationException();
+            }
+
+            string candidatePath = entryAssembly.Location;
+
+            // Strip the .dll from assembly name on Mac and Linux
+            if (!PlatformUtils.IsWindows() && Path.HasExtension(candidatePath))
+            {
+                return Path.ChangeExtension(candidatePath, null);
+            }
+
+            return candidatePath;
+        }
     }
 }

src/shared/Microsoft.AzureRepos.Tests/AzureReposHostProviderTests.cs

@@ -13,6 +13,9 @@ namespace Microsoft.AzureRepos.Tests
 {
     public class AzureReposHostProviderTests
     {
+        private static readonly string AzDevUseHttpPathKey =
+            $"{Constants.GitConfiguration.Credential.SectionName}.https://dev.azure.com.{Constants.GitConfiguration.Credential.UseHttpPath}";
+
         [Fact]
         public void AzureReposProvider_IsSupported_AzureHost_UnencryptedHttp_ReturnsTrue()
         {
@@ -171,5 +174,84 @@ public async Task AzureReposProvider_GetCredentialAsync_ReturnsCredential()
             Assert.Equal(personalAccessToken, credential.Password);
             // We don't care about the username value
         }
+
+        [Fact]
+        public async Task AzureReposHostProvider_ConfigureAsync_UseHttpPathSetTrue_DoesNothing()
+        {
+            var provider = new AzureReposHostProvider(new TestCommandContext());
+
+            var environment = new TestEnvironment();
+            var config = new TestGitConfiguration(new Dictionary<string, IList<string>>
+            {
+                [AzDevUseHttpPathKey] = new List<string> {"true"}
+            });
+
+            await provider.ConfigureAsync(
+                environment, EnvironmentVariableTarget.User,
+                config, GitConfigurationLevel.Global);
+
+            Assert.Single(config.Dictionary);
+            Assert.True(config.Dictionary.TryGetValue(AzDevUseHttpPathKey, out IList<string> actualValues));
+            Assert.Single(actualValues);
+            Assert.Equal("true", actualValues[0]);
+        }
+
+        [Fact]
+        public async Task AzureReposHostProvider_ConfigureAsync_UseHttpPathSetFalse_SetsUseHttpPathTrue()
+        {
+            var provider = new AzureReposHostProvider(new TestCommandContext());
+
+            var environment = new TestEnvironment();
+            var config = new TestGitConfiguration(new Dictionary<string, IList<string>>
+            {
+                [AzDevUseHttpPathKey] = new List<string> {"false"}
+            });
+
+            await provider.ConfigureAsync(
+                environment, EnvironmentVariableTarget.User,
+                config, GitConfigurationLevel.Global);
+
+            Assert.Single(config.Dictionary);
+            Assert.True(config.Dictionary.TryGetValue(AzDevUseHttpPathKey, out IList<string> actualValues));
+            Assert.Single(actualValues);
+            Assert.Equal("true", actualValues[0]);
+        }
+
+        [Fact]
+        public async Task AzureReposHostProvider_ConfigureAsync_UseHttpPathUnset_SetsUseHttpPathTrue()
+        {
+            var provider = new AzureReposHostProvider(new TestCommandContext());
+
+            var environment = new TestEnvironment();
+            var config = new TestGitConfiguration();
+
+            await provider.ConfigureAsync(
+                environment, EnvironmentVariableTarget.User,
+                config, GitConfigurationLevel.Global);
+
+            Assert.Single(config.Dictionary);
+            Assert.True(config.Dictionary.TryGetValue(AzDevUseHttpPathKey, out IList<string> actualValues));
+            Assert.Single(actualValues);
+            Assert.Equal("true", actualValues[0]);
+        }
+
+
+        [Fact]
+        public async Task AzureReposHostProvider_UnconfigureAsync_UseHttpPathSet_RemovesEntry()
+        {
+            var provider = new AzureReposHostProvider(new TestCommandContext());
+
+            var environment = new TestEnvironment();
+            var config = new TestGitConfiguration(new Dictionary<string, IList<string>>
+            {
+                [AzDevUseHttpPathKey] = new List<string> {"true"}
+            });
+
+            await provider.UnconfigureAsync(
+                environment, EnvironmentVariableTarget.User,
+                config, GitConfigurationLevel.Global);
+
+            Assert.Empty(config.Dictionary);
+        }
     }
 }

src/shared/Microsoft.AzureRepos/AzureReposHostProvider.cs

@@ -5,10 +5,11 @@
 using System.Threading.Tasks;
 using Microsoft.Git.CredentialManager;
 using Microsoft.Git.CredentialManager.Authentication;
+using KnownGitCfg = Microsoft.Git.CredentialManager.Constants.GitConfiguration;
 
 namespace Microsoft.AzureRepos
 {
-    public class AzureReposHostProvider : HostProvider
+    public class AzureReposHostProvider : HostProvider, IConfigurableComponent
     {
         private readonly IAzureDevOpsRestApi _azDevOps;
         private readonly IMicrosoftAuthentication _msAuth;
@@ -103,5 +104,49 @@ protected override void ReleaseManagedResources()
         }
 
         #endregion
+
+        #region IConfigurationComponent
+
+        string IConfigurableComponent.Name => "Azure Repos provider";
+
+        public Task ConfigureAsync(
+            IEnvironment environment, EnvironmentVariableTarget environmentTarget,
+            IGitConfiguration configuration, GitConfigurationLevel configurationLevel)
+        {
+            string useHttpPathKey = $"{KnownGitCfg.Credential.SectionName}.https://dev.azure.com.{KnownGitCfg.Credential.UseHttpPath}";
+
+            using (IGitConfiguration targetConfig = configuration.GetFilteredConfiguration(configurationLevel))
+            {
+                if (targetConfig.TryGetValue(useHttpPathKey, out string currentValue) && currentValue.IsTruthy())
+                {
+                    Context.Trace.WriteLine("Git configuration 'credential.useHttpPath' is already set to 'true' for https://dev.azure.com.");
+                }
+                else
+                {
+                    Context.Trace.WriteLine("Setting Git configuration 'credential.useHttpPath' to 'true' for https://dev.azure.com...");
+                    targetConfig.SetValue(useHttpPathKey, "true");
+                }
+            }
+
+            return Task.CompletedTask;
+        }
+
+        public Task UnconfigureAsync(
+            IEnvironment environment, EnvironmentVariableTarget environmentTarget,
+            IGitConfiguration configuration, GitConfigurationLevel configurationLevel)
+        {
+            string useHttpPathKey = $"{KnownGitCfg.Credential.SectionName}.https://dev.azure.com.{KnownGitCfg.Credential.UseHttpPath}";
+
+            Context.Trace.WriteLine("Clearing Git configuration 'credential.useHttpPath' for https://dev.azure.com...");
+
+            using (IGitConfiguration targetConfig = configuration.GetFilteredConfiguration(configurationLevel))
+            {
+                targetConfig.DeleteEntry(useHttpPathKey);
+            }
+
+            return Task.CompletedTask;
+        }
+
+        #endregion
     }
 }