heroku_hatchet 4.0.7 → 4.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 2d62240ccab36896f21d254213e96976f8efbcb9294dd79c9a614f6167926a0d
-  data.tar.gz: 9b56fff4dc3217e079fb7e47ce43cd96c56632f72501a12cfbd476bda6be3acf
+SHA1:
+  metadata.gz: 2757fc3e39814bfab066c368f2dd365e5252f4b9
+  data.tar.gz: 86bb1d5c5ed24462ccd99556420f327c8baceeac
 SHA512:
-  metadata.gz: e31bbcca0a7e163acfe5c8ae66a0f7e9aa4296095bbf5e43e9fb53df852b6fc628bb428519c5939b566ed3fa047d9e8a670cba786cc3d97fd8191592f2432de2
-  data.tar.gz: bd9f296e0f5b2f28728f09b7d4aca5795f22659ab738e49d6cc88a438b49fcd3bb7a3524da8389f81d73377322ef012551542fcdef45cfa34d42d029dc6a75e5
+  metadata.gz: bd74e5705b78273eb133189a1c807133a0840c1161ce478deb4a699a5641a69c81bd072f62b3531245780a421d0d127cd5f3643fe6e41aab38e7f8ea93e8ac38
+  data.tar.gz: de5f809bcd7b0f4ac6f121ebbb852057eb73b89e6370398e43635a5de6edee2cbffb05ece7b76d50751479152a7b1850fa54c765e787c004fb43067e1a57c670

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## HEAD
 
+## 4.0.8
+
+- Fix `hatchet destroy` calling class from wrong module
+- Fix `hatchet destroy` not passing rate limited API to Reaper
+- Fix undeclared variable in `App#create_app` rescue block
+- Fix race condition in `Reaper#cycle` triggering 403s in API, causing test failures
+- Allow configurable app name prefix (default "hatchet-t-") via `HATCHET_APP_PREFIX` env var
+
 ## 4.0.7
 
 - Exit code is now returned from `app.run` commands (https://github.com/heroku/hatchet/pull/58)

data/README.md

@@ -130,6 +130,12 @@ Hatchet::Runner.new('no_lockfile')
 
 If you have conflicting names, use full paths.
 
+If you woud like to test with fixtures that are checked in locally, that is also possible by passing in the path to the fixture directory and skipping the `hatchet install`:
+
+```
+Hatchet::Runner.new("spec/fixtures/repos/node-10-metrics")
+```
+
 A word of warning on including repos inside of your test
 directory, if you're using a runner that looks for patterns such as
 `*_test.rb` to run your hatchet tests, it may incorrectly think you want
@@ -254,7 +260,46 @@ Hatchet::Runner.new("rails3_mri_193").deploy do |app|
 end
 ```
 
-Please read the docs on [repl_runner](http://github.com/schneems/repl_runner) for more info. The only interactive commands that are supported out of the box are `rails console`, `bash`, and `irb` it is fairly easy to add your own though:
+Please read the docs on [repl_runner](http://github.com/schneems/repl_runner) for more info. The only interactive commands that are supported out of the box are `rails console`, `bash`, and `irb` it is fairly easy to add your own though.
+
+## Modify Application Files on Disk
+
+While template apps provided from your `hatchet.json` can provide a wide array of different test cases, it's likely that you'll want to test minor varriations of an app. To do this you can use the `before_deploy` hook to modify files on disk inside of an app in a way that is threadsafe and will only affect the local instance of the app:
+
+```ruby
+Hatchet::App.new("default_ruby", before_deploy: { FileUtils.touch("foo.txt")}).deploy do
+  # Assert stuff
+end
+```
+
+After the `before_deploy` block fires, the results will be committed to git automatically before the app deploys.
+
+You can also manually call the `before_deploy` method:
+
+```ruby
+app  = Hatchet::App.new("default_ruby")
+app.before_deploy do
+  FileUtils.touch("foo.txt")
+end
+app.deploy do
+  # Assert stuff
+end
+```
+
+Note: If you're going to shell out in this `before_deploy` section, you should check the success of your command, for example:
+
+```ruby
+before_deploy = Proc.new do
+  cmd = "bundle update"
+  output = `#{cmd}`
+  raise "Command #{cmd.inspect} failed unexpectedly with output: #{output}"
+end
+Hatchet::App.new("default_ruby", before_deploy: before_deploy).deploy do
+  # Assert stuff
+end
+```
+
+It's helpful to make a helper function in your library if this pattern happens a lot in your app.
 
 ## Heroku CI
 

data/bin/hatchet

@@ -98,7 +98,8 @@ class HatchetCLI < Thor
   def destroy(name=nil)
     api_key      = ENV['HEROKU_API_KEY'] || bundle_exec {`heroku auth:token`.chomp }
     platform_api = PlatformAPI.connect_oauth(api_key, cache: Moneta.new(:Null))
-    reaper       = Reaper.new(platform_api: platform_api)
+    api_rate_limit = ApiRateLimit.new(platform_api)
+    reaper       = Hatchet::Reaper.new(api_rate_limit: api_rate_limit)
 
     if options[:all]
       reaper.destroy_all

data/lib/hatchet.rb

@@ -9,6 +9,7 @@ require 'stringio'
 require 'date'
 
 module Hatchet
+    APP_PREFIX = (ENV['HATCHET_APP_PREFIX'] || "hatchet-t-")
 end
 
 require 'hatchet/version'

data/lib/hatchet/app.rb

@@ -148,7 +148,7 @@ module Hatchet
           hash = { name: name, stack: stack }
           hash.delete_if { |k,v| v.nil? }
           api_rate_limit.call.app.create(hash)
-        rescue
+        rescue => e
           @reaper.cycle
           raise e
         end
@@ -347,7 +347,7 @@ module Hatchet
     end
 
     private def default_name
-      "hatchet-t-#{SecureRandom.hex(10)}"
+      "#{Hatchet::APP_PREFIX}#{SecureRandom.hex(5)}"
     end
 
     private def call_before_deploy

data/lib/hatchet/reaper.rb

@@ -1,3 +1,5 @@
+require 'tmpdir'
+
 module Hatchet
   # Hatchet apps are useful after the tests run for debugging purposes
   # the reaper is designed to allow the most recent apps to stay alive
@@ -7,10 +9,9 @@ module Hatchet
   class Reaper
     HEROKU_APP_LIMIT = Integer(ENV["HEROKU_APP_LIMIT"]  || 100) # the number of apps heroku allows you to keep
     HATCHET_APP_LIMT = Integer(ENV["HATCHET_APP_LIMIT"] || 20)  # the number of apps hatchet keeps around
-    DEFAULT_REGEX = /^hatchet-t-/
+    DEFAULT_REGEX = /^#{Regexp.escape(Hatchet::APP_PREFIX)}[a-f0-9]+/
     attr_accessor :apps
 
-
     def initialize(api_rate_limit: , regex: DEFAULT_REGEX)
       @api_rate_limit = api_rate_limit
       @regex        = regex
@@ -24,16 +25,24 @@ module Hatchet
     end
 
     def cycle
+      # we don't want multiple Hatchet processes (e.g. when using rspec-parallel) to delete apps at the same time
+      # this could otherwise result in race conditions in API causing errors other than 404s, making tests fail
+      mutex = File.open("#{Dir.tmpdir()}/hatchet_reaper_mutex", File::CREAT)
+      mutex.flock(File::LOCK_EX)
+
+      # update list of apps once
       get_apps
-      if over_limit?
+
+      return unless over_limit?
+
+      while over_limit?
         if @hatchet_apps.count > 1
+          # remove our own apps until we are below limit
           destroy_oldest
-          cycle
         else
           puts "Warning: Reached Heroku app limit of #{HEROKU_APP_LIMIT}."
+          break
         end
-      else
-        # do nothing
       end
 
     # If the app is already deleted an exception
@@ -46,6 +55,9 @@ module Hatchet
         retry
       end
       raise e
+    ensure
+      # don't forget to close the mutex; this also releases our lock
+      mutex.close
     end
 
     def destroy_oldest

data/lib/hatchet/test_run.rb

@@ -30,7 +30,7 @@ module Hatchet
       commit_message: "commit",
       organization:    nil
     )
-      @pipeline        = pipeline || "hatchet-t-#{SecureRandom.hex(10)}"
+      @pipeline        = pipeline || "#{Hatchet::APP_PREFIX}#{SecureRandom.hex(5)}"
       @timeout         = timeout
       @pause           = pause
       @organization    = organization

data/lib/hatchet/version.rb

@@ -1,3 +1,3 @@
 module Hatchet
-  VERSION = "4.0.7"
+  VERSION = "4.0.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroku_hatchet
 version: !ruby/object:Gem::Version
-  version: 4.0.7
+  version: 4.0.8
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2019-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: platform-api
@@ -247,7 +247,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Hatchet is a an integration testing library for developing Heroku buildpacks.