blinka-reporter 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c1fc7642c8c305df691452e7c08bf3d0f5cd3f93942fe05123727e7190ce43c
-  data.tar.gz: 5695c3b9e7e5db14f9584515a06b1abbbe36f40900f90226e8f8cf8bfdc6922a
+  metadata.gz: 169cf0a2be6fe787a73ecb591ff4e271ead078adc25cfc762317d4de32871a00
+  data.tar.gz: e54f8c1b7c9521c42ff07c24ddef03489ebdfce0619b5006d0aa26d1eac7f3fc
 SHA512:
-  metadata.gz: 6e3b2bfaf92e19ac3630f3bd89f84f5f53ad065b3c41e47fa8a1f0f80f2300b68ce6eec6368ebd50b9bfa5208ddf75c3c206e5875bbc440bca6ad403c24fe79e
-  data.tar.gz: 2449352484f17be048e5b84c37a715e2130402832481a61534a344ccba7cedb42074d653570f513d33cfbe13907ab5846946b3fe52519804e4893e6de75009a9
+  metadata.gz: cd66de441531a066ed462e241670b0ea2904be084db2dd66819376e78f93d37bb5233709d634048727c8df9fd33e88a0820609c0e38df23f7052c052957cba2b
+  data.tar.gz: 28ee703aeb5a4bdf3ddfea38d443ad9db0692b370cbad8d744c9bb85e6669107723454f15cac24f6bc483b90315a55828776c103724a76aadc6f1458ab305557

data/.github/workflows/main.yml

@@ -8,6 +8,7 @@ jobs:
     name: Tests
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
         ruby: ["2.6", "2.7", "3.0", "3.1"]
 
@@ -29,7 +30,7 @@ jobs:
 
       - name: Run tests
         env:
-          BLINKA_JSON: true
+          BLINKA_PATH: ./results.json
         run: bundle exec rake test
 
       - name: Build and install gem
@@ -38,9 +39,12 @@ jobs:
 
       - 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
+        run: |
+          blinka_reporter \
+          --blinka \
+          --tap \
+          --path ./results.json \
+          --repository davidwessman/blinka_reporter \
+          --tag ${{ matrix.ruby }} \
+          --team-id ${{ secrets.BLINKA_TEAM_ID }} \
+          --team-secret ${{ secrets.BLINKA_TEAM_SECRET }}

data/.gitignore

@@ -26,3 +26,4 @@ yarn-error.log*
 .yarn-integrity
 
 /blinka_results.json
+/results.json

data/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.7.0] - 2022-03-06
+
+- Support multiple `--path` calls to combine results from multiple files.
+- Replaces `BLINKA_JSON` and `BLINKA_APPEND` with `BLINKA_PATH`.
+- Adds all reporter options as CLI-options instead of using environment variables. -`BLINKA_REPOSITORY` => `--repository`
+
 ## [0.6.1] - 2022-02-27
 
 - Rspec
@@ -137,7 +143,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Handle inconsistency in source_location of test result in Minitest for different versions.
 
-[unreleased]: https://github.com/davidwessman/blinka_reporter/compare/v0.6.1...HEAD
+[unreleased]: https://github.com/davidwessman/blinka_reporter/compare/v0.7.0...HEAD
+[0.7.0]: https://github.com/davidwessman/blinka_reporter/compare/v0.6.1...v0.7.0
 [0.6.1]: https://github.com/davidwessman/blinka_reporter/compare/v0.6.0...v0.6.1
 [0.6.0]: 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

data/README.md

@@ -16,7 +16,7 @@ gem install blinka-reporter
 or add to your Gemfile
 
 ```ruby
-gem 'blinka-repoter', '~> 0.5.0'
+gem 'blinka-reporter', '~> 0.7.0'
 ```
 
 ## Which ruby testing frameworks are supported?
