It connects to supported ruby testing frameworks and outputs a report of all passing, failing and skipped tests into a json-format. This format can be used to report test results using the ruby client to Blinka.

Run

gem install blinka-reporter

or add to your Gemfile

gem 'blinka-repoter', '~> 0.5.0'

• Minitest

Please reach out for other frameworks or create a reporter yourself.

Blinka is a web service developed by @davidwessman to store test results from CI and report interesting results back to Github, right in the pull request.

After the tests have run with environment variable BLINKA_JSON=true and the blinka_report.json file is populated, run in ruby:

require 'blinka_client'
BlinkaClient.new.report

Add a step to your Github Action Workflow after running tests:

- name: Run tests and report to Blinka
  env:
    BLINKA_COMMIT: ${{ github.event.pull_request.head.sha || github.sha }}
    BLINKA_REPORT: true
    BLINKA_REPOSITORY: davidwessman/blinka_reporter
    BLINKA_TAG: ""
    BLINKA_TEAM_ID: ${{ secrets.BLINKA_TEAM_ID }}
    BLINKA_TEAM_SECRET: ${{ secrets.BLINKA_TEAM_SECRET }}
  run: bundle exec rake test

BLINKA_TAG is optional and can be used to separate different reports, for example when using a build matrix.

For example when running tests in parallel you might need to run system tests separately. By using BLINKA_JSON first and the BLINKA_REPORT with BLINKA_APPEND it will keep the results from both runs:

- name: System tests
  env:
    BLINKA_COMMIT: ${{ github.event.pull_request.head.sha || github.sha }}
    BLINKA_JSON: true
    BLINKA_REPOSITORY: davidwessman/blinka_reporter
    BLINKA_TAG: ""
    PARALLEL_WORKERS: 1
  run: bundle exec rails test:system
- name: Tests
  env:
    BLINKA_COMMIT: ${{ github.event.pull_request.head.sha || github.sha }}
    BLINKA_REPORT: true
    BLINKA_APPEND: true
    BLINKA_REPOSITORY: davidwessman/blinka_reporter
    BLINKA_TAG: ""
  run: bundle exec rails test

TAP-format (Test anything protocol) is used to parse tests results on for example Heroku CI.

Set BLINKA_TAP environment variable to any value to get a report:

$ BLINKA_TAP=true rake
Run options: --seed 33934

# Running:

..............

Finished in 0.002069s, 6766.5538 runs/s, 9666.5054 assertions/s.

14 runs, 20 assertions, 0 failures, 0 errors, 0 skips

TAP version 13
1..14
ok 1 - test/test_blinka_minitest.rb - test_message
ok 2 - test/test_blinka_minitest.rb - test_image
ok 3 - test/test_blinka_minitest.rb - test_image_no_file
ok 4 - test/test_blinka_minitest.rb - test_report_with_image
ok 5 - test/test_blinka_minitest.rb - test_line
ok 6 - test/test_blinka_minitest.rb - test_backtrace
ok 7 - test/test_blinka_minitest.rb - test_line_no_failure
ok 8 - test/test_blinka_minitest.rb - test_report
ok 9 - test/test_blinka_minitest.rb - test_backtrace_no_failure
ok 10 - test/test_blinka_minitest.rb - test_kind_no_folder
ok 11 - test/test_blinka_minitest.rb - test_result
ok 12 - test/test_blinka_minitest.rb - test_kind
ok 13 - test/test_blinka_minitest.rb - test_message_no_failure
ok 14 - test/test_blinka_minitest.rb - test_source_location

It should format tests as TAP-format, it can be combined with BLINKA_JSON=true or BLINKA_REPORT=true.

1. Update version in CHANGELOG.md and include changes.
2. Update version in lib/blinka_reporter/version.rb.
3. Create pull request and merge to default branch.
4. gem build blinka_reporter.gemspec (make sure it matches the bumped version).
5. gem push blinka-reporter-{version}.gem (had to use --otp because I could not enter it when prompted).
6. Create a release and tag on Github for history.

blinka-reporter is licensed under the MIT license, see LICENSE for details.