ci_runner 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25a11b4505aff5153e388723711643c4aae5f3a7b64b53b3265e0bd7198ec381
-  data.tar.gz: 858492f60b87472cf41da22c5808a2371659d56712ef77dad98590cb98063ecf
+  metadata.gz: fb83fde059747332cee33b4a0d313d2eaefb735ec3fe0e291141e8a18a535fa3
+  data.tar.gz: 6dd4960bce217bbebba6a22b6e1863d0baaf7190c5835c1fc63de9d0cc86e94e
 SHA512:
-  metadata.gz: 51158e9a4b9cd2188f5161320dc140e076009f7c4550206b957ffac03e9b5859533dc99defc644f05aa126713f8d52cf1d2260a4691ba74cba746f779ec3c945
-  data.tar.gz: 5db9352b2360cec4f5f8b23ce4cf378fcef79c3cc1e8b2f1cb4543fb307a2fc8db1116fea023b766d262d768582dd9f44bb1c48434c2c6171e697962398f0543
+  metadata.gz: f1e747da3d2101445f77645cc9f4d37f1f36b53702a85b735aecac605576b0d060037b56a54fcd3269c65a4313ebc3a3b00cab05d4acfbfd0785f3138911d51e
+  data.tar.gz: 65a90464a386601f2bd6caaaa61ec6ea6188bd65688ddf9e32db0ee7006aff914bc3d3104271d5a4607f0252a1936514ee301b16bb3a708e1d32b7a12bc75c9d

data/ci_runner.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/Edouard-chin/ci_runner"
+  spec.metadata["changelog_uri"] = "https://github.com/Edouard-chin/ci_runner/blob/main/CHANGELOG.md"
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
   spec.metadata["rubygems_mfa_required"] = "true"
 

data/lib/ci_runner/check/base.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module CIRunner
+  module Check
+    # Base class for a CI check.
+    #
+    # @see https://docs.github.com/en/rest/checks/runs#get-a-check-run
+    # @see https://docs.github.com/en/rest/commits/statuses#list-commit-statuses-for-a-reference
+    class Base
+      # @return [String] The full repository name, including the owner (i.e. rails/rails)
+      attr_reader :repository
+
+      # @return [String] The Git commit that has been pushed to GitHub and for which we'll retrieve the CI checks.
+      attr_reader :commit
+
+      # @return [String] The name of that check. Should be whatever you had set in your CI configuration cile
+      attr_reader :name
+
+      # @return [String] The status from the GitHub API for this check. Can be a lot of different values.
+      #   See the GitHub API.
+      attr_reader :status
+
+      # @param repository (See #repository)
+      # @param commit (See #commit)
+      # @param name (See #name)
+      # @param status (See #status)
+      def initialize(repository, commit, name, status)
+        @repository = repository
+        @commit = commit
+        @name = name
+        @status = status
+      end
+
+      # Subclass have to implement this to download the log(s) output for the build.
+      #
+      # @raise [NotImplementedError]
+      #
+      # @return [IO]
+      def download_log
+        raise(NotImplementedError, "Subclass responsability")
+      end
+
+      # Used to tell the user which CI provider we are downloading the log output from.
+      #
+      # @return [String]
+      def provider
+        raise(NotImplementedError, "Subclass responsability")
+      end
+
+      # @return [Boolean]
+      def success?
+        @status == "success"
+      end
+
+      # @return [Boolean]
+      def failed?
+        @status == "failure"
+      end
+    end
+  end
+end

