heroku_hatchet 5.0.2 → 7.1.1

data/spec/hatchet/git_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe "GitAppTest" do
+  it "can deploy git app" do
+    Hatchet::GitApp.new("rails5_ruby_schema_format").deploy do |app|
+      expect(app.run("ruby -v")).to match("2.6.6")
+    end
+  end
+end

data/spec/hatchet/heroku_api_spec.rb

@@ -0,0 +1,30 @@
+require("spec_helper")
+describe "HerokuApiTest" do
+  it "config vars" do
+    begin
+      runner = Hatchet::Runner.new("no_lockfile").setup!
+      actual = runner.get_config
+      actual.delete("BUILDPACK_URL")
+      expect(actual).to eq({})
+
+      runner.set_config("foo" => "bar")
+
+      actual = runner.get_config
+      actual.delete("BUILDPACK_URL")
+      expect(actual).to eq({ "foo" => "bar" })
+    ensure
+      runner.teardown! if runner
+    end
+  end
+
+  it "config vars in init" do
+    begin
+      runner = Hatchet::Runner.new("no_lockfile", config: { foo: "bar" }).setup!
+      actual = runner.get_config
+
+      expect(actual).to eq({ "foo" => "bar" })
+    ensure
+      runner.teardown! if runner
+    end
+  end
+end

data/spec/hatchet/local_repo_spec.rb

@@ -0,0 +1,26 @@
+require("spec_helper")
+describe "LocalRepoTest" do
+  it "in directory fork" do
+    env_name = SecureRandom.hex
+    ENV[env_name] = env_name
+    Hatchet::App.new("default_ruby").in_directory_fork do
+      ENV.delete(env_name) # Does not affect parent env
+      expect(ENV[env_name]).to be_nil
+    end
+
+    expect(ENV[env_name]).to eq(env_name)
+  end
+
+  it "repos checked into git" do
+    begin
+      app = Hatchet::App.new("repo_fixtures/different-folder-for-checked-in-repos/default_ruby")
+      app.in_directory do
+        expect(Dir.exist?(".git")).to eq(false)
+        app.setup!
+        expect(Dir.exist?(".git")).to eq(true)
+      end
+    ensure
+      app.teardown! if app
+    end
+  end
+end

data/spec/hatchet/lock_spec.rb

@@ -0,0 +1,81 @@
+require "spec_helper"
+require 'yaml'
+
+describe "LockTest" do
+  before(:all) do
+    puts(`bundle exec hatchet lock`)
+  end
+
+  it "app with failure can be locked to prior commit" do
+    Hatchet::GitApp.new("lock_fail").deploy do |app|
+      expect(app.deployed?).to be_truthy
+    end
+  end
+
+  it "app with failure can be locked to master" do
+    lock = YAML.load_file("hatchet.lock")
+    name, branch = lock.select { |k, v| k.end_with?("lock_fail_master") }.first
+
+    expect(name).to eq("repo_fixtures/repos/lock/lock_fail_master")
+    expect(branch).to eq("master")
+  end
+
+  it "app with failure can be locked to main" do
+    lock = YAML.load_file("hatchet.lock")
+    name, branch = lock.select { |k, v| k.end_with?("lock_fail_main") }.first
+
+    expect(name).to eq("repo_fixtures/repos/lock/lock_fail_main")
+    expect(branch).to eq("main")
+  end
+end
+
+describe "isolated lock tests" do
+  it "works when there's no hatchet.lock" do
+    Dir.mktmpdir do |dir|
+      dir = Pathname.new(dir)
+
+      dir.join("hatchet.json").open("w+") do |f|
+        f.puts %Q{{ "foo": ["sharpstone/lock_fail_main_default_is_master"] }}
+      end
+
+      output = `cd #{dir} && hatchet lock 2>&1`
+
+      raise "Expected cmd `hatchet lock` to succeed, but it did not: #{output}" unless $?.success?
+      expect(output).to include("locking")
+
+      lockfile_contents = dir.join('hatchet.lock').read
+      expect(lockfile_contents).to include("repos/foo/lock_fail_main_default_is_master")
+    end
+  end
+
+  it "works when a project is locked to main but the default branch is master" do
+    Dir.mktmpdir do |dir|
+      dir = Pathname.new(dir)
+
+      dir.join("hatchet.json").open("w+") do |f|
+        f.puts %Q{{ "foo": ["sharpstone/lock_fail_main_default_is_master"] }}
+      end
+
+      dir.join("hatchet.lock").open("w+") do |f|
+        f.puts <<~EOM
+        ---
+        - - "./repos/foo/lock_fail_main_default_is_master"
+          - main
+        EOM
+      end
+
+      output = `cd #{dir} && hatchet install 2>&1`
+
+      raise "Expected cmd `hatchet install` to succeed, but it did not:\n#{output}" unless $?.success?
+      expect(output).to include("Installing")
+
+      lockfile_contents = dir.join('hatchet.lock').read
+      contents = YAML.safe_load(lockfile_contents).to_h
+      expect(contents).to eq({"./repos/foo/lock_fail_main_default_is_master" => "main"})
+
+      contents.each do |repo_dir, commit_or_branch|
+        expect(`cd #{dir.join(repo_dir)} && git describe --contains --all HEAD`).to match("main")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'hatchet'
+require 'rspec/retry'
+require "bundler/setup"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+  config.verbose_retry       = true # show retry status in spec process
+  config.default_retry_count = 2 if ENV['IS_RUNNING_ON_CI'] # retry all tests that fail again
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+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

