blinka-reporter 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad98fd45f2147f5fd55ca1d55c6f672feacbe41ac3b76b192ac6080992901107
-  data.tar.gz: 36abc057b50457b372f1edea9d1e6fadb3088ccf6e9f21db2da2be10d804bfb4
+  metadata.gz: 46f79e8aba9b05128ca43d27e20f0897d9c7eb574403dadf4b6b9777bdc32af8
+  data.tar.gz: '069f1f72d6dcd55a9bdad1a18504a98365a20308a10fe9c890e64cfdf47ffb52'
 SHA512:
-  metadata.gz: 65e2258b6777627483a15f3b1b1d3a8abf3ad5b8f0d88b71f1b32c9745d22cbc6da165864074e00338bb0479c352305ca8841cc242936c4b1bd7a6cc42e43af8
-  data.tar.gz: a5bd248c55c5a164970326fe24a8277ea6b869ad9fab6f9fecab786166c9dc5e982521f2fea5ba9c18408a7023ff3cc39a41af83c67f56996205713e6fc567bf
+  metadata.gz: 76efdffd9a799088d948e28f4153ab3e764caa2e5c12e099735a007b54a4b403f77636627526f6e5f0c725515d402db8f0611efad73fa963cc0310a29f086fed
+  data.tar.gz: 8ace0335d407cd0efae861c79b3c48c14b9d414129a5cc04daec94565a0d4ffeb041be3b3237302a3780cdb9b5a65580f02cbac1db6041f1ad872fb1158a4815

data/.github/dependabot.yml

@@ -0,0 +1,18 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    target-branch: "main"
+
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    target-branch: "main"

data/.github/release.yml

@@ -0,0 +1,9 @@
+changelog:
+  categories:
+    - title: Dependencies 🤖
+      labels:
+        - dependencies
+
+    - title: Changes
+      labels:
+        - "*"

data/.github/workflows/main.yml

@@ -0,0 +1,46 @@
+name: Main
+on:
+  push:
+  workflow_dispatch:
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["2.6", "2.7", "3.0", "3.1"]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Generate lockfile
+        run: bundle lock
+
+      - name: Run Setup
+        run: ./bin/setup
+
+      - name: Run tests
+        env:
+          BLINKA_JSON: true
+        run: bundle exec rake test
+
+      - name: Build and install gem
+        if: always()
+        run: gem build blinka_reporter.gemspec && gem install blinka-reporter-*.gem
+
+      - name: Report to Blinka
+        if: always()
+        env:
+          BLINKA_REPOSITORY: davidwessman/blinka_reporter
+          BLINKA_TEAM_ID: ${{ secrets.BLINKA_TEAM_ID }}
+          BLINKA_TEAM_SECRET: ${{ secrets.BLINKA_TEAM_SECRET }}
+          BLINKA_TAG: ${{ matrix.ruby }}
+        run: blinka_reporter --blinka --tap --path ./blinka_results.json

data/.gitignore

