hammer_cli_foreman_tasks 0.0.1

data/LICENSE

@@ -0,0 +1,5 @@
+This program and entire repository is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

data/README.md

@@ -0,0 +1,34 @@
+Hammer CLI Foreman Tasks
+========================
+
+Showing of the tasks (results and progress) in the Hammer CLI.
+
+Allows waiting for async task after the task was triggered.
+
+Usage:
+
+```ruby
+class MyAsyncCommand < HammerCLIForemanTasks::AsyncCommand
+  action "run"
+  command_name "run"
+
+  success_message "Task started with id %{id}s"
+  failure_message "Could not run the task"
+
+  apipie_options
+end
+```
+
+Also, there is `HammerCLIForemanTasks::Helper` with helper methods, if
+the `AsyncCommand` class doesn't fit for the case.
+
+The `AsyncCommand` comes with `--async` option so that the command
+doesn't wait for the task to finish.
+
+There is a `task` command with `progress` action available, showing the
+progress for action based on id.
+
+Usage:
+
+    # wait for task to finish (showing the progress)
+    hammer task progress --id 1234-5678-7654-3210

data/lib/hammer_cli_foreman_tasks/async_command.rb

@@ -0,0 +1,18 @@
+module HammerCLIForemanTasks
+  class AsyncCommand < HammerCLIForeman::WriteCommand
+    include HammerCLIForemanTasks::Helper
+
+    option '--async', :flag, 'Do not wait for the task'
+
+    def execute
+      if option_async?
+        super
+      else
+        task_progress(send_request)
+        HammerCLI::EX_OK
+      end
+    end
+
+    apipie_options
+  end
+end

data/lib/hammer_cli_foreman_tasks/helper.rb

@@ -0,0 +1,34 @@
+module HammerCLIForemanTasks
+  module Helper
+    # render the progress of the task using polling to the task API
+    def task_progress(task_or_id)
+      task_id = task_or_id.is_a?(Hash) ? task_or_id['id'] : task_or_id
+      TaskProgress.new(task_id) { |id| load_task(id) }.tap do |task_progress|
+        task_progress.render
+      end
+    end
+
+    def load_task(id)
+      options = resource_config.merge(resource_config[:credentials].to_params)
+      client = ForemanApi::Base.new(options)
+      flatten_task(client.http_call(:get, "/foreman_tasks/api/tasks/#{id}").first)
+    end
+
+    def send_request
+      flatten_task(super)
+    end
+
+    # make sure to flatten the nested data, to use it easily in
+    # success_message, such as
+    #
+    #   success_messasge "Repository is being synchronized in task %{id}s"
+    #
+    def flatten_task(task)
+      if task.key?('id')
+        return task
+      else
+        return task.values.first
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman_tasks/task.rb

@@ -0,0 +1,22 @@
+module HammerCLIForemanTasks
+  class Task < HammerCLI::AbstractCommand
+    class ProgressCommand < HammerCLIForeman::ReadCommand
+
+      include HammerCLIForemanTasks::Helper
+
+      command_name "progress"
+      desc "Show the progress of the task"
+      option '--id', "UUID", "UUID of the task", :required => true
+
+      def execute
+        task_progress(option_id)
+        HammerCLI::EX_OK
+      end
+
+    end
+
+    autoload_subcommands
+  end
+
+  HammerCLI::MainCommand.subcommand 'task', "Tasks related actions.", Task
+end

data/lib/hammer_cli_foreman_tasks/task_progress.rb

@@ -0,0 +1,69 @@
+require 'powerbar'
+module HammerCLIForemanTasks
+  class TaskProgress
+    attr_accessor :interval, :task
+
+    def initialize(task_id, &block)
+      @update_block = block
+      @task_id      = task_id
+      @interval     = 2
+    end
+
+    def render
+      update_task
+      if task_pending?
+        render_progress
+      else
+        render_result
+      end
+    end
+
+    private
+
+    def render_progress
+      progress_bar do |bar|
+        begin
+          while true
+            bar.show(:msg => "Task #{@task_id} progress", :done => @task['progress'].to_f, :total => 1)
+            if task_pending?
+              sleep interval
+              update_task
+            else
+              break
+            end
+          end
+        rescue Interrupt
+          # Inerrupting just means we stop rednering the progress bar
+        end
+      end
+    end
+
+    def render_result
+      puts "Task %{uuid}: %{result}" % { :uuid => @task_id, :result => @task['result'] }
+      unless @task['humanized']['output'].to_s.empty?
+        puts @task['humanized']['output']
+      end
+    end
+
+    def update_task
+      @task = @update_block.call(@task_id)
+    end
+
+    def task_pending?
+      !%w[paused stopped].include?(@task['state'])
+    end
+
+    def progress_bar
+      bar                                      = PowerBar.new
+      @closed = false
+      bar.settings.tty.finite.template.main    = '[${<bar>}] [${<percent>%}]'
+      bar.settings.tty.finite.template.padchar = ' '
+      bar.settings.tty.finite.template.barchar = '.'
+      bar.settings.tty.finite.output           = Proc.new { |s| $stderr.print s }
+      yield bar
+    ensure
+      bar.close
+      render_result
+    end
+  end
+end

data/lib/hammer_cli_foreman_tasks/version.rb

@@ -0,0 +1,3 @@
+module HammerCLIForemanTasks
+  VERSION = '0.0.1' unless defined? VERSION
+end

data/lib/hammer_cli_foreman_tasks.rb

@@ -0,0 +1,6 @@
+module HammerCLIForemanTasks
+  require 'hammer_cli_foreman_tasks/helper'
+  require 'hammer_cli_foreman_tasks/task_progress'
+  require 'hammer_cli_foreman_tasks/async_command'
+  require 'hammer_cli_foreman_tasks/task'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: hammer_cli_foreman_tasks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ivan Nečas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: powerbar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hammer_cli_foreman
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Contains the code for showing of the tasks (results and progress)
+  in the Hammer CLI.
+
+'
+email:
+- inecas@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hammer_cli_foreman_tasks.rb
+- lib/hammer_cli_foreman_tasks/task_progress.rb
+- lib/hammer_cli_foreman_tasks/version.rb
+- lib/hammer_cli_foreman_tasks/async_command.rb
+- lib/hammer_cli_foreman_tasks/helper.rb
+- lib/hammer_cli_foreman_tasks/task.rb
+- LICENSE
+- README.md
+homepage: https://github.com/iNecas/hammer-cli-foreman-tasks
+licenses:
+- GPL v3+
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1902630174674946817
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1902630174674946817
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Foreman CLI plugin for showing tasks information for resoruces and users
+test_files: []