data/spec/unit/reaper_spec.rb

@@ -0,0 +1,169 @@
+require "spec_helper"
+
+describe "Reaper" do
+  it "destroy all" do
+    reaper = Hatchet::Reaper.new(api_rate_limit: Object.new, hatchet_app_limit: 1, io: StringIO.new)
+
+    def reaper.get_heroku_apps
+      @mock_apps ||= [
+        {"name" => "hatchet-t-unfinished", "id" => 2, "maintenance" => false, "created_at" => Time.now.to_s},
+        {"name" => "hatchet-t-foo", "id" => 1, "maintenance" => true, "created_at" => Time.now.to_s}
+      ]
+    end
+    def reaper.destroy_with_log(*args); @destroy_with_log_count ||= 0; @destroy_with_log_count += 1; end
+
+    reaper.destroy_all
+
+    expect(reaper.instance_variable_get("@destroy_with_log_count")).to eq(1)
+  end
+
+  describe "cycle" do
+    it "does not delete anything if under the limit" do
+      reaper = Hatchet::Reaper.new(api_rate_limit: Object.new, hatchet_app_limit: 1, io: StringIO.new)
+
+      def reaper.get_heroku_apps
+        @called_get_heroku_apps = true
+
+        @mock_apps ||= [{"name" => "hatchet-t-foo", "id" => 1, "maintenance" => true, "created_at" => Time.now.to_s}]
+      end
+      def reaper.check_get_heroku_apps_called; @called_get_heroku_apps ; end
+      def reaper.reap_once; raise "should not be called"; end
+
+      reaper.cycle
+
+      expect(reaper.check_get_heroku_apps_called).to be_truthy
+    end
+
+    it "deletes a maintenance mode app on error" do
+      reaper = Hatchet::Reaper.new(api_rate_limit: Object.new, hatchet_app_limit: 1, io: StringIO.new)
+
+      def reaper.get_heroku_apps
+        @mock_apps ||= [
+          {"name" => "hatchet-t-unfinished", "id" => 2, "maintenance" => false, "created_at" => Time.now.to_s},
+          {"name" => "hatchet-t-foo", "id" => 1, "maintenance" => true, "created_at" => Time.now.to_s}
+        ]
+      end
+      def reaper.destroy_with_log(name: , id: )
+        @reaper_destroy_called_with = {"name" => name, "id" => id}
+      end
+      def reaper.destroy_called_with; @reaper_destroy_called_with; end
+
+      reaper.cycle(app_exception_message: true)
+
+      expect(reaper.destroy_called_with).to eq({"name" => "hatchet-t-foo", "id" => 1})
+    end
+
+    it "deletes maintenance mode app when over limit" do
+      reaper = Hatchet::Reaper.new(api_rate_limit: Object.new, hatchet_app_limit: 0, io: StringIO.new)
+
+      def reaper.get_heroku_apps
+        @mock_apps ||= [{"name" => "hatchet-t-foo", "id" => 1, "maintenance" => true, "created_at" => Time.now.to_s}]
+      end
+      def reaper.destroy_with_log(name: , id: )
+        @reaper_destroy_called_with = {"name" => name, "id" => id}
+      end
+      def reaper.destroy_called_with; @reaper_destroy_called_with; end
+
+      reaper.cycle
+
+      expect(reaper.destroy_called_with).to eq({"name" => "hatchet-t-foo", "id" => 1})
+    end
+
+    it "deletes an old app that is past TLL" do
+      reaper = Hatchet::Reaper.new(api_rate_limit: Object.new, hatchet_app_limit: 0, io: StringIO.new)
+
+      def reaper.get_heroku_apps
+        two_days_ago = DateTime.now.new_offset(0) - 2
+        @mock_apps ||= [{"name" => "hatchet-t-foo", "id" => 1, "maintenance" => false, "created_at" => two_days_ago.to_s }]
+      end
+      def reaper.destroy_with_log(name: , id: )
+        @reaper_destroy_called_with = {"name" => name, "id" => id}
+      end
+      def reaper.destroy_called_with; @reaper_destroy_called_with; end
+
+      reaper.cycle
+
+      expect(reaper.destroy_called_with).to eq({"name" => "hatchet-t-foo", "id" => 1})
+    end
+
+    it "sleeps, refreshes app list, and tries again when an old app is not past TTL" do
+      warning = StringIO.new
+      reaper = Hatchet::Reaper.new(api_rate_limit: Object.new, hatchet_app_limit: 1, initial_sleep: 0, io: warning)
+
+      def reaper.get_heroku_apps
+        now = DateTime.now.new_offset(0)
+        @mock_apps ||= [{"name" => "hatchet-t-foo", "id" => 1, "maintenance" => false, "created_at" => now.to_s }]
+      end
+      def reaper.destroy_with_log(name: , id: )
+        @reaper_destroy_called_with = {"name" => name, "id" => id}
+      end
+      def reaper.destroy_called_with; @reaper_destroy_called_with; end
+      def reaper.sleep(val)
+        @_slept_for = val
+      end
+
+      def reaper.get_slept_for_val; @_slept_for; end
+
+      reaper.cycle(app_exception_message: true)
+
+      expect(reaper.get_slept_for_val).to eq(0)
+      expect(reaper.destroy_called_with).to eq(nil)
+
+      expect(warning.string).to match("WARNING")
+      expect(warning.string).to match("total_app_count: 1, hatchet_app_count: 1/#{Hatchet::Reaper::HATCHET_APP_LIMIT}, finished: 0, unfinished: 1")
+    end
+  end
+
+  describe "app age" do
+    it "calculates young apps" do
+      time_now = DateTime.parse("2020-07-28T14:40:00Z")
+      age = Hatchet::Reaper::AppAge.new(created_at: time_now, time_now: time_now, ttl_minutes: 1)
+      expect(age.in_minutes).to eq(0.0)
+      expect(age.too_young_to_die?).to be_truthy
+      expect(age.can_delete?).to be_falsey
+      expect(age.sleep_for_ttl).to eq(60)
+    end
+
+    it "calculates old apps" do
+      time_now = DateTime.parse("2020-07-28T14:40:00Z")
+      created_at = time_now - 2
+      age = Hatchet::Reaper::AppAge.new(created_at: created_at, time_now: time_now, ttl_minutes: 1)
+      expect(age.in_minutes).to eq(2880.0)
+      expect(age.too_young_to_die?).to be_falsey
+      expect(age.can_delete?).to be_truthy
+      expect(age.sleep_for_ttl).to eq(0)
+    end
+  end
+
+  describe "reaper throttle" do
+    it "increments and decrements based on min_sleep" do
+      reaper_throttle = Hatchet::Reaper::ReaperThrottle.new(initial_sleep: 2)
+      reaper_throttle.call(max_sleep: 5) do |sleep_for|
+        expect(sleep_for).to eq(2)
+      end
+      reaper_throttle.call(max_sleep: 5) do |sleep_for|
+        expect(sleep_for).to eq(4)
+      end
+      reaper_throttle.call(max_sleep: 5) do |sleep_for|
+        expect(sleep_for).to eq(5)
+      end
+      # The throttle is now reset since it hit the min_sleep value
+
+      reaper_throttle.call(max_sleep: 5) do |sleep_for|
+        expect(sleep_for).to eq(2)
+      end
+    end
+  end
+
+  it "over limit" do
+    reaper = Hatchet::Reaper.new(api_rate_limit: -> (){}, io: StringIO.new)
+    def reaper.hatchet_app_count; Hatchet::Reaper::HATCHET_APP_LIMIT + 1; end
+
+    expect(reaper.over_limit?).to be_truthy
+
+    reaper = Hatchet::Reaper.new(api_rate_limit: -> (){}, io: StringIO.new)
+    def reaper.hatchet_app_count; Hatchet::Reaper::HATCHET_APP_LIMIT - 1; end
+
+    expect(reaper.over_limit?).to be_falsey
+  end
+end

