From 42ecceb0628d0d2b19d0cadffe8cd437e7707d75 Mon Sep 17 00:00:00 2001
From: Bill Fenner <fenner@gmail.com>
Date: Wed, 16 Dec 2020 13:54:49 -0800
Subject: [PATCH] Build system: Add WITH_COVERAGE to compile netdissect and
 tcpdump with code coverage

Build with --coverage and use the coveralls tool to submit
code coverage reports to https://coveralls.io/github/the-tcpdump-group/tcpdump

Support for coverage builds is added to both automake and cmake, but
coverage relies on running tests, and running tests is currently broken
with cmake.  So the added job is CMAKE=no but can be changed to
CMAKE=yes when running tests with cmake is fixed.
---
 .travis.yml    | 16 +++++++++++++++-
 CMakeLists.txt |  8 ++++++++
 2 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/.travis.yml b/.travis.yml
index 6c408aedf..4d78b762c 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -74,6 +74,15 @@ jobs:
     arch: s390x
   - if: branch = coverity_scan
     arch: arm64
+  include:
+  - name: Linux amd64 coverage gcc
+    os: linux
+    arch: amd64
+    compiler: gcc
+    env: BUILD_LIBPCAP=yes CMAKE=no  REMOTE=disable CRYPTO=yes COVERAGE=yes
+    # Coverage depends on running tests, so we use CMAKE=no because
+    # that is the only time that we can run tests.  Once running tests
+    # with cmake is supported again, we can make this CMAKE=yes.
 
 cache: ccache
 
@@ -146,6 +155,7 @@ before_install:
   - gem install travis-conditions
   - if [ "$TRAVIS_OS_NAME" = osx ]; then brew update >/dev/null; fi
   - if [ "$TRAVIS_OS_NAME" = linux ]; then apt list --installed 'lib*-dev'; fi
+  - if [ "$COVERAGE" = yes ]; then pip install --user cpp-coveralls; fi
 
 install:
   - if [ "$TRAVIS_OS_NAME" = osx ]; then brew install libsmi | grep -v '%'; fi
@@ -153,17 +163,21 @@ install:
 before_script:
   - if [ "$BUILD_LIBPCAP" = yes ]; then (cd .. && echo '$ git clone [...] libpcap.git' && git clone --depth 3 --branch=master --quiet git://github.com/the-tcpdump-group/libpcap.git && cd libpcap && ./configure "--${REMOTE}-remote" --prefix=/tmp && make && make install); fi
 
+after_success:
+  - if [ "$COVERAGE" = yes ]; then coveralls --gcov-options '\-lp'; fi
+
 script:
   - if [ "$COVERITY_SCAN_BRANCH" = 1 ]; then exit 0; fi
   - if [ "$TRAVIS_OS_NAME" = osx ]; then OSX_SSL_DIR=$(ls /usr/local/Cellar/openssl); echo "OSX_SSL_DIR=$OSX_SSL_DIR"; fi
   - touch .devel configure
   - if [ "$CMAKE" = no ]; then echo '$ ./configure [...]' && echo travis_fold:start:script.configure; fi
+  - if [ "$CMAKE" = no -a "$COVERAGE" = yes ]; then export CFLAGS=--coverage LDFLAGS=--coverage; fi
   - if [ "$CMAKE" = no ]; then ./configure --with-crypto=${CRYPTO} CPPFLAGS="-I/usr/local/Cellar/openssl/$OSX_SSL_DIR/include/" --prefix=/tmp; fi
   - if [ "$CMAKE" = no ]; then echo -n travis_fold:end:script.configure; fi
   - if [ "$CMAKE" = yes ]; then mkdir build; fi
   - if [ "$CMAKE" = yes ]; then cd build; fi
   - if [ "$CMAKE" = yes ]; then echo travis_fold:start:script.cmake; fi
-  - if [ "$CMAKE" = yes ]; then cmake -DWITH_CRYPTO="$CRYPTO" -DCMAKE_PREFIX_PATH=/tmp -DCMAKE_INSTALL_PREFIX=/tmp ..; fi
+  - if [ "$CMAKE" = yes ]; then cmake -DWITH_CRYPTO="$CRYPTO" -DCMAKE_PREFIX_PATH=/tmp -DCMAKE_INSTALL_PREFIX=/tmp -DWITH_COVERAGE="COVERAGE" ..; fi
   - if [ "$CMAKE" = yes ]; then echo -n travis_fold:end:script.cmake; fi
   - make -s CFLAGS=-Werror
   - echo '$ make install [...]' && echo travis_fold:start:script.make_install
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 72091428e..5931df987 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -115,6 +115,7 @@ option(WITH_CRYPTO "Build with OpenSSL/libressl libcrypto, if available" ON)
 option(WITH_CAPSICUM "Build with Capsicum security functions, if available" ON)
 option(WITH_CAP_NG "Use libcap-ng, if available" ON)
 option(ENABLE_SMB "Build with the SMB dissector" ON)
+option(WITH_COVERAGE "Enable coverage if using gcc" OFF)
 
 #
 # String parameters.  Neither of them are set, initially; only if the
@@ -1151,6 +1152,13 @@ add_executable(tcpdump ${TCPDUMP_SOURCE_LIST_C})
 if(NOT C_ADDITIONAL_FLAGS STREQUAL "")
     set_target_properties(tcpdump PROPERTIES COMPILE_FLAGS ${C_ADDITIONAL_FLAGS})
 endif()
+if(WITH_COVERAGE AND "${CMAKE_COMPILER_IS_GNUCC}")
+    target_compile_options(tcpdump PUBLIC --coverage)
+    target_link_options(tcpdump PUBLIC --coverage)
+    target_compile_options(netdissect PUBLIC --coverage)
+    target_link_options(netdissect PUBLIC --coverage)
+endif()
+
 target_link_libraries(tcpdump netdissect ${TCPDUMP_LINK_LIBRARIES})
 
 ######################################