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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
|
// Copyright The gittuf Authors
// SPDX-License-Identifier: Apache-2.0
package gitinterface
import (
"fmt"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestGetReference(t *testing.T) {
tempDir := t.TempDir()
repo := CreateTestGitRepository(t, tempDir, false)
refName := "refs/heads/main"
treeBuilder := NewTreeBuilder(repo)
// Write empty tree
emptyTreeID, err := treeBuilder.WriteTreeFromEntries(nil)
if err != nil {
t.Fatal(err)
}
commitID, err := repo.Commit(emptyTreeID, refName, "Initial commit\n", false)
require.Nil(t, err)
refTip, err := repo.GetReference(refName)
assert.Nil(t, err)
assert.Equal(t, commitID, refTip)
}
func TestSetReference(t *testing.T) {
tempDir := t.TempDir()
repo := CreateTestGitRepository(t, tempDir, false)
refName := "refs/heads/main"
treeBuilder := NewTreeBuilder(repo)
// Write empty tree
emptyTreeID, err := treeBuilder.WriteTreeFromEntries(nil)
if err != nil {
t.Fatal(err)
}
firstCommitID, err := repo.Commit(emptyTreeID, refName, "Initial commit\n", false)
require.Nil(t, err)
// Create second commit with tree
secondCommitID, err := repo.Commit(emptyTreeID, refName, "Add README\n", false)
require.Nil(t, err)
refTip, err := repo.GetReference(refName)
require.Nil(t, err)
require.Equal(t, secondCommitID, refTip)
err = repo.SetReference(refName, firstCommitID)
assert.Nil(t, err)
refTip, err = repo.GetReference(refName)
require.Nil(t, err)
assert.Equal(t, firstCommitID, refTip)
}
func TestCheckAndSetReference(t *testing.T) {
tempDir := t.TempDir()
repo := CreateTestGitRepository(t, tempDir, false)
refName := "refs/heads/main"
treeBuilder := NewTreeBuilder(repo)
// Write empty tree
emptyTreeID, err := treeBuilder.WriteTreeFromEntries(nil)
if err != nil {
t.Fatal(err)
}
firstCommitID, err := repo.Commit(emptyTreeID, refName, "Initial commit\n", false)
require.Nil(t, err)
// Create second commit with tree
secondCommitID, err := repo.Commit(emptyTreeID, refName, "Add README\n", false)
require.Nil(t, err)
refTip, err := repo.GetReference(refName)
require.Nil(t, err)
require.Equal(t, secondCommitID, refTip)
err = repo.CheckAndSetReference(refName, firstCommitID, secondCommitID)
assert.Nil(t, err)
refTip, err = repo.GetReference(refName)
require.Nil(t, err)
assert.Equal(t, firstCommitID, refTip)
}
func TestGetSymbolicReferenceTarget(t *testing.T) {
tempDir := t.TempDir()
repo := CreateTestGitRepository(t, tempDir, false)
refName := "refs/heads/main"
treeBuilder := NewTreeBuilder(repo)
// Write empty tree
emptyTreeID, err := treeBuilder.WriteTreeFromEntries(nil)
if err != nil {
t.Fatal(err)
}
_, err = repo.Commit(emptyTreeID, refName, "Initial commit\n", false)
require.Nil(t, err)
// HEAD must be set to the main branch -> this is handled by git init
head, err := repo.GetSymbolicReferenceTarget("HEAD")
assert.Nil(t, err)
assert.Equal(t, refName, head)
}
func TestSetSymbolicReference(t *testing.T) {
tempDir := t.TempDir()
repo := CreateTestGitRepository(t, tempDir, false)
refName := "refs/heads/not-main" // we want to ensure it's set to something other than the default main
treeBuilder := NewTreeBuilder(repo)
// Write empty tree
emptyTreeID, err := treeBuilder.WriteTreeFromEntries(nil)
if err != nil {
t.Fatal(err)
}
_, err = repo.Commit(emptyTreeID, refName, "Initial commit\n", false)
require.Nil(t, err)
head, err := repo.GetSymbolicReferenceTarget("HEAD")
require.Nil(t, err)
assert.Equal(t, "refs/heads/main", head)
err = repo.SetSymbolicReference("HEAD", refName)
assert.Nil(t, err)
head, err = repo.GetSymbolicReferenceTarget("HEAD")
require.Nil(t, err)
assert.Equal(t, refName, head) // not main anymore
}
func TestRepositoryRefSpec(t *testing.T) {
tempDir := t.TempDir()
repo := CreateTestGitRepository(t, tempDir, false)
shortRefName := "master"
qualifiedRefName := "refs/heads/master"
qualifiedRemoteRefName := "refs/remotes/origin/master"
treeBuilder := NewTreeBuilder(repo)
emptyTreeHash, err := treeBuilder.WriteTreeFromEntries(nil)
if err != nil {
t.Fatal(err)
}
commitID, err := repo.Commit(emptyTreeHash, qualifiedRefName, "Test Commit", false)
if err != nil {
t.Fatal(err)
}
refHash, err := repo.GetReference(qualifiedRefName)
if err != nil {
t.Fatal(err)
}
assert.Equal(t, commitID, refHash, "unexpected value configuring test repo")
tests := map[string]struct {
repo *Repository
refName string
remoteName string
fastForwardOnly bool
expectedRefSpec string
expectedError error
}{
"standard branch, not fast forward only, no remote": {
refName: "refs/heads/main",
expectedRefSpec: "+refs/heads/main:refs/heads/main",
},
"standard branch, fast forward only, no remote": {
refName: "refs/heads/main",
fastForwardOnly: true,
expectedRefSpec: "refs/heads/main:refs/heads/main",
},
"standard branch, not fast forward only, remote": {
refName: "refs/heads/main",
remoteName: "origin",
expectedRefSpec: "+refs/heads/main:refs/remotes/origin/main",
},
"standard branch, fast forward only, remote": {
refName: "refs/heads/main",
remoteName: "origin",
fastForwardOnly: true,
expectedRefSpec: "refs/heads/main:refs/remotes/origin/main",
},
"non-standard branch, not fast forward only, no remote": {
refName: "refs/heads/foo/bar",
expectedRefSpec: "+refs/heads/foo/bar:refs/heads/foo/bar",
},
"non-standard branch, fast forward only, no remote": {
refName: "refs/heads/foo/bar",
fastForwardOnly: true,
expectedRefSpec: "refs/heads/foo/bar:refs/heads/foo/bar",
},
"non-standard branch, not fast forward only, remote": {
refName: "refs/heads/foo/bar",
remoteName: "origin",
expectedRefSpec: "+refs/heads/foo/bar:refs/remotes/origin/foo/bar",
},
"non-standard branch, fast forward only, remote": {
refName: "refs/heads/foo/bar",
remoteName: "origin",
fastForwardOnly: true,
expectedRefSpec: "refs/heads/foo/bar:refs/remotes/origin/foo/bar",
},
"short branch, not fast forward only, no remote": {
refName: shortRefName,
repo: repo,
expectedRefSpec: fmt.Sprintf("+%s:%s", qualifiedRefName, qualifiedRefName),
},
"short branch, fast forward only, no remote": {
refName: shortRefName,
repo: repo,
fastForwardOnly: true,
expectedRefSpec: fmt.Sprintf("%s:%s", qualifiedRefName, qualifiedRefName),
},
"short branch, not fast forward only, remote": {
refName: shortRefName,
repo: repo,
remoteName: "origin",
expectedRefSpec: fmt.Sprintf("+%s:%s", qualifiedRefName, qualifiedRemoteRefName),
},
"short branch, fast forward only, remote": {
refName: shortRefName,
repo: repo,
fastForwardOnly: true,
remoteName: "origin",
expectedRefSpec: fmt.Sprintf("%s:%s", qualifiedRefName, qualifiedRemoteRefName),
},
"custom namespace, not fast forward only, no remote": {
refName: "refs/foo/bar",
expectedRefSpec: "+refs/foo/bar:refs/foo/bar",
},
"custom namespace, fast forward only, no remote": {
refName: "refs/foo/bar",
fastForwardOnly: true,
expectedRefSpec: "refs/foo/bar:refs/foo/bar",
},
"custom namespace, not fast forward only, remote": {
refName: "refs/foo/bar",
remoteName: "origin",
expectedRefSpec: "+refs/foo/bar:refs/remotes/origin/foo/bar",
},
"custom namespace, fast forward only, remote": {
refName: "refs/foo/bar",
remoteName: "origin",
fastForwardOnly: true,
expectedRefSpec: "refs/foo/bar:refs/remotes/origin/foo/bar",
},
"tag, not fast forward only, no remote": {
refName: "refs/tags/v1.0.0",
fastForwardOnly: false,
expectedRefSpec: "refs/tags/v1.0.0:refs/tags/v1.0.0",
},
"tag, fast forward only, no remote": {
refName: "refs/tags/v1.0.0",
fastForwardOnly: true,
expectedRefSpec: "refs/tags/v1.0.0:refs/tags/v1.0.0",
},
"tag, not fast forward only, remote": {
refName: "refs/tags/v1.0.0",
remoteName: "origin",
fastForwardOnly: false,
expectedRefSpec: "refs/tags/v1.0.0:refs/tags/v1.0.0",
},
"tag, fast forward only, remote": {
refName: "refs/tags/v1.0.0",
remoteName: "origin",
fastForwardOnly: true,
expectedRefSpec: "refs/tags/v1.0.0:refs/tags/v1.0.0",
},
}
for name, test := range tests {
refSpec, err := test.repo.RefSpec(test.refName, test.remoteName, test.fastForwardOnly)
assert.ErrorIs(t, err, test.expectedError, fmt.Sprintf("unexpected error in test '%s'", name))
assert.Equal(t, test.expectedRefSpec, refSpec, fmt.Sprintf("unexpected refspec returned in test '%s'", name))
}
}
func TestBranchReferenceName(t *testing.T) {
tests := map[string]struct {
branchName string
expectedReferenceName string
}{
"short name": {
branchName: "main",
expectedReferenceName: "refs/heads/main",
},
"reference name": {
branchName: "refs/heads/main",
expectedReferenceName: "refs/heads/main",
},
}
for name, test := range tests {
referenceName := BranchReferenceName(test.branchName)
assert.Equal(t, test.expectedReferenceName, referenceName, fmt.Sprintf("unexpected branch reference received in test '%s'", name))
}
}
func TestTagReferenceName(t *testing.T) {
tests := map[string]struct {
tagName string
expectedReferenceName string
}{
"short name": {
tagName: "v1",
expectedReferenceName: "refs/tags/v1",
},
"reference name": {
tagName: "refs/tags/v1",
expectedReferenceName: "refs/tags/v1",
},
}
for name, test := range tests {
referenceName := TagReferenceName(test.tagName)
assert.Equal(t, test.expectedReferenceName, referenceName, fmt.Sprintf("unexpected tag reference received in test '%s'", name))
}
}
func TestDeleteReference(t *testing.T) {
tempDir := t.TempDir()
repo := CreateTestGitRepository(t, tempDir, false)
refName := "refs/heads/main"
treeBuilder := NewTreeBuilder(repo)
emptyTreeID, err := treeBuilder.WriteTreeFromEntries(nil)
if err != nil {
t.Fatal(err)
}
commitID, err := repo.Commit(emptyTreeID, refName, "Initial commit\n", false)
require.Nil(t, err)
refTip, err := repo.GetReference(refName)
require.Nil(t, err)
require.Equal(t, commitID, refTip)
err = repo.DeleteReference(refName)
assert.Nil(t, err)
_, err = repo.GetReference(refName)
assert.ErrorIs(t, err, ErrReferenceNotFound)
}
|
