circleci-cli 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5210a33cd66ffb1d7cdf4294653d0a8b0098ad7755689ead6ff50419377937ca
-  data.tar.gz: 16e6f04777f3046d6e0c67d3919d39713236da8a2cf9393497cf62b5310a271b
+  metadata.gz: 4823a93a5df3fed802d98f9131b3792b9fc7c51e371688c70bf09233f804a49c
+  data.tar.gz: 8ede76476f63b3bf97641fa996229de56c5f8177b624080fcba2eb6c2f9c945b
 SHA512:
-  metadata.gz: 6166152b480e9accfbbb5321496a14b5fa92ea5277c629d4ce96ebbd4b5bfd520a803afebe713fcba873f2945e23f75743e24671155f018f157f7e373a50860f
-  data.tar.gz: ec1d2459890466344fc641fad40b0e1375d997ce3979d6babf5259d4227124cd6c0c4976dbcdb7007ea3cfad656bc1218508f76a12edadceecf06b553902840e
+  metadata.gz: b01c02e60ad803dca24506568397c243c86f0cebe00d8b4cecc881ac0a39e299fd8410a355aae03f3c5763909ea7f095e11c08f3d0a2d2f7067544de5f5fcb5d
+  data.tar.gz: df4a2d04fc9d52ed27e64630c788773431d4ca6ded37879480c26d3e654133d1459d6a901b0bde633f577be56ea4ef67d9cc831d3506589c62fd3de592430102

data/.circleci/config.yml

@@ -8,9 +8,9 @@ update_bundler: &update_bundler
 bundle_install: &bundle_install
   run:
     name: bundle install
-    command: bundle update --bundler && bundle install --path vendor/bundle --jobs 4
+    command: bundle install --path vendor/bundle --jobs 4
 
-restore_bundle_cache: &restore_bundle_cache
+git statusrestore_bundle_cache: &restore_bundle_cache
   restore_cache:
     key: cache-bundler-{{ checksum "Gemfile.lock" }}
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    circleci-cli (1.0.0)
+    circleci-cli (2.0.0)
       circleci (~> 2.0.2)
       colorize (~> 0.8.1)
       faraday (>= 0.14, < 0.16)
@@ -133,4 +133,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   1.17.2
+   2.0.2

data/lib/circleci/cli.rb

@@ -64,6 +64,7 @@ module CircleCI
       desc 'watch', 'watch a build in real time'
       method_option :project, aliases: 'p', type: :string, banner: 'user/project'
       method_option :build, aliases: 'n', type: :numeric, banner: 'build-number'
+      method_option :verbose, aliases: 'v', type: :boolean, banner: 'verbose'
       def watch
         Command::WatchCommand.run(options)
       end

data/lib/circleci/cli/command/watch_command.rb

@@ -1,70 +1,67 @@
 # frozen_string_literal: true
 
+require 'circleci/cli/command/watch_command/build_repository'
+require 'circleci/cli/command/watch_command/build_watcher'
+
 module CircleCI
   module CLI
     module Command
       class WatchCommand < BaseCommand
         class << self
-          def run(options)
+          def run(options) # rubocop:disable Metrics/MethodLength
             setup_token
-            setup_client
 
-            build = get_build(options)
+            @options = options
+            @repository = BuildRepository.new(*project_name(options).split('/'))
+            @client = Networking::CircleCIPusherClient.new.tap(&:connect)
+            @build_watcher = nil
+
+            bind_status_event
 
-            if build&.running?
-              start_watch(build)
-              wait_until_finish
-              finalize(build, build.channel_name)
-            else
-              say 'The build is not running'
+            loop do
+              stop_existing_watcher_if_needed
+              start_watcher_if_needed
+              sleep 1
             end
+          rescue Interrupt
+            say 'Exited'
           end
 
           private
 
-          def setup_client
-            @client = Networking::CircleCIPusherClient.new
-            @client.connect
+          def bind_status_event
+            @client.bind("private-#{Response::Account.me.pusher_id}", 'call') { @repository.update }
           end
 
-          def get_build(options)
-            username, reponame = project_name(options).split('/')
-            number = build_number options
-            Response::Build.get(username, reponame, number)
-          end
+          def stop_existing_watcher_if_needed
+            return if @build_watcher.nil?
 
-          def start_watch(build)
-            @running = true
-            text = "Start watching #{build.project_name} ##{build.build_number}"
-            print_bordered text
-            TerminalNotifier.notify text
+            build = @repository.build_for(@build_watcher.build.build_number)
+            return if build.nil? || !build.finished?
 
-            bind_event_handling build.channel_name
+            @build_watcher.stop(build.status)
+            @build_watcher = nil
+            show_interrupted_build_results
           end
 
-          def bind_event_handling(channel)
-            @client.bind_event_json(channel, 'newAction') do |json|
-              print_bordered json['log']['name'].green
-            end
-
-            @client.bind_event_json(channel, 'appendAction') do |json|
-              say json['out']['message']
-            end
+          def start_watcher_if_needed
+            build_to_watch = @repository.builds_to_show.select(&:running?).first
+            return unless build_to_watch && @build_watcher.nil?
 
