codeclimate-test-reporter-buildkite-plugin

A BuildKite plugin

https://buildkite.com/docs/agent/plugins

to report coverage with the Code Climate test reporter

https://github.com/codeclimate/test-reporter

Plugin can handle single, or multiple (parallel), tests.

Also see: https://docs.codeclimate.com/docs/configuring-test-coverage

Usage:

This plugin will download build artifact(s) generated by a previous step, compile and report to Code Climate.

steps:
  - label: ":codeclimate: Report coverage"
    plugins:
      - jobready/codeclimate-test-reporter#v2.0:
          artifact: "coverage/.resultset.json"
          input_type: simplecov
          prefix: /app
    env:
      CC_TEST_REPORTER_ID:

If you are running parallel builds you'll probably want to create uniquely named artifacts. That can be done by renaming the .resultset.json file after your tests have run:

mv -v coverage/.resultset.json coverage/.resultset${BUILDKITE_PARALLEL_JOB}.json

Configuration

artifact (required)

Passed through as the [COVERAGE FILE] argument to

https://github.com/codeclimate/test-reporter/blob/master/man/cc-test-reporter-format-coverage.1.md

Example: coverage/.resultset.json

Would be the artifact path uploaded by a previous step. Use a wildcard for multiple artifacts

Example: coverage/.resultset*.json

input_type (required)

Passed through to the --input-type option of

https://github.com/codeclimate/test-reporter/blob/master/man/cc-test-reporter-format-coverage.1.md

Example: simplecov

prefix (optional)

Passed through to the --prefix option of

https://github.com/codeclimate/test-reporter/blob/master/man/cc-test-reporter-format-coverage.1.md

Example: /app

If the coverage was generated from a Docker container, prefix would be the Dockerfile WORKDIR.

version (optional)

The preferred version of the test reporter to download. Defaults to latest.

Example: 0.4.3

parts (optional)

If you expect multiple partial coverage artifacts, set this value to enforce a check. If not set the plugin will proceed with any/all provided parts.

Example: 2

debug (optional)

Set to true to enable cc-test-reporter --debug flag

Example: true

CC_TEST_REPORTER_ID (required)

The CC_TEST_REPORTER_ID environment variable must be configured.

Linting

To run the Buildkite Plugin Linter, run

docker-compose run --rm lint --name jobready/codeclimate-test-reporter

License

MIT