test_dots 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a467e52898dc1852528c61576ee18dd9f74043d8
+  data.tar.gz: bcf7f771ef4c00f6cd3ba40e603029660033c2e8
+SHA512:
+  metadata.gz: 1125708c5036e636d8324377dc1e4dc85d8c4534ba558dbdacb4177103247f8c2f826f96672b176a44962c8dcd17c1a2fa165db4546ab598ebe9483674245b50
+  data.tar.gz: c080b6225a22d3b72db698a2ad4aa6bbd25dbd1f45c650c1a6499167a6fd2ec20ce540f75b4aae476080f39913b9724395187c7d90c8acfc3ff8dd8bcb848846

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.rspec_status
+
+test_output.log
+
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in test_dots.gemspec
+gemspec

data/README.md

@@ -0,0 +1,86 @@
+## TestDots
+
+This is the Ruby gem for the [Test Dots CI performance monitoring service](https://testdots.com/).
+
+## Installation instructions for a Rails Project
+
+**1.** Add TestDots to your project's Gemfile in the 'test' group.
+
+```ruby
+group :test do
+  gem 'test_dots'
+end
+```
+
+**2.** If you are using RSpec, add the following to your `spec_helper.rb` file. This is not needed for MiniTest.
+
+```ruby
+TestDots.register_rspec_listener
+```
+
+**3.** Configure your API key by setting the `TEST_DOTS_KEY` environment variable in your continuous integration tool.
+
+## Integrating with Test Frameworks
+
+Test Dots integrates with different test frameworks to get timing and result information about your tests.
+
+### Supported Test Frameworks
++ RSpec
++ MiniTest
+
+## Integrating with CI services
+
+The TestDots gem integrates with different CI services to gather more information about each of your builds. It does this by looking at the environment variables CI services set such as the build number and the name of the branch being built.
+
+### Supported CI services
++ TravisCI
++ CircleCI
++ Jenkins
+
+### Writing a custom adapter
+
+If you want to write your own CI adapter you should:
++ Subclass `TestDots::CIAdapters::Base`
++ Implement any of the `branch`, `build` and `url` methods
+  + `build` should return a unique identifier to represent the build. Multiple parts of the same build can return the same value.
+  + `url` should return be a URL that can be followed to view this build in you CI service.
+  + `branch` should return be the name of commit or branch being built
++ Change the `ci_adapter` configuration option to use your adapter.
+
+For example, for a fictional 'CoolCI' service, you might write:
+
+```ruby
+class CoolCI < TestDots::CIAdapters::Base
+  def branch
+    ENV['COOL_CI_BRANCH']
+  end
+
+  def build
+    ENV['COOL_CI_BUILD_NUM']
+  end
+
+  def url
+    ENV['COOL_CI_BUILD_URL']
+  end
+end
+
+TestDots.configure do |config|
+  config.ci_adapter = CoolCI.new
+end
+```
+
+
+## Configuration options
+
+You can override the default configuration options by passing a block to `TestDots.configure`. This can be done in your `test_helper.rb` or `spec_helper.rb` files.
+
+```ruby
+TestDots.configure do |config|
+  config.api_key = ENV['MY_TEST_DOTS_KEY']
+end
+```
+
+| Option | Use  | Default |
+|:-:|:-:|:-:|
+| `api_key`  | Your projects API key. If not set, the test suite will not be monitored  | The value of the `TEST_DOTS_KEY` environment variable |
+| `ci_adapter`  | What CI service to integrate with | Picks the an adapter based on the [supported CI services](#Supported-CI-Services) |

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 "test_dots"
+
+# 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/examples/minitest/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gem "minitest"
+gem 'test_dots', path: '../../'
+gem 'rake'

data/examples/minitest/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: ../..
+  specs:
+    test_dots (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.10.3)
+    rake (12.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  rake
+  test_dots!
+
+BUNDLED WITH
+   1.15.4

data/examples/minitest/Rakefile

@@ -0,0 +1,6 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/examples/minitest/test/features/feature_example_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class FeatureExampleTest < Minitest::Test
+  def test_numerics
+    assert_equal 1, 1
+  end
+
+  def test_booleans
+    assert_equal true, true
+  end
+end

data/examples/minitest/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'test_dots'
+require 'minitest/autorun'
+
+TestDots.configure do |config|
+  config.use_ssl = false
+end

data/examples/minitest/test/units/unit_example_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class UnitExampleTest < Minitest::Test
+  def test_it_passes
+    assert_equal true, true
+  end
+
+  def test_it_fails
+    assert_equal true, false
+  end
+end

data/examples/minitest_specs/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gem "minitest"
+gem 'test_dots', path: '../../'

data/examples/minitest_specs/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: ../..
+  specs:
+    test_dots (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.10.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  test_dots!
+
+BUNDLED WITH
+   1.15.1

data/examples/minitest_specs/example_test.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler/setup'
+require "minitest/autorun"
+require 'test_dots'
+
+TestDots.configure do |config|
+  config.use_ssl = false
+end
+
+describe 'TestExample' do
+  describe "passing" do
+    it 'passes' do
+      assert_equal true, true
+    end
+  end
+
+  it 'fails' do
+    assert_equal true, false
+  end
+end

data/examples/rspec/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gem "rspec"
+gem 'test_dots', path: '../../'

data/examples/rspec/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: ../..
+  specs:
+    test_dots (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  test_dots!
+
+BUNDLED WITH
+   1.15.1

data/examples/rspec/spec/features/feature_example_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+RSpec.describe "feature example" do
+  it 'works with numbers' do
+    expect(1).to eq(1)
+  end
+
+  it 'works with booleans' do
+    expect(true).to eq(true)
+  end
+end

data/examples/rspec/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'test_dots'
+
+TestDots.configure do |config|
+  config.use_ssl = false
+end
+
+TestDots.register_rspec_listener

data/examples/rspec/spec/units/unit_example_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+RSpec.describe "unit example" do
+  it 'is passing' do
+    expect(true).to be(true)
+  end
+
+  it 'is failing' do
+    expect(true).to be(false)
+  end
+end

data/examples/rspec_custom_adapter/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gem "rspec"
+gem 'test_dots', path: '../../'

data/examples/rspec_custom_adapter/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: ../..
+  specs:
+    test_dots (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  test_dots!
+
+BUNDLED WITH
+   1.16.0

data/examples/rspec_custom_adapter/example_spec.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'test_dots'
+
+class MyAdapter < TestDots::CIAdapters::Base
+  def build
+    'a-build'
+  end
+
+  def branch
+    'a-branch'
+  end
+
+  def url
+    'http://example.com/a-url'
+  end
+end
+
+TestDots.configure do |config|
+  config.use_ssl = false
+  config.ci_adapter = MyAdapter.new
+end
+
+TestDots.register_rspec_listener
+
+RSpec.describe "example" do
+  describe 'odd and even' do
+    it 'returns true' do
+      expect(2.even?).to be(true)
+    end
+
+    it 'returns false' do
+      expect(5.even?).to be(false)
+    end
+  end
+end

data/examples/rspec_full/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gem "rspec"
+gem 'test_dots', path: '../../'

data/examples/rspec_full/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: ../..
+  specs:
+    test_dots (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  test_dots!
+
+BUNDLED WITH
+   1.16.0

data/examples/rspec_full/example_spec.rb

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'test_dots'
+
+TestDots.configure do |config|
+  config.use_ssl = false
+end
+
+TestDots.register_rspec_listener
+
+RSpec.describe "example" do
+  describe 'odd and even' do
+    context 'a group of tests' do
+      it 'returns true' do
+        expect(2.even?).to be(true)
+      end
+
+      it 'returns false' do
+        expect(5.even?).to be(false)
+      end
+    end
+
+    context 'a different' do
+      it 'returns true' do
+        expect(3.odd?).to be(true)
+      end
+
+      it 'returns false' do
+        expect(6.odd?).to be(false)
+      end
+    end
+  end
+
+  it 'is failing' do
+    expect(true).to be(false)
+  end
+
+  it 'errors' do
+    raise 'hi'
+  end
+
+  it 'is intermittent' do
+    random = rand
+    expect(random).to be > 0.5
+  end
+
+  it 'it is variably slow' do
+    sleep(rand * 2)
+    expect(true).to be(true)
+  end
+
+  it 'is slow' do
+    sleep(1.5)
+    expect(true).to be(true)
+  end
+end

data/lib/minitest/test_dots_plugin.rb

@@ -0,0 +1,66 @@
+require 'test_dots'
+require 'pathname'
+
+module Minitest
+  def self.plugin_test_dots_init(_)
+    if TestDots.configuration.collect_test_data?
+      self.reporter << TestDotsReporter.new
+    end
+  end
+
+  class TestDotsReporter < AbstractReporter
+    def initialize
+      @dir = Pathname.new(Dir.pwd)
+      @results = []
+      @start_time = nil
+    end
+
+    def start
+      @start_time = Minitest.clock_time
+    end
+
+    def record(result)
+      status = if result.passed?
+        'passed'
+      elsif result.skipped?
+        'skipped'
+      else
+        'failed'
+      end
+
+      @results << {
+        description: result.name,
+        full_description: "#{result.class}##{result.name}",
+        location: location_for_result(result),
+        run_time: result.time,
+        status: status
+      }
+    end
+
+    def report
+      run_time = Minitest.clock_time - @start_time
+
+      TestDots.send_report(
+        framework: 'minitest',
+        run_time: run_time,
+        results: @results
+      )
+    end
+
+    private
+
+    def location_for_result(result)
+      file, line = result.method(result.name).source_location
+      if file
+        [relative_path(file).to_s, line].join(':')
+      else
+        nil
+      end
+    end
+
+    def relative_path(test_path)
+      expaned_test_path = File.expand_path(test_path, @dir)
+      Pathname.new(expaned_test_path).relative_path_from(@dir)
+    end
+  end
+end

data/lib/test_dots/api.rb

@@ -0,0 +1,20 @@
+require 'openssl'
+
+module TestDots
+  class Api
+    def post(payload)
+      http = Net::HTTP.new(TestDots.configuration.server, TestDots.configuration.port)
+      if TestDots.configuration.use_ssl
+        http.use_ssl = true
+        http.ca_file = TestDots.configuration.cacert_path
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      else
+        http.use_ssl = false
+      end
+      request = Net::HTTP::Post.new(TestDots.configuration.endpoint, 'Content-Type' => 'application/json')
+      request.basic_auth(TestDots.configuration.api_key, "")
+      request.body = payload
+      http.request(request)
+    end
+  end
+end

data/lib/test_dots/ci_adapters/base.rb

@@ -0,0 +1,21 @@
+module TestDots
+  module CIAdapters
+    class Base
+      def active?
+        true
+      end
+
+      def branch
+        '(unknown)'
+      end
+
+      def build
+        nil
+      end
+
+      def url
+        nil
+      end
+    end
+  end
+end

data/lib/test_dots/ci_adapters/circle_ci.rb

@@ -0,0 +1,21 @@
+module TestDots
+  module CIAdapters
+    class CircleCI < TestDots::CIAdapters::Base
+      def active?
+        ENV.has_key?('CIRCLECI')
+      end
+
+      def branch
+        ENV['CIRCLE_BRANCH']
+      end
+
+      def build
+        ENV['CIRCLE_BUILD_NUM']
+      end
+
+      def url
+        ENV['CIRCLE_BUILD_URL']
+      end
+    end
+  end
+end

data/lib/test_dots/ci_adapters/jenkins.rb

@@ -0,0 +1,21 @@
+module TestDots
+  module CIAdapters
+    class Jenkins < TestDots::CIAdapters::Base
+      def active?
+        ENV.has_key?('JENKINS_URL')
+      end
+
+      def branch
+        ENV['GIT_BRANCH']
+      end
+
+      def build
+        ENV['BUILD_NUMBER']
+      end
+
+      def url
+        ENV['BUILD_URL']
+      end
+    end
+  end
+end