data/spec/unit/shell_throttle.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe "ShellThrottle" do
+  it "throttles when throw is called" do
+    platform_api = Hatchet::Runner.new("default_ruby").platform_api
+
+    @count = 0
+    Hatchet::ShellThrottle.new(platform_api: platform_api).call do
+      @count += 1
+      if @count >= 2
+        # No throttle
+      else
+        throw(:throttle)
+      end
+    end
+    expect(@count).to eq(2)
+  end
+
+  it "does not throttle when throw is NOT called" do
+    platform_api = Hatchet::Runner.new("default_ruby").platform_api
+
+    @count = 0
+    Hatchet::ShellThrottle.new(platform_api: platform_api).call do
+      @count += 1
+    end
+    expect(@count).to eq(1)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroku_hatchet
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 7.1.1
 platform: ruby
 authors:
 - Richard Schneeman
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2020-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: platform-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rrrretry
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: repl_runner
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: threaded
   requirement: !ruby/object:Gem::Requirement
@@ -95,33 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-retry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.9
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.9
-- !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -151,19 +123,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: parallel_tests
+  name: parallel_split_test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
@@ -179,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: m
+  name: rspec-retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -203,7 +175,6 @@ files:
 - ".circleci/config.yml"
 - ".github/workflows/check_changelog.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -222,37 +193,32 @@ files:
 - lib/hatchet/config.rb
 - lib/hatchet/git_app.rb
 - lib/hatchet/reaper.rb
