git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Fabian Stelzer <fs@gigacodes.de>
Cc: git@vger.kernel.org, Adam Dinwoodie <adam@dinwoodie.org>,
	Jeff King <peff@peff.net>
Subject: Re: [PATCH 2/2] test-lib: introduce required prereq for test runs
Date: Mon, 15 Nov 2021 22:09:08 -0800	[thread overview]
Message-ID: <xmqqpmr0bpiz.fsf@gitster.g> (raw)
In-Reply-To: 20211115160750.1208940-3-fs@gigacodes.de

Fabian Stelzer <fs@gigacodes.de> writes:

> In certain environments or for specific test scenarios we might expect a
> specific prerequisite check to be succeed. Therefore we would like to

"to be succeed" -> "to succeed"?

> trigger an error when running our tests if this is not the case.
>
> To remedy this we add the environment variable GIT_TEST_REQUIRE_PREREQ
> which can be set to a comma separated list of prereqs. If one of these
> prereq tests fail then the whole test run will abort.
>
> Signed-off-by: Fabian Stelzer <fs@gigacodes.de>
> ---
>  t/README                |  6 ++++++
>  t/test-lib-functions.sh | 11 +++++++++++
>  2 files changed, 17 insertions(+)
>
> diff --git a/t/README b/t/README
> index 29f72354bf..18ce75976e 100644
> --- a/t/README
> +++ b/t/README
> @@ -466,6 +466,12 @@ explicitly providing repositories when accessing submodule objects is
>  complete or needs to be abandoned for whatever reason (in which case the
>  migrated codepaths still retain their performance benefits).
>  
> +GIT_TEST_REQUIRE_PREREQ=<list> allows specifying a comma speparated list of
> +prereqs that are required to succeed. If a prereq in this list is triggered by
> +a test and then fails then the whole test run will abort. This can help to make
> +sure the expected tests are executed and not silently skipped when their
> +dependency breaks or is simply not present in a new environment.
> +
>  Naming Tests
>  ------------
>  
> diff --git a/t/test-lib-functions.sh b/t/test-lib-functions.sh
> index eef2262a36..2c8abf3420 100644
> --- a/t/test-lib-functions.sh
> +++ b/t/test-lib-functions.sh
> @@ -680,6 +680,17 @@ test_have_prereq () {
>  			# Keep a list of missing prerequisites; restore
>  			# the negative marker if necessary.
>  			prerequisite=${negative_prereq:+!}$prerequisite
> +
> +			# Abort if this prereq was marked as required
> +			if test -n $GIT_TEST_REQUIRE_PREREQ
> +			then
> +				case ",$GIT_TEST_REQUIRE_PREREQ," in
> +				*,$prerequisite,*)
> +					error "required prereq $prerequisite failed"
> +					;;
> +				esac
> +			fi
> +
>  			if test -z "$missing_prereq"
>  			then
>  				missing_prereq=$prerequisite

      reply	other threads:[~2021-11-16  6:09 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-15 16:07 [PATCH 0/2] test-lib: improve missing prereq handling Fabian Stelzer
2021-11-15 16:07 ` [PATCH 1/2] test-lib: show missing prereq summary Fabian Stelzer
2021-11-15 17:44   ` Ævar Arnfjörð Bjarmason
2021-11-15 17:53     ` Junio C Hamano
2021-11-15 19:56       ` Fabian Stelzer
2021-11-15 22:10         ` Junio C Hamano
2021-11-16 14:19     ` Fabian Stelzer
2021-11-17  8:19       ` Junio C Hamano
2021-11-17  9:05         ` Fabian Stelzer
2021-11-15 16:07 ` [PATCH 2/2] test-lib: introduce required prereq for test runs Fabian Stelzer
2021-11-16  6:09   ` Junio C Hamano [this message]

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=xmqqpmr0bpiz.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=adam@dinwoodie.org \
    --cc=fs@gigacodes.de \
    --cc=git@vger.kernel.org \
    --cc=peff@peff.net \
    /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).