From: William Chargin <wchargin@gmail.com>
To: git@vger.kernel.org, sunshine@sunshineco.com
Cc: William Chargin <wchargin@gmail.com>, jrnieder@gmail.com, peff@peff.net
Subject: [PATCH v4] test_dir_is_empty: fix edge cases with newlines and hyphens
Date: Wed, 12 Sep 2018 11:37:55 -0700 [thread overview]
Message-ID: <20180912183755.7875-1-wchargin@gmail.com> (raw)
In-Reply-To: <CAPig+cQSg-t6KGj3s0LJi+FU7LSQMNTmSHhMJJH=PgMUU9GWOA@mail.gmail.com>
While the `test_dir_is_empty` function appears correct in most normal
use cases, it can improperly pass if a directory contains a filename
with a newline, and can improperly fail if an empty directory looks like
an argument to `ls`. This patch changes the implementation to check that
the output of `ls -a` has at most two lines (for `.` and `..`), which
should be better behaved, and adds the `--` delimiter before the
directory name when invoking `ls`.
The newly added unit test fails before this change and passes after it.
Signed-off-by: William Chargin <wchargin@gmail.com>
---
This patch depends on "t: factor out FUNNYNAMES as shared lazy prereq"
(2018-08-06), which is now in master.
I originally wrote this patch for the standalone Sharness library, but
that library advises that such patches be sent to the Git mailing list
first.
Tested on GNU/Linux (Mint 18.2) and macOS (10.13).
t/t0000-basic.sh | 43 +++++++++++++++++++++++++++++++++++++++++
t/test-lib-functions.sh | 2 +-
2 files changed, 44 insertions(+), 1 deletion(-)
diff --git a/t/t0000-basic.sh b/t/t0000-basic.sh
index 850f651e4e..a5c57c6aa5 100755
--- a/t/t0000-basic.sh
+++ b/t/t0000-basic.sh
@@ -821,6 +821,49 @@ test_expect_success 'tests clean up even on failures' "
EOF
"
+test_expect_success FUNNYNAMES \
+ 'test_dir_is_empty behaves even in pathological cases' "
+ run_sub_test_lib_test \
+ dir-empty 'behavior of test_dir_is_empty' <<-\\EOF &&
+ test_expect_success 'should pass with actually empty directory' '
+ mkdir empty_dir &&
+ test_dir_is_empty empty_dir
+ '
+ test_expect_success 'should fail with a normal filename' '
+ mkdir nonempty_dir &&
+ >nonempty_dir/some_file &&
+ ! test_dir_is_empty nonempty_dir
+ '
+ test_expect_success 'should fail with dot-newline-dot filename' '
+ mkdir pathological_dir &&
+ >\"pathological_dir/.
+ .\" &&
+ ! test_dir_is_empty pathological_dir
+ '
+ test_expect_success 'should pass with an empty directory \"-l\"' '
+ mkdir -- -l &&
+ test_dir_is_empty -l &&
+ rmdir -- -l
+ '
+ test_expect_success 'should pass with an empty directory \"--wat\"' '
+ mkdir -- --wat &&
+ test_dir_is_empty --wat &&
+ rmdir -- --wat
+ '
+ test_done
+ EOF
+ check_sub_test_lib_test dir-empty <<-\\EOF
+ > ok 1 - should pass with actually empty directory
+ > ok 2 - should fail with a normal filename
+ > ok 3 - should fail with dot-newline-dot filename
+ > ok 4 - should pass with an empty directory \"-l\"
+ > ok 5 - should pass with an empty directory \"--wat\"
+ > # passed all 5 test(s)
+ > 1..5
+ EOF
+"
+
+
################################################################
# Basics of the basics
diff --git a/t/test-lib-functions.sh b/t/test-lib-functions.sh
index 4207af4077..3df6b8027f 100644
--- a/t/test-lib-functions.sh
+++ b/t/test-lib-functions.sh
@@ -576,7 +576,7 @@ test_path_exists () {
# Check if the directory exists and is empty as expected, barf otherwise.
test_dir_is_empty () {
test_path_is_dir "$1" &&
- if test -n "$(ls -a1 "$1" | egrep -v '^\.\.?$')"
+ if test "$(ls -a1 -- "$1" | wc -l)" -gt 2
then
echo "Directory '$1' is not empty, it contains:"
ls -la "$1"
--
2.18.0.549.gd66323a05
next prev parent reply other threads:[~2018-09-12 18:38 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-08-05 2:20 [PATCH 0/1] t/test-lib: make `test_dir_is_empty` more robust William Chargin
2018-08-05 2:20 ` [PATCH 1/1] " William Chargin
2018-08-05 4:19 ` Jonathan Nieder
2018-08-05 5:23 ` Eric Sunshine
2018-08-05 20:52 ` Jeff King
2018-08-06 13:02 ` Jeff King
2018-08-06 17:52 ` Eric Sunshine
2018-08-12 4:06 ` [PATCH v3] test_dir_is_empty: properly detect files with newline in name William Chargin
2018-08-12 6:17 ` Eric Sunshine
2018-08-12 6:32 ` William Chargin
2018-08-12 6:44 ` Eric Sunshine
2018-09-12 18:35 ` [PATCH v4] test_dir_is_empty: fix edge cases with newlines and hyphens William Chargin
2018-09-12 19:50 ` Junio C Hamano
2018-09-12 18:37 ` William Chargin [this message]
2018-08-12 4:06 ` [PATCH 1/1] t/test-lib: make `test_dir_is_empty` more robust William Chargin
2018-08-05 5:24 ` William Chargin
2018-08-05 6:34 ` Jonathan Nieder
2018-08-05 6:03 ` Junio C Hamano
2018-08-05 6:23 ` Jonathan Nieder
2018-08-05 3:36 ` [PATCH 0/1] " Jonathan Nieder
2018-08-05 4:19 ` William Chargin
2018-08-05 4:20 ` [PATCH v2] " William Chargin
2018-08-05 8:34 ` Johannes Sixt
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=20180912183755.7875-1-wchargin@gmail.com \
--to=wchargin@gmail.com \
--cc=git@vger.kernel.org \
--cc=jrnieder@gmail.com \
--cc=peff@peff.net \
--cc=sunshine@sunshineco.com \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.