minitest-flyordie 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28addd70acbe2d5ac79b1edc5f7731b31ee335b2
+  data.tar.gz: af9671b96c82c93ab4bcd782648222d8b7da9516
+SHA512:
+  metadata.gz: 65b647cc5a187468bcb4430c7de3854d49d8c723d34a521f2e02228c487564bfdaff7a02e294c0fe33051f130a6327238fde8136ef4d2aa8199c15f51fb47102
+  data.tar.gz: 2701fdf468f4406f1baa433e16e2a9ce993f7dab0b0822ce5250d0e9c8c9e2be61cbea0aeea672161effa943c6a9b48f7a513f0fa6c7575a43f27e31072fe5c1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 John Stewart
+
+MIT License
+
+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,45 @@
+# Minitest::Flyordie
+
+FlyOrDie is a simple plugin for Minitest that allows you to specify via command-line options a maximum duration for a test to be marked as "slow", and a maximum number of allowable slow tests.  
+If the thresholds are exceeded, the test run will be marked as failed and the list of slow tests will be output.
+FlyOrDie is primarily meant to be used as part of a Continuous Integration (CI) process to ensure test quality, sometimes referred to as a 'test ratchet'.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+gem "minitest-flyordie"
+
+```ruby
+gem 'minitest-flyordie'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+Use the `--maxslow COUNT` flag to set the maximum allowed number of slow tests
+Use the `--slowtime DURATION` flag to specify the duration for a tests to be slow, in milliseconds
+
+Direct invocation:
+
+    `ruby test_thing.rb --maxslow 3 --slowtime 30`
+
+Via rake test runner:
+
+    `TESTOPTS='--maxslow 4 --slowtime 42' rake test`
+
+## Credits
+
+Based on ideas from [Step](https://github.com/stephenaument) and [Nick](https://github.com/nmeans). And code liberally copied from Nick's [minitest-profile](https://github.com/nmeans/minitest-profile) gem.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/minitest-flyordie/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/minitest/flyordie.rb

@@ -0,0 +1,48 @@
+require 'minitest'
+
+module Minitest
+
+  def self.plugin_flyordie_options(opts, options)
+    opts.on "--maxslow COUNT", Integer, "Maximum number of allowable slow tests before build failed." do |c|
+      options[:maxslow] = c
+    end
+    opts.on "--slowtime DURATION", Integer, "Duration of time before a tests is considered slow, in milliseconds" do |c|
+      options[:slowtime] = c
+    end
+  end
+
+  def self.plugin_flyordie_init(options)
+    self.reporter << FlyOrDieReporter.new(options) if options[:maxslow]
+  end
+
+  class FlyOrDieReporter < AbstractReporter
+    attr_accessor :slowtests, :maxslow, :slowtime
+
+    def initialize(options)
+      self.maxslow = options[:maxslow] || 5
+      self.slowtime = options[:slowtime] || 50
+      self.slowtests = []
+    end
+
+    def record(result)
+      slowtests << result if (result.time * 1000) > slowtime
+    end
+
+    def passed?
+      slowtests.length < maxslow
+    end
+
+    def report
+      return if passed?
+      puts
+      puts "#{slowtests.count} tests exceeded the maximum duration of #{slowtime} msec"
+      puts
+      self.slowtests.each do |st|
+        puts "#{sprintf("%5.2f", st.time*1000)} msec -----  #{st.name}"
+      end
+      puts
+    end
+
+  end
+
+end

data/lib/minitest/flyordie/version.rb

@@ -0,0 +1,5 @@
+module Minitest
+  module Flyordie
+    VERSION = "0.0.1"
+  end
+end

data/lib/minitest/flyordie_plugin.rb

@@ -0,0 +1,3 @@
+require "minitest/flyordie/version"
+
+require_relative "./flyordie.rb"

data/minitest-flyordie.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minitest/flyordie/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minitest-flyordie"
+  spec.version       = Minitest::Flyordie::VERSION
+  spec.authors       = ["John Stewart"]
+  spec.email         = ["johns@wellmatchhealth.com"]
+  spec.summary       = %q{Simple Minitest extension to fail test runs on slow tests}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/test/_flyordie_reporter_test.rb

@@ -0,0 +1,13 @@
+require 'minitest'
+require 'minitest/autorun'
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'minitest/flyordie'
+
+describe "slow runs" do
+  5.times do
+    it "is slow" do
+      sleep(90/1000.0)
+      assert true
+    end
+  end
+end

data/test/flyordie_reporter_test.rb

@@ -0,0 +1,19 @@
+require 'minitest'
+require 'minitest/autorun'
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'minitest/flyordie'
+
+describe Minitest::FlyOrDieReporter do
+  it "fails if more than the default are slow" do
+    output = `ruby -Ilib:test test/_flyordie_reporter_test.rb --maxslow 2 2>&1`
+    output.must_match 'test_0001_is slow'
+  end
+  it "succeeds if no tests are slow" do
+    output = `ruby -Ilib:test test/_flyordie_reporter_test.rb --maxslow 2 --slowtime 100 2>&1`
+    output.wont_match 'test_0001_is slow'
+  end
+  it "succeeds if less than the max are slow" do
+    output = `ruby -Ilib:test test/_flyordie_reporter_test.rb --maxslow 6 2>&1`
+    output.wont_match 'test_0001_is slow'
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: minitest-flyordie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Stewart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-01 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: 
+email:
+- johns@wellmatchhealth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/minitest/flyordie.rb
+- lib/minitest/flyordie/version.rb
+- lib/minitest/flyordie_plugin.rb
+- minitest-flyordie.gemspec
+- test/_flyordie_reporter_test.rb
+- test/flyordie_reporter_test.rb
+homepage: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Simple Minitest extension to fail test runs on slow tests
+test_files:
+- test/_flyordie_reporter_test.rb
+- test/flyordie_reporter_test.rb
+has_rdoc: