-
Notifications
You must be signed in to change notification settings - Fork 0
/
log_test.go
435 lines (359 loc) · 12.1 KB
/
log_test.go
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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
package git_test
import (
"bufio"
"os"
"strings"
"testing"
git "github.com/purpleclay/gitz"
"github.com/purpleclay/gitz/gittest"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestLog(t *testing.T) {
log := `fix: parsing error when input string is too long
ci: extend the existing build workflow to include integration tests
docs: create initial mkdocs material documentation
feat: add second operation to library
feat: add first operation to library`
gittest.InitRepository(t, gittest.WithLog(log))
client, _ := git.NewClient()
out, err := client.Log()
require.NoError(t, err)
lines := countLogLines(t, out.Raw)
require.Equal(t, 6, lines)
require.Equal(t, 6, len(out.Commits))
assert.Contains(t, out.Raw, "fix: parsing error when input string is too long")
assert.Equal(t, "fix: parsing error when input string is too long", out.Commits[0].Message)
assert.Contains(t, out.Raw, "ci: extend the existing build workflow to include integration tests")
assert.Equal(t, "ci: extend the existing build workflow to include integration tests", out.Commits[1].Message)
assert.Contains(t, out.Raw, "docs: create initial mkdocs material documentation")
assert.Equal(t, "docs: create initial mkdocs material documentation", out.Commits[2].Message)
assert.Contains(t, out.Raw, "feat: add second operation to library")
assert.Equal(t, "feat: add second operation to library", out.Commits[3].Message)
assert.Contains(t, out.Raw, "feat: add first operation to library")
assert.Equal(t, "feat: add first operation to library", out.Commits[4].Message)
assert.Contains(t, out.Raw, gittest.InitialCommit)
assert.Equal(t, gittest.InitialCommit, out.Commits[5].Message)
}
func TestLogMultiLineCommit(t *testing.T) {
log := `> feat: this is a commit that will
be spread
across multiple lines`
gittest.InitRepository(t, gittest.WithLog(log))
client, _ := git.NewClient()
out, err := client.Log()
require.NoError(t, err)
require.Len(t, out.Commits, 2)
assert.Equal(t, `feat: this is a commit that will
be spread
across multiple lines`, out.Commits[0].Message)
assert.Equal(t, gittest.InitialCommit, out.Commits[1].Message)
}
// A utility function that will scan the raw output from a git log and
// count all of the returned log lines. It is important to note, that
// in some scenarios the log will contain the [gittest.InitialCommit]
// used to initialize the repository
func countLogLines(t *testing.T, log string) int {
t.Helper()
scanner := bufio.NewScanner(strings.NewReader(log))
scanner.Split(bufio.ScanLines)
count := 0
for scanner.Scan() {
count++
}
return count
}
func TestLogValidateParsing(t *testing.T) {
gittest.InitRepository(t)
client, _ := git.NewClient()
out, err := client.Log()
require.NoError(t, err)
require.Len(t, out.Commits, 1)
assert.Equal(t, gittest.InitialCommit, out.Commits[0].Message)
lastCommit := gittest.LastCommit(t)
assert.Equal(t, lastCommit.Hash, out.Commits[0].Hash)
assert.Equal(t, lastCommit.AbbrevHash, out.Commits[0].AbbrevHash)
}
func TestLogError(t *testing.T) {
nonWorkingDirectory(t)
client, _ := git.NewClient()
_, err := client.Log()
require.Error(t, err)
}
func nonWorkingDirectory(t *testing.T) {
t.Helper()
current, err := os.Getwd()
require.NoError(t, err)
tmpDir := t.TempDir()
require.NoError(t, os.Chdir(tmpDir))
t.Cleanup(func() {
require.NoError(t, os.Chdir(current))
})
}
func TestLogWithRawOnly(t *testing.T) {
gittest.InitRepository(t)
client, _ := git.NewClient()
out, err := client.Log(git.WithRawOnly())
require.NoError(t, err)
assert.Empty(t, out.Commits)
}
func TestLogWithRef(t *testing.T) {
log := `(tag: 0.1.1) fix: unexpected bytes in message while parsing
(tag: 0.1.0) docs: create initial mkdocs material documentation
feat: build exciting new library`
gittest.InitRepository(t, gittest.WithLog(log))
client, _ := git.NewClient()
out, err := client.Log(git.WithRef("0.1.0"))
require.NoError(t, err)
lines := countLogLines(t, out.Raw)
require.Equal(t, 3, lines)
assert.Contains(t, out.Raw, "docs: create initial mkdocs material documentation")
assert.Contains(t, out.Raw, "feat: build exciting new library")
assert.Contains(t, out.Raw, gittest.InitialCommit)
}
func TestLogWithRefRange(t *testing.T) {
log := `(tag: 0.2.0) feat: add ability to filter on results
(tag: 0.1.1) fix: unexpected bytes in message while parsing
docs: update documentation to include fix
(tag: 0.1.0) docs: create initial mkdocs material documentation
feat: build exciting new library`
tests := []struct {
name string
fromRef string
toRef string
expectedLines int
expectedCommits []string
}{
{
name: "FromAndToRefsProvided",
fromRef: "0.1.1",
toRef: "0.1.0",
expectedLines: 2,
expectedCommits: []string{
"fix: unexpected bytes in message while parsing",
"docs: update documentation to include fix",
},
},
{
name: "FromRefOnly",
fromRef: "0.1.0",
expectedLines: 3,
expectedCommits: []string{
"docs: create initial mkdocs material documentation",
"feat: build exciting new library",
gittest.InitialCommit,
},
},
{
name: "ToRefOnly",
toRef: "0.1.1",
expectedLines: 1,
expectedCommits: []string{
"feat: add ability to filter on results",
},
},
{
name: "TrimsWhitespaceAroundRefs",
fromRef: " 0.2.0 ",
toRef: " 0.1.1 ",
expectedLines: 1,
expectedCommits: []string{
"feat: add ability to filter on results",
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
gittest.InitRepository(t, gittest.WithLog(log))
client, _ := git.NewClient()
out, err := client.Log(git.WithRefRange(tt.fromRef, tt.toRef))
require.NoError(t, err)
lines := countLogLines(t, out.Raw)
require.Equal(t, tt.expectedLines, lines)
for _, commit := range tt.expectedCommits {
require.Contains(t, out.Raw, commit)
}
})
}
}
func TestLogWithPaths(t *testing.T) {
gittest.InitRepository(t,
gittest.WithLocalCommits("this should not appear in the log"),
gittest.WithStagedFiles("dir1/a.txt", "dir2/b.txt"))
gittest.Commit(t, "feat: include both dir1/a.txt and dir2/b.txt")
overwriteFile(t, "dir1/a.txt", "Help, I have been overwritten!")
gittest.StageFile(t, "dir1/a.txt")
gittest.Commit(t, "fix: changed file dir1/a.txt")
client, _ := git.NewClient()
out, err := client.Log(git.WithPaths("dir1"))
require.NoError(t, err)
lines := countLogLines(t, out.Raw)
require.Equal(t, 2, lines)
assert.Contains(t, out.Raw, "fix: changed file dir1/a.txt")
assert.Contains(t, out.Raw, "feat: include both dir1/a.txt and dir2/b.txt")
}
func overwriteFile(t *testing.T, path, content string) {
t.Helper()
fi, err := os.Create(path)
require.NoError(t, err)
defer fi.Close()
fi.WriteString(content)
require.NoError(t, fi.Sync())
}
func TestLogWithSkip(t *testing.T) {
log := `feat: add options to support skipping of log entries
ci: improve github workflow
docs: update documentation to include new option`
tests := []struct {
name string
skipCount int
expectedLines int
expectedCommits []string
}{
{
name: "IsIgnored",
skipCount: 0,
expectedLines: 4,
expectedCommits: []string{
"feat: add options to support skipping of log entries",
"ci: improve github workflow",
"docs: update documentation to include new option",
gittest.InitialCommit,
},
},
{
name: "SkipFirstEntry",
skipCount: 1,
expectedLines: 3,
expectedCommits: []string{
"ci: improve github workflow",
"docs: update documentation to include new option",
gittest.InitialCommit,
},
},
{
name: "SkipExceedsLogLength",
skipCount: 10,
expectedLines: 0,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
gittest.InitRepository(t, gittest.WithLog(log))
client, _ := git.NewClient()
out, err := client.Log(git.WithSkip(tt.skipCount))
require.NoError(t, err)
lines := countLogLines(t, out.Raw)
require.Equal(t, tt.expectedLines, lines)
for _, commit := range tt.expectedCommits {
require.Contains(t, out.Raw, commit)
}
})
}
}
func TestLogWithTake(t *testing.T) {
log := `feat: add options to support taking n number of log entries
docs: update documentation to include new option`
tests := []struct {
name string
takeCount int
expectedLines int
expectedCommits []string
}{
{
name: "TakeZero",
takeCount: 0,
expectedLines: 0,
},
{
name: "TakeLatestEntry",
takeCount: 1,
expectedLines: 1,
expectedCommits: []string{
"feat: add options to support taking n number of log entries",
},
},
{
name: "TakeExceedsLogLength",
takeCount: 10,
expectedLines: 3,
expectedCommits: []string{
"feat: add options to support taking n number of log entries",
"docs: update documentation to include new option",
gittest.InitialCommit,
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
gittest.InitRepository(t, gittest.WithLog(log))
client, _ := git.NewClient()
out, err := client.Log(git.WithTake(tt.takeCount))
require.NoError(t, err)
lines := countLogLines(t, out.Raw)
require.Equal(t, tt.expectedLines, lines)
for _, commit := range tt.expectedCommits {
require.Contains(t, out.Raw, commit)
}
})
}
}
func TestLogWithSkipAndTake(t *testing.T) {
log := `feat: include options to filter logs between points in time and from a specific directory
feat: include option for generating an annotated tag
feat: add basic git push support
feat: detect if git is available when creating a new client
chore: simplify feature request issue
feat: add basic git log operation support
feat: add support for a basic file staging operation
feat: add basic support for git commit operations
chore(deps): bump dependabot/fetch-metadata from 1.3.5 to 1.3.6
feat: add basic support for git tag operations
chore: configure basic structure of project`
gittest.InitRepository(t, gittest.WithLog(log))
client, _ := git.NewClient()
out, err := client.Log(git.WithSkip(3), git.WithTake(2))
require.NoError(t, err)
lines := countLogLines(t, out.Raw)
require.Equal(t, 2, lines)
assert.Contains(t, out.Raw, "feat: detect if git is available when creating a new client")
assert.Contains(t, out.Raw, "chore: simplify feature request issue")
}
func TestWithGrep(t *testing.T) {
log := `feat: add option to match commits by regex
docs: document how to use new option for commit matching
chore(deps): bump dependabot/fetch-metadata from 1.3.5 to 1.3.6`
gittest.InitRepository(t, gittest.WithLog(log))
client, _ := git.NewClient()
out, err := client.Log(git.WithGrep("regex$", "option"))
require.NoError(t, err)
lines := countLogLines(t, out.Raw)
require.Equal(t, 2, lines)
assert.Contains(t, out.Raw, "feat: add option to match commits by regex")
assert.Contains(t, out.Raw, "docs: document how to use new option for commit matching")
}
func TestWithGrepAndMatchAll(t *testing.T) {
log := `feat: add option to match commits by regex
docs: document how to use new option for commit matching
chore(deps): bump dependabot/fetch-metadata from 1.3.5 to 1.3.6`
gittest.InitRepository(t, gittest.WithLog(log))
client, _ := git.NewClient()
out, err := client.Log(git.WithGrep("regex$", "option"), git.WithMatchAll())
require.NoError(t, err)
lines := countLogLines(t, out.Raw)
require.Equal(t, 1, lines)
assert.Contains(t, out.Raw, "feat: add option to match commits by regex")
}
func TestWithInvertGrep(t *testing.T) {
log := `feat: add option to match commits by regex
docs: document how to use new option for commit matching
chore(deps): bump dependabot/fetch-metadata from 1.3.5 to 1.3.6`
gittest.InitRepository(t, gittest.WithLog(log))
client, _ := git.NewClient()
out, err := client.Log(git.WithInvertGrep("regex$", "option"))
require.NoError(t, err)
lines := countLogLines(t, out.Raw)
require.Equal(t, 2, lines)
assert.Contains(t, out.Raw, "chore(deps): bump dependabot/fetch-metadata from 1.3.5 to 1.3.6")
assert.Contains(t, out.Raw, gittest.InitialCommit)
}