Skip to content

Commit 989eea9

Browse files
abhishekkumar2718gitster
abhishekkumar2718
authored and
gitster
committed
lib-log-graph: consolidate test_cmp_graph logic
Log graph comparision logic is duplicated many times in: - t3430-rebase-merges.sh - t4202-log.sh - t4214-log-graph-octopus.sh - t4215-log-skewed-merges.sh Consolidate the core of the comparision and sanitization logic in lib-log-graph, and use it to replace the existing tests. While at it, lose the singular/plural transition magic from the sanitize_output helper, which was necessary around 7f81463 ("Use correct grammar in diffstat summary line", 2012-02-01), that has long outlived its usefulness. Signed-off-by: Abhishek Kumar <abhishekkumar8222@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent 51ebf55 commit 989eea9

File tree

5 files changed

+54
-77
lines changed

5 files changed

+54
-77
lines changed

‎t/lib-log-graph.sh‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Helps shared by the test scripts for comparing log graphs.
2+
3+
sanitize_log_output () {
4+
sed -e 's/ *$//' \
5+
-e 's/commit [0-9a-f]*$/commit COMMIT_OBJECT_NAME/' \
6+
-e 's/Merge: [ 0-9a-f]*$/Merge: MERGE_PARENTS/' \
7+
-e 's/Merge tag.*/Merge HEADS DESCRIPTION/' \
8+
-e 's/Merge commit.*/Merge HEADS DESCRIPTION/' \
9+
-e 's/index [0-9a-f]*\.\.[0-9a-f]*/index BEFORE..AFTER/'
10+
}
11+
12+
lib_test_cmp_graph () {
13+
git log --graph "$@" >output &&
14+
sed 's/ *$//' >output.sanitized <output &&
15+
test_i18ncmp expect output.sanitized
16+
}
17+
18+
lib_test_cmp_short_graph () {
19+
git log --graph --pretty=short "$@" >output &&
20+
sanitize_log_output >output.sanitized <output &&
21+
test_i18ncmp expect output.sanitized
22+
}

‎t/t3430-rebase-merges.sh‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,11 @@ Initial setup:
2020
'
2121
. ./test-lib.sh
2222
. "$TEST_DIRECTORY"/lib-rebase.sh
23+
. "$TEST_DIRECTORY"/lib-log-graph.sh
2324

2425
test_cmp_graph () {
2526
cat >expect &&
26-
git log --graph --boundary --format=%s "$@" >output &&
27-
sed "s/ *$//" <output >output.trimmed &&
28-
test_cmp expect output.trimmed
27+
lib_test_cmp_graph --boundary --format=%s "$@"
2928
}
3029

3130
test_expect_success 'setup' '

‎t/t4202-log.sh‎

Lines changed: 14 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ test_description='git log'
55
. ./test-lib.sh
66
. "$TEST_DIRECTORY/lib-gpg.sh"
77
. "$TEST_DIRECTORY/lib-terminal.sh"
8+
. "$TEST_DIRECTORY/lib-log-graph.sh"
9+
10+
test_cmp_graph () {
11+
lib_test_cmp_graph --format=%s "$@"
12+
}
813

914
test_expect_success setup '
1015
@@ -452,8 +457,7 @@ cat > expect <<EOF
452457
EOF
453458

454459
test_expect_success 'simple log --graph' '
455-
git log --graph --pretty=tformat:%s >actual &&
456-
test_cmp expect actual
460+
test_cmp_graph
457461
'
458462

459463
cat > expect <<EOF
@@ -467,8 +471,7 @@ cat > expect <<EOF
467471
EOF
468472

469473
test_expect_success 'simple log --graph --line-prefix="123 "' '
470-
git log --graph --line-prefix="123 " --pretty=tformat:%s >actual &&
471-
test_cmp expect actual
474+
test_cmp_graph --line-prefix="123 "
472475
'
473476

474477
test_expect_success 'set up merge history' '
@@ -495,9 +498,7 @@ cat > expect <<\EOF
495498
EOF
496499