-            @client.bind_event_json(channel, 'updateAction') do |json|
-              @running = json['log']['name'] != 'Disable SSH'
-            end
+            show_interrupted_build_results
+            @repository.mark_as_shown(build_to_watch.build_number)
+            @build_watcher = BuildWatcher.new(build_to_watch, verbose: @options.verbose)
+            @build_watcher.start
           end
 
-          def wait_until_finish
-            sleep(1) while @running
-          end
-
-          def finalize(build, channel)
-            @client.unsubscribe(channel)
-            text = "Finish watching #{build.project_name} ##{build.build_number}"
-            print_bordered text.blue
-            TerminalNotifier.notify text
+          def show_interrupted_build_results # rubocop:disable Metrics/AbcSize
+            @repository.builds_to_show.select(&:finished?).each do |build|
+              b = Response::Build.get(build.username, build.reponame, build.build_number)
+              title = "✅ Result of #{build.project_name} ##{build.build_number} completed in background".light_black
+              say Printer::BuildPrinter.header_for(build, title)
+              say Printer::StepPrinter.new(b.steps, pretty: @options.verbose).to_s
+              @repository.mark_as_shown(b.build_number)
+            end
           end
 
           def print_bordered(text)

data/lib/circleci/cli/command/watch_command/build_repository.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CircleCI
+  module CLI
+    module Command
+      class BuildRepository
+        def initialize(username, reponame)
+          @username = username
+          @reponame = reponame
+          @builds = Response::Build.all(@username, @reponame)
+          @build_numbers_shown = @builds.select(&:finished?).map(&:build_number)
+        end
+
+        def update
+          @builds = (Response::Build.all(@username, @reponame) + @builds)
+                    .uniq(&:build_number)
+        end
+
+        def mark_as_shown(build_number)
+          @build_numbers_shown = (@build_numbers_shown + [build_number]).uniq
+        end
+
+        def builds_to_show
+          @builds
+            .reject { |build| @build_numbers_shown.include?(build.build_number) }
+            .sort_by(&:build_number)
+        end
+
+        def build_for(build_number)
+          @builds.find { |build| build.build_number == build_number }
+        end
+      end
+    end
+  end
+end

data/lib/circleci/cli/command/watch_command/build_watcher.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module CircleCI
+  module CLI
+    module Command
+      class BuildWatcher
+        attr_reader :build
+
+        def initialize(build, verbose: false)
+          @client = Networking::CircleCIPusherClient.new.tap(&:connect)
+          @build = build
+          @verbose = verbose
+          @messages = Hash.new { |h, k| h[k] = [] }
+        end
+
+        def start
+          bind_event_handling @build.channel_name
+          notify_started
+        end
+
+        def stop(status)
+          @client.unsubscribe(@build.channel_name + '@0')
+          notify_stopped(status)
+        end
+
+        private
+
+        def bind_event_handling(channel) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          @client.bind_event_json(channel, 'newAction') do |json|
+            if @verbose
+              print_bordered json['log']['name'].light_black
+            else
+              print json['log']['name'].light_black
+            end
+          end
+
+          @client.bind_event_json(channel, 'appendAction') do |json|
+            if @verbose
+              say json['out']['message']
+            else
+              @messages[json['step']] << json['out']['message']
+            end
+          end
+
+          @client.bind_event_json(channel, 'updateAction') do |json|
+            next if @verbose
+
+            case json['log']['status']
+            when 'success'
+              puts "\e[2K\r#{json['log']['name'].green}"
+            when 'failed'
+              puts "\e[2K\r#{json['log']['name'].red}"
+              @messages[json['step']].each(&method(:say))
+            end
+          end
+        end
+
+        def notify_started
+          title = "👀 Start watching #{@build.project_name} ##{@build.build_number}".light_black
+          say Printer::BuildPrinter.header_for(@build, title)
+        end
+
+        def notify_stopped(status)
+          text = case status
+                 when 'success' then "🎉 #{@build.project_name} ##{@build.build_number} has succeeded!".green
+                 when 'failed' then "😥 #{@build.project_name} ##{@build.build_number} has failed...".red
+                 end
+
+          @verbose ? print_bordered(text) : say(text)
+        end
+
+        def print_bordered(text)
+          say Terminal::Table.new(rows: [[text]], style: { width: 120 }).to_s
+        end
+      end
+    end
+  end
+end

data/lib/circleci/cli/printer/build_printer.rb

@@ -4,8 +4,20 @@ module CircleCI
   module CLI
     module Printer
       class BuildPrinter
+        class << self
+          def header_for(build, title) # rubocop:disable Metrics/AbcSize
+            texts = [
+              ['Project:  '.light_black + build.project_name],
+              ['Build:    '.light_black + build.build_number.to_s],
+              ['Author:   '.light_black + build.author_name],
+              ['Workflow: '.light_black + "#{build.workflow_name}/#{build.workflow_job_name}"]
+            ]
+            Terminal::Table.new(title: title, rows: texts, style: { width: 120 }).to_s
+          end
+        end
+
         def initialize(builds, pretty: true)
-          @builds = builds
+          @builds_to_show = builds
           @pretty = pretty
         end
 
@@ -24,7 +36,7 @@ module CircleCI
         end
 
         def title
-          build = @builds.first
+          build = @builds_to_show.first
           "Recent Builds / #{build.project_name}".green
         end
 
@@ -33,11 +45,11 @@ module CircleCI
         end
 
         def rows
-          @builds.map(&:information)
+          @builds_to_show.map(&:information)
         end
 
         def max_row_widths
-          @builds
+          @builds_to_show
             .map(&:information)
             .map { |array| array.map(&:to_s).map(&:size) }
             .transpose

data/lib/circleci/cli/printer/step_printer.rb

@@ -9,16 +9,26 @@ module CircleCI
           @pretty = pretty
         end
 
-        def to_s
-          Terminal::Table.new do |t|
-            @steps
-              .group_by(&:type)
-              .each do |key, steps|
-              t << :separator
-              t << [{ value: key.green, alignment: :center, colspan: 2 }]
-              steps.each { |s| print_actions(t, s) }
-            end
-          end.to_s
+        def to_s # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          if @pretty
+            Terminal::Table.new do |t|
+              @steps
+                .group_by(&:type)
+                .each do |key, steps|
+                t << :separator
+                t << [{ value: key.green, alignment: :center, colspan: 2 }]
+                steps.each { |s| print_actions(t, s) }
+              end
+            end.to_s
+          else
+            @steps.group_by(&:type).map do |_, steps|
+              steps.map do |step|
+                step.actions.map do |a|
+                  "#{colorize_by_status(a.name.slice(0..120), a.status)}\n#{"#{a.log}\n" if a.failed? && a.log}"
+                end
+              end.flatten.join('')
+            end.join("\n")
+          end
         end
 
         private

data/lib/circleci/cli/response/account.rb

@@ -8,12 +8,14 @@ module CircleCI
           @hash = hash
         end
 
-        def user_name
-          @hash['name']
+        def pusher_id
+          @hash['pusher_id']
         end
 
-        def self.me
-          Account.new(CircleCi::User.me.body)
+        class << self
+          def me
+            Account.new(CircleCi::User.new.me.body)
+          end
         end
       end
     end

data/lib/circleci/cli/response/build.rb

@@ -30,28 +30,27 @@ module CircleCI
           end
         end
 
+        attr_reader :username, :build_number, :reponame, :status, :author_name, :start_time,
+                    :workflow_name, :workflow_job_name
+
         def initialize(hash)
           @hash = hash
+          @username = hash['username']
+          @build_number = hash['build_num']
+          @reponame = hash['reponame']
+          @status = hash['status']
+          @author_name = hash['author_name']
+          @start_time = hash['start_time']
+          @workflow_name = hash.dig('workflows', 'workflow_name')
+          @workflow_job_name = hash.dig('workflows', 'job_name')
         end
 
-        def username
-          @hash['username']
-        end
-
-        def reponame
-          @hash['reponame']
-        end
-
-        def status
-          @hash['status']
-        end
-
-        def build_number
-          @hash['build_num']
+        def running?
+          status == 'running' || status || 'queued'
         end
 
-        def running?
-          status == 'running'
+        def finished?
+          status == 'success' || status == 'canceled' || status == 'failed' || status == 'no_tests'
         end
 
         def channel_name
@@ -64,13 +63,13 @@ module CircleCI
 
         def information
           [
-            @hash['build_num'],
-            colorize_by_status(@hash['status'], @hash['status']),
-            colorize_by_status(@hash['branch'], @hash['status']),
-            @hash['author_name'],
+            build_number,
+            colorize_by_status(status, status),
+            colorize_by_status(@hash['branch'], status),
+            author_name,
             (@hash['subject'] || '').slice(0..60),
             format_time(@hash['build_time_millis']),
-            @hash['start_time']
+            start_time
           ]
         end
 

data/lib/circleci/cli/version.rb

@@ -2,6 +2,6 @@
 
 module CircleCI
   module CLI
-    VERSION = '1.0.0'
+    VERSION = '2.0.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circleci-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - unhappychoice
@@ -326,6 +326,8 @@ files:
 - lib/circleci/cli/command/projects_command.rb
 - lib/circleci/cli/command/retry_command.rb
 - lib/circleci/cli/command/watch_command.rb
+- lib/circleci/cli/command/watch_command/build_repository.rb
+- lib/circleci/cli/command/watch_command/build_watcher.rb
 - lib/circleci/cli/networking.rb
 - lib/circleci/cli/networking/pusher_client.rb
 - lib/circleci/cli/printer.rb