From patchwork Tue May 5 11:43:02 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Denton Liu X-Patchwork-Id: 11528849 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id D5230139F for ; Tue, 5 May 2020 11:43:15 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id AC99A20757 for ; Tue, 5 May 2020 11:43:15 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="bT1JHT9Q" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728868AbgEELnP (ORCPT ); Tue, 5 May 2020 07:43:15 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53138 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-FAIL-OK-FAIL) by vger.kernel.org with ESMTP id S1728624AbgEELnN (ORCPT ); Tue, 5 May 2020 07:43:13 -0400 Received: from mail-qk1-x744.google.com (mail-qk1-x744.google.com [IPv6:2607:f8b0:4864:20::744]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 19C41C061A0F for ; Tue, 5 May 2020 04:43:13 -0700 (PDT) Received: by mail-qk1-x744.google.com with SMTP id q7so1892779qkf.3 for ; Tue, 05 May 2020 04:43:13 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=pkcGdPBdua1X2EXqM/AoaTnD2RpZR5Ucx47Ou937swE=; b=bT1JHT9Q+zIqcEPeTbEZYg/T0d+usypoYRkfxOni4Ty92J1f8PwtcvflhR6LFEuU9j bhwNkYK+mMOFPJxiwNRj0je9vUQi/sDcCvj1t2Mc71WMWuI+sSvevsnvKt/WDUIz5pSR 6nQYNdaib+Un/ghd2I1Hfmu+Bdz7sdKLbRKRbjEbEqwUxgXUOFcEjMQwA3bDYdy/eFO3 rxlnVma9XSJXAmIbfMZ6Mu2Vrg/HT8/ufWGhe5zlszMkUi+/nNarbtJ+y0iDaGvZBURJ W3kzpr/a2ctpSZN7CcvNKX3jBK8t3HH9gPwqd5N8svNwf4Jdh/n4KX+1a42c7vT4PVCT FiTQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=pkcGdPBdua1X2EXqM/AoaTnD2RpZR5Ucx47Ou937swE=; b=fm59/QQzRA7BJiBUeW8rlObON+95KEgRuHVAcDQpYHCE0YruX7RBSGG6z0a7bDKWdw ywhEHU5BW7McYAN4TLpaN2gUA3sjDYGFnuBDayGhdr8xM71RzdDGWpSaT2F5GapLNIuJ B2Sj3ikQ4cDu0cdzQfU0C3Xxt4RIFXRn8BPSPTTvytLgbZ7uyJr10e0G6DOKC4/pyLqh HC3vjjfZxMIT+LdjkFbWqChca/SIsu8VuFavMhEOtv6HDcdVGCfLFenTkDiXuATmo5R5 Z80U64XUNXZJvxeS9FcH0umOu/P9C0zUC1ZIwcwKPCjWv4nMcQjE72kzFPyGBDL7yW/h DGWw== X-Gm-Message-State: AGi0PubILofUInMaGeorUqQ8+PwWkHCmcEiI8aCUxeGxE0h808YalZ+6 RHc/2kbxvl8/dW4HJcFZ8v/u+icJ X-Google-Smtp-Source: APiQypLAvIqYKM8hn+C3eOlMpvV6zjgfPracRX+E+bpeaXJ2rHmgiw2j/ZBAjLD/D2Tx6QAe3wI9ZQ== X-Received: by 2002:a37:61d8:: with SMTP id v207mr3122279qkb.146.1588678991808; Tue, 05 May 2020 04:43:11 -0700 (PDT) Received: from archbookpro.localdomain (CPE18593399858a-CM185933998587.cpe.net.cable.rogers.com. [174.112.65.113]) by smtp.gmail.com with ESMTPSA id m33sm1470659qte.17.2020.05.05.04.43.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 05 May 2020 04:43:10 -0700 (PDT) From: Denton Liu To: Git Mailing List Cc: Junio C Hamano Subject: [PATCH v1.2] lib-submodule-update: pass OVERWRITING_FAIL Date: Tue, 5 May 2020 07:43:02 -0400 Message-Id: X-Mailer: git-send-email 2.26.2.548.gbb00c8a0a9 In-Reply-To: References: MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org We are using `test_must_fail $command`. However, $command is not necessarily a git command; it could be a test helper function. In an effort to stop using test_must_fail with non-git commands, instead of invoking `test_must_fail $command`, run `OVERWRITING_FAIL=test_must_fail $command` instead in test_submodule_switch_common(). In the case where $command is a git command, test_submodule_switch_common() is called by one of test_submodule_switch() or test_submodule_forced_switch(). In those two functions, pass $command like this: test_submodule_switch_common "eval \$OVERWRITING_FAIL git $command" When $command is a helper function, the parent function calling test_submodule_switch_common() is test_submodule_switch_func(). For all test_submodule_switch_func() invocations, increase the granularity of the argument test helper function by prefixing the git invocation which is meant to fail with $OVERWRITING_FAIL like this: $OVERWRITING_FAIL git checkout "$1" This is useful because currently, when we run a test helper function, we just mark the whole thing as `test_must_fail`. However, it's possible that the helper function might fail earlier or later than expected due to an introduced bug. If this happens, then the test case will still report as passing but it should really be marked as failing since it didn't actually display the intended behaviour. While we're at it, some helper functions have git commands piping into another git command. Break these pipes up into two separate invocations with a file buffer so that the return code of the first command is not lost. This patch can be better viewed with `--ignore-all-space`. Signed-off-by: Denton Liu --- Changes since v1.1: * unset OVERWRITING_FAIL in more places that I missed earlier * clarify that the helper functions passed to test_submodule_switch_func() are the ones that have been modified (I'm not 100% if I understood your complaint with the text so perhaps the commit message may still need further refinement) t/lib-submodule-update.sh | 33 +++++++++++++++++++++++++-------- t/t3426-rebase-submodule.sh | 4 ++-- t/t3513-revert-submodule.sh | 20 ++++++++++++-------- t/t3906-stash-submodule.sh | 15 +++++++++------ t/t4137-apply-submodule.sh | 6 ++++-- t/t4255-am-submodule.sh | 6 ++++-- t/t5572-pull-submodule.sh | 8 ++++---- t/t6041-bisect-submodule.sh | 33 ++++++++++++++++++--------------- 8 files changed, 78 insertions(+), 47 deletions(-) diff --git a/t/lib-submodule-update.sh b/t/lib-submodule-update.sh index cd80d77707..67d9d8615a 100644 --- a/t/lib-submodule-update.sh +++ b/t/lib-submodule-update.sh @@ -304,12 +304,15 @@ test_submodule_content () { # a removed submodule. # # Removing a submodule containing a .git directory must fail even when forced -# to protect the history! +# to protect the history! If we are testing this case, +# OVERWRITING_FAIL=test_must_fail, otherwise OVERWRITING_FAIL will be the empty +# string. # # Internal function; use test_submodule_switch_func(), test_submodule_switch_func(), # or test_submodule_forced_switch() instead. test_submodule_switch_common () { + OVERWRITING_FAIL= command="$1" ######################### Appearing submodule ######################### # Switching to a commit letting a submodule appear creates empty dir ... @@ -443,7 +446,9 @@ test_submodule_switch_common () { ( cd submodule_update && git branch -t replace_sub1_with_directory origin/replace_sub1_with_directory && - test_must_fail $command replace_sub1_with_directory && + OVERWRITING_FAIL=test_must_fail && + $command replace_sub1_with_directory && + OVERWRITING_FAIL= && test_superproject_content origin/add_sub1 && test_submodule_content sub1 origin/add_sub1 ) @@ -456,7 +461,9 @@ test_submodule_switch_common () { cd submodule_update && git branch -t replace_sub1_with_directory origin/replace_sub1_with_directory && replace_gitfile_with_git_dir sub1 && - test_must_fail $command replace_sub1_with_directory && + OVERWRITING_FAIL=test_must_fail && + $command replace_sub1_with_directory && + OVERWRITING_FAIL= && test_superproject_content origin/add_sub1 && test_git_directory_is_unchanged sub1 && test_submodule_content sub1 origin/add_sub1 @@ -470,7 +477,9 @@ test_submodule_switch_common () { ( cd submodule_update && git branch -t replace_sub1_with_file origin/replace_sub1_with_file && - test_must_fail $command replace_sub1_with_file && + OVERWRITING_FAIL=test_must_fail && + $command replace_sub1_with_file && + OVERWRITING_FAIL= && test_superproject_content origin/add_sub1 && test_submodule_content sub1 origin/add_sub1 ) @@ -484,7 +493,9 @@ test_submodule_switch_common () { cd submodule_update && git branch -t replace_sub1_with_file origin/replace_sub1_with_file && replace_gitfile_with_git_dir sub1 && - test_must_fail $command replace_sub1_with_file && + OVERWRITING_FAIL=test_must_fail && + $command replace_sub1_with_file && + OVERWRITING_FAIL= && test_superproject_content origin/add_sub1 && test_git_directory_is_unchanged sub1 && test_submodule_content sub1 origin/add_sub1 @@ -559,6 +570,11 @@ test_submodule_switch_common () { # conditions, set the appropriate KNOWN_FAILURE_* variable used in the tests # below to 1. # +# Removing a submodule containing a .git directory must fail even when forced +# to protect the history! If we are testing this case, +# OVERWRITING_FAIL=test_must_fail, otherwise OVERWRITING_FAIL will be the empty +# string. +# # Use as follows: # # my_func () { @@ -568,6 +584,7 @@ test_submodule_switch_common () { # } # test_submodule_switch_func "my_func" test_submodule_switch_func () { + OVERWRITING_FAIL= command="$1" test_submodule_switch_common "$command" @@ -580,7 +597,7 @@ test_submodule_switch_func () { cd submodule_update && git branch -t add_sub1 origin/add_sub1 && >sub1 && - test_must_fail $command add_sub1 && + OVERWRITING_FAIL=test_must_fail $command add_sub1 && test_superproject_content origin/no_submodule && test_must_be_empty sub1 ) @@ -588,7 +605,7 @@ test_submodule_switch_func () { } test_submodule_switch () { - test_submodule_switch_func "git $1" + test_submodule_switch_func "eval \$OVERWRITING_FAIL git $1" } # Same as test_submodule_switch(), except that throwing away local changes in @@ -596,7 +613,7 @@ test_submodule_switch () { test_submodule_forced_switch () { command="$1" KNOWN_FAILURE_FORCED_SWITCH_TESTS=1 - test_submodule_switch_common "git $command" + test_submodule_switch_common "eval \$OVERWRITING_FAIL git $command" # When forced, a file in the superproject does not prevent creating a # submodule of the same name. diff --git a/t/t3426-rebase-submodule.sh b/t/t3426-rebase-submodule.sh index 788605ccc0..c6a7f584ed 100755 --- a/t/t3426-rebase-submodule.sh +++ b/t/t3426-rebase-submodule.sh @@ -17,7 +17,7 @@ git_rebase () { git status -su >actual && ls -1pR * >>actual && test_cmp expect actual && - git rebase "$1" + $OVERWRITING_FAIL git rebase "$1" } test_submodule_switch_func "git_rebase" @@ -35,7 +35,7 @@ git_rebase_interactive () { test_cmp expect actual && set_fake_editor && echo "fake-editor.sh" >.git/info/exclude && - git rebase -i "$1" + $OVERWRITING_FAIL git rebase -i "$1" } test_submodule_switch_func "git_rebase_interactive" diff --git a/t/t3513-revert-submodule.sh b/t/t3513-revert-submodule.sh index 95a7f64471..6c899db7e1 100755 --- a/t/t3513-revert-submodule.sh +++ b/t/t3513-revert-submodule.sh @@ -15,14 +15,18 @@ git_revert () { git status -su >expect && ls -1pR * >>expect && tar cf "$TRASH_DIRECTORY/tmp.tar" * && - git checkout "$1" && - git revert HEAD && - rm -rf * && - tar xf "$TRASH_DIRECTORY/tmp.tar" && - git status -su >actual && - ls -1pR * >>actual && - test_cmp expect actual && - git revert HEAD + $OVERWRITING_FAIL git checkout "$1" && + if test -z "$OVERWRITING_FAIL" + then + git checkout "$1" && + git revert HEAD && + rm -rf * && + tar xf "$TRASH_DIRECTORY/tmp.tar" && + git status -su >actual && + ls -1pR * >>actual && + test_cmp expect actual && + git revert HEAD + fi } KNOWN_FAILURE_NOFF_MERGE_DOESNT_CREATE_EMPTY_SUBMODULE_DIR=1 diff --git a/t/t3906-stash-submodule.sh b/t/t3906-stash-submodule.sh index 6a7e801ca0..860940072d 100755 --- a/t/t3906-stash-submodule.sh +++ b/t/t3906-stash-submodule.sh @@ -8,12 +8,15 @@ test_description='stash can handle submodules' git_stash () { git status -su >expect && ls -1pR * >>expect && - git read-tree -u -m "$1" && - git stash && - git status -su >actual && - ls -1pR * >>actual && - test_cmp expect actual && - git stash apply + $OVERWRITING_FAIL git read-tree -u -m "$1" && + if test -z "$OVERWRITING_FAIL" + then + git stash && + git status -su >actual && + ls -1pR * >>actual && + test_cmp expect actual && + git stash apply + fi } KNOWN_FAILURE_STASH_DOES_IGNORE_SUBMODULE_CHANGES=1 diff --git a/t/t4137-apply-submodule.sh b/t/t4137-apply-submodule.sh index b645e303a0..dd08d9e1a4 100755 --- a/t/t4137-apply-submodule.sh +++ b/t/t4137-apply-submodule.sh @@ -6,13 +6,15 @@ test_description='git apply handling submodules' . "$TEST_DIRECTORY"/lib-submodule-update.sh apply_index () { - git diff --ignore-submodules=dirty "..$1" | git apply --index - + git diff --ignore-submodules=dirty "..$1" >diff && + $OVERWRITING_FAIL git apply --index - diff && + $OVERWRITING_FAIL git apply --3way - patch && + $OVERWRITING_FAIL git am - patch && + $OVERWRITING_FAIL git am --3way - >expect && tar cf "$TRASH_DIRECTORY/tmp.tar" * && GOOD=$(git rev-parse --verify HEAD) && - git checkout "$1" && - echo "foo" >bar && - git add bar && - git commit -m "bisect bad" && - BAD=$(git rev-parse --verify HEAD) && - git reset --hard HEAD^^ && - git submodule update && - git bisect start && - git bisect good $GOOD && - rm -rf * && - tar xf "$TRASH_DIRECTORY/tmp.tar" && - git status -su >actual && - ls -1pR * >>actual && - test_cmp expect actual && - git bisect bad $BAD + $OVERWRITING_FAIL git checkout "$1" && + if test -z "$OVERWRITING_FAIL" + then + echo "foo" >bar && + git add bar && + git commit -m "bisect bad" && + BAD=$(git rev-parse --verify HEAD) && + git reset --hard HEAD^^ && + git submodule update && + git bisect start && + git bisect good $GOOD && + rm -rf * && + tar xf "$TRASH_DIRECTORY/tmp.tar" && + git status -su >actual && + ls -1pR * >>actual && + test_cmp expect actual && + git bisect bad $BAD + fi } test_submodule_switch_func "git_bisect"