submodule init and update implementation

Author: mcuadros

common.go

@@ -2,6 +2,8 @@ package git
 
 import "strings"
 
+const defaultDotGitPath = ".git"
+
 // countLines returns the number of lines in a string à la git, this is
 // The newline character is assumed to be '\n'.  The empty string
 // contains 0 lines.  If the last line of the string doesn't end with a

submodule.go

@@ -1,33 +1,79 @@
 package git
 
 import (
-	"fmt"
-
+	"srcd.works/go-git.v4/config"
 	"srcd.works/go-git.v4/plumbing"
 )
 
+// Submodule a submodule allows you to keep another Git repository in a
+// subdirectory of your repository.
 type Submodule struct {
-	Name   string
-	Branch string
-	URL    string
-
+	m *config.Submodule
+	w *Worktree
+	// r is the submodule repository
 	r *Repository
 }
 
+// Config returns the submodule config
+func (s *Submodule) Config() *config.Submodule {
+	return s.m
+}
+
+// Init initialize the submodule reading the recoreded Entry in the index for
+// the given submodule
 func (s *Submodule) Init() error {
-	return s.r.clone(&CloneOptions{
-		URL:           s.URL,
-		ReferenceName: plumbing.ReferenceName(s.Branch),
+	e, err := s.w.readIndexEntry(s.m.Path)
+	if err != nil {
+		return err
+	}
+
+	_, err = s.r.CreateRemote(&config.RemoteConfig{
+		Name: DefaultRemoteName,
+		URL:  s.m.URL,
 	})
+
+	if err != nil {
+		return err
+	}
+
+	return s.fetchAndCheckout(e.Hash)
+}
+
+// Update  the registered submodule to match what the superproject expects
+func (s *Submodule) Update() error {
+	e, err := s.w.readIndexEntry(s.m.Path)
+	if err != nil {
+		return err
+	}
+
+	return s.fetchAndCheckout(e.Hash)
+}
+
+func (s *Submodule) fetchAndCheckout(hash plumbing.Hash) error {
+	if err := s.r.Fetch(&FetchOptions{}); err != nil && err != NoErrAlreadyUpToDate {
+		return err
+	}
+
+	w, err := s.r.Worktree()
+	if err != nil {
+		return err
+	}
+
+	if err := w.Checkout(hash); err != nil {
+		return err
+	}
+
+	head := plumbing.NewHashReference(plumbing.HEAD, hash)
+	return s.r.Storer.SetReference(head)
 }
 
+// Submodules list of several submodules from the same repository
 type Submodules []*Submodule
 
+// Init initialize the submodule recorded in the index
 func (s Submodules) Init() error {
 	for _, sub := range s {
-		fmt.Println("clone", sub.URL)
 		if err := sub.Init(); err != nil {
-			fmt.Println(err)
 			return err
 		}
 	}

submodule_test.go

@@ -0,0 +1,114 @@
+package git
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+
+	"github.com/src-d/go-git-fixtures"
+
+	. "gopkg.in/check.v1"
+	"srcd.works/go-git.v4/plumbing"
+)
+
+type SubmoduleSuite struct {
+	BaseSuite
+	Worktree *Worktree
+	path     string
+}
+
+var _ = Suite(&SubmoduleSuite{})
+
+func (s *SubmoduleSuite) SetUpTest(c *C) {
+	path := fixtures.ByTag("submodule").One().Worktree().Base()
+
+	dir, err := ioutil.TempDir("", "submodule")
+	c.Assert(err, IsNil)
+
+	r, err := PlainClone(dir, false, &CloneOptions{
+		URL: fmt.Sprintf("file://%s", filepath.Join(path)),
+	})
+
+	c.Assert(err, IsNil)
+
+	s.Repository = r
+	s.Worktree, err = r.Worktree()
+	c.Assert(err, IsNil)
+
+	s.path = path
+}
+
+func (s *SubmoduleSuite) TearDownTest(c *C) {
+	err := os.RemoveAll(s.path)
+	c.Assert(err, IsNil)
+}
+
+func (s *SubmoduleSuite) TestInit(c *C) {
+	sm, err := s.Worktree.Submodule("basic")
+	c.Assert(err, IsNil)
+
+	_, err = sm.r.Reference(plumbing.HEAD, true)
+	c.Assert(err, Equals, plumbing.ErrReferenceNotFound)
+
+	err = sm.Init()
+	c.Assert(err, IsNil)
+
+	ref, err := sm.r.Reference(plumbing.HEAD, true)
+	c.Assert(err, IsNil)
+	c.Assert(ref.Hash().String(), Equals, "6ecf0ef2c2dffb796033e5a02219af86ec6584e5")
+
+	w, err := sm.r.Worktree()
+	c.Assert(err, IsNil)
+
+	status, err := w.Status()
+	c.Assert(err, IsNil)
+	c.Assert(status.IsClean(), Equals, true)
+}
+
+func (s *SubmoduleSuite) TestUpdate(c *C) {
+	sm, err := s.Worktree.Submodule("basic")
+	c.Assert(err, IsNil)
+
+	_, err = sm.r.Reference(plumbing.HEAD, true)
+	c.Assert(err, Equals, plumbing.ErrReferenceNotFound)
+
+	err = sm.Init()
+	c.Assert(err, IsNil)
+
+	idx, err := s.Repository.Storer.Index()
+	c.Assert(err, IsNil)
+
+	for i, e := range idx.Entries {
+		if e.Name == "basic" {
+			e.Hash = plumbing.NewHash("b029517f6300c2da0f4b651b8642506cd6aaf45d")
+		}
+
+		idx.Entries[i] = e
+	}
+
+	err = s.Repository.Storer.SetIndex(idx)
+	c.Assert(err, IsNil)
+
+	err = sm.Update()
+	c.Assert(err, IsNil)
+
+	ref, err := sm.r.Reference(plumbing.HEAD, true)
+	c.Assert(err, IsNil)
+	c.Assert(ref.Hash().String(), Equals, "b029517f6300c2da0f4b651b8642506cd6aaf45d")
+
+}
+
+func (s *SubmoduleSuite) TestSubmodulesInit(c *C) {
+	sm, err := s.Worktree.Submodules()
+	c.Assert(err, IsNil)
+
+	err = sm.Init()
+	c.Assert(err, IsNil)
+
+	for _, m := range sm {
+		ref, err := m.r.Reference(plumbing.HEAD, true)
+		c.Assert(err, IsNil)
+		c.Assert(ref.Hash(), Not(Equals), plumbing.ZeroHash)
+	}
+}