ci_runner 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6573071a75fdc013ce2cb451567a5610d4928d8e10e336bba6296b1b046f1b82
-  data.tar.gz: b171257681c40b76b71c5113c243bdc9ee3992e2522b3128e980527eaab151bf
+  metadata.gz: 361a2617b4dfcf8a20ed8566286fed6b10c88f9618d712dfd939520e31ab3400
+  data.tar.gz: 39a23722fd556bac27f95fd5417bf0a6b3db5d736c6effbc4ea55e9025f91965
 SHA512:
-  metadata.gz: 40a798ad29846ca92722b56ef4f1bae2a1f76358de371ebf95fec1053b135882cbbb494430d77cc720ed3d60795413b994fc7288261e1c4d2bc981b0a003b45f
-  data.tar.gz: c1cde1a84e5c4cdc87b4763a85388373b187a43518f72330a3a1c7855f51ca33f358b1831977d708105731ebd61c75c25184f7cfb4ec9abcb7c0b32458e247d1
+  metadata.gz: 4e904af08558ae212fe8cf2ca471d56c74ff25a74c416c085478bd6f3e840cde12fd5e4f2e9a5444d00c6d92ee1ce1caf5b19d432a9294947a6451c6c19907bb
+  data.tar.gz: a1c780586d26f82d1524450cb930c4be253017f1d739b6be6504fe76907ec09283bd8ba6b542cca92850f9d33f437c4ed58b1c8fa2002c544b2f38c9995c44dc

data/ci_runner.gemspec

@@ -34,10 +34,12 @@ Gem::Specification.new do |spec|
   spec.executables = ["ci_runner"]
   spec.require_paths = ["lib"]
 
-  spec.add_dependency("cli-ui", "~> 1.5")
+  spec.add_dependency("cli-ui", "~> 2.7")
+  spec.add_dependency("drb")
   spec.add_dependency("rake", "~> 13.0")
   spec.add_dependency("thor", "~> 1.2")
 
+  spec.add_development_dependency("base64")
   spec.add_development_dependency("rspec", "~> 3.11")
   spec.add_development_dependency("rubocop-shopify", "~> 2.8")
   spec.add_development_dependency("webmock", "~> 3.14")

data/lib/ci_runner/check/buildkite.rb

@@ -39,14 +39,18 @@ module CIRunner
       def download_log
         uri = URI(url)
         _, org, pipeline, _, build = uri.path.split("/")
-        @client = Client::Buildkite.new
+        @token = nil
+        client = Client::Buildkite.new
 
-        unless @client.public_build?(org, pipeline, build)
-          token = retrieve_token_from_config(org, url)
-          @client = Client::AuthenticatedBuildkite.new(token)
+        unless client.public_build?(org, pipeline, build)
+          @token = retrieve_token_from_config(org, url)
+          client = Client::AuthenticatedBuildkite.new(@token)
         end
 
-        @client.job_logs(org, pipeline, build).each do |log_url|
+        # Remember the client class so each concurrent download can build its own instance in #process.
+        @client_class = client.class
+
+        client.job_logs(org, pipeline, build).each do |log_url|
           @queue << log_url
         end
 
@@ -55,14 +59,17 @@ module CIRunner
 
       private
 
+      # Net::HTTP is not thread-safe, so each concurrent download gets its own client instance
+      # rather than sharing (and repeatedly resetting) a single one across threads.
+      #
       # @param url [String]
       #
       # @return [void]
       def process(url)
-        @client.reset!
-        response = @client.download_log(url)
+        response = @client_class.new(@token).download_log(url)
+        content = response.read
 
-        @tempfile.write(response.read)
+        @write_mutex.synchronize { @tempfile.write(content) }
       end
 
       # Retrieve a Buildkite token from the user confg.

data/lib/ci_runner/check/circle_ci.rb

@@ -113,7 +113,7 @@ module CIRunner
         parsed_response = JSON.parse(response.read)
         log_output = parsed_response.map! { |res| res["message"] }.join
 
-        @tempfile.write(log_output)
+        @write_mutex.synchronize { @tempfile.write(log_output) }
       end
 
       # The URL on the commit status will look something like: https://circleci.com/gh/owner/repo/1234?query_string.

data/lib/ci_runner/check/concurrent_download.rb

@@ -13,6 +13,7 @@ module CIRunner
       def initialize(...)
         @queue = Queue.new
         @tempfile = Tempfile.new
+        @write_mutex = Mutex.new
 
         super(...)
       end

data/lib/ci_runner/cli.rb

@@ -29,9 +29,9 @@ module CIRunner
       Please note that CI Runner will **not** ensure that the Git HEAD of your local repository matches
       the commit that failed upstream.
     EOM
-    option :commit, type: :string, desc: "The Git commit that was pushed to GitHub and has a failing CI. The HEAD commit of your local repository will be used by default." # rubocop:disable Layout/LineLength
-    option :repository, type: :string, desc: "The repository on which the CI failed. The repository will be infered from your git remote by default.", banner: "catanacorp/catana" # rubocop:disable Layout/LineLength
-    option :run_name, type: :string, desc: "The CI check you which to rerun in case multiple checks failed for a commit. CI Runner will prompt you by default." # rubocop:disable Layout/LineLength
+    option :commit, type: :string, desc: "The Git commit that was pushed to GitHub and has a failing CI. The HEAD commit of your local repository will be used by default."
+    option :repository, type: :string, desc: "The repository on which the CI failed. The repository will be infered from your git remote by default.", banner: "catanacorp/catana"
+    option :run_name, type: :string, desc: "The CI check you which to rerun in case multiple checks failed for a commit. CI Runner will prompt you by default."
     def rerun
       ::CLI::UI::StdoutRouter.enable
 

data/lib/ci_runner/client/github.rb

@@ -45,16 +45,20 @@ module CIRunner
         get("/repos/#{repository}/commits/#{commit}/check-runs")
       end
 
-      # Makes an API request to get the Commit statuses for the +commit+.
+      # Makes an API request to get the combined Commit status for the +commit+.
+      #
+      # Unlike the "list commit statuses" endpoint (which is append-only and returns every status
+      # update), the combined status endpoint returns only the latest status per context, matching
+      # what GitHub displays. This avoids presenting duplicate checks to the user.
       #
       # @param repository [String] The full repository name, including the owner (rails/rails)
       # @param commit [String] The Git commit that has been pushed to GitHub.
       #
       # @return [Hash] See GitHub documentation.
       #
-      # @see https://docs.github.com/en/rest/commits/statuses#list-commit-statuses-for-a-reference
-      def commit_statuses(repository, commit)
-        get("/repos/#{repository}/commits/#{commit}/statuses")
+      # @see https://docs.github.com/en/rest/commits/statuses#get-the-combined-status-for-a-specific-reference
+      def commit_status(repository, commit)
+        get("/repos/#{repository}/commits/#{commit}/status")
       end
 
       # Makes two requests to get the CI log for a check run.

data/lib/ci_runner/configuration/project.rb

@@ -183,6 +183,44 @@ module CIRunner
         value.nil? ? true : value
       end
 
+      # Whether CI Runner should detect the Ruby version used on CI and re-run the tests with the
+      # matching Ruby from ~/.rubies.
+      #
+      # Set this to +false+ for projects whose gems are bound to a specific interpreter/gem path
+      # that CI Runner shouldn't override (e.g. a Nix- or shadowenv-managed monorepo). When false,
+      # the rerun uses the Ruby and gems of the environment CI Runner is invoked from.
+      #
+      # @return [Boolean] True by default.
+      #
+      # @example Storing this configuration
+      #   `cat myproject/.github/ci_runner.yml`
+      #
+      #   ---
+      #   detect_ruby: false
+      def detect_ruby?
+        value = @yaml_config.dig("detect_ruby")
+
+        value.nil? ? true : value
+      end
+
+      # Whether CI Runner should detect the Gemfile used on CI and re-run the tests with it.
+      #
+      # Set this to +false+ for the same reasons as +detect_ruby?+: when the environment CI Runner
+      # runs in already provides the correct set of dependencies.
+      #
+      # @return [Boolean] True by default.
+      #
+      # @example Storing this configuration
+      #   `cat myproject/.github/ci_runner.yml`
+      #
+      #   ---
+      #   detect_gemfile: false
+      def detect_gemfile?
+        value = @yaml_config.dig("detect_gemfile")
+
+        value.nil? ? true : value
+      end
+
       # Main detection regex used to detect test failures.
       #
       # **Important** This regexp 3 named capture groups. The order doesn't matter.

