testmetrics_rspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca2804b98b037c67b23476d07586b3f8c8e0843ffb8ef8b98fbdc7eced0d956b
+  data.tar.gz: d402bac313a1668ee771a38347caf94eaa272e3ad44962fe4aa04835935e5ffa
+SHA512:
+  metadata.gz: 88a93ab6b35b8fdcca980850eaf63cd96eb6438fdd7c94ff04e499e67db871b51c78687f0a4b4330007b19223382f3d377e939c09a4fa3bad431809f4558c09a
+  data.tar.gz: 49bb0f27a4ff2944199df67b0df5ef7ac818c4d1edb39c4a057bfdb5cd570939ed342d1494dcebc8956380a6a45107d6997c135cade0e5dc6ad16d648bbe2ed4

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    testmetrics_rspec (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  testmetrics_rspec!
+
+BUNDLED WITH
+   1.16.5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Testmetrics
+
+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,2 @@
+# testmetrics_rspec
+The official RSpec client for Testmetrics

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/.rspec

@@ -0,0 +1 @@
+--format TestmetricsRSpec

data/example/spec/example_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+require_relative "shared_examples"
+
+describe "some example specs" do
+  it "should succeed" do
+    expect(true).to be(true)
+  end
+
+  it "should fail" do
+    expect(false).to be(true)
+  end
+
+  it "should raise" do
+    raise ArgumentError
+  end
+
+  it "should be pending" do
+    if defined? skip
+      skip
+    else
+      pending
+    end
+  end
+
+  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")
+  end
+
+  it "escapes controlling \u{7f} characters" do
+    expect("\u{7f}").to eql("pacman om nom nom")
+  end
+
+  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>")
+  end
+
+  it_should_behave_like "shared examples"
+
+  it "can capture stdout and stderr" do
+    $stdout.puts "Test"
+    $stderr.puts "Bar"
+  end
+end

data/example/spec/shared_examples.rb

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

data/example/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+RSpec.configure do |config|
+  # register around filter that captures stderr and stdout
+  config.around(:each) do |example|
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+
+    example.run
+
+    example.metadata[:stdout] = $stdout.string
+    example.metadata[:stderr] = $stderr.string
+
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+end

data/lib/testmetrics_rspec/persist.rb

@@ -0,0 +1,6 @@
+# This sends the results to the Testmetrics server
+module TestmetricsRspec::Persist
+  def self.call(results)
+    puts results
+  end
+end

data/lib/testmetrics_rspec/rspec2.rb

@@ -0,0 +1,79 @@
+class TestmetricsRspec < RSpec::Core::Formatters::BaseFormatter
+  attr_reader :started
+
+  def start(example_count)
+    @started = Time.now
+    super
+  end
+
+  def dump_summary(duration, example_count, failure_count, pending_count)
+    super
+  end
+
+private
+
+  def result_of(example)
+    example.execution_result[:status].to_sym
+  end
+
+  def example_group_file_path_for(example)
+    meta = example.metadata
+    while meta[:example_group]
+      meta = meta[:example_group]
+    end
+    meta[:file_path]
+  end
+
+  def classname_for(example)
+    fp = example_group_file_path_for(example)
+    fp.sub(%r{\.[^/.]+\Z}, "").gsub("/", ".").gsub(/\A\.+|\.+\Z/, "")
+  end
+
+  def duration_for(example)
+    example.execution_result[:run_time]
+  end
+
+  def description_for(example)
+    example.full_description
+  end
+
+  def exception_for(example)
+    example.execution_result[:exception]
+  end
+
+  def failure_type_for(example)
+    exception_for(example).class.name
+  end
+
+  def failure_message_for(example)
+    strip_diff_colors(exception_for(example).to_s)
+  end
+
+  def failure_for(example)
+    exception = exception_for(example)
+    message   = strip_diff_colors(exception.message)
+    backtrace = format_backtrace(exception.backtrace, example)
+
+    if shared_group = find_shared_group(example)
+      backtrace << "Shared Example Group: \"#{shared_group.metadata[:shared_group_name]}\" called from #{shared_group.metadata[:example_group][:location]}"
+    end
+
+    "#{message}\n#{backtrace.join("\n")}"
+  end
+
+  def find_shared_group(example)
+    group_and_parent_groups(example).find { |group| group.metadata[:shared_group_name] }
+  end
+
+  def group_and_parent_groups(example)
+    example.example_group.parent_groups + [example.example_group]
+  end
+
+  def stdout_for(example)
+    example.metadata[:stdout]
+  end
+
+  def stderr_for(example)
+    example.metadata[:stderr]
+  end
+end

data/lib/testmetrics_rspec/rspec3.rb

@@ -0,0 +1,66 @@
+# Doc
+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)
+    TestmetricsRspec::Persist.call({})
+    super
+  end
+
+  def stop(notification)
+    tests = notification.notifications.map do |test|
+      {
+        name: test.example.full_description,
+        total_run_time: test.example.execution_result.run_time,
+        state: test.example.execution_result.status
+      }
+    end
+
+    @results = {
+      total_run_time: nil,
+      key: ENV['TESTMETRICS_PROJECT_KEY'],
+      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)
+    @results[:total_run_time] = notification.duration
+    TestmetricsRspec::Persist.call(@results)
+  end
+
+  BRANCH_VARS = ["TRAVIS_BRANCH", "CIRCLE_BRANCH", "CI_COMMIT_REF_NAME", "BRANCH_NAME"]
+  def git_branch
+    correct_var = BRANCH_VARS.find do |var| ENV[var] != nil end
+    correct_var.nil? ? nil : ENV[correct_var]
+  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? ? nil : 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/version.rb

@@ -0,0 +1,2 @@
+  VERSION =
+end

data/lib/testmetrics_rspec.rb

@@ -0,0 +1,10 @@
+require 'rspec/core'
+require 'rspec/core/formatters/base_formatter'
+
+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

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "testmetrics_rspec"
+  spec.version       = "0.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"
+
+  # 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)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: testmetrics_rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Devon Estes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-02 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- devon.c.estes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/.rspec
+- example/spec/example_spec.rb
+- example/spec/shared_examples.rb
+- example/spec/spec_helper.rb
+- lib/testmetrics_rspec.rb
+- lib/testmetrics_rspec/persist.rb
+- lib/testmetrics_rspec/rspec2.rb
+- lib/testmetrics_rspec/rspec3.rb
+- lib/testmetrics_rspec/version.rb
+- testmetrics_rspec.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 RSpec client for Testmetrics
+test_files: []