aboutsummaryrefslogtreecommitdiffstats
path: root/repository/repo_testing.go
blob: 53375a5b6ecc4cf4061510c839cf98412796144e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
package repository

import (
	"log"
	"math/rand"
	"os"
	"strings"
	"testing"

	"github.com/stretchr/testify/require"

	"github.com/MichaelMure/git-bug/util/lamport"
)

func CleanupTestRepos(repos ...Repo) {
	var firstErr error
	for _, repo := range repos {
		path := repo.GetPath()
		if strings.HasSuffix(path, "/.git") {
			// for a normal repository (not --bare), we want to remove everything
			// including the parent directory where files are checked out
			path = strings.TrimSuffix(path, "/.git")

			// Testing non-bare repo should also check path is
			// only .git (i.e. ./.git), but doing so, we should
			// try to remove the current directory and hav some
			// trouble. In the present case, this case should not
			// occur.
			// TODO consider warning or error when path == ".git"
		}
		// fmt.Println("Cleaning repo:", path)
		err := os.RemoveAll(path)
		if err != nil {
			log.Println(err)
			if firstErr == nil {
				firstErr = err
			}
		}
	}

	if firstErr != nil {
		log.Fatal(firstErr)
	}
}

type RepoCreator func(bare bool) TestedRepo
type RepoCleaner func(repos ...Repo)

// Test suite for a Repo implementation
func RepoTest(t *testing.T, creator RepoCreator, cleaner RepoCleaner) {
	for bare, name := range map[bool]string{
		false: "Plain",
		true:  "Bare",
	} {
		t.Run(name, func(t *testing.T) {
			t.Run("Blob-Tree-Commit-Ref", func(t *testing.T) {
				repo := creator(bare)
				defer cleaner(repo)

				// Blob

				data := randomData()

				blobHash1, err := repo.StoreData(data)
				require.NoError(t, err)
				require.True(t, blobHash1.IsValid())

				blob1Read, err := repo.ReadData(blobHash1)
				require.NoError(t, err)
				require.Equal(t, data, blob1Read)

				// Tree

				blobHash2, err := repo.StoreData(randomData())
				require.NoError(t, err)
				blobHash3, err := repo.StoreData(randomData())
				require.NoError(t, err)

				tree1 := []TreeEntry{
					{
						ObjectType: Blob,
						Hash:       blobHash1,
						Name:       "blob1",
					},
					{
						ObjectType: Blob,
						Hash:       blobHash2,
						Name:       "blob2",
					},
				}

				treeHash1, err := repo.StoreTree(tree1)
				require.NoError(t, err)
				require.True(t, treeHash1.IsValid())

				tree1Read, err := repo.ReadTree(treeHash1)
				require.NoError(t, err)
				require.ElementsMatch(t, tree1, tree1Read)

				tree2 := []TreeEntry{
					{
						ObjectType: Tree,
						Hash:       treeHash1,
						Name:       "tree1",
					},
					{
						ObjectType: Blob,
						Hash:       blobHash3,
						Name:       "blob3",
					},
				}

				treeHash2, err := repo.StoreTree(tree2)
				require.NoError(t, err)
				require.True(t, treeHash2.IsValid())

				tree2Read, err := repo.ReadTree(treeHash2)
				require.NoError(t, err)
				require.ElementsMatch(t, tree2, tree2Read)

				// Commit

				commit1, err := repo.StoreCommit(treeHash1)
				require.NoError(t, err)
				require.True(t, commit1.IsValid())

				treeHash1Read, err := repo.GetTreeHash(commit1)
				require.NoError(t, err)
				require.Equal(t, treeHash1, treeHash1Read)

				commit2, err := repo.StoreCommitWithParent(treeHash2, commit1)
				require.NoError(t, err)
				require.True(t, commit2.IsValid())

				treeHash2Read, err := repo.GetTreeHash(commit2)
				require.NoError(t, err)
				require.Equal(t, treeHash2, treeHash2Read)

				// Ref

				exist1, err := repo.RefExist("refs/bugs/ref1")
				require.NoError(t, err)
				require.False(t, exist1)

				err = repo.UpdateRef("refs/bugs/ref1", commit2)
				require.NoError(t, err)

				exist1, err = repo.RefExist("refs/bugs/ref1")
				require.NoError(t, err)
				require.True(t, exist1)

				ls, err := repo.ListRefs("refs/bugs")
				require.NoError(t, err)
				require.ElementsMatch(t, []string{"refs/bugs/ref1"}, ls)

				err = repo.CopyRef("refs/bugs/ref1", "refs/bugs/ref2")
				require.NoError(t, err)

				ls, err = repo.ListRefs("refs/bugs")
				require.NoError(t, err)
				require.ElementsMatch(t, []string{"refs/bugs/ref1", "refs/bugs/ref2"}, ls)

				commits, err := repo.ListCommits("refs/bugs/ref2")
				require.NoError(t, err)
				require.ElementsMatch(t, []Hash{commit1, commit2}, commits)

				// Graph

				commit3, err := repo.StoreCommitWithParent(treeHash1, commit1)
				require.NoError(t, err)

				ancestorHash, err := repo.FindCommonAncestor(commit2, commit3)
				require.NoError(t, err)
				require.Equal(t, commit1, ancestorHash)

				err = repo.RemoveRef("refs/bugs/ref1")
				require.NoError(t, err)
			})

			t.Run("Local config", func(t *testing.T) {
				repo := creator(bare)
				defer cleaner(repo)

				testConfig(t, repo.LocalConfig())
			})

			t.Run("Clocks", func(t *testing.T) {
				repo := creator(bare)
				defer cleaner(repo)

				clock, err := repo.GetOrCreateClock("foo")
				require.NoError(t, err)
				require.Equal(t, lamport.Time(1), clock.Time())

				time, err := clock.Increment()
				require.NoError(t, err)
				require.Equal(t, lamport.Time(1), time)
				require.Equal(t, lamport.Time(2), clock.Time())

				clock2, err := repo.GetOrCreateClock("foo")
				require.NoError(t, err)
				require.Equal(t, lamport.Time(2), clock2.Time())

				clock3, err := repo.GetOrCreateClock("bar")
				require.NoError(t, err)
				require.Equal(t, lamport.Time(1), clock3.Time())
			})
		})
	}
}

func randomData() []byte {
	var letterRunes = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
	b := make([]byte, 32)
	for i := range b {
		b[i] = letterRunes[rand.Intn(len(letterRunes))]
	}
	return b
}