[v6,GSOC] ref-filter: fix read invalid union member bug

Commit Message

ZheNing Hu May 12, 2021, 12:12 p.m. UTC

From: ZheNing Hu <[e-mail]>

used_atom.u is an union, and it has different members depending on
what atom the auxiliary data the union part of the "struct
used_atom" wants to record. At most only one of the members can be
valid at any one time. Since the code checks u.remote_ref without
even making sure if the atom is "push" or "push:" (which are only
two cases that u.remote_ref.push becomes valid), but u.remote_ref
shares the same storage for other members of the union, the check
was reading from an invalid member, which was the bug.

Modify the condition here to check whether the atom name
equals to "push" or starts with "push:", to avoid reading the
value of invalid member of the union.

Helped-by: Junio C Hamano <[e-mail]>
Signed-off-by: ZheNing Hu <[e-mail]>
---
    [GSOC] ref-filter: fix read invalid union member bug
    
    Change from last version: Modify the test content to make the test more
    correct and complete.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-949%2Fadlternative%2Fref-filter-enum-bug-fix-v6
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-949/adlternative/ref-filter-enum-bug-fix-v6
Pull-Request: https://github.com/gitgitgadget/git/pull/949

Range-diff vs v5:

 1:  b546477e8c87 ! 1:  518cc41a78a4 [GSOC] ref-filter: fix read invalid union member bug
     @@ t/t6302-for-each-ref-filter.sh: test_expect_success '%(color) must fail' '
       	test_must_fail git for-each-ref --format="%(color)%(refname)"
       '
       
     -+test_expect_success '%(color:#aa22ac) must successed' '
     -+	test_when_finished "cd .. && rm -rf ./test" &&
     ++test_expect_success '%(color:#aa22ac) must succeed' '
      +	mkdir test &&
     -+	cd test &&
     -+	git init &&
     -+	cat >expect <<-\EOF &&
     -+	refs/heads/main
     -+	EOF
     -+	git add . &&
     -+	git branch -M main &&
     -+	git commit -m "test" &&
     -+	git remote add origin nowhere &&
     -+	git config branch.main.remote origin &&
     -+	git config branch.main.merge refs/heads/main &&
     -+	git for-each-ref --format="%(color:#aa22ac)%(refname)" >actual &&
     -+	test_cmp expect actual
     ++	git init test &&
     ++	(
     ++		cd test &&
     ++		test_commit initial &&
     ++		git branch -M main &&
     ++		cat >expect <<-\EOF &&
     ++		refs/heads/main
     ++		refs/tags/initial
     ++		EOF
     ++		git remote add origin nowhere &&
     ++		git config branch.main.remote origin &&
     ++		git config branch.main.merge refs/heads/main &&
     ++		git for-each-ref --format="%(color:#aa22ac)%(refname)" >actual &&
     ++		test_cmp expect actual
     ++	)
      +'
      +
       test_expect_success 'left alignment is default' '


 ref-filter.c                   |  2 +-
 t/t6302-for-each-ref-filter.sh | 19 +++++++++++++++++++
 2 files changed, 20 insertions(+), 1 deletion(-)


base-commit: 311531c9de557d25ac087c1637818bd2aad6eb3a

Comments

Junio C Hamano May 12, 2021, 11:24 p.m. UTC | #1

"ZheNing Hu via GitGitGadget" <[e-mail]> writes:

> +test_expect_success '%(color:#aa22ac) must succeed' '
> +	mkdir test &&

You do not need "mkdir test" here, as "git init test" would take
care of it.

On the other hand, you'd want to get 'test' directory removed after
this passes, so 

	test_when_finished rm -fr test &&

would be useful.

Other than that, looks good to me.

Thanks.

> +	git init test &&
> +	(
> +		cd test &&
> +		test_commit initial &&
> +		git branch -M main &&
> +		cat >expect <<-\EOF &&
> +		refs/heads/main
> +		refs/tags/initial
> +		EOF
> +		git remote add origin nowhere &&
> +		git config branch.main.remote origin &&
> +		git config branch.main.merge refs/heads/main &&
> +		git for-each-ref --format="%(color:#aa22ac)%(refname)" >actual &&
> +		test_cmp expect actual
> +	)
> +'
> +
>  test_expect_success 'left alignment is default' '
>  	cat >expect <<-\EOF &&
>  	refname is refs/heads/main    |refs/heads/main
>
> base-commit: 311531c9de557d25ac087c1637818bd2aad6eb3a

ZheNing Hu May 13, 2021, 9:29 a.m. UTC | #2

Junio C Hamano <[e-mail]> 于2021年5月13日周四 上午7:24写道：
>
> "ZheNing Hu via GitGitGadget" <[e-mail]> writes:
>
> > +test_expect_success '%(color:#aa22ac) must succeed' '
> > +     mkdir test &&
>
> You do not need "mkdir test" here, as "git init test" would take
> care of it.
>

Make sence.

> On the other hand, you'd want to get 'test' directory removed after
> this passes, so
>
>         test_when_finished rm -fr test &&
>
> would be useful.
>

Well, deleting or not deleting the directory "test" is not a big problem here.
Delete it is ok.

> Other than that, looks good to me.
>
> Thanks.
>

Thanks.
--
ZheNing Hu

Patch

diff --git a/ref-filter.c b/ref-filter.c
index a0adb4551d87..213d3773ada3 100644
--- a/ref-filter.c
+++ b/ref-filter.c
@@ -1730,7 +1730,7 @@  static int populate_value(struct ref_array_item *ref, struct strbuf *err)
 			else
 				v->s = xstrdup("");
 			continue;
-		} else if (atom->u.remote_ref.push) {
+		} else if (!strcmp(atom->name, "push") || starts_with(atom->name, "push:")) {
 			const char *branch_name;
 			v->s = xstrdup("");
 			if (!skip_prefix(ref->refname, "refs/heads/",
diff --git a/t/t6302-for-each-ref-filter.sh b/t/t6302-for-each-ref-filter.sh
index 9866b1b57368..b64abe4184b8 100755
--- a/t/t6302-for-each-ref-filter.sh
+++ b/t/t6302-for-each-ref-filter.sh
@@ -117,6 +117,25 @@  test_expect_success '%(color) must fail' '
 	test_must_fail git for-each-ref --format="%(color)%(refname)"
 '
 
+test_expect_success '%(color:#aa22ac) must succeed' '
+	mkdir test &&
+	git init test &&
+	(
+		cd test &&
+		test_commit initial &&
+		git branch -M main &&
+		cat >expect <<-\EOF &&
+		refs/heads/main
+		refs/tags/initial
+		EOF
+		git remote add origin nowhere &&
+		git config branch.main.remote origin &&
+		git config branch.main.merge refs/heads/main &&
+		git for-each-ref --format="%(color:#aa22ac)%(refname)" >actual &&
+		test_cmp expect actual
+	)
+'
+
 test_expect_success 'left alignment is default' '
 	cat >expect <<-\EOF &&
 	refname is refs/heads/main    |refs/heads/main