aboutsummaryrefslogblamecommitdiffstats
path: root/remote_test.go
blob: c3e86df449512e4d406a6299f00258d48c16b256 (plain) (tree)
1
2
3
4
5
6
7
8
9

           
        
               

                    
            
                   
                  
            
              
 
                                         
                                           
                                                                     
                                                  

                                                                  
                                                     
                                                 
                                                   
 
                             
 
 


                         
 
                             
 
                                         
                                             
                                                                             

                          
                            

 
                                                          
                                                                               

                          
                             

 






                                                                                                      
                                                                
                                                                                     

                          
                             

 
                                      
                                             
                                                                             
                                                 
                                    
                                                  
                                                                                     

 
                                               
                                             
                                                                             
                                    
                                                                                      

 
                                              
                                             
                                                                             
                                    
                                                                   
 
 
                                       
                                             
                                  
                                                                             

                                    
                                                                        
                                     
                                                    
          
 
                            
                                         
 


                                                                                                                           










                                                          
                                                                             













                                                                                                                           


                                          
                                                 

                                                          

 


















                                                                             






                                                                       
                                                                


                                                         




                                               
                                                        

                            

                                                
                                             
                                                                              

                                    
                                                                        
                                    
                                                    




                            
                                                         

                            
                                                  


                          
 
                                   
                                                         

 
                                                           
                                             
                                  
                                                                             

                                    
                                                                        
                           
                                                    





                                                   
 
 
                                      
                                             
                                                                             
 
                          
                            
                                                                                                       


                                     
                                             
                                                                             
                          

                            
                                                     
                            
                                                   
 
                                                   
                            
                                                                                 


                                      
                                             
                                                                             
                          
                            
 
                                   




                                        
                                                      



                                                                  



                                                                           
 
















                                                                                                            
                               
                        
                                                



















                                                                
package git

import (
	"bytes"
	"crypto/tls"
	"fmt"
	"io"
	"io/ioutil"
	"net/http"
	"os"
	"time"

	"gopkg.in/src-d/go-git.v4/config"
	"gopkg.in/src-d/go-git.v4/plumbing"
	"gopkg.in/src-d/go-git.v4/plumbing/protocol/packp/capability"
	"gopkg.in/src-d/go-git.v4/plumbing/storer"
	"gopkg.in/src-d/go-git.v4/plumbing/transport/client"
	githttp "gopkg.in/src-d/go-git.v4/plumbing/transport/http"
	"gopkg.in/src-d/go-git.v4/storage/filesystem"
	"gopkg.in/src-d/go-git.v4/storage/memory"
	osfs "gopkg.in/src-d/go-git.v4/utils/fs/os"

	. "gopkg.in/check.v1"
)

type RemoteSuite struct {
	BaseSuite
}

var _ = Suite(&RemoteSuite{})

func (s *RemoteSuite) TestConnect(c *C) {
	url := s.GetBasicLocalRepositoryURL()
	r := newRemote(nil, nil, &config.RemoteConfig{Name: "foo", URL: url})

	err := r.Connect()
	c.Assert(err, IsNil)
}

func (s *RemoteSuite) TestnewRemoteInvalidEndpoint(c *C) {
	r := newRemote(nil, nil, &config.RemoteConfig{Name: "foo", URL: "qux"})

	err := r.Connect()
	c.Assert(err, NotNil)
}

func (s *RemoteSuite) TestnewRemoteNonExistentEndpoint(c *C) {
	r := newRemote(nil, nil, &config.RemoteConfig{Name: "foo", URL: "ssh://non-existent/foo.git"})

	err := r.Connect()
	c.Assert(err, NotNil)
}

func (s *RemoteSuite) TestnewRemoteInvalidSchemaEndpoint(c *C) {
	r := newRemote(nil, nil, &config.RemoteConfig{Name: "foo", URL: "qux://foo"})

	err := r.Connect()
	c.Assert(err, NotNil)
}

func (s *RemoteSuite) TestInfo(c *C) {
	url := s.GetBasicLocalRepositoryURL()
	r := newRemote(nil, nil, &config.RemoteConfig{Name: "foo", URL: url})
	c.Assert(r.AdvertisedReferences(), IsNil)
	c.Assert(r.Connect(), IsNil)
	c.Assert(r.AdvertisedReferences(), NotNil)
	c.Assert(r.AdvertisedReferences().Capabilities.Get(capability.Agent), NotNil)
}