data/lib/ci_runner/check/circle_ci.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require "uri"
+require "open-uri"
+require "json"
+require "tempfile"
+
+module CIRunner
+  module Check
+    # A Step object represents a CircleCI step.
+    # This Struct has +eql?+ and +hash+ implemented in order to check if two steps are the same and remove
+    # the duplicates.
+    #
+    # Two steps are considered the same if their names are equal and both are successful.
+    # The reason this is implemented like this is to avoid downloading too many of the same logfiles.
+    #
+    # Project on CircleCI can be configured to run in parallel, the number of steps and therefore log output
+    # we have to download increases exponentially.
+    #
+    # As an example, imagine this CircleCI configuration:
+    #
+    # 'Minitest':
+    #   executor: ruby/default
+    #   parallelism: 16
+    #   steps:
+    #     - setup-ruby
+    #     - bundle install
+    #     - bin/rails test
+    #
+    # CircleCI will create 48 steps (and 48 log download link). Downloading those 48 log, don't make sense
+    # since they will be all similar. Unless they failed, in which case we download the log for that step.
+    #
+    # @see https://circleci.com/docs/configuration-reference#steps
+    Step = Struct.new(:name, :output_url, :failed) do
+      # Used in conjuction with +hash+ for unique comparison.
+      #
+      # @param other [Object]
+      #
+      # @return [Boolean]
+      def eql?(other)
+        return false if failed || other.failed
+
+        name == other.name
+      end
+
+      # Used for unique comparison.
+      #
+      # @return [String]
+      def hash
+        [self.class, name, failed].hash
+      end
+    end
+
+    # Check class used when a project is configured to run its CI using CircleCI.
+    class CircleCI < Base
+      attr_reader :url # :private:
+
+      # @param args (See Base#initialize)
+      # @param url [String] The html URL pointing to the CircleCI build.
+      def initialize(*args, url)
+        super(*args)
+
+        @url = url
+        @queue = Queue.new
+        @tempfile = Tempfile.new
+      end
+
+      # Used to tell the user which CI provider we are downloading the log output from.
+      #
+      # @return [String]
+      def provider
+        "CircleCI"
+      end
+
+      # Download the CI logs for this CI build.
+      #
+      # CircleCI doesn't have an API to download a single log file for the whole build. Instead, we have
+      # to download a log output for each steps. Depending on the number of steps configured on a project, and
+      # whether it uses parallelism, the number of log files to download might be quite important.
+      #
+      # The log for each steps are small in size, so downloading them in parallel to make things much faster.
+      #
+      # @return [Tempfile]
+      def download_log
+        client = Client::CircleCI.new(Configuration::User.instance.circle_ci_token)
+        job = client.job(repository, build_number)
+        steps = []
+
+        job["steps"].each do |step|
+          step["actions"].each do |parallel|
+            next unless parallel["has_output"]
+
+            steps << Step.new(*parallel.values_at("name", "output_url", "failed"))
+          end
+        end
+
+        steps.uniq!
+
+        steps.each do |step|
+          @queue << step
+        end
+
+        process_queue
+
+        @tempfile.tap(&:flush)
+      end
+
+      # @return [Boolean]
+      #
+      # @see https://docs.github.com/en/rest/commits/statuses#get-the-combined-status-for-a-specific-reference
+      def failed?
+        ["error", "failure"].include?(status)
+      end
+
+      private
+
+      # Implement a queuing system in order to download log files in parallel.
+      #
+      # @return [void]
+      def process_queue
+        max_threads = 6
+        threads = []
+
+        max_threads.times do
+          threads << Thread.new do
+            while (element = dequeue)
+              process(element)
+            end
+          end
+        end
+
+        threads.each(&:join)
+      end
+
+      # @param step [Step]
+      #
+      # @return [void]
+      def process(step)
+        response = URI.open(step.output_url)
+        parsed_response = JSON.parse(response.read)
+        log_output = parsed_response.map! { |res| res["message"] }.join
+
+        @tempfile.write(log_output)
+      end
+
+      # Dequeue a CircleCI Step from the queue.
+      #
+      # @return [Step, nil]
+      def dequeue
+        @queue.pop(true)
+      rescue ThreadError
+        nil
+      end
+
+      # The URL on the commit status will look something like: https://circleci.com/gh/owner/repo/1234?query_string.
+      # We want the `1234` which is the builder number.
+      #
+      # @return [Integer]
+      def build_number
+        URI(@url.to_s).path.split("/").last
+      end
+    end
+  end
+end

data/lib/ci_runner/check/github.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module CIRunner
+  module Check
+    # Check class used when a project is configured to run its CI using GitHub actions.
+    #
+    # @see https://docs.github.com/en/rest/actions/workflow-jobs
+    class Github < Base
+      attr_reader :id # :private:
+
+      # @param args (See Base#initialize)
+      # @param id [Integer] The ID of this check.
+      def initialize(*args, id)
+        super(*args)
+
+        @id = id
+      end
+
+      # Used to tell the user which CI provider we are downloading the log output from.
+      #
+      # @return [String]
+      def provider
+        "GitHub"
+      end
+
+      # Download the log output for thig GitHub build.
+      #
+      # @return (See Client::Github#download_log)
+      #
+      # @see https://docs.github.com/en/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
+      def download_log
+        github_client = Client::Github.new(Configuration::User.instance.github_token)
+
+        github_client.download_log(@repository, @id)
+      end
+    end
+  end
+end

