@matheusbsbs / matheus-bagliano / commits / 956d2e4639

tests: add a test mode for SANITIZE=leak, run it in CI

While git can be compiled with SANITIZE=leak, we have not run regression tests under that mode. Memory leaks have only been fixed as one-offs without structured regression testing. This change adds CI testing for it. We'll now build and small set of whitelisted t00*.sh tests under Linux with a new job called "linux-leaks". The CI target uses a new GIT_TEST_PASSING_SANITIZE_LEAK=true test mode. When running in that mode, we'll assert that we were compiled with SANITIZE=leak. We'll then skip all tests, except those that we've opted-in by setting "TEST_PASSES_SANITIZE_LEAK=true". A test setting "TEST_PASSES_SANITIZE_LEAK=true" setting can in turn make use of the "SANITIZE_LEAK" prerequisite, should they wish to selectively skip tests even under "GIT_TEST_PASSING_SANITIZE_LEAK=true". In the preceding commit we started doing this in "t0004-unwritable.sh" under SANITIZE=leak, now it'll combine nicely with "GIT_TEST_PASSING_SANITIZE_LEAK=true". This is how tests that don't set "TEST_PASSES_SANITIZE_LEAK=true" will be skipped under GIT_TEST_PASSING_SANITIZE_LEAK=true: $ GIT_TEST_PASSING_SANITIZE_LEAK=true ./t0001-init.sh 1..0 # SKIP skip all tests in t0001 under SANITIZE=leak, TEST_PASSES_SANITIZE_LEAK not set The intent is to add more TEST_PASSES_SANITIZE_LEAK=true annotations as follow-up change, but let's start small to begin with. In ci/run-build-and-tests.sh we make use of the default "*" case to run "make test" without any GIT_TEST_* modes. SANITIZE=leak is known to fail in combination with GIT_TEST_SPLIT_INDEX=true in t0016-oidmap.sh, and we're likely to have other such failures in various GIT_TEST_* modes. Let's focus on getting the base tests passing, we can expand coverage to GIT_TEST_* modes later. It would also be possible to implement a more lightweight version of this by only relying on setting "LSAN_OPTIONS". See <YS9OT/pn5rRK9cGB@coredump.intra.peff.net>[1] and <YS9ZIDpANfsh7N+S@coredump.intra.peff.net>[2] for a discussion of that. I've opted for this approach of adding a GIT_TEST_* mode instead because it's consistent with how we handle other special test modes. Being able to add a "!SANITIZE_LEAK" prerequisite and calling "test_done" early if it isn't satisfied also means that we can more incrementally add regression tests without being forced to fix widespread and hard-to-fix leaks at the same time. We have tests that do simple checking of some tool we're interested in, but later on in the script might be stressing trace2, or common sources of leaks like "git log" in combination with the tool (e.g. the commit-graph tests). To be clear having a prerequisite could also be accomplished by using "LSAN_OPTIONS" directly. On the topic of "LSAN_OPTIONS": It would be nice to have a mode to aggregate all failures in our various scripts, see [2] for a start at doing that which sets "log_path" in "LSAN_OPTIONS". I've punted on that for now, it can be added later. As of writing this we've got major regressions between master..seen, i.e. the t000*.sh tests and more fixed since 31f9acf9ce2 (Merge branch 'ah/plugleaks', 2021-08-04) have regressed recently. See the discussion at <87czsv2idy.fsf@evledraar.gmail.com>[3] about the lack of this sort of test mode, and 0e5bba53af (add UNLEAK annotation for reducing leak false positives, 2017-09-08) for the initial addition of SANITIZE=leak. See also 09595ab381 (Merge branch 'jk/leak-checkers', 2017-09-19), 7782066f67 (Merge branch 'jk/apache-lsan', 2019-05-19) and the recent 936e58851a (Merge branch 'ah/plugleaks', 2021-05-07) for some of the past history of "one-off" SANITIZE=leak (and more) fixes. As noted in [5] we can't support this on OSX yet until Clang 14 is released, at that point we'll probably want to resurrect that "osx-leaks" job. 1. https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer 2. https://lore.kernel.org/git/YS9OT%2Fpn5rRK9cGB@coredump.intra.peff.net/ 3. https://lore.kernel.org/git/87czsv2idy.fsf@evledraar.gmail.com/ 4. https://lore.kernel.org/git/YS9ZIDpANfsh7N+S@coredump.intra.peff.net/ 5. https://lore.kernel.org/git/20210916035603.76369-1-carenas@gmail.com/ Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Carlo Marcelo Arenas Belón <carenas@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Ævar Arnfjörð Bjarmason committed Sep 23, 2021 at 11:20 UTC 956d2e4639bfbcac49e7c173f603d24985d7df23

13 files changed +49 -2

.github/workflows/main.yml

@@ -232,6 +232,9 @@ jobs:

232 - jobname: linux-gcc-default

233 cc: gcc

234 pool: ubuntu-latest

235 + - jobname: linux-leaks

236 + cc: gcc

237 + pool: ubuntu-latest

238 env:

239 CC: ${{matrix.vector.cc}}

240 jobname: ${{matrix.vector.jobname}}

ci/install-dependencies.sh

+1 -1

@@ -12,7 +12,7 @@ UBUNTU_COMMON_PKGS="make libssl-dev libcurl4-openssl-dev libexpat-dev

12 libemail-valid-perl libio-socket-ssl-perl libnet-smtp-ssl-perl"

14 case "$jobname" in

15 -linux-clang|linux-gcc)

15 +linux-clang|linux-gcc|linux-leaks)

16 sudo apt-add-repository -y "ppa:ubuntu-toolchain-r/test"

17 sudo apt-get -q update

18 sudo apt-get -q -y install language-pack-is libsvn-perl apache2 \

ci/lib.sh

+8 -1

@@ -183,7 +183,7 @@ export GIT_TEST_CLONE_2GB=true

183 export SKIP_DASHED_BUILT_INS=YesPlease

184

185 case "$jobname" in

186 -linux-clang|linux-gcc)

186 +linux-clang|linux-gcc|linux-leaks)

187 if [ "$jobname" = linux-gcc ]

188 then

189 export CC=gcc-8

@@ -233,4 +233,11 @@ linux-musl)

233 ;;

234 esac

235

236 +case "$jobname" in

237 +linux-leaks)

238 + export SANITIZE=leak

239 + export GIT_TEST_PASSING_SANITIZE_LEAK=true

240 + ;;

241 +esac

242 +

243 MAKEFLAGS="$MAKEFLAGS CC=${CC:-cc}"

t/README

@@ -366,6 +366,13 @@ excluded as so much relies on it, but this might change in the future.

366 GIT_TEST_SPLIT_INDEX=<boolean> forces split-index mode on the whole

367 test suite. Accept any boolean values that are accepted by git-config.

368

369 +GIT_TEST_PASSING_SANITIZE_LEAK=<boolean> when compiled with

370 +SANITIZE=leak will run only those tests that have whitelisted

371 +themselves as passing with no memory leaks. Tests can be whitelisted

372 +by setting "TEST_PASSES_SANITIZE_LEAK=true" before sourcing

373 +"test-lib.sh" itself at the top of the test script. This test mode is

374 +used by the "linux-leaks" CI target.

375 +

376 GIT_TEST_PROTOCOL_VERSION=<n>, when set, makes 'protocol.version'

377 default to n.

378

t/t0004-unwritable.sh

@@ -2,6 +2,7 @@

3 test_description='detect unwritable repository and fail correctly'

5 +TEST_PASSES_SANITIZE_LEAK=true

6 . ./test-lib.sh

8 test_expect_success setup '

t/t0011-hashmap.sh

@@ -1,6 +1,8 @@

1 #!/bin/sh

3 test_description='test hashmap and string hash functions'

4 +

5 +TEST_PASSES_SANITIZE_LEAK=true

6 . ./test-lib.sh

8 test_hashmap() {

t/t0016-oidmap.sh

@@ -1,6 +1,8 @@

1 #!/bin/sh

3 test_description='test oidmap'

4 +

5 +TEST_PASSES_SANITIZE_LEAK=true

6 . ./test-lib.sh

8 # This purposefully is very similar to t0011-hashmap.sh

t/t0017-env-helper.sh

@@ -2,6 +2,7 @@

3 test_description='test env--helper'

5 +TEST_PASSES_SANITIZE_LEAK=true

6 . ./test-lib.sh

t/t0018-advice.sh

@@ -2,6 +2,7 @@

3 test_description='Test advise_if_enabled functionality'

5 +TEST_PASSES_SANITIZE_LEAK=true

6 . ./test-lib.sh

8 test_expect_success 'advice should be printed when config variable is unset' '

t/t0030-stripspace.sh

@@ -5,6 +5,7 @@

6 test_description='git stripspace'

8 +TEST_PASSES_SANITIZE_LEAK=true

9 . ./test-lib.sh

11 t40='A quick brown fox jumps over the lazy do'

t/t0063-string-list.sh

@@ -5,6 +5,7 @@

6 test_description='Test string list functionality'

8 +TEST_PASSES_SANITIZE_LEAK=true

9 . ./test-lib.sh

11 test_split () {

t/t0091-bugreport.sh

@@ -2,6 +2,7 @@

3 test_description='git bugreport'

5 +TEST_PASSES_SANITIZE_LEAK=true

6 . ./test-lib.sh

8 # Headers "[System Info]" will be followed by a non-empty line if we put some

t/test-lib.sh

+20

@@ -1379,6 +1379,26 @@ then

1379 test_done

1380 fi

1381

1382 +# skip non-whitelisted tests when compiled with SANITIZE=leak

1383 +if test -n "$SANITIZE_LEAK"

1384 +then

1385 + if test_bool_env GIT_TEST_PASSING_SANITIZE_LEAK false

1386 + then

1387 + # We need to see it in "git env--helper" (via

1388 + # test_bool_env)

1389 + export TEST_PASSES_SANITIZE_LEAK

1390 +

1391 + if ! test_bool_env TEST_PASSES_SANITIZE_LEAK false

1392 + then

1393 + skip_all="skipping $this_test under GIT_TEST_PASSING_SANITIZE_LEAK=true"

1394 + test_done

1395 + fi

1396 + fi

1397 +elif test_bool_env GIT_TEST_PASSING_SANITIZE_LEAK false

1398 +then

1399 + error "GIT_TEST_PASSING_SANITIZE_LEAK=true has no effect except when compiled with SANITIZE=leak"

1400 +fi

1401 +

1402 # Last-minute variable setup

1403 HOME="$TRASH_DIRECTORY"

1404 GNUPGHOME="$HOME/gnupg-home-not-used"