func (s *RemoteSuite) TestDefaultBranch(c *C) {
	url := s.GetBasicLocalRepositoryURL()
	r := newRemote(nil, nil, &config.RemoteConfig{Name: "foo", URL: url})
	c.Assert(r.Connect(), IsNil)
	c.Assert(r.Head().Name(), Equals, plumbing.ReferenceName("refs/heads/master"))
}

func (s *RemoteSuite) TestCapabilities(c *C) {
	url := s.GetBasicLocalRepositoryURL()
	r := newRemote(nil, nil, &config.RemoteConfig{Name: "foo", URL: url})
	c.Assert(r.Connect(), IsNil)
	c.Assert(r.Capabilities().Get(capability.Agent), HasLen, 1)
}

func (s *RemoteSuite) TestFetch(c *C) {
	url := s.GetBasicLocalRepositoryURL()
	sto := memory.NewStorage()
	r := newRemote(sto, nil, &config.RemoteConfig{Name: "foo", URL: url})
	c.Assert(r.Connect(), IsNil)

	refspec := config.RefSpec("+refs/heads/*:refs/remotes/origin/*")
	err := r.Fetch(&FetchOptions{
		RefSpecs: []config.RefSpec{refspec},
	})

	c.Assert(err, IsNil)
	c.Assert(sto.Objects, HasLen, 31)

	expectedRefs := []*plumbing.Reference{
		plumbing.NewReferenceFromStrings("refs/remotes/origin/master", "6ecf0ef2c2dffb796033e5a02219af86ec6584e5"),
		plumbing.NewReferenceFromStrings("refs/remotes/origin/branch", "e8d3ffab552895c19b9fcf7aa264d277cde33881"),
	}

	for _, exp := range expectedRefs {
		r, _ := sto.Reference(exp.Name())
		c.Assert(exp.String(), Equals, r.String())
	}
}

func (s *RemoteSuite) TestFetchDepth(c *C) {
	url := s.GetBasicLocalRepositoryURL()
	sto := memory.NewStorage()
	r := newRemote(sto, nil, &config.RemoteConfig{Name: "foo", URL: url})
	c.Assert(r.Connect(), IsNil)

	refspec := config.RefSpec("+refs/heads/*:refs/remotes/origin/*")
	err := r.Fetch(&FetchOptions{
		RefSpecs: []config.RefSpec{refspec},
		Depth:    1,
	})

	c.Assert(err, IsNil)
	c.Assert(sto.Objects, HasLen, 18)

	expectedRefs := []*plumbing.Reference{
		plumbing.NewReferenceFromStrings("refs/remotes/origin/master", "6ecf0ef2c2dffb796033e5a02219af86ec6584e5"),
		plumbing.NewReferenceFromStrings("refs/remotes/origin/branch", "e8d3ffab552895c19b9fcf7aa264d277cde33881"),
	}

	for _, exp := range expectedRefs {
		r, _ := sto.Reference(exp.Name())
		c.Assert(exp.String(), Equals, r.String())
	}
}

func (s *RemoteSuite) TestFetchWithProgress(c *C) {
	url := s.GetBasicLocalRepositoryURL()
	sto := memory.NewStorage()
	buf := bytes.NewBuffer(nil)

	r := newRemote(sto, buf, &config.RemoteConfig{Name: "foo", URL: url})
	c.Assert(r.Connect(), IsNil)

	refspec := config.RefSpec("+refs/heads/*:refs/remotes/origin/*")
	err := r.Fetch(&FetchOptions{
		RefSpecs: []config.RefSpec{refspec},
	})

	c.Assert(err, IsNil)
	c.Assert(sto.Objects, HasLen, 31)

	c.Assert(buf.Len(), Not(Equals), 0)
}

type mockPackfileWriter struct {
	Storer
	PackfileWriterCalled bool
}

func (m *mockPackfileWriter) PackfileWriter() (io.WriteCloser, error) {
	m.PackfileWriterCalled = true
	return m.Storer.(storer.PackfileWriter).PackfileWriter()
}

