blinka-reporter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f41cbd0de7d1ac7f76f2c6851c15601b96b62ff4eae50ef87bf6a7c6cd17a71
+  data.tar.gz: 121c8bd87cb7ee1774d174c1e38c1985d902f0f84e9301b5139f99c5dee056c6
+SHA512:
+  metadata.gz: b5c19402bd82d52180918458f1718d04963af0e091009443d60e018b21f46a841299313d613c10d209e6e126e9a2d50e22795302d4945f7b245f1b5cbf390b1b
+  data.tar.gz: 593d9f154261a39cee153067e4a4548a2fac34b8021aa75f1fe89039201e6ce928031892062e7103a2f86dfe31757e4a4a37175b2f17b5604a69175ccbafbeb4

data/lib/blinka_client.rb

@@ -0,0 +1,161 @@
+require 'mimemagic'
+require 'httparty'
+
+class BlinkaClient
+  class BlinkaConfig
+    attr_reader(
+      :branch,
+      :commit,
+      :host,
+      :repository,
+      :team_id,
+      :team_secret,
+      :jwt_token
+    )
+    def initialize
+      @host = ENV.fetch('BLINKA_HOST', 'https://blinkblink.herokuapp.com')
+      @team_id = ENV.fetch('BLINKA_TEAM_ID')
+      @team_secret = ENV.fetch('BLINKA_TEAM_SECRET')
+      @repository = ENV.fetch('BLINKA_REPOSITORY')
+      @branch = ENV.fetch('BLINKA_BRANCH')
+      @commit = `git rev-parse HEAD`.chomp
+    end
+  end
+
+  class BlinkaError < StandardError; end
+  include HTTParty
+
+  def initialize
+    @config = BlinkaConfig.new
+    self.class.base_uri("#{@config.host}/api/v1")
+  end
+
+  def report(filepath: './blinka_results.json')
+    self.authenticate
+    data = JSON.parse(File.open(filepath).read)
+
+    results =
+      data
+        .fetch('results', [])
+        .map do |result|
+          if result.key?('image')
+            result['image'] =
+              BlinkaClient.upload_image(filepath: result['image'])
+            result
+          else
+            result
+          end
+        end
+
+    body = {
+      report: {
+        repository: @config.repository,
+        branch: @config.branch,
+        commit: @config.commit,
+        metadata: {
+          total_time: data.dig('total_time'),
+          nbr_tests: data.dig('nbr_tests'),
+          nbr_assertions: data.dig('nbr_assertions'),
+          seed: data.dig('seed')
+        }.compact,
+        results: results
+      }
+    }
+
+    response =
+      self.class.post(
+        '/report',
+        body: body.to_json,
+        headers: {
+          'Content-Type' => 'application/json',
+          'Authorization' => "Bearer #{@jwt_token}"
+        }
+      )
+    case response.code
+    when 200
+      puts "Reported #{data.dig('nbr_tests')} tests!"
+    else
+      raise(BlinkaError, "Could not report, got response code #{response.code}")
+    end
+  end
+
+  def self.upload_image(filepath:)
+    return unless File.exist?(filepath)
+
+    file = File.open(filepath)
+    filename = File.basename(filepath)
+    content_type = MimeMagic.by_magic(file).type
+
+    presigned_post =
+      BlinkaClient.presign_image(filename: filename, content_type: content_type)
+    BlinkaClient.upload_to_storage(presigned_post: presigned_post, file: file)
+
+    puts "Uploaded: #{filename}"
+    BlinkaClient.to_shrine_object(
+      presigned_post: presigned_post,
+      file: file,
+      filename: filename
+    )
+  end
+
+  def authenticate
+    response =
+      self.class.post(
+        '/authentication',
+        body: {
+          token_id: @config.team_id,
+          token_secret: @config.team_secret
+        }.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    case response.code
+    when 200
+      @jwt_token = JSON.parse(response.body).dig('auth_token')
+    else
+      raise(BlinkaError, 'Could not authenticate to API')
+    end
+  end
+
+  def self.presign_image(filename:, content_type:)
+    response =
+      self.get(
+        '/presign',
+        body: { filename: filename, content_type: content_type }
+      )
+
+    case response.code
+    when 200
+      JSON.parse(response.body)
+    else
+      raise(BlinkaError, 'Could not presign file')
+    end
+  end
+
+  def self.upload_to_storage(presigned_post:, file:)
+    url = URI.parse(presigned_post.fetch('url'))
+    fields = presigned_post.fetch('fields')
+
+    body = presigned_post['fields'].merge({ 'file' => file.read })
+    response = HTTParty.post(url, multipart: true, body: body)
+
+    case response.code
+    when 204
+      true
+    else
+      raise(BlinkaError, 'Could not upload file to storage')
+    end
+  end
+
+  def self.to_shrine_object(presigned_post:, file:, filename:)
+    storage, idx = presigned_post.dig('fields', 'key').split('/')
+    {
+      "id": idx,
+      "storage": storage,
+      "metadata": {
+        "size": file.size,
+        "filename": filename,
+        "mime_type": presigned_post.dig('fields', 'Content-Type')
+      }
+    }
+  end
+end

data/lib/blinka_minitest.rb

@@ -0,0 +1,92 @@
+class BlinkaMinitest
+  attr_reader(:test_result)
+  def initialize(test_result)
+    @test_result = test_result
+  end
+
+  def path
+    @path ||= source_location.first.gsub(Dir.getwd, '').delete_prefix('/')
+  end
+
+  # Handle broken API in Minitest between 5.10 and 5.11
+  # https://github.com/minitest-reporters/minitest-reporters/blob/e9092460b5a5cf5ca9eb375428217cbb2a7f6dbb/lib/minitest/reporters/default_reporter.rb#L159
+  def source_location
+    if test_result.respond_to?(:klass)
+      test_result.source_location
+    else
+      test_result.method(test_result.name).source_location
+    end
+  end
+
+  def kind
+    parts = self.path.gsub('test/', '').split('/')
+    parts.length > 1 ? parts.first : 'general'
+  end
+
+  def message
+    failure = test_result.failure
+    return unless failure
+    "#{failure.error.class}: #{failure.error.message}"
+  end
+
+  def backtrace
+    return unless test_result.failure
+    Minitest.filter_backtrace(test_result.failure.backtrace)
+  end
+
+  def result
+    if test_result.error?
+      :error
+    elsif test_result.skipped?
+      :skip
+    elsif test_result.failure
+      :failed
+    else
+      :pass
+    end
+  end
+
+  def line
+    current_backtrace = backtrace
+    return if current_backtrace.nil?
+
+    row =
+      current_backtrace
+        .map { |row| row.split(':')[0..1] }
+        .detect { |row| row[0] == path }
+
+    return if row.nil?
+    row[1].to_i
+  end
+
+  def time
+    test_result.time
+  end
+
+  def name
+    test_result.name
+  end
+
+  def image
+    return unless kind == 'system'
+
+    image_path = "./tmp/screenshots/failures_#{name}.png"
+    return unless File.exist?(image_path)
+
+    image_path
+  end
+
+  def report
+    {
+      backtrace: backtrace,
+      message: message,
+      line: line,
+      image: image,
+      kind: kind,
+      name: name,
+      path: path,
+      result: result,
+      time: time
+    }.compact
+  end
+end

data/lib/minitest/blinka_plugin.rb

@@ -0,0 +1,46 @@
+require 'minitest'
+require 'json'
+require 'blinka_minitest'
+
+module Minitest
+  def self.plugin_blinka_init(options)
+    reporter.reporters << BlinkaPlugin::Reporter.new(options[:io], options)
+  end
+
+  def plugin_blinka_options(opts, options); end
+
+  module BlinkaPlugin
+    class Reporter < Minitest::StatisticsReporter
+      attr_accessor :tests
+
+      def initialize(io = $stdout, options = {})
+        super
+        self.tests = []
+      end
+
+      def record(test)
+        super
+        tests << test
+      end
+
+      def report
+        super
+
+        result = {
+          total_time: total_time,
+          nbr_tests: count,
+          nbr_assertions: assertions,
+          seed: options[:seed],
+          results:
+            tests.map { |test_result| BlinkaMinitest.new(test_result).report }
+        }
+
+        File.open('blinka_results.json', 'w+') do |file|
+          file.write(JSON.pretty_generate(result))
+        end
+        puts
+        puts('Test results written to `./blinka_results.json`')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: blinka-reporter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Wessman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+description: Use to format test results from Minitest to use with Blinka.
+email: david@wessman.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/blinka_client.rb
+- lib/blinka_minitest.rb
+- lib/minitest/blinka_plugin.rb
+homepage: https://rubygemspec.org/gems/blinka-reporter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Format tests for Blinka
+test_files: []