@@ -0,0 +1,28 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor # or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Environment
+/.env
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore all gems
+/*.gem
+Gemfile.lock
+
+.byebug_history
+/node_modules
+yarn-debug.log*
+yarn-error.log*
+.yarn-integrity
+
+/blinka_results.json

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/CHANGELOG.md

@@ -0,0 +1,152 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.6.0] - 2022-02-20
+
+- Adds support for Rspec.
+- Remove support for `BLINKA_REPORT`, instead use `bundle exec blinka-reporter --blinka` for reporting.
+- Remove `BLINKA_TAP` and replace with `bundle exec blinka-reporter --tap`.
+- Restructure gem internals.
+- Support Rspec screenshots.
+
+## [0.5.2] - 2022-02-01
+
+- Require MFA for pushing to [Rubygems](https://guides.rubygems.org/mfa-requirement-opt-in/)
+
+## [0.5.1] - 2022-02-01
+
+- Look for screenshots in `Capybara.save_path` to allow different output folders for screenshots.
+  - For example a Rails application can be configured with `Capybara.save_path = ENV.fetch('CAPYBARA_ARTIFACTS', './tmp/capybara')` which can then be overriden in CI.
+
+## [0.5.0] - 2022-01-21
+
+### Added
+
+- `BLINKA_APPEND` allows multiple test-runs to be appended to the same JSON-file.
+
+## [0.4.0] - 2021-03-27
+
+### Changed
+
+- Change tempus of failing results from `failed` to `fail`.
+
+## [0.3.6] - 2021-03-25
+
+### Changed
+
+- Removes dependency on mimemagic.
+- Only allow images of `jpeg` or `png` format, handles their mime-types by extension.
+
+## [0.3.5] - 2021-03-11
+
+### Changed
+
+- Move commit and tag to JSON-report instead of setting in the reporting client.
+  This allows the report to be made by a general script instead of in the test environment. In preparation of supporting Github Actions without access to secrets.
+
+## [0.3.4] - 2021-02-24
+
+### Changed
+
+- Reported test cases now include the line in the file where they are defined, previously the line number was connected to the backtrace.
+
+## [0.3.3] - 2021-02-13
+
+### Added
+
+- Use `HEROKU_TEST_RUN_COMMIT_VERSION` defined on Heroku CI when reporting test results to Blinka.
+
+## [0.3.2] - 2021-02-12
+
+### Fixed
+
+- Allow to report with `BLINKA_REPORT` while using in tests `WebMock`.
+
+## [0.3.1] - 2021-02-12
+
+### Added
+
+- Setting `BLINKA_REPORT` with credentials allow report to be sent to Blinka directly at the end of the test run.
+
+## [0.3.0] - 2021-02-08
+
+### Changed
+
+- BREAKING 🚨 - Require setting environment variable `BLINKA_JSON` to any value to generate `blinka_results.json` used for reporting to Blinka.
+
+## [0.2.1] - 2021-02-08
+
+### Changed
+
+- Raise error if configuration to report to Blinka is missing when reporting.
+
+## [0.2.0] - 2021-02-07
+
+### Added
+
+- Adds support for reporting test results in TAP-format.
+
+## [0.1.1] - 2021-02-04
+
+### Changed
+
+- Correct the homepage on rubygems.
+
+## [0.1.0] - 2021-02-03
+
+### Added
+
+- Support for adding tag to report using `BLINKA_TAG` environment variable.
+
+### Removed
+
+- No longer support `BLINKA_BRANCH`, use `BLINKA_TAG` instead.
+
+## [0.0.3] - 2021-02-02
+
+### Added
+
+- Allow supplying which git commit sha to report.
+
+## [0.0.2] - 2021-02-01
+
+### Added
+
+- Debug print for which commit hash was reported.
+
+## [0.0.1] - 2021-01-31
+
+### Added
+
+- Setup LICENSE and CHANGELOG.
+
+### Fixed
+
+- Handle inconsistency in source_location of test result in Minitest for different versions.
+
+[unreleased]: https://github.com/davidwessman/blinka_reporter/compare/v0.6.0...HEAD
+[0.5.2]: https://github.com/davidwessman/blinka_reporter/compare/v0.5.2...v0.6.0
+[0.5.2]: https://github.com/davidwessman/blinka_reporter/compare/v0.5.1...v0.5.2
+[0.5.1]: https://github.com/davidwessman/blinka_reporter/compare/v0.5.0...v0.5.1
+[0.5.0]: https://github.com/davidwessman/blinka_reporter/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/davidwessman/blinka_reporter/compare/v0.3.6...v0.4.0
+[0.3.6]: https://github.com/davidwessman/blinka_reporter/compare/v0.3.5...v0.3.6
+[0.3.5]: https://github.com/davidwessman/blinka_reporter/compare/v0.3.4...v0.3.5
+[0.3.4]: https://github.com/davidwessman/blinka_reporter/compare/v0.3.3...v0.3.4
+[0.3.3]: https://github.com/davidwessman/blinka_reporter/compare/v0.3.2...v0.3.3
+[0.3.2]: https://github.com/davidwessman/blinka_reporter/compare/v0.3.1...v0.3.2
+[0.3.1]: https://github.com/davidwessman/blinka_reporter/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/davidwessman/blinka_reporter/compare/v0.2.1...v0.3.0
+[0.2.1]: https://github.com/davidwessman/blinka_reporter/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/davidwessman/blinka_reporter/compare/v0.1.1...v0.2.0
+[0.1.1]: https://github.com/davidwessman/blinka_reporter/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/davidwessman/blinka_reporter/compare/v0.0.3...v0.1.0
+[0.0.3]: https://github.com/davidwessman/blinka_reporter/compare/v0.0.2...v0.0.3
+[0.0.2]: https://github.com/davidwessman/blinka_reporter/compare/v0.0.1...v0.0.2
+[0.0.1]: https://github.com/davidwessman/blinka_reporter/releases/tag/v0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blinka_reporter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 David Wessman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,162 @@
+# Blinka reporter
+
+## What does this gem do?
+
+It connects to [supported ruby testing frameworks](#which-ruby-testing-frameworks-are-supported) 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](#how-to-send-report-to-blinka) to [Blinka](#what-is-blinka).
+
+## How do I install the gem?
+
+Run
+
+```sh
+gem install blinka-reporter
+```
+
+or add to your Gemfile
+
+```ruby
+gem 'blinka-repoter', '~> 0.5.0'
+```
+
+## Which ruby testing frameworks are supported?
+
+- Minitest
+- Rspec
+
+> Please reach out for other frameworks or create a reporter yourself.
+
+## What is Blinka?
+
+Blinka is a web service developed by [@davidwessman](https://github.com/davidwessman) to store test results from CI and report interesting results back to Github, right in the pull request.
+
+## How to generate test report in the right format?
+
+### Minitest
+
+```sh
+BLINKA_JSON=true bundle exec rails test
+```
+
+Output as `./blinka_results.json`
+
+### Rspec
+
+Make sure [rspec_junit_formatter](https://github.com/sj26/rspec_junit_formatter) is installed.
+
+```sh
+bundle exec rspec --formatter RspecJunitFormatter --out ./rspec.xml
+```
+
+## How to send report to Blinka?
+
+1. Output your test results as described [above](#how-to-generate-test-report-in-the-right-format).
+1. Configure `BLINKA_TEAM_ID`, `BLINKA_TEAM_SECRET`, `BLINKA_REPOSITORY`.
+1. `bundle exec blinka-reporter --path {./blinka_results.json,./rspec.xml} --blinka`
+
+## How can I send report in Github Action?
+
+Add a step to your Github Action Workflow after running tests:
+
+````yaml
+- name: Minitest
+  env:
+    BLINKA_JSON: true
+  run: bundle exec rake test
+
+- name: Report minitest to Blinka
+  env:
+    BLINKA_COMMIT: ${{ github.event.pull_request.head.sha || github.sha }}
+    BLINKA_REPOSITORY: davidwessman/blinka_reporter
+    BLINKA_TAG: ""
+    BLINKA_TEAM_ID: ${{ secrets.BLINKA_TEAM_ID }}
+    BLINKA_TEAM_SECRET: ${{ secrets.BLINKA_TEAM_SECRET }}
+  run: bundle exec blinka-reporter --path ./blinka_results.json --blinka
+
+
+```yaml
+- name: Rspec
+  run: bundle exec rspec --formatter RspecJunitFormatter --out ./rspec.xml
+- name: Report minitest to Blinka
+  env:
+    BLINKA_COMMIT: ${{ github.event.pull_request.head.sha || github.sha }}
+    BLINKA_REPOSITORY: davidwessman/blinka_reporter
+    BLINKA_TAG: ""
+    BLINKA_TEAM_ID: ${{ secrets.BLINKA_TEAM_ID }}
+    BLINKA_TEAM_SECRET: ${{ secrets.BLINKA_TEAM_SECRET }}
+  run: bundle exec blinka-reporter --path ./rspec.xml --blinka
+````
+
+`BLINKA_TAG` is optional and can be used to separate different reports, for example when using a build matrix.
+
+## How to make multiple test runs into one report?
+
+**Only supported for Minitest, open an issue for Rspec-support**
+
+For example when running tests in parallel you might need to run system tests separately.
+By first using `BLINKA_JSON` it will create a clean file, `BLINKA_APPEND` will append the results.
+
+```yaml
+- name: System tests
+  env:
+    BLINKA_JSON: true
+    PARALLEL_WORKERS: 1
+  run: bundle exec rails test:system
+
+- name: Tests
+  env:
+    BLINKA_JSON: true
+    BLINKA_APPEND: true
+  run: bundle exec rails test
+
+- name: Report to Blinka
+  env:
+    BLINKA_COMMIT: ${{ github.event.pull_request.head.sha || github.sha }}
+    BLINKA_REPOSITORY: davidwessman/blinka_reporter
+    BLINKA_TAG: ""
+    BLINKA_TEAM_ID: ${{ secrets.BLINKA_TEAM_ID }}
+    BLINKA_TEAM_SECRET: ${{ secrets.BLINKA_TEAM_SECRET }}
+  run: bundle exec blinka-reporter --path ./blinka_results.json --blinka
+```
+
+## How can I report tests in TAP-format?
+
+TAP-format ([Test anything protocol](https://testanything.org)) is used to parse tests results on for example Heroku CI.
+
+Generate your test results like [above](#how-to-generate-test-report-in-the-right-format),
+replace `<path>` with your json or xml file.
+
+```sh
+bundle exec blinka-reporter --tap --path <path>
+
+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
+```
+
+# Development
+
+## Release new version
+
+1. Update version in [`CHANGELOG.md`](./CHANGELOG.md) and include changes.
+1. Update version in [`lib/blinka_reporter/version.rb`](./lib/blinka_reporter/version.rb).
+1. Create pull request and merge to default branch.
+1. `gem build blinka_reporter.gemspec` (make sure it matches the bumped version).
+1. `gem push blinka-reporter-{version}.gem` (had to use `--otp` because I could not enter it when prompted).
+1. Create a release and tag on Github for history.
+
+# License
+
+`blinka-reporter` is licensed under the MIT license, see [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+require 'dotenv/load'
+
+Rake::TestTask.new { |t| t.libs << 'test' }
+
+desc('Run tests')
+task(default: :test)

data/bin/blinka_reporter

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require "blinka_reporter/cli"
+
+exit BlinkaReporter::Cli.run(ARGV)

data/bin/setup

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+set -e
+
+# CI-specific setup
+if [ -n "$GITHUB_ACTIONS" ]; then
+  bundle config path vendor/bundle
+  bundle config jobs 4
+  bundle config retry 3
+  git config --global user.name 'GitHub Actions'
+  git config --global user.email 'github-actions@blinka'
+fi
+
+gem install bundler --conservative
+bundle check || bundle install

data/blinka_reporter.gemspec

@@ -0,0 +1,41 @@
+require_relative 'lib/blinka_reporter/version'
+
+Gem::Specification.new do |gem|
+  gem.authors = ['David Wessman']
+  gem.description =
+    'Use to format test results from Minitest to use with Blinka.'
+  gem.email = 'david@wessman.co'
+  gem.homepage = 'https://github.com/davidwessman/blinka_reporter'
+  gem.license = 'MIT'
+  gem.summary = 'Format tests for Blinka'
+
+  gem.metadata = {
+    'homepage_uri' => 'https://github.com/davidwessman/blinka_reporter',
+    'bug_tracker_uri' =>
+      'https://github.com/davidwessman/blinka_reporter/issues',
+    'documentation_uri' => 'https://github.com/davidwessman/blinka_reporter',
+    'changelog_uri' =>
+      'https://github.com/davidwessman/blinka_reporter/main/CHANGELOG.md',
+    'source_code_uri' => 'https://github.com/davidwessman/blinka_reporter',
+    'rubygems_mfa_required' => 'true'
+  }
+
+  gem.files =
+    Dir.chdir(File.expand_path('..', __FILE__)) do
+      `git ls-files -z`
+        .split("\x0")
+        .reject { |f| f.match(%r{^(test|spec|features)/}) }
+    end
+  gem.name = 'blinka-reporter'
+  gem.version = BlinkaReporter::VERSION
+  gem.executables = ['blinka_reporter']
+  gem.require_path = ['lib']
+
+  gem.add_dependency('httparty', '~> 0.18')
+  gem.add_dependency('ox', '~> 2')
+  gem.add_development_dependency('dotenv', '~> 2.7.6')
+  gem.add_development_dependency('minitest', '~> 5.0')
+  gem.add_development_dependency('mocha', '~> 1.12')
+  gem.add_development_dependency('rake', '~> 13')
+  gem.add_development_dependency('webmock', '~> 3.11')
+end