Merge pull request #374: Update Git to include en/sparse-checkout

Also fixes a bug when running `scalar clone` followed by `git sparse-checkout disable`.

See microsoft/git#267.

Author: derrickstolee

Directory.Build.props

@@ -43,7 +43,7 @@
        VFS for Git (which is less flexible). Only update that version if we rely upon a
        new command-line interface in Git or if there is a truly broken interaction.
     -->
-    <GitPackageVersion>2.20200420.2</GitPackageVersion>
+    <GitPackageVersion>2.20200514.1</GitPackageVersion>
     <MinimumGitVersion>v2.25.0.vfs.1.1</MinimumGitVersion>
 
     <WatchmanPackageUrl>https://github.com/facebook/watchman/suites/307436006/artifacts/304557</WatchmanPackageUrl>

Scalar.FunctionalTests/Tests/EnlistmentPerFixture/SparseSetTests.cs

@@ -14,8 +14,9 @@ namespace Scalar.FunctionalTests.Tests.EnlistmentPerFixture
     [Category(Categories.GitCommands)]
     public class SparseSetTests : TestsWithEnlistmentPerFixture
     {
-        private const string SetOverwriteMessage = "would be overwritten by sparse checkout update";
+        private const string SetOverwriteMessage = "The following paths were already present and thus not updated despite sparse patterns";
         private const string SetIndexStateMessage = "you need to resolve your current index first";
+        private const string UnmergedPathsMessage = "The following paths are unmerged and were left despite sparse patterns";
 
         private const string FolderDotGit = ".git";
         private const string FolderDeleteFileTests = "DeleteFileTests";
@@ -145,19 +146,11 @@ public void SparseSetFileAlreadyExists()
             // Contents before 'set'
             this.VerifyContentsForSparseSetFileAlreadyExists();
 
-            // If a file already exists that would conflict with a sparse checkout, the 'set' should fail
+            // If a file already exists that would conflict with a sparse checkout, the 'set' will partially succeed.
             this.currentFolderList.Add(FolderEnumerateAndReadTestFiles);
             string result = this.SparseSet();
             result.ShouldContain(SetOverwriteMessage);
 
-            // Contents should be unchanged after failure
-            this.VerifyContentsForSparseSetFileAlreadyExists();
-
-            // After deleting the conflicting file you should be able to 'set'
-            this.fileSystem.DeleteFile(existingFile);
-            result = this.SparseSet();
-            result.ShouldNotContain(true, SetOverwriteMessage);
-
             // Should now have multiple files under EnumerateAndReadTestFiles
             Directory.GetFiles(folderEnumerateDirectory).Length.ShouldEqual(18);
         }
@@ -231,15 +224,11 @@ public void SparseSetWithOneFolderConflict()
 
             this.VerifyContentsSparseSetWithOneFolderConflict();
 
-            // One folder conflict should fail the entire 'set', and this does not modify the sparse-checkout file
             this.currentFolderList.Add(FolderTest_MoveRenameFileTests);
             this.currentFolderList.Add(FolderTest_MoveRenameFileTests2);
             string result = this.SparseSet();
             result.ShouldContain(SetOverwriteMessage);
 
-            // Results should be unchanged
-            this.VerifyContentsSparseSetWithOneFolderConflict();
-
             // Checkout new_branch
             GitProcess.Invoke(this.Enlistment.RepoRoot, "checkout -b new_branch");
 
@@ -249,7 +238,7 @@ public void SparseSetWithOneFolderConflict()
 
             this.fileSystem.DeleteFile(existingFile);
             result = this.SparseSet();