497500
test_expect_success 'log --graph with merge' '
498-
git log --graph --date-order --pretty=tformat:%s |
499-
sed "s/ *\$//" >actual &&
500-
test_cmp expect actual
501+
test_cmp_graph --date-order
501502
'
502503

503504
cat > expect <<\EOF
@@ -516,9 +517,7 @@ cat > expect <<\EOF
516517
EOF
517518

518519
test_expect_success 'log --graph --line-prefix="| | | " with merge' '
519-
git log --line-prefix="| | | " --graph --date-order --pretty=tformat:%s |
520-
sed "s/ *\$//" >actual &&
521-
test_cmp expect actual
520+
test_cmp_graph --line-prefix="| | | " --date-order
522521
'
523522

524523
cat > expect.colors <<\EOF
@@ -676,9 +675,7 @@ cat > expect <<\EOF
676675
EOF
677676

678677
test_expect_success 'log --graph with merge' '
679-
git log --graph --date-order --pretty=tformat:%s |
680-
sed "s/ *\$//" >actual &&
681-
test_cmp expect actual
678+
test_cmp_graph --date-order
682679
'
683680

684681
test_expect_success 'log.decorate configuration' '
@@ -1213,24 +1210,8 @@ cat >expect <<\EOF
12131210
+one
12141211
EOF
12151212

1216-
sanitize_output () {
1217-
sed -e 's/ *$//' \
1218-
-e 's/commit [0-9a-f]*$/commit COMMIT_OBJECT_NAME/' \
1219-
-e 's/Merge: [ 0-9a-f]*$/Merge: MERGE_PARENTS/' \
1220-
-e 's/Merge tag.*/Merge HEADS DESCRIPTION/' \
1221-
-e 's/Merge commit.*/Merge HEADS DESCRIPTION/' \
1222-
-e 's/, 0 deletions(-)//' \
1223-
-e 's/, 0 insertions(+)//' \
1224-
-e 's/ 1 files changed, / 1 file changed, /' \
1225-
-e 's/, 1 deletions(-)/, 1 deletion(-)/' \
1226-
-e 's/, 1 insertions(+)/, 1 insertion(+)/' \
1227-
-e 's/index [0-9a-f]*\.\.[0-9a-f]*/index BEFORE..AFTER/'
1228-
}
1229-
12301213
test_expect_success 'log --graph with diff and stats' '
1231-
git log --no-renames --graph --pretty=short --stat -p >actual &&
1232-
sanitize_output >actual.sanitized <actual &&
1233-
test_i18ncmp expect actual.sanitized
1214+
lib_test_cmp_short_graph --no-renames --stat -p
12341215
'
12351216

12361217
cat >expect <<\EOF
@@ -1505,9 +1486,7 @@ cat >expect <<\EOF
15051486
EOF
15061487

15071488
test_expect_success 'log --line-prefix="*** " --graph with diff and stats' '
1508-
git log --line-prefix="*** " --no-renames --graph --pretty=short --stat -p >actual &&
1509-
sanitize_output >actual.sanitized <actual &&
1510-
test_i18ncmp expect actual.sanitized
1489+
lib_test_cmp_short_graph --line-prefix="*** " --no-renames --stat -p
15111490
'
15121491

15131492
cat >expect <<-\EOF
@@ -1529,9 +1508,7 @@ cat >expect <<-\EOF
15291508
EOF
15301509

15311510
test_expect_success 'log --graph with --name-status' '
1532-
git log --graph --format=%s --name-status tangle..reach >actual &&
1533-
sanitize_output <actual >actual.sanitized &&
1534-
test_cmp expect actual.sanitized
1511+
test_cmp_graph --name-status tangle..reach
15351512
'
15361513

15371514
cat >expect <<-\EOF
@@ -1553,9 +1530,7 @@ cat >expect <<-\EOF
15531530
EOF
15541531

15551532
test_expect_success 'log --graph with --name-only' '
1556-
git log --graph --format=%s --name-only tangle..reach >actual &&
1557-
sanitize_output <actual >actual.sanitized &&
1558-
test_cmp expect actual.sanitized
1533+
test_cmp_graph --name-only tangle..reach
15591534
'
15601535

15611536
test_expect_success 'dotdot is a parent directory' '

