commit 1228dd293b60a8eaab03472fa29428c5e2752c44 Author: Sebastian Hahn sebastian@torproject.org Date: Fri Mar 20 13:12:09 2015 +0100
Disable assertions during coverage builds
This removes roughly 5000 branches in my testing. We never want to trigger assertions even during tests, so this is sane. Implements #15400. --- Makefile.am | 20 ++++++++++++++++++++ changes/coverage | 6 ++++++ src/common/include.am | 6 +++--- src/common/util.h | 8 ++++++++ src/or/include.am | 4 ++-- src/test/include.am | 4 ++-- src/trunnel/include.am | 2 +- 7 files changed, 42 insertions(+), 8 deletions(-)
diff --git a/Makefile.am b/Makefile.am index 1c2d2c1..df893ff 100644 --- a/Makefile.am +++ b/Makefile.am @@ -35,8 +35,10 @@ EXTRA_DIST+= \
if COVERAGE_ENABLED TEST_CFLAGS=-fno-inline -fprofile-arcs -ftest-coverage +TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE else TEST_CFLAGS= +TEST_CPPFLAGS=-DTOR_UNIT_TESTS endif
#install-data-local: @@ -80,6 +82,13 @@ test-stem: $(TESTING_TOR_BINARY) echo "To run these tests, git clone https://git.torproject.org/stem.git/ ; export STEM_SOURCE_DIR=`pwd`/stem"; \ fi
+test-stem-full: $(TESTING_TOR_BINARY) + @if test -d "$$STEM_SOURCE_DIR"; then \ + "$$STEM_SOURCE_DIR"/run_tests.py --tor $(TESTING_TOR_BINARY) --all --log notice --target RUN_ALL,ONLINE -v; \ + else \ + echo '$$STEM_SOURCE_DIR was not set.'; echo; \ + echo "To run these tests, git clone https://git.torproject.org/stem.git/ ; export STEM_SOURCE_DIR=`pwd`/stem"; \ + fi
reset-gcov: rm -f $(top_builddir)/src/*/*.gcda $(top_builddir)/src/*/*/*.gcda @@ -99,6 +108,17 @@ else @printf "Not configured with --enable-coverage, run ./configure --enable-coverage\n" endif
+coverage-html-full: all + test -e "`which lcov`" || (echo "lcov must be installed. See http://ltp.sourceforge.net/coverage/lcov.php." && false) + test -d "$(HTML_COVER_DIR)" || mkdir -p "$(HTML_COVER_DIR)" + lcov --rc lcov_branch_coverage=1 --directory ./src --zerocounters + $(MAKE) reset-gcov + $(MAKE) check + $(MAKE) test-stem-full + lcov --capture --rc lcov_branch_coverage=1 --no-external --directory . --output-file "$(HTML_COVER_DIR)/lcov.tmp" + lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info" + genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info" + # Avoid strlcpy.c, strlcat.c, aes.c, OpenBSD_malloc_Linux.c, sha256.c, # eventdns.[hc], tinytest*.[ch] check-spaces: diff --git a/changes/coverage b/changes/coverage new file mode 100644 index 0000000..bb7c7cf --- /dev/null +++ b/changes/coverage @@ -0,0 +1,6 @@ + o Minor features: + - Remove assertions during builds to determine Tor's test coverage. + We don't want to trigger these even in assertions, so including + them artificially makes our branch coverage look worse than it is. + This patch provides the new test-stem-full and coverage-html-full + configure options. Implements ticket 15400. diff --git a/src/common/include.am b/src/common/include.am index ec48935..00e0055 100644 --- a/src/common/include.am +++ b/src/common/include.am @@ -96,9 +96,9 @@ src_common_libor_testing_a_SOURCES = $(LIBOR_A_SOURCES) src_common_libor_crypto_testing_a_SOURCES = $(LIBOR_CRYPTO_A_SOURCES) src_common_libor_event_testing_a_SOURCES = $(LIBOR_EVENT_A_SOURCES)
-src_common_libor_testing_a_CPPFLAGS = -DTOR_UNIT_TESTS $(AM_CPPFLAGS) -src_common_libor_crypto_testing_a_CPPFLAGS = -DTOR_UNIT_TESTS $(AM_CPPFLAGS) -src_common_libor_event_testing_a_CPPFLAGS = -DTOR_UNIT_TESTS $(AM_CPPFLAGS) +src_common_libor_testing_a_CPPFLAGS = $(AM_CPPFLAGS) $(TEST_CPPFLAGS) +src_common_libor_crypto_testing_a_CPPFLAGS = $(AM_CPPFLAGS) $(TEST_CPPFLAGS) +src_common_libor_event_testing_a_CPPFLAGS = $(AM_CPPFLAGS) $(TEST_CPPFLAGS) src_common_libor_testing_a_CFLAGS = $(AM_CFLAGS) $(TEST_CFLAGS) src_common_libor_crypto_testing_a_CFLAGS = $(AM_CFLAGS) $(TEST_CFLAGS) src_common_libor_event_testing_a_CFLAGS = $(AM_CFLAGS) $(TEST_CFLAGS) diff --git a/src/common/util.h b/src/common/util.h index 783c2a1..3584a87 100644 --- a/src/common/util.h +++ b/src/common/util.h @@ -45,6 +45,13 @@ #error "Sorry; we don't support building with NDEBUG." #endif
+/* Don't use assertions during coverage. It leads to tons of unreached + * branches which in reality are only assertions we didn't hit. */ +#ifdef TOR_COVERAGE +#define tor_assert(a) STMT_BEGIN \ + (void)(a); \ + STMT_END +#else /** Like assert(3), but send assertion failures to the log as well as to * stderr. */ #define tor_assert(expr) STMT_BEGIN \ @@ -52,6 +59,7 @@ tor_assertion_failed_(SHORT_FILE__, __LINE__, __func__, #expr); \ abort(); \ } STMT_END +#endif
void tor_assertion_failed_(const char *fname, unsigned int line, const char *func, const char *expr); diff --git a/src/or/include.am b/src/or/include.am index 9298093..c7f22ab 100644 --- a/src/or/include.am +++ b/src/or/include.am @@ -99,7 +99,7 @@ AM_CPPFLAGS += -DSHARE_DATADIR=""$(datadir)"" \ -DLOCALSTATEDIR=""$(localstatedir)"" \ -DBINDIR=""$(bindir)""
-src_or_libtor_testing_a_CPPFLAGS = -DTOR_UNIT_TESTS $(AM_CPPFLAGS) +src_or_libtor_testing_a_CPPFLAGS = $(AM_CPPFLAGS) $(TEST_CPPFLAGS) src_or_libtor_testing_a_CFLAGS = $(AM_CFLAGS) $(TEST_CFLAGS)
# -L flags need to go in LDFLAGS. -l flags need to go in LDADD. @@ -116,7 +116,7 @@ src_or_tor_LDADD = src/or/libtor.a src/common/libor.a \
if COVERAGE_ENABLED src_or_tor_cov_SOURCES = src/or/tor_main.c -src_or_tor_cov_CPPFLAGS = -DTOR_UNIT_TESTS $(AM_CPPFLAGS) +src_or_tor_cov_CPPFLAGS = $(AM_CPPFLAGS) $(TEST_CPPFLAGS) src_or_tor_cov_CFLAGS = $(AM_CFLAGS) $(TEST_CFLAGS) src_or_tor_cov_LDFLAGS = @TOR_LDFLAGS_zlib@ @TOR_LDFLAGS_openssl@ @TOR_LDFLAGS_libevent@ src_or_tor_cov_LDADD = src/or/libtor-testing.a src/common/libor-testing.a \ diff --git a/src/test/include.am b/src/test/include.am index c56e887..089c622 100644 --- a/src/test/include.am +++ b/src/test/include.am @@ -76,7 +76,7 @@ src_test_test_slow_SOURCES = \
src_test_test_CFLAGS = $(AM_CFLAGS) $(TEST_CFLAGS)
-src_test_test_CPPFLAGS= $(src_test_AM_CPPFLAGS) +src_test_test_CPPFLAGS= $(src_test_AM_CPPFLAGS) $(TEST_CPPFLAGS)
src_test_bench_SOURCES = \ src/test/bench.c @@ -151,7 +151,7 @@ src_test_test_bt_cl_LDADD = src/common/libor-testing.a \ @TOR_LIB_MATH@ \ @TOR_LIB_WS32@ @TOR_LIB_GDI@ src_test_test_bt_cl_CFLAGS = $(AM_CFLAGS) $(TEST_CFLAGS) -src_test_test_bt_cl_CPPFLAGS= $(src_test_AM_CPPFLAGS) +src_test_test_bt_cl_CPPFLAGS= $(src_test_AM_CPPFLAGS) $(TEST_CPPFLAGS)
check-local: $(NTOR_TEST_DEPS) $(CMDLINE_TEST_TOR) diff --git a/src/trunnel/include.am b/src/trunnel/include.am index c7ac167..54e3db2 100644 --- a/src/trunnel/include.am +++ b/src/trunnel/include.am @@ -23,7 +23,7 @@ src_trunnel_libor_trunnel_a_SOURCES = $(TRUNNELSOURCES) src_trunnel_libor_trunnel_a_CPPFLAGS = -DTRUNNEL_LOCAL_H $(AM_CPPFLAGS)
src_trunnel_libor_trunnel_testing_a_SOURCES = $(TRUNNELSOURCES) -src_trunnel_libor_trunnel_testing_a_CPPFLAGS = -DTOR_UNIT_TESTS -DTRUNNEL_LOCAL_H $(AM_CPPFLAGS) +src_trunnel_libor_trunnel_testing_a_CPPFLAGS = -DTRUNNEL_LOCAL_H $(AM_CPPFLAGS) $(TEST_CPPFLAGS) src_trunnel_libor_trunnel_testing_a_CFLAGS = $(AM_CFLAGS) $(TEST_CFLAGS)
noinst_HEADERS+= $(TRUNNELHEADERS)