| Message ID | 9589f2a6e495034cc4f45bd0bce80dedfcd30f16.1661992197.git.gitgitgadget@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 23a14f301662df6d003b5bf4dc598f02311c6b30 |
| Headers | show |
| Series | make test "linting" more comprehensive | expand |
On Wed, Aug 31, 2022 at 5:30 PM Eric Sunshine via GitGitGadget <gitgitgadget@gmail.com> wrote: > > From: Eric Sunshine <sunshine@sunshineco.com> > > By automatically invoking chainlint.sed upon each test it runs, > `test_run_` in test-lib.sh ensures that broken &&-chains will be > detected early as tests are modified or new are tests created since it s/new are tests created/new tests are created/ ? > is typical to run a test script manually (i.e. `./t1234-test-script.sh`) > during test development. Now that the implementation of chainlint.pl is > complete, modify test-lib.sh to invoke it automatically instead of > chainlint.sed each time a test script is run. > > This change reduces the number of "linter" invocations from 26800+ (once > per test run) down to 1050+ (once per test script), however, a > subsequent change will drop the number of invocations to 1 per `make > test`, thus fully realizing the benefit of the new linter. > > Note that the "magic exit code 117" &&-chain checker added by bb79af9d09 > (t/test-lib: introduce --chain-lint option, 2015-03-20) which is built > into t/test-lib.sh is retained since it has near zero-cost and > (theoretically) may catch a broken &&-chain not caught by chainlint.pl. > > Signed-off-by: Eric Sunshine <sunshine@sunshineco.com> > --- > contrib/buildsystems/CMakeLists.txt | 2 +- > t/test-lib.sh | 9 +++++++-- > 2 files changed, 8 insertions(+), 3 deletions(-) > > diff --git a/contrib/buildsystems/CMakeLists.txt b/contrib/buildsystems/CMakeLists.txt > index 2237109b57f..ca358a21a5f 100644 > --- a/contrib/buildsystems/CMakeLists.txt > +++ b/contrib/buildsystems/CMakeLists.txt > @@ -1076,7 +1076,7 @@ if(NOT ${CMAKE_BINARY_DIR}/CMakeCache.txt STREQUAL ${CACHE_PATH}) > "string(REPLACE \"\${GIT_BUILD_DIR_REPL}\" \"GIT_BUILD_DIR=\\\"$TEST_DIRECTORY/../${BUILD_DIR_RELATIVE}\\\"\" content \"\${content}\")\n" > "file(WRITE ${CMAKE_SOURCE_DIR}/t/test-lib.sh \${content})") > #misc copies > - file(COPY ${CMAKE_SOURCE_DIR}/t/chainlint.sed DESTINATION ${CMAKE_BINARY_DIR}/t/) > + file(COPY ${CMAKE_SOURCE_DIR}/t/chainlint.pl DESTINATION ${CMAKE_BINARY_DIR}/t/) > file(COPY ${CMAKE_SOURCE_DIR}/po/is.po DESTINATION ${CMAKE_BINARY_DIR}/po/) > file(COPY ${CMAKE_SOURCE_DIR}/mergetools/tkdiff DESTINATION ${CMAKE_BINARY_DIR}/mergetools/) > file(COPY ${CMAKE_SOURCE_DIR}/contrib/completion/git-prompt.sh DESTINATION ${CMAKE_BINARY_DIR}/contrib/completion/) > diff --git a/t/test-lib.sh b/t/test-lib.sh > index dc0d0591095..a65df2fd220 100644 > --- a/t/test-lib.sh > +++ b/t/test-lib.sh > @@ -1091,8 +1091,7 @@ test_run_ () { > trace= > # 117 is magic because it is unlikely to match the exit > # code of other programs > - if $(printf '%s\n' "$1" | sed -f "$GIT_BUILD_DIR/t/chainlint.sed" | grep -q '?![A-Z][A-Z]*?!') || > - test "OK-117" != "$(test_eval_ "(exit 117) && $1${LF}${LF}echo OK-\$?" 3>&1)" > + if test "OK-117" != "$(test_eval_ "(exit 117) && $1${LF}${LF}echo OK-\$?" 3>&1)" > then > BUG "broken &&-chain or run-away HERE-DOC: $1" > fi > @@ -1588,6 +1587,12 @@ then > BAIL_OUT_ENV_NEEDS_SANITIZE_LEAK "GIT_TEST_SANITIZE_LEAK_LOG=true" > fi > > +if test "${GIT_TEST_CHAIN_LINT:-1}" != 0 > +then > + "$PERL_PATH" "$TEST_DIRECTORY/chainlint.pl" "$0" || > + BUG "lint error (see '?!...!? annotations above)" > +fi > + > # Last-minute variable setup > USER_HOME="$HOME" > HOME="$TRASH_DIRECTORY" > -- > gitgitgadget >
On Sat, Sep 3, 2022 at 1:07 AM Elijah Newren <newren@gmail.com> wrote: > On Wed, Aug 31, 2022 at 5:30 PM Eric Sunshine via GitGitGadget > > By automatically invoking chainlint.sed upon each test it runs, > > `test_run_` in test-lib.sh ensures that broken &&-chains will be > > detected early as tests are modified or new are tests created since it > > s/new are tests created/new tests are created/ ? That does sound better (except perhaps to Yoda).
diff --git a/contrib/buildsystems/CMakeLists.txt b/contrib/buildsystems/CMakeLists.txt index 2237109b57f..ca358a21a5f 100644 --- a/contrib/buildsystems/CMakeLists.txt +++ b/contrib/buildsystems/CMakeLists.txt @@ -1076,7 +1076,7 @@ if(NOT ${CMAKE_BINARY_DIR}/CMakeCache.txt STREQUAL ${CACHE_PATH}) "string(REPLACE \"\${GIT_BUILD_DIR_REPL}\" \"GIT_BUILD_DIR=\\\"$TEST_DIRECTORY/../${BUILD_DIR_RELATIVE}\\\"\" content \"\${content}\")\n" "file(WRITE ${CMAKE_SOURCE_DIR}/t/test-lib.sh \${content})") #misc copies - file(COPY ${CMAKE_SOURCE_DIR}/t/chainlint.sed DESTINATION ${CMAKE_BINARY_DIR}/t/) + file(COPY ${CMAKE_SOURCE_DIR}/t/chainlint.pl DESTINATION ${CMAKE_BINARY_DIR}/t/) file(COPY ${CMAKE_SOURCE_DIR}/po/is.po DESTINATION ${CMAKE_BINARY_DIR}/po/) file(COPY ${CMAKE_SOURCE_DIR}/mergetools/tkdiff DESTINATION ${CMAKE_BINARY_DIR}/mergetools/) file(COPY ${CMAKE_SOURCE_DIR}/contrib/completion/git-prompt.sh DESTINATION ${CMAKE_BINARY_DIR}/contrib/completion/) diff --git a/t/test-lib.sh b/t/test-lib.sh index dc0d0591095..a65df2fd220 100644 --- a/t/test-lib.sh +++ b/t/test-lib.sh @@ -1091,8 +1091,7 @@ test_run_ () { trace= # 117 is magic because it is unlikely to match the exit # code of other programs - if $(printf '%s\n' "$1" | sed -f "$GIT_BUILD_DIR/t/chainlint.sed" | grep -q '?![A-Z][A-Z]*?!') || - test "OK-117" != "$(test_eval_ "(exit 117) && $1${LF}${LF}echo OK-\$?" 3>&1)" + if test "OK-117" != "$(test_eval_ "(exit 117) && $1${LF}${LF}echo OK-\$?" 3>&1)" then BUG "broken &&-chain or run-away HERE-DOC: $1" fi @@ -1588,6 +1587,12 @@ then BAIL_OUT_ENV_NEEDS_SANITIZE_LEAK "GIT_TEST_SANITIZE_LEAK_LOG=true" fi +if test "${GIT_TEST_CHAIN_LINT:-1}" != 0 +then + "$PERL_PATH" "$TEST_DIRECTORY/chainlint.pl" "$0" || + BUG "lint error (see '?!...!? annotations above)" +fi + # Last-minute variable setup USER_HOME="$HOME" HOME="$TRASH_DIRECTORY"