data/lib/ci_runner/check/unsupported.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module CIRunner
+  module Check
+    # Check class used for any CI provider not (yet) supported by CIRunner.
+    #
+    # When running the `ci_runner` CLI, those will be selectable but CI runner will bail out
+    # if they get selected. Not sure if its a good idea :shrug:.
+    class Unsupported < Base
+      # @return [String]
+      def name
+        "#{@name} (Unsupported by CI Runner)"
+      end
+
+      # @return [String]
+      def provider
+        ""
+      end
+
+      # @raise [Error]
+      def download_log
+        raise(Error, <<~EOM)
+          Aw, snap! This CI is not supported by CI Runner.
+          Please open an Issue on GitHub to let me know you are interested:
+
+          {{info:https://github.com/Edouard-chin/ci_runner/issues/new}}
+        EOM
+      end
+    end
+  end
+end

data/lib/ci_runner/cli.rb

@@ -47,14 +47,12 @@ module CIRunner
         run_name = options[:run_name] || ask_for_name(ci_checks)
         check_run = TestRunFinder.find(ci_checks, run_name)
 
-        ci_log = fetch_ci_log(repository, commit, check_run)
-        runner = TestRunFinder.detect_runner(ci_log)
+        ci_log = fetch_ci_log(check_run)
+        runner = TestRunFinder.detect_runner(ci_log.read)
         runner.parse!
 
-        if runner.failures.count == 0
-          # Error
-        end
-      rescue GithubClient::Error, Error => e
+        no_failure_error(ci_log, runner) if runner.failures.count.zero?
+      rescue Client::Error, Error => e
         ::CLI::UI.puts("\n{{red:#{e.message}}}", frame_color: :red)
 
         exit(false)
@@ -71,13 +69,13 @@ module CIRunner
       Save a personal access GitHub token in the ~/.ci_runner/config.yml file.
       The GitHub token is required to fetch CI checks and download logs from repositories.
 
-      You can get a token from GitHub by following this link: https://github.com/settings/tokens/new?description=CI+Runner&scopes=repo # rubocop:disable Layout/LineLength
+      You can get a token from GitHub by following this link: https://github.com/settings/tokens/new?description=CI+Runner&scopes=repo
     EOM
     def github_token(token)
       ::CLI::UI::StdoutRouter.enable
 
       ::CLI::UI.frame("Saving GitHub Token") do
-        user = GithubClient.new(token).me
+        user = Client::Github.new(token).me
         Configuration::User.instance.save_github_token(token)
 
         ::CLI::UI.puts(<<~EOM)
@@ -85,13 +83,40 @@ module CIRunner
 
           {{info:The token has been saved in this file: #{Configuration::User.instance.config_file}}}
         EOM
-      rescue GithubClient::Error => e
+      rescue Client::Error => e
         ::CLI::UI.puts("{{red:\nYour token doesn't seem to be valid. The response from GitHub was: #{e.message}}}")
 
         exit(false)
       end
     end
 
+    desc "circle_ci_token TOKEN", "Save a Circle CI token in your config."
+    long_desc <<~EOM
+      Save a personal access Circle CI token in the ~/.ci_runner/config.yml file.
+      If one of your project uses Circle CI as its CI provider and the project is set to private,
+      CI Runner won't be able to fetch the logs unless you provide a token.
+
+      You can get a token from Circle CI by following this link: https://app.circleci.com/settings/user/tokens
+    EOM
+    def circle_ci_token(token)
+      ::CLI::UI::StdoutRouter.enable
+
+      ::CLI::UI.frame("Saving CircleCI Token") do
+        user = Client::CircleCI.new(token).me
+        Configuration::User.instance.save_circle_ci_token(token)
+
+        ::CLI::UI.puts(<<~EOM)
+          Hello {{warning:#{user["login"]}}}! {{success:Your token is valid!}}
+
+          {{info:The token has been saved in this file: #{Configuration::User.instance.config_file}}}
+        EOM
+      rescue Client::Error => e
+        ::CLI::UI.puts("{{red:\nYour token doesn't seem to be valid. The response from Circle CI was: #{e.message}}}")
+
+        exit(false)
+      end
+    end
+
     private
 
     # Retrieve all the GitHub CI checks for a given commit. Will be used to interactively prompt
@@ -100,7 +125,7 @@ module CIRunner
     # @param repository [String] The full repository name including the owner (rails/rails).
     # @param commit [String] A Git commit that has been pushed to GitHub and for which CI failed.
     #
-    # @return [Hash] See the GitHub documentation.
+    # @return [Array<Check::Base>] Array filled with Check::Base subclasses.
     #
     # @raise [SystemExit] Early exit the process if the CI checks can't be retrieved.
     #
@@ -120,19 +145,17 @@ module CIRunner
     # Download and cache the log for the GitHub check. Downloading the log allows CI Runner to parse it and detect
     # which test failed in order to run uniquely those on the user machine.
     #
-    # @param repository [String] The full repository name including the owner (rails/rails).
-    # @param commit [String]     A Git commit that has been pushed to GitHub and for which CI failed.
-    # @param check_run [Hash]    The GitHub Check that failed. See #fetch_ci_checks.
+    # @param check_run [Check::Base] The GitHub Check that failed. See #fetch_ci_checks.
     #
     # @return [String] The content of the CI log.
     #
     # @raise [SystemExit] Early exit the process if the CI checks can't be retrieved.
     #
     # @see https://docs.github.com/en/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
-    def fetch_ci_log(repository, commit, check_run)
-      log = LogDownloader.new(commit, repository, check_run).fetch do |error|
-        puts(<<~EOM)
-          Couldn't fetch the CI log. The response from GitHub was:
+    def fetch_ci_log(check_run)
+      log = LogDownloader.new(check_run).fetch do |error|
+        ::CLI::UI.puts(<<~EOM)
+          Couldn't fetch the CI log. The error was:
 
           #{error.message}
         EOM
@@ -140,27 +163,26 @@ module CIRunner
         exit(false)
       end
 
-      log.read
+      log
     end
 
     # Interatively ask the user which CI check to rerun in the case a commit has multiple failing checks.
     # This method only runs if the user has not passed the '--run-name' flag to ci_runner.
     # Will automatically select a check in the case where there is only one failing check.
     #
-    # @param ci_checks [Hash] (See #fetch_ci_checks)
+    # @param ci_checks [Array<Check::Base>] (See #fetch_ci_checks)
     #
-    # @return [Hash] A single Check Run, the one that the user selected.
+    # @return [Check::Base] A single Check, the one that the user selected.
     #
     # @raise [CIRunner::Error] In case all the CI checks on this commit were successfull. In such case
     #   there is no need to proceed as there should be no failing tests to rerun.
     def ask_for_name(ci_checks)
-      check_runs = ci_checks["check_runs"]
-      failed_runs = check_runs.reject { |check_run| check_run["conclusion"] == "success" }
+      failed_runs = ci_checks.select(&:failed?)
 
       if failed_runs.count == 0
         raise(Error, "No CI checks failed on this commit.")
       elsif failed_runs.count == 1
-        check_run = failed_runs.first["name"]
+        check_run = failed_runs.first.name
 
         ::CLI::UI.puts(<<~EOM)
           {{warning:Automatically selected the CI check #{check_run} because it's the only one failing.}}
@@ -170,9 +192,30 @@ module CIRunner
       else
         ::CLI::UI.ask(
           "Multiple CI checks failed for this commit. Please choose the one you wish to re-run.",
-          options: failed_runs.map { |check_run| check_run["name"] },
+          options: failed_runs.map(&:name),
         )
       end
     end
+
+    # Raise an error in the case where CI Runner can't detect test failures from the logs.
+    # Can happen for a couple of reasons, outlined in the error message below.
+    #
+    # @param ci_log [Pathname]
+    # @param runner [Runners::Minitest, Runners::RSpec]
+    #
+    # @raise [Error]
+    def no_failure_error(ci_log, runner)
+      raise(Error, <<~EOM)
+        Couldn't detect any {{warning:#{runner.name}}} test failures from the log output. This can be either because:
+
+        {{warning:- The selected CI is not running #{runner.name} tests.}}
+        {{warning:- CIRunner default set of regexes failed to match the failures.}}
+
+          If your application is using custom reporters, you'll need to configure CI Runner.
+          {{info:Have a look at the wiki to know how: https://github.com/Edouard-chin/ci_runner/wiki}}
+
+        The CI log output has been downloaded to {{underline:#{ci_log}}} if you need to inspect it.
+      EOM
+    end
   end
 end

data/lib/ci_runner/client/base.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "openssl"
+
+module CIRunner
+  module Client
+    class Base
+      # @return [Net::HTTP] An instance of Net:HTTP configured to make requests to the GitHub API endpoint.
+      def self.default_client
+        Net::HTTP.new(self::API_ENDPOINT, 443).tap do |http|
+          http.use_ssl = true
+          http.read_timeout = 3
+          http.write_timeout = 3
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        end
+      end
+
+      # @param access_token [String] The access token with "repo" scope.
+      # @param client [Net::HTTP]
+      def initialize(access_token = nil, client = self.class.default_client)
+        @access_token = access_token
+        @client = client
+      end
+
+      private
+
+      # Add authentication before making the request.
+      #
+      # @param request [Net::HTTPRequest] A subclass of Net::HTTPRequest.
+      #
+      # @return [void]
+      def authentication(request)
+        raise(NotImplementedError, "Subclass responsability")
+      end
+
+      # Perform an authenticated GET request.
+      #
+      # @param path [String] The resource to access.
+      #
+      # @return (See #request)
+      def get(path)
+        request(Net::HTTP::Get, path)
+      end
+
+      # Perform an authenticated request.
+      #
+      # @param verb_class [Net::HTTPRequest] A subclass of Net::HTTPRequest.
+      # @param path [String] The resource to access.
+      #
+      # @return [Hash, String] A decoded JSON response or a String pointing to the Location redirection.
+      def request(verb_class, path)
+        req = verb_class.new(path)
+        req["Accept"] = "application/json"
+        authentication(req)
+
+        response = @client.request(req)
+
+        case response.code.to_i
+        when 200..204
+          response.content_type == "application/json" ? JSON.parse(response.body) : response.body
+        when 302
+          response["Location"]
+        else
+          raise(Error.new(response.code, response.body, self.class.name.split("::").last))
+        end
+      end
+    end
+  end
+end

data/lib/ci_runner/client/circle_ci.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module CIRunner
+  module Client
+    class CircleCI < Base
+      API_ENDPOINT = "circleci.com"
+
+      # Make an API request to get the authenticated user. Used to verify if the access token
+      # the user has stored in its config is valid.
+      #
+      # @return [Hash] See Circle CI documentation.
+      #
+      # @see https://circleci.com/docs/api/v1/index.html#user
+      def me
+        get("/api/v1.1/me")
+      end
+
+      # @param repository [String] The full repository name including the owner (rails/rails).
+      # @param build_number [Integer] The CircleCI build number.
+      #
+      # @see https://circleci.com/docs/api/v1/index.html#single-job
+      def job(repository, build_number)
+        get("/api/v1.1/project/github/#{repository}/#{build_number}")
+      rescue Error => e
+        reraise_with_reason(e)
+      end
+
+      private
+
+      # Add authentication before making the request.
+      #
+      # @param request [Net::HTTPRequest] A subclass of Net::HTTPRequest.
+      #
+      # @return [void]
+      def authentication(request)
+        request.basic_auth(@access_token, "") if @access_token
+      end
+
+      # @param error [Client::Error]
+      #
+      # @raise [Client::Error] A better error message in case of a 404.
+      def reraise_with_reason(error)
+        if @access_token.nil? && error.error_code == 404
+          raise(error, <<~EOM.rstrip)
+            404 while trying to fetch the CircleCI build.
+
+            {{warning:Please save a CircleCI token in your configuration.}}
+            {{command:ci_runner help circle_ci_token}}
+          EOM
+        else
+          raise(error)
+        end
+      end
+    end
+  end
+end

data/lib/ci_runner/client/error.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CIRunner
+  module Client
+    class Error < StandardError
+      attr_reader :error_code
+
+      # @param error_code [String] The HTTP status code.
+      # @param error_body [String] The response from the provider.
+      # @param provider [String] The name of the CI provider.
+      # @param message [String, nil]
+      def initialize(error_code, error_body, provider, message = nil)
+        @error_code = error_code.to_i
+
+        if message
+          super(message)
+        else
+          super(<<~EOM.rstrip)
+            Error while making a request to #{provider}. Code: #{error_code}
+
+            The response was: #{error_body}
+          EOM
+        end
+      end
+    end
+  end
+end

data/lib/ci_runner/client/github.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require "open-uri"
+
+module CIRunner
+  module Client
+    # A simple client to interact the GitHub API.
+    #
+    # @example Using the client
+    #  Github.new("access_token").me
+    class Github < Base
+      API_ENDPOINT = "api.github.com"
+
+      # Make an API request to get the authenticated user. Used to verify if the access token
+      # the user has stored in its config is valid.
+      #
+      # @return [Hash] See GitHub documentation.
+      #
+      # @see https://docs.github.com/en/rest/users/users#get-the-authenticated-user
+      def me
+        get("/user")
+      end
+
+      # Makes an API request to get the CI checks for the +commit+.
+      #
+      # @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/checks/runs#list-check-runs-for-a-git-reference
+      def check_runs(repository, commit)
+        get("/repos/#{repository}/commits/#{commit}/check-runs")
+      end
+
+      # Makes an API request to get the Commit statuses for the +commit+.
+      #
+      # @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")
+      end
+
+      # Makes two requests to get the CI log for a check run.
+      # The first request returns a 302 containing a Location header poiting to a short lived url to download the log.
+      # The second request is to actually download the log.
+      #
+      # @param repository [String] The full repository name, including the owner (rails/rails)
+      # @param check_run_id [Integer] The GitHub ID of the check run.
+      #
+      # @return [Tempfile, IO] Depending on the size of the response. Quirk of URI.open.
+      #
+      # @see https://docs.github.com/en/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
+      def download_log(repository, check_run_id)
+        download_url = get("/repos/#{repository}/actions/jobs/#{check_run_id}/logs")
+
+        URI.open(download_url)
+      end
+
+      private
+
+      # Add authentication before making the request.
+      #
+      # @param request [Net::HTTPRequest] A subclass of Net::HTTPRequest.
+      #
+      # @return [void]
+      def authentication(request)
+        request.basic_auth("user", @access_token)
+      end
+    end
+  end
+end

data/lib/ci_runner/configuration/user.rb

@@ -39,6 +39,13 @@ module CIRunner
         @yaml_config.dig("github", "token")
       end
 
+      # Retrieve the stored CircleCI access token of the user.
+      #
+      # @return [String, nil] Depending if the user ran the `ci_runner circle_ci_token TOKEN` command.
+      def circle_ci_token
+        @yaml_config.dig("circle_ci", "token")
+      end
+
       # Write the GitHub token to the user configuration file
       #
       # @param token [String] A valid GitHub access token.
@@ -50,6 +57,17 @@ module CIRunner
         save!(@yaml_config)
       end
 
+      # Write the Circle CI token to the user configuration file
+      #
+      # @param token [String] A valid Circle CI access token.
+      #
+      # @return [void]
+      def save_circle_ci_token(token)
+        @yaml_config["circle_ci"] = { "token" => token }
+
+        save!(@yaml_config)
+      end
+
       # @return [Pathname] The path of the configuration file.
       #
       # @example

data/lib/ci_runner/log_downloader.rb

@@ -8,44 +8,44 @@ module CIRunner
   # A PORO to help download and cache a GitHub CI log.
   #
   # @example Using the service
-  #   log_dl = LogDownloader.new("commit_sha", "catanacorp/catana", { "id" => 1, "name" => "Ruby Test 3.1.2" })
+  #   log_dl = LogDownloader.new(
+  #     CICheck::GitHub.new(
+  #       "catanacorp/catana",
+  #       "commit_sha",
+  #       "Tests Ruby 2.7",
+  #       "failed",
+  #       12345,
+  #     )
+  #   )
   #   log_file = log_dl.fetch
   #   puts log_file # => File
-  #
-  # @see https://docs.github.com/en/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
   class LogDownloader
-    # @param commit [String] A Git commit. Used to compute the file name we are going to cache.
-    # @param repository [String] The repository full name, including the owner (i.e. rails/rails).
-    # @param check_run [Hash] A GitHub CI check for which we want to download the log.
-    def initialize(commit, repository, check_run)
-      @commit = commit
-      @repository = repository
+    # @param check_run [Check::Base] A Base::Check subclass for which we want to download the log.
+    def initialize(check_run)
       @check_run = check_run
     end
 
-    # Download the CI logs from GitHub or retrieve it from disk in case we previously downloaded it.
+    # Ask the +@check_run+ to download the log from its CI or retrieve it from disk in case we previously downloaded it.
     #
     # @param block [Proc, Lambda] A proc that gets called if fetching the logs from GitHub fails. Allows the CLI to
     #   prematurely exit while cleaning up the CLI::UI frame.
     #
-    # @return [File] A file ready to be read.
+    # @return [Pathname] The path to the log file.
     def fetch(&block)
       return cached_log if cached_log
 
-      github_client = GithubClient.new(Configuration::User.instance.github_token)
       error = nil
 
-      ::CLI::UI.spinner("Downloading CI logs from GitHub", auto_debrief: false) do
-        logfile = github_client.download_log(@repository, @check_run["id"])
-
-        cache_log(logfile)
-      rescue GithubClient::Error => e
+      ::CLI::UI.spinner("Downloading CI logs from #{@check_run.provider}", auto_debrief: false) do
+        cache_log(@check_run.download_log)
+      rescue Client::Error, Error => e
         error = e
 
         ::CLI::UI::Spinner::TASK_FAILED
       end
 
       block.call(error) if error
+
       cached_log
     end
 
@@ -74,14 +74,14 @@ module CIRunner
     # @example Given a repository "rails/rails". A CI check called "Ruby 3.0". A commit "abcdef".
     #   puts computed_filed_path # ==> /var/tmpdir/T/.../rails/rails/log-abcdef-Ruby 3.0
     def computed_file_path
-      normalized_run_name = @check_run["name"].tr("/", "_")
+      normalized_run_name = @check_run.name.tr("/", "_")
 
-      log_folder.join("log-#{@commit[0..12]}-#{normalized_run_name}.log")
+      log_folder.join("log-#{@check_run.commit[0..12]}-#{normalized_run_name}.log")
     end
 
     # @return [Pathname]
     def log_folder
-      Pathname(Dir.tmpdir).join(@repository)
+      Pathname(Dir.tmpdir).join(@check_run.repository)
     end
 
     # @return [Pathname, false] Depending if the log has been downloaded before.

data/lib/ci_runner/runners/base.rb

@@ -43,13 +43,15 @@ module CIRunner
       # @return [void]
       def parse!
         @ci_log.each_line do |line|
-          case line
+          line_no_ansi_color = line.gsub(/\e\[\d+m/, "")
+
+          case line_no_ansi_color
           when seed_regex
             @seed = first_matching_group(Regexp.last_match)
           when ruby_detection_regex
             @ruby_version = first_matching_group(Regexp.last_match)
 
-            @buffer << line if buffering?
+            @buffer << line_no_ansi_color if buffering?
           when gemfile_detection_regex
             @gemfile = first_matching_group(Regexp.last_match)
           when buffer_detection_regex
@@ -58,9 +60,9 @@ module CIRunner
               @buffer.clear
             end
 
-            @buffer << line
+            @buffer << line_no_ansi_color
           else
-            @buffer << line if buffering?
+            @buffer << line_no_ansi_color if buffering?
           end
         end
 

data/lib/ci_runner/runners/minitest_runner.rb

@@ -40,7 +40,7 @@ module CIRunner
       def self.match?(ci_log)
         default_reporter = %r{(Finished in) \d+\.\d{6}s, \d+\.\d{4} runs/s, \d+\.\d{4} assertions/s\.}
 
-        Regexp.union(default_reporter, SEED_REGEX, "minitest").match?(ci_log)
+        Regexp.union(default_reporter, SEED_REGEX).match?(ci_log)
       end
 
       # @return [String] See Runners::Base#report

data/lib/ci_runner/runners/rspec.rb

@@ -15,7 +15,7 @@ module CIRunner
         command = /bundle exec rspec/
         summary = /Failed examples:/
 
-        Regexp.union(command, summary, /rspec/i).match?(log)
+        Regexp.union(command, summary).match?(log)
       end
 
       # @return [String] See Runners::Base#report

data/lib/ci_runner/test_run_finder.rb

@@ -2,6 +2,8 @@
 
 module CIRunner
   module TestRunFinder
+    GITHUB_ACTION = "github-actions"
+
     extend self
 
     # Makes a request to GitHub to retrieve the checks for a commit. Display a nice UI with
@@ -12,18 +14,16 @@ module CIRunner
     # @param block [Proc, Lambda] A proc that will be called in case we can't retrieve the CI Checks.
     #   This allows the CLI to prematurely exit and let the CLI::UI closes its frame.
     #
-    # @return [Hash] See GitHub documentation
-    #
-    # @see https://docs.github.com/en/rest/checks/runs#list-check-runs-for-a-git-reference
+    # @return [Array<Check::Base>] Array filled with Check::Base subclasses.
     def fetch_ci_checks(repository, commit, &block)
-      github_client = GithubClient.new(Configuration::User.instance.github_token)
-      ci_checks = {}
       error = nil
-
+      ci_checks = []
       title = "Fetching failed CI checks from GitHub for commit {{info:#{commit[..12]}}}"
+
       ::CLI::UI.spinner(title, auto_debrief: false) do
-        ci_checks = github_client.check_runs(repository, commit)
-      rescue GithubClient::Error => e
+        ci_checks = github_ci(repository, commit)
+        ci_checks += other_ci(repository, commit)
+      rescue Client::Error, StandardError => e
         error = e
 
         ::CLI::UI::Spinner::TASK_FAILED
@@ -34,21 +34,58 @@ module CIRunner
       ci_checks
     end
 
+    # Download the GitHub checks. This is used in case a project uses GitHub itself as its CI provider.
+    #
+    # @param repository [String] The full repository name, including the owner (i.e. rails/rails)
+    # @param commit [String] The Git commit that has been pushed to GitHub and for which we'll retrieve the CI checks.
+    #
+    # @return [Array<Check::Github>]
+    #
+    # @see https://docs.github.com/en/rest/checks/runs#list-check-runs-for-a-git-reference
+    def github_ci(repository, commit)
+      github_client = Client::Github.new(Configuration::User.instance.github_token)
+      ci_checks = github_client.check_runs(repository, commit)["check_runs"]
+
+      ci_checks.filter_map do |check_run|
+        next unless check_run.dig("app", "slug") == GITHUB_ACTION
+
+        Check::Github.new(repository, commit, *check_run.values_at("name", "conclusion", "id"))
+      end
+    end
+
+    # Download the Commit Statuses for this commit. Some CI provider (like GitHub or Buildkite), doesn't use
+    # the GitHub Check API, but instead this API.
+    #
+    # @param repository [String] The full repository name, including the owner (i.e. rails/rails)
+    # @param commit [String] The Git commit that has been pushed to GitHub and for which we'll retrieve the CI checks.
+    #
+    # @return [Array<Check::CircleCI, Check::Unsupported>]
+    #
+    # @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_statuses.map do |commit_status|
+        check_class_from_url(commit_status, repository, commit)
+      end.compact
+    end
+
     # Find the CI check the user requested from the list of upstream checks.
     # This method is useful only when the user passes the `--run-name` flag to `ci-runner`. This makes
     # sure the CI check actually exists.
     #
-    # @param ci_checks [Hash] The response from the previous +fetch_ci_checks+ request.
+    # @param ci_checks [Array<Check::Base>] A list of CI checks.
     # @param run_name [String] The name of the CI run that the user would like to retry on its machine.
     #
-    # @return [Hash] A single check run from the list of +ci_checks+
+    # @return [Check::Base] A single check run from the list of +ci_checks+
     #
     # @raise [Error] If no CI checks with the given +run_name+ could be found.
     # @raise [Error] If the CI check was successfull. No point to continue as there should be no tests to rerun.
     def find(ci_checks, run_name)
-      check_run = ci_checks["check_runs"].find { |check_run| check_run["name"] == run_name }
+      check_run = ci_checks.find { |check| check.name == run_name }
       raise(Error, no_check_message(ci_checks, run_name)) if check_run.nil?
-      raise(Error, check_succeed(run_name)) if check_run["conclusion"] == "success"
+      raise(Error, check_succeed(run_name)) unless check_run.failed?
 
       check_run
     end
@@ -75,6 +112,28 @@ module CIRunner
 
     private
 
+    # Infer the CI Runner Check class based on the URL pointing to the CI provider's page.
+    #
+    # @param commit_status [Hash] A single commit status previously retrieved from the GitHub API.
+    # @param repository [String] The full repository name, including the owner (i.e. rails/rails)
+    # @param commit [String] The Git commit that has been pushed to GitHub and for which we'll retrieve the CI checks.
+    #
+    # @return [Check::CircleCI, Check::Unsupported] Depending if we could recognize the URL on the commit status
+    #   pointing to the CI provider.
+    def check_class_from_url(commit_status, repository, commit)
+      target_url = commit_status["target_url"]
+      return unless target_url
+
+      uri = URI(target_url)
+
+      case uri.host
+      when "circleci.com"
+        Check::CircleCI.new(repository, commit, *commit_status.values_at("context", "state", "target_url"))
+      else
+        Check::Unsupported.new(repository, commit, *commit_status.values_at("context", "state"))
+      end
+    end
+
     # @param [String] run_name The name of the CI check input or chosen by the user.
     #
     # @return [String] A error message to display.
@@ -82,16 +141,18 @@ module CIRunner
       "The CI check '#{run_name}' was successfull. There should be no failing tests to rerun."
     end
 
-    # @param [Hash] ci_checks The list of CI checks previously by the +fetch_ci_checks+ method.
-    # @param [String] run_name The name of the CI check input or chosen by the user.
+    # @param ci_checks [Array<Check::Base>] The list of CI checks previously by the +fetch_ci_checks+ method.
+    # @param run_name [String] run_name The name of the CI check input or chosen by the user.
     #
     # @return [String] A error message letting the user know why CI Runner couldn't continue.
     def no_check_message(ci_checks, run_name)
-      possible_checks = ci_checks["check_runs"].map do |check_run|
-        if check_run["conclusion"] == "success"
-          "#{::CLI::UI::Glyph.lookup("v")} #{check_run["name"]}"
+      possible_checks = ci_checks.filter_map do |check_run|
+        if check_run.success?
+          "#{::CLI::UI::Glyph.lookup("v")} #{check_run.name}"
+        elsif check_run.failed?
+          "#{::CLI::UI::Glyph.lookup("x")} #{check_run.name}"
         else
-          "#{::CLI::UI::Glyph.lookup("x")} #{check_run["name"]}"
+          next
         end
       end
 

data/lib/ci_runner/version.rb

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

data/lib/ci_runner.rb

@@ -7,12 +7,23 @@ module CIRunner
   Error = Class.new(StandardError)
 
   autoload :CLI,            "ci_runner/cli"
-  autoload :GithubClient,   "ci_runner/github_client"
   autoload :GitHelper,      "ci_runner/git_helper"
   autoload :TestRunFinder,  "ci_runner/test_run_finder"
   autoload :LogDownloader,  "ci_runner/log_downloader"
   autoload :TestFailure,    "ci_runner/test_failure"
 
+  module Check
+    autoload :Github,      "ci_runner/check/github"
+    autoload :CircleCI,    "ci_runner/check/circle_ci"
+    autoload :Unsupported, "ci_runner/check/unsupported"
+  end
+
+  module Client
+    autoload :Error,       "ci_runner/client/error"
+    autoload :Github,      "ci_runner/client/github"
+    autoload :CircleCI,    "ci_runner/client/circle_ci"
+  end
+
   module Configuration
     autoload :User, "ci_runner/configuration/user"
     autoload :Project, "ci_runner/configuration/project"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ci_runner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Edouard Chin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-ui
@@ -112,11 +112,18 @@ files:
 - ci_runner.gemspec
 - exe/ci_runner
 - lib/ci_runner.rb
+- lib/ci_runner/check/base.rb
+- lib/ci_runner/check/circle_ci.rb
+- lib/ci_runner/check/github.rb
+- lib/ci_runner/check/unsupported.rb
 - lib/ci_runner/cli.rb
+- lib/ci_runner/client/base.rb
+- lib/ci_runner/client/circle_ci.rb
+- lib/ci_runner/client/error.rb
+- lib/ci_runner/client/github.rb
 - lib/ci_runner/configuration/project.rb
 - lib/ci_runner/configuration/user.rb
 - lib/ci_runner/git_helper.rb
-- lib/ci_runner/github_client.rb
 - lib/ci_runner/log_downloader.rb
 - lib/ci_runner/runners/base.rb
 - lib/ci_runner/runners/minitest_runner.rb
@@ -131,6 +138,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/Edouard-chin/ci_runner
   source_code_uri: https://github.com/Edouard-chin/ci_runner
+  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:
@@ -148,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.19
 signing_key:
 specification_version: 4
 summary: Re-run failing tests from CI on your local machine without copy/pasting.

data/lib/ci_runner/github_client.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-require "net/http"
-require "openssl"
-require "json"
-require "open-uri"
-
-module CIRunner
-  # A simple client to interact the GitHub API.
-  #
-  # @example Using the client
-  #  GithubClient.new("access_token").me
-  class GithubClient
-    Error = Class.new(StandardError)
-
-    # @return [Net::HTTP] An instance of Net:HTTP configured to make requests to the GitHub API endpoint.
-    def self.default_client
-      Net::HTTP.new("api.github.com", 443).tap do |http|
-        http.use_ssl = true
-        http.read_timeout = 3
-        http.write_timeout = 3
-        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-      end
-    end
-
-    # @param access_token [String] The access token with "repo" scope.
-    # @param client [Net::HTTP]
-    def initialize(access_token, client = self.class.default_client)
-      @access_token = access_token
-      @client = client
-    end
-
-    # Make an API request to get the authenticated user. Used to verify if the access token
-    # the user has stored in its config is valid.
-    #
-    # @return [Hash] See GitHub documentation.
-    #
-    # @see https://docs.github.com/en/rest/users/users#get-the-authenticated-user
-    def me
-      get("/user")
-    end
-
-    # Makes an API request to get the CI checks for the +commit+.
-    #
-    # @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/checks/runs#list-check-runs-for-a-git-reference
-    def check_runs(repository, commit)
-      get("/repos/#{repository}/commits/#{commit}/check-runs")
-    end
-
-    # Makes two requests to get the CI log for a check run.
-    # The first request returns a 302 containing a Location header poiting to a short lived url to download the log.
-    # The second request is to actually download the log.
-    #
-    # @param repository [String] The full repository name, including the owner (rails/rails)
-    # @param check_run_id [Integer] The GitHub ID of the check run.
-    #
-    # @return [Tempfile, IO] Depending on the size of the response. Quirk of URI.open.
-    #
-    # @see https://docs.github.com/en/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
-    def download_log(repository, check_run_id)
-      download_url = get("/repos/#{repository}/actions/jobs/#{check_run_id}/logs")
-
-      URI.open(download_url) # rubocop:disable Security/Open
-    end
-
-    private
-
-    # Perform an authenticated GET request.
-    #
-    # @param path [String] The resource to access.
-    #
-    # @return (See #request)
-    def get(path)
-      request(Net::HTTP::Get, path)
-    end
-
-    # Perform an authenticated request.
-    #
-    # @param verb_class [Net::HTTPRequest] A subclass of Net::HTTPRequest.
-    # @param path [String] The resource to access.
-    #
-    # @return [Hash, String] A decoded JSON response or a String pointing to the Location redirection.
-    def request(verb_class, path)
-      req = verb_class.new(path)
-      req["Accept"] = "application/vnd.github+json"
-      req.basic_auth("user", @access_token)
-
-      response = @client.request(req)
-
-      case response.code.to_i
-      when 200..204
-        response.content_type == "application/json" ? JSON.parse(response.body) : response.body
-      when 302
-        response["Location"]
-      else
-        raise(Error, "GitHub response: Status: #{response.code}. Body:\n\n#{response.body}")
-      end
-    end
-  end
-end