‎t/t4214-log-graph-octopus.sh‎

Lines changed: 14 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33
test_description='git log --graph of skewed left octopus merge.'
44

55
. ./test-lib.sh
6+
. "$TEST_DIRECTORY"/lib-log-graph.sh
7+
8+
test_cmp_graph () {
9+
cat >expect &&
10+
lib_test_cmp_graph --color=never --date-order --format=%s "$@"
11+
}
612

713
test_expect_success 'set up merge history' '
814
test_commit initial &&
@@ -24,7 +30,7 @@ test_expect_success 'set up merge history' '
2430
'
2531

2632
test_expect_success 'log --graph with tricky octopus merge, no color' '
27-
cat >expect.uncolored <<-\EOF &&
33+
test_cmp_graph left octopus-merge <<-\EOF
2834
* left
2935
| *-. octopus-merge
3036
|/|\ \
@@ -37,9 +43,6 @@ test_expect_success 'log --graph with tricky octopus merge, no color' '
3743
|/
3844
* initial
3945
EOF
40-
git log --color=never --graph --date-order --pretty=tformat:%s left octopus-merge >actual.raw &&
41-
sed "s/ *\$//" actual.raw >actual &&
42-
test_cmp expect.uncolored actual
4346
'
4447

4548
test_expect_success 'log --graph with tricky octopus merge with colors' '
@@ -66,7 +69,7 @@ test_expect_success 'log --graph with tricky octopus merge with colors' '
6669
# without the first parent skewing to the "left" branch column).
6770

6871
test_expect_success 'log --graph with normal octopus merge, no color' '
69-
cat >expect.uncolored <<-\EOF &&
72+
test_cmp_graph octopus-merge <<-\EOF
7073
*---. octopus-merge
7174
|\ \ \
7275
| | | * 4
@@ -78,9 +81,6 @@ test_expect_success 'log --graph with normal octopus merge, no color' '
7881
|/
7982
* initial
8083
EOF
81-
git log --color=never --graph --date-order --pretty=tformat:%s octopus-merge >actual.raw &&
82-
sed "s/ *\$//" actual.raw >actual &&
83-
test_cmp expect.uncolored actual
8484
'
8585

8686
test_expect_success 'log --graph with normal octopus merge with colors' '
@@ -103,7 +103,7 @@ test_expect_success 'log --graph with normal octopus merge with colors' '
103103
'
104104

105105
test_expect_success 'log --graph with normal octopus merge and child, no color' '
106-
cat >expect.uncolored <<-\EOF &&
106+
test_cmp_graph after-merge <<-\EOF
107107
* after-merge
108108
*---. octopus-merge
109109
|\ \ \
@@ -116,9 +116,6 @@ test_expect_success 'log --graph with normal octopus merge and child, no color'
116116
|/
117117
* initial
118118
EOF
119-
git log --color=never --graph --date-order --pretty=tformat:%s after-merge >actual.raw &&
120-
sed "s/ *\$//" actual.raw >actual &&
121-
test_cmp expect.uncolored actual
122119
'
123120

124121
test_expect_success 'log --graph with normal octopus and child merge with colors' '
@@ -142,7 +139,7 @@ test_expect_success 'log --graph with normal octopus and child merge with colors
142139
'
143140

144141
test_expect_success 'log --graph with tricky octopus merge and its child, no color' '
145-
cat >expect.uncolored <<-\EOF &&
142+
test_cmp_graph left after-merge <<-\EOF
146143
* left
147144
| * after-merge
148145
| *-. octopus-merge
@@ -156,9 +153,6 @@ test_expect_success 'log --graph with tricky octopus merge and its child, no col
156153
|/
157154
* initial
158155
EOF
159-
git log --color=never --graph --date-order --pretty=tformat:%s left after-merge >actual.raw &&
160-
sed "s/ *\$//" actual.raw >actual &&
161-
test_cmp expect.uncolored actual
162156
'
163157

164158
test_expect_success 'log --graph with tricky octopus merge and its child with colors' '
@@ -183,7 +177,7 @@ test_expect_success 'log --graph with tricky octopus merge and its child with co
183177
'
184178

