ci_runner 0.1.0 → 0.3.0

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,30 @@ 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"))
+      when "buildkite.com"
+        Check::Buildkite.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 +143,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.3.0"
 end

data/lib/ci_runner/version_verifier.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module CIRunner
+  # Class used to check if a newer version of CI Runner has been released.
+  # This is used to inform the user to update its gem.
+  #
+  # The check only runs every week.
+  class VersionVerifier
+    SEVEN_DAYS = 86_400 * 7
+
+    # Check if the user is running the latest version of CI Runner.
+    #
+    # @return [Boolean]
+    def new_ci_runner_version?
+      return false unless check?
+
+      fetch_upstream_version
+      FileUtils.touch(last_checked)
+
+      upstream_version > Gem::Version.new(VERSION)
+    end
+
+    # Makes a request to GitHub to get the latest release on the Edouard-chin/ci_runner repository
+    #
+    # @return [Gem::Version] An instance of Gem::Version
+    def upstream_version
+      @upstream_version ||= begin
+        release = Client::Github.new(Configuration::User.instance.github_token).latest_release("Edouard-chin/ci_runner")
+
+        Gem::Version.new(release["tag_name"].sub(/\Av/, ""))
+      end
+    end
+    alias_method :fetch_upstream_version, :upstream_version
+
+    # Path of a file used to store when we last checked for a release.
+    #
+    # @return [Pathname]
+    def last_checked
+      Configuration::User.instance.config_directory.join("last-checked")
+    end
+
+    private
+
+    # @return [Boolean] Whether we checked for a release in the 7 days.
+    def check?
+      Time.now > (File.stat(last_checked).mtime + SEVEN_DAYS)
+    rescue Errno::ENOENT
+      true
+    end
+  end
+end

data/lib/ci_runner.rb

@@ -6,12 +6,28 @@ require_relative "ci_runner/version"
 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"
+  autoload :CLI,             "ci_runner/cli"
+  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"
+  autoload :VersionVerifier, "ci_runner/version_verifier"
+
+  module Check
+    autoload :Buildkite,          "ci_runner/check/buildkite"
+    autoload :Github,             "ci_runner/check/github"
+    autoload :CircleCI,           "ci_runner/check/circle_ci"
+    autoload :Unsupported,        "ci_runner/check/unsupported"
+    autoload :ConcurrentDownload, "ci_runner/check/concurrent_download"
+  end
+
+  module Client
+    autoload :Error,                  "ci_runner/client/error"
+    autoload :Github,                 "ci_runner/client/github"
+    autoload :CircleCI,               "ci_runner/client/circle_ci"
+    autoload :Buildkite,              "ci_runner/client/buildkite"
+    autoload :AuthenticatedBuildkite, "ci_runner/client/authenticated_buildkite"
+  end
 
   module Configuration
     autoload :User, "ci_runner/configuration/user"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ci_runner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Edouard Chin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2022-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-ui
@@ -112,11 +112,22 @@ files:
 - ci_runner.gemspec
 - exe/ci_runner
 - lib/ci_runner.rb
+- lib/ci_runner/check/base.rb
+- lib/ci_runner/check/buildkite.rb
+- lib/ci_runner/check/circle_ci.rb
+- lib/ci_runner/check/concurrent_download.rb
+- lib/ci_runner/check/github.rb
+- lib/ci_runner/check/unsupported.rb
 - lib/ci_runner/cli.rb
+- lib/ci_runner/client/authenticated_buildkite.rb
+- lib/ci_runner/client/base.rb
+- lib/ci_runner/client/buildkite.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
@@ -124,6 +135,7 @@ files:
 - lib/ci_runner/test_failure.rb
 - lib/ci_runner/test_run_finder.rb
 - lib/ci_runner/version.rb
+- lib/ci_runner/version_verifier.rb
 - lib/minitest/ci_runner_plugin.rb
 homepage: https://github.com/Edouard-chin/ci_runner
 licenses:
@@ -131,6 +143,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 +161,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