heroku_hatchet 7.3.4 → 7.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a45ee1ab2021838074b4f288d70aab769a71961cbae7cd12af67866e5558bb64
-  data.tar.gz: 0c99b826bfc797632924e151b796590f1ddbd07ff50e9eea2dc816b9991fb69d
+  metadata.gz: 4e33ffcf73b42d412f81525fdce9b77baa34da4083a6662cb14ddb098a0535dc
+  data.tar.gz: 3d73f585c00dd74cd4733802af979ba75e2c04e4cb93118128fdaf6efe9bc53b
 SHA512:
-  metadata.gz: 940afbe59938c35c5bee92ac43dabe66e0e68f7cefbc35b662667eaecec343f04cc83e93418e7302a47ce2f955b2d7269073e167614a475dc91d69e6bee94d82
-  data.tar.gz: 204098d3744d64717141ca4d8f754324e761981b3d2d3bc9710e3b18e5532c97a1028813e1d7e2d295d35fb36e1b09ab78761a370af6490849de991ca50045ce
+  metadata.gz: f9ef93379dd21e7808f30d9a2ed6179a76aa12679d5a1129a1ed394682c3e046abcc6c8b87ae8d3112edc5ff77965f90d42550be6d09a49ed89b7ad7270fdf14
+  data.tar.gz: 6cd06944d64ca9ae96ed8b25744000de748a5235dc52fab838368b9afc75c28af6dc9c1432106a99f972b4044d94762ce573fcaef2fa91f062a68aad2000b05a

data/.github/workflows/check_changelog.yml

@@ -1,13 +1,22 @@
 name: Check Changelog
 
 on:
- pull_request:
-  types: [opened, reopened, edited, synchronize]
+  pull_request:
+    types: [opened, reopened, edited, labeled, unlabeled, synchronize]
+
 jobs:
-  build:
+  check-changelog:
     runs-on: ubuntu-latest
+    if: |
+      !contains(github.event.pull_request.body, '[skip changelog]') &&
+      !contains(github.event.pull_request.body, '[changelog skip]') &&
+      !contains(github.event.pull_request.body, '[skip ci]') &&
+      !contains(github.event.pull_request.labels.*.name, 'skip changelog') &&
+      !contains(github.event.pull_request.labels.*.name, 'dependencies') &&
+      !contains(github.event.pull_request.labels.*.name, 'automation')
     steps:
-    - uses: actions/checkout@v1
-    - name: Check that CHANGELOG is touched
-      run: |
-        cat $GITHUB_EVENT_PATH | jq .pull_request.title |  grep -i '\[\(\(changelog skip\)\|\(ci skip\)\)\]' ||  git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md
+      - uses: actions/checkout@v3
+      - name: Check that CHANGELOG is touched
+        run: |
+          git fetch origin ${{ github.base_ref }} --depth 1 && \
+          git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md

data/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+on:
+  push:
+    # Avoid duplicate builds on PRs.
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ["2.7", "3.0", "3.1"]
+    runs-on: ubuntu-22.04
+    env:
+      HATCHET_APP_LIMIT: 100
+      HATCHET_RETRIES: 3
+      HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}
+      HEROKU_API_USER: ${{ secrets.HEROKU_API_USER }}
+      IS_RUNNING_ON_CI: 1
+      HATCHET_EXPENSIVE_MODE: 1
+      PARALLEL_SPLIT_TEST_PROCESSES: 25
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }} and dependencies
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Hatchet setup
+        run: bundle exec hatchet ci:setup
+      - name: Run test suite
+        run: bundle exec parallel_split_test spec/

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## HEAD
 
+## 7.4.0
+
+- Supports "basic" scaledown (https://github.com/heroku/hatchet/pull/193)
+- Breaking: Support for Ruby 2.2 is soft removed going forward only Ruby versions on the currently released stack will be supported
+- Bugfix: `heroku run` calls are now properly rate throttled and retried https://github.com/heroku/hatchet/pull/187
+
 ## 7.3.4
 
 - Memoize `Hatchet::App.default_buildpack` (https://github.com/heroku/hatchet/pull/183)

data/lib/hatchet/app.rb

@@ -360,7 +360,7 @@ module Hatchet
 
       if @run_multi_is_setup
         @run_multi_array.map(&:join)
-        platform_api.formation.update(name, "web", {"size" => "free"})
+        platform_api.formation.update(name, "web", {"size" => "basic"})
       end
 
     ensure

data/lib/hatchet/heroku_run.rb

@@ -1,4 +1,39 @@
+require 'open3'
+
 module Hatchet
+  class BashResult
+    attr_reader :stdout, :stderr, :status
+
+    def initialize(stdout:, stderr:, status:, set_global_status: false)
+      @stdout = stdout
+      @stderr = stderr
+      @status = status.respond_to?(:exitstatus) ? status.exitstatus : status.to_i
+      `exit #{@status}` if set_global_status
+    end
+
+    # @return [Boolean]
+    def success?
+      @status == 0
+    end
+
+    def failed?
+      !success?
+    end
+
+    # Testing helper methods
+    def include?(value)
+      stdout.include?(value)
+    end
+
+    def match?(value)
+      stdout.match?(value)
+    end
+
+    def match(value)
+      stdout.match(value)
+    end
+  end
+
   # Used for running Heroku commands
   #
   # Example:
@@ -28,18 +63,21 @@ module Hatchet
       @command = build_heroku_command(command, heroku || {})
       @retry_on_empty = retry_on_empty
       @stderr = stderr
-      @output = ""
-      @status = nil
+      @result = nil
       @empty_fail_count = 0
     end
 
+    def result
+      raise "You must run `call` on this object first" unless @result
+      @result
+    end
+
     def output
-      raise "You must run `call` on this object first" unless @status
-      @output
+      result.stdout
     end
 
     def status
-      raise "You must run `call` on this object first" unless @status
+      result
       @status
     end
 
@@ -68,12 +106,13 @@ module Hatchet
     private def execute!
       ShellThrottle.new(platform_api: @app.platform_api).call do |throttle|
         run_shell!
-        throw(:throttle) if output.match?(/reached the API rate limit/)
+        throw(:throttle) if @result.stderr.match?(/reached the API rate limit/)
       end
     end
 
     private def run_shell!
-      @output = `#{@command}`
+      stdout, stderr, status = Open3.capture3(@command)
+      @result = BashResult.new(stdout: stdout, stderr: stderr, status: status, set_global_status: true)
       @status = $?
     end
 

data/lib/hatchet/templates/check_changelog.erb

@@ -1,13 +1,22 @@
 name: Check Changelog
 
 on:
- pull_request:
-  types: [opened, reopened, edited, synchronize]
+  pull_request:
+    types: [opened, reopened, edited, labeled, unlabeled, synchronize]
+
 jobs:
-  build:
+  check-changelog:
     runs-on: ubuntu-latest
+    if: |
+      !contains(github.event.pull_request.body, '[skip changelog]') &&
+      !contains(github.event.pull_request.body, '[changelog skip]') &&
+      !contains(github.event.pull_request.body, '[skip ci]') &&
+      !contains(github.event.pull_request.labels.*.name, 'skip changelog') &&
+      !contains(github.event.pull_request.labels.*.name, 'dependencies') &&
+      !contains(github.event.pull_request.labels.*.name, 'automation')
     steps:
-    - uses: actions/checkout@v1
-    - name: Check that CHANGELOG is touched
-      run: |
-        cat $GITHUB_EVENT_PATH | jq .pull_request.title |  grep -i '\[\(\(changelog skip\)\|\(ci skip\)\)\]' ||  git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md
+      - uses: actions/checkout@v3
+      - name: Check that CHANGELOG is touched
+        run: |
+          git fetch origin ${{ github.base_ref }} --depth 1 && \
+          git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md

data/lib/hatchet/version.rb

@@ -1,3 +1,3 @@
 module Hatchet
-  VERSION = "7.3.4"
+  VERSION = "7.4.0"
 end

data/spec/hatchet/app_spec.rb

@@ -63,7 +63,7 @@ describe "AppTest" do
   end
 
   it "create app with stack" do
-    stack = "heroku-16"
+    stack = "heroku-18"
     app = Hatchet::App.new("default_ruby", stack: stack)
     app.create_app
     expect(app.platform_api.app.info(app.name)["build_stack"]["name"]).to eq(stack)

data/spec/hatchet/ci_spec.rb

@@ -27,6 +27,8 @@ describe "CIFourTest" do
   end
 
   it "error with bad app" do
+    pending("upgrade rails 5 app to newer")
+
     expect {
       Hatchet::GitApp.new("rails5_ci_fails_no_database", stack: "heroku-18").run_ci { }
     }.to raise_error(/PG::ConnectionBad: could not connect to server/)
@@ -51,6 +53,8 @@ describe "CIFourTest" do
   end
 
   it "ci create app with stack" do
+    pending("upgrade rails 5 app to newer")
+
     app = Hatchet::GitApp.new("rails5_ruby_schema_format")
     app.run_ci do |test_run|
       expect(test_run.output).to match("Ruby buildpack tests completed successfully")

data/spec/unit/heroku_run_spec.rb

@@ -50,7 +50,7 @@ describe "HerokuRun" do
       run_obj = Hatchet::HerokuRun.new("ruby -v", app: @app, stderr: stderr)
 
       def run_obj.run_shell!
-        @output = ""
+        @result = Hatchet::BashResult.new(stdout: "", stderr: "", status: 1)
         @status = Object.new
       end
 
@@ -65,7 +65,7 @@ describe "HerokuRun" do
       run_obj = Hatchet::HerokuRun.new("ruby -v", app: @app, stderr: stderr)
 
       def run_obj.run_shell!
-        @output = "not empty"
+        @result = Hatchet::BashResult.new(stdout: "not empty", stderr: "", status: 1)
         @status = Object.new
       end
 
@@ -80,7 +80,7 @@ describe "HerokuRun" do
       run_obj = Hatchet::HerokuRun.new("ruby -v", app: @app, stderr: stderr, retry_on_empty: false)
 
       def run_obj.run_shell!
-        @output = ""
+        @result = Hatchet::BashResult.new(stdout: "", stderr: "", status: 1)
         @status = Object.new
       end
 
@@ -90,6 +90,24 @@ describe "HerokuRun" do
       expect(stderr.string).to_not include("retrying the command.")
     end
 
+    it "retries work when message is delivered via stderr" do
+      stderr = StringIO.new
+      run_obj = Hatchet::HerokuRun.new("ruby -v", app: @app, stderr: stderr, retry_on_empty: false)
+
+      def run_obj.run_shell!
+        @throttle_retry_count ||= 0
+        @throttle_retry_count += 1
+        @command = "echo 'lol'" if @throttle_retry_count > 1
+
+        super
+      end
+
+      run_obj.instance_variable_set(:@command, "ruby -e 'STDERR.puts %Q{reached the API rate limit}'")
+      run_obj.call
+
+      expect(run_obj.instance_variable_get(:@throttle_retry_count)).to eq(2)
+    end
+
     it "retries 0 times on empty result when disabled via ENV var" do
       begin
         original_env = ENV["HATCHET_DISABLE_EMPTY_RUN_RETRY"]
@@ -98,7 +116,7 @@ describe "HerokuRun" do
         run_obj = Hatchet::HerokuRun.new("ruby -v", app: @app, stderr: stderr)
 
         def run_obj.run_shell!
-          @output = ""
+          @result = Hatchet::BashResult.new(stdout: "", stderr: "", status: 1)
           @status = Object.new
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroku_hatchet
 version: !ruby/object:Gem::Version
-  version: 7.3.4
+  version: 7.4.0
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
+date: 2023-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: platform-api
@@ -158,8 +158,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
 - ".github/workflows/check_changelog.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
@@ -230,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Hatchet is a an integration testing library for developing Heroku buildpacks.

data/.circleci/config.yml

@@ -1,69 +0,0 @@
-version: 2
-references:
-  unit: &unit
-    run:
-      name: Run test suite
-      command: PARALLEL_SPLIT_TEST_PROCESSES=25 bundle exec parallel_split_test spec/
-      environment:
-        HATCHET_EXPENSIVE_MODE: 1 # !!!! WARNING !!!! ONLY RUN THIS IF YOU WORK FOR HEROKU !!!! WARNING !!!!
-  restore: &restore
-    restore_cache:
-      keys:
-        - v1_bundler_deps-{{ .Environment.CIRCLE_JOB }}
-  save: &save
-    save_cache:
-      paths:
-        - ./vendor/bundle
-      key: v1_bundler_deps-{{ .Environment.CIRCLE_JOB }} # CIRCLE_JOB e.g. "ruby-2.5"
-  hatchet_setup: &hatchet_setup
-    run:
-      name: Hatchet setup
-      command: |
-        bundle exec hatchet ci:setup
-  bundle: &bundle
-    run:
-      name: install dependencies
-      command: |
-        bundle install --jobs=4 --retry=3 --path vendor/bundle
-        bundle update
-        bundle clean
-
-jobs:
-  "ruby-2.2":
-    docker:
-      - image: circleci/ruby:2.2
-    steps:
-      - checkout
-      - <<: *restore
-      - <<: *bundle
-      - <<: *hatchet_setup
-      - <<: *unit
-      - <<: *save
-  "ruby-2.5":
-    docker:
-      - image: circleci/ruby:2.5
-    steps:
-      - checkout
-      - <<: *restore
-      - <<: *bundle
-      - <<: *hatchet_setup
-      - <<: *unit
-      - <<: *save
-  "ruby-2.7":
-    docker:
-      - image: circleci/ruby:2.7
-    steps:
-      - checkout
-      - <<: *restore
-      - <<: *bundle
-      - <<: *hatchet_setup
-      - <<: *unit
-      - <<: *save
-
-workflows:
-  version: 2
-  build:
-    jobs:
-      - "ruby-2.2"
-      - "ruby-2.5"
-      - "ruby-2.7"