185179
test_expect_success 'log --graph with crossover in octopus merge, no color' '
186-
cat >expect.uncolored <<-\EOF &&
180+
test_cmp_graph after-4 octopus-merge <<-\EOF
187181
* after-4
188182
| *---. octopus-merge
189183
| |\ \ \
@@ -200,9 +194,6 @@ test_expect_success 'log --graph with crossover in octopus merge, no color' '
200194
|/
201195
* initial
202196
EOF
203-
git log --color=never --graph --date-order --pretty=tformat:%s after-4 octopus-merge >actual.raw &&
204-
sed "s/ *\$//" actual.raw >actual &&
205-
test_cmp expect.uncolored actual
206197
'
207198

208199
test_expect_success 'log --graph with crossover in octopus merge with colors' '
@@ -230,7 +221,7 @@ test_expect_success 'log --graph with crossover in octopus merge with colors' '
230221
'
231222

232223
test_expect_success 'log --graph with crossover in octopus merge and its child, no color' '
233-
cat >expect.uncolored <<-\EOF &&
224+
test_cmp_graph after-4 after-merge <<-\EOF
234225
* after-4
235226
| * after-merge
236227
| *---. octopus-merge
@@ -248,9 +239,6 @@ test_expect_success 'log --graph with crossover in octopus merge and its child,
248239
|/
249240
* initial
250241
EOF
251-
git log --color=never --graph --date-order --pretty=tformat:%s after-4 after-merge >actual.raw &&
252-
sed "s/ *\$//" actual.raw >actual &&
253-
test_cmp expect.uncolored actual
254242
'
255243

256244
test_expect_success 'log --graph with crossover in octopus merge and its child with colors' '
@@ -279,7 +267,7 @@ test_expect_success 'log --graph with crossover in octopus merge and its child w
279267
'
280268

281269
test_expect_success 'log --graph with unrelated commit and octopus tip, no color' '
282-
cat >expect.uncolored <<-\EOF &&
270+
test_cmp_graph after-initial octopus-merge <<-\EOF
283271
* after-initial
284272
| *---. octopus-merge
285273
| |\ \ \
@@ -296,9 +284,6 @@ test_expect_success 'log --graph with unrelated commit and octopus tip, no color
296284
|/
297285
* initial
298286
EOF
299-
git log --color=never --graph --date-order --pretty=tformat:%s after-initial octopus-merge >actual.raw &&
300-
sed "s/ *\$//" actual.raw >actual &&
301-
test_cmp expect.uncolored actual
302287
'
303288

304289
test_expect_success 'log --graph with unrelated commit and octopus tip with colors' '
@@ -326,7 +311,7 @@ test_expect_success 'log --graph with unrelated commit and octopus tip with colo
326311
'
327312

328313
test_expect_success 'log --graph with unrelated commit and octopus child, no color' '
329-
cat >expect.uncolored <<-\EOF &&
314+
test_cmp_graph after-initial after-merge <<-\EOF
330315
* after-initial
331316
| * after-merge
332317
| *---. octopus-merge
@@ -344,9 +329,6 @@ test_expect_success 'log --graph with unrelated commit and octopus child, no col
344329
|/
345330
* initial
346331
EOF
347-
git log --color=never --graph --date-order --pretty=tformat:%s after-initial after-merge >actual.raw &&
348-
sed "s/ *\$//" actual.raw >actual &&
349-
test_cmp expect.uncolored actual
350332
'
351333

352334
test_expect_success 'log --graph with unrelated commit and octopus child with colors' '

‎t/t4215-log-skewed-merges.sh‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
test_description='git log --graph of skewed merges'
44

55
. ./test-lib.sh
6+
. "$TEST_DIRECTORY"/lib-log-graph.sh
67

78
check_graph () {
89
cat >expect &&
9-
git log --graph --pretty=tformat:%s "$@" >actual.raw &&
10-
sed "s/ *$//" actual.raw >actual &&
11-
test_cmp expect actual
10+
lib_test_cmp_graph --format=%s "$@"
1211
}
1312

1413
test_expect_success 'log --graph with merge fusing with its left and right neighbors' '

0 commit comments

Comments
 (0)