choria-colt 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e86ae8b9274433cf146d571d2a7466a2c7c131e826ec5e4a8df9540d37f7994d
-  data.tar.gz: 9e4717f11b4f1f3f93c555818b9281e0118ac59a4bbf7b2573d6a85ed6e74fd9
+  metadata.gz: '09cf08b6443654efe090590c045225192ca703516fdea84794072e4b6a8e719c'
+  data.tar.gz: a163ba98c06e5ea4d49f6e89fd23d466984fa8bfe8a1e8e713c87710ae943b6d
 SHA512:
-  metadata.gz: 3754982bc70a01d44fc4115c76693f67201d5a618d2f61b229d9b3408bea3ff2c2ac187ea5c0bd55fdbf8ca391c668f09086339ab366a85f93100c0ac1bd8973
-  data.tar.gz: c1a1dd4eaf6287d28d09baa7f45ff7ab297ffff5a8bd78d519d9a814dfcab74512d6f300fe6696789d1687e1a9f04aa021f90531a98143e263fae4d3a8d53688
+  metadata.gz: 634b6d2839fe60f98e80180321cf5e6466485c4acee04438306c23c4619dd886a88217e4f4dddcd0fd4ccaa7cf0c883db10d88c8bf128f364409253e62f065c4
+  data.tar.gz: 8741a7293a4d5b80a74ac0a5900d9744d3a2b7f8fdd92978a70bed026d9b139607f3d9ed9f9f6a8229477b8e6fa83da6a60dc36d0786f627fba2ee5b5158fd56

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [v0.8.1](https://github.com/opus-codium/choria-colt/tree/v0.8.1) (2024-10-29)
+
+[Full Changelog](https://github.com/opus-codium/choria-colt/compare/v0.8.0...v0.8.1)
+
+**Merged pull requests:**
+
+- CLI: Fix `colt tasks show` when using it with long task names [\#34](https://github.com/opus-codium/choria-colt/pull/34) ([neomilium](https://github.com/neomilium))
+
+## [v0.8.0](https://github.com/opus-codium/choria-colt/tree/v0.8.0) (2022-11-25)
+
+[Full Changelog](https://github.com/opus-codium/choria-colt/compare/v0.7.0...v0.8.0)
+
+**Merged pull requests:**
+
+- CLI: Summarize task status results by default [\#33](https://github.com/opus-codium/choria-colt/pull/33) ([neomilium](https://github.com/neomilium))
+- CLI: Always display stderr if available [\#32](https://github.com/opus-codium/choria-colt/pull/32) ([neomilium](https://github.com/neomilium))
+
 ## [v0.7.0](https://github.com/opus-codium/choria-colt/tree/v0.7.0) (2022-09-26)
 
 [Full Changelog](https://github.com/opus-codium/choria-colt/compare/v0.6.0...v0.7.0)

data/choria-colt.gemspec

@@ -35,6 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'puppet'
   spec.add_dependency 'thor'
   spec.add_dependency 'tty-logger'
+  spec.add_dependency 'tty-progressbar'
 
   # spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'github_changelog_generator'

data/lib/choria/colt/cli/formatter.rb

@@ -22,6 +22,10 @@ module Choria
             dig(:data, :runtime)
           end
 
+          def statuscode
+            self[:statuscode]
+          end
+
           # CLI
           def output
             if dig(:result, :_output).nil?
@@ -30,92 +34,131 @@ module Choria
               dig(:result, :_output)
             end
           end
+
+          def stderr
+            dig(:result, :_stderr)
+          end
         end
 
-        attr_reader :pastel
+        module FormattedResult
+          attr_accessor :pastel
 
-        def initialize(colored:)
-          @pastel = Pastel.new(enabled: colored)
-          pastel.alias_color(:host, :cyan)
-        end
+          def host
+            if statuscode.zero?
+              format_host pastel.bright_green('√ ').to_s
+            else
+              format_host pastel.bright_red('⨯ ').to_s
+            end
+          end
 
-        def process_result(result)
-          result.extend Formatter::Result
+          def content
+            case statuscode
+            when 0
+              # 0 	OK
+              format_success
+            when 1
+              # 1 	OK, failed. All the data parsed ok, we have a action matching the request but the requested action could not be completed. 	RPCAborted
+              format_error
+            else
+              # 2 	Unknown action 	UnknownRPCAction
+              # 3 	Missing data 	MissingRPCData
+              # 4 	Invalid data 	InvalidRPCData
+              # 5 	Other error
+              format_rpc_error
+            end
+          end
 
-          case result[:statuscode]
-          when 0
-            # 0 	OK
-            process_success(result)
-          when 1
-            # 1 	OK, failed. All the data parsed ok, we have a action matching the request but the requested action could not be completed. 	RPCAborted
-            process_error(result) # unless result.ok?
-          else
-            # 2 	Unknown action 	UnknownRPCAction
-            # 3 	Missing data 	MissingRPCData
-            # 4 	Invalid data 	InvalidRPCData
-            # 5 	Other error
-            process_rpc_error(result)
+          def to_s
+            [
+              host,
+              content,
+            ].join("\n")
           end
-        end
 
-        def process_success(result)
-          host = format_host(result, "#{pastel.bright_green '√'} ")
-          headline = "#{pastel.on_green ' '} "
+          private
 
-          [
-            host,
-            result.output.map { |line| "#{headline}#{line}" },
-          ].flatten.join("\n")
-        end
+          def stderr_description
+            if stderr.nil? || stderr.empty?
+              []
+            else
+              [
+                nil,
+                pastel.bright_red('stderr:'),
+                stderr,
+              ]
+            end
+          end
+
+          def output_description
+            if output.nil? || output.empty?
+              []
+            else
+              [
+                nil,
+                pastel.bright_red('output:'),
+                output,
+              ]
+            end
+          end
+
+          def format_duration
+            runtime.nil? ? '' : "duration: #{pastel.bright_white format('%.2fs', runtime)}"
+          end
+
+          def format_host(headline)
+            "#{headline}#{pastel.host(sender).ljust(60, ' ')}#{format_duration}".strip
+          end
+
+          def format_success
+            headline = "#{pastel.on_green ' '} "
+            warning_headline = "#{pastel.on_yellow ' '} "
 
-        def process_error(result) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-          host = format_host(result, "#{pastel.bright_red '⨯'} ")
-          output = result.dig(:result, '_output')
-          error_details = JSON.pretty_generate(result.dig(:result, :_error, :details)).split "\n"
-          error_description = [
-            "#{pastel.bright_red result.dig(:result, :_error, :kind)}: #{pastel.bright_white result.dig(:result, :_error, :msg)}",
-            "  details: #{error_details.shift}",
-            error_details.map { |line| "  #{line}" },
-          ]
-          output_description = if output.nil? || output.empty?
-                                 []
-                               else
-                                 [
-                                   nil,
-                                   pastel.bright_red('output:'),
-                                   output,
-                                 ]
-                               end
-
-          headline = "#{pastel.on_red ' '} "
-
-          [
-            host,
             [
-              error_description,
-              output_description,
-            ].flatten.map { |line| "#{headline}#{line}" },
-          ].flatten.join("\n")
-        end
+              output.map { |line| "#{headline}#{line}" },
+              stderr_description.flatten.map { |line| "#{warning_headline}#{line}" },
+            ].flatten.join("\n")
+          end
+
+          def format_error
+            error_details = JSON.pretty_generate(dig(:result, :_error, :details)).split "\n"
+            error_description = [
+              "#{pastel.bright_red dig(:result, :_error, :kind)}: #{pastel.bright_white dig(:result, :_error, :msg)}",
+              "  details: #{error_details.shift}",
+              error_details.map { |line| "  #{line}" },
+            ]
 
-        def process_rpc_error(result)
-          host = "#{pastel.bright_red '⨯'} #{pastel.host(result.sender)}"
-          headline = "#{pastel.on_red ' '} "
+            headline = "#{pastel.on_red ' '} "
 
-          [
-            host,
-            "#{headline}#{pastel.bright_red "RPC error (#{result[:statuscode]})"}: #{pastel.bright_white result[:statusmsg]}",
-          ].join("\n")
+            [
+              [
+                error_description,
+                output_description,
+                stderr_description,
+              ].flatten.map { |line| "#{headline}#{line}" },
+            ].flatten.join("\n")
+          end
+
+          def format_rpc_error
+            headline = "#{pastel.on_red ' '} "
+
+            [
+              "#{headline}#{pastel.bright_red "RPC error (#{statuscode})"}: #{pastel.bright_white self[:statusmsg]}",
+            ].join("\n")
+          end
         end
 
-        private
+        attr_reader :pastel
 
-        def format_duration(result)
-          result.runtime.nil? ? '' : "duration: #{pastel.bright_white format('%.2fs', result.runtime)}"
+        def initialize(colored:)
+          @pastel = Pastel.new(enabled: colored)
+          pastel.alias_color(:host, :cyan)
         end
 
-        def format_host(result, headline)
-          "#{headline}#{pastel.host(result.sender).ljust(60, ' ')}#{format_duration(result)}"
+        def format(result)
+          result.extend Formatter::Result
+          result.extend Formatter::FormattedResult
+          result.pastel = pastel
+          result
         end
       end
     end

data/lib/choria/colt/cli.rb

@@ -44,7 +44,7 @@ module Choria
 
           environment = options['environment']
           results = colt.run_bolt_task task_name, input: input, targets: targets, targets_with_classes: targets_with_classes, environment: environment do |result|
-            $stdout.puts formatter.process_result(result)
+            $stdout.puts formatter.format(result)
           end
 
           File.write 'last_run.json', JSON.pretty_generate(results)
@@ -86,12 +86,23 @@ module Choria
 
           A task ID is required to request Choria services and retrieve results.
         DESC
+        option :style,
+               aliases: ['-S'],
+               desc: "Output style; can be 'continuous' or 'summary'",
+               default: 'summary'
         define_targets_and_filters_options
         def status(task_id)
+          validate_style_option
+
           targets, targets_with_classes = extract_targets_and_filters_from_options
 
-          results = colt.wait_bolt_task(task_id, targets: targets, targets_with_classes: targets_with_classes) do |result|
-            $stdout.puts formatter.process_result(result)
+          case options['style']
+          when 'continous'
+            results = colt.wait_bolt_task(task_id, targets: targets, targets_with_classes: targets_with_classes) do |result|
+              $stdout.puts formatter.format(result)
+            end
+          when 'summary'
+            show_summarized_status(task_id, targets: targets, targets_with_classes: targets_with_classes)
           end
 
           File.write 'last_run.json', JSON.pretty_generate(results)
@@ -111,6 +122,7 @@ module Choria
                 [:stream, { output: File.open('colt-debug.log', 'a'), level: :debug }],
               ]
               config.metadata = %i[date time]
+              Choria::Colt::Debugger.enabled = true
             end
           end
 
@@ -118,6 +130,11 @@ module Choria
             @formatter ||= Formatter.new(colored: $stdout.tty?)
           end
 
+          def validate_style_option
+            supported_styles = %i[summary continous]
+            raise Thor::Error, "Invalid style: '#{options['style']}' (available: #{supported_styles.map(&:to_s)})" unless supported_styles.include? options['style'].to_sym
+          end
+
           def extract_task_parameters_from_args(args)
             parameters = args.grep(/^\w+=/)
             args.reject! { |arg| arg =~ /^\w+=/ }
@@ -157,9 +174,12 @@ module Choria
           def show_tasks_summary(tasks)
             tasks.reject! { |_task, metadata| metadata['metadata']['private'] }
 
+            task_name_max_size = 0
+            tasks.each { |task, _metadata| task_name_max_size = [task_name_max_size, task.size].max }
+
             puts <<~OUTPUT
               #{pastel.title 'Tasks'}
-              #{tasks.map { |task, metadata| "#{task}#{' ' * (60 - task.size)}#{metadata['metadata']['description']}" }.join("\n").gsub(/^/, '  ')}
+              #{tasks.map { |task, metadata| "#{task}#{' ' * (task_name_max_size + 4 - task.size)}#{metadata['metadata']['description']}" }.join("\n").gsub(/^/, '  ')}
             OUTPUT
           end
 
@@ -185,6 +205,33 @@ module Choria
             end.join "\n"
           end
 
+          def summarize(results)
+            results_grouped_by_result_content = results.group_by { |result| result[:result] }
+            results_grouped_by_result_content.each do |_content, grouped_results|
+              # Display each host
+              grouped_results.each do |result|
+                $stdout.puts formatter.format(result).host
+              end
+              # Display the result content
+              content = formatter.format(grouped_results.first).content
+              content = pastel.bright_white '(no output)' if content.nil? || content.empty?
+              $stdout.puts content
+            end
+          end
+
+          def show_summarized_status(task_id, targets:, targets_with_classes:)
+            require 'tty-progressbar'
+
+            bar = TTY::ProgressBar.new('[:bar] :current/:total ET::elapsed ETA::eta :rate/s')
+            results = colt.wait_bolt_task(task_id, targets: targets, targets_with_classes: targets_with_classes) do |_result, count, total_count|
+              bar.update total: total_count
+              bar.current = count
+            end
+
+            puts "\nSummary:"
+            summarize(results)
+          end
+
           def pastel
             @pastel ||= _pastel
           end

data/lib/choria/colt/data_structurer.rb

@@ -22,11 +22,7 @@ module Choria
         # On one side, data.stderr is filled by the remote execution stderr.
         # On the other side, error description is in JSON (ie. '_error')
         # So merge data.stderr in '_error'.'details'
-        unless res.dig(:data, :stderr).nil? || res[:data][:stderr].empty?
-          raise NotImplementedError, 'What to do when res[:data][:stderr] contains something?' if res[:result]['_error'].empty?
-
-          res[:result]['_error']['details'].merge!({ 'stderr' => res[:data][:stderr].split("\n") })
-        end
+        res[:result]['_stderr'] = res[:data][:stderr].split("\n") unless res.dig(:data, :stderr).nil? || res[:data][:stderr].empty?
         res[:data].delete :stderr
 
         # Convert '_output' (ie. stdout) lines into array

data/lib/choria/colt/debugger.rb

@@ -0,0 +1,28 @@
+module Choria
+  class Colt
+    module Debugger
+      class << self
+        attr_writer :enabled
+
+        def enabled
+          @enabled ||= false
+        end
+
+        def root_directory
+          'colt-debug'
+        end
+
+        # This method is helpful to grab raw content to be used as test fixture
+        # To do so, copy the generated result set (ie. directory) in relevant fixture directory (e.g. `spec/fixtures/orchestrator/task/result_sets`)
+        def save_file(result_set:, filename:, content:)
+          directory = File.join Colt::Debugger.root_directory, result_set
+          FileUtils.mkdir_p directory
+          path = File.join directory, filename
+          File.write(path, content)
+
+          path
+        end
+      end
+    end
+  end
+end

data/lib/choria/colt/version.rb

@@ -2,6 +2,6 @@
 
 module Choria
   class Colt
-    VERSION = '0.7.0'
+    VERSION = '0.8.1'
   end
 end

data/lib/choria/orchestrator/task/result_set.rb

@@ -6,9 +6,12 @@ module Choria
       class ResultSet
         attr_reader :results
 
+        attr_accessor :pending_count
+
         def initialize(on_result:)
           @results = []
           @on_result = on_result
+          @pending_count = 0
         end
 
         def integrate_rpc_error(rpc_error)
@@ -20,7 +23,7 @@ module Choria
         def integrate_result(result)
           structured_result = Choria::Colt::DataStructurer.structure(result).with_indifferent_access
           @results << structured_result
-          @on_result&.call(structured_result)
+          @on_result&.call(structured_result, @results.count, pending_count + @results.count)
         end
       end
     end

data/lib/choria/orchestrator/task.rb

@@ -3,6 +3,8 @@ require_relative 'task/result_set'
 require 'active_support'
 require 'active_support/core_ext/hash/indifferent_access'
 
+require 'choria/colt/debugger'
+
 module Choria
   class Orchestrator
     class Task
@@ -55,7 +57,7 @@ module Choria
       end
 
       def on_result(&block)
-        @on_result = ->(result) { block.call(result) }
+        @on_result = ->(result, count, total_count) { block.call(result, count, total_count) }
       end
 
       private
@@ -64,15 +66,26 @@ module Choria
         @result_set ||= ResultSet.new(on_result: @on_result)
       end
 
+      def log_new_result(res)
+        if Colt::Debugger.enabled
+          debug_file = Colt::Debugger.save_file(result_set: @id, filename: "#{Time.now.iso8601}-#{res[:sender]}.json", content: JSON.pretty_generate(res))
+          logger.debug "New result for task ##{@id} saved in '#{debug_file}'"
+        else
+          logger.debug "New result for task ##{@id} from '#{res[:sender]}'"
+        end
+      end
+
       def rpc_results=(results)
         completed_results = results.reject { |res| res[:data][:exitcode] == -1 }
         @pending_targets ||= results.map { |res| res[:sender] }
 
         new_results = completed_results.select { |res| @pending_targets.include? res[:sender] }
         new_results.each do |res|
-          logger.debug "New result for task ##{@id}: #{res}"
-          result_set.integrate_result(res)
+          log_new_result res
+
           @pending_targets.delete res[:sender]
+          result_set.pending_count = @pending_targets.count
+          result_set.integrate_result res
         end
       end
 

data/lib/choria/orchestrator.rb

@@ -42,13 +42,13 @@ module Choria
     def run(task, targets: nil, targets_with_classes: nil, verbose: false)
       rpc_client.progress = verbose
       discover(targets: targets, targets_with_classes: targets_with_classes)
-      raise DiscoverError, 'No requests sent, no nodes discovered' if rpc_client.discover.size.zero?
+      raise DiscoverError, 'No requests sent, no nodes discovered' if rpc_client.discover.empty?
 
       task.run
     end
 
     def discover(targets: nil, targets_with_classes: nil)
-      logger.debug "Targets: #{targets.nil? ? 'all' : targets})"
+      logger.debug "Targets: #{targets.nil? ? 'all' : targets}"
       targets&.each { |target| rpc_client.identity_filter target }
 
       unless targets_with_classes.nil?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: choria-colt
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Romuald Conty
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-26 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
@@ -214,6 +228,7 @@ files:
 - lib/choria/colt/cli/formatter.rb
 - lib/choria/colt/cli/thor.rb
 - lib/choria/colt/data_structurer.rb
+- lib/choria/colt/debugger.rb
 - lib/choria/colt/version.rb
 - lib/choria/orchestrator.rb
 - lib/choria/orchestrator/task.rb
@@ -226,7 +241,7 @@ metadata:
   source_code_uri: https://github.com/opus-codium/choria-colt
   changelog_uri: https://github.com/opus-codium/choria-colt/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -241,8 +256,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
 summary: Bolt-like CLI to run Bolt tasks, through Choria
 test_files: []