heroku_hatchet 4.1.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b30075b5028dc2c364c35d338ad0d48e7a9318c088c9f433936664d60262318
-  data.tar.gz: 4cc696dadc3e206ff256d252b756c950d4ca0a36e541f554d1c8d416005418f3
+  metadata.gz: d315483e6cd1509b1ea90279b800beb2a969f57956a44f7df08c5844ec9f539b
+  data.tar.gz: 5f66b2f956bd2820b80dc634d68cea6dc84c7e23079253ef990fe5be8d131d0c
 SHA512:
-  metadata.gz: b19500cd4df7b71b00d9930f47aa732db1535108895cd23c04eddc34aaad9f35550a19ff6a596c5b3b52fa01afe2cc48e7243cb4223c1c9fe5419197095db6d6
-  data.tar.gz: 283b420ef99004247dc2ef190771a43fe401052aec131dc55531c5ebebd1f4f0ca0d3d3976d9fe4f49e8a026193975bfce7e9d7485efdfa6fbbea0167dee9bf7
+  metadata.gz: 03570dbbf7075600e686b4f36d1a15d51c812582ab558574c28bb4eb3f80f76618c20bb1bb6d4473a644078fcff0d831360cbfbe12a653727d6609d5a8c66853
+  data.tar.gz: 107c8c3accdc9690cb7daafd1a0c9a20ea21e2730d9618de2913e6d7c5ff1d6a6191f552890272436ff0833c1456bce67ae8fbafc4eaa29da667a795c5fdd404

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## HEAD
 