@@ -35,10 +35,10 @@ Blinka is a web service developed by [@davidwessman](https://github.com/davidwes
 ### Minitest
 
 ```sh
-BLINKA_JSON=true bundle exec rails test
+BLINKA_PATH=./tests.json bundle exec rails test
 ```
 
-Output as `./blinka_results.json`
+Output as `./tests.json`.
 
 ### Rspec
 
@@ -51,8 +51,7 @@ 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`
+1. `bundle exec blinka_reporter --path {./blinka_results.json,./rspec.xml} --blinka --team-id <BLINKA_TEAM_ID> --team-secret <BLINKA_TEAM_SECRET> --repository davidwessman/blinka_reporter`
 
 ## How can I send report in Github Action?
 
@@ -65,58 +64,59 @@ Add a step to your Github Action Workflow after running tests:
   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
+  run: |
+    bundle exec blinka_reporter \
+      --path ./blinka_results.json \
+      --blinka \
+      --commit ${{ github.event.pull_request.head.sha || github.sha }} \
+      --repository davidwessman/blinka_reporter \
+      --team-id ${{ secrets.BLINKA_TEAM_ID }} \
+      --team-secret ${{ secrets.BLINKA_TEAM_SECRET }}
 ```
 
 ```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
+  run: |
+    bundle exec blinka_reporter \
+      --path ./rspec.xml \
+      --blinka \
+      --commit ${{ github.event.pull_request.head.sha || github.sha }} \
+      --repository davidwessman/blinka_reporter \
+      --team-id ${{ secrets.BLINKA_TEAM_ID }} \
+      --team-secret ${{ secrets.BLINKA_TEAM_SECRET }}
 ```
 
-`BLINKA_TAG` is optional and can be used to separate different reports, for example when using a build matrix.
+`--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.
+Output the test results to different paths with `BLINKA_PATH`.
 
 ```yaml
 - name: System tests
   env:
-    BLINKA_JSON: true
+    BLINKA_PATH: ./system_tests.json
     PARALLEL_WORKERS: 1
   run: bundle exec rails test:system
 
 - name: Tests
   env:
-    BLINKA_JSON: true
-    BLINKA_APPEND: true
+    BLINKA_JSON: ./tests.json
   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
+  run: |
+    bundle exec blinka_reporter \
+      --path ./system_tests.json \
+      --path ./tests.json \
+      --blinka \
+      --commit ${{ github.event.pull_request.head.sha || github.sha }} \
+      --repository davidwessman/blinka_reporter \
+      --team-id ${{ secrets.BLINKA_TEAM_ID }} \
+      --team-secret ${{ secrets.BLINKA_TEAM_SECRET }}
 ```
 
 ## How can I report tests in TAP-format?

data/lib/blinka_reporter/blinka.rb

@@ -99,7 +99,10 @@ module BlinkaReporter
       when 200
         @jwt_token = JSON.parse(response.body).dig('auth_token')
       else
-        raise(BlinkaReporter::Error, 'Could not authenticate to API')
+        raise(
+          BlinkaReporter::Error,
+          "Could not authenticate to API #{response.code}"
+        )
       end
     end
 

data/lib/blinka_reporter/cli.rb

@@ -9,28 +9,58 @@ module BlinkaReporter
           blinka_reporter version #{BlinkaReporter::VERSION}
 
           Options:
-          --tap: Flag for outputting test results in TAP-protocol, helpful on Heroku CI.
-          --blinka: Flag for reporting test results to blinka.app, requires setting environment:
-                    - BLINKA_TEAM_ID
-                    - BLINKA_TEAM_SECRET
-                    - BLINKA_REPOSITORY
-          --path <path>: Path to test results file, works for
-                  - ./blinka_results.json blinka json format [default]
-                  - ./rspec.xml from https://github.com/sj26/rspec_junit_formatter
+          --path <path>: Path to test results file, can be supplied multiple times to combine results
+            - ./blinka_results.json blinka json format
+            - ./rspec.xml from https://github.com/sj26/rspec_junit_formatter
+
+          --tap: Flag for outputting test results in TAP-protocol, helpful on Heroku CI
+          --blinka: Flag for reporting test results to blinka.app, requires also supplying:
+            - --team-id
+            - --team-secret
+            - --repository
+            - --commit
+          --team-id <team-id>: Blinka team id, only used with --blinka
+          --team-secret <team-secret>: Blinka team secret, only used with --blinka
+          --commit <commit>: The commit hash to report
+          --tag <tag>: The tag for the run, for example to separate a test matrix
+          --repository <repository>: The Github repository
+          --host <host>: Override Blink host to send report
+
         EOS
         return 0
       end
 
       tap = (argv.index('--tap') || -1) >= 0
+
+      paths = argv_value_for(argv, '--path')
+
       blinka = (argv.index('--blinka') || -1) >= 0
-      path = argv_value_for(argv, '--path') || './blinka_results.json'
-      BlinkaReporter::Client.report(blinka: blinka, tap: tap, path: path)
-      0
+      commit = argv_value_for(argv, '--commit')&.first
+      repository = argv_value_for(argv, '--repository')&.first
+      tag = argv_value_for(argv, '--tag')&.first
+      team_id = argv_value_for(argv, '--team-id')&.first
+      team_secret = argv_value_for(argv, '--team-secret')&.first
+      host = argv_value_for(argv, '--host')&.first
+
+      client = BlinkaReporter::Client.new
+      data = client.parse(paths: paths)
+      config =
+        BlinkaReporter::Config.new(
+          tag: tag,
+          commit: commit,
+          team_id: team_id,
+          team_secret: team_secret,
+          repository: repository,
+          host: host
+        )
+      client.report(data: data, config: config, tap: tap, blinka: blinka)
     end
 
     def self.argv_value_for(argv, option_name)
-      return unless (index = argv.index(option_name))
-      argv[index + 1]
+      argv
+        .each_index
+        .select { |index| argv[index] == option_name }
+        .map { |index| argv[index + 1] }
     end
   end
 end

data/lib/blinka_reporter/client.rb

@@ -8,44 +8,58 @@ require 'blinka_reporter/tap'
 
 module BlinkaReporter
   class Client
-    def initialize
-      @config = BlinkaReporter::Config.new
-    end
-
-    def report(path: './blinka_results.json', blinka: false, tap: false)
-      unless File.exist?(path)
-        raise(
-          BlinkaReporter::Error,
-          "Could not find #{path}, was it generated when running the tests?"
-        )
-      end
-
-      data =
-        if path.end_with?('.xml')
-          self.class.parse_xml(path: path)
-        elsif path.end_with?('.json')
-          self.class.parse_json(path: path)
-        else
+    def parse(paths: nil)
+      paths ||= ['./blinka_results.json']
+      paths = Array(paths)
+      paths.each do |path|
+        unless File.exist?(path)
           raise(
             BlinkaReporter::Error,
-            "Unknown format of #{path}, needs to be .json or .xml"
+            "Could not find #{path}, make sure the path is correct."
           )
         end
+      end
+
+      merge_results(
+        paths.map do |path|
+          if path.end_with?('.xml')
+            parse_xml(path: path)
+          elsif path.end_with?('.json')
+            parse_json(path: path)
+          else
+            raise(
+              BlinkaReporter::Error,
+              "Unknown format of #{path}, needs to be .json or .xml"
+            )
+          end
+        end
+      )
+    end
 
+    def report(data:, blinka: false, tap: false, config: nil)
       BlinkaReporter::Tap.report(data) if tap
-      BlinkaReporter::Blinka.report(config: @config, data: data) if blinka
+      BlinkaReporter::Blinka.report(config: config, data: data) if blinka
       0
     end
 
-    def self.report(path:, tap: false, blinka: false)
-      Client.new.report(path: path, tap: tap, blinka: blinka)
+    private
+
+    def merge_results(data_array)
+      data = { total_time: 0, nbr_tests: 0, nbr_assertions: 0, results: [] }
+      data_array.each do |result|
+        data[:total_time] += result[:total_time] || 0
+        data[:nbr_tests] += result[:nbr_tests] || 0
+        data[:nbr_assertions] += result[:nbr_assertions] || 0
+        data[:results] += result[:results] || []
+      end
+      data
     end
 
-    def self.parse_json(path:)
+    def parse_json(path:)
       JSON.parse(File.open(path).read, symbolize_names: true)
     end
 
-    def self.parse_xml(path:)
+    def parse_xml(path:)
       data = Ox.load_file(path, { symbolize_keys: true, skip: :skip_none })
       test_suite = data.root
       unless test_suite.name == 'testsuite'
@@ -62,7 +76,7 @@ module BlinkaReporter
       }
     end
 
-    def self.xml_seed(ox_properties)
+    def xml_seed(ox_properties)
       ox_properties.each do |property|
         property.nodes.each do |node|
           return node.attributes[:value] if node.attributes[:name] == 'seed'
@@ -72,7 +86,7 @@ module BlinkaReporter
     end
 
     # Kind is extracted from the second part of spec.models.customer_spec
-    def self.xml_test_cases(test_cases)
+    def xml_test_cases(test_cases)
       test_cases.map do |test_case|
         result = {
           kind: Array(test_case.attributes[:classname]&.split('.'))[1],
@@ -100,7 +114,7 @@ module BlinkaReporter
       end
     end
 
-    def self.get_image_path(backtrace)
+    def get_image_path(backtrace)
       backtrace.each do |text|
         path = /^(\[Screenshot\]|\[Screenshot Image\]):\s([\S]*)$/.match(text)
         next if path.nil?

data/lib/blinka_reporter/config.rb

@@ -3,32 +3,35 @@ require 'blinka_reporter/error'
 module BlinkaReporter
   class Config
     attr_reader(:commit, :host, :repository, :tag, :team_id, :team_secret)
+    DEFAULT_HOST = 'https://www.blinka.app'
 
-    def initialize
-      @commit = find_commit
-      @host = ENV.fetch('BLINKA_HOST', 'https://www.blinka.app')
-      @repository = ENV.fetch('BLINKA_REPOSITORY', nil)
-      @tag = ENV.fetch('BLINKA_TAG', nil)
-      @team_id = ENV.fetch('BLINKA_TEAM_ID', nil)
-      @team_secret = ENV.fetch('BLINKA_TEAM_SECRET', nil)
+    def initialize(
+      tag:,
+      commit:,
+      repository:,
+      host: nil,
+      team_id:,
+      team_secret:
+    )
+      @commit = commit || find_commit
+      @host = host || DEFAULT_HOST
+      @repository = repository
+      @tag = tag
+      @team_id = team_id
+      @team_secret = team_secret
     end
 
     def validate_blinka
-      if @team_id.nil? || @team_secret.nil? || @repository.nil?
+      required = [@team_id, @team_secret, @repository]
+      if required.include?(nil) || required.include?('')
         raise(BlinkaReporter::Error, <<~EOS)
-          Missing configuration, make sure to set required environment variables:
-          - BLINKA_TEAM_ID
-          - BLINKA_TEAM_SECRET
-          - BLINKA_REPOSITORY
-          EOS
+          Missing configuration, make sure to set --team-id, --team-secret, --repository
+        EOS
       end
     end
 
     def find_commit
-      ENV.fetch(
-        'BLINKA_COMMIT',
-        ENV.fetch('HEROKU_TEST_RUN_COMMIT_VERSION', `git rev-parse HEAD`.chomp)
-      )
+      ENV.fetch('HEROKU_TEST_RUN_COMMIT_VERSION', `git rev-parse HEAD`.chomp)
     end
   end
 end

data/lib/blinka_reporter/version.rb

@@ -1,3 +1,3 @@
 module BlinkaReporter
-  VERSION = '0.6.1'.freeze
+  VERSION = '0.7.0'.freeze
 end

data/lib/minitest/blinka_plugin.rb

@@ -11,31 +11,29 @@ module Minitest
   def plugin_blinka_options(opts, options); end
 
   module BlinkaPlugin
-    REPORT_PATH = 'blinka_results.json'.freeze
     class Reporter < Minitest::StatisticsReporter
       attr_accessor :tests
 
-      def initialize(io = $stdout, options = {})
-        super
-        self.tests = []
-      end
-
       def record(test)
         super
+        self.tests ||= []
         tests << test
       end
 
       def report
         super
 
-        json_report(append: !ENV['BLINKA_APPEND'].nil?) if ENV['BLINKA_JSON']
-      rescue BlinkaReporter::Client::BlinkaReporter::Error => error
+        json_report
+      rescue BlinkaReporter::Error => error
         puts(error)
       end
 
       private
 
-      def json_report(append:)
+      def json_report
+        report_path = ENV['BLINKA_PATH']
+        return if report_path.nil? || report_path.eql?('')
+
         result = {
           total_time: total_time,
           nbr_tests: count,
@@ -46,34 +44,13 @@ module Minitest
               BlinkaReporter::MinitestAdapter.new(test_result).report
             end
         }
-        result = append_previous(result) if append
 
-        File.open(REPORT_PATH, 'w+') do |file|
+        File.open(report_path, 'w+') do |file|
           file.write(JSON.pretty_generate(result))
         end
 
         puts
-        puts("Test results written to `#{REPORT_PATH}`")
-      end
-
-      private
-
-      def parse_report
-        return unless File.exist?(REPORT_PATH)
-        JSON.parse(File.read(REPORT_PATH), symbolize_names: true)
-      end
-
-      def append_previous(result)
-        previous = parse_report
-        return if previous.nil?
-        return if result[:commit] != previous[:commit]
-        return if result[:tag] != previous[:tag]
-
-        result[:total_time] += previous[:total_time] || 0
-        result[:nbr_tests] += previous[:nbr_tests] || 0
-        result[:nbr_assertions] += previous[:nbr_assertions] || 0
-        result[:results] += previous[:results] || []
-        result
+        puts("Test results written to `#{report_path}`")
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blinka-reporter
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - David Wessman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-27 00:00:00.000000000 Z
+date: 2022-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty