diff mbox series

t6016: move to lib-log-graph.sh framework

Message ID 6dc37f6b-1afd-544d-126e-2be9422571c6@aerusso.net (mailing list archive)
State Superseded
Commit c8302c6c0027fb8714106b9365f3443a2d233f44
Headers show
Series t6016: move to lib-log-graph.sh framework | expand

Commit Message

Antonio Russo Jan. 4, 2021, 2:30 a.m. UTC
t6016 manually reconstructs git log --graph output by using the reported
commit hashes from `git rev-parse`.  Each tag is converted into an
environment variable manually, and then `echo`-ed to an expected output
file, which is in turn compared to the actual output.

The expected output is difficult to read and write, because, e.g.,
each line of output must be prefaced with echo, quoted, and properly
escaped.  Additionally, the test is sensitive to trailing whitespace,
which may potentially be removed from graph log output in the future.

In order to reduce duplication, ease troubleshooting of failed tests by
improving readability, and ease the addition of more tests to this file,
port the operations to `lib-log-graph.sh`, which is already used in
several other tests, e.g., t4215.  Give all merges a simple commit
message, and use a common `check_graph` macro taking a heredoc of the
expected output which does not required extensive escaping.

Signed-off-by: Antonio Russo <aerusso@aerusso.net>
---
 t/t6016-rev-list-graph-simplify-history.sh | 354 ++++++++++-----------
 1 file changed, 167 insertions(+), 187 deletions(-)

This patch builds, and passes the test suite on travis-ci:

https://travis-ci.org/github/aerusso/git/builds/752694578

Comments

Abhishek Kumar Jan. 4, 2021, 6:26 a.m. UTC | #1
On Sun, Jan 03, 2021 at 07:30:35PM -0700, Antonio Russo wrote:
> t6016 manually reconstructs git log --graph output by using the reported
> commit hashes from `git rev-parse`.  Each tag is converted into an
> environment variable manually, and then `echo`-ed to an expected output
> file, which is in turn compared to the actual output.
> 
> The expected output is difficult to read and write, because, e.g.,
> each line of output must be prefaced with echo, quoted, and properly
> escaped.  Additionally, the test is sensitive to trailing whitespace,
> which may potentially be removed from graph log output in the future.
> 
> In order to reduce duplication, ease troubleshooting of failed tests by
> improving readability, and ease the addition of more tests to this file,
> port the operations to `lib-log-graph.sh`, which is already used in
> several other tests, e.g., t4215.  Give all merges a simple commit
> message, and use a common `check_graph` macro taking a heredoc of the
> expected output which does not required extensive escaping.
> 

Glad to see others using `lib-log-graph.sh` as well!

The changes look alright to me but maybe you could have split the two
changes into two different commits: Using tags directly instead of
environment variables and using `check_graph` instead of manually
`echo`-ing to an expected output and comparing with the actual output.

Other contributors would have a better idea whether it's truly required
or not.

> Signed-off-by: Antonio Russo <aerusso@aerusso.net>
> ---
>  t/t6016-rev-list-graph-simplify-history.sh | 354 ++++++++++-----------
>  1 file changed, 167 insertions(+), 187 deletions(-)
> 
> This patch builds, and passes the test suite on travis-ci:
> 
> https://travis-ci.org/github/aerusso/git/builds/752694578
> 
> diff --git a/t/t6016-rev-list-graph-simplify-history.sh b/t/t6016-rev-list-graph-simplify-history.sh
> index f5e6e92f5b..f79df8b6d1 100755
> --- a/t/t6016-rev-list-graph-simplify-history.sh
> +++ b/t/t6016-rev-list-graph-simplify-history.sh
> @@ -8,6 +8,12 @@
>  test_description='--graph and simplified history'
>  
>  . ./test-lib.sh
> +. "$TEST_DIRECTORY"/lib-log-graph.sh
> +
> +check_graph () {
> +	cat >expect &&
> +	lib_test_cmp_graph --format=%s "$@"
> +}
>  
>  test_expect_success 'set up rev-list --graph test' '
>  	# 3 commits on branch A
> @@ -28,7 +34,7 @@ test_expect_success 'set up rev-list --graph test' '
>  
>  	# Octopus merge B and C into branch A
>  	git checkout A &&
> -	git merge B C &&
> +	git merge B C -m A4 &&
>  	git tag A4 &&
>  
>  	test_commit A5 bar.txt &&
> @@ -38,81 +44,64 @@ test_expect_success 'set up rev-list --graph test' '
>  	test_commit C3 foo.txt &&
>  	test_commit C4 bar.txt &&
>  	git checkout A &&
> -	git merge -s ours C &&
> +	git merge -s ours C -m A6 &&
>  	git tag A6 &&
>  
> -	test_commit A7 bar.txt &&
> -
> -	# Store commit names in variables for later use
> -	A1=$(git rev-parse --verify A1) &&
> -	A2=$(git rev-parse --verify A2) &&
> -	A3=$(git rev-parse --verify A3) &&
> -	A4=$(git rev-parse --verify A4) &&
> -	A5=$(git rev-parse --verify A5) &&
> -	A6=$(git rev-parse --verify A6) &&
> -	A7=$(git rev-parse --verify A7) &&
> -	B1=$(git rev-parse --verify B1) &&
> -	B2=$(git rev-parse --verify B2) &&
> -	C1=$(git rev-parse --verify C1) &&
> -	C2=$(git rev-parse --verify C2) &&
> -	C3=$(git rev-parse --verify C3) &&
> -	C4=$(git rev-parse --verify C4)
> -	'
> +	test_commit A7 bar.txt
> +'
>  
>  test_expect_success '--graph --all' '
> -	rm -f expected &&
> -	echo "* $A7" >> expected &&
> -	echo "*   $A6" >> expected &&
> -	echo "|\\  " >> expected &&
> -	echo "| * $C4" >> expected &&
> -	echo "| * $C3" >> expected &&
> -	echo "* | $A5" >> expected &&
> -	echo "| |   " >> expected &&
> -	echo "|  \\  " >> expected &&
> -	echo "*-. | $A4" >> expected &&
> -	echo "|\\ \\| " >> expected &&
> -	echo "| | * $C2" >> expected &&
> -	echo "| | * $C1" >> expected &&
> -	echo "| * | $B2" >> expected &&
> -	echo "| * | $B1" >> expected &&
> -	echo "* | | $A3" >> expected &&
> -	echo "| |/  " >> expected &&
> -	echo "|/|   " >> expected &&
> -	echo "* | $A2" >> expected &&
> -	echo "|/  " >> expected &&
> -	echo "* $A1" >> expected &&
> -	git rev-list --graph --all > actual &&
> -	test_cmp expected actual
> -	'
> +	check_graph --all <<-\EOF
> +	* A7
> +	*   A6
> +	|\
> +	| * C4
> +	| * C3
> +	* | A5
> +	| |
> +	|  \
> +	*-. | A4
> +	|\ \|
> +	| | * C2
> +	| | * C1
> +	| * | B2
> +	| * | B1
> +	* | | A3
> +	| |/
> +	|/|
> +	* | A2
> +	|/
> +	* A1
> +	EOF
> +'
>  
>  # Make sure the graph_is_interesting() code still realizes
>  # that undecorated merges are interesting, even with --simplify-by-decoration
>  test_expect_success '--graph --simplify-by-decoration' '
> -	rm -f expected &&
>  	git tag -d A4 &&
> -	echo "* $A7" >> expected &&
> -	echo "*   $A6" >> expected &&
> -	echo "|\\  " >> expected &&
> -	echo "| * $C4" >> expected &&
> -	echo "| * $C3" >> expected &&
> -	echo "* | $A5" >> expected &&
> -	echo "| |   " >> expected &&
> -	echo "|  \\  " >> expected &&
> -	echo "*-. | $A4" >> expected &&
> -	echo "|\\ \\| " >> expected &&
> -	echo "| | * $C2" >> expected &&
> -	echo "| | * $C1" >> expected &&
> -	echo "| * | $B2" >> expected &&
> -	echo "| * | $B1" >> expected &&
> -	echo "* | | $A3" >> expected &&
> -	echo "| |/  " >> expected &&
> -	echo "|/|   " >> expected &&
> -	echo "* | $A2" >> expected &&
> -	echo "|/  " >> expected &&
> -	echo "* $A1" >> expected &&
> -	git rev-list --graph --all --simplify-by-decoration > actual &&
> -	test_cmp expected actual
> -	'
> +	check_graph --all --simplify-by-decoration <<-\EOF
> +	* A7
> +	*   A6
> +	|\
> +	| * C4
> +	| * C3
> +	* | A5
> +	| |
> +	|  \
> +	*-. | A4
> +	|\ \|
> +	| | * C2
> +	| | * C1
> +	| * | B2
> +	| * | B1
> +	* | | A3
> +	| |/
> +	|/|
> +	* | A2
> +	|/
> +	* A1
> +	EOF
> +'
>  
>  test_expect_success 'setup: get rid of decorations on B' '
>  	git tag -d B2 &&
> @@ -122,142 +111,133 @@ test_expect_success 'setup: get rid of decorations on B' '
>  
>  # Graph with branch B simplified away
>  test_expect_success '--graph --simplify-by-decoration prune branch B' '
> -	rm -f expected &&
> -	echo "* $A7" >> expected &&
> -	echo "*   $A6" >> expected &&
> -	echo "|\\  " >> expected &&
> -	echo "| * $C4" >> expected &&
> -	echo "| * $C3" >> expected &&
> -	echo "* | $A5" >> expected &&
> -	echo "* | $A4" >> expected &&
> -	echo "|\\| " >> expected &&
> -	echo "| * $C2" >> expected &&
> -	echo "| * $C1" >> expected &&
> -	echo "* | $A3" >> expected &&
> -	echo "|/  " >> expected &&
> -	echo "* $A2" >> expected &&
> -	echo "* $A1" >> expected &&
> -	git rev-list --graph --simplify-by-decoration --all > actual &&
> -	test_cmp expected actual
> -	'
> +	check_graph --simplify-by-decoration --all <<-\EOF
> +	* A7
> +	*   A6
> +	|\
> +	| * C4
> +	| * C3
> +	* | A5
> +	* | A4
> +	|\|
> +	| * C2
> +	| * C1
> +	* | A3
> +	|/
> +	* A2
> +	* A1
> +	EOF
> +'
>  
>  test_expect_success '--graph --full-history -- bar.txt' '
> -	rm -f expected &&
> -	echo "* $A7" >> expected &&
> -	echo "*   $A6" >> expected &&
> -	echo "|\\  " >> expected &&
> -	echo "| * $C4" >> expected &&
> -	echo "* | $A5" >> expected &&
> -	echo "* | $A4" >> expected &&
> -	echo "|\\| " >> expected &&
> -	echo "* | $A3" >> expected &&
> -	echo "|/  " >> expected &&
> -	echo "* $A2" >> expected &&
> -	git rev-list --graph --full-history --all -- bar.txt > actual &&
> -	test_cmp expected actual
> -	'
> +	check_graph --full-history --all -- bar.txt <<-\EOF
> +	* A7
> +	*   A6
> +	|\
> +	| * C4
> +	* | A5
> +	* | A4
> +	|\|
> +	* | A3
> +	|/
> +	* A2
> +	EOF
> +'
>  
>  test_expect_success '--graph --full-history --simplify-merges -- bar.txt' '
> -	rm -f expected &&
> -	echo "* $A7" >> expected &&
> -	echo "*   $A6" >> expected &&
> -	echo "|\\  " >> expected &&
> -	echo "| * $C4" >> expected &&
> -	echo "* | $A5" >> expected &&
> -	echo "* | $A3" >> expected &&
> -	echo "|/  " >> expected &&
> -	echo "* $A2" >> expected &&
> -	git rev-list --graph --full-history --simplify-merges --all \
> -		-- bar.txt > actual &&
> -	test_cmp expected actual
> -	'
> +	check_graph --full-history --simplify-merges --all -- bar.txt <<-\EOF
> +	* A7
> +	*   A6
> +	|\
> +	| * C4
> +	* | A5
> +	* | A3
> +	|/
> +	* A2
> +	EOF
> +'
>  
>  test_expect_success '--graph -- bar.txt' '
> -	rm -f expected &&
> -	echo "* $A7" >> expected &&
> -	echo "* $A5" >> expected &&
> -	echo "* $A3" >> expected &&
> -	echo "| * $C4" >> expected &&
> -	echo "|/  " >> expected &&
> -	echo "* $A2" >> expected &&
> -	git rev-list --graph --all -- bar.txt > actual &&
> -	test_cmp expected actual
> -	'
> +	check_graph --all -- bar.txt <<-\EOF
> +	* A7
> +	* A5
> +	* A3
> +	| * C4
> +	|/
> +	* A2
> +	EOF
> +'
>  
>  test_expect_success '--graph --sparse -- bar.txt' '
> -	rm -f expected &&
> -	echo "* $A7" >> expected &&
> -	echo "* $A6" >> expected &&
> -	echo "* $A5" >> expected &&
> -	echo "* $A4" >> expected &&
> -	echo "* $A3" >> expected &&
> -	echo "| * $C4" >> expected &&
> -	echo "| * $C3" >> expected &&
> -	echo "| * $C2" >> expected &&
> -	echo "| * $C1" >> expected &&
> -	echo "|/  " >> expected &&
> -	echo "* $A2" >> expected &&
> -	echo "* $A1" >> expected &&
> -	git rev-list --graph --sparse --all -- bar.txt > actual &&
> -	test_cmp expected actual
> -	'
> +	check_graph --sparse --all -- bar.txt <<-\EOF
> +	* A7
> +	* A6
> +	* A5
> +	* A4
> +	* A3
> +	| * C4
> +	| * C3
> +	| * C2
> +	| * C1
> +	|/
> +	* A2
> +	* A1
> +	EOF
> +'
>  
>  test_expect_success '--graph ^C4' '
> -	rm -f expected &&
> -	echo "* $A7" >> expected &&
> -	echo "* $A6" >> expected &&
> -	echo "* $A5" >> expected &&
> -	echo "*   $A4" >> expected &&
> -	echo "|\\  " >> expected &&
> -	echo "| * $B2" >> expected &&
> -	echo "| * $B1" >> expected &&
> -	echo "* $A3" >> expected &&
> -	git rev-list --graph --all ^C4 > actual &&
> -	test_cmp expected actual
> -	'
> +	check_graph --all ^C4 <<-\EOF
> +	* A7
> +	* A6
> +	* A5
> +	*   A4
> +	|\
> +	| * B2
> +	| * B1
> +	* A3
> +	EOF
> +'
>  
>  test_expect_success '--graph ^C3' '
> -	rm -f expected &&
> -	echo "* $A7" >> expected &&
> -	echo "*   $A6" >> expected &&
> -	echo "|\\  " >> expected &&
> -	echo "| * $C4" >> expected &&
> -	echo "* $A5" >> expected &&
> -	echo "*   $A4" >> expected &&
> -	echo "|\\  " >> expected &&
> -	echo "| * $B2" >> expected &&
> -	echo "| * $B1" >> expected &&
> -	echo "* $A3" >> expected &&
> -	git rev-list --graph --all ^C3 > actual &&
> -	test_cmp expected actual
> -	'
> +	check_graph --all ^C3 <<-\EOF
> +	* A7
> +	*   A6
> +	|\
> +	| * C4
> +	* A5
> +	*   A4
> +	|\
> +	| * B2
> +	| * B1
> +	* A3
> +	EOF
> +'
>  
>  # I don't think the ordering of the boundary commits is really
>  # that important, but this test depends on it.  If the ordering ever changes
>  # in the code, we'll need to update this test.
>  test_expect_success '--graph --boundary ^C3' '
> -	rm -f expected &&
> -	echo "* $A7" >> expected &&
> -	echo "*   $A6" >> expected &&
> -	echo "|\\  " >> expected &&
> -	echo "| * $C4" >> expected &&
> -	echo "* | $A5" >> expected &&
> -	echo "| |     " >> expected &&
> -	echo "|  \\    " >> expected &&
> -	echo "*-. \\   $A4" >> expected &&
> -	echo "|\\ \\ \\  " >> expected &&
> -	echo "| * | | $B2" >> expected &&
> -	echo "| * | | $B1" >> expected &&
> -	echo "* | | | $A3" >> expected &&
> -	echo "o | | | $A2" >> expected &&
> -	echo "|/ / /  " >> expected &&
> -	echo "o / / $A1" >> expected &&
> -	echo " / /  " >> expected &&
> -	echo "| o $C3" >> expected &&
> -	echo "|/  " >> expected &&
> -	echo "o $C2" >> expected &&
> -	git rev-list --graph --boundary --all ^C3 > actual &&
> -	test_cmp expected actual
> -	'
> +	check_graph --boundary --all ^C3 <<-\EOF
> +	* A7
> +	*   A6
> +	|\
> +	| * C4
> +	* | A5
> +	| |
> +	|  \
> +	*-. \   A4
> +	|\ \ \
> +	| * | | B2
> +	| * | | B1
> +	* | | | A3
> +	o | | | A2
> +	|/ / /
> +	o / / A1
> +	 / /
> +	| o C3
> +	|/
> +	o C2
> +	EOF
> +'
>  
>  test_done
> -- 
> 2.30.0

