# [PATCH] t6300: don't run cat-file on non-existent object 11 messages from 2021-08-17 to 2021-08-21. Participants: Đoàn Trần Công Danh, Johannes Schindelin, Junio C Hamano. Thread: https://gitlist.dev/t/56311 ## Đoàn Trần Công Danh, 2021-08-17 11:48 Subject: [PATCH] t6300: don't run cat-file on non-existent object Message-ID: URL: https://gitlist.dev/e/bcbde2e7364865ac16702447b863b8a725670428.1629200841.git.congdanhqx%40gmail.com ``` In t6300, some tests are guarded behind some prerequisites. Thus, objects created by those tests ain't available if those prerequisites is unsatistified. Attempting to run "cat-file" on those objects will run into failure. In fact, running t6300 in an environment without gpg(1), we'll see those warnings: fatal: Not a valid object name refs/tags/signed-empty fatal: Not a valid object name refs/tags/signed-short fatal: Not a valid object name refs/tags/signed-long Let's put those commands into the real tests, in order to: * skip their execution if prerequisites aren't satistified. * check their exit status code Signed-off-by: Đoàn Trần Công Danh --- t/t6300-for-each-ref.sh | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/t/t6300-for-each-ref.sh b/t/t6300-for-each-ref.sh index 9e0214076b..65fbed2bef 100755 --- a/t/t6300-for-each-ref.sh +++ b/t/t6300-for-each-ref.sh @@ -59,18 +59,23 @@ test_atom() { # Automatically test "contents:size" atom after testing "contents" if test "$2" = "contents" then - case $(git cat-file -t "$ref") in - tag) - # We cannot use $3 as it expects sanitize_pgp to run - expect=$(git cat-file tag $ref | tail -n +6 | wc -c) ;; - tree | blob) - expect='' ;; - commit) - expect=$(printf '%s' "$3" | wc -c) ;; - esac - # Leave $expect unquoted to lose possible leading whitespaces - echo $expect >expected + expect=$(printf '%s' "$3" | wc -c) test_expect_${4:-success} $PREREQ "basic atom: $1 contents:size" ' + type=$(git cat-file -t "$ref") && + case $type in + tag) + # We cannot use $3 as it expects sanitize_pgp to run + git cat-file tag $ref >out && + expect=$(expected && git for-each-ref --format="%(contents:size)" "$ref" >actual && test_cmp expected actual ' -- 2.33.0 ``` ## Johannes Schindelin, 2021-08-17 21:44 Subject: Re: [PATCH] t6300: don't run cat-file on non-existent object Message-ID: URL: https://gitlist.dev/e/nycvar.QRO.7.76.6.2108172339080.55%40tvgsbejvaqbjf.bet In-Reply-To: ``` Hi Danh, On Tue, 17 Aug 2021, Đoàn Trần Công Danh wrote: > In t6300, some tests are guarded behind some prerequisites. > Thus, objects created by those tests ain't available if those > prerequisites is unsatistified. Attempting to run "cat-file" > on those objects will run into failure. > > In fact, running t6300 in an environment without gpg(1), > we'll see those warnings: > > fatal: Not a valid object name refs/tags/signed-empty > fatal: Not a valid object name refs/tags/signed-short > fatal: Not a valid object name refs/tags/signed-long > > Let's put those commands into the real tests, in order to: > > * skip their execution if prerequisites aren't satistified. > * check their exit status code > > Signed-off-by: Đoàn Trần Công Danh Makes sense. > --- > t/t6300-for-each-ref.sh | 27 ++++++++++++++++----------- > 1 file changed, 16 insertions(+), 11 deletions(-) > > diff --git a/t/t6300-for-each-ref.sh b/t/t6300-for-each-ref.sh > index 9e0214076b..65fbed2bef 100755 > --- a/t/t6300-for-each-ref.sh > +++ b/t/t6300-for-each-ref.sh > @@ -59,18 +59,23 @@ test_atom() { > # Automatically test "contents:size" atom after testing "contents" > if test "$2" = "contents" > then > - case $(git cat-file -t "$ref") in > - tag) > - # We cannot use $3 as it expects sanitize_pgp to run > - expect=$(git cat-file tag $ref | tail -n +6 | wc -c) ;; Here, we pipe the output of `cat-file` to `tail` and then `wc`. But below: > - tree | blob) > - expect='' ;; > - commit) > - expect=$(printf '%s' "$3" | wc -c) ;; > - esac > - # Leave $expect unquoted to lose possible leading whitespaces > - echo $expect >expected > + expect=$(printf '%s' "$3" | wc -c) > test_expect_${4:-success} $PREREQ "basic atom: $1 contents:size" ' > + type=$(git cat-file -t "$ref") && > + case $type in > + tag) > + # We cannot use $3 as it expects sanitize_pgp to run > + git cat-file tag $ref >out && > + expect=$( + tree | blob) > + expect="" ;; > + commit) > + : "use the calculated expect" ;; This necessarily has to be different from the original code (i.e. the code could not have been moved verbatim) because it uses `$3`, which at this point has a different value. My suggestion: mention this in the commit message, other reviewers or future readers might stumble over this otherwise. > + *) > + BUG "unknown object type" ;; This one is new. Do we need it? Thanks, Dscho > + esac && > + # Leave $expect unquoted to lose possible leading whitespaces > + echo $expect >expected && > git for-each-ref --format="%(contents:size)" "$ref" >actual && > test_cmp expected actual > ' > -- > 2.33.0 > > ``` ## Đoàn Trần Công Danh, 2021-08-18 05:19 Subject: [PATCH v2 0/2] t6300: clear warning when running without gpg Message-ID: URL: https://gitlist.dev/e/cover.1629263759.git.congdanhqx%40gmail.com In-Reply-To: ``` Running t6300 in an environment without gpg(1), we'll see those warnings: fatal: Not a valid object name refs/tags/signed-empty fatal: Not a valid object name refs/tags/signed-short fatal: Not a valid object name refs/tags/signed-long Because, those objects will be created only when GPG is satistified. This series try to clean those errors. Change from v1: * Make 1/2 as near pure-code-move; and * Use 2/2 as a code change to preserve status code for cat-file * Mention reasons that 1/2 couldn't be pure-code-move. Đoàn Trần Công Danh (2): t6300: don't run cat-file on non-existent object t6300: check for cat-file exit status code t/t6300-for-each-ref.sh | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) Range-diff against v1: 1: 6d36f3a8df ! 1: b813d6f2ad t6300: don't run cat-file on non-existent object @@ Commit message * skip their execution if prerequisites aren't satistified. * check their exit status code + The expected value for objects with type: commit needs to be + computed outside the test because we can't relies on "$3" there. + Furthermore, to prevent the accidental usage of that computed + expected value, BUG out on unknown object's type. + Signed-off-by: Đoàn Trần Công Danh ## t/t6300-for-each-ref.sh ## @@ t/t6300-for-each-ref.sh: test_atom() { - esac - # Leave $expect unquoted to lose possible leading whitespaces - echo $expect >expected ++ # for commit leg, $3 is changed there + expect=$(printf '%s' "$3" | wc -c) test_expect_${4:-success} $PREREQ "basic atom: $1 contents:size" ' + type=$(git cat-file -t "$ref") && + case $type in + tag) + # We cannot use $3 as it expects sanitize_pgp to run -+ git cat-file tag $ref >out && -+ expect=$( 2: 68ee769121 t6300: check for cat-file exit status code -- 2.33.0.rc1 ``` ## Đoàn Trần Công Danh, 2021-08-18 05:19 Subject: [PATCH v2 1/2] t6300: don't run cat-file on non-existent object Message-ID: URL: https://gitlist.dev/e/b813d6f2ad96d79a8904ef8b255d4b73ea6567d2.1629263759.git.congdanhqx%40gmail.com In-Reply-To: ``` In t6300, some tests are guarded behind some prerequisites. Thus, objects created by those tests ain't available if those prerequisites is unsatistified. Attempting to run "cat-file" on those objects will run into failure. In fact, running t6300 in an environment without gpg(1), we'll see those warnings: fatal: Not a valid object name refs/tags/signed-empty fatal: Not a valid object name refs/tags/signed-short fatal: Not a valid object name refs/tags/signed-long Let's put those commands into the real tests, in order to: * skip their execution if prerequisites aren't satistified. * check their exit status code The expected value for objects with type: commit needs to be computed outside the test because we can't relies on "$3" there. Furthermore, to prevent the accidental usage of that computed expected value, BUG out on unknown object's type. Signed-off-by: Đoàn Trần Công Danh --- t/t6300-for-each-ref.sh | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/t/t6300-for-each-ref.sh b/t/t6300-for-each-ref.sh index 0d2e062f79..93126341b3 100755 --- a/t/t6300-for-each-ref.sh +++ b/t/t6300-for-each-ref.sh @@ -59,18 +59,23 @@ test_atom() { # Automatically test "contents:size" atom after testing "contents" if test "$2" = "contents" then - case $(git cat-file -t "$ref") in - tag) - # We cannot use $3 as it expects sanitize_pgp to run - expect=$(git cat-file tag $ref | tail -n +6 | wc -c) ;; - tree | blob) - expect='' ;; - commit) - expect=$(printf '%s' "$3" | wc -c) ;; - esac - # Leave $expect unquoted to lose possible leading whitespaces - echo $expect >expected + # for commit leg, $3 is changed there + expect=$(printf '%s' "$3" | wc -c) test_expect_${4:-success} $PREREQ "basic atom: $1 contents:size" ' + type=$(git cat-file -t "$ref") && + case $type in + tag) + # We cannot use $3 as it expects sanitize_pgp to run + expect=$(git cat-file tag $ref | tail -n +6 | wc -c) ;; + tree | blob) + expect="" ;; + commit) + : "use the calculated expect" ;; + *) + BUG "unknown object type" ;; + esac && + # Leave $expect unquoted to lose possible leading whitespaces + echo $expect >expected && git for-each-ref --format="%(contents:size)" "$ref" >actual && test_cmp expected actual ' -- 2.33.0.rc1 ``` ## Đoàn Trần Công Danh, 2021-08-18 05:19 Subject: [PATCH v2 2/2] t6300: check for cat-file exit status code Message-ID: <68ee769121195eb61bb51fd6a27d22a8dddb13b6.1629263759.git.congdanhqx@gmail.com> URL: https://gitlist.dev/e/68ee769121195eb61bb51fd6a27d22a8dddb13b6.1629263759.git.congdanhqx%40gmail.com In-Reply-To: ``` In test_atom(), we're piping the output of cat-file to tail(1), thus, losing its exit status. Let's use a temporary file to preserve git exit status code. Signed-off-by: Đoàn Trần Công Danh --- t/t6300-for-each-ref.sh | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/t/t6300-for-each-ref.sh b/t/t6300-for-each-ref.sh index 93126341b3..cc0f5b6627 100755 --- a/t/t6300-for-each-ref.sh +++ b/t/t6300-for-each-ref.sh @@ -66,7 +66,9 @@ test_atom() { case $type in tag) # We cannot use $3 as it expects sanitize_pgp to run - expect=$(git cat-file tag $ref | tail -n +6 | wc -c) ;; + git cat-file tag $ref >out && + expect=$(tail -n +6 URL: https://gitlist.dev/e/nycvar.QRO.7.76.6.2108181231400.55%40tvgsbejvaqbjf.bet In-Reply-To: ``` Hi Danh, On Wed, 18 Aug 2021, Đoàn Trần Công Danh wrote: > > Running t6300 in an environment without gpg(1), > we'll see those warnings: > > fatal: Not a valid object name refs/tags/signed-empty > fatal: Not a valid object name refs/tags/signed-short > fatal: Not a valid object name refs/tags/signed-long > > Because, those objects will be created only when GPG is satistified. > This series try to clean those errors. > > Change from v1: > * Make 1/2 as near pure-code-move; and > * Use 2/2 as a code change to preserve status code for cat-file > * Mention reasons that 1/2 couldn't be pure-code-move. Thank you for accommodating my concerns so quickly. The code was still so present in my mind that I did not have to go back to remind myself, but it was sufficient to look through the range-diff. This version happily gets my `Reviewed-by:`. Thanks, Dscho > > Đoàn Trần Công Danh (2): > t6300: don't run cat-file on non-existent object > t6300: check for cat-file exit status code > > t/t6300-for-each-ref.sh | 29 ++++++++++++++++++----------- > 1 file changed, 18 insertions(+), 11 deletions(-) > > Range-diff against v1: > 1: 6d36f3a8df ! 1: b813d6f2ad t6300: don't run cat-file on non-existent object > @@ Commit message > * skip their execution if prerequisites aren't satistified. > * check their exit status code > > + The expected value for objects with type: commit needs to be > + computed outside the test because we can't relies on "$3" there. > + Furthermore, to prevent the accidental usage of that computed > + expected value, BUG out on unknown object's type. > + > Signed-off-by: Đoàn Trần Công Danh > > ## t/t6300-for-each-ref.sh ## > @@ t/t6300-for-each-ref.sh: test_atom() { > - esac > - # Leave $expect unquoted to lose possible leading whitespaces > - echo $expect >expected > ++ # for commit leg, $3 is changed there > + expect=$(printf '%s' "$3" | wc -c) > test_expect_${4:-success} $PREREQ "basic atom: $1 contents:size" ' > + type=$(git cat-file -t "$ref") && > + case $type in > + tag) > + # We cannot use $3 as it expects sanitize_pgp to run > -+ git cat-file tag $ref >out && > -+ expect=$( ++ expect=$(git cat-file tag $ref | tail -n +6 | wc -c) ;; > + tree | blob) > + expect="" ;; > + commit) > -: ---------- > 2: 68ee769121 t6300: check for cat-file exit status code > -- > 2.33.0.rc1 > > ``` ## Junio C Hamano, 2021-08-19 20:16 Subject: Re: [PATCH v2 1/2] t6300: don't run cat-file on non-existent object Message-ID: URL: https://gitlist.dev/e/xmqqo89tyyu2.fsf%40gitster.g In-Reply-To: ``` Đoàn Trần Công Danh writes: > In t6300, some tests are guarded behind some prerequisites. > Thus, objects created by those tests ain't available if those > prerequisites is unsatistified. Attempting to run "cat-file" is -> are. > on those objects will run into failure. > > In fact, running t6300 in an environment without gpg(1), > we'll see those warnings: > > fatal: Not a valid object name refs/tags/signed-empty > fatal: Not a valid object name refs/tags/signed-short > fatal: Not a valid object name refs/tags/signed-long > > Let's put those commands into the real tests, in order to: > > * skip their execution if prerequisites aren't satistified. > * check their exit status code > > The expected value for objects with type: commit needs to be > computed outside the test because we can't relies on "$3" there. relies -> rely ``` ## Junio C Hamano, 2021-08-19 20:19 Subject: Re: [PATCH v2 2/2] t6300: check for cat-file exit status code Message-ID: URL: https://gitlist.dev/e/xmqqim01yyox.fsf%40gitster.g In-Reply-To: <68ee769121195eb61bb51fd6a27d22a8dddb13b6.1629263759.git.congdanhqx@gmail.com> ``` Đoàn Trần Công Danh writes: > In test_atom(), we're piping the output of cat-file to tail(1), > thus, losing its exit status. > > Let's use a temporary file to preserve git exit status code. > > Signed-off-by: Đoàn Trần Công Danh > --- > t/t6300-for-each-ref.sh | 4 +++- > 1 file changed, 3 insertions(+), 1 deletion(-) > > diff --git a/t/t6300-for-each-ref.sh b/t/t6300-for-each-ref.sh > index 93126341b3..cc0f5b6627 100755 > --- a/t/t6300-for-each-ref.sh > +++ b/t/t6300-for-each-ref.sh > @@ -66,7 +66,9 @@ test_atom() { > case $type in > tag) > # We cannot use $3 as it expects sanitize_pgp to run > - expect=$(git cat-file tag $ref | tail -n +6 | wc -c) ;; > + git cat-file tag $ref >out && > + expect=$(tail -n +6 + rm -f out ;; > tree | blob) > expect="" ;; > commit) ``` ## Đoàn Trần Công Danh, 2021-08-21 01:36 Subject: [PATCH v3 0/2] t6300: clear warning when running without gpg Message-ID: URL: https://gitlist.dev/e/cover.1629509530.git.congdanhqx%40gmail.com In-Reply-To: ``` Running t6300 in an environment without gpg(1), we'll see those warnings: fatal: Not a valid object name refs/tags/signed-empty fatal: Not a valid object name refs/tags/signed-short fatal: Not a valid object name refs/tags/signed-long Because, those objects will be created only when GPG is satistified. This series try to clean those errors. Change in v3 from v2: * Fix grammar in 1/2 commit's message * Let tail open input file instead of using shell redirection. Change in v2 from v1: * Make 1/2 as near pure-code-move; and * Use 2/2 as a code change to preserve status code for cat-file * Mention reasons that 1/2 couldn't be pure-code-move. Đoàn Trần Công Danh (2): t6300: don't run cat-file on non-existent object t6300: check for cat-file exit status code t/t6300-for-each-ref.sh | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) Range-diff against v2: 1: b813d6f2ad ! 1: b1b9771913 t6300: don't run cat-file on non-existent object @@ Commit message In t6300, some tests are guarded behind some prerequisites. Thus, objects created by those tests ain't available if those - prerequisites is unsatistified. Attempting to run "cat-file" + prerequisites are unsatistified. Attempting to run "cat-file" on those objects will run into failure. In fact, running t6300 in an environment without gpg(1), @@ Commit message * check their exit status code The expected value for objects with type: commit needs to be - computed outside the test because we can't relies on "$3" there. + computed outside the test because we can't rely on "$3" there. Furthermore, to prevent the accidental usage of that computed expected value, BUG out on unknown object's type. 2: 68ee769121 ! 2: 83d532528b t6300: check for cat-file exit status code @@ t/t6300-for-each-ref.sh: test_atom() { # We cannot use $3 as it expects sanitize_pgp to run - expect=$(git cat-file tag $ref | tail -n +6 | wc -c) ;; + git cat-file tag $ref >out && -+ expect=$(tail -n +6 URL: https://gitlist.dev/e/b1b9771913f310829ff142eeb1262a4e8f7e70cb.1629509531.git.congdanhqx%40gmail.com In-Reply-To: ``` In t6300, some tests are guarded behind some prerequisites. Thus, objects created by those tests ain't available if those prerequisites are unsatistified. Attempting to run "cat-file" on those objects will run into failure. In fact, running t6300 in an environment without gpg(1), we'll see those warnings: fatal: Not a valid object name refs/tags/signed-empty fatal: Not a valid object name refs/tags/signed-short fatal: Not a valid object name refs/tags/signed-long Let's put those commands into the real tests, in order to: * skip their execution if prerequisites aren't satistified. * check their exit status code The expected value for objects with type: commit needs to be computed outside the test because we can't rely on "$3" there. Furthermore, to prevent the accidental usage of that computed expected value, BUG out on unknown object's type. Signed-off-by: Đoàn Trần Công Danh --- t/t6300-for-each-ref.sh | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/t/t6300-for-each-ref.sh b/t/t6300-for-each-ref.sh index 0d2e062f79..93126341b3 100755 --- a/t/t6300-for-each-ref.sh +++ b/t/t6300-for-each-ref.sh @@ -59,18 +59,23 @@ test_atom() { # Automatically test "contents:size" atom after testing "contents" if test "$2" = "contents" then - case $(git cat-file -t "$ref") in - tag) - # We cannot use $3 as it expects sanitize_pgp to run - expect=$(git cat-file tag $ref | tail -n +6 | wc -c) ;; - tree | blob) - expect='' ;; - commit) - expect=$(printf '%s' "$3" | wc -c) ;; - esac - # Leave $expect unquoted to lose possible leading whitespaces - echo $expect >expected + # for commit leg, $3 is changed there + expect=$(printf '%s' "$3" | wc -c) test_expect_${4:-success} $PREREQ "basic atom: $1 contents:size" ' + type=$(git cat-file -t "$ref") && + case $type in + tag) + # We cannot use $3 as it expects sanitize_pgp to run + expect=$(git cat-file tag $ref | tail -n +6 | wc -c) ;; + tree | blob) + expect="" ;; + commit) + : "use the calculated expect" ;; + *) + BUG "unknown object type" ;; + esac && + # Leave $expect unquoted to lose possible leading whitespaces + echo $expect >expected && git for-each-ref --format="%(contents:size)" "$ref" >actual && test_cmp expected actual ' -- 2.33.0.254.g68ee769121 ``` ## Đoàn Trần Công Danh, 2021-08-21 01:36 Subject: [PATCH v3 2/2] t6300: check for cat-file exit status code Message-ID: <83d532528bce7cb475833a504a244aa945fe048d.1629509531.git.congdanhqx@gmail.com> URL: https://gitlist.dev/e/83d532528bce7cb475833a504a244aa945fe048d.1629509531.git.congdanhqx%40gmail.com In-Reply-To: ``` In test_atom(), we're piping the output of cat-file to tail(1), thus, losing its exit status. Let's use a temporary file to preserve git exit status code. Signed-off-by: Đoàn Trần Công Danh --- Junio wrote: > It is not wrong per-se, but do we need a redirect '<' here? "tail" > takes filename(s) on the command line, but is there a reason to feed > the contents from the standard input? Well, no reason. In v1, I replaced the left hand side of pipe with out && + expect=$(tail -n +6 out | wc -c) && + rm -f out ;; tree | blob) expect="" ;; commit) -- 2.33.0.254.g68ee769121 ```