ci_runner 0.1.0 → 0.3.0

data/lib/ci_runner/client/authenticated_buildkite.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require "stringio"
+
+module CIRunner
+  module Client
+    # Client used to retrieve private Resources on buildkite.
+    #
+    # For public resources, the API can be used but only a limited number of users will be
+    # be able to access it as it requires a token scoped for the organization (most users
+    # working on opensource project aren't member of the organization they contribute to).
+    #
+    # @see https://forum.buildkite.community/t/api-access-to-public-builds/1425/2
+    # @see Client::Buildkite
+    #
+    class AuthenticatedBuildkite < Base
+      API_ENDPOINT = "api.buildkite.com"
+
+      # Retrieve URLs to download job logs for all steps.
+      #
+      # @param org [String] The organizatio name.
+      # @param pipeline [String] The pipeline name.
+      # @param number [Integer] The build number.
+      #
+      # @return [Array<String>] An array of URLs
+      #
+      # @see https://buildkite.com/docs/apis/rest-api/builds#get-a-build
+      def job_logs(org, pipeline, number)
+        build = get("/v2/organizations/#{org}/pipelines/#{pipeline}/builds/#{number}")
+
+        build["jobs"].map do |job|
+          job["raw_log_url"]
+        end
+      end
+
+      # @param url [String] A URL pointing to a log output resource.
+      #
+      # @return [StringIO]
+      #
+      # @see https://buildkite.com/docs/apis/rest-api/jobs#get-a-jobs-log-output
+      def download_log(url)
+        StringIO.new(get(url))
+      end
+
+      # Get information about an access token. Used to check if the token has the correct scopes.
+      #
+      # @see https://buildkite.com/docs/apis/rest-api/access-token
+      #
+      # @return [Hash] See Buildkite doc
+      def access_token
+        get("/v2/access-token")
+      end
+
+      private
+
+      # Add authentication before making the request.
+      #
+      # @param request [Net::HTTPRequest] A subclass of Net::HTTPRequest.
+      #
+      # @return [void]
+      def authentication(request)
+        request["Authorization"] = "Bearer #{@access_token}"
+      end
+    end
+  end
+end

data/lib/ci_runner/client/base.rb

@@ -0,0 +1,78 @@
+# 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
+
+      # Set a new Client object.
+      # NET::HTTP is not threadsafe so each time we need to make requests concurrently we need to use a new client.
+      #
+      # @return [void]
+      def reset!
+        @client = self.class.default_client
+      end
+
+      private
+
+      # Add authentication before making the request.
+      #
+      # @param request [Net::HTTPRequest] A subclass of Net::HTTPRequest.
+      #
+      # @return [void]
+      def authentication(request)
+      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/buildkite.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require "open-uri"
+
+module CIRunner
+  module Client
+    # Client used for public Buildkite resources.
+    # Allow any users to download log output for builds that are in organizations they
+    # are not a member of.
+    #
+    # This client doesn't use the official buildkite API. The data returned are not exactly the same.
+    class Buildkite < Base
+      API_ENDPOINT = "buildkite.com"
+
+      # Check if the build is public and can be accessed without authentication.
+      #
+      # @param org [String] The organizatio name.
+      # @param pipeline [String] The pipeline name.
+      # @param number [Integer] The build number.
+      #
+      # @return [Boolean]
+      def public_build?(org, pipeline, build_number)
+        job_logs(org, pipeline, build_number)
+
+        true
+      rescue Error => e
+        return false if e.error_code == 403
+
+        raise(e)
+      end
+
+      # Retrieve URL paths to download job logs for all steps.
+      #
+      # @param org [String] The organizatio name.
+      # @param pipeline [String] The pipeline name.
+      # @param number [Integer] The build number.
+      #
+      # @return [Array<String>] An array of URL paths
+      def job_logs(org, pipeline, build_number)
+        @build ||= get("/#{org}/#{pipeline}/builds/#{build_number}")
+
+        @build["jobs"].map do |job|
+          job["base_path"] + "/raw_log"
+        end
+      end
+
+      # Download raw log output for a job.
+      #
+      # @param path [String] A URL path
+      #
+      # @return [Tempfile, IO] Depending on the size of the response. Quirk of URI.open.
+      def download_log(path)
+        redirection_url = get(path)
+
+        URI.open(redirection_url)
+      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,88 @@
+# 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
+
+      # Get the latest release of a repository.
+      #
+      # @param repository [String] The full repository name, including the owner (rails/rails)
+      #
+      # @return [Hash] See GitHub documentation.
+      #
+      # https://docs.github.com/en/rest/releases/releases#get-the-latest-release
+      def latest_release(repository)
+        get("/repos/#{repository}/releases/latest")
+      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,47 @@ 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
+
+      # Retrieve the stored Buildkite access token of the user that has access to the +organization+.
+      #
+      # @return [String, nil] Depending if the user ran the `ci_runner buildkite TOKEN ORGANIZATION` command.
+      def buildkite_token(organization)
+        @yaml_config.dig("buildkite", "tokens", organization.downcase)
+      end
+
+      # Write the Buildkite token to the user configuration file.
+      #
+      # @param token [String] A valid Buildkite access token.
+      # @param organization [String] The name of the organization the token has access to.
+      #
+      # @return [void]
+      def save_buildkite_token(token, organization)
+        existing_tokens = @yaml_config.dig("buildkite", "tokens") || {}
+        existing_tokens[organization.downcase] = token
+
+        @yaml_config["buildkite"] = { "tokens" => existing_tokens }
+
+        save!(@yaml_config)
+      end
+
+      # @return [Pathname] The path of the CI Runner directory configuration.
+      #
+      # @example
+      #   puts config_directory # ~/.ci_runner
+      def config_directory
+        config_file.dirname
+      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_failure.rb

@@ -56,6 +56,9 @@ module CIRunner
 
       regex = %r{.*/?(test/.*?)\Z}
       unless path.to_s.match?(regex)
+        # TODO(on: '2022-09-17', to: "edouard-chin") Revisit this as it's too brittle.
+        #   If a test file doesn't live the in the `test/` root folder, this will raise an error.
+        #   I should instead warn the user and move on.
         raise "Can't create a relative path."
       end