Thanks
- Abhishek
Antonio Russo Jan. 5, 2021, 12:59 a.m. UTC | #2
On 1/3/21 11:26 PM, Abhishek Kumar wrote:
> 
> Glad to see others using `lib-log-graph.sh` as well!
> 
> The changes look alright to me but maybe you could have split the two
> changes into two different commits: Using tags directly instead of
> environment variables and using `check_graph` instead of manually
> `echo`-ing to an expected output and comparing with the actual output.
> 
> Other contributors would have a better idea whether it's truly required
> or not.
> 

Thanks for the feedback!  I can split this patch in two if that's desired.

[snip]

> 
> Thanks
> - Abhishek
> 

Best,
Antonio
Junio C Hamano Jan. 6, 2021, 5:05 a.m. UTC | #3
Abhishek Kumar <abhishekkumar8222@gmail.com> writes:

> On Sun, Jan 03, 2021 at 07:30:35PM -0700, Antonio Russo wrote:
>> t6016 manually reconstructs git log --graph output by using the reported
>> commit hashes from `git rev-parse`.  Each tag is converted into an
>> environment variable manually, and then `echo`-ed to an expected output
>> file, which is in turn compared to the actual output.
>> 
>> The expected output is difficult to read and write, because, e.g.,
>> each line of output must be prefaced with echo, quoted, and properly
>> escaped.  Additionally, the test is sensitive to trailing whitespace,
>> which may potentially be removed from graph log output in the future.
>> 
>> In order to reduce duplication, ease troubleshooting of failed tests by
>> improving readability, and ease the addition of more tests to this file,
>> port the operations to `lib-log-graph.sh`, which is already used in
>> several other tests, e.g., t4215.  Give all merges a simple commit
>> message, and use a common `check_graph` macro taking a heredoc of the
>> expected output which does not required extensive escaping.
>> 
>
> Glad to see others using `lib-log-graph.sh` as well!
>
> The changes look alright to me but maybe you could have split the two
> changes into two different commits: Using tags directly instead of
> environment variables and using `check_graph` instead of manually
> `echo`-ing to an expected output and comparing with the actual output.

