From: Gereon Kremer <gereon.kremer@cs.rwth-aachen.de>
Date: Tue, 8 Mar 2022 02:13:43 +0000 (+0100)
Subject: Script to list not covered API functions (#8254)
X-Git-Tag: cvc5-1.0.0~306
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=23f2844de386e16fcaa0ba3156152aa3f6a4c199;p=cvc5.git

Script to list not covered API functions (#8254)

Adds a script that lists all functions from the cpp API not covered by the current coverage information.
---

diff --git a/cmake/CodeCoverage.cmake b/cmake/CodeCoverage.cmake
index 9027b21b3..c003d2cef 100644
--- a/cmake/CodeCoverage.cmake
+++ b/cmake/CodeCoverage.cmake
@@ -57,10 +57,12 @@ function(setup_code_coverage_fastcov)
   add_custom_target(${COVERAGE_NAME}
     COMMAND
       ${FASTCOV_BINARY}
-          -d ${COVERAGE_PATH} --lcov ${EXCLUDES} -o coverage.info
-          -j${FASTCOV_PARALLEL_JOBS}
+          -d ${COVERAGE_PATH} ${EXCLUDES} -o coverage.json
+          -j${FASTCOV_PARALLEL_JOBS} -X
+    COMMAND
+      ${FASTCOV_BINARY} -C coverage.json --lcov -o coverage.info
     COMMAND
-      ${GENHTML_BINARY} --no-prefix -o coverage coverage.info
+      ${GENHTML_BINARY} --demangle-cpp --no-prefix -o coverage coverage.info
     DEPENDS
       ${COVERAGE_DEPENDENCIES}
     COMMENT
diff --git a/contrib/uncovered-api-functions.py b/contrib/uncovered-api-functions.py
new file mode 100755
index 000000000..17659fc21
--- /dev/null
+++ b/contrib/uncovered-api-functions.py
@@ -0,0 +1,44 @@
+#!/usr/bin/env python3
+
+import json
+import re
+import subprocess
+
+
+def demangle(name):
+    """Demangle a C++ symbol using c++filt."""
+    pipe = subprocess.Popen(['c++filt', name],
+                            stdin=subprocess.PIPE,
+                            stdout=subprocess.PIPE)
+    stdout, _ = pipe.communicate()
+    return stdout.decode().strip()
+
+
+def get_uncovered(data, file_patterns):
+    """Collect all uncovered functions from files matching the given patterns.
+       Returns a list of dicts with filename, function and startline."""
+    notcovered = []
+
+    for file, fdata in data['sources'].items():
+        if all([re.search(f, file) == None for f in file_patterns]):
+            continue
+        for function, funcdata in fdata['']['functions'].items():
+            if funcdata['execution_count'] == 0:
+                notcovered.append({
+                    'filename': file,
+                    'startline': funcdata['start_line'],
+                    'function': demangle(function),
+                })
+
+    notcovered.sort(key=lambda s: (s['filename'], s['startline']))
+    return notcovered
+
+
+if __name__ == "__main__":
+    patterns = ['src/api/cpp/cvc5.*']
+    data = json.load(open('coverage.json', 'r'))
+    notcovered = get_uncovered(data, patterns)
+    for nc in notcovered:
+        print('starting in {filename}:{startline}'.format(**nc))
+        print('function {function}'.format(**nc))
+        print('')