choria-colt 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a899af183eb44fcd18e470166a824da35e0ab2ed46ab25c9f001c716442edfe
-  data.tar.gz: 891b29051dacb1ca6e2fa801ae38f0800e8cdb7decc734590c3354bdb5d12dee
+  metadata.gz: fbb608f3080843c72765bb15bb6b375d1e3e02370c59b00b1d34fb9d5c02e57c
+  data.tar.gz: cc292639012cdde4ea87d35522f207e792e2727275d6c331bebfe7332948f905
 SHA512:
-  metadata.gz: 98a116297f7f1d4f4384042f43d0fc90b07e85ea4546a799391271dc2c2b2b0602a4e400754f795ee1c499c027b0861de3d713fea2dc132d1d8a88d6bab2f9ab
-  data.tar.gz: 51bd11e393b922ae49113fa6784fd24aeb31a592f093ba95b4de0e5a02973a004030233302ff401d58d01fbef411aa4c87ac98dd1a6e219c6219d61727c0181e
+  metadata.gz: e3ef3078f635f8223eb3e2fbc9d5d043cdb536f0acc34008f61c80a4efc5af760b23021bb1c023a3aeed402903c1f59e66628e78e7087b398cb42bd8bf62d97a
+  data.tar.gz: 5b05929aae9c9414c1af2daa68fe7f17d5c8da758282e0d30ec9e27e69ba919eb9e2ec4ab59469aa94d7c7244e45e2f8f3c5a6ee4a9f35eafcd7c09ba7b0a9ae

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
   TargetRubyVersion: 2.5
   Exclude:
@@ -8,8 +10,13 @@ AllCops:
 Metrics/AbcSize:
   Max: 20
 
+Metrics/ClassLength:
+  Max: 120
+  Exclude:
+    - 'lib/choria/colt/cli.rb'
+
 Metrics/MethodLength:
-  Max: 17
+  Max: 20
 
 Layout/LineLength:
   Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,17 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-04-28 09:34:37 UTC using RuboCop version 1.26.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 22
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 8

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+## [v0.4.0](https://github.com/opus-codium/choria-colt/tree/v0.4.0) (2022-04-25)
+
+[Full Changelog](https://github.com/opus-codium/choria-colt/compare/v0.3.0...v0.4.0)
+
+**Merged pull requests:**
+
+- Spec: Fix tests after duration introduction [\#20](https://github.com/opus-codium/choria-colt/pull/20) ([neomilium](https://github.com/neomilium))
+- CLI: Add `colt task status` subcommand [\#19](https://github.com/opus-codium/choria-colt/pull/19) ([neomilium](https://github.com/neomilium))
+
+## [v0.3.0](https://github.com/opus-codium/choria-colt/tree/v0.3.0) (2022-04-12)
+
+[Full Changelog](https://github.com/opus-codium/choria-colt/compare/v0.2.0...v0.3.0)
+
+**Merged pull requests:**
+
+- Improve CLI output [\#18](https://github.com/opus-codium/choria-colt/pull/18) ([neomilium](https://github.com/neomilium))
+- CLI: Add an option to choose log level [\#17](https://github.com/opus-codium/choria-colt/pull/17) ([neomilium](https://github.com/neomilium))
+- Improve stability, fix results retrieving [\#16](https://github.com/opus-codium/choria-colt/pull/16) ([neomilium](https://github.com/neomilium))
+- CLI: Add an option to set log level [\#15](https://github.com/opus-codium/choria-colt/pull/15) ([neomilium](https://github.com/neomilium))
+- Setup CI [\#14](https://github.com/opus-codium/choria-colt/pull/14) ([neomilium](https://github.com/neomilium))
+- CLI: Format error [\#13](https://github.com/opus-codium/choria-colt/pull/13) ([neomilium](https://github.com/neomilium))
+- CLI: Display default value if available for parameters [\#12](https://github.com/opus-codium/choria-colt/pull/12) ([neomilium](https://github.com/neomilium))
+- Test CLI formatter using RSpec [\#11](https://github.com/opus-codium/choria-colt/pull/11) ([neomilium](https://github.com/neomilium))
+- Colorize outputs [\#10](https://github.com/opus-codium/choria-colt/pull/10) ([neomilium](https://github.com/neomilium))
+- Fix task input option parsing and task output display [\#9](https://github.com/opus-codium/choria-colt/pull/9) ([neomilium](https://github.com/neomilium))
+- Implement continous result display [\#8](https://github.com/opus-codium/choria-colt/pull/8) ([neomilium](https://github.com/neomilium))
+- Improve robustness on errors [\#7](https://github.com/opus-codium/choria-colt/pull/7) ([neomilium](https://github.com/neomilium))
+- Minor code readability improvements [\#6](https://github.com/opus-codium/choria-colt/pull/6) ([neomilium](https://github.com/neomilium))
+- Improve logging [\#5](https://github.com/opus-codium/choria-colt/pull/5) ([neomilium](https://github.com/neomilium))
+- Force convertion to boolean if parameter is true/false [\#4](https://github.com/opus-codium/choria-colt/pull/4) ([neomilium](https://github.com/neomilium))
+- Tasks: Autofill default values [\#3](https://github.com/opus-codium/choria-colt/pull/3) ([neomilium](https://github.com/neomilium))
+- CLI: Support filter on Puppet classes [\#2](https://github.com/opus-codium/choria-colt/pull/2) ([neomilium](https://github.com/neomilium))
+- Tasks: Structure data before return results [\#1](https://github.com/opus-codium/choria-colt/pull/1) ([neomilium](https://github.com/neomilium))
+
+## [v0.2.0](https://github.com/opus-codium/choria-colt/tree/v0.2.0) (2022-03-03)
+
+[Full Changelog](https://github.com/opus-codium/choria-colt/compare/v0.1.1...v0.2.0)
+
+## [v0.1.1](https://github.com/opus-codium/choria-colt/tree/v0.1.1) (2022-03-03)
+
+[Full Changelog](https://github.com/opus-codium/choria-colt/compare/v0.1.0...v0.1.1)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -47,7 +47,14 @@ Or install it yourself as:
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+
+To release a new version:
+  1. update the version number in `version.rb`
+  1. generate CHANGELOG.md with `bundle exec rake changelog`
+  1. commit changes
+  1. run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/Rakefile

@@ -3,6 +3,17 @@
 require 'bundler/gem_tasks'
 require 'rubocop/rake_task'
 
+require 'choria/colt/version'
+
 RuboCop::RakeTask.new
 
+require 'github_changelog_generator/task'
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = 'opus-codium'
+  config.project = 'choria-colt'
+  config.since_tag = 'v0.1.0'
+  config.future_release = "v#{Choria::Colt::VERSION}"
+end
+
 task default: :rubocop

data/choria-colt.gemspec

@@ -28,15 +28,21 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activesupport'
   spec.add_dependency 'choria-mcorpc-support'
   spec.add_dependency 'deep_merge'
+  spec.add_dependency 'pastel'
   spec.add_dependency 'puppet'
   spec.add_dependency 'thor'
+  spec.add_dependency 'tty-logger'
 
+  # spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'github_changelog_generator'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
-  #spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

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

@@ -0,0 +1,123 @@
+require 'choria/colt/cli'
+require 'choria/colt/cli/thor'
+
+module Choria
+  class Colt
+    class CLI < Thor
+      class Formatter
+        module Result
+          def sender
+            self[:sender]
+          end
+
+          def exitcode
+            dig(:data, :exitcode)
+          end
+
+          def ok?
+            exitcode&.zero?
+          end
+
+          def runtime
+            dig(:data, :runtime)
+          end
+
+          # CLI
+          def output
+            if dig(:result, :_output).nil?
+              JSON.pretty_generate(self[:result]).split("\n")
+            else
+              dig(:result, :_output)
+            end
+          end
+        end
+
+        attr_reader :pastel
+
+        def initialize(colored:)
+          @pastel = Pastel.new(enabled: colored)
+          pastel.alias_color(:host, :cyan)
+        end
+
+        def process_result(result)
+          result.extend Formatter::Result
+
+          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)
+          end
+        end
+
+        def process_success(result)
+          host = format_host(result, "#{pastel.bright_green '√'} ")
+          headline = "#{pastel.on_green ' '} "
+
+          [
+            host,
+            result.output.map { |line| "#{headline}#{line}" },
+          ].flatten.join("\n")
+        end
+
+        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
+
+        def process_rpc_error(result)
+          host = "#{pastel.bright_red '⨯'} #{pastel.host(result.sender)}"
+          headline = "#{pastel.on_red ' '} "
+
+          [
+            host,
+            "#{headline}#{pastel.bright_red "RPC error (#{result[:statuscode]})"}: #{pastel.bright_white result[:statusmsg]}",
+          ].join("\n")
+        end
+
+        private
+
+        def format_duration(result)
+          result.runtime.nil? ? '' : "duration: #{pastel.bright_white format('%.2fs', result.runtime)}"
+        end
+
+        def format_host(result, headline)
+          "#{headline}#{pastel.host(result.sender).ljust(60, ' ')}#{format_duration(result)}"
+        end
+      end
+    end
+  end
+end

data/lib/choria/colt/cli.rb

@@ -1,13 +1,17 @@
 require 'choria/colt'
+require 'choria/colt/cli/formatter'
 require 'choria/colt/cli/thor'
 
 require 'json'
-require 'logger'
+require 'tty/logger'
 
 module Choria
   class Colt
     class CLI < Thor
       class Tasks < Thor
+        class_option :log_level,
+                     desc: 'Set log level for CLI',
+                     default: 'info'
         # BOLT: desc 'run <task name> [parameters] {--targets TARGETS | --query QUERY | --rerun FILTER} [options]', 'Run a Bolt task'
         desc 'run <task name> [parameters] --targets TARGETS [options]', 'Run a Bolt task'
         long_desc <<~DESC
@@ -17,26 +21,32 @@ module Choria
         DESC
         option :targets,
                aliases: ['--target', '-t'],
-               desc: 'Identifies the targets of the command.',
-               required: true
-        def run(*args)
+               desc: 'Identifies the targets of the command.'
+        option :targets_with_classes,
+               aliases: ['--targets-with-class', '-C'],
+               desc: 'Select the targets which have the specified Puppet classes.'
+        def run(*args) # rubocop:disable Metrics/AbcSize
           input = extract_task_parameters_from_args(args)
+          targets = extract_targets_from_options
 
           raise Thor::Error, 'Task name is required' if args.empty?
           raise Thor::Error, "Too many arguments: #{args}" unless args.count == 1
 
+          raise Thor::Error, 'Flag --targets or --targets-with-class is required' if options['targets'].nil? && options['targets_with_classes'].nil?
+
           task_name = args.shift
 
-          targets = options['targets'].split ','
-          targets = nil if options['targets'] == 'all'
+          logger.debug "Targets: #{targets}"
 
-          results = colt.run_bolt_task task_name, input: input, targets: targets
+          targets_with_classes = options['targets_with_classes']&.split(',')
 
-          File.write 'last_run.json', JSON.pretty_generate(results)
+          results = colt.run_bolt_task task_name, input: input, targets: targets, targets_with_classes: targets_with_classes do |result|
+            $stdout.puts formatter.process_result(result)
+          end
 
-          show_results(results)
-        rescue Choria::Orchestrator::Error => e
-          raise Thor::Error, "#{e.class}: #{e}"
+          File.write 'last_run.json', JSON.pretty_generate(results)
+        rescue Choria::Orchestrator::Error
+          # This error is already logged and displayed.
         end
 
         desc 'show [task name] [options]', 'Show available tasks and task documentation'
@@ -68,9 +78,39 @@ module Choria
           end
         end
 
-        no_commands do
+        desc 'status <task id>', 'Show task results'
+        long_desc <<~DESC
+          Show results from a previously ran task.
+
+          A task ID is required to request Choria services and retrieve results.
+        DESC
+        def status(task_id)
+          results = colt.wait_bolt_task task_id do |result|
+            $stdout.puts formatter.process_result(result)
+          end
+
+          File.write 'last_run.json', JSON.pretty_generate(results)
+        rescue Choria::Orchestrator::Error
+          # This error is already logged and displayed.
+        end
+
+        no_commands do # rubocop:disable Metrics/BlockLength
           def colt
-            @colt ||= Choria::Colt.new logger: Logger.new($stdout)
+            @colt ||= Choria::Colt.new logger: logger
+          end
+
+          def logger
+            @logger ||= TTY::Logger.new do |config|
+              config.handlers = [
+                [:console, { output: $stderr, level: options['log_level'].to_sym }],
+                [:stream, { output: File.open('colt-debug.log', 'a'), level: :debug }],
+              ]
+              config.metadata = %i[date time]
+            end
+          end
+
+          def formatter
+            @formatter ||= Formatter.new(colored: $stdout.tty?)
           end
 
           def extract_task_parameters_from_args(args)
@@ -78,16 +118,33 @@ module Choria
             args.reject! { |arg| arg =~ /^\w+=/ }
 
             parameters.map do |parameter|
-              key, value = parameter.split('=')
+              key, value = parameter.split('=', 2)
+
+              # TODO: Convert to boolean only if the expected type of parameter is boolean
+              # TODO: Support String to integer convertion
+              # TODO: Support @notation from parameter and/or whole input
+              value = true if value == 'true'
+              value = false if value == 'false'
+
               [key, value]
             end.to_h
           end
 
+          def extract_targets_from_options
+            return nil if options['targets'] == 'all'
+
+            targets = options['targets']&.split(',')
+            targets&.map do |t|
+              t = File.read(t.sub(/^@/, '')).lines.map(&:strip) if t.start_with? '@'
+              t
+            end&.flatten
+          end
+
           def show_tasks_summary(tasks)
             tasks.reject! { |_task, metadata| metadata['metadata']['private'] }
 
             puts <<~OUTPUT
-              Tasks
+              #{pastel.title 'Tasks'}
               #{tasks.map { |task, metadata| "#{task}#{' ' * (60 - task.size)}#{metadata['metadata']['description']}" }.join("\n").gsub(/^/, '  ')}
             OUTPUT
           end
@@ -95,30 +152,35 @@ module Choria
           def show_task_details(task_name, tasks)
             metadata = tasks[task_name]
             puts <<~OUTPUT
-              Task: '#{task_name}'
+              #{pastel.title "Task: #{task_name}"}
                 #{metadata['metadata']['description']}
 
-              Parameters:
-              #{JSON.pretty_generate(metadata['metadata']['parameters']).gsub(/^/, '  ')}
+              #{pastel.title 'Parameters'}
+              #{format_task_parameters(metadata['metadata']['parameters']).gsub(/^/, '  ')}
             OUTPUT
           end
 
-          def show_results(results)
-            results.each { |result| show_result(result) }
+          def format_task_parameters(parameters)
+            parameters.map do |parameter, metadata|
+              output = <<~OUTPUT
+                #{pastel.parameter(parameter)}  #{pastel.parameter_type metadata['type']}
+                  #{metadata['description']}
+              OUTPUT
+              output += "  Default: #{metadata['default']}" unless metadata['default'].nil?
+              output
+            end.join "\n"
           end
 
-          def show_result(result)
-            return show_generic_output(result) unless result.dig(:result, '_output').nil? || (result.dig(:result, 'exit_code') != 0)
-
-            $stdout.puts JSON.pretty_generate(result)
+          def pastel
+            @pastel ||= _pastel
           end
 
-          def show_generic_output(result)
-            target = result[:sender]
-
-            output = result.dig(:result, '_output')
-            $stdout.puts "'#{target}':"
-            output.split("\n").each { |line| $stdout.puts("  #{line}") }
+          def _pastel
+            pastel = Pastel.new(enabled: $stdout.tty?)
+            pastel.alias_color(:title, :cyan)
+            pastel.alias_color(:parameter, :yellow)
+            pastel.alias_color(:parameter_type, :bright_white)
+            pastel
           end
         end
       end

data/lib/choria/colt/data_structurer.rb

@@ -0,0 +1,28 @@
+module Choria
+  class Colt
+    module DataStructurer
+      def self.structure(res) # rubocop:disable Metrics/AbcSize
+        return res unless [0, 1].include? res[:statuscode]
+
+        # data.stdout seems to always be JSON, so parse it once.
+        res[:result] = JSON.parse res[:data][:stdout]
+        res[:data].delete :stdout
+
+        # 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[: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[:data].delete :stderr
+
+        # Convert '_output' (ie. stdout) lines into array
+        res[:result]['_output'] = res[:result]['_output'].split("\n") unless res[:result]['_output'].nil?
+
+        res
+      end
+    end
+  end
+end

data/lib/choria/colt/version.rb

@@ -2,6 +2,6 @@
 
 module Choria
   class Colt
-    VERSION = '0.2.0'
+    VERSION = '0.5.0'
   end
 end

data/lib/choria/colt.rb

@@ -19,11 +19,25 @@ module Choria
       @orchestrator = Choria::Orchestrator.new logger: @logger
     end
 
-    def run_bolt_task(task_name, input: {}, targets: nil)
+    def run_bolt_task(task_name, input: {}, targets: nil, targets_with_classes: nil, &block)
       logger.debug "Instantiate task '#{task_name}' and validate input"
-      task = Choria::Orchestrator::Task.new(task_name, input: input, orchestrator: orchestrator)
+      task = Choria::Orchestrator::Task.new(name: task_name, input: input, orchestrator: orchestrator)
+
+      task.on_result(&block) if block_given?
+
+      orchestrator.run(task, targets: targets, targets_with_classes: targets_with_classes)
+      task.wait
+      task.results
+    rescue Choria::Orchestrator::Error => e
+      logger.error e.message
+      raise
+    end
+
+    def wait_bolt_task(task_id, &block)
+      task = Choria::Orchestrator::Task.new(id: task_id, orchestrator: orchestrator)
+
+      task.on_result(&block) if block_given?
 
-      orchestrator.run(task, targets: targets)
       task.wait
       task.results
     rescue Choria::Orchestrator::Error => e
@@ -36,14 +50,6 @@ module Choria
         task['name']
       end
 
-      def tasks_metadata(tasks, environment)
-        tasks.map do |task|
-          logger.debug "Fetching metadata for task '#{task}' (environment: '#{environment}')"
-          metadata = orchestrator.tasks_support.task_metadata(task, environment)
-          [task, metadata]
-        end.to_h
-      end
-
       return tasks_metadata(tasks_names, environment) if cache.nil?
 
       cached_tasks = cache.load
@@ -54,5 +60,17 @@ module Choria
 
       updated_tasks
     end
+
+    private
+
+    def tasks_metadata(tasks, environment)
+      logger.info "Fetching metadata for tasks (environment: '#{environment}')"
+
+      tasks.map do |task|
+        logger.debug "Fetching metadata for task '#{task}' (environment: '#{environment}')"
+        metadata = orchestrator.tasks_support.task_metadata(task, environment)
+        [task, metadata]
+      end.to_h
+    end
   end
 end

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

@@ -0,0 +1,28 @@
+require 'choria/colt/data_structurer'
+
+module Choria
+  class Orchestrator
+    class Task
+      class ResultSet
+        attr_reader :results
+
+        def initialize(on_result:)
+          @results = []
+          @on_result = on_result
+        end
+
+        def integrate_rpc_error(rpc_error)
+          result = rpc_error[:body]
+          result[:sender] = rpc_error[:senderid]
+          integrate_result(result)
+        end
+
+        def integrate_result(result)
+          structured_result = Choria::Colt::DataStructurer.structure(result).with_indifferent_access
+          @results << structured_result
+          @on_result&.call(structured_result)
+        end
+      end
+    end
+  end
+end

data/lib/choria/orchestrator/task.rb

@@ -1,17 +1,25 @@
+require_relative 'task/result_set'
+
+require 'active_support'
+require 'active_support/core_ext/hash/indifferent_access'
+
 module Choria
   class Orchestrator
     class Task
       class Error < Orchestrator::Error; end
+      class NoNodesLeftError < Error; end
 
-      attr_reader :name, :input, :environment, :rpc_results
-      attr_accessor :rpc_responses
+      attr_reader :id, :name, :input, :environment
 
-      def initialize(name, orchestrator:, input: {}, environment: 'production')
+      def initialize(orchestrator:, id: nil, name: nil, input: {}, environment: 'production')
+        @id = id
         @name = name
-        @input = input
         @environment = environment
         @orchestrator = orchestrator
+        return if @name.nil?
 
+        @input = default_input.merge input
+        logger.debug "Task inputs: #{input}"
         validate_inputs
       end
 
@@ -23,37 +31,110 @@ module Choria
         metadata['files'].to_json
       end
 
-      def wait
-        task_ids = rpc_responses.map { |res| res[:body][:data][:task_id] }.uniq
-        raise NotImplementedError, "Multiple task IDs: #{task_ids}" unless task_ids.count == 1
+      def results
+        result_set.results
+      end
+
+      def run
+        raise Error, 'Unable to run a task by ID' if name.nil?
 
-        @rpc_results = @orchestrator.wait_results task_id: task_ids.first
+        @pending_targets = rpc_client.discover
+        _download
+        _run_no_wait
       end
 
-      def results
-        @rpc_results.map do |res|
-          raise NotImplementedError, 'What to do when res[:data][:stderr] contains something?' unless res[:data][:stderr].empty?
+      def wait
+        raise Error, 'Task ID is required!' if @id.nil?
 
-          res[:result] = JSON.parse res[:data][:stdout]
-          res[:data].delete :stderr
-          res[:data].delete :stdout
-          res
+        logger.info "Waiting task #{@id} results…"
+        @rpc_results = []
+        loop do
+          self.rpc_results = rpc_client.task_status(task_id: @id).map(&:results)
+          break if @pending_targets.empty?
         end
       end
 
+      def on_result(&block)
+        @on_result = ->(result) { block.call(result) }
+      end
+
       private
 
+      def result_set
+        @result_set ||= ResultSet.new(on_result: @on_result)
+      end
+
+      def rpc_results=(results)
+        pending_results, completed_results = results.partition { |res| res[:data][:exitcode] == -1 }
+        @pending_targets ||= pending_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)
+          @pending_targets.delete res[:sender]
+        end
+      end
+
+      def process_rpc_response(rpc_response)
+        rpc_response.extend Orchestrator::RpcResponse
+        logger.debug "  RPC Response: '#{rpc_response}'"
+        return unless rpc_response.rpc_error?
+
+        @pending_targets.delete rpc_response.sender
+        result_set.integrate_rpc_error(rpc_response)
+      end
+
+      def _download
+        logger.info "Downloading task '#{name}' on #{rpc_client.discover.size} nodes…"
+        rpc_client.download(task: name, files: files, verbose: false) do |rpc_response|
+          process_rpc_response(rpc_response)
+        end
+
+        raise NoNodesLeftError, "No nodes left to continue after 'download' action" if @pending_targets.empty?
+      end
+
+      def _run_no_wait # rubocop:disable Metrics/AbcSize
+        logger.info "Starting task '#{name}' on #{rpc_client.discover.size} nodes…"
+        task_ids = []
+        rpc_client.run_no_wait(task: name, files: files, input: input.to_json, verbose: false) do |rpc_response|
+          process_rpc_response(rpc_response)
+          task_ids << rpc_response.task_id
+        end
+        raise NoNodesLeftError, "No nodes left to continue after 'run_no_wait' action" if @pending_targets.empty?
+
+        task_ids.uniq!
+        raise NotImplementedError, "Multiple task IDs: #{task_ids}" unless task_ids.count == 1
+
+        @id = task_ids.first
+      end
+
       def _metadata
-        # puts 'Retrieving task metadata for task %s from the Puppet Server' % task if verbose
+        logger.info 'Downloading task metadata from the Puppet Server…'
         @orchestrator.tasks_support.task_metadata(@name, @environment)
       rescue RuntimeError => e
         raise Error, e.message
       end
 
+      def default_input
+        parameters_with_defaults = metadata['metadata']['parameters'].reject { |_k, v| v['default'].nil? }
+        parameters_with_defaults.transform_values do |meta|
+          meta['default']
+        end
+      end
+
       def validate_inputs
         ok, reason = @orchestrator.tasks_support.validate_task_inputs(@input, metadata)
         raise Error, reason.sub(/^\n/, '') unless ok
       end
+
+      def logger
+        @orchestrator.logger
+      end
+
+      def rpc_client
+        @orchestrator.rpc_client
+      end
     end
   end
 end

data/lib/choria/orchestrator.rb

@@ -6,6 +6,24 @@ module Choria
     class Error < StandardError; end
     class DiscoverError < Error; end
 
+    module RpcResponse
+      def sender
+        self[:senderid]
+      end
+
+      def rpc_error?
+        !rpc_success?
+      end
+
+      def rpc_success?
+        [0, 1].include? self[:body][:statuscode]
+      end
+
+      def task_id
+        self[:body][:data][:task_id]
+      end
+    end
+
     include MCollective::RPC
 
     attr_reader :logger
@@ -21,80 +39,25 @@ module Choria
       @tasks_support ||= MCollective::Util::Choria.new.tasks_support
     end
 
-    def run(task, targets: nil, verbose: false)
-      logger.debug "Running task: '#{task.name}' (targets: #{targets.nil? ? 'all' : targets})"
+    def run(task, targets: nil, targets_with_classes: nil, verbose: false) # rubocop:disable Metrics/AbcSize
       rpc_client.progress = verbose
 
+      logger.debug "Running task: '#{task.name}' (targets: #{targets.nil? ? 'all' : targets})"
       targets&.each { |target| rpc_client.identity_filter target }
 
-      raise DiscoverError, 'No request sent, no node discovered' if rpc_client.discover.size.zero?
-
-      logger.info "Attempting to download and run task '#{task.name}' on #{rpc_client.discover.size} nodes"
-
-      rpc_client.download(task: task.name, files: task.files, verbose: verbose)
-
-      # TODO: Extract error from 'rpc' (see MCollective::RPC#printrpc)
-
-      responses = []
-      rpc_client.run_no_wait(task: task.name, files: task.files, input: task.input.to_json, verbose: verbose) do |response|
-        logger.debug "  Response: '#{response}'"
-        responses << response
+      unless targets_with_classes.nil?
+        logger.debug "Filtering targets with classes: #{targets_with_classes}"
+        targets_with_classes.each { |klass| rpc_client.class_filter klass }
       end
 
-      # TODO: Include stats in logs when logger will be available (see MCollective::RPC#printrpcstats)
+      logger.info 'Discovering targets…'
+      raise DiscoverError, 'No requests sent, no nodes discovered' if rpc_client.discover.size.zero?
 
-      task.rpc_responses = responses
+      task.run
     end
 
-    def wait_results(task_id:)
-      raise 'Task ID is required!' if task_id.nil?
-
-      task_status_results = nil
-      loop do
-        task_status_results = rpc_client.task_status(task_id: task_id).map(&:results)
-        logger.debug "Task ##{task_id} status: #{task_status_results}"
-        break if task_completed? task_status_results
-      end
-
-      task_status_results
-    end
-
-    def task_completed?(results)
-      results.each do |result|
-        return false unless result[:data][:completed]
-      end
-
-      true
-    end
-
-    def validate_rpc_result(result)
-      raise Error, "The RPC agent returned an error: #{result[:statusmsg]}" unless (result[:statuscode]).zero?
-    end
-
-    private
-
     def rpc_client
-      @rpc_client ||= rpcclient('bolt_tasks', options: rpc_options)
-    end
-
-    def rpc_options
-      {
-        verbose: false,
-        disctimeout: nil,
-        timeout: 5,
-        config: '/etc/choria/client.conf',
-        collective: 'mcollective',
-        discovery_method: nil,
-        discovery_options: [],
-        filter: {
-          'fact' => [], 'cf_class' => [], 'agent' => [], 'identity' => [], 'compound' => []
-        },
-        progress_bar: false,
-        mcollective_limit_targets: false,
-        batch_size: nil,
-        batch_sleep_time: 1,
-        output_format: :json,
-      }
+      @rpc_client ||= rpcclient('bolt_tasks', options: {})
     end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: choria-colt
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Romuald Conty
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-03 00:00:00.000000000 Z
+date: 2022-05-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: choria-mcorpc-support
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  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: puppet
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-logger
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +164,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Colt eases the Bolt tasks run through Choria
 email:
 - romuald@opus-codium.fr
@@ -116,7 +200,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -125,10 +212,13 @@ files:
 - lib/choria/colt.rb
 - lib/choria/colt/cache.rb
 - lib/choria/colt/cli.rb
+- lib/choria/colt/cli/formatter.rb
 - lib/choria/colt/cli/thor.rb
+- lib/choria/colt/data_structurer.rb
 - lib/choria/colt/version.rb
 - lib/choria/orchestrator.rb
 - lib/choria/orchestrator/task.rb
+- lib/choria/orchestrator/task/result_set.rb
 - sig/choria/colt.rbs
 homepage: https://github.com/opus-codium/choria-colt
 licenses: []