performance_test_fixture

This repository contains the source code for the performance_test_fixture package.

performance_test_fixture provides: 1. A Google Benchmark fixture that leverages memory tools from osrf_testing_tools_cpp to record memory allocation statistics 2. A CMake macro for compiling, linking, and configuring benchmarking runs, as well as automatically skipping the tests on platforms where the osrf_testing_tools_cpp memory tools are not supported

Usage

The test fixture can be used just like any other Google Benchmark fixture:

#include <performance_test_fixture/performance_test_fixture.hpp>

using performance_test_fixture::PerformanceTest;

BENCHMARK_F(PerformanceTest, example_test)(benchmark::State & st)
{
  ...
}

The CMake macro can be used in the same way as the rest of the ament_cmake_test family of macros:

  find_package(performance_test_fixture REQUIRED)
  add_performance_test(example_test test/example_test.cpp)

Because it has a large impact on performance, trace messages coming from the memory tools in osrf_testing_tools_cpp are suppressed by default. To enable memory operation trace logging, set the environment variable PERFORMANCE_TEST_FIXTURE_ENABLE_TRACE=1.

Changelog for package performance_test_fixture

0.2.0 (2023-04-27)

0.1.1 (2023-04-11)

• Resolve use-after-free compiler warnings (#24)
• Contributors: Scott K Logan

0.1.0 (2023-02-13)

• Update performance_test_fixture to C++17. (#21)
• [rolling] Update maintainers - 2022-11-07 (#20)
• Contributors: Audrow Nash, Chris Lalancette

0.0.9 (2022-07-25)

• Mirror rolling to main
• Add \"cstring\" to the list of includes (#19)
• Contributors: Audrow Nash, Chris Lalancette

0.0.8 (2022-01-14)

• Fix include order for cpplint (#16)
• Contributors: Jacob Perron

0.0.7 (2021-03-18)

• Record calls to calloc, update tests (#15)
• Contributors: Scott K Logan

0.0.6 (2020-11-19)

• Make allocation counter atomic (#13) Even if the benchmark itself isn\'t threaded, the process we\'re testing could be. In any case, this should prevent those shenanigans from messing up the measurement.
• Add methods for pausing/resuming performance metrics (#10)
  • Add methods for pausing/resuming performance metrics
• Add benchmarks to evaluate overhead (#11)
  • Add benchmarks to evaluate overhead in performance tests
• Add namespace performance_test_fixture to .cpp (#9)
• Contributors: Scott K Logan, brawner

0.0.5 (2020-10-21)

• Export dependency on benchmark and osrf_testing_tools_cpp (#8)
• Update maintainers (#7)
• Contributors: Alejandro Hern