testmetrics_minitest 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed676fac58e14542581140eb0f7b6dbfc11df4a3652de9292296e907798a1731
+  data.tar.gz: b4b22d08333b7d8227957d3e1b09c621c0ed9cf101fe79617538ba07e864397c
+SHA512:
+  metadata.gz: 3fdb0d03f98045223a119b1c71ce9c3e65991f65d7765f7dff70338e0635d9225bb36dd0b118757c419ad8f3edfe38d7fb36ab0d5ae58e783d9d7ea798c37d42
+  data.tar.gz: c291a41b052ef3fa11376f7e6ae3e33d56ab28fd0221f7679233d0f951473b1802392cf8dd83107b482e87a3fb29162ea5cd4cf2b9cc312959c74d6f9d1b8140

data/.gitignore

@@ -0,0 +1,5 @@
+*.swp
+pkg
+tmp
+test/reports
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,24 @@
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2019 devonestes
+
+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,38 @@
+# Testmetrics MiniTest [![CircleCI](https://circleci.com/gh/Testmetrics/testmetrics_minitest.svg?style=svg)](https://circleci.com/gh/Testmetrics/testmetrics_minitest)
+
+The official MiniTest client for [Testmetrics](https://www.testmetrics.app). This client collects data
+about your MiniTest test suites after being run in CI and sends that data to
+Testmetrics so you can gain valuable insights about your test suite.
+
+## Usage
+
+Add it to your Gemfile in the same groups as MiniTest.
+
+```ruby
+group :test do
+  gem "minitest"
+  gem "testmetrics_minitest"
+end
+```
+
+Then, when you're running your tests in CI, you can pass the `--testmetrics`
+option to turn on the reporter:
+
+```
+bundle exec rake test --testmetrics
+```
+
+You can also turn on the reporter by requiring `'minitest/testmetrics'` in
+your test files.
+
+In order for the metrics to be sent to Testmetrics, you must have your
+Testmetrics Project Key set in the `TESTMETRICS_PROJECT_KEY` environment
+variable in your CI environment. If this environment variable isn't set, the
+collected metrics for your CI run will be discarded.
+
+This key should be kept private and not exposed to the public.
+
+## License
+
+`testmetrics_minitest` is offered under the MIT license. For the full license
+text see [LICENSE](https://github.com/testmetrics/testmetrics_minitest/blob/master/LICENSE).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.test_files = FileList['test/minitest/test_*.rb']
+end
+
+task default: :test

data/circle.yml

@@ -0,0 +1,24 @@
+version: 2
+jobs:
+  build:
+    parallelism: 1
+    docker:
+      - image: circleci/ruby:2.4.2-jessie-node
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: vendor/bundle
+          PGHOST: 127.0.0.1
+          PGUSER: circleci-demo-ruby
+          RAILS_ENV: test
+    steps:
+      - checkout
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+      - run:
+          name: MiniTest run
+          command: bundle exec rake

data/lib/minitest/testmetrics.rb

@@ -0,0 +1,2 @@
+require 'minitest/testmetrics_plugin'
+Minitest::Testmetrics.report!

data/lib/minitest/testmetrics_plugin.rb

@@ -0,0 +1,148 @@
+require 'time'
+require 'faraday'
+require 'json'
+
+module Minitest
+  def self.plugin_testmetrics_options(opts, _options)
+    opts.on "--testmetrics", "Enable Minitest::Testmetrics Reporting." do
+      Testmetrics.report!
+    end
+  end
+
+  def self.plugin_testmetrics_init(options)
+    if Testmetrics.report?
+      self.reporter << Testmetrics.new(options)
+    end
+  end
+
+  class Testmetrics < Reporter
+    class << self
+      def report!
+        @enabled = true
+      end
+
+      def report?
+        @enabled ||= false
+      end
+    end
+
+    attr_accessor :options, :testmetrics_results, :results
+
+    def initialize(options = {})
+      self.options = options
+      self.results = Hash.new { |h, k| h[k] = [] }
+      self.testmetrics_results = {
+        key: ENV['TESTMETRICS_PROJECT_KEY'] || 'Unknown',
+        branch: git_branch,
+        sha: git_sha,
+        metadata: {
+          ruby_version: RUBY_VERSION,
+          ci_platform: ci_platform
+        },
+        tests: []
+      }
+      post_results(testmetrics_results) unless testmetrics_results[:key] == 'Unknown'
+    end
+
+    def start
+      nil
+    end
+
+    def record(result)
+      key = result.respond_to?(:klass) ? result.klass : result.class
+      results[key] << result
+    end
+
+    def report
+      total_time = 0
+      results.each do |name, class_results|
+        class_results.each do |result|
+          total_time += time_in_microseconds(result.time)
+          result.name
+          testmetrics_results[:tests]<< {
+            name: "#{name}.#{result.name.delete("\0").delete("\x01").delete("\e")}",
+            total_run_time: time_in_microseconds(result.time),
+            state: state(result.failure)
+          }
+        end
+
+        testmetrics_results[:total_run_time] = total_time
+
+        puts "\nSending results to Testmetrics server..."
+        post_results(testmetrics_results) unless testmetrics_results[:key] == 'Unknown'
+      end
+    end
+
+    private
+
+    BRANCH_VARS = %w[
+      TRAVIS_EVENT_TYPE
+      CIRCLE_BRANCH
+      CI_COMMIT_REF_NAME
+      BRANCH_NAME
+    ].freeze
+    def git_branch
+      correct_var = correct_var(BRANCH_VARS)
+
+      if correct_var == 'TRAVIS_EVENT_TYPE'
+        travis_branch(correct_var)
+      else
+        correct_var.nil? ? 'Unknown' : ENV[correct_var]
+      end
+    end
+
+    def travis_branch(var)
+      case ENV[var]
+      when 'push'
+        ENV['TRAVIS_BRANCH']
+      when 'pull_request'
+        ENV['TRAVIS_PULL_REQUEST_BRANCH']
+      end
+    end
+
+    SHA_VARS = %w[TRAVIS_COMMIT CIRCLE_SHA1 CI_COMMIT_SHA REVISION].freeze
+    def git_sha
+      correct_var = correct_var(SHA_VARS)
+      correct_var.nil? ? 'Unknown' : ENV[correct_var]
+    end
+
+    def ci_platform
+      case correct_var(SHA_VARS)
+      when 'TRAVIS_COMMIT' then 'Travis CI'
+      when 'CIRCLE_SHA1' then 'Circle CI'
+      when 'CI_COMMIT_SHA' then 'Gitlab CI'
+      when 'REVISION' then 'Semaphore CI'
+      else 'Unknown'
+      end
+    end
+
+    def correct_var(vars)
+      vars.find { |var| !ENV[var].nil? && ENV[var] != '' }
+    end
+
+    def post_results(results)
+      Faraday.post do |req|
+        req.url 'https://www.testmetrics.app/results'
+        req.headers['Content-Type'] = 'application/json'
+        req.body = results.to_json
+      end
+    end
+
+    def time_in_microseconds(time)
+      (time * 1_000_000).round(0)
+    end
+
+    def state(failure)
+      case failure
+      when Skip
+        :pending
+      when UnexpectedError
+        :failed
+      when Assertion
+        :failed
+      else
+        :passed
+      end
+    end
+  end
+end

data/lib/testmetrics_minitest.rb

@@ -0,0 +1,2 @@
+require 'minitest'
+require 'minitest/testmetrics'

data/testmetrics_minitest.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'testmetrics_minitest'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Devon Estes']
+  spec.email         = ['devon.c.estes@gmail.com']
+
+  spec.summary       = 'The official Minitest client for Testmetrics'
+  spec.homepage      = 'https://testmetrics.app'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_runtime_dependency 'faraday', '>= 0.9.0'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: testmetrics_minitest
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Devon Estes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: 
+email:
+- devon.c.estes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- circle.yml
+- lib/minitest/testmetrics.rb
+- lib/minitest/testmetrics_plugin.rb
+- lib/testmetrics_minitest.rb
+- testmetrics_minitest.gemspec
+homepage: https://testmetrics.app
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: The official Minitest client for Testmetrics
+test_files: []