data/lib/ci_runner/runners/base.rb

@@ -49,11 +49,11 @@ module CIRunner
           when seed_regex
             @seed = first_matching_group(Regexp.last_match)
           when ruby_detection_regex
-            @ruby_version = first_matching_group(Regexp.last_match)
+            @ruby_version = first_matching_group(Regexp.last_match) if Configuration::Project.instance.detect_ruby?
 
             @buffer << line_no_ansi_color if buffering?
           when gemfile_detection_regex
-            @gemfile = first_matching_group(Regexp.last_match)
+            @gemfile = first_matching_group(Regexp.last_match) if Configuration::Project.instance.detect_gemfile?
           when buffer_detection_regex
             if Configuration::Project.instance.process_on_new_match? && buffering?
               process_buffer

data/lib/ci_runner/runners/minitest_runner.rb

@@ -66,12 +66,14 @@ module CIRunner
 
         minitest_plugin_path = File.expand_path("../..", __dir__)
         rake_load_path = Gem.loaded_specs["rake"].full_require_paths.first
+        drb_load_path = Gem.loaded_specs["drb"].full_require_paths.first
 
         code = <<~EOM
           Rake::TestTask.new(:__ci_runner_test) do |t|
             t.libs << "test"
             t.libs << "lib"
             t.libs << "#{rake_load_path}"
+            t.libs << "#{drb_load_path}"
             t.libs << "#{minitest_plugin_path}"
             t.test_files = #{failures.map(&:path)}
             t.ruby_opts = ["-W0"] if ENV["NO_WARNING"]
@@ -122,7 +124,7 @@ module CIRunner
       #
       # For failure, Minitest will print the location of the test file, but it can be wrong.
       #
-      # MaintenanceTasks::RunsTest#test_run_a_CSV_Task [/home/runner/work/maintenance_tasks/maintenance_tasks/vendor/bundle/ruby/2.7.0/gems/capybara-3.37.1/lib/capybara/minitest.rb:295] # rubocop:disable Layout/LineLength
+      # MaintenanceTasks::RunsTest#test_run_a_CSV_Task [/home/runner/work/maintenance_tasks/maintenance_tasks/vendor/bundle/ruby/2.7.0/gems/capybara-3.37.1/lib/capybara/minitest.rb:295]
       #
       # In this case the location of the file points to a file inside a gem, which is for sure not where the test lives.
       # When this happen, we discard the location provided by Minitest and try to match another possible location.

data/lib/ci_runner/test_run_finder.rb

@@ -64,10 +64,10 @@ module CIRunner
     # @see https://docs.github.com/en/rest/checks/runs#get-a-check-run
     def other_ci(repository, commit)
       github_client = Client::Github.new(Configuration::User.instance.github_token)
-      commit_statuses = github_client.commit_statuses(repository, commit)
+      commit_status = github_client.commit_status(repository, commit)
 
-      commit_statuses.map do |commit_status|
-        check_class_from_url(commit_status, repository, commit)
+      commit_status["statuses"].map do |status|
+        check_class_from_url(status, repository, commit)
       end.compact
     end
 

data/lib/ci_runner/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CIRunner
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/minitest/ci_runner_plugin.rb

@@ -25,6 +25,11 @@ module Minitest
           "#{failure.klass}##{failure.test_name}" == runnable
         end
       end
+
+      # Vanilla Minitest filters with `filter === runnable`, but the minitest-reporters gem's
+      # DelegateReporter calls `filter.match?(runnable)` instead. Alias the two so CI Runner
+      # works whether or not the project under test uses minitest-reporters.
+      alias_method :match?, :===
     end
 
     options[:filter] = filter.new(failures)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ci_runner
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Edouard Chin
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-ui
@@ -16,14 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: drb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +65,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: base64
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -146,7 +173,6 @@ metadata:
   changelog_uri: https://github.com/Edouard-chin/ci_runner/blob/main/CHANGELOG.md
   allowed_push_host: https://rubygems.org
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -161,8 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Re-run failing tests from CI on your local machine without copy/pasting.
 test_files: []