-            result.ShouldNotContain(false, SetOverwriteMessage);
+            result.ShouldBeEmpty();
 
             // Verify the folders are now populated
             this.VerifyDirectory(folderRenameDirectory, new List<string>
@@ -269,9 +258,10 @@ public void SparseSetWithOneFolderConflict()
         [TestCase, Order(8)]
         public void AddWhileInMergeConflict()
         {
-            // Attempt to 'set' while you have a cherry-pick merge conflict.  It will say it failed.
+            string result = this.SparseSet();
+
+            // Attempt to 'set' while you have a cherry-pick merge conflict. It will succeed.
             // Abort the cherry-pick, switch branches, and switch back. Now the folders will be fully populated.
-            // The correct behavior should be that if the 'set' fails the folders should not be added to sparse
             string conflictFilename = "conflict";
             string fileToConflict = this.Enlistment.GetSourcePath(conflictFilename);
 
@@ -292,29 +282,10 @@ public void AddWhileInMergeConflict()
             // Attempt to cherry-pick the commit we know will result in a merge conflict
             GitProcess.Invoke(this.Enlistment.RepoRoot, "cherry-pick " + commitId);
 
-            // Should not be able to add which we have a merge conflict
+            // This should succeed!
             this.currentFolderList.Add(FolderTrailingSlashTests);
-            string result = this.SparseSet();
-            result.ShouldContain(SetIndexStateMessage);
-
-            // New directory should not be listed because of the error
-            this.VerifyDirectory(this.Enlistment.RepoRoot, new List<string>
-            {
-                FolderDotGit,
-                FolderEnumerateAndReadTestFiles,
-                FolderFileNameEncoding,
-                FolderGitCommandsTests,
-                FolderGVFS,
-                FolderScripts,
-                FolderTest_MoveRenameFileTests,
-                FolderTest_MoveRenameFileTests2
-             });
-
-            // Fix the error, switch to the new branch, and switch back and we should have all directories
-            GitProcess.Invoke(this.Enlistment.RepoRoot, "cherry-pick --abort");
-
             result = this.SparseSet();
-            result.ShouldNotContain(true, SetIndexStateMessage);
+            result.ShouldContain(UnmergedPathsMessage);
 
             GitProcess.Invoke(this.Enlistment.RepoRoot, "checkout branch_with_conflict");
             GitProcess.Invoke(this.Enlistment.RepoRoot, "checkout " + this.Enlistment.Commitish);
@@ -343,7 +314,8 @@ public void CherryPickWithChangesInAndOutOfTheCone()
 
             // Add the folder with the commit out of the cone
             this.currentFolderList.Add(FolderTest_WorkingDirectoryTests);
-            this.SparseSet();
+            string result = this.SparseSet();
+            result.ShouldContain(UnmergedPathsMessage);
 
             // New Folder should exist
             string newFolder = this.Enlistment.GetSourcePath(FolderTest_WorkingDirectoryTests);
@@ -363,7 +335,8 @@ public void CherryPickWithChangesInAndOutOfTheCone()
 
             // New changes should exist in the recently added file
             string fileWithCherryPick = Path.Combine(newFolder, "AllNullObjectRedownloaded.txt");
-            this.fileSystem.ReadAllText(fileWithCherryPick).ShouldContain("TestTest contents for AllNullObjectRedownloaded");
+            this.fileSystem.ReadAllText(fileWithCherryPick).ShouldContain("Test contents for AllNullObjectRedownloaded");
+            GitProcess.Invoke(this.Enlistment.RepoRoot, "cherry-pick --abort");
         }
 
         [TestCase, Order(10)]
@@ -377,6 +350,7 @@ public void MergeChangesOutOfTheConeWithConflict()
             string conflictTargetBranch = "FunctionalTests/20170206_Conflict_Target";
             GitProcess.Invoke(this.Enlistment.RepoRoot, $"checkout {conflictTargetBranch}");
             GitProcess.Invoke(this.Enlistment.RepoRoot, $"checkout {conflictSourceBranch}");
+
             ProcessResult checkoutResult = GitProcess.InvokeProcess(this.Enlistment.RepoRoot, $"merge {conflictTargetBranch}");
             checkoutResult.Output.ShouldContain("Merge conflict");
 
@@ -511,9 +485,14 @@ private string SparseSet()
                 sb.Append("\n");
             }
 
+            string lockfile = Path.Combine(this.Enlistment.RepoRoot, ".git", "info", "sparse-checkout.lock");
+            this.fileSystem.FileExists(lockfile).ShouldBeFalse(message: $"{lockfile} exists");
+
             ProcessResult result = GitProcess.InvokeProcess(this.Enlistment.RepoRoot, "sparse-checkout set --stdin", sb.ToString());
+            result.ExitCode.ShouldEqual(0, $"Errors: {result.Errors}\nOutput: {result.Output}");
 
-            return result.Errors;
+            this.fileSystem.FileExists(lockfile).ShouldBeFalse(message: $"{lockfile} exists");
+            return result.Errors + result.Output;
         }
     }
 }

Scalar.FunctionalTests/Tests/GitCommands/GitRepoTests.cs

@@ -143,6 +143,8 @@ public virtual void SetupForTest()
                     sb.Append("\n");
                 }
 
+                GitProcess.InvokeProcess(this.ControlGitRepo.RootPath, "sparse-checkout init --cone", string.Empty);
+                GitProcess.InvokeProcess(this.ControlGitRepo.RootPath, "sparse-checkout set --stdin", sb.ToString());
                 GitProcess.InvokeProcess(this.Enlistment.RepoRoot, "sparse-checkout set --stdin", sb.ToString());
                 this.pathPrefixes = SparseModeFolders;
             }

Scalar/CommandLine/CloneVerb.cs

@@ -329,11 +329,7 @@ private Result GitClone()
 
             if (!this.FullClone)
             {
-                git.SetInLocalConfig($"core.sparseCheckout", "true");
-                git.SetInLocalConfig($"core.sparseCheckoutCone", "true");
-
-                this.fileSystem.CreateDirectory(Path.Combine(this.enlistment.DotGitRoot, "info"));
-                this.fileSystem.WriteAllText(Path.Combine(this.enlistment.DotGitRoot, "info", "sparse-checkout"), "/*\n!/*/*");
+                GitProcess.SparseCheckoutInit(this.enlistment);
             }
 
             this.context = new ScalarContext(this.tracer, this.fileSystem, this.enlistment);