+- lib/hatchet/reaper/app_age.rb
+- lib/hatchet/reaper/reaper_throttle.rb
+- lib/hatchet/shell_throttle.rb
 - lib/hatchet/tasks.rb
 - lib/hatchet/test_run.rb
 - lib/hatchet/version.rb
-- test/different-folder-for-checked-in-repos/default_ruby/Gemfile
-- test/different-folder-for-checked-in-repos/default_ruby/Gemfile.lock
-- test/fixtures/buildpacks/null-buildpack/bin/compile
-- test/fixtures/buildpacks/null-buildpack/bin/detect
-- test/fixtures/buildpacks/null-buildpack/bin/release
-- test/fixtures/buildpacks/null-buildpack/hatchet.json
-- 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
-- test/hatchet/config_test.rb
-- test/hatchet/edit_repo_test.rb
-- test/hatchet/git_test.rb
-- test/hatchet/heroku_api_test.rb
-- test/hatchet/labs_test.rb
-- test/hatchet/local_repo_test.rb
-- test/hatchet/lock_test.rb
-- test/hatchet/multi_cmd_runner_test.rb
-- test/test_helper.rb
+- repo_fixtures/different-folder-for-checked-in-repos/default_ruby/Gemfile
+- repo_fixtures/different-folder-for-checked-in-repos/default_ruby/Gemfile.lock
+- spec/hatchet/allow_failure_git_spec.rb
+- spec/hatchet/app_spec.rb
+- spec/hatchet/ci_spec.rb
+- spec/hatchet/config_spec.rb
+- spec/hatchet/edit_repo_spec.rb
+- spec/hatchet/git_spec.rb
+- spec/hatchet/heroku_api_spec.rb
+- spec/hatchet/local_repo_spec.rb
+- spec/hatchet/lock_spec.rb
+- spec/spec_helper.rb
+- spec/unit/reaper_spec.rb
+- spec/unit/shell_throttle.rb
 - tmp/parallel_runtime_test.log
 homepage: https://github.com/heroku/hatchet
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -268,29 +234,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Hatchet is a an integration testing library for developing Heroku buildpacks.
 test_files:
-- test/different-folder-for-checked-in-repos/default_ruby/Gemfile
-- test/different-folder-for-checked-in-repos/default_ruby/Gemfile.lock
-- test/fixtures/buildpacks/null-buildpack/bin/compile
-- test/fixtures/buildpacks/null-buildpack/bin/detect
-- test/fixtures/buildpacks/null-buildpack/bin/release
-- test/fixtures/buildpacks/null-buildpack/hatchet.json
-- 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
-- test/hatchet/config_test.rb
-- test/hatchet/edit_repo_test.rb
-- test/hatchet/git_test.rb
-- test/hatchet/heroku_api_test.rb
-- test/hatchet/labs_test.rb
-- test/hatchet/local_repo_test.rb
-- test/hatchet/lock_test.rb
-- test/hatchet/multi_cmd_runner_test.rb
-- test/test_helper.rb
+- spec/hatchet/allow_failure_git_spec.rb
+- spec/hatchet/app_spec.rb
+- spec/hatchet/ci_spec.rb
+- spec/hatchet/config_spec.rb
+- spec/hatchet/edit_repo_spec.rb
+- spec/hatchet/git_spec.rb
+- spec/hatchet/heroku_api_spec.rb
+- spec/hatchet/local_repo_spec.rb
+- spec/hatchet/lock_spec.rb
+- spec/spec_helper.rb
+- spec/unit/reaper_spec.rb
+- spec/unit/shell_throttle.rb