Plugin Option 3: Rake Tasks

This plugin type adds custom Rake tasks to your project that can be run with ceedling <custom_task>.

Naming and location conventions: <plugin_name>/<plugin_name>.rake

Rake will be fully deprecated in the future

The Ceedling project is working towards fully removing Rake as a runtime dependency.

Example Rake task

# Only tasks with description are listed by `ceedling -T`
desc "Print hello world to console"
task :hello_world do
  sh "echo Hello World!"
end

Resulting, example command line:

 > ceedling hello_world
 > Hello World!

Running a test build from a Rake task

A Rake task can trigger a full test build itself by calling @ceedling[:test_invoker].setup_and_invoke. Pass a context symbol unique to your plugin. Ceedling uses this context to distinguish build pipelines. It also keeps your build's delta build state separate from ordinary test builds. See Delta Builds for how this tracking works.

Example Rake plugin layout

Project configuration file:

:plugins:
  :load_paths:
    - support/plugins
  :enabled:
    - hello_world

Ceedling project directory structure:

project/
├── project.yml
└── support/
    └── plugins/
        └── hello_world/
            └── hello_world.rake