TGSAI / mdio-cpp

C++, Cloud native, scalable storage engine for various types of energy data.

Apache License 2.0

6 stars 3 forks source link

Proposal: Enable AddressSanitizer in build pipelines #81

Open BrianMichell opened 3 months ago

BrianMichell commented 3 months ago

Motivation

There were previously undiagnosed memory access issues that would only manifest in certain conditions. #46

What this will help solve

The intent is to discover undefined behavior regarding memory access before features may be merged into main.

Impact

Test execution will may be up to 2x slower. This should be negligible on overall pipeline execution time.
Pull requests will be safer as there are more checks.
More pipelines may fail if false positives are detected.

Required changes

cmake_build.yaml may require additional flags. -DCMAKE_CXX_FLAGS="-fsanitize=address"
Contribution guide will require update noting required flag for passing builds.