Ruby

Install and instrument test coverage with SimpleCov

Configure SimpleCov to generate JSON reports:

1
require 'simplecov'
2
require 'simplecov_json_formatter'
3
SimpleCov.start do
4
    formatter SimpleCov::Formatter::JSONFormatter
5
    add_filter '/spec/'
6
end

If you want to combine the JSON format with other formats, use SimpleCov’s MultiFormatter:

1
SimpleCov.start do
2
    formatter SimpleCov::Formatter::MultiFormatter.new([
3
      SimpleCov::Formatter::JSONFormatter,
4
      SimpleCov::Formatter::HTMLFormatter
5
    ])
6
    add_filter '/spec/'
7
end

Publish SimpleCov’s JSON coverage reports using qlty coverage publish PATH

SimpleCov will write a coverage data file to coverage/coverage.json.

This path is needed to complete the final step which is publishing this data to qlty.

For GitHub Actions users, the simplest next step is to use our example workflow from our example ruby repository.

Otherwise, refer to:

• Our general procedure for test coverage setup (start at step 2)
• Instructions on using with other CI providers