catchorg/Catch2

First-class support for sanitizers

Open

#1,730 opened on Aug 18, 2019

View on GitHub
 (2 comments) (3 reactions) (0 assignees)C++ (3,228 forks)batch import
Feature RequestHelp wanted

Repository metrics

Stars
 (20,381 stars)
PR merge metrics
 (Avg merge 4d 16h) (2 merged PRs in 30d)

Description

Description When running tests in continuous integration, it is rather common to use sanitizers (ubsan, asan, tsan, etc.). It would be nice if Catch2 reported errors as usual and logged the information that it generally logs when a test fails, such as the seed that was passed to the command line if any.

In libc++ at least, the sanitizers have a public API: https://github.com/llvm-mirror/compiler-rt/blob/release_36/include/sanitizer/common_interface_defs.h

It might be possible to do something with __sanitizer_set_death_callback or the other sanitizer-specific callbacks that can be found in the other headers in the same directory.

Contributor guide

Research direction
Investigate the Catch2 source code for the test runner's error reporting mechanism (likely in 'src/catch2/run context.cpp' or similar). Study the sanitizer API provided by compiler rt, particularly the ' sanitizer set death callback' function. Determine how to register a callback that logs the seed and test information when a sanitizer detects an issue. Check existing discussions in the issue comments for any additional insights.
Tech stack
cpp
Domain
testingci cd
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
C++ programmingFamiliarity with Catch2Understanding of sanitizers (asan/ubsan/tsan)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55