Perhaps.  Also I am wondering if the tests still need to create tags
after this change---isn't the output all matched by the commit title
now?

That is ...

>>  . ./test-lib.sh
>> +. "$TEST_DIRECTORY"/lib-log-graph.sh
>> +
>> +check_graph () {
>> +	cat >expect &&
>> +	lib_test_cmp_graph --format=%s "$@"
>> +}

... this only shows the title, and ...

>> -	git merge B C &&
>> +	git merge B C -m A4 &&

... that is why we need to have the title here.

>>  	git tag A4 &&

Now, does this A4 used anywhere?

>> -	# Store commit names in variables for later use
>> -	A1=$(git rev-parse --verify A1) &&
>> -	A2=$(git rev-parse --verify A2) &&
>> -	A3=$(git rev-parse --verify A3) &&
>> -	A4=$(git rev-parse --verify A4) &&

It certainly used to be needed here, but ...
>> +	check_graph --all <<-\EOF
>> +	* A7
>> +	*   A6
>> +	|\
>> +	| * C4
>> +	| * C3
>> +	* | A5
>> +	| |
>> +	|  \
>> +	*-. | A4

... not anymore in the new version.

>> +	|\ \|
>> +	| | * C2
>> +	| | * C1
>> +	| * | B2
>> +	| * | B1
>> +	* | | A3
>> +	| |/
>> +	|/|
>> +	* | A2
>> +	|/
>> +	* A1
>> +	EOF
>> +'
>>
Antonio Russo Jan. 6, 2021, 3:21 p.m. UTC | #4
On 1/5/21 10:05 PM, Junio C Hamano wrote:
> Abhishek Kumar <abhishekkumar8222@gmail.com> writes:
> 
>> On Sun, Jan 03, 2021 at 07:30:35PM -0700, Antonio Russo wrote:
>>> t6016 manually reconstructs git log --graph output by using the reported
>>> commit hashes from `git rev-parse`.  Each tag is converted into an
>>> environment variable manually, and then `echo`-ed to an expected output
>>> file, which is in turn compared to the actual output.
>>>
>>> The expected output is difficult to read and write, because, e.g.,
>>> each line of output must be prefaced with echo, quoted, and properly
>>> escaped.  Additionally, the test is sensitive to trailing whitespace,
>>> which may potentially be removed from graph log output in the future.
>>>
>>> In order to reduce duplication, ease troubleshooting of failed tests by
>>> improving readability, and ease the addition of more tests to this file,
>>> port the operations to `lib-log-graph.sh`, which is already used in
>>> several other tests, e.g., t4215.  Give all merges a simple commit
>>> message, and use a common `check_graph` macro taking a heredoc of the
>>> expected output which does not required extensive escaping.
>>>
>>
>> Glad to see others using `lib-log-graph.sh` as well!
>>
>> The changes look alright to me but maybe you could have split the two
>> changes into two different commits: Using tags directly instead of
>> environment variables and using `check_graph` instead of manually
>> `echo`-ing to an expected output and comparing with the actual output.
> 
> Perhaps.  Also I am wondering if the tests still need to create tags
> after this change---isn't the output all matched by the commit title
> now?

