ci_runner 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb83fde059747332cee33b4a0d313d2eaefb735ec3fe0e291141e8a18a535fa3
-  data.tar.gz: 6dd4960bce217bbebba6a22b6e1863d0baaf7190c5835c1fc63de9d0cc86e94e
+  metadata.gz: f7834106a8db1f0770e5184dcf31fbfc892a92890b52f4709ab900ccd560f1b2
+  data.tar.gz: 69c9c0533ff5a52a1f97cb1f4374e012f56004a06a584b2b60ab80e4c9897517
 SHA512:
-  metadata.gz: f1e747da3d2101445f77645cc9f4d37f1f36b53702a85b735aecac605576b0d060037b56a54fcd3269c65a4313ebc3a3b00cab05d4acfbfd0785f3138911d51e
-  data.tar.gz: 65a90464a386601f2bd6caaaa61ec6ea6188bd65688ddf9e32db0ee7006aff914bc3d3104271d5a4607f0252a1936514ee301b16bb3a708e1d32b7a12bc75c9d
+  metadata.gz: 67d81327e046862ccb85ead5688aac13d9818d8ffc1487ef92001fba07ff6c6795dee7a537566e410c3c864ed0ee8e3712668310412cae9bbab3eddaeff52114
+  data.tar.gz: ac943446f8cf3ebd2a65c5d35e021aebcfee0cca6c5e693bafe7f4ea41b673bc669a3eabe1914eed70a98c646dc12d51dba12d14a066e6b51538a9bfc37318d8

data/lib/ci_runner/check/base.rb

@@ -53,8 +53,10 @@ module CIRunner
       end
 
       # @return [Boolean]
+      #
+      # @see https://docs.github.com/en/rest/commits/statuses#get-the-combined-status-for-a-specific-reference
       def failed?
-        @status == "failure"
+        ["error", "failure"].include?(status)
       end
     end
   end

data/lib/ci_runner/check/buildkite.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require "uri"
+
+module CIRunner
+  module Check
+    # Check class used when a project is configured to run its CI using Buildkite.
+    class Buildkite < Base
+      include ConcurrentDownload
+
+      attr_reader :url # :private:
+
+      # @param args (See Base#initialize)
+      # @param url [String] The html URL pointing to the Buildkite build.
+      def initialize(*args, url)
+        super(*args)
+
+        @url = url
+      end
+
+      # Used to tell the user which CI provider we are downloading the log output from.
+      #
+      # @return [String]
+      def provider
+        "Buildkite"
+      end
+
+      # Download the CI logs for this Buildkite build.
+      #
+      # The Buildkite API scopes tokens per organizations (token generated for org A can't access
+      # resource on org B, even for public resources). This means that for opensource projects using
+      # Buildkite, users that are not members of the buildkite org normally can't use CI Runner.
+      #
+      # To bypass this problem, for builds that are public, CI Runner uses a different API.
+      # For private build, CI runner will check if the user had stored a Buildkite token in its config.
+      #
+      # @return [Tempfile]
+      def download_log
+        uri = URI(url)
+        _, org, pipeline, _, build = uri.path.split("/")
+        @client = Client::Buildkite.new
+
+        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|
+          @queue << log_url
+        end
+
+        process_queue
+      end
+
+      private
+
+      # @param url [String]
+      #
+      # @return [void]
+      def process(url)
+        @client.reset!
+        response = @client.download_log(url)
+
+        @tempfile.write(response.read)
+      end
+
+      # Retrieve a Buildkite token from the user confg.
+      #
+      # @param organization [String] The organization that owns this buildkite build.
+      # @param url [String] The FQDN pointing to the buildkite build.
+      #
+      # @return [String] The token
+      #
+      # @raise [Error] If no token for that organization exists in the config.
+      def retrieve_token_from_config(organization, url)
+        token = Configuration::User.instance.buildkite_token(organization.downcase)
+
+        token || raise(Error, <<~EOM)
+          Can't get the log output from the Buildkite build #{url} because it requires authentication.
+
+          Please store a Buildkite token scoped to the organization #{organization} and retry.
+          See {{command:ci_runner help buildkite_token}}
+        EOM
+      end
+    end
+  end
+end

data/lib/ci_runner/check/circle_ci.rb

@@ -4,7 +4,6 @@ require_relative "base"
 require "uri"
 require "open-uri"
 require "json"
-require "tempfile"
 
 module CIRunner
   module Check
@@ -54,6 +53,8 @@ module CIRunner
 
     # Check class used when a project is configured to run its CI using CircleCI.
     class CircleCI < Base
+      include ConcurrentDownload
+
       attr_reader :url # :private:
 
       # @param args (See Base#initialize)
@@ -62,8 +63,6 @@ module CIRunner
         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.
@@ -102,37 +101,10 @@ module CIRunner
         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]
