[27/27] t: run tests with `set -o pipefail` on Bash

Message ID	bc3f226edf284d96dc7fff15c188ecfbc32162d6.1573779466.git.liu.denton@gmail.com (mailing list archive)
State	New, archived
Headers	show Return-Path: <SRS0=V4lN=ZH=vger.kernel.org=git-owner@kernel.org> Date: Thu, 14 Nov 2019 17:01:32 -0800 From: Denton Liu <liu.denton@gmail.com> To: Git Mailing List <git@vger.kernel.org> Subject: [PATCH 27/27] t: run tests with `set -o pipefail` on Bash Message-ID: <bc3f226edf284d96dc7fff15c188ecfbc32162d6.1573779466.git.liu.denton@gmail.com> References: <cover.1573779465.git.liu.denton@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <cover.1573779465.git.liu.denton@gmail.com> User-Agent: Mutt/1.12.2 (2019-09-21) Sender: git-owner@vger.kernel.org Precedence: bulk
Series	t: general test cleanup + `set -o pipefail` \| expand [00/27] t: general test cleanup + `set -o pipefail` [01/27] lib-bash.sh: move `then` onto its own line [02/27] t0014: remove git command upstream of pipe [03/27] t0090: stop losing return codes of git commands [04/27] t3301: stop losing return codes of git commands [05/27] t3600: use test_line_count() where possible [06/27] t3600: stop losing return codes of git commands [07/27] t3600: comment on inducing SIGPIPE in `git rm` [08/27] t4015: stop losing return codes of git commands [09/27] t4015: use test_write_lines() [10/27] t4138: stop losing return codes of git commands [11/27] t5317: stop losing return codes of git commands [12/27] t5317: use ! grep to check for no matching lines [13/27] t5703: stop losing return codes of git commands [14/27] t7501: remove spaces after redirect operators [15/27] t7501: stop losing return codes of git commands [16/27] t7700: drop redirections to /dev/null [17/27] t7700: remove spaces after redirect operators [18/27] t7700: move keywords onto their own line [19/27] t7700: s/test -f/test_path_is_file/ [20/27] t7700: stop losing return codes of git commands [21/27] t: define test_grep_return_success() [22/27] t0090: mask failing grep status [23/27] t3600: mark git command as failing [24/27] t5004: ignore SIGPIPE in zipinfo [25/27] t5703: mask failing grep status [26/27] t9902: disable pipefail [27/27] t: run tests with `set -o pipefail` on Bash

Message ID

bc3f226edf284d96dc7fff15c188ecfbc32162d6.1573779466.git.liu.denton@gmail.com (mailing list archive)

State

New, archived

Headers

Date: Thu, 14 Nov 2019 17:01:32 -0800
From: Denton Liu <liu.denton@gmail.com>
To: Git Mailing List <git@vger.kernel.org>
Subject: [PATCH 27/27] t: run tests with `set -o pipefail` on Bash
Message-ID: 
 <bc3f226edf284d96dc7fff15c188ecfbc32162d6.1573779466.git.liu.denton@gmail.com>
References: <cover.1573779465.git.liu.denton@gmail.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <cover.1573779465.git.liu.denton@gmail.com>
User-Agent: Mutt/1.12.2 (2019-09-21)
Sender: git-owner@vger.kernel.org
Precedence: bulk

Series

t: general test cleanup + `set -o pipefail` | expand

Commit Message

Denton Liu Nov. 15, 2019, 1:01 a.m. UTC

The current convention is to ensure that git commands are not placed in
the upstream of a pipe. If they are, they could fail in an undetectable
manner since a pipe's return code is the last command in the pipe.
However, many old tests are still written with git commands in the
upstream of a pipe.

In the spirit of catching these failures, run tests with
`set -o pipefail` if the underlying shell is Bash. This way, we can
catch failures of Git commands that may occur even in the middle of a
pipeline.

In the future, more shells that support `set -o pipefail` may have it
enabled but let's start small for now.

Signed-off-by: Denton Liu <liu.denton@gmail.com>
---
 t/README      |  4 ++++
 t/test-lib.sh | 12 ++++++++++++
 2 files changed, 16 insertions(+)

diff --git a/t/README b/t/README
index 60d5b77bcc..ba96b6d113 100644
--- a/t/README
+++ b/t/README
@@ -415,6 +415,10 @@  GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=<boolean>, when true (which is
 the default when running tests), errors out when an abbreviated option
 is used.
 
+GIT_TEST_PIPEFAIL=<boolean>, when true, run 'set -o pipefail' to catch
+failures in commands that aren't the last in a pipe. Defaults to true on
+Bash and false otherwise.
+
 Naming Tests
 ------------
 
diff --git a/t/test-lib.sh b/t/test-lib.sh
index 46c4440843..c0c43dfce9 100644
--- a/t/test-lib.sh
+++ b/t/test-lib.sh
@@ -64,6 +64,18 @@  then
 	export GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS
 fi
 
+# Use set -o pipefail on platforms that support it
+GIT_TEST_PIPEFAIL_DEFAULT=false
+# TODO: detect more platforms that support `set -o pipefail`
+if test -n "$BASH_VERSION"
+then
+	GIT_TEST_PIPEFAIL_DEFAULT=true
+fi
+if git env--helper --type=bool --default="$GIT_TEST_PIPEFAIL_DEFAULT" --exit-code GIT_TEST_PIPEFAIL
+then
+	set -o pipefail
+fi
+
 ################################################################
 # It appears that people try to run tests without building...
 "${GIT_TEST_INSTALLED:-$GIT_BUILD_DIR}/git$X" >/dev/null

[27/27] t: run tests with `set -o pipefail` on Bash

Commit Message

Patch