sleet 0.3.10 → 0.5.0

data/docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-slate

data/lib/sleet.rb

@@ -25,6 +25,7 @@ require 'sleet/config'
 require 'sleet/error'
 require 'sleet/fetch_command'
 require 'sleet/job_fetcher'
+require 'sleet/local_repo'
 require 'sleet/repo'
 require 'sleet/rspec_file_merger'
 require 'sleet/version'

data/lib/sleet/artifact_downloader.rb

@@ -2,20 +2,21 @@
 
 module Sleet
   class ArtifactDownloader
-    def initialize(artifacts:, file_name:)
+    def initialize(circle_ci_token:, artifacts:, file_name:)
+      @circle_ci_token = circle_ci_token
       @artifacts = artifacts
       @file_name = file_name
     end
 
     def files
       @files ||= urls.map do |url|
-        Sleet::CircleCi.get(url)
+        Sleet::CircleCi.get(url, circle_ci_token)
       end.map(&:body)
     end
 
     private
 
-    attr_reader :artifacts, :file_name
+    attr_reader :artifacts, :file_name, :circle_ci_token
 
     def urls
       rspec_artifacts.map { |x| x['url'] }

data/lib/sleet/branch.rb

@@ -2,26 +2,28 @@
 
 module Sleet
   class Branch
-    def initialize(github_user:, github_repo:, branch:)
+    def initialize(circle_ci_token:, github_user:, github_repo:, branch:)
+      @circle_ci_token = circle_ci_token
       @github_user = github_user
       @github_repo = github_repo
-      @branch = branch
+      @branch = CGI.escape(branch)
     end
 
     def builds
-      @builds ||= JSON.parse(Sleet::CircleCi.get(url).body)
+      @builds ||= JSON.parse(Sleet::CircleCi.get(url, circle_ci_token).body)
     end
 
-    def builds_with_artificats
+    def builds_with_artifacts
       builds.select { |b| b['has_artifacts'] }
     end
 
     private
 
-    attr_reader :github_user, :github_repo, :branch
+    attr_reader :github_user, :github_repo, :branch, :circle_ci_token
 
     def url
-      "https://circleci.com/api/v1.1/project/github/#{github_user}/#{github_repo}/tree/#{branch}?filter=completed"
+      "https://circleci.com/api/v1.1/project/github/#{github_user}/#{github_repo}/tree/#{branch}" \
+        '?filter=completed&limit=100'
     end
   end
 end

data/lib/sleet/build.rb

@@ -4,19 +4,20 @@ module Sleet
   class Build
     attr_reader :build_num
 
-    def initialize(github_user:, github_repo:, build_num:)
+    def initialize(circle_ci_token:, github_user:, github_repo:, build_num:)
+      @circle_ci_token = circle_ci_token
       @github_user = github_user
       @github_repo = github_repo
       @build_num = build_num
     end
 
     def artifacts
-      @artifacts ||= JSON.parse(Sleet::CircleCi.get(url).body)
+      @artifacts ||= JSON.parse(Sleet::CircleCi.get(url, circle_ci_token).body)
     end
 
     private
 
-    attr_reader :github_user, :github_repo
+    attr_reader :github_user, :github_repo, :circle_ci_token
 
     def url
       "https://circleci.com/api/v1.1/project/github/#{github_user}/#{github_repo}/#{build_num}/artifacts" # rubocop:disable Metrics/LineLength

data/lib/sleet/build_selector.rb

@@ -29,14 +29,14 @@ module Sleet
     end
 
     def chosen_build_json
-      branch.builds_with_artificats.find do |b|
+      branch.builds_with_artifacts.find do |b|
         b.fetch('workflows', nil)&.fetch('job_name', nil) == job_name
       end
     end
 
     def must_find_a_build_with_artifacts!
       !chosen_build_json.nil? ||
