1 Commits

Author SHA1 Message Date
52b36aecc4 Namespace embedded coverage target
All checks were successful
libakerror CI Build / cmake_build (push) Successful in 2m47s
libakerror CI Build / coverage (push) Successful in 2m48s
libakerror CI Build / mutation_test (push) Successful in 37m46s
2026-08-03 13:46:00 -04:00
8 changed files with 14 additions and 83 deletions

View File

@@ -37,23 +37,6 @@ jobs:
fail_on_failure: 'true' fail_on_failure: 'true'
- run: echo "🍏 This job's status is ${{ job.status }}." - run: echo "🍏 This job's status is ${{ job.status }}."
sanitizer:
runs-on: ubuntu-latest
steps:
- name: Check out repository code
uses: actions/checkout@v4
- name: dependencies
run: |
sudo apt-get update -y
sudo apt-get install -y cmake gcc moreutils
- name: build with AddressSanitizer and UBSan
run: |
cmake -S . -B build/asan -DAKERR_SANITIZE=address,undefined
cmake --build build/asan
- name: test with AddressSanitizer and UBSan
run: ctest --test-dir build/asan --output-on-failure
- run: echo "🍏 This job's status is ${{ job.status }}."
coverage: coverage:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:

View File

@@ -282,22 +282,6 @@ foreach(_test IN LISTS AKERR_TESTS)
endif() endif()
endforeach() endforeach()
# The ignored-error slot is declared in the public header but must have one
# library definition. Compare its address from two translation units, and
# compile the consumer-facing test with all ordinary warnings enabled: a
# header-local TLS definition would both duplicate storage and warn when unused.
add_executable(test_err_ignore_multitu
tests/err_ignore_multitu.c
tests/err_ignore_multitu_helper.c)
target_include_directories(test_err_ignore_multitu
PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/tests)
target_link_libraries(test_err_ignore_multitu PRIVATE akerror)
target_compile_options(test_err_ignore_multitu PRIVATE -Wall -Wextra -Werror)
if(AKERR_THREAD_SAFE)
target_link_libraries(test_err_ignore_multitu PRIVATE Threads::Threads)
endif()
add_test(NAME err_ignore_multitu COMMAND test_err_ignore_multitu)
# HANDLE_GROUP deliberately enters the next case label. Keep that public macro # HANDLE_GROUP deliberately enters the next case label. Keep that public macro
# compiling with the warning enabled, so a future macro edit cannot restore the # compiling with the warning enabled, so a future macro edit cannot restore the
# warning for consumers which adopt -Wextra. # warning for consumers which adopt -Wextra.
@@ -321,7 +305,14 @@ if(Python3_FOUND)
# The script configures and drives its own instrumented build tree (under # The script configures and drives its own instrumented build tree (under
# ${CMAKE_BINARY_DIR}/coverage) so this build's binaries and its coverage # ${CMAKE_BINARY_DIR}/coverage) so this build's binaries and its coverage
# counters can never be stale or half-instrumented. Reports via gcov. # counters can never be stale or half-instrumented. Reports via gcov.
add_custom_target(coverage # Keep the convenient generic name at the top level, but namespace it when
# embedded so a parent project can provide its own coverage target.
if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
set(AKERR_COVERAGE_TARGET coverage)
else()
set(AKERR_COVERAGE_TARGET akerror_coverage)
endif()
add_custom_target(${AKERR_COVERAGE_TARGET}
COMMAND ${Python3_EXECUTABLE} COMMAND ${Python3_EXECUTABLE}
${CMAKE_CURRENT_SOURCE_DIR}/scripts/coverage.py ${CMAKE_CURRENT_SOURCE_DIR}/scripts/coverage.py
--source-root ${CMAKE_CURRENT_SOURCE_DIR} --source-root ${CMAKE_CURRENT_SOURCE_DIR}

View File

@@ -25,8 +25,6 @@ Usage:
--work DIR scratch dir for the mutated copy (default: a temp dir) --work DIR scratch dir for the mutated copy (default: a temp dir)
--timeout SECONDS per-suite ctest timeout (default: 120) --timeout SECONDS per-suite ctest timeout (default: 120)
--threshold PCT exit non-zero if mutation score < PCT (default: 0 = off) --threshold PCT exit non-zero if mutation score < PCT (default: 0 = off)
--cmake-arg ARG pass an additional argument to the mutant CMake configure;
repeat for multiple arguments (e.g. -DAKERR_SANITIZE=thread)
--list only list the mutants that would be run, then exit --list only list the mutants that would be run, then exit
--keep keep the scratch working copy on exit (for debugging) --keep keep the scratch working copy on exit (for debugging)
-j N (reserved) currently runs sequentially -j N (reserved) currently runs sequentially
@@ -201,11 +199,10 @@ def generate_mutants(root, rel_target):
# --------------------------------------------------------------------------- # # --------------------------------------------------------------------------- #
class Runner: class Runner:
def __init__(self, work, timeout, cmake_args): def __init__(self, work, timeout):
self.work = work self.work = work
self.build = os.path.join(work, "build") self.build = os.path.join(work, "build")
self.timeout = timeout self.timeout = timeout
self.cmake_args = cmake_args
def _run(self, cmd, timeout=None): def _run(self, cmd, timeout=None):
return subprocess.run( return subprocess.run(
@@ -214,8 +211,7 @@ class Runner:
) )
def configure(self): def configure(self):
r = self._run(["cmake", "-S", ".", "-B", "build", *self.cmake_args], r = self._run(["cmake", "-S", ".", "-B", "build"], timeout=self.timeout)
timeout=self.timeout)
return r.returncode == 0, r.stdout return r.returncode == 0, r.stdout
def build_and_test(self): def build_and_test(self):
@@ -311,8 +307,6 @@ def main():
ap.add_argument("--work", default=None) ap.add_argument("--work", default=None)
ap.add_argument("--timeout", type=int, default=120) ap.add_argument("--timeout", type=int, default=120)
ap.add_argument("--threshold", type=float, default=0.0) ap.add_argument("--threshold", type=float, default=0.0)
ap.add_argument("--cmake-arg", action="append", default=[],
help="pass an argument to the mutant CMake configure; repeatable")
ap.add_argument("--junit", default=None, ap.add_argument("--junit", default=None,
help="write a JUnit XML report to this path") help="write a JUnit XML report to this path")
ap.add_argument("--max-mutants", type=int, default=0, ap.add_argument("--max-mutants", type=int, default=0,
@@ -360,7 +354,7 @@ def main():
print(f"\nCopying sources to scratch dir: {work}") print(f"\nCopying sources to scratch dir: {work}")
copy_tree(root, work) copy_tree(root, work)
runner = Runner(work, args.timeout, args.cmake_arg) runner = Runner(work, args.timeout)
print("Configuring baseline ...") print("Configuring baseline ...")
ok, out = runner.configure() ok, out = runner.configure()

View File

@@ -664,7 +664,7 @@ static akerr_ErrorContext AKERR_NOIGNORE *akerr_reserve_status_range_locked(int
"must not overflow int)", "must not overflow int)",
count, first_status, owner == NULL ? "(null)" : owner, count, first_status, owner == NULL ? "(null)" : owner,
AKERR_MAX_STATUS_RANGE_OWNER_LENGTH); AKERR_MAX_STATUS_RANGE_OWNER_LENGTH);
last_status = first_status + (count - 1); last_status = first_status + count - 1;
for ( int i = 0; i < akerr_status_range_count; i++ ) { for ( int i = 0; i < akerr_status_range_count; i++ ) {
if ( first_status <= akerr_status_ranges[i].last && if ( first_status <= akerr_status_ranges[i].last &&

View File

@@ -32,9 +32,6 @@ scripts/mutation_test.py --target src/error.c --list
# Gate CI: exit non-zero if the score drops below 90% # Gate CI: exit non-zero if the score drops below 90%
scripts/mutation_test.py --threshold 90 scripts/mutation_test.py --threshold 90
# Check concurrency mutants under ThreadSanitizer
scripts/mutation_test.py --cmake-arg=-DAKERR_SANITIZE=thread
``` ```
Via CMake (configures a build first if needed): Via CMake (configures a build first if needed):
@@ -43,10 +40,8 @@ Via CMake (configures a build first if needed):
cmake --build build --target mutation cmake --build build --target mutation
``` ```
Useful flags: `--cmake-arg ARG` (pass a CMake configure argument to every Useful flags: `--timeout SECONDS` (per-suite build+test cap; a mutant that
mutant build; repeat it for multiple arguments), `--timeout SECONDS` (per-suite hangs is counted as killed), `--keep` (retain the scratch copy for debugging),
build+test cap; a mutant that hangs is counted as killed), `--keep` (retain the
scratch copy for debugging),
`--work DIR` (use a specific scratch directory), `--junit FILE` (write a JUnit `--work DIR` (use a specific scratch directory), `--junit FILE` (write a JUnit
XML report — surviving mutants appear as failing test cases). XML report — surviving mutants appear as failing test cases).

View File

@@ -1,18 +0,0 @@
#include "akerror.h"
#include "err_ignore_multitu.h"
#include <stdio.h>
int main(void)
{
akerr_ErrorContext **main_address = &__akerr_last_ignored;
akerr_ErrorContext **helper_address = akerr_multitu_snapshot_address();
if ( main_address != helper_address ) {
fprintf(stderr,
"CHECK FAILED: ignored-error storage differs between translation units\n");
return 1;
}
fprintf(stderr, "err_ignore_multitu ok\n");
return 0;
}

View File

@@ -1,8 +0,0 @@
#ifndef AKERR_TEST_IGNORE_MULTITU_H
#define AKERR_TEST_IGNORE_MULTITU_H
#include "akerror.h"
akerr_ErrorContext **akerr_multitu_snapshot_address(void);
#endif

View File

@@ -1,6 +0,0 @@
#include "err_ignore_multitu.h"
akerr_ErrorContext **akerr_multitu_snapshot_address(void)
{
return &__akerr_last_ignored;
}