testmetrics_rspec 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb87ffb6200cb3155db8922ec1e0b13b53ee7b56206771524bdcfe34e6ac9eae
-  data.tar.gz: 6daf32f3b36d2ac5b7efdfc2c707f2a2ea590d0fd463c0f2b995f9b819aac9da
+  metadata.gz: 61a13a84f9ca0a791bc49e5883790d2d11273208f465990aca64ae1134e4c6b6
+  data.tar.gz: 7512a2be5780a01369b6ace01a8afd375c03a96742f749047f61c92d286a1a90
 SHA512:
-  metadata.gz: 2bae0f0b5ec46a3454ad87e4a83d0c70ba29283ab6494c14ce5160a765b8273f439539f9f2c314fb8c1459cf567256f21f2403094de38b77b8295ed397deb9f0
-  data.tar.gz: 01e0609b13afefd8840615c948b46efccb359850a662139c445a7f598b188d4ccf1df70637ee7cd80d84fe701834909f04922070b43fcbfe3cb5304347b03c06
+  metadata.gz: 8153b351c7752b79b854de242ef38a9f7c1f4df4f37c48a40d3390c0e849afc186450bb8fb806a6def3e925aa40e5b4bffd82682fd9cfeaa25bc2165d66c6058
+  data.tar.gz: 85ef93d5e182f64ae3600b88774599b36aa638d208d297b708357ecfcbe0cd800297d625eaaf4163bd371498c6523705f5a335f788a25fb5fb7ccdec05c69f48

data/Gemfile

@@ -1,6 +1,4 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in testmetrics_rspec.gemspec
 gemspec

data/README.md

@@ -4,51 +4,60 @@ The official [RSpec][rspec] 2 & 3 client for [Testmetrics](https://www.testmetri
 
 ## Usage
 
-Install the gem:
+Add it to your Gemfile in the same groups as rspec.
 
-```sh
-gem install testmetrics_rspec
-```
-
-Use it:
-
-```sh
-rspec --format TestmetricsRspec 
+```ruby
+group :test do
+  gem "rspec"
+  gem "testmetrics_rspec"
+end
 ```
 
-You can use it in combination with other [formatters][rspec-formatters], too:
+Add `TestmetricsRspec` as a formatter in [your `.rspec` file][rspec-file]:
 
 ```sh
-rspec --format progress --format TestmetricsRspec
+--format TestmetricsRspec
 ```
 
-  [rspec-formatters]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/formatters
+  [bundler]: https://bundler.io
+  [rspec-file]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/configuration/read-command-line-configuration-options-from-files
 
-In order for the metrics to be send to Testmetrics, you must have your
+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.
+collected metrics for your CI run will be discarded.
 
-### Using in your project with Bundler
+This key should be kept private and not exposed to the public.
 
-Add it to your Gemfile if you're using [Bundler][bundler]. Put it in the same groups as rspec.
+### Additional setup for using with the `parallel_tests` gem
 
-```ruby
-group :test do
-  gem "rspec"
-  gem "testmetrics_rspec"
-end
-```
+If you are running your tests in parallel in CI with the `parallel_tests` gem,
+there are additional steps you need to take to start collecting metrics in CI.
+
+First, do the steps listed above.
 
-Put the same arguments as the commands above in [your `.rspec`][rspec-file]:
+If you have a `.rspec_parallel` file, also add `TestmetricsRspec` as a formatter
+there:
 
 ```sh
 --format TestmetricsRspec
 ```
 
-  [bundler]: https://bundler.io
-  [rspec-file]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/configuration/read-command-line-configuration-options-from-files
+Then, add the following task to your `Rakefile`
+
+```ruby
+require 'testmetrics_rspec'
+task :testmetrics_parallel_rspec do
+  TestmetricsRspec::ParallelTests.run()
+end
+```
+
+Lastly, you'll need to change your CI script to use that rake task to run your
+tests. `rake testmetrics_parallel_rspec` (or whatever you name that task - it
+can be whatever you want) is just a wrapper around running `parallel_rspec`, so
+all command line options that you would normally give work just the same. You
+just replace `parallel_rspec` with `rake testmetrics_parallel_rspec` and it will
+work.
 
 ## License
 

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "testmetrics_rspec"
+require 'bundler/setup'
+require 'testmetrics_rspec'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "testmetrics_rspec"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/example/spec/example_spec.rb

@@ -1,20 +1,20 @@
-require "spec_helper"
-require_relative "shared_examples"
+require 'spec_helper'
+require_relative 'shared_examples'
 
-describe "some example specs" do
-  it "should succeed" do
+describe 'some example specs' do
+  it 'should succeed' do
     expect(true).to be(true)
   end
 
-  it "should fail" do
+  it 'should fail' do
     expect(false).to be(true)
   end
 
-  it "should raise" do
+  it 'should raise' do
     raise ArgumentError
   end
 
-  it "should be pending" do
+  it 'should be pending' do
     if defined? skip
       skip
     else
@@ -22,30 +22,30 @@ describe "some example specs" do
     end
   end
 
-  it "shows diffs cleanly" do
-    expect({a: "b", c: "d"}).to eql({a: 2, c: 4})
+  it 'shows diffs cleanly' do
+    expect(a: 'b', c: 'd').to eql(a: 2, c: 4)
   end
 
   it "replaces naughty \0 and \e characters, \x01 and \uFFFF too" do
-    expect("\0\0\0").to eql("emergency services")
+    expect("\0\0\0").to eql('emergency services')
   end
 
   it "escapes controlling \u{7f} characters" do
-    expect("\u{7f}").to eql("pacman om nom nom")
+    expect("\u{7f}").to eql('pacman om nom nom')
   end
 
-  it "can include unicodes 😁" do
-    expect("🚀").to eql("🔥")
+  it 'can include unicodes 😁' do
+    expect('🚀').to eql('🔥')
   end
 
-  it %{escapes <html tags='correctly' and="such &amp; such">} do
-    expect("<p>This is important</p>").to eql("<p>This is <strong>very</strong> important</p>")
+  it %(escapes <html tags='correctly' and="such &amp; such">) do
+    expect('<p>This is important</p>').to eql('<p>This is <strong>very</strong> important</p>')
   end
 
-  it_should_behave_like "shared examples"
+  it_should_behave_like 'shared examples'
 
-  it "can capture stdout and stderr" do
-    $stdout.puts "Test"
-    $stderr.puts "Bar"
+  it 'can capture stdout and stderr' do
+    $stdout.puts 'Test'
+    warn 'Bar'
   end
 end

data/example/spec/shared_examples.rb

@@ -1,10 +1,10 @@
-shared_examples "shared examples" do
-  context "in a shared example" do
-    it "succeeds" do
+shared_examples 'shared examples' do
+  context 'in a shared example' do
+    it 'succeeds' do
       expect(true).to be(true)
     end
 
-    it "also fails" do
+    it 'also fails' do
       expect(false).to be(true)
     end
   end

data/example/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+ENV['PRINT_TESTMETRICS_RESULTS'] = 'true'
 RSpec.configure do |config|
   # register around filter that captures stderr and stdout
   config.around(:each) do |example|

data/lib/testmetrics_rspec/parallel_tests.rb

@@ -0,0 +1,39 @@
+class TestmetricsRspec < RSpec::Core::Formatters::BaseFormatter
+  # This is a wrapper around running RSpec with the `parallel_tests` gem
+  class ParallelTests
+    class << self
+      include ::TestmetricsRspec::Shared
+
+      def run
+        key = ENV['TESTMETRICS_PROJECT_KEY']
+
+        post(starting_results) unless key.nil?
+
+        ENV['PARALLEL_FORMAT'] = 'true'
+        system("parallel_rspec #{ARGV[1..-1].join(' ')}")
+        ENV['PARALLEL_FORMAT'] = nil
+
+        send_end_results unless key.nil?
+      end
+
+      def send_end_results
+        results = Dir.glob('results*.json').each_with_object([]) do |path, acc|
+          acc << JSON.parse(IO.read(path))
+          FileUtils.rm(path)
+        end
+
+        post(combined(results))
+      end
+
+      def combined(results)
+        start = results.pop
+
+        results.each_with_object(start) do |result, acc|
+          acc['tests'] = acc['tests'] + result['tests']
+          acc['total_run_time'] = acc['total_run_time'] +
+                                  result['total_run_time']
+        end
+      end
+    end
+  end
+end

data/lib/testmetrics_rspec/persist.rb

@@ -1,15 +1,45 @@
 class TestmetricsRspec
-  # This sends the results to the Testmetrics server
+  # This sends the results to the Testmetrics server or writes them to a file
+  # if the tests are being run in parallel.
   module Persist
-    def self.call(results)
-      unless results[:key] == "Unknown"
-        Faraday.post do |req|
-            req.url 'https://www.testmetrics.app/results'
-            req.headers['Content-Type'] = 'application/json'
-            req.body = results.to_json
+    class << self
+      include ::TestmetricsRspec::Shared
+      def call(results)
+        puts results if currently_running_tests_for_this_gem?
+        return if project_key_missing?(results)
+
+        persist(results)
+      end
+
+      def persist(results)
+        if running_in_parallel?
+          return if ignore_results?(results)
+
+          write_to_file(results)
+        else
+          post(results)
         end
       end
-      puts results
+
+      def write_to_file(results)
+        IO.write("results#{ENV['TEST_ENV_NUMBER']}.json", results.to_json)
+      end
+
+      def project_key_missing?(results)
+        results[:key] == 'Unknown'
+      end
+
+      def running_in_parallel?
+        ENV['PARALLEL_FORMAT'] == 'true'
+      end
+
+      def ignore_results?(results)
+        results[:tests] == []
+      end
+
+      def currently_running_tests_for_this_gem?
+        ENV['PRINT_TESTMETRICS_RESULTS'] == 'true'
+      end
     end
   end
 end

data/lib/testmetrics_rspec/rspec2.rb

@@ -1,88 +1,22 @@
+# The RSpec 2 formatter
 class TestmetricsRspec < RSpec::Core::Formatters::BaseFormatter
-  def start(example_count)
-    results = {
-      key: ENV['TESTMETRICS_PROJECT_KEY'],
-      branch: git_branch,
-      sha: git_sha,
-      metadata: {
-        ruby_version: RUBY_VERSION,
-        ci_platform: ci_platform
-      },
-      tests: []
-    }
-    TestmetricsRspec::Persist.call(results)
-    super
-  end
+  include ::TestmetricsRspec::Shared
 
   def stop
-    @results = {
-      key: ENV['TESTMETRICS_PROJECT_KEY'],
-      branch: git_branch,
-      sha: git_sha,
-      metadata: {
-        ruby_version: RUBY_VERSION,
-        ci_platform: ci_platform
-      },
-      tests: tests
-    }
+    @results = results do
+      examples.map do |example|
+        format(example.full_description,
+               example.execution_result[:run_time],
+               example.execution_result[:status].to_sym)
+      end
+    end
+
     super
   end
 
   def dump_summary(duration, example_count, failure_count, pending_count)
-    # Send results in microseconds
-    @results[:total_run_time] = (duration * 1_000_000).round(0)
+    @results[:total_run_time] = run_time_in_microseconds(duration)
     TestmetricsRspec::Persist.call(@results)
     super
   end
-
-  private
-
-  def tests
-    examples.map do |example|
-      {
-        name: example.full_description.delete("\0").delete("\x01").delete("\e"),
-        # Send results in microseconds
-        total_run_time: (example.execution_result[:run_time] * 1_000_000).round(0),
-        state: example.execution_result[:status].to_sym
-      }
-    end
-  end
-
-  BRANCH_VARS = ["TRAVIS_EVENT_TYPE", "CIRCLE_BRANCH", "CI_COMMIT_REF_NAME", "BRANCH_NAME"]
-  def git_branch
-    correct_var = BRANCH_VARS.find do |var| ENV[var] != nil && ENV[var] != "" end
-
-    if correct_var == "TRAVIS_EVENT_TYPE"
-      case ENV[correct_var]
-      when "push"
-        ENV["TRAVIS_BRANCH"]
-      when "pull_request"
-        ENV["TRAVIS_PULL_REQUEST_BRANCH"]
-      end
-    else
-      correct_var.nil? ? "Unknown" : ENV[correct_var]
-    end
-  end
-
-  SHA_VARS = ["TRAVIS_COMMIT", "CIRCLE_SHA1", "CI_COMMIT_SHA", "REVISION"]
-  def git_sha
-    correct_var = SHA_VARS.find do |var| ENV[var] != nil end
-    correct_var.nil? ? "Unknown" : ENV[correct_var]
-  end
-
-  def ci_platform
-    correct_var = SHA_VARS.find do |var| ENV[var] != nil end
-    case correct_var
-    when "TRAVIS_COMMIT"
-      "Travis CI"
-    when "CIRCLE_SHA1"
-      "Circle CI"
-    when "CI_COMMIT_SHA"
-      "Gitlab CI"
-    when "REVISION"
-      "Semaphore CI"
-    else
-      "Unknown"
-    end
-  end
 end

data/lib/testmetrics_rspec/rspec3.rb

@@ -1,86 +1,20 @@
+# The RSpec 3 formatter
 class TestmetricsRspec < RSpec::Core::Formatters::BaseFormatter
   RSpec::Core::Formatters.register self, :start, :stop, :dump_summary
-
-  # This sends the "start" message to testmetrics
-  def start(notification)
-    results = {
-      key: ENV['TESTMETRICS_PROJECT_KEY'] || "Unknown",
-      branch: git_branch,
-      sha: git_sha,
-      metadata: {
-        ruby_version: RUBY_VERSION,
-        ci_platform: ci_platform
-      },
-      tests: []
-    }
-    TestmetricsRspec::Persist.call(results)
-    super
-  end
+  include ::TestmetricsRspec::Shared
 
   def stop(notification)
-    tests = notification.notifications.map do |test|
-      {
-        name: test.example.full_description.delete("\0").delete("\x01").delete("\e"),
-        # Send results in microseconds
-        total_run_time: (test.example.execution_result.run_time * 1_000_000).round(0),
-        state: test.example.execution_result.status
-      }
+    @results = results do
+      notification.notifications.map do |test|
+        format(test.example.full_description,
+               test.example.execution_result.run_time,
+               test.example.execution_result.status)
+      end
     end
-
-    @results = {
-      key: ENV['TESTMETRICS_PROJECT_KEY'] || "Unknown",
-      branch: git_branch,
-      sha: git_sha,
-      metadata: {
-        ruby_version: RUBY_VERSION,
-        ci_platform: ci_platform
-      },
-      tests: tests
-    }
   end
 
-  # This sends the "end" message to testmetrics
   def dump_summary(notification)
-    # Send results in microseconds
-    @results[:total_run_time] = (notification.duration * 1_000_000).round(0)
+    @results[:total_run_time] = run_time_in_microseconds(notification.duration)
     TestmetricsRspec::Persist.call(@results)
   end
-
-  BRANCH_VARS = ["TRAVIS_EVENT_TYPE", "CIRCLE_BRANCH", "CI_COMMIT_REF_NAME", "BRANCH_NAME"]
-  def git_branch
-    correct_var = BRANCH_VARS.find do |var| ENV[var] != nil && ENV[var] != "" end
-
-    if correct_var == "TRAVIS_EVENT_TYPE"
-      case ENV[correct_var]
-      when "push"
-        ENV["TRAVIS_BRANCH"]
-      when "pull_request"
-        ENV["TRAVIS_PULL_REQUEST_BRANCH"]
-      end
-    else
-      correct_var.nil? ? "Unknown" : ENV[correct_var]
-    end
-  end
-
-  SHA_VARS = ["TRAVIS_COMMIT", "CIRCLE_SHA1", "CI_COMMIT_SHA", "REVISION"]
-  def git_sha
-    correct_var = SHA_VARS.find do |var| ENV[var] != nil && ENV[var] != "" end
-    correct_var.nil? ? "Unknown" : ENV[correct_var]
-  end
-
-  def ci_platform
-    correct_var = SHA_VARS.find do |var| ENV[var] != nil end
-    case correct_var
-    when "TRAVIS_COMMIT"
-      "Travis CI"
-    when "CIRCLE_SHA1"
-      "Circle CI"
-    when "CI_COMMIT_SHA"
-      "Gitlab CI"
-    when "REVISION"
-      "Semaphore CI"
-    else
-      "Unknown"
-    end
-  end
 end

data/lib/testmetrics_rspec/shared.rb

@@ -0,0 +1,91 @@
+class TestmetricsRspec < RSpec::Core::Formatters::BaseFormatter
+  # Shared stuff between formatters
+  module Shared
+    def start(notification)
+      TestmetricsRspec::Persist.call(starting_results)
+      super
+    end
+
+    def post(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 format(description, run_time, status)
+      {
+        name: description.delete("\0").delete("\x01").delete("\e"),
+        total_run_time: run_time_in_microseconds(run_time),
+        state: status
+      }
+    end
+
+    def starting_results
+      results { [] }
+    end
+
+    def results
+      {
+        key: ENV['TESTMETRICS_PROJECT_KEY'] || 'Unknown',
+        branch: git_branch,
+        sha: git_sha,
+        metadata: {
+          ruby_version: RUBY_VERSION,
+          ci_platform: ci_platform
+        },
+        tests: yield
+      }
+    end
+
+    def run_time_in_microseconds(time)
+      (time * 1_000_000).round(0)
+    end
+
+    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
+  end
+end

data/lib/testmetrics_rspec.rb

@@ -2,11 +2,12 @@ require 'json'
 require 'faraday'
 require 'rspec/core'
 require 'rspec/core/formatters/base_formatter'
+require 'testmetrics_rspec/shared'
+require 'testmetrics_rspec/persist'
+require 'testmetrics_rspec/parallel_tests'
 
 if Gem::Version.new(RSpec::Core::Version::STRING) >= Gem::Version.new('3')
   require 'testmetrics_rspec/rspec3'
 else
   require 'testmetrics_rspec/rspec2'
 end
-
-require 'testmetrics_rspec/persist'

data/testmetrics_rspec.gemspec

@@ -1,26 +1,29 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.name          = "testmetrics_rspec"
-  spec.version       = "1.0.1"
-  spec.authors       = ["Devon Estes"]
-  spec.email         = ["devon.c.estes@gmail.com"]
+  spec.name          = 'testmetrics_rspec'
+  spec.version       = '1.1.0'
+  spec.authors       = ['Devon Estes']
+  spec.email         = ['devon.c.estes@gmail.com']
 
-  spec.summary       = %q{The official RSpec client for Testmetrics}
-  spec.homepage      = "https://testmetrics.app"
+  spec.summary       = 'The official RSpec 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('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # 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.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_runtime_dependency "faraday", ">= 0.9.0"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_runtime_dependency 'faraday', '>= 0.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testmetrics_rspec
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Devon Estes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-04 00:00:00.000000000 Z
+date: 2019-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,9 +87,11 @@ files:
 - example/spec/shared_examples.rb
 - example/spec/spec_helper.rb
 - lib/testmetrics_rspec.rb
+- lib/testmetrics_rspec/parallel_tests.rb
 - lib/testmetrics_rspec/persist.rb
 - lib/testmetrics_rspec/rspec2.rb
 - lib/testmetrics_rspec/rspec3.rb
+- lib/testmetrics_rspec/shared.rb
 - testmetrics_rspec.gemspec
 homepage: https://testmetrics.app
 licenses: []