You are correct that the A4 and A6 tags can be removed without affecting
the output.  In fact, A4 is basically immediately deleted (in the second test).
I can remove that, if we want to stop testing the tag deletion logic here.
I suppose that is sufficiently validated elsewhere in the test suite.

There's a (weak IMO) argument to keep the A6 tag, since it might in principle
affect the output at later stages, since it is not deleted and calls are made
with --simplify-by-decoration.  Of course, it isn't needed in order to be
displayed, so we're only testing that that the merge commit A6 shows up when
it *has* a tag, and --simplify-by-decoration is used.  That failure mode
certainly seems perverse!

My guiding principle when I made this patch was to be as minimally invasive
as possible, while allowing modifications to this file to be pleasant---which
I must admit is my ulterior motive.

I can certainly remove these "extraneous" tags if desired.

Best,
Antonio


> That is ...
> 
>>>  . ./test-lib.sh
>>> +. "$TEST_DIRECTORY"/lib-log-graph.sh
>>> +
>>> +check_graph () {
>>> +	cat >expect &&
>>> +	lib_test_cmp_graph --format=%s "$@"
>>> +}
> 
> ... this only shows the title, and ...
> 
>>> -	git merge B C &&
>>> +	git merge B C -m A4 &&
> 
> ... that is why we need to have the title here.
> 
>>>  	git tag A4 &&
> 
> Now, does this A4 used anywhere?
> 
>>> -	# Store commit names in variables for later use
>>> -	A1=$(git rev-parse --verify A1) &&
>>> -	A2=$(git rev-parse --verify A2) &&
>>> -	A3=$(git rev-parse --verify A3) &&
>>> -	A4=$(git rev-parse --verify A4) &&
> 
> It certainly used to be needed here, but ...
>>> +	check_graph --all <<-\EOF
>>> +	* A7
>>> +	*   A6
>>> +	|\
>>> +	| * C4
>>> +	| * C3
>>> +	* | A5
>>> +	| |
>>> +	|  \
>>> +	*-. | A4
> 
> ... not anymore in the new version.
> 
>>> +	|\ \|
>>> +	| | * C2
>>> +	| | * C1
>>> +	| * | B2
>>> +	| * | B1
>>> +	* | | A3
>>> +	| |/
>>> +	|/|
>>> +	* | A2
>>> +	|/
>>> +	* A1
>>> +	EOF
>>> +'
>>>
Junio C Hamano Jan. 6, 2021, 8:55 p.m. UTC | #5
Antonio Russo <aerusso@aerusso.net> writes:

> You are correct that the A4 and A6 tags can be removed without affecting
> the output.  In fact, A4 is basically immediately deleted (in the second test).
> I can remove that, if we want to stop testing the tag deletion logic here.
> I suppose that is sufficiently validated elsewhere in the test suite.
>
> There's a (weak IMO) argument to keep the A6 tag, since ...

I see.  Thanks for explaining.

> My guiding principle when I made this patch was to be as minimally invasive
> as possible, while allowing modifications to this file to be pleasant---which
> I must admit is my ulterior motive.
>
> I can certainly remove these "extraneous" tags if desired.

I actually am _for_ keeping these tags.  It is just that I want to
see the reason why these tags, some of which are no longer needed
for the purpose of matching the output with expectation, are kept
explained in the proposed log message.

Thanks.
diff mbox series

Patch

diff --git a/t/t6016-rev-list-graph-simplify-history.sh b/t/t6016-rev-list-graph-simplify-history.sh
index f5e6e92f5b..f79df8b6d1 100755
--- a/t/t6016-rev-list-graph-simplify-history.sh
+++ b/t/t6016-rev-list-graph-simplify-history.sh
@@ -8,6 +8,12 @@ 
 test_description='--graph and simplified history'
 
 . ./test-lib.sh
+. "$TEST_DIRECTORY"/lib-log-graph.sh
+
+check_graph () {
+	cat >expect &&
+	lib_test_cmp_graph --format=%s "$@"
+}
 
 test_expect_success 'set up rev-list --graph test' '
 	# 3 commits on branch A
@@ -28,7 +34,7 @@  test_expect_success 'set up rev-list --graph test' '
 
 	# Octopus merge B and C into branch A
 	git checkout A &&
-	git merge B C &&
+	git merge B C -m A4 &&
 	git tag A4 &&
 
 	test_commit A5 bar.txt &&
@@ -38,81 +44,64 @@  test_expect_success 'set up rev-list --graph test' '
 	test_commit C3 foo.txt &&
 	test_commit C4 bar.txt &&
 	git checkout A &&
-	git merge -s ours C &&
+	git merge -s ours C -m A6 &&
 	git tag A6 &&
 
-	test_commit A7 bar.txt &&
-
-	# Store commit names in variables for later use
-	A1=$(git rev-parse --verify A1) &&
-	A2=$(git rev-parse --verify A2) &&
-	A3=$(git rev-parse --verify A3) &&
-	A4=$(git rev-parse --verify A4) &&
-	A5=$(git rev-parse --verify A5) &&
-	A6=$(git rev-parse --verify A6) &&
-	A7=$(git rev-parse --verify A7) &&
-	B1=$(git rev-parse --verify B1) &&
-	B2=$(git rev-parse --verify B2) &&
-	C1=$(git rev-parse --verify C1) &&
-	C2=$(git rev-parse --verify C2) &&
-	C3=$(git rev-parse --verify C3) &&
-	C4=$(git rev-parse --verify C4)
-	'
+	test_commit A7 bar.txt
+'
 
 test_expect_success '--graph --all' '
-	rm -f expected &&
-	echo "* $A7" >> expected &&
-	echo "*   $A6" >> expected &&
-	echo "|\\  " >> expected &&
-	echo "| * $C4" >> expected &&
-	echo "| * $C3" >> expected &&
-	echo "* | $A5" >> expected &&
-	echo "| |   " >> expected &&
-	echo "|  \\  " >> expected &&
-	echo "*-. | $A4" >> expected &&
-	echo "|\\ \\| " >> expected &&
-	echo "| | * $C2" >> expected &&
-	echo "| | * $C1" >> expected &&
-	echo "| * | $B2" >> expected &&
-	echo "| * | $B1" >> expected &&
-	echo "* | | $A3" >> expected &&
-	echo "| |/  " >> expected &&
-	echo "|/|   " >> expected &&
-	echo "* | $A2" >> expected &&
-	echo "|/  " >> expected &&
-	echo "* $A1" >> expected &&
-	git rev-list --graph --all > actual &&
-	test_cmp expected actual
-	'
+	check_graph --all <<-\EOF
+	* A7
+	*   A6
+	|\
+	| * C4
+	| * C3
+	* | A5
+	| |
+	|  \
+	*-. | A4
+	|\ \|
+	| | * C2
+	| | * C1
+	| * | B2
+	| * | B1
+	* | | A3
+	| |/
+	|/|
+	* | A2
+	|/
+	* A1
+	EOF
+'
 
 # Make sure the graph_is_interesting() code still realizes
 # that undecorated merges are interesting, even with --simplify-by-decoration
 test_expect_success '--graph --simplify-by-decoration' '
-	rm -f expected &&
 	git tag -d A4 &&
-	echo "* $A7" >> expected &&
-	echo "*   $A6" >> expected &&
-	echo "|\\  " >> expected &&
-	echo "| * $C4" >> expected &&
-	echo "| * $C3" >> expected &&
-	echo "* | $A5" >> expected &&
-	echo "| |   " >> expected &&
-	echo "|  \\  " >> expected &&
-	echo "*-. | $A4" >> expected &&
-	echo "|\\ \\| " >> expected &&
-	echo "| | * $C2" >> expected &&
-	echo "| | * $C1" >> expected &&
-	echo "| * | $B2" >> expected &&
-	echo "| * | $B1" >> expected &&
-	echo "* | | $A3" >> expected &&
-	echo "| |/  " >> expected &&
-	echo "|/|   " >> expected &&
-	echo "* | $A2" >> expected &&
-	echo "|/  " >> expected &&
-	echo "* $A1" >> expected &&
-	git rev-list --graph --all --simplify-by-decoration > actual &&
-	test_cmp expected actual
-	'
+	check_graph --all --simplify-by-decoration <<-\EOF
+	* A7
+	*   A6
+	|\
+	| * C4
+	| * C3
+	* | A5
+	| |
+	|  \
+	*-. | A4
+	|\ \|
+	| | * C2
+	| | * C1
+	| * | B2
+	| * | B1
+	* | | A3
+	| |/
+	|/|
+	* | A2
+	|/
+	* A1
+	EOF
+'
 
 test_expect_success 'setup: get rid of decorations on B' '
 	git tag -d B2 &&
@@ -122,142 +111,133 @@  test_expect_success 'setup: get rid of decorations on B' '
 
 # Graph with branch B simplified away
 test_expect_success '--graph --simplify-by-decoration prune branch B' '
-	rm -f expected &&
-	echo "* $A7" >> expected &&
-	echo "*   $A6" >> expected &&
-	echo "|\\  " >> expected &&
-	echo "| * $C4" >> expected &&
-	echo "| * $C3" >> expected &&
-	echo "* | $A5" >> expected &&
-	echo "* | $A4" >> expected &&
-	echo "|\\| " >> expected &&
-	echo "| * $C2" >> expected &&
-	echo "| * $C1" >> expected &&
-	echo "* | $A3" >> expected &&
-	echo "|/  " >> expected &&
-	echo "* $A2" >> expected &&
-	echo "* $A1" >> expected &&
-	git rev-list --graph --simplify-by-decoration --all > actual &&
-	test_cmp expected actual
-	'
+	check_graph --simplify-by-decoration --all <<-\EOF
+	* A7
+	*   A6
+	|\
+	| * C4
+	| * C3
+	* | A5
+	* | A4
+	|\|
+	| * C2
+	| * C1
+	* | A3
+	|/
+	* A2
+	* A1
+	EOF
+'
 
 test_expect_success '--graph --full-history -- bar.txt' '
-	rm -f expected &&
-	echo "* $A7" >> expected &&
-	echo "*   $A6" >> expected &&
-	echo "|\\  " >> expected &&
-	echo "| * $C4" >> expected &&
-	echo "* | $A5" >> expected &&
-	echo "* | $A4" >> expected &&
-	echo "|\\| " >> expected &&
-	echo "* | $A3" >> expected &&
-	echo "|/  " >> expected &&
-	echo "* $A2" >> expected &&
-	git rev-list --graph --full-history --all -- bar.txt > actual &&
-	test_cmp expected actual
-	'
+	check_graph --full-history --all -- bar.txt <<-\EOF
+	* A7
+	*   A6
+	|\
+	| * C4
+	* | A5
+	* | A4
+	|\|
+	* | A3
+	|/
+	* A2
+	EOF
+'
 
 test_expect_success '--graph --full-history --simplify-merges -- bar.txt' '
-	rm -f expected &&
-	echo "* $A7" >> expected &&
-	echo "*   $A6" >> expected &&
-	echo "|\\  " >> expected &&
-	echo "| * $C4" >> expected &&
-	echo "* | $A5" >> expected &&
-	echo "* | $A3" >> expected &&
-	echo "|/  " >> expected &&
-	echo "* $A2" >> expected &&
-	git rev-list --graph --full-history --simplify-merges --all \
-		-- bar.txt > actual &&
-	test_cmp expected actual
-	'
+	check_graph --full-history --simplify-merges --all -- bar.txt <<-\EOF
+	* A7
+	*   A6
+	|\
+	| * C4
+	* | A5
+	* | A3
+	|/
+	* A2
+	EOF
+'
 
 test_expect_success '--graph -- bar.txt' '
-	rm -f expected &&
-	echo "* $A7" >> expected &&
-	echo "* $A5" >> expected &&
-	echo "* $A3" >> expected &&
-	echo "| * $C4" >> expected &&
-	echo "|/  " >> expected &&
-	echo "* $A2" >> expected &&
-	git rev-list --graph --all -- bar.txt > actual &&
-	test_cmp expected actual
-	'
+	check_graph --all -- bar.txt <<-\EOF
+	* A7
+	* A5
+	* A3
+	| * C4
+	|/
+	* A2
+	EOF
+'
 
 test_expect_success '--graph --sparse -- bar.txt' '
-	rm -f expected &&
-	echo "* $A7" >> expected &&
-	echo "* $A6" >> expected &&
-	echo "* $A5" >> expected &&
-	echo "* $A4" >> expected &&
-	echo "* $A3" >> expected &&
-	echo "| * $C4" >> expected &&
-	echo "| * $C3" >> expected &&
-	echo "| * $C2" >> expected &&
-	echo "| * $C1" >> expected &&
-	echo "|/  " >> expected &&
-	echo "* $A2" >> expected &&
-	echo "* $A1" >> expected &&
-	git rev-list --graph --sparse --all -- bar.txt > actual &&
-	test_cmp expected actual
-	'
+	check_graph --sparse --all -- bar.txt <<-\EOF
+	* A7
+	* A6
+	* A5
+	* A4
+	* A3
+	| * C4
+	| * C3
+	| * C2
+	| * C1
+	|/
+	* A2
+	* A1
+	EOF
+'
 
 test_expect_success '--graph ^C4' '
-	rm -f expected &&
-	echo "* $A7" >> expected &&
-	echo "* $A6" >> expected &&
-	echo "* $A5" >> expected &&
-	echo "*   $A4" >> expected &&
-	echo "|\\  " >> expected &&
-	echo "| * $B2" >> expected &&
-	echo "| * $B1" >> expected &&
-	echo "* $A3" >> expected &&
-	git rev-list --graph --all ^C4 > actual &&
-	test_cmp expected actual
-	'
+	check_graph --all ^C4 <<-\EOF
+	* A7
+	* A6
+	* A5
+	*   A4
+	|\
+	| * B2
+	| * B1
+	* A3
+	EOF
+'
 
 test_expect_success '--graph ^C3' '
-	rm -f expected &&
-	echo "* $A7" >> expected &&
-	echo "*   $A6" >> expected &&
-	echo "|\\  " >> expected &&
-	echo "| * $C4" >> expected &&
-	echo "* $A5" >> expected &&
-	echo "*   $A4" >> expected &&
-	echo "|\\  " >> expected &&
-	echo "| * $B2" >> expected &&
-	echo "| * $B1" >> expected &&
-	echo "* $A3" >> expected &&
-	git rev-list --graph --all ^C3 > actual &&
-	test_cmp expected actual
-	'
+	check_graph --all ^C3 <<-\EOF
+	* A7
+	*   A6
+	|\
+	| * C4
+	* A5
+	*   A4
+	|\
+	| * B2
+	| * B1
+	* A3
+	EOF
+'
 
 # I don't think the ordering of the boundary commits is really
 # that important, but this test depends on it.  If the ordering ever changes
 # in the code, we'll need to update this test.
 test_expect_success '--graph --boundary ^C3' '
-	rm -f expected &&
-	echo "* $A7" >> expected &&
-	echo "*   $A6" >> expected &&
-	echo "|\\  " >> expected &&
-	echo "| * $C4" >> expected &&
-	echo "* | $A5" >> expected &&
-	echo "| |     " >> expected &&
-	echo "|  \\    " >> expected &&
-	echo "*-. \\   $A4" >> expected &&
-	echo "|\\ \\ \\  " >> expected &&
-	echo "| * | | $B2" >> expected &&
-	echo "| * | | $B1" >> expected &&
-	echo "* | | | $A3" >> expected &&
-	echo "o | | | $A2" >> expected &&
-	echo "|/ / /  " >> expected &&
-	echo "o / / $A1" >> expected &&
-	echo " / /  " >> expected &&
-	echo "| o $C3" >> expected &&
-	echo "|/  " >> expected &&
-	echo "o $C2" >> expected &&
-	git rev-list --graph --boundary --all ^C3 > actual &&
-	test_cmp expected actual
-	'
+	check_graph --boundary --all ^C3 <<-\EOF
+	* A7
+	*   A6
+	|\
+	| * C4
+	* | A5
+	| |
+	|  \
+	*-. \   A4
+	|\ \ \
+	| * | | B2
+	| * | | B1
+	* | | | A3
+	o | | | A2
+	|/ / /
+	o / / A1
+	 / /
+	| o C3
+	|/
+	o C2
+	EOF
+'
 
 test_done