+## 5.0.0
+
+- Shelling out to `heroku` commands no longer uses `Bundler.with_clean_env` (https://github.com/heroku/hatchet/pull/74)
+- CI runs can now happen multiple times against the same app/pipeline (https://github.com/heroku/hatchet/pull/75)
+- Breaking change: Do not allow App#run to escape to system shell by default (https://github.com/heroku/hatchet/pull/72)
+
+> Note: If you were relying on this behavior, use the `raw: true` option.
+
+- ReplRunner use with App#run is now deprecated (https://github.com/heroku/hatchet/pull/72)
+- Calling App#run with a nil in the second argument is now deprecated (https://github.com/heroku/hatchet/pull/72)
+
 ## 4.1.2
 
 - Hatchet::App.default_buildpack is aliased to `:default` symbol while passing in buildpacks as an array to Hatchet::App (https://github.com/heroku/hatchet/pull/73)

data/README.md

@@ -242,19 +242,62 @@ Hatchet::Runner.new("rails3_mri_193").deploy do |app|
 end
 ```
 
-This is the prefered way to run commands against the app. You can also string together commands in a session, but it's less deterministic due to difficulties in driving a REPL programatically via [repl_runner](http://github.com/schneems/repl_runner).
+By default commands will be shell escaped (to prevent commands from escaping the `heroku run` command), if you want to manage your own quoting you can use the `raw: true` option:
 
+```
+app.run('echo \$HELLO \$NAME', raw: true)
+```
 
-```ruby
-Hatchet::Runner.new("rails3_mri_193").deploy do |app|
-  app.run("bash") do |bash|
-    bash.run("ls")           {|result| assert_match "Gemfile.lock", result }
-    bash.run("cat Procfile") {|result| assert_match "web:", result }
-  end
-end
+You can specify Heroku flags to the `heroku run` command by passing in the `heroku:` key along with a hash.
+
+```
+app.run("nproc", heroku: { "size" => "performance-l" })
+# => 8
 ```
 
-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.
+You can see a list of Heroku flags by running:
+
+```
+$ heroku run --help
+run a one-off process inside a heroku dyno
+
+USAGE
+  $ heroku run
+
+OPTIONS
+  -a, --app=app        (required) app to run command against
+  -e, --env=env        environment variables to set (use ';' to split multiple vars)
+  -r, --remote=remote  git remote of app to use
+  -s, --size=size      dyno size
+  -x, --exit-code      passthrough the exit code of the remote command
+  --no-notify          disables notification when dyno is up (alternatively use HEROKU_NOTIFICATIONS=0)
+  --no-tty             force the command to not run in a tty
+  --type=type          process type
+```
+
+By default Hatchet will set the app name and the exit code
+
+
+```
+app.run("exit 127")
+puts $?.exitcode
+# => 127
+```
+
+To skip a value you can use the constant:
+
+```
+app.run("exit 127", heroku: { "exit-code" => Hatchet::App::SkipDefaultOption})
+puts $?.exitcode
+# => 0
+```
+
+To specify a flag that has no value (such as `--no-notify`, `no-tty`, or `--exit-code`) pass a `nil` value:
+
+```
+app.run("echo 'foo'", heroku: { "no-notify" => nil })
+# This is the same as `heroku run echo 'foo' --no-notify`
+```
 
 ## Modify Application Files on Disk
 
@@ -302,6 +345,10 @@ Hatchet supports testing Heroku CI.
 ```ruby
 Hatchet::Runner.new("rails5_ruby_schema_format").run_ci do |test_run|
   assert_match "Ruby buildpack tests completed successfully", test_run.output
+
+  test_run.run_again # Runs tests again, for example to make sure the cache was used
+
+  assert_match "Using rake", test_run.output
 end
 ```
 

data/bin/hatchet

@@ -96,7 +96,7 @@ class HatchetCLI < Thor
   desc "destroy [NAME]", "Deletes applications"
   option :all, :type => :boolean
   def destroy(name=nil)
-    api_key      = ENV['HEROKU_API_KEY'] || bundle_exec {`heroku auth:token`.chomp }
+    api_key      = ENV['HEROKU_API_KEY'] || `heroku auth:token`.chomp
     platform_api = PlatformAPI.connect_oauth(api_key, cache: Moneta.new(:Null))
     api_rate_limit = ApiRateLimit.new(platform_api)
     reaper       = Hatchet::Reaper.new(api_rate_limit: api_rate_limit)
@@ -113,7 +113,7 @@ class HatchetCLI < Thor
   private
   def load_lockfile
     return YAML.safe_load(File.read('hatchet.lock')).to_h
-  rescue Errno::ENOENT => e
+  rescue Errno::ENOENT
     raise "No such file found `hatchet.lock` please run `$ bundle exec hatchet lock`"
   end
 
@@ -161,16 +161,6 @@ class HatchetCLI < Thor
     cmd("cd #{path} && git clone #{git_repo} --quiet", quiet: quiet)
   end
 
-  def bundle_exec
-    if defined?(Bundler)
-      Bundler.with_clean_env do
-        yield
-      end
-    else
-      yield
-    end
-  end
-
   def cmd(command, let_fail: false, stdin: nil, quiet: true)
     command = "printf '#{stdin}' | #{command}" if stdin
     puts "Running: #{command}" unless quiet

data/hatchet.gemspec

@@ -26,9 +26,9 @@ Gem::Specification.new do |gem|
   gem.add_dependency "threaded",      "~> 0"
   gem.add_dependency 'minitest-retry', '~> 0.1.9'
 
-  gem.add_development_dependency "minitest",       "~> 5.1"
-  gem.add_development_dependency "rake",           "~> 10"
-  gem.add_development_dependency "mocha",          "~> 1"
-  gem.add_development_dependency "parallel_tests", "~> 2"
-  gem.add_development_dependency "travis",         "~> 1"
+  gem.add_development_dependency "minitest",       ">= 5.1"
+  gem.add_development_dependency "rake",           ">= 10"
+  gem.add_development_dependency "mocha",          ">= 1"
+  gem.add_development_dependency "parallel_tests", ">= 2"
+  gem.add_development_dependency "travis",         ">= 1"
 end

data/hatchet.lock

@@ -6,7 +6,7 @@
 - - test/fixtures/repos/ci/rails5_ruby_schema_format
   - 3e63c3e13f435cf4ab11265e9abd161cc28cc552
 - - test/fixtures/repos/default/default_ruby
-  - da748a59340be8b950e7bbbfb32077eb67d70c3c
+  - 6e642963acec0ff64af51bd6fba8db3c4176ed6e
 - - test/fixtures/repos/lock/lock_fail
   - da748a59340be8b950e7bbbfb32077eb67d70c3c
 - - test/fixtures/repos/rails2/rails2blog

data/lib/hatchet.rb

@@ -1,6 +1,5 @@
 require 'active_support/core_ext/object/blank'
 require 'rrrretry'
-require 'repl_runner'
 
 require 'json'
 require 'stringio'

data/lib/hatchet/app.rb

@@ -46,6 +46,8 @@ module Hatchet
       @buildpacks    = buildpack || buildpacks || buildpack_url || self.class.default_buildpack
       @buildpacks    = Array(@buildpacks)
       @buildpacks.map! {|b| b == :default ? self.class.default_buildpack : b}
+      @already_in_dir = nil
+      @app_is_setup = nil
 
       @before_deploy = before_deploy
       @app_config    = config
@@ -108,10 +110,25 @@ module Hatchet
       end
     end
 
+    DefaultCommand = Object.new
     # runs a command on heroku similar to `$ heroku run #foo`
     # but programatically and with more control
-    def run(cmd_type, command = nil, options = {}, &block)
-      command        = cmd_type.to_s if command.nil?
+    def run(cmd_type, command = DefaultCommand, options = {}, &block)
+      case command
+      when Hash
+        options.merge!(command)
+        command = cmd_type.to_s
+      when nil
+        STDERR.puts "Calling App#run with an explicit nil value in the second argument is deprecated."
+        STDERR.puts "You can pass in a hash directly as the second argument now.\n#{caller.join("\n")}"
+        command = cmd_type.to_s
+      when DefaultCommand
+        command = cmd_type.to_s
+      else
+        command = command.to_s
+      end
+      command = command.shellescape unless options.delete(:raw)
+
       default_options = { "app" => name, "exit-code" => nil }
       heroku_options = (default_options.merge(options.delete(:heroku) || {})).map do |k,v|
         next if v == Hatchet::App::SkipDefaultOption # for forcefully removing e.g. --exit-code, a user can pass this
@@ -120,12 +137,14 @@ module Hatchet
         arg
       end.join(" ")
       heroku_command = "heroku run #{heroku_options} -- #{command}"
-      bundle_exec do
-        if block_given?
-          ReplRunner.new(cmd_type, heroku_command, options).run(&block)
-        else
-          `#{heroku_command}`
-        end
+
+      if block_given?
+        STDERR.puts "Using App#run with a block is deprecated, support for ReplRunner is being removed.\n#{caller}"
+        # When we deprecated this we can get rid of the "cmd_type" from the method signature
+        require 'repl_runner'
+        ReplRunner.new(cmd_type, heroku_command, options).run(&block)
+      else
+        `#{heroku_command}`
       end
     end
 
@@ -280,6 +299,7 @@ module Hatchet
       return "" if attempt == max_retries
       msg = "\nRetrying failed Attempt ##{attempt}/#{max_retries} to push for '#{name}' due to error: \n"<<
             "#{error.class} #{error.message}\n  #{error.backtrace.join("\n  ")}"
+      return msg
     end
 
     def output
@@ -287,7 +307,7 @@ module Hatchet
     end
 
     def api_key
-      @api_key ||= ENV['HEROKU_API_KEY'] || bundle_exec {`heroku auth:token`.chomp }
+      @api_key ||= ENV['HEROKU_API_KEY'] || `heroku auth:token`.chomp
     end
 
     def heroku
@@ -317,12 +337,15 @@ module Hatchet
         app:            self,
         pipeline:       @pipeline_id,
         api_rate_limit: api_rate_limit
-     )
+      )
+      in_directory do
+        call_before_deploy
 
-      Hatchet::RETRIES.times.retry do
-        test_run.create_test_run
+        Hatchet::RETRIES.times.retry do
+          test_run.create_test_run
+        end
+        test_run.wait!(&block)
       end
-      test_run.wait!(&block)
     ensure
       delete_pipeline(@pipeline_id) if @pipeline_id
       @pipeline_id = nil
@@ -377,7 +400,7 @@ module Hatchet
     end
 
     private def is_git_repo?
-      out = `git rev-parse --git-dir > /dev/null 2>&1`
+      `git rev-parse --git-dir > /dev/null 2>&1`
       $?.success?
     end
 
@@ -408,16 +431,6 @@ module Hatchet
 
       commit! if needs_commit?
     end
-
-    private def bundle_exec
-      if defined?(Bundler)
-        Bundler.with_clean_env do
-          yield
-        end
-      else
-        yield
-      end
-    end
   end
 end
 

data/lib/hatchet/test_run.rb

@@ -46,6 +46,17 @@ module Hatchet
     end
     attr_reader :app
 
+    def run_again(&block)
+      @mutex.synchronize do
+        @status = false
+      end
+
+      Hatchet::RETRIES.times.retry do
+        create_test_run
+      end
+      wait!(&block)
+    end
+
     def create_test_run
       @mutex.synchronize do
         raise "Test is already running" if @status
@@ -116,11 +127,11 @@ module Hatchet
           info
           case @status
           when :succeeded
-            yield self
+            yield self if block_given?
             return self
           when :failed, :errored
             raise FailedTestError.new(self.app, self.output) unless app.allow_failure?
-            yield self
+            yield self if block_given?
             return self
           else
             # keep looping
@@ -165,7 +176,8 @@ module Hatchet
         app_json["stack"]                              ||= @app.stack if @app.stack && !@app.stack.empty?
         File.open("app.json", "w") {|f| f.write(JSON.generate(app_json)) }
 
-        `tar c . | gzip -9 > slug.tgz`
+        out = `tar c . | gzip -9 > slug.tgz`
+        raise "Tar command failed: #{out}" unless $?.success?
 
         source_put_url = @app.create_source
         Hatchet::RETRIES.times.retry do
@@ -195,7 +207,7 @@ module Hatchet
     end
 
     def raw_excon_request(options)
-      version = options[:version] || 3
+      version = options.delete(:version) || 3
       options[:headers] = {
         "Authorization" => "Bearer #{@token}",
         "Accept"        => "application/vnd.heroku+json; version=#{version}",
@@ -210,4 +222,4 @@ module Hatchet
       end
     end
   end
-end
+end

data/lib/hatchet/version.rb

@@ -1,3 +1,3 @@
 module Hatchet
-  VERSION = "4.1.2"
+  VERSION = "5.0.0"
 end

data/test/hatchet/app_test.rb

@@ -71,18 +71,26 @@ class AppTest < Minitest::Test
   def test_run
     app = Hatchet::GitApp.new("default_ruby")
     app.deploy do
-      assert_match /ls: cannot access 'foo bar #baz': No such file or directory\s+Gemfile/, app.run("ls -a Gemfile 'foo bar #baz'")
+      assert_match(/ls: cannot access 'foo bar #baz': No such file or directory\s+Gemfile/, app.run("ls -a Gemfile 'foo bar #baz'"))
       assert (0 != $?.exitstatus) # $? is from the app.run use of backticks
-      sleep(3)
-      app.run("ls erpderp", nil, { :heroku => { "exit-code" => Hatchet::App::SkipDefaultOption } } )
+      sleep(4) # Dynos don't exit right away and free dynos can't have more than one running at a time, wait before calling `run` again
+
+      app.run("ls erpderp", { :heroku => { "exit-code" => Hatchet::App::SkipDefaultOption } } )
       assert (0 == $?.exitstatus) # $? is from the app.run use of backticks, but we asked the CLI not to return the program exit status by skipping the default "exit-code" option
-      sleep(3)
-      app.run("ls erpderp", nil, { :heroku => { "no-tty" => nil } } )
+      sleep(4)
+
+      app.run("ls erpderp", { :heroku => { "no-tty" => nil } } )
       assert (0 != $?.exitstatus) # $? is from the app.run use of backticks
-      sleep(3)
-      assert_match /ohai world/, app.run('echo \$HELLO \$NAME', nil, { :heroku => { "env" => "HELLO=ohai;NAME=world" } } )
-      sleep(3)
-      refute_match /ohai world/, app.run('echo \$HELLO \$NAME', nil, { :heroku => { "env" => "" } } )
+      sleep(4)
+
+      assert_match(/ohai world/, app.run('echo \$HELLO \$NAME', { raw: true, :heroku => { "env" => "HELLO=ohai;NAME=world" } } ))
+      sleep(4)
+
+      refute_match(/ohai world/, app.run('echo \$HELLO \$NAME', { raw: true, :heroku => { "env" => "" } } ))
+      sleep(4)
+
+      random_name = SecureRandom.hex
+      assert_match(/#{random_name}/, app.run("mkdir foo; touch foo/#{random_name}; ls foo/"))
     end
   end
 end

data/test/hatchet/ci_four_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class CIFourTest < Minitest::Test
+  def test_error_with_bad_app
+    string = SecureRandom.hex
+    Hatchet::GitApp.new("default_ruby").run_ci do |test_run|
+      refute_match(string, test_run.output)
+      assert_match("Installing rake" , test_run.output)
+
+      run!(%Q{echo 'puts "#{string}"' >> Rakefile})
+      test_run.run_again
+
+      assert_match(string, test_run.output)
+      assert_match("Using rake" , test_run.output)
+
+      refute_match("Installing rake" , test_run.output)
+    end
+  end
+end

data/test/hatchet/config_test.rb

@@ -14,13 +14,12 @@ class ConfigTest < Minitest::Test
     {
       "test/fixtures/repos/bundler/no_lockfile"   => "https://github.com/sharpstone/no_lockfile.git",
       "test/fixtures/repos/default/default_ruby"  => "https://github.com/sharpstone/default_ruby.git",
-      "test/fixtures/repos/default/default_ruby"  => "https://github.com/sharpstone/default_ruby.git",
       "test/fixtures/repos/rails2/rails2blog"     => "https://github.com/sharpstone/rails2blog.git",
       "test/fixtures/repos/rails3/rails3_mri_193" => "https://github.com/sharpstone/rails3_mri_193.git"
      }.each do |key, value|
        assert_include(key, value, @config.dirs)
      end
-   end
+  end
 
   def test_config_repos
     {

data/test/hatchet/edit_repo_test.rb

@@ -13,7 +13,7 @@ class EditRepoTest < Minitest::Test
     end
 
     Hatchet::GitApp.new("default_ruby").in_directory do |app|
-      refute_match /foo/, `ls`
+      refute_match(/foo/, `ls`)
     end
   end
 end

data/test/hatchet/multi_cmd_runner_test.rb

@@ -4,8 +4,8 @@ class MultiCmdRunnerTest < Minitest::Test
   # slow but needed, there are ghosts in the machine
   # by running common command multiple times we can find them
   def test_multi_repl_commands
+    require 'repl_runner'
     Hatchet::GitApp.new("default_ruby").deploy do |app|
-
       assert_raise(ReplRunner::UnregisteredCommand) do
         app.run("ls", 2) do |ls| # will return right away, should raise error
           ls.run("cat")

data/test/test_helper.rb

@@ -7,16 +7,11 @@ Bundler.require
 # require 'test/unit'
 
 require 'minitest/autorun'
-require "mocha/setup"
+require "mocha/minitest"
 
 require 'minitest/retry'
 Minitest::Retry.use!
 
-# Not needed if you're using the most recent version
-if defined?(MiniTest::Unit::TestCase)
-  Minitest::Test = MiniTest::Unit::TestCase
-end
-
 def assert_raise(*args, &block)
   assert_raises(*args, &block)
 end
@@ -25,3 +20,9 @@ end
 ENV['HATCHET_BUILDPACK_BRANCH'] = "master"
 
 require 'parallel_tests/test/runtime_logger' if ENV['RECORD_RUNTIME']
+
+def run!(cmd)
+  out = `#{cmd}`
+  raise "Error running #{cmd}, output: #{out}" unless $?.success?
+  out
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroku_hatchet
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 5.0.0
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-13 00:00:00.000000000 Z
+date: 2020-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: platform-api
@@ -112,70 +112,70 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
   name: parallel_tests
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1'
 description: Hatchet is a an integration testing library for developing Heroku buildpacks.
@@ -219,6 +219,7 @@ files:
 - test/fixtures/buildpacks/null-buildpack/readme.md
 - test/hatchet/allow_failure_git_test.rb
 - test/hatchet/app_test.rb
+- test/hatchet/ci_four_test.rb
 - test/hatchet/ci_test.rb
 - test/hatchet/ci_three_test.rb
 - test/hatchet/ci_too_test.rb
@@ -265,6 +266,7 @@ test_files:
 - test/fixtures/buildpacks/null-buildpack/readme.md
 - test/hatchet/allow_failure_git_test.rb
 - test/hatchet/app_test.rb
+- test/hatchet/ci_four_test.rb
 - test/hatchet/ci_test.rb
 - test/hatchet/ci_three_test.rb
 - test/hatchet/ci_too_test.rb