git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Chandra Pratap <chandrapratap3519@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] unit-tests: use xstrfmt() instead of a char buffer in t-reftable-stack
Date: Tue, 01 Oct 2024 12:22:57 -0700	[thread overview]
Message-ID: <xmqqo743vd9q.fsf@gitster.g> (raw)
In-Reply-To: <20241001170629.7768-1-chandrapratap3519@gmail.com> (Chandra Pratap's message of "Tue, 1 Oct 2024 22:35:55 +0530")

Chandra Pratap <chandrapratap3519@gmail.com> writes:

> A char buffer is used to hold refname values as formatted strings
> in the reftable_stack_add() test in t/unit-tests/t-reftable-stack.c.
> This can be replaced with a single call to xstrfmt() making the test
> conciser.

It may make the test more concise, but would we now need to worry
about leaking .refname?

It turns out that we do not have to, as we were already storing the
result of xstrdup() to .refname, so we must have been freeing them
already (or we are not making existing leak worse, if .refname were
leaking).

I've heard some noises about using our helper functions in tests, in
that a buggy helper function of ours would interfere with testing
the thing(s) we truly want to test, but we have been using xstrdup()
and replacing it with xstrfmt(), so it is not like we are making
things worse in that regard.  Not that I entirely buy the "don't use
git to test git" argument.

One thing that this worsens is that we now have two copies of the
literal "branch%02"PRIuMAX string.  If we ever want to change one of
them, we must remember to change the other to match.

Perhaps with another constant, this patch would become perfect, like
this?

> Signed-off-by: Chandra Pratap <chandrapratap3519@gmail.com>
> ---
>  t/unit-tests/t-reftable-stack.c | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
>
> diff --git a/t/unit-tests/t-reftable-stack.c b/t/unit-tests/t-reftable-stack.c
> index 31d563d992..2d7cfbf8aa 100644
> --- a/t/unit-tests/t-reftable-stack.c
> +++ b/t/unit-tests/t-reftable-stack.c
> @@ -523,14 +523,12 @@ static void t_reftable_stack_add(void)
>  	check(!err);
>  
>  	for (i = 0; i < N; i++) {
> -		char buf[256];

+		static const char fmt[] = "branch%02"PRIuMAX;

> -		snprintf(buf, sizeof(buf), "branch%02"PRIuMAX, (uintmax_t)i);
> -		refs[i].refname = xstrdup(buf);
> +		refs[i].refname = xstrfmt("branch%02"PRIuMAX, (uintmax_t)i);

+		refs[i].refname = xstrfmt(fmt, (uintmax_t)i);

>  		refs[i].update_index = i + 1;
>  		refs[i].value_type = REFTABLE_REF_VAL1;
>  		t_reftable_set_hash(refs[i].value.val1, i, GIT_SHA1_FORMAT_ID);
>  
> -		logs[i].refname = xstrdup(buf);
> +		logs[i].refname = xstrfmt("branch%02"PRIuMAX, (uintmax_t)i);

+		logs[i].refname = xstrfmt(fmt, (uintmax_t)i);

>  		logs[i].update_index = N + i + 1;
>  		logs[i].value_type = REFTABLE_LOG_UPDATE;
>  		logs[i].value.update.email = xstrdup("identity@invalid");

  reply	other threads:[~2024-10-01 19:23 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-01 17:05 [PATCH] unit-tests: use xstrfmt() instead of a char buffer in t-reftable-stack Chandra Pratap
2024-10-01 19:22 ` Junio C Hamano [this message]
2024-10-01 19:32   ` Eric Sunshine

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqo743vd9q.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=chandrapratap3519@gmail.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).