func (s *RemoteSuite) TestFetchWithPackfileWriter(c *C) {
	dir, err := ioutil.TempDir("", "fetch")
	c.Assert(err, IsNil)

	defer os.RemoveAll(dir) // clean up

	fss, err := filesystem.NewStorage(osfs.New(dir))
	c.Assert(err, IsNil)

	mock := &mockPackfileWriter{Storer: fss}

	url := s.GetBasicLocalRepositoryURL()
	r := newRemote(mock, nil, &config.RemoteConfig{Name: "foo", URL: url})
	c.Assert(r.Connect(), IsNil)

	refspec := config.RefSpec("+refs/heads/*:refs/remotes/origin/*")
	err = r.Fetch(&FetchOptions{
		RefSpecs: []config.RefSpec{refspec},
	})

	c.Assert(err, IsNil)

	var count int
	iter, err := mock.IterObjects(plumbing.AnyObject)
	c.Assert(err, IsNil)

	iter.ForEach(func(plumbing.Object) error {
		count++
		return nil
	})

	c.Assert(count, Equals, 31)
	c.Assert(mock.PackfileWriterCalled, Equals, true)
}

func (s *RemoteSuite) TestFetchNoErrAlreadyUpToDate(c *C) {
	url := s.GetBasicLocalRepositoryURL()
	sto := memory.NewStorage()
	r := newRemote(sto, nil, &config.RemoteConfig{Name: "foo", URL: url})
	c.Assert(r.Connect(), IsNil)

	refspec := config.RefSpec("+refs/heads/*:refs/remotes/origin/*")
	o := &FetchOptions{
		RefSpecs: []config.RefSpec{refspec},
	}

	err := r.Fetch(o)
	c.Assert(err, IsNil)
	err = r.Fetch(o)
	c.Assert(err, Equals, NoErrAlreadyUpToDate)
}

func (s *RemoteSuite) TestHead(c *C) {
	url := s.GetBasicLocalRepositoryURL()
	r := newRemote(nil, nil, &config.RemoteConfig{Name: "foo", URL: url})

	err := r.Connect()
	c.Assert(err, IsNil)
	c.Assert(r.Head().Hash(), Equals, plumbing.NewHash("6ecf0ef2c2dffb796033e5a02219af86ec6584e5"))
}

func (s *RemoteSuite) TestRef(c *C) {
	url := s.GetBasicLocalRepositoryURL()
	r := newRemote(nil, nil, &config.RemoteConfig{Name: "foo", URL: url})
	err := r.Connect()
	c.Assert(err, IsNil)

	ref, err := r.Reference(plumbing.HEAD, false)
	c.Assert(err, IsNil)
	c.Assert(ref.Name(), Equals, plumbing.HEAD)

	ref, err = r.Reference(plumbing.HEAD, true)
	c.Assert(err, IsNil)
	c.Assert(ref.Name(), Equals, plumbing.ReferenceName("refs/heads/master"))
}

func (s *RemoteSuite) TestRefs(c *C) {
	url := s.GetBasicLocalRepositoryURL()
	r := newRemote(nil, nil, &config.RemoteConfig{Name: "foo", URL: url})
	err := r.Connect()
	c.Assert(err, IsNil)

	iter, err := r.References()
	c.Assert(err, IsNil)
	c.Assert(iter, NotNil)
}

func (s *RemoteSuite) TestString(c *C) {
	r := newRemote(nil, nil, &config.RemoteConfig{
		Name: "foo",
		URL:  "https://github.com/git-fixtures/basic.git",
	})

	c.Assert(r.String(), Equals, ""+
		"foo\thttps://github.com/git-fixtures/basic.git (fetch)\n"+
		"foo\thttps://github.com/git-fixtures/basic.git (push)",
	)
}

// Here is an example to configure http client according to our own needs.
func Example_customHTTPClient() {
	const url = "https://github.com/git-fixtures/basic.git"

	// Create a custom http(s) client with your config
	customClient := &http.Client{
		Transport: &http.Transport{
			TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
		}, // accept any certificate (might be useful for testing)
		Timeout: 15 * time.Second, // 15 second timeout
		CheckRedirect: func(req *http.Request, via []*http.Request) error { // don't follow redirect
			return http.ErrUseLastResponse
		},
	}

	// Override http(s) default protocol to use our custom client
	client.InstallProtocol(
		"https",
		githttp.NewClient(customClient))

	// Create an in-memory repository
	r := NewMemoryRepository()

	// Clone repo
	if err := r.Clone(&CloneOptions{URL: url}); err != nil {
		panic(err)
	}

	// Retrieve the branch pointed by HEAD
	head, err := r.Head()
	if err != nil {
		panic(err)
	}

	// Print latest commit hash
	fmt.Println(head.Hash())
	// Output:
	// 6ecf0ef2c2dffb796033e5a02219af86ec6584e5
}