turtle_hunter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9365dc057a040b08ffdeffa2688e526908c5d16
+  data.tar.gz: 35e84f42ff8fb7dc1fb5229752e8554ec6f3587c
+SHA512:
+  metadata.gz: 586c721345bba12363b863b0cf32094255afebe226113d47bbeed48db5784fc2843bf570e472d8b507f4ab8291a9855b451f9b573f258329ca5ca7582ecc29b0
+  data.tar.gz: 4ca469d45f61182e8f36f632595211f842dc85e0bd520ae7c09795171cb3d142e50cdc51bd857ec176a49da290373da11421dc870f50ccfa110075b30cb6d015

data/Gemfile

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

data/Gemfile.lock

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Chris Woodrich
+
+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,62 @@
+# TurtleHunter
+
+![relevant gif](https://media.tenor.co/images/06d50ee7fa70b2fd636d1916a23063c7/tenor.gif)
+
+Turtle Hunter (https://github.com/doximity/turtle_hunter) is a gem that enforces speed requirements on RSpec specs.  Any spec that takes longer than its allowed threshold will be failed.  Thresholds can be more lenient in CI.  This reduces/eliminates the possibility that a spec passed on your local machine but failed in CI due to hardware/software/latency differences.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "turtle_hunter", github: "doximity/turtle_hunter"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install turtle_hunter
+    
+Set `FAIL_SLOW` to `true`, run specs.
+
+## Configuration
+
+* `FAIL_SLOW`
+  * default: nil
+  * set this to `true` to invoke turtle hunter
+
+
+The following `test` ENV vars can be setup for turtle_hunter, overriding turtle_hunter's defaults.  All times are in milliseconds.
+
+* `SKIP_FLAG`
+  * default: `:allowed_slow_test`
+  * The name of the flag you give specs you want turtle_hunter to skip over
+* `MODEL_THRESHOLD`
+  * default: `2000`
+  * Threshold at which model specs will fail.
+* `CONTROLLER_THRESHOLD`
+  * default: `5000`
+  * Threshold at which controller specs will fail.
+* `FEATURE_THRESHOLD`
+  * default: `20000`
+  * Threshold at which feature specs will fail.
+* `ELSE_THRESHOLD`
+  * default: `5000`
+  * Threshold at which all type other specs will fail.
+* `LENIENCE_FLAG`
+  * default: `nil`
+  * If set to an environment variable that will be present in CI, ie `ENV['CIRCLECI']`, this flag will enable "lenient" turtle_hunting.
+* `LENIENCE_LEVEL`
+  * default: `2.0`
+  * If enabled via `LENIENCE_FLAG`, the factor at which specs are leniently watched.  A `LENIENCE_LEVEL` of 2 and `LENIENCE_FLAG` of `'CIRCLECI'` will enlarge the allowed threshold by 2x of all specs that run on CircleCI.## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/doximity/turtle_hunter.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "turtle_hunter"
+
+# 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/lib/turtle_hunter.rb

@@ -0,0 +1,6 @@
+require "turtle_hunter/version"
+require "turtle_hunter/rspec_init"
+
+module TurtleHunter
+  RspecInit.hunt
+end

data/lib/turtle_hunter/derived_constants.rb

@@ -0,0 +1,11 @@
+module DerivedConstants
+  SKIP_FLAG = :allowed_slow_test
+
+  MODEL_THRESHOLD = ENV.fetch("TH_MODEL_THRESHOLD", 2000).to_i
+  CONTROLLER_THRESHOLD = ENV.fetch("TH_CONTROLLER_THRESHOLD", 5000).to_i
+  FEATURE_THRESHOLD = ENV.fetch("TH_FEATURE_THRESHOLD", 20000).to_i
+  ELSE_THRESHOLD = ENV.fetch("TH_ELSE_THRESHOLD", 5000).to_i
+
+  LENIENCE_FLAG = ENV.fetch("TH_LENIENCE_FLAG", nil)
+  LENIENCE_LEVEL = ENV.fetch("TH_LENIENCE_LEVEL", 2).to_f
+end

data/lib/turtle_hunter/rspec_init.rb

@@ -0,0 +1,11 @@
+require "turtle_hunter/util"
+
+class RspecInit
+  def self.hunt
+    RSpec.configure do |config|
+      config.after do |example|
+        Util.guard_against_slow_spec(example)
+      end
+    end
+  end
+end

data/lib/turtle_hunter/util.rb

@@ -0,0 +1,53 @@
+require_relative 'derived_constants'
+
+module Util
+  include DerivedConstants
+
+  def self.guard_against_slow_spec(example)
+    @example = example
+    return unless passes_preconditions?
+
+    fail_after = set_defaults
+    started_at = example.metadata[:execution_result].started_at
+    now = Time.now
+    runtime = (now - started_at) * 1000
+
+    if runtime > fail_after
+      message = <<-HEREDOC
+      Expected spec to run within #{fail_after} milliseconds but it took #{runtime} milliseconds.
+      Lenience was set to `#{lenience?}`
+
+      If you want to disable turtle_hunter for this run, set `ENV["FAIL_SLOW"]=false` while you run specs.
+
+      If you want to skip turtle_hunter for this spec, add `#{SKIP_FLAG}: true` to the example.
+      HEREDOC
+      fail message
+    end
+  end
+
+  private
+
+  def self.passes_preconditions?
+    return if @example.nil?
+    return if @example.metadata[SKIP_FLAG.to_sym] == true
+    return if ENV["FAIL_SLOW"] != "true"
+    true
+  end
+
+  def self.set_defaults
+    spec_type = @example.metadata[:type]
+    time = case spec_type
+    when :model then MODEL_THRESHOLD
+    when :controller then CONTROLLER_THRESHOLD
+    when :feature then FEATURE_THRESHOLD
+    else ELSE_THRESHOLD
+    end
+
+    time *= LENIENCE_LEVEL.to_f if lenience?
+    time
+  end
+
+  def self.lenience?
+    LENIENCE_FLAG.present? && ENV[LENIENCE_FLAG].present?
+  end
+end

data/lib/turtle_hunter/version.rb

@@ -0,0 +1,3 @@
+module TurtleHunter
+  VERSION = "0.1.0"
+end

data/turtle_hunter.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'turtle_hunter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "turtle_hunter"
+  spec.version       = TurtleHunter::VERSION
+  spec.authors       = ["Chris Woodrich"]
+  spec.email         = ["cwoodrich@doximity.com"]
+
+  spec.summary       = %q{Fails slow specs}
+  spec.description   = %q{Fails slow specs}
+  spec.homepage      = "https://github.com/doximity/turtle_hunter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 "gemfury"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: turtle_hunter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Woodrich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gemfury
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Fails slow specs
+email:
+- cwoodrich@doximity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/turtle_hunter.rb
+- lib/turtle_hunter/derived_constants.rb
+- lib/turtle_hunter/rspec_init.rb
+- lib/turtle_hunter/util.rb
+- lib/turtle_hunter/version.rb
+- turtle_hunter.gemspec
+homepage: https://github.com/doximity/turtle_hunter
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Fails slow specs
+test_files: []