Merge pull request git-lfs#3190 from git-lfs/ttaylorr/lock-gitignored…

…-files

locks: manage write permissions of ignored files

locking/lockable.go

@@ -122,7 +122,7 @@ func (c *Client) fixFileWriteFlags(absPath, workingDir string, lockable, unlocka
 		errs = append(errs, err)
 	}
 
-	tools.FastWalkGitRepo(absPath, func(parentDir string, fi os.FileInfo, err error) {
+	tools.FastWalkGitRepoAll(absPath, func(parentDir string, fi os.FileInfo, err error) {
 		if err != nil {
 			addErr(err)
 			return

t/t-lock.sh

@@ -229,3 +229,27 @@ begin_test "creating a lock (symlinked working directory)"
   popd > /dev/null
 )
 end_test
+
+begin_test "lock with .gitignore"
+(
+  set -e
+
+  reponame="lock-with-gitignore"
+  setup_remote_repo_with_file "$reponame" "a.txt"
+  clone_repo "$reponame" "$reponame"
+
+  echo "*.txt filter=lfs diff=lfs merge=lfs -text lockable" > .gitattributes
+
+  git add .gitattributes
+  git commit -m ".gitattributes: mark 'a.txt' as lockable"
+
+  rm -f a.txt && git checkout a.txt
+  refute_file_writeable a.txt
+
+  echo "*.txt" > .gitignore
+  git add .gitignore
+  git commit -m ".gitignore: ignore 'a.txt'"
+  rm -f a.txt && git checkout a.txt
+  refute_file_writeable a.txt
+)
+end_test

tools/filetools.go

@@ -152,7 +152,19 @@ type FastWalkCallback func(parentDir string, info os.FileInfo, err error)
 //
 // rootDir - Absolute path to the top of the repository working directory
 func FastWalkGitRepo(rootDir string, cb FastWalkCallback) {
-	walker := fastWalkWithExcludeFiles(rootDir, ".gitignore")
+	fastWalkCallback(fastWalkWithExcludeFiles(rootDir, ".gitignore"), cb)
+}
+
+// FastWalkGitRepoAll behaves as FastWalkGitRepo, with the additional caveat
+// that it does not ignore paths and directories found in .gitignore file(s)
+// throughout the repository.
+func FastWalkGitRepoAll(rootDir string, cb FastWalkCallback) {
+	fastWalkCallback(fastWalkWithExcludeFiles(rootDir, ""), cb)
+}
+
+// fastWalkCallback calls the FastWalkCallback "cb" for all files found by the
+// given *fastWalker, "walker".
+func fastWalkCallback(walker *fastWalker, cb FastWalkCallback) {
 	for file := range walker.ch {
 		cb(file.ParentDir, file.Info, file.Err)
 	}

tools/filetools_test.go

@@ -171,6 +171,32 @@ thisisnot.txt
 	sort.Strings(gotEntries)
 	assert.Equal(t, expectedEntries, gotEntries)
 
+	// Go again using FastWalkGitRepoAll instead of FastWalkGitRepo to
+	// ensure that .gitingore'd files and directories are seen and
+	// traversed, respectively.
+	for _, ignore := range ignored {
+		expectedEntries = append(expectedEntries, join(mainDir, ignore))
+	}
+	gotEntries = make([]string, 0, 1000)
+
+	FastWalkGitRepoAll(mainDir, func(parent string, info os.FileInfo, err error) {
+		if err != nil {
+			gotErrors = append(gotErrors, err)
+		} else {
+			if len(parent) == 0 {
+				gotEntries = append(gotEntries, info.Name())
+			} else {
+				gotEntries = append(gotEntries, join(parent, info.Name()))
+			}
+		}
+	})
+
+	expectedEntries = uniq(expectedEntries)
+	gotEntries = uniq(gotEntries)
+
+	sort.Strings(expectedEntries)
+	sort.Strings(gotEntries)
+	assert.Equal(t, expectedEntries, gotEntries)
 }
 
 // Make test data - ensure you've Chdir'ed into a temp dir first
@@ -233,6 +259,22 @@ func getFileMode(filename string) os.FileMode {
 	return s.Mode()
 }
 
+// uniq creates an element-wise copy of "xs" containing only unique elements in
+// the same order.
+func uniq(xs []string) []string {
+	seen := make(map[string]struct{})
+	uniq := make([]string, 0, len(xs))
+
+	for _, x := range xs {
+		if _, ok := seen[x]; !ok {
+			seen[x] = struct{}{}
+			uniq = append(uniq, x)
+		}
+	}
+
+	return uniq
+}
+
 func TestSetWriteFlag(t *testing.T) {
 	f, err := ioutil.TempFile("", "lfstestwriteflag")
 	assert.Nil(t, err)