Support .git/commondir repository layout

Git creates `.git/commondir` when there are custom worktrees (see "git worktree add" related commands).

`.git/commondir` in such case contains a link to another dot-git repository tree, which could contain some folders like:
 - objects;
 - config;
 - refs;
 - etc.

In this PR a new dotgit.RepositoryFilesystem struct is defined, which is billy.Filesystem interface compatible object-wrapper, that can handle commondir and dispatch all operations to the correct file path.

`git.PlainOpen` remain unchanged, but `git.PlainOpenWithOptions` has a new option: `PlainOpenOptions.EnableDotGitCommonDir=true|false` (which is false by default). When `EnableDotGitCommonDir=true` repository-open procedure will read `.git/commondir` (if it exists) and then create dotgit.RepositoryFilesystem object initialized with 2 filesystems. This object then passed into storage and then into dotgit.DotGit as `billy.Filesystem` interface. This object will catch all filesystem operations and dispatch to the correct repository-filesystem (dot-git or common-dot-git) according to the rules described in the doc: https://git-scm.com/docs/gitrepository-layout#Documentation/gitrepository-layout.txt. EnableDotGitCommonDir option will only work with the filesystem-backed storage.

Also worktree_test.go has been adopted from an older, already existing existing PR: src-d/go-git#1098. This PR needs new fixtures added in the following PR: go-git/go-git-fixtures#1.

Author: distorhead

go.mod

