From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 41B0AC43334 for ; Sun, 3 Jul 2022 15:49:19 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232624AbiGCPtQ (ORCPT ); Sun, 3 Jul 2022 11:49:16 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:47208 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230446AbiGCPtP (ORCPT ); Sun, 3 Jul 2022 11:49:15 -0400 Received: from mail-wr1-x42d.google.com (mail-wr1-x42d.google.com [IPv6:2a00:1450:4864:20::42d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id ED8FC62E6 for ; Sun, 3 Jul 2022 08:49:13 -0700 (PDT) Received: by mail-wr1-x42d.google.com with SMTP id v14so10049926wra.5 for ; Sun, 03 Jul 2022 08:49:13 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=bzN2urqS60ye2yOJ3jN7br17X0LgQPb95drMSVEZsJE=; b=AjYIKca1ykpZ4u+AZC5fW5BSvRWQRcEikrS7q4sNumqF9rsvPxHy5cHiG79o2bfEb6 bcAvj7waccjwjGh1JFcIN5bLkw0pMFfVYSVWGtRYWzstE7ewnQguH4bIe5qlgfsB/teL mZxSnHFiktWc+BTTSUlJcotw8NI4o71QK2oxFksXRY0s+fmE+DxcHZzTh8MaGYPz+//+ 9LWWtrUo35uT+h5Y4UMcZm/f0lQciUWTt/oETOzTMT0/+xG2EZCm5a12dRwE+hjHK6qx 7I12uyxkTdg4hUDEJXD9sme1WUpdG/Iq6NeS2vWNnypLc+7XcUAJ3P91BL2Q9bBX0vbN ZQhQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=bzN2urqS60ye2yOJ3jN7br17X0LgQPb95drMSVEZsJE=; b=Gj9HiOOMiStU70qSUNTBKwJjp4u3FWfH4QFHTNBW7JtKtt2LWa0V5P45obC7++tZs2 qYc1adYWw8qX6AO4z5rdYnrbLoL3XBa2JZ3ouFiMSI1EzpZcmXhZFkfxcor0zM/HyjOE pNfZotbDm1BoiawMb1zC9W8D4AoA0P0cZjFE2WKBWz12liY7n8YWFRbPcnh43u478MIv Ixydx6FMzqzJAyLb4I3UcOsnLT8aGzssHxRRIjfKEMMI/lejoBDJqXR1mCmdnk6oFEXF vsK5k6sxXam5lO4/0I7g4mQF8rcdFuff2RD+csFXes9NkYkygnpyXS+abVYbCyl/Ksb6 T1Hg== X-Gm-Message-State: AJIora8ibNdgd9mMIrKvK0YDWj/LH1a12g81oIldGwVMwPVP2OydTuSc 6coVvzugVzDMczuZfJAZx4lYOy9h7B4= X-Google-Smtp-Source: AGRyM1vsF4fta7q7rFzXp0BolGDCWCsV61/QIeN9DN+wGe2y7UcbeFB0FG9luXP1MDYBROyfhQID9Q== X-Received: by 2002:a05:6000:1b86:b0:21d:21d2:3e12 with SMTP id r6-20020a0560001b8600b0021d21d23e12mr23206589wru.515.1656863352007; Sun, 03 Jul 2022 08:49:12 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id w17-20020adf8bd1000000b0021a3c960214sm29200093wra.6.2022.07.03.08.49.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 03 Jul 2022 08:49:10 -0700 (PDT) Message-Id: In-Reply-To: References: From: "Li Linchao via GitGitGadget" Date: Sun, 03 Jul 2022 15:49:09 +0000 Subject: [PATCH v6] ls-files: update test style Fcc: Sent Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit MIME-Version: 1.0 To: git@vger.kernel.org Cc: =?UTF-8?Q?=C3=86var_Arnfj=C3=B6r=C3=B0?= Bjarmason , Li Linchao , Li Linchao Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Li Linchao Update test style in t/t30[*].sh for uniformity, that's to keep test title the same line with helper function itself, and fix some indentions. Add a new section "recommended style" in t/README to encourage people to use more modern style in test. Signed-off-by: Li Linchao --- ls-files: update test style Update test style in t/t30[*].sh for uniformity, that's to keep test title the same line with helper function itself. And update t/README to describe this test style. Signed-off-by: Li Linchao lilinchao@oschina.cn Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1269%2FCactusinhand%2Fllc%2Ffix-test-title-style-v6 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1269/Cactusinhand/llc/fix-test-title-style-v6 Pull-Request: https://github.com/gitgitgadget/git/pull/1269 Range-diff vs v5: 1: 6cbb4e5fd49 ! 1: 8dae5a70e22 ls-files: update test style @@ t/README: This test harness library does the following things: + test_cmp expect actual + ' + -+ - Quote or escape the EOF at the head of a here document when -+ there is no variable interpolation in it: -+ -+ cmd <<-"EOF" -+ literal here-doc text -+ EOF -+ -+ Or: ++ - Quote or escape the EOF delimiter that begins a here-document if ++ there is no parameter and other expansion in it, to signal readers ++ that they can skim it more casually: + + cmd <<-\EOF -+ literal here-doc text ++ literal here-document text without any expansion + EOF + + t/README | 55 +++++++++++++++++++ t/t3001-ls-files-others-exclude.sh | 42 +++++++-------- t/t3002-ls-files-dashpath.sh | 86 ++++++++++++++++-------------- t/t3020-ls-files-error-unmatch.sh | 12 ++--- t/t3060-ls-files-with-tree.sh | 8 +-- 5 files changed, 132 insertions(+), 71 deletions(-) diff --git a/t/README b/t/README index 309a31133c6..4f9981cf5e3 100644 --- a/t/README +++ b/t/README @@ -547,6 +547,61 @@ This test harness library does the following things: consistently when command line arguments --verbose (or -v), --debug (or -d), and --immediate (or -i) is given. +Recommended style +----------------- +Here are some recommented styles when writing test case. + + - Keep test title the same line with test helper function itself. + + Take test_expect_success helper for example, write it like: + + test_expect_success 'test title' ' + ... test body ... + ' + + Instead of: + + test_expect_success \ + 'test title' \ + '... test body ...' + + + - End the line with a single quote. + + - Indent the body of here-document, and use "<<-" instead of "<<" + to strip leading TABs used for indentation: + + test_expect_success 'test something' ' + cat >expect <<-\EOF && + one + two + three + EOF + test_something > actual && + test_cmp expect actual + ' + + Instead of: + + test_expect_success 'test something' ' + cat >expect <<\EOF && + one + two + three + EOF + test_something > actual && + test_cmp expect actual + ' + + - Quote or escape the EOF delimiter that begins a here-document if + there is no parameter and other expansion in it, to signal readers + that they can skim it more casually: + + cmd <<-\EOF + literal here-document text without any expansion + EOF + + Do's & don'ts ------------- diff --git a/t/t3001-ls-files-others-exclude.sh b/t/t3001-ls-files-others-exclude.sh index 48cec4e5f88..e07ac6c6dce 100755 --- a/t/t3001-ls-files-others-exclude.sh +++ b/t/t3001-ls-files-others-exclude.sh @@ -67,26 +67,26 @@ echo '!*.2 allignores='.gitignore one/.gitignore one/two/.gitignore' -test_expect_success \ - 'git ls-files --others with various exclude options.' \ - 'git ls-files --others \ +test_expect_success 'git ls-files --others with various exclude options.' ' + git ls-files --others \ --exclude=\*.6 \ --exclude-per-directory=.gitignore \ --exclude-from=.git/ignore \ - >output && - test_cmp expect output' + >output && + test_cmp expect output +' # Test \r\n (MSDOS-like systems) printf '*.1\r\n/*.3\r\n!*.6\r\n' >.gitignore -test_expect_success \ - 'git ls-files --others with \r\n line endings.' \ - 'git ls-files --others \ +test_expect_success 'git ls-files --others with \r\n line endings.' ' + git ls-files --others \ --exclude=\*.6 \ --exclude-per-directory=.gitignore \ --exclude-from=.git/ignore \ - >output && - test_cmp expect output' + >output && + test_cmp expect output +' test_expect_success 'setup skip-worktree gitignore' ' git add $allignores && @@ -94,14 +94,14 @@ test_expect_success 'setup skip-worktree gitignore' ' rm $allignores ' -test_expect_success \ - 'git ls-files --others with various exclude options.' \ - 'git ls-files --others \ +test_expect_success 'git ls-files --others with various exclude options.' ' + git ls-files --others \ --exclude=\*.6 \ --exclude-per-directory=.gitignore \ --exclude-from=.git/ignore \ - >output && - test_cmp expect output' + >output && + test_cmp expect output +' test_expect_success !SANITIZE_LEAK 'restore gitignore' ' git checkout --ignore-skip-worktree-bits $allignores && @@ -283,12 +283,12 @@ test_expect_success 'pattern matches prefix completely' ' ' test_expect_success 'ls-files with "**" patterns' ' - cat <<\EOF >expect && -a.1 -one/a.1 -one/two/a.1 -three/a.1 -EOF + cat <<-\EOF >expect && + a.1 + one/a.1 + one/two/a.1 + three/a.1 + EOF git ls-files -o -i --exclude "**/a.1" >actual && test_cmp expect actual ' diff --git a/t/t3002-ls-files-dashpath.sh b/t/t3002-ls-files-dashpath.sh index 54d22a45dfb..4dd24550eba 100755 --- a/t/t3002-ls-files-dashpath.sh +++ b/t/t3002-ls-files-dashpath.sh @@ -16,56 +16,62 @@ filesystem. TEST_PASSES_SANITIZE_LEAK=true . ./test-lib.sh -test_expect_success \ - setup \ - 'echo frotz >path0 && +test_expect_success 'setup' ' + echo frotz >path0 && echo frotz >./-foo && - echo frotz >./--' + echo frotz >./-- +' -test_expect_success \ - 'git ls-files without path restriction.' \ - 'git ls-files --others >output && - test_cmp output - <output && + cat >expect <<-\EOF && + -- + -foo + output + path0 + EOF + test_cmp output expect ' -test_expect_success \ - 'git ls-files with path restriction.' \ - 'git ls-files --others path0 >output && - test_cmp output - <output && + cat >expect <<-\EOF && + path0 + EOF + test_cmp output expect ' -test_expect_success \ - 'git ls-files with path restriction with --.' \ - 'git ls-files --others -- path0 >output && - test_cmp output - <output && + cat >expect <<-\EOF && + path0 + EOF + test_cmp output expect ' -test_expect_success \ - 'git ls-files with path restriction with -- --.' \ - 'git ls-files --others -- -- >output && - test_cmp output - <output && + cat >expect <<-\EOF && + -- + EOF + test_cmp output expect ' -test_expect_success \ - 'git ls-files with no path restriction.' \ - 'git ls-files --others -- >output && - test_cmp output - <output && + cat >expect <<-\EOF && + -- + -foo + output + path0 + EOF + test_cmp output expect + ' test_done diff --git a/t/t3020-ls-files-error-unmatch.sh b/t/t3020-ls-files-error-unmatch.sh index 2cbcbc0721b..133593d23c0 100755 --- a/t/t3020-ls-files-error-unmatch.sh +++ b/t/t3020-ls-files-error-unmatch.sh @@ -19,12 +19,12 @@ test_expect_success 'setup' ' git commit -m "add foo bar" ' -test_expect_success \ - 'git ls-files --error-unmatch should fail with unmatched path.' \ - 'test_must_fail git ls-files --error-unmatch foo bar-does-not-match' +test_expect_success 'git ls-files --error-unmatch should fail with unmatched path.' ' + test_must_fail git ls-files --error-unmatch foo bar-does-not-match +' -test_expect_success \ - 'git ls-files --error-unmatch should succeed with matched paths.' \ - 'git ls-files --error-unmatch foo bar' +test_expect_success 'git ls-files --error-unmatch should succeed with matched paths.' ' + git ls-files --error-unmatch foo bar +' test_done diff --git a/t/t3060-ls-files-with-tree.sh b/t/t3060-ls-files-with-tree.sh index b257c792a46..52f76f7b57f 100755 --- a/t/t3060-ls-files-with-tree.sh +++ b/t/t3060-ls-files-with-tree.sh @@ -10,7 +10,7 @@ a scenario known to trigger a crash with some versions of git. ' . ./test-lib.sh -test_expect_success setup ' +test_expect_success 'setup' ' # The bug we are exercising requires a fair number of entries # in a sub-directory so that add_index_entry will trigger a @@ -62,9 +62,9 @@ test_expect_success 'git ls-files --with-tree should succeed from subdir' ' ) ' -test_expect_success \ - 'git ls-files --with-tree should add entries from named tree.' \ - 'test_cmp expected output' +test_expect_success 'git ls-files --with-tree should add entries from named tree.' ' + test_cmp expected output +' test_expect_success 'no duplicates in --with-tree output' ' git ls-files --with-tree=HEAD >actual && base-commit: e4a4b31577c7419497ac30cebe30d755b97752c5 -- gitgitgadget