-        raise(Error, "No builds with artifcats found#{" for job name [#{job_name}]" if job_name}")
+        raise(Error, "No builds with artifacts found#{" for job name [#{job_name}]" if job_name}")
     end
 
     def chosen_build_must_have_input_file!

data/lib/sleet/circle_ci.rb

@@ -4,22 +4,8 @@ require 'singleton'
 
 module Sleet
   class CircleCi
-    include Singleton
-
-    def token
-      @token ||= File.read("#{Dir.home}/.circleci.token").strip
-    end
-
-    def get(url)
+    def self.get(url, token)
       Faraday.get(url, 'circle-token' => token)
     end
-
-    def reset!
-      @token = nil
-    end
-
-    def self.get(url)
-      instance.get(url)
-    end
   end
 end

data/lib/sleet/cli.rb

@@ -4,6 +4,10 @@ module Sleet
   class Cli < Thor
     default_task :fetch
 
+    def self.exit_on_failure?
+      true
+    end
+
     desc 'fetch', 'Fetch and Aggregate RSpec Persistance Files from CircleCI'
     long_desc <<~LONGDESC
       `sleet fetch` will find build(s) in CircleCI for the current branch, and
@@ -20,16 +24,27 @@ module Sleet
     option :output_file, type: :string, aliases: [:o], desc: <<~DESC
       This is the name for the output file, on your local system. It is relative to the source_dir. Will be IGNORED if workflows is provided.
     DESC
+    option :username, type: :string, aliases: [:u], desc: <<~DESC
+      This is the GitHub username that is referenced by the CircleCI build. By default, Sleet will base this on your upstream git remote.
+    DESC
+    option :project, type: :string, aliases: [:p], desc: <<~DESC
+      This is the GitHub project that is referenced by the CircleCI build. By default, Sleet will base this on your upstream git remote.
+    DESC
+    option :branch, type: :string, aliases: [:b], desc: <<~DESC
+      This is the remote branch that is referenced by the CircleCI build. Sleet will attempt to guess this by default, but if you are pushing to a forked repo, you may need to specify a different branch name (e.g. "pull/1234").
+    DESC
     option :workflows, type: :hash, aliases: [:w], desc: <<~DESC
       To use Sleet with CircleCI Workflows you need to tell Sleet which build(s) to look in, and where each output should be saved. The input is a hash, where the key is the build name and the value is the output_file for that build. Sleet supports saving the artifacts to multiple builds, meaning it can support a mono-repo setup.
     DESC
-    option :print_config, type: :boolean, default: false
+    option :print_config, type: :boolean
     def fetch
       sleet_config = Sleet::Config.new(cli_hash: options, dir: Dir.pwd)
       if options[:print_config]
         sleet_config.print!
         exit
       end
+      raise Sleet::Error, 'circle_ci_token required and not provided' unless sleet_config.circle_ci_token
+
       Sleet::FetchCommand.new(sleet_config).do!
     end
 
@@ -44,6 +59,7 @@ module Sleet
     end
 
     desc 'config', 'Print the config'
+    option :show_sensitive, type: :boolean
     def config
       Sleet::Config.new(cli_hash: options, dir: Dir.pwd).print!
     end

data/lib/sleet/config.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module Sleet
-  class Config
+  class Config # rubocop:disable Metrics/ClassLength
     OPTION_FILENAME = '.sleet.yml'
+    HIDDEN_UNLESS_IN_CLI_OPTIONS = %w[show_sensitive print_config].freeze
     ConfigOption = Struct.new(:value, :source)
 
     def initialize(dir:, cli_hash: {})
@@ -22,10 +23,26 @@ module Sleet
       options_hash[:output_file]
     end
 
+    def username
+      options_hash[:username]
+    end
+
+    def project
+      options_hash[:project]
+    end
+
+    def branch
+      options_hash[:branch]
+    end
+
     def workflows
       options_hash[:workflows]
     end
 
+    def circle_ci_token
+      options_hash[:circle_ci_token]
+    end
+
     def print!
       puts Terminal::Table.new headings: %w[Option Value Source], rows: table_rows
     end
@@ -43,15 +60,23 @@ module Sleet
     end
 
     def table_rows
-      options.map do |key, option|
+      table_options.map do |key, option|
         if key.to_sym == :workflows
           [key, Terminal::Table.new(headings: ['Job Name', 'Output File'], rows: option.value.to_a), option.source]
+        elsif key.to_sym == :circle_ci_token && !options['show_sensitive'].value
+          [key, '**REDACTED**', option.source]
         else
           [key, option.value, option.source]
         end
       end
     end
 
+    def table_options
+      options.reject do |key, _option|
+        HIDDEN_UNLESS_IN_CLI_OPTIONS.include?(key) && !cli_hash.key?(key)
+      end
+    end
+
     def cli_options
       build_option_hash('CLI', cli_hash)
     end
@@ -88,7 +113,9 @@ module Sleet
       {
         'source_dir' => File.expand_path(default_dir),
         'input_file' => '.rspec_example_statuses',
-        'output_file' => '.rspec_example_statuses'
+        'output_file' => '.rspec_example_statuses',
+        'show_sensitive' => false,
+        'print_config' => true
       }
     end
 

data/lib/sleet/fetch_command.rb

@@ -7,7 +7,6 @@ module Sleet
     end
 
     def do!
-      repo.validate!
       error_messages = []
       fetchers.map do |fetcher|
         begin
@@ -26,8 +25,7 @@ module Sleet
     def fetchers
       job_name_to_output_files.map do |job_name, output_filename|
         Sleet::JobFetcher.new(
-          source_dir: config.source_dir,
-          input_filename: config.input_file,
+          config: config,
           output_filename: output_filename,
           repo: repo,
           job_name: job_name
@@ -40,7 +38,7 @@ module Sleet
     end
 
     def repo
-      @repo ||= Sleet::Repo.from_dir(config.source_dir)
+      @repo ||= Sleet::Repo.from_config(config)
     end
   end
 end

data/lib/sleet/job_fetcher.rb

@@ -2,9 +2,10 @@
 
 module Sleet
   class JobFetcher
-    def initialize(source_dir:, input_filename:, output_filename:, job_name:, repo:)
-      @source_dir = source_dir
-      @input_filename = input_filename
+    def initialize(config:, output_filename:, job_name:, repo:)
+      @circle_ci_token = config.circle_ci_token
+      @source_dir = config.source_dir
+      @input_filename = config.input_file
       @output_filename = output_filename
       @job_name = job_name
       @repo = repo
@@ -17,7 +18,7 @@ module Sleet
 
     private
 
-    attr_reader :input_filename, :output_filename, :job_name, :source_dir, :repo
+    attr_reader :input_filename, :output_filename, :job_name, :source_dir, :repo, :circle_ci_token
 
     def validate!
       build_selector.validate!
@@ -35,14 +36,11 @@ module Sleet
     def build_persistance_artifacts
       @build_persistance_artifacts ||= Sleet::ArtifactDownloader.new(
         file_name: input_filename,
-        artifacts: build.artifacts
+        artifacts: build.artifacts,
+        circle_ci_token: circle_ci_token
       ).files
     end
 
-    def branch
-      repo.branch
-    end
-
     def build
       build_selector.build
     end

data/lib/sleet/local_repo.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Sleet
+  class LocalRepo
+    REMOTE_BRANCH_REGEX = %r{^([^\/.]+)\/(.+)}.freeze
+    CURRENT_BRANCH_REGEX = %r{^refs\/heads\/}.freeze
+    GITHUB_MATCH_REGEX = %r{github.com[:\/](.+)\/(.+)\.git}.freeze
+
+    def initialize(source_dir:)
+      @source_dir = source_dir
+    end
+
+    def username
+      validate!
+
+      github_match[1]
+    end
+
+    def project
+      validate!
+
+      github_match[2]
+    end
+
+    def branch_name
+      validate!
+
+      current_branch.upstream.name.match(REMOTE_BRANCH_REGEX)[2]
+    end
+
+    private
+
+    attr_reader :source_dir
+
+    def current_branch_name
+      @current_branch_name ||= repo.head.name.sub(CURRENT_BRANCH_REGEX, '')
+    end
+
+    def current_branch
+      @current_branch ||= repo.branches[current_branch_name]
+    end
+
+    def github_match
+      @github_match ||= GITHUB_MATCH_REGEX.match(current_branch.remote.url)
+    end
+
+    def repo
+      @repo ||= Rugged::Repository.new(source_dir)
+    end
+
+    def validate!
+      return if @validated
+
+      must_be_on_branch!
+      must_have_an_upstream_branch!
+      upstream_remote_must_be_github!
+      @validated = true
+    end
+
+    def must_be_on_branch!
+      !current_branch.nil? ||
+        raise(Error, 'Not on a branch')
+    end
+
+    def must_have_an_upstream_branch!
+      !current_branch.remote.nil? ||
+        raise(Error, "No upstream branch set for the current branch of #{repo.current_branch_name}")
+    end
+
+    def upstream_remote_must_be_github!
+      !github_match.nil? ||
+        raise(Error, 'Upstream remote is not GitHub')
+    end
+  end
+end

data/lib/sleet/repo.rb

@@ -2,81 +2,44 @@
 
 module Sleet
   class Repo
-    REMOTE_BRANCH_REGEX = %r{^([^\/.]+)\/(.+)}
-    CURRENT_BRANCH_REGEX = %r{^refs\/heads\/}
-    GITHUB_MATCH_REGEX = %r{github.com[:\/](.+)\/(.+)\.git}
-
-    def self.from_dir(dir)
-      new(repo: Rugged::Repository.new(dir))
-    end
-
-    def initialize(repo:)
-      @repo = repo
+    def self.from_config(config)
+      local_repo = Sleet::LocalRepo.new(source_dir: config.source_dir)
+
+      new(
+        circle_ci_token: config.circle_ci_token,
+        username: config.username || local_repo.username,
+        project: config.project || local_repo.project,
+        branch_name: config.branch || local_repo.branch_name
+      )
     end
 
-    def validate!
-      must_be_on_branch!
-      must_have_an_upstream_branch!
-      upstream_remote_must_be_github!
+    def initialize(circle_ci_token:, username:, project:, branch_name:)
+      @circle_ci_token = circle_ci_token
+      @github_user = username
+      @github_repo = project
+      @branch_name = branch_name
     end
 
-    def branch
-      @branch ||= Sleet::Branch.new(
+    def build_for(build_num)
+      Sleet::Build.new(
+        circle_ci_token: circle_ci_token,
         github_user: github_user,
         github_repo: github_repo,
-        branch: remote_branch
+        build_num: build_num
       )
     end
 
-    def build_for(build_num)
-      Sleet::Build.new(
+    def branch
+      @branch ||= Sleet::Branch.new(
+        circle_ci_token: circle_ci_token,
         github_user: github_user,
         github_repo: github_repo,
-        build_num: build_num
+        branch: branch_name
       )
     end
 
     private
 
-    attr_reader :repo
-
-    def remote_branch
-      current_branch.upstream.name.match(REMOTE_BRANCH_REGEX)[2]
-    end
-
-    def github_user
-      github_match[1]
-    end
-
-    def github_repo
-      github_match[2]
-    end
-
-    def current_branch_name
-      repo.head.name.sub(CURRENT_BRANCH_REGEX, '')
-    end
-
-    def current_branch
-      repo.branches[current_branch_name]
-    end
-
-    def github_match
-      @github_match ||= GITHUB_MATCH_REGEX.match(current_branch.remote.url)
-    end
-
-    def must_be_on_branch!
-      !current_branch.nil? ||
-        raise(Error, 'Not on a branch')
-    end
-
-    def must_have_an_upstream_branch!
-      !current_branch.remote.nil? ||
-        raise(Error, "No upstream branch set for the current branch of #{repo.current_branch_name}")
-    end
-
-    def upstream_remote_must_be_github!
-      !github_match.nil? ||
-        raise(Error, 'Upstream remote is not GitHub')
-    end
+    attr_reader :circle_ci_token, :github_user, :github_repo, :branch_name
   end
 end