choria-colt 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17cd0f4a8fd7bc14aed8bd1f702405d257c8ab18b31406eb13eb3b3b3d6623cd
-  data.tar.gz: 9ad55b6d635820f4486476ed9722e23f68f85037f0b94c0ed93d500a64e10e29
+  metadata.gz: 8d2f9c64ee41ebc49a88deff71b470baab7c4e83b921102518969fe2a35b77f1
+  data.tar.gz: 8f69562d201ff4addc3b44aa693d508ceca1a1623455d2ac57b273e59cd300f1
 SHA512:
-  metadata.gz: cac0c586629af294b520c29e4967824cd832b257405be6a95ba4e2a552f1a92cba936b22e219ed0342b8b1cfff34b3257a5c3cf5ab6607f66450d864b636ba12
-  data.tar.gz: 6d6cf405dd1973a4e7d813a58de872a8b37514e821ea90c216a42b3242240895ed1fb4adda8dd24d065fbbf926b7ae186fea610b9e54f5c2e5df3a7fa75b94ef
+  metadata.gz: 8fd9cc5e888843d6c8954fe7d2543b4496fe861354162f499831f4ebe7cc8ccd3def73604c6d44e6f83273f71eb8364fc1b01c99581c16e8b2635adbee071aea
+  data.tar.gz: 5a912066de4c960ffc85debf3cc53a678ac3312f2e75daec0d999f50af7f24215f1347b6c4984de55db9f3bb357075486310ab11db685e8f866c61a06049940f

data/.rubocop.yml

@@ -10,6 +10,10 @@ AllCops:
 Metrics/AbcSize:
   Max: 20
 
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/choria/colt/cli.rb'
+
 Metrics/MethodLength:
   Max: 20
 

data/.rubocop_todo.yml

@@ -6,11 +6,6 @@
 # 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: CountComments, CountAsOne.
-Metrics/ClassLength:
-  Max: 109
-
 # Offense count: 1
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:

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

@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
   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'

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

@@ -20,7 +20,7 @@ module Choria
 
         def process_success(result)
           output_lines = [
-            "#{pastel.host(result[:sender]).ljust(60, ' ')}duration: #{pastel.bright_white result[:data][:runtime]}",
+            "#{pastel.host(result[:sender]).ljust(60, ' ')}duration: #{pastel.bright_white format('%.2fs', result[:data][:runtime])}",
           ]
 
           output_lines += if result.dig(:result, :_output).nil?
@@ -32,8 +32,8 @@ module Choria
           output_lines.join("\n")
         end
 
-        def process_error(result) # rubocop:disable Metrics/AbcSize
-          host = "#{pastel.bright_red '⨯'} #{pastel.host(result[:sender]).ljust(60, ' ')}duration: #{pastel.bright_white result[:data][:runtime]}"
+        def process_error(result) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          host = "#{pastel.bright_red '⨯'} #{pastel.host(result[:sender]).ljust(60, ' ')}duration: #{pastel.bright_white format('%.2fs', result[:data][:runtime])}"
           output = result.dig(:result, '_output')
           error_details = JSON.pretty_generate(result.dig(:result, :_error, :details)).split "\n"
           error_description = [

data/lib/choria/colt/cli.rb

@@ -78,6 +78,22 @@ module Choria
           end
         end
 
+        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 => e
+          raise Thor::Error, "#{e.class}: #{e}"
+        end
+
         no_commands do # rubocop:disable Metrics/BlockLength
           def colt
             @colt ||= Choria::Colt.new logger: logger

data/lib/choria/colt/version.rb

@@ -2,6 +2,6 @@
 
 module Choria
   class Colt
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

data/lib/choria/colt.rb

@@ -21,7 +21,7 @@ module Choria
 
     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?
 
@@ -33,6 +33,18 @@ module Choria
       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?
+
+      task.wait
+      task.results
+    rescue Choria::Orchestrator::Error => e
+      logger.error e.message
+      raise
+    end
+
     def tasks(environment:, cache: nil)
       tasks_names = orchestrator.tasks_support.tasks(environment).map do |task|
         task['name']

data/lib/choria/orchestrator/task.rb

@@ -8,17 +8,19 @@ module Choria
     class Task
       class Error < Orchestrator::Error; end
 
-      attr_reader :name, :input, :environment, :rpc_results, :results
+      attr_reader :id, :name, :input, :environment, :rpc_results, :results
       attr_accessor :rpc_responses
 
-      def initialize(name, orchestrator:, input: {}, environment: 'production')
+      def initialize(orchestrator:, id: nil, name: nil, input: {}, environment: 'production')
+        @id = id
         @name = name
         @environment = environment
         @orchestrator = orchestrator
-        @input = default_input.merge input
-
         @results = []
 
+        return if @name.nil?
+
+        @input = default_input.merge input
         logger.debug "Task inputs: #{input}"
         validate_inputs
       end
@@ -32,16 +34,18 @@ module Choria
       end
 
       def wait # rubocop:disable Metrics/AbcSize
-        rpc_responses_ok, rpc_responses_error = rpc_responses.partition { |res| (res[:body][:statuscode]).zero? }
-        rpc_responses_error.each do |res|
-          logger.error "Task request failed on '#{res[:senderid]}':\n#{pp res}"
-        end
+        if @id.nil?
+          rpc_responses_ok, rpc_responses_error = rpc_responses.partition { |res| (res[:body][:statuscode]).zero? }
+          rpc_responses_error.each do |res|
+            logger.error "Task request failed on '#{res[:senderid]}':\n#{pp res}"
+          end
 
-        task_ids = rpc_responses_ok.map { |res| res[:body][:data][:task_id] }.uniq
+          task_ids = rpc_responses_ok.map { |res| res[:body][:data][:task_id] }.uniq
 
-        raise NotImplementedError, "Multiple task IDs: #{task_ids}" unless task_ids.count == 1
+          raise NotImplementedError, "Multiple task IDs: #{task_ids}" unless task_ids.count == 1
 
-        @id = task_ids.first
+          @id = task_ids.first
+        end
 
         wait_results
       end
@@ -76,7 +80,7 @@ module Choria
       def wait_results
         raise 'Task ID is required!' if @id.nil?
 
-        logger.info 'Waiting task results…'
+        logger.info "Waiting task #{@id} results…"
 
         @results = []
         @rpc_results = []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: choria-colt
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Romuald Conty
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-12 00:00:00.000000000 Z
+date: 2022-04-25 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: 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
@@ -189,6 +203,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile