Added support to checkout a tag

Fixes: #1

Giltfile.yaml

@@ -3,10 +3,13 @@ giltDir: ~/.gilt/clone
 debug: false
 repositories:
   - git: https://github.com/retr0h/ansible-etcd.git
-    version: 77a95b7
+    sha: 77a95b7
+    dstDir: /tmp/retr0h.ansible-etcd
+  - git: https://github.com/retr0h/ansible-etcd.git
+    tag: 1.1
     dstDir: /tmp/retr0h.ansible-etcd
   - git: https://github.com/lorin/openstack-ansible-modules.git
-    version: 2677cc3
+    sha: 2677cc3
     sources:
       - src: "*_manage"
         dstDir: /tmp/library

README.md

@@ -23,8 +23,7 @@ This project is a port of [Gilt][], it is not 100% compatible with the python
 version, and aims to correct poor decisions made in the python version of
 Gilt.
 
-This version of Gilt does not handle branches and tags unlike our python
-friend.  However, those features will be added soon.
+This version of Gilt does not handle branches unlike our python friend.
 
 ## Installation
 
@@ -48,11 +47,13 @@ giltDir: ~/.gilt/clone
 debug: false
 repositories:
   - git: https://github.com/retr0h/ansible-etcd.git
-    version: 77a95b7
+    sha: 77a95b7
     dstDir: roles/retr0h.ansible-etcd
-
+  - git: https://github.com/retr0h/ansible-etcd.git
+    tag: 1.1
+    dstDir: roles/retr0h.ansible-etcd-tag
   - git: https://github.com/lorin/openstack-ansible-modules.git
-    version: 2677cc3
+    sha: 2677cc3
     sources:
       - src: "*_manage"
         dstDir: library
@@ -118,7 +119,7 @@ func main() {
 		Repositories: []config.Repository{
 			{
 				Git:     "https://github.com/retr0h/ansible-etcd.git",
-				Version: "77a95b7",
+				SHA:     "77a95b7",
 				DstDir:  "../tmp/retr0h.ansible-etcd",
 			},
 		},

internal/git.go

@@ -23,6 +23,7 @@ package internal
 // GitManager manager responsible for Git operations.
 type GitManager interface {
 	Clone(gitURL string, cloneDir string) error
-	Reset(cloneDir string, gitVersion string) error
+	CloneByTag(gitURL string, gitTag string, cloneDir string) error
+	Reset(cloneDir string, gitSHA string) error
 	CheckoutIndex(dstDir string, cloneDir string) error
 }

internal/git/git.go

@@ -48,21 +48,32 @@ func New(
 	}
 }
 
-// Clone as exec manager to clone repo.
+// Clone git clone repo.
 func (g *Git) Clone(
 	gitURL string,
 	cloneDir string,
 ) error {
-	// return g.execManager.Clone(gitURL, cloneDir)
 	return g.execManager.RunCmd("git", []string{"clone", gitURL, cloneDir})
 }
 
+// CloneByTag git clone repo by tag.
+func (g *Git) CloneByTag(
+	gitURL string,
+	gitTag string,
+	cloneDir string,
+) error {
+	return g.execManager.RunCmd(
+		"git",
+		[]string{"clone", "--depth", "1", "--branch", gitTag, gitURL, cloneDir},
+	)
+}
+
 // Reset to the given git version.
 func (g *Git) Reset(
 	cloneDir string,
-	gitVersion string,
+	gitSHA string,
 ) error {
-	return g.execManager.RunCmd("git", []string{"-C", cloneDir, "reset", "--hard", gitVersion})
+	return g.execManager.RunCmd("git", []string{"-C", cloneDir, "reset", "--hard", gitSHA})
 }
 
 // CheckoutIndex checkout Repository.Git to Repository.DstDir.

internal/git/git_public_test.go

@@ -42,10 +42,11 @@ type GitManagerPublicTestSuite struct {
 	ctrl     *gomock.Controller
 	mockExec *exec.MockExecManager
 
-	gitURL     string
-	gitVersion string
-	cloneDir   string
-	dstDir     string
+	gitURL   string
+	gitSHA   string
+	gitTag   string
+	cloneDir string
+	dstDir   string
 
 	gm internal.GitManager
 }
@@ -65,7 +66,8 @@ func (suite *GitManagerPublicTestSuite) SetupTest() {
 	defer suite.ctrl.Finish()
 
 	suite.gitURL = "https://example.com/user/repo.git"
-	suite.gitVersion = "abc123"
+	suite.gitSHA = "abc123"
+	suite.gitTag = "v1.1"
 	suite.cloneDir = "/cloneDir"
 	suite.dstDir = "/dstDir"
 
@@ -89,19 +91,36 @@ func (suite *GitManagerPublicTestSuite) TestCloneReturnsError() {
 	assert.Error(suite.T(), err)
 }
 
+func (suite *GitManagerPublicTestSuite) TestCloneByTagOk() {
+	suite.mockExec.EXPECT().
+		RunCmd("git", []string{"clone", "--depth", "1", "--branch", suite.gitTag, suite.gitURL, suite.cloneDir}).
+		Return(nil)
+
+	err := suite.gm.CloneByTag(suite.gitURL, suite.gitTag, suite.cloneDir)
+	assert.NoError(suite.T(), err)
+}
+
+func (suite *GitManagerPublicTestSuite) TestCloneByTagReturnsError() {
+	errors := errors.New("tests error")
+	suite.mockExec.EXPECT().RunCmd(gomock.Any(), gomock.Any()).Return(errors)
+
+	err := suite.gm.CloneByTag(suite.gitURL, suite.gitTag, suite.cloneDir)
+	assert.Error(suite.T(), err)
+}
+
 func (suite *GitManagerPublicTestSuite) TestResetOk() {
 	suite.mockExec.EXPECT().
-		RunCmd("git", []string{"-C", suite.cloneDir, "reset", "--hard", suite.gitVersion})
+		RunCmd("git", []string{"-C", suite.cloneDir, "reset", "--hard", suite.gitSHA})
 
-	err := suite.gm.Reset(suite.cloneDir, suite.gitVersion)
+	err := suite.gm.Reset(suite.cloneDir, suite.gitSHA)
 	assert.NoError(suite.T(), err)
 }
 
 func (suite *GitManagerPublicTestSuite) TestResetReturnsError() {
 	errors := errors.New("tests error")
 	suite.mockExec.EXPECT().RunCmd(gomock.Any(), gomock.Any()).Return(errors)
 
-	err := suite.gm.Reset(suite.cloneDir, suite.gitVersion)
+	err := suite.gm.Reset(suite.cloneDir, suite.gitSHA)
 	assert.Error(suite.T(), err)
 }
 

internal/repositories/repositories.go

@@ -67,8 +67,12 @@ func (r *Repositories) getCloneHash(
 		":", "-",
 	)
 	replacedGitURL := replacer.Replace(c.Git)
+	version := c.SHA
+	if c.Tag != "" {
+		version = c.Tag
+	}
 
-	return fmt.Sprintf("%s-%s", replacedGitURL, c.Version)
+	return fmt.Sprintf("%s-%s", replacedGitURL, version)
 }
 
 // getCacheDir create the cacheDir if it doesn't exist.

internal/repositories/repositories_public_test.go

@@ -50,7 +50,7 @@ type RepositoriesPublicTestSuite struct {
 	dstDir           string
 	giltDir          string
 	gitURL           string
-	gitVersion       string
+	gitSHA           string
 	repoConfigDstDir []config.Repository
 	logger           *slog.Logger
 }
@@ -84,12 +84,12 @@ func (suite *RepositoriesPublicTestSuite) SetupTest() {
 	suite.dstDir = "/dstDir"
 	suite.giltDir = "/giltDir"
 	suite.gitURL = "https://example.com/user/repo.git"
-	suite.gitVersion = "abc1234"
+	suite.gitSHA = "abc1234"
 	suite.repoConfigDstDir = []config.Repository{
 		{
-			Git:     suite.gitURL,
-			Version: suite.gitVersion,
-			DstDir:  suite.dstDir,
+			Git:    suite.gitURL,
+			SHA:    suite.gitSHA,
+			DstDir: suite.dstDir,
 		},
 	}
 
@@ -150,8 +150,8 @@ func (suite *RepositoriesPublicTestSuite) TestOverlayReturnsErrorWhenCheckoutInd
 func (suite *RepositoriesPublicTestSuite) TestOverlayOkWhenCopySources() {
 	repoConfig := []config.Repository{
 		{
-			Git:     suite.gitURL,
-			Version: suite.gitVersion,
+			Git: suite.gitURL,
+			SHA: suite.gitSHA,
 			Sources: []config.Source{
 				{
 					Src:    "srcDir",
@@ -174,8 +174,8 @@ func (suite *RepositoriesPublicTestSuite) TestOverlayOkWhenCopySources() {
 func (suite *RepositoriesPublicTestSuite) TestOverlayReturnsErrorWhenCopySourcesErrors() {
 	repoConfig := []config.Repository{
 		{
-			Git:     suite.gitURL,
-			Version: suite.gitVersion,
+			Git: suite.gitURL,
+			SHA: suite.gitSHA,
 			Sources: []config.Source{
 				{
 					Src:    "srcDir",
@@ -197,9 +197,9 @@ func (suite *RepositoriesPublicTestSuite) TestOverlayReturnsErrorWhenCopySources
 func (suite *RepositoriesPublicTestSuite) TestOverlayOkWhenCommands() {
 	repoConfig := []config.Repository{
 		{
-			Git:     suite.gitURL,
-			Version: suite.gitVersion,
-			DstDir:  suite.dstDir,
+			Git:    suite.gitURL,
+			SHA:    suite.gitSHA,
+			DstDir: suite.dstDir,
 			Commands: []config.Command{
 				{
 					Cmd:  "touch",
@@ -222,9 +222,9 @@ func (suite *RepositoriesPublicTestSuite) TestOverlayOkWhenCommands() {
 func (suite *RepositoriesPublicTestSuite) TestOverlayReturnsErrorWhenCommandErrors() {
 	repoConfig := []config.Repository{
 		{
-			Git:     suite.gitURL,
-			Version: suite.gitVersion,
-			DstDir:  suite.dstDir,
+			Git:    suite.gitURL,
+			SHA:    suite.gitSHA,
+			DstDir: suite.dstDir,
 			Commands: []config.Command{
 				{
 					Cmd:  "touch",

internal/repositories/repositories_test.go

@@ -82,24 +82,38 @@ func (suite *RepositoriesTestSuite) TestgetCloneDirOk() {
 	repos := suite.NewTestRepositories(suite.giltDir)
 
 	got := repos.getCloneDir(
-		"/giltDir",
+		suite.giltDir,
 		config.Repository{
-			Version: "abc123",
+			Git: "https://example.com/user/repo2.git",
+			SHA: "abc123",
 		},
 	)
-	assert.Equal(suite.T(), got, "/giltDir/-abc123")
+	assert.Equal(suite.T(), "/giltDir/https---example.com-user-repo2.git-abc123", got)
 }
 
-func (suite *RepositoriesTestSuite) TestgetCloneHash() {
+func (suite *RepositoriesTestSuite) TestgetCloneDirOkByTag() {
 	repos := suite.NewTestRepositories(suite.giltDir)
 
 	got := repos.getCloneDir(
-		"https://example.com/user/repo2.git",
+		suite.giltDir,
 		config.Repository{
-			Version: "abc123",
+			Git: "https://example.com/user/repo2.git",
+			Tag: "v1.1",
 		},
 	)
-	assert.Equal(suite.T(), got, "https:/example.com/user/repo2.git/-abc123")
+	assert.Equal(suite.T(), "/giltDir/https---example.com-user-repo2.git-v1.1", got)
+}
+
+func (suite *RepositoriesTestSuite) TestgetCloneHashOk() {
+	repos := suite.NewTestRepositories(suite.giltDir)
+
+	got := repos.getCloneHash(
+		config.Repository{
+			Git: "https://example.com/user/repo2.git",
+			SHA: "abc123",
+		},
+	)
+	assert.Equal(suite.T(), "https---example.com-user-repo2.git-abc123", got)
 }
 
 func (suite *RepositoriesTestSuite) TestgetCacheDir() {
@@ -108,7 +122,7 @@ func (suite *RepositoriesTestSuite) TestgetCacheDir() {
 	expectedDir := "/giltDir/cache"
 	got, err := repos.getCacheDir()
 	assert.NoError(suite.T(), err)
-	assert.Equal(suite.T(), got, expectedDir)
+	assert.Equal(suite.T(), expectedDir, got)
 
 	exists, err := afero.Exists(suite.appFs, expectedDir)
 	assert.NoError(suite.T(), err)

internal/repository/repository.go

@@ -80,25 +80,34 @@ func glob(
 }
 
 // Clone clone Repository.Git to Repository.getCloneDir, and hard checkout
-// to Repository.Version.
+// to Repository.SHA.
 func (r *Repository) Clone(
 	c config.Repository,
 	cloneDir string,
 ) error {
 	r.logger.Info(
 		"cloning",
 		slog.String("repository", c.Git),
-		slog.String("version", c.Version),
+		slog.String("sha", c.SHA),
+		slog.String("tag", c.Tag),
 		slog.String("dstDir", cloneDir),
 	)
 
 	if _, err := r.appFs.Stat(cloneDir); os.IsNotExist(err) {
-		if err := r.gitManager.Clone(c.Git, cloneDir); err != nil {
-			return err
+		if c.SHA != "" {
+			if err := r.gitManager.Clone(c.Git, cloneDir); err != nil {
+				return err
+			}
+
+			if err := r.gitManager.Reset(cloneDir, c.SHA); err != nil {
+				return err
+			}
 		}
 
-		if err := r.gitManager.Reset(cloneDir, c.Version); err != nil {
-			return err
+		if c.Tag != "" {
+			if err := r.gitManager.CloneByTag(c.Git, c.Tag, cloneDir); err != nil {
+				return err
+			}
 		}
 	} else {
 		r.logger.Warn(