@@ -8,7 +8,7 @@ require (
 	github.com/gliderlabs/ssh v0.2.2
 	github.com/go-git/gcfg v1.5.0
 	github.com/go-git/go-billy/v5 v5.0.0
-	github.com/go-git/go-git-fixtures/v4 v4.0.1
+	github.com/go-git/go-git-fixtures/v4 v4.0.2-0.20200613231340-f56387b50c12
 	github.com/google/go-cmp v0.3.0
 	github.com/imdario/mergo v0.3.9
 	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99

go.sum

@@ -20,6 +20,8 @@ github.com/go-git/go-billy/v5 v5.0.0 h1:7NQHvd9FVid8VL4qVUMm8XifBK+2xCoZ2lSk0agR
 github.com/go-git/go-billy/v5 v5.0.0/go.mod h1:pmpqyWchKfYfrkb/UVH4otLvyi/5gJlGI4Hb3ZqZ3W0=
 github.com/go-git/go-git-fixtures/v4 v4.0.1 h1:q+IFMfLx200Q3scvt2hN79JsEzy4AmBTp/pqnefH+Bc=
 github.com/go-git/go-git-fixtures/v4 v4.0.1/go.mod h1:m+ICp2rF3jDhFgEZ/8yziagdT1C+ZpZcrJjappBCDSw=
+github.com/go-git/go-git-fixtures/v4 v4.0.2-0.20200613231340-f56387b50c12 h1:PbKy9zOy4aAKrJ5pibIRpVO2BXnK1Tlcg+caKI7Ox5M=
+github.com/go-git/go-git-fixtures/v4 v4.0.2-0.20200613231340-f56387b50c12/go.mod h1:m+ICp2rF3jDhFgEZ/8yziagdT1C+ZpZcrJjappBCDSw=
 github.com/google/go-cmp v0.3.0 h1:crn/baboCvb5fXaQ0IJ1SGTsTVrWpDsCWC8EGETZijY=
 github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
 github.com/imdario/mergo v0.3.9 h1:UauaLniWCFHWd+Jp9oCEkTBj8VO/9DKg3PV3VCNMDIg=

options.go

@@ -602,6 +602,9 @@ type PlainOpenOptions struct {
 	// DetectDotGit defines whether parent directories should be
 	// walked until a .git directory or file is found.
 	DetectDotGit bool
+	// Enable .git/commondir support (see https://git-scm.com/docs/gitrepository-layout#Documentation/gitrepository-layout.txt).
+	// NOTE: This option will only work with the filesystem storage.
+	EnableDotGitCommonDir bool
 }
 
 // Validate validates the fields and sets the default values.

repository.go

@@ -13,6 +13,8 @@ import (
 	"strings"
 	"time"
 
+	"github.com/go-git/go-git/v5/storage/filesystem/dotgit"
+
 	"github.com/go-git/go-git/v5/config"
 	"github.com/go-git/go-git/v5/internal/revision"
 	"github.com/go-git/go-git/v5/plumbing"
@@ -47,6 +49,7 @@ var (
 
 	ErrInvalidReference          = errors.New("invalid reference, should be a tag or a branch")
 	ErrRepositoryNotExists       = errors.New("repository does not exist")
+	ErrRepositoryIncomplete      = errors.New("repository's commondir path does not exist")
 	ErrRepositoryAlreadyExists   = errors.New("repository already exists")
 	ErrRemoteNotFound            = errors.New("remote not found")
 	ErrRemoteExists              = errors.New("remote already exists")
@@ -253,7 +256,19 @@ func PlainOpenWithOptions(path string, o *PlainOpenOptions) (*Repository, error)
 		return nil, err
 	}
 
-	s := filesystem.NewStorage(dot, cache.NewObjectLRUDefault())
+	var repositoryFs billy.Filesystem
+
+	if o.EnableDotGitCommonDir {
+		dotGitCommon, err := dotGitCommonDirectory(dot)
+		if err != nil {
+			return nil, err
+		}
+		repositoryFs = dotgit.NewRepositoryFilesystem(dot, dotGitCommon)
+	} else {
+		repositoryFs = dot
+	}
+
+	s := filesystem.NewStorage(repositoryFs, cache.NewObjectLRUDefault())
 
 	return Open(s, wt)
 }
@@ -328,6 +343,38 @@ func dotGitFileToOSFilesystem(path string, fs billy.Filesystem) (bfs billy.Files
 	return osfs.New(fs.Join(path, gitdir)), nil
 }
 
+func dotGitCommonDirectory(fs billy.Filesystem) (commonDir billy.Filesystem, err error) {
+	f, err := fs.Open("commondir")
+	if os.IsNotExist(err) {
+		return nil, nil
+	}
+	if err != nil {
+		return nil, err
+	}
+
+	b, err := stdioutil.ReadAll(f)
+	if err != nil {
+		return nil, err
+	}
+	if len(b) > 0 {
+		path := strings.TrimSpace(string(b))
+		if filepath.IsAbs(path) {
+			commonDir = osfs.New(path)
+		} else {
+			commonDir = osfs.New(filepath.Join(fs.Root(), path))
+		}
+		if _, err := commonDir.Stat(""); err != nil {
+			if os.IsNotExist(err) {
+				return nil, ErrRepositoryIncomplete
+			}
+
+			return nil, err
+		}
+	}
+
+	return commonDir, nil
+}
+
 // PlainClone a repository into the path with the given options, isBare defines
 // if the new repository will be bare or normal. If the path is not empty
 // ErrRepositoryAlreadyExists is returned.

storage/filesystem/dotgit/dotgit.go

@@ -30,6 +30,12 @@ const (
 	objectsPath    = "objects"
 	packPath       = "pack"
 	refsPath       = "refs"
+	branchesPath   = "branches"
+	hooksPath      = "hooks"
+	infoPath       = "info"
+	remotesPath    = "remotes"
+	logsPath       = "logs"
+	worktreesPath  = "worktrees"
 
 	tmpPackedRefsPrefix = "._packed-refs"
 

storage/filesystem/dotgit/repository_filesystem.go

@@ -0,0 +1,111 @@
+package dotgit
+
+import (
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/go-git/go-billy/v5"
+)
+
+// RepositoryFilesystem is a billy.Filesystem compatible object wrapper
+// which handles dot-git filesystem operations and supports commondir according to git scm layout:
+// https://github.com/git/git/blob/master/Documentation/gitrepository-layout.txt
+type RepositoryFilesystem struct {
+	dotGitFs       billy.Filesystem
+	commonDotGitFs billy.Filesystem
+}
+
+func NewRepositoryFilesystem(dotGitFs, commonDotGitFs billy.Filesystem) *RepositoryFilesystem {
+	return &RepositoryFilesystem{
+		dotGitFs:       dotGitFs,
+		commonDotGitFs: commonDotGitFs,
+	}
+}
+
+func (fs *RepositoryFilesystem) mapToRepositoryFsByPath(path string) billy.Filesystem {
+	// Nothing to decide if commondir not defined
+	if fs.commonDotGitFs == nil {
+		return fs.dotGitFs
+	}
+
+	cleanPath := filepath.Clean(path)
+
+	// Check exceptions for commondir (https://git-scm.com/docs/gitrepository-layout#Documentation/gitrepository-layout.txt)
+	switch cleanPath {
+	case fs.dotGitFs.Join(logsPath, "HEAD"):
+		return fs.dotGitFs
+	case fs.dotGitFs.Join(refsPath, "bisect"), fs.dotGitFs.Join(refsPath, "rewritten"), fs.dotGitFs.Join(refsPath, "worktree"):
+		return fs.dotGitFs
+	}
+
+	// Determine dot-git root by first path element.
+	// There are some elements which should always use commondir when commondir defined.
+	// Usual dot-git root will be used for the rest of files.
+	switch strings.Split(cleanPath, string(filepath.Separator))[0] {
+	case objectsPath, refsPath, packedRefsPath, configPath, branchesPath, hooksPath, infoPath, remotesPath, logsPath, shallowPath, worktreesPath:
+		return fs.commonDotGitFs
+	default:
+		return fs.dotGitFs
+	}
+}
+
+func (fs *RepositoryFilesystem) Create(filename string) (billy.File, error) {
+	return fs.mapToRepositoryFsByPath(filename).Create(filename)
+}
+
+func (fs *RepositoryFilesystem) Open(filename string) (billy.File, error) {
+	return fs.mapToRepositoryFsByPath(filename).Open(filename)
+}
+
+func (fs *RepositoryFilesystem) OpenFile(filename string, flag int, perm os.FileMode) (billy.File, error) {
+	return fs.mapToRepositoryFsByPath(filename).OpenFile(filename, flag, perm)
+}
+
+func (fs *RepositoryFilesystem) Stat(filename string) (os.FileInfo, error) {
+	return fs.mapToRepositoryFsByPath(filename).Stat(filename)
+}
+
+func (fs *RepositoryFilesystem) Rename(oldpath, newpath string) error {
+	return fs.mapToRepositoryFsByPath(oldpath).Rename(oldpath, newpath)
+}
+
+func (fs *RepositoryFilesystem) Remove(filename string) error {
+	return fs.mapToRepositoryFsByPath(filename).Remove(filename)
+}
+
+func (fs *RepositoryFilesystem) Join(elem ...string) string {
+	return fs.dotGitFs.Join(elem...)
+}
+
+func (fs *RepositoryFilesystem) TempFile(dir, prefix string) (billy.File, error) {
+	return fs.mapToRepositoryFsByPath(dir).TempFile(dir, prefix)
+}
+
+func (fs *RepositoryFilesystem) ReadDir(path string) ([]os.FileInfo, error) {
+	return fs.mapToRepositoryFsByPath(path).ReadDir(path)
+}
+
+func (fs *RepositoryFilesystem) MkdirAll(filename string, perm os.FileMode) error {
+	return fs.mapToRepositoryFsByPath(filename).MkdirAll(filename, perm)
+}
+
+func (fs *RepositoryFilesystem) Lstat(filename string) (os.FileInfo, error) {
+	return fs.mapToRepositoryFsByPath(filename).Lstat(filename)
+}
+
+func (fs *RepositoryFilesystem) Symlink(target, link string) error {
+	return fs.mapToRepositoryFsByPath(target).Symlink(target, link)
+}
+
+func (fs *RepositoryFilesystem) Readlink(link string) (string, error) {
+	return fs.mapToRepositoryFsByPath(link).Readlink(link)
+}
+
+func (fs *RepositoryFilesystem) Chroot(path string) (billy.Filesystem, error) {
+	return fs.mapToRepositoryFsByPath(path).Chroot(path)
+}
+
+func (fs *RepositoryFilesystem) Root() string {
+	return fs.dotGitFs.Root()
+}

storage/filesystem/dotgit/repository_filesystem_test.go

@@ -0,0 +1,124 @@
+package dotgit
+
+import (
+	"io/ioutil"
+	"log"
+	"os"
+
+	"github.com/go-git/go-billy/v5/osfs"
+
+	. "gopkg.in/check.v1"
+)
+
+func (s *SuiteDotGit) TestRepositoryFilesystem(c *C) {
+	dir, err := ioutil.TempDir("", "repository_filesystem")
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer os.RemoveAll(dir)
+
+	fs := osfs.New(dir)
+
+	err = fs.MkdirAll("dotGit", 0777)
+	c.Assert(err, IsNil)
+	dotGitFs, err := fs.Chroot("dotGit")
+	c.Assert(err, IsNil)
+
+	err = fs.MkdirAll("commonDotGit", 0777)
+	c.Assert(err, IsNil)
+	commonDotGitFs, err := fs.Chroot("commonDotGit")
+	c.Assert(err, IsNil)
+
+	repositoryFs := NewRepositoryFilesystem(dotGitFs, commonDotGitFs)
+	c.Assert(repositoryFs.Root(), Equals, dotGitFs.Root())
+
+	somedir, err := repositoryFs.Chroot("somedir")
+	c.Assert(err, IsNil)
+	c.Assert(somedir.Root(), Equals, repositoryFs.Join(dotGitFs.Root(), "somedir"))
+
+	_, err = repositoryFs.Create("somefile")
+	c.Assert(err, IsNil)
+
+	_, err = repositoryFs.Stat("somefile")
+	c.Assert(err, IsNil)
+
+	file, err := repositoryFs.Open("somefile")
+	c.Assert(err, IsNil)
+	err = file.Close()
+	c.Assert(err, IsNil)
+
+	file, err = repositoryFs.OpenFile("somefile", os.O_RDONLY, 0666)
+	c.Assert(err, IsNil)
+	err = file.Close()
+	c.Assert(err, IsNil)
+
+	file, err = repositoryFs.Create("somefile2")
+	c.Assert(err, IsNil)
+	err = file.Close()
+	c.Assert(err, IsNil)
+	_, err = repositoryFs.Stat("somefile2")
+	c.Assert(err, IsNil)
+	err = repositoryFs.Rename("somefile2", "newfile")
+	c.Assert(err, IsNil)
+
+	tempDir, err := repositoryFs.TempFile("tmp", "myprefix")
+	c.Assert(err, IsNil)
+	c.Assert(repositoryFs.Join(repositoryFs.Root(), "tmp", tempDir.Name()), Equals, repositoryFs.Join(dotGitFs.Root(), "tmp", tempDir.Name()))
+
+	err = repositoryFs.Symlink("newfile", "somelink")
+	c.Assert(err, IsNil)
+
+	_, err = repositoryFs.Lstat("somelink")
+	c.Assert(err, IsNil)
+
+	link, err := repositoryFs.Readlink("somelink")
+	c.Assert(err, IsNil)
+	c.Assert(link, Equals, "newfile")
+
+	err = repositoryFs.Remove("somelink")
+	c.Assert(err, IsNil)
+
+	_, err = repositoryFs.Stat("somelink")
+	c.Assert(os.IsNotExist(err), Equals, true)
+
+	dirs := []string{objectsPath, refsPath, packedRefsPath, configPath, branchesPath, hooksPath, infoPath, remotesPath, logsPath, shallowPath, worktreesPath}
+	for _, dir := range dirs {
+		err := repositoryFs.MkdirAll(dir, 0777)
+		c.Assert(err, IsNil)
+		_, err = commonDotGitFs.Stat(dir)
+		c.Assert(err, IsNil)
+		_, err = dotGitFs.Stat(dir)
+		c.Assert(os.IsNotExist(err), Equals, true)
+	}
+
+	exceptionsPaths := []string{repositoryFs.Join(logsPath, "HEAD"), repositoryFs.Join(refsPath, "bisect"), repositoryFs.Join(refsPath, "rewritten"), repositoryFs.Join(refsPath, "worktree")}
+	for _, path := range exceptionsPaths {
+		_, err := repositoryFs.Create(path)
+		c.Assert(err, IsNil)
+		_, err = commonDotGitFs.Stat(path)
+		c.Assert(os.IsNotExist(err), Equals, true)
+		_, err = dotGitFs.Stat(path)
+		c.Assert(err, IsNil)
+	}
+
+	err = repositoryFs.MkdirAll("refs/heads", 0777)
+	c.Assert(err, IsNil)
+	_, err = commonDotGitFs.Stat("refs/heads")
+	c.Assert(err, IsNil)
+	_, err = dotGitFs.Stat("refs/heads")
+	c.Assert(os.IsNotExist(err), Equals, true)
+
+	err = repositoryFs.MkdirAll("objects/pack", 0777)
+	c.Assert(err, IsNil)
+	_, err = commonDotGitFs.Stat("objects/pack")
+	c.Assert(err, IsNil)
+	_, err = dotGitFs.Stat("objects/pack")
+	c.Assert(os.IsNotExist(err), Equals, true)
+
+	err = repositoryFs.MkdirAll("a/b/c", 0777)
+	c.Assert(err, IsNil)
+	_, err = commonDotGitFs.Stat("a/b/c")
+	c.Assert(os.IsNotExist(err), Equals, true)
+	_, err = dotGitFs.Stat("a/b/c")
+	c.Assert(err, IsNil)
+}