@@ -144,15 +116,6 @@ module CIRunner
         @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.
       #

data/lib/ci_runner/check/concurrent_download.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "tempfile"
+
+module CIRunner
+  module Check
+    # Module used to dowload multiple logfiles in parallel.
+    #
+    # Some CI providers doesn't have an API to download a single log file for the whole
+    # build, and instead one log file is produced per step. CI Runner needs to download
+    # the logfile of all steps in the build in order to rerun all test that failed.
+    module ConcurrentDownload
+      def initialize(...)
+        @queue = Queue.new
+        @tempfile = Tempfile.new
+
+        super(...)
+      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)
+
+        @tempfile.tap(&:flush)
+      end
+
+      # Process item in the queue.
+      def process
+        raise(NotImplementedError)
+      end
+
+      # Dequeue a CircleCI Step from the queue.
+      #
+      # @return [Step, nil]
+      def dequeue
+        @queue.pop(true)
+      rescue ThreadError
+        nil
+      end
+    end
+  end
+end

data/lib/ci_runner/cli.rb

@@ -35,6 +35,7 @@ module CIRunner
     def rerun
       ::CLI::UI::StdoutRouter.enable
 
+      check_for_new_version
       runner = nil
 
       ::CLI::UI.frame("Preparing CI Runner") do
@@ -117,8 +118,56 @@ module CIRunner
       end
     end
 
+    desc "buildkite_token TOKEN ORGANIZATION", "Save a Buildkite token in your config."
+    long_desc <<~EOM
+      Save a personal access Buildkite token in the ~/.ci_runner/config.yml file.
+      Storing a Buildkite token is required to retrieve log from private Buildkite builds.
+
+      The ORGANIZATION, should be the name of the organization the token has access to.
+
+      You can get a token from Buildkite by following this link: https://buildkite.com/user/api-access-tokens/new?description=CI%20Runner&scopes[]=read_builds&scopes[]=read_build_logs
+    EOM
+    def buildkite_token(token, organization)
+      ::CLI::UI::StdoutRouter.enable
+
+      required_scopes = ["read_builds", "read_build_logs"]
+      token_scopes = Client::AuthenticatedBuildkite.new(token).access_token["scopes"]
+      missing_scopes = required_scopes - token_scopes
+
+      if missing_scopes.empty?
+        Configuration::User.instance.save_buildkite_token(token, organization)
+
+        ::CLI::UI.puts(<<~EOM)
+          {{success:Your token is valid!}}
+
+          {{info:The token has been saved in this file: #{Configuration::User.instance.config_file}}}
+        EOM
+      else
+        ::CLI::UI.puts("{{red:\nYour token is missing required scope(s): #{missing_scopes.join(",")}")
+      end
+    rescue Client::Error => e
+      ::CLI::UI.puts("{{red:\nYour token doesn't seem to be valid. The response from Buildkite was: #{e.message}}}")
+
+      exit(false)
+    end
+
     private
 
+    # Inform the user of a possible new CI Runner version.
+    #
+    # @return [void]
+    def check_for_new_version
+      version_verifier = VersionVerifier.new
+      return unless version_verifier.new_ci_runner_version?
+
+      ::CLI::UI.puts(<<~EOM)
+        {{info:A newer version of CI Runner is available (#{version_verifier.upstream_version}).}}
+        {{info:You can update CI Runner by running}} {{command:gem update ci_runner}}
+      EOM
+    rescue StandardError
+      nil
+    end
+
     # Retrieve all the GitHub CI checks for a given commit. Will be used to interactively prompt
     # the user which one to rerun.
     #

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

@@ -24,6 +24,14 @@ module CIRunner
         @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.
@@ -32,7 +40,6 @@ module CIRunner
       #
       # @return [void]
       def authentication(request)
-        raise(NotImplementedError, "Subclass responsability")
       end
 
       # Perform an authenticated GET request.

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/github.rb

@@ -22,6 +22,17 @@ module CIRunner
         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)

data/lib/ci_runner/configuration/user.rb

@@ -68,6 +68,36 @@ module CIRunner
         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/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
 

data/lib/ci_runner/test_run_finder.rb

@@ -129,6 +129,8 @@ module CIRunner
       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

data/lib/ci_runner/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CIRunner
-  VERSION = "0.2.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,22 +6,27 @@ require_relative "ci_runner/version"
 module CIRunner
   Error = Class.new(StandardError)
 
-  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 :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 :Github,      "ci_runner/check/github"
-    autoload :CircleCI,    "ci_runner/check/circle_ci"
-    autoload :Unsupported, "ci_runner/check/unsupported"
+    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 :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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ci_runner
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Edouard Chin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-22 00:00:00.000000000 Z
+date: 2022-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-ui
@@ -113,11 +113,15 @@ files:
 - 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
@@ -131,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: