cat-file_test.go

package gitgo

import (
	"compress/zlib"
	"fmt"
	"io"
	"io/ioutil"
	"os"
	"path/filepath"
	"reflect"
	"strings"
	"testing"
	"time"
)

func ReadAll(t *testing.T, r io.Reader) []byte {
	bts, err := ioutil.ReadAll(r)
	if err != nil {
		t.Error(err)
	}
	return bts
}

// ReaderEqual tests that two readers read the same number of bytes
// and read the same content
func ReaderEqual(t *testing.T, r1 io.Reader, expected io.Reader) (err error) {
	bts1, err := ioutil.ReadAll(r1)
	if err != nil {
		t.Error(err)
		return
	}
	bts2, err := ioutil.ReadAll(expected)
	if err != nil {
		t.Error(err)
		return
	}
	if !reflect.DeepEqual(bts1, bts2) {
		err = fmt.Errorf("Actual does not match expected: %s, %s", string(bts1), string(bts2))
		t.Error(err)
		return
	}
	return nil
}

func Test_parseObjInitialCommit(t *testing.T) {
	tm, err := time.Parse(RFC2822, "Fri Apr 3 11:45:00 2015 -0400")
	if err != nil {
		t.Fatal(err)
	}
	const inputSHA = SHA("97eed02ebe122df8fdd853c1215d8775f3d9f1a1")
	expected := Commit{
		_type:         "commit",
		Name:          inputSHA,
		Tree:          "9de6c72106b169990a83ce7090c7cad84b6b506b",
		Parents:       nil,
		Author:        "aditya <dev@chimeracoder.net>",
		AuthorDate:    tm,
		Committer:     "aditya <dev@chimeracoder.net>",
		CommitterDate: tm,
		Message:       []byte("First commit. Create .gitignore"),
		size:          "190",
	}
	const input = "commit 190\x00" + `tree 9de6c72106b169990a83ce7090c7cad84b6b506b
author aditya <dev@chimeracoder.net> 1428075900 -0400
committer aditya <dev@chimeracoder.net> 1428075900 -0400

First commit. Create .gitignore`

	pwd, err := os.Open(".")
	if err != nil {
		t.Fatal(err)
	}

	result, err := parseObj(strings.NewReader(input), inputSHA, *pwd)
	if err != nil {
		t.Error(err)
		return
	}

	if !reflect.DeepEqual(expected, result) {
		t.Errorf("Expected and result don't match:\n%+v\n%+v", expected, result)
	}
}

func Test_parseObjTreeCommit(t *testing.T) {
	tm, err := time.Parse(RFC2822, "Mon Apr 6 15:51:36 2015 -0400")
	if err != nil {
		t.Fatal(err)
	}
	const inputSHA = SHA("3ead3116d0378089f5ce61086354aac43e736b01")
	const fileContents = "commit 243\x00tree d22fc8a57073fdecae2001d00aff921440d3aabd\nparent 1d833eb5b6c5369c0cb7a4a3e20ded237490145f\nauthor aditya <dev@chimeracoder.net> 1428349896 -0400\ncommitter aditya <dev@chimeracoder.net> 1428349896 -0400\n\nRemove extraneous logging statements\n"

	expected := Commit{
		_type:         "commit",
		Name:          inputSHA,
		Tree:          "d22fc8a57073fdecae2001d00aff921440d3aabd",
		Parents:       []SHA{"1d833eb5b6c5369c0cb7a4a3e20ded237490145f"},
		Author:        "aditya <dev@chimeracoder.net>",
		AuthorDate:    tm,
		Committer:     "aditya <dev@chimeracoder.net>",
		CommitterDate: tm,
		Message:       []byte("Remove extraneous logging statements\n"),
		size:          "243",
	}

	pwd, err := os.Open(".")
	if err != nil {
		t.Fatal(err)
	}

	result, err := parseObj(strings.NewReader(fileContents), inputSHA, *pwd)
	if err != nil {
		t.Error(err)
		return
	}

	if !reflect.DeepEqual(expected, result) {
		t.Errorf("Expected and result don't match:\n%+v\n%+v", expected, result)
	}
}

func Test_ParseTree(t *testing.T) {
	const inputSha = SHA("1efecd717188441397c07f267cf468fdf04d4796")
	expected := Tree{
		_type: "tree",
		size:  "156",
		Blobs: []objectMeta{
			objectMeta{SHA("af6e4fe91a8f9a0f3c03cbec9e1d2aac47345d67"), "100644", ".gitignore"},
			objectMeta{SHA("f45d37d9add8f21eb84678f6d2c66377c4dd0c5e"), "100644", "cat-file.go"},
			objectMeta{SHA("2c225b962d6666011c69ca5c2c67204959f8ba32"), "100644", "cat-file_test.go"},
		},
		Trees: []objectMeta{
			objectMeta{SHA("d564d0bc3dd917926892c55e3706cc116d5b165e"), "040000", "examples"},
		},
	}
	result, err := NewObject(inputSha, *RepoDir)
	if err != nil {
		t.Error(err)
	}
	if !reflect.DeepEqual(expected, result) {
		t.Errorf("Expected and result don't match:\n\n%+v\n\n%+v", expected, result)
	}

}

func Test_ParseBlob(t *testing.T) {
	const inputSha = SHA("af6e4fe91a8f9a0f3c03cbec9e1d2aac47345d67")
	expected := Blob{
		_type:    "blob",
		size:     "18",
		Contents: []byte("*.swp\n*.swo\n*.swn\n"),
	}
	result, err := NewObject(inputSha, *RepoDir)
	if err != nil {
		t.Error(err)
	}
	if !reflect.DeepEqual(expected, result) {
		t.Errorf("Expected and result don't match:\n\n%+v\n\n%+v", expected, result)
	}

}

func Test_ParsePackfile(t *testing.T) {
	const inputSha = SHA("c3b8133617bbdb72e237b0f163fade7fbf1f0c18")
	const expected = 2160

	result, err := NewObject(inputSha, *RepoDir)
	if err != nil {
		t.Error(err)
		return
	}

	// TODO remove this type assertion
	if len(result.(Blob).rawData) != expected {
		t.Errorf("expected and result don't match")
	}
}

func Test_ParsePrefix(t *testing.T) {
	const inputSha = SHA("1efecd717188441397c07f267cf468fdf04d4796")
	expected := Tree{
		_type: "tree",
		size:  "156",
		Blobs: []objectMeta{
			objectMeta{SHA("af6e4fe91a8f9a0f3c03cbec9e1d2aac47345d67"), "100644", ".gitignore"},
			objectMeta{SHA("f45d37d9add8f21eb84678f6d2c66377c4dd0c5e"), "100644", "cat-file.go"},
			objectMeta{SHA("2c225b962d6666011c69ca5c2c67204959f8ba32"), "100644", "cat-file_test.go"},
		},
		Trees: []objectMeta{
			objectMeta{SHA("d564d0bc3dd917926892c55e3706cc116d5b165e"), "040000", "examples"},
		},
	}
	result, err := NewObject(inputSha[:15], *RepoDir)
	if err != nil {
		t.Error(err)
		return
	}
	if !reflect.DeepEqual(expected, result) {
		t.Errorf("Expected and result don't match:\n\n%+v\n\n%+v", expected, result)
	}
}

func Test_ParsePrefixPackfile(t *testing.T) {
	// in the test directory, this is stored in a packfile
	const inputSHA SHA = "b45377f6daf59a4cec9e8de64f5df1533a7994cd"
	_, err := NewObject(inputSHA[:15], *RepoDir)
	if err != nil {
		t.Error(err)
	}
}

func Test_NakedDirectory(t *testing.T) {
	// Test that we can read a "naked" directory
	// (ie, without the .git extension)

	dirName := filepath.Clean(filepath.Join(RepoDir.Name(), ".."))
	dir, err := os.Open(dirName)
	if err != nil {
		t.Fatal(err)
	}
	const inputSHA SHA = "254671773e8cd91e07e36546c9a2d9c27e8dfeec"
	_, err = NewObject(inputSHA[:15], *dir)
	if err != nil {
		t.Error(err)
	}
}

func Test_Subdirectory(t *testing.T) {
	// Test that we can read a subdirectory of a git repo

	dirName := filepath.Clean(filepath.Join(RepoDir.Name(), "..", "subdir"))
	dir, err := os.Open(dirName)
	if err != nil {
		t.Fatal(err)
	}
	const inputSHA SHA = "254671773e8cd91e07e36546c9a2d9c27e8dfeec"
	_, err = NewObject(inputSHA[:15], *dir)
	if err != nil {
		t.Error(err)
	}
}

// BenchmarkCatFile benchmarks the entire CatFile operation,
// including opening the current directory and searching for the location
// of the closest parent git repository
func BenchmarkCatFile(b *testing.B) {
	const inputSha = SHA("af6e4fe91a8f9a0f3c03cbec9e1d2aac47345d67")
	for i := 0; i < b.N; i++ {
		_, _ = CatFile(inputSha) //, *RepoDir)
	}
}

// BenchmarkParseObject benchmarks the operation that reads a compressed object file
// and parses it into a blob GitObject. The benchmark includes the zlib inflate operation.
// It uses an object that is not stored within a packfile.
func BenchmarkParseObject(b *testing.B) {
	const inputSha = SHA("af6e4fe91a8f9a0f3c03cbec9e1d2aac47345d67")
	basedir, err := os.Open(filepath.Join("test_data", ".git"))
	if err != nil {
		b.Error(err)
	}
	defer basedir.Close()
	f, err := os.Open(filepath.Join("test_data", ".git", "objects", "af", "6e4fe91a8f9a0f3c03cbec9e1d2aac47345d67"))
	if err != nil {
		b.Error(err)
	}
	defer f.Close()

	for i := 0; i < b.N; i++ {
		f.Seek(0, io.SeekStart)
		r, err := zlib.NewReader(f)
		if err != nil {
			b.Fatalf("error on iteration %d: %s", i, err)
		}
		obj, err := parseObj(r, inputSha, *basedir)
		if err != nil {
			b.Fatalf("error on iteration %d: %s", i, err)
		}
		blb := obj.(Blob)
		if blb.size != "18" {
			b.Errorf("Expected size 18 and found size %d", blb.size)
		}
	}
}