Skip to content

Ceedling Plugins

Ceedling includes a number of built-in plugins. Each plugin linked below includes full documentation of its capabilities and configuration options.

Need a CI test build report?

Test Suite Report Log Factory provides a handful of popular reports and the ability to create your own.

Have custom needs?

Many find the handy-dandy Command Hooks plugin is often enough as it allows you to connect your own scripts and tools to Ceedling build steps. Alternatively, you can create your own plugins.

See the :plugins configuration reference for how to enable built-in plugins and load custom plugins in your project.

Console Test Results

  • report_tests_pretty_stdout

    The default plugin for printing test results to the console. Produces a well-formatted list of summary statistics, ignored and failed tests, and any extraneous output collected from test fixtures.

  • report_tests_ide_stdout

    Formats test results for the console such that an IDE executing Ceedling tasks can recognize file paths and line numbers in test failures and link them for direct file navigation.

  • report_tests_gtestlike_stdout

    Prints test results to the console in a format that mimics Google Test's output — both human readable and recognized by a variety of reporting tools, IDEs, and CI servers.

  • report_tests_teamcity_stdout

    Processes test results into TeamCity service messages printed to the console, allowing the CI server to extract build steps and test results from software builds.

Test Results Reports

  • report_tests_log_factory

    Produces any or all of four useful test suite reports in JSON, JUnit XML, CppUnit XML, or HTML format. Also provides a mechanism for custom reports with a small amount of Ruby rather than a full plugin.

  • report_tests_raw_output_log

    Captures extraneous console output generated by test executables — typically for debugging — to log files named after the test executables.

  • report_build_warnings_log

    Scans the output of build tools for console warning notices and produces a simple text file that collects all such warning messages.

Code Coverage

  • gcov

    Adds Ceedling tasks to execute tests with GNU code coverage instrumentation. Manages use of gcov, optional Python-based GCovr, and .Net-based ReportGenerator to produce coverage reports in a variety of formats.

  • bullseye

    Adds Ceedling tasks to execute tests with code coverage instrumentation provided by the commercial Bullseye tool, which provides visualization and report generation from the coverage results.

Mocking & Test Doubles

Build Integration

  • command_hooks

    Connects Ceedling's build events to tool entries you define in your project configuration. Easily attach your own scripts or command line utilities to build steps without writing a full custom plugin.

  • compile_commands_json_db

    Creates a JSON Compilation Database — a compile_commands.json file useful to any editor or IDE that implements clangd Language Server Protocol support.

  • beep

    Provides a simple audio notification when a test build completes suite execution or fails due to a build error, intended to support developers running time-consuming test suites locally in the background.

Project & Release Builds

  • module_generator

    Saves time in Test-Driven Development by generating a templated triplet of source file, header file, and test file — scaffolded such that they refer to one another — with convenient command line tasks.

  • dependencies

    Manages release build dependencies (e.g. static libraries) including fetching those dependencies and calling a given dependency‘s build process to generate the components needed by your Ceedling release build target.