hammer_cli_foreman_remote_execution 0.0.4 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bdb90815b99416e087efed5bf5901d8207aee6c9
-  data.tar.gz: 28ac9b4a9e859af2fac1354ab87dcebf54d40601
+SHA256:
+  metadata.gz: 82a8e161e362047b1b57912566bba871c744abf23f65b23f5425865138f281a2
+  data.tar.gz: 3a26ec61f5fda760497bbc0bb8d9744ffa1d99bb5717f3d15a82b9750e37d949
 SHA512:
-  metadata.gz: 21ecf180e141ffbb370d15cbb1fb798fd25c3c5fb1a18a138f18da2b85e3339299cc55cf8da8faa79a42b66c9f3ff1009ffd7957b2831a603ca4287344f47874
-  data.tar.gz: dac550144f0ecc605bf5d418274bbb5970d04803d185c08428fca862c9e562f1c7c46437392ad71b55a40fffb447bb62e11485b9996cd0f5a0cabdb5df813484
+  metadata.gz: f3ee7406b730f5036b5b283e35d2353f7341a007b28e10da883f5dc2fe9ab9ad801ac162765e6646b664a8cf61bd7da355eae1d10e76ca940909f9ab87a3c8ac
+  data.tar.gz: 12bad04f757471161f6ac7e4e8cb3b5e25c4971957af6e37e9cc4fa8d7755f9257aa5c3940586696db72afe686c49ff2dcda02af30f9df2f946178ad3f12a61d

data/.gitignore

@@ -18,3 +18,7 @@ tags
 .idea
 *.sw?
 *~
+
+# Locale files
+locale/*/*.edit.po
+locale/*/*.po.time_stamp

data/.travis.yml

@@ -1,7 +1,9 @@
 ---
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
+  - 2.4.0
+  - 2.5.0
+  - 2.6.0
 sudo: false
+before_install:
+  - gem update bundler

data/.tx/config

@@ -0,0 +1,8 @@
+[main]
+host = https://www.transifex.com
+
+[foreman.hammer_cli_foreman_tasks]
+file_filter = locale/<lang>/hammer-cli-foreman-remote-execution.edit.po
+source_file = locale/hammer-cli-foreman-remote-exectution.pot
+source_lang = en
+type = PO

data/Gemfile

@@ -3,11 +3,14 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'gettext', '>= 3.1.3', '< 4.0.0'
+if RUBY_VERSION < '2.1.0'
+  gem 'fast_gettext', '< 1.2.0'
+end
 
 group :test do
   gem 'rake', '~> 10.1.0'
   gem 'thor'
-  gem 'minitest', '< 5.0.0'
+  gem 'minitest', '< 4.7.4'
   gem 'minitest-spec-context'
   gem 'simplecov'
   gem 'mocha'
@@ -15,5 +18,7 @@ group :test do
 end
 
 # load local gemfile
-local_gemfile = File.join(File.dirname(__FILE__), 'Gemfile.local')
-self.instance_eval(Bundler.read_file(local_gemfile)) if File.exist?(local_gemfile)
+['Gemfile.local.rb', 'Gemfile.local'].map do |file_name|
+  local_gemfile = File.join(File.dirname(__FILE__), file_name)
+  self.instance_eval(Bundler.read_file(local_gemfile)) if File.exist?(local_gemfile)
+end

data/README.md

@@ -8,41 +8,60 @@ CLI Plugin for Foreman Remote Execution
 
 This [Hammer CLI](https://github.com/theforeman/hammer-cli) plugin contains commands for [foreman_remote_execution](https://github.com/theforeman/foreman_remote_execution).
 
-Examples
---------
+# Examples
 
-### Create a Template
+## Templates
+
+### List templates
+
+```
+hammer job-template list
+```
+
+### Create a template
 
 ```
 hammer job-template create --file /tmp/template.txt --name "Ping a Host"\
-  --provider-type Ssh --job-name "Ping"
+  --provider-type SSH --job-category "Commands"
 ```
 
-### Create a Template Input
+### Create a template input
 
 ```
 hammer template-input create --template-id 17 --name hostname\
   --input-type user --options www.google.com,www.facebook.com,localhost
 ```
 
-### Run a Job Examples
+## Jobs
+
+### Show jobs
 
-#### Command line inputs
+```
+hammer job-invocation list
+```
+
+Show details:
 
 ```
-hammer job-invocation create --job-name "Run Command" --inputs command="ping -c 50 www.google.com"\
-  --search-query "name ~ rex01"
+hammer job-invocation info --id 83
 ```
 
+### Run a job with command line inputs
+
+```
+hammer job-invocation create --job-template "Run Command - SSH Default" \
+  --inputs command="ping -c 50 www.google.com" --search-query "name ~ rex01"
 ```
-hammer job-invocation create --job-name "Package Action"\
+
+```
+hammer job-invocation create --job-template "Package Action - SSH Default" \
   --inputs package=vim-enhanced,action=install --search-query "name ~ rex01"
 ```
 
-#### File inputs:
+### Run a job with file inputs
 
 ```
-hammer job-invocation create --job-name "Run Command"\
+hammer job-invocation create --job-template "Run Command - SSH Default"\
   --input-files command=/tmp/script.sh --search-query "name ~ rex01"
 ```
 
@@ -60,7 +79,27 @@ Alternatively, pass the `--async` option to see the output so far:
 hammer job-invocation output --id 155 --host rex01.example.com --async
 ```
 
-License
--------
+## Developer Information
+
+### Updating API docs
+
+In `test/data/[foreman_version]/foreman_api.json`, we include the Apipie
+documentation, with generated examples from the tests.
+
+When adding new features to the hammer, you'll need to update this.
+
+1. From foreman directory, run remote execution tests with examples enabled:
+
+        APIPIE_RECORD=examples rake test:foreman_remote_execution
+
+2. From foreman directory, generate the apipie cache for English:
+
+        FOREMAN_APIPIE_LANGS=en rake apipie:cache
+
+3. Copy the docs to hammer_cli_foreman_remote_execution
+
+        cp public/apipie-cache/apidoc/v2.en.json ~/hammer_cli_foreman_remote_execution/test/data/1.10/foreman_api.json
+
+## License
 
 This project is licensed under the GPLv3+.

data/Rakefile

@@ -9,17 +9,28 @@ Rake::TestTask.new :test do |t|
 end
 
 namespace :gettext do
-  desc 'Update pot file'
-  task :find do
-    require 'hammer_cli_foreman_remote_execution/version'
-    require 'hammer_cli_foreman_remote_execution/i18n'
-    require 'gettext/tools'
+
+  task :setup do
+    require "hammer_cli_foreman_remote_execution/version"
+    require "hammer_cli_foreman_remote_execution/i18n"
+    require 'gettext/tools/task'
 
     domain = HammerCLIForemanRemoteExecution::I18n::LocaleDomain.new
-    GetText.update_pofiles(domain.domain_name, domain.translated_files,
-                           "#{domain.domain_name} #{HammerCLIForemanRemoteExecution.version}",
-                           :po_root => domain.locale_dir)
+    GetText::Tools::Task.define do |task|
+      task.package_name = domain.domain_name
+      task.package_version = HammerCLIForemanRemoteExecution.version.to_s
+      task.domain = domain.domain_name
+      task.mo_base_directory = domain.locale_dir
+      task.po_base_directory = domain.locale_dir
+      task.files = domain.translated_files
+    end
+  end
+
+  desc "Update pot file"
+  task :find => [:setup] do
+    Rake::Task["gettext:po:update"].invoke
   end
+
 end
 
 namespace :pkg do

data/hammer_cli_foreman_remote_execution.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.platform      = Gem::Platform::RUBY
   s.authors       = ['Foreman Remote Execution team']
   s.email         = ['foreman-dev@googlegroups.com']
-  s.homepage      = 'http://github.com/theforeman/hammer_cli_foreman_remote_execution'
-  s.license       = 'GPL v3+'
+  s.homepage      = 'https://github.com/theforeman/hammer_cli_foreman_remote_execution'
+  s.license       = 'GPL-3.0-or-later'
 
   s.summary       = 'CLI for the Foreman remote execution plugin'
   s.description   = 'CLI for the Foreman remote execution plugin'
@@ -16,6 +16,6 @@ Gem::Specification.new do |s|
   s.test_files =       `git ls-files test`.split("\n")
   s.extra_rdoc_files = `git ls-files doc`.split("\n") + Dir['README*', 'LICENSE']
 
-  s.add_dependency 'hammer_cli_foreman', '>= 0.1.3', '< 1.0.0'
+  s.add_dependency 'hammer_cli_foreman', '>= 0.1.3', '< 3.0.0'
   s.add_dependency 'hammer_cli_foreman_tasks', '~> 0.0.3'
 end

data/lib/hammer_cli_foreman_remote_execution.rb

@@ -8,6 +8,7 @@ module HammerCLIForemanRemoteExecution
   require 'hammer_cli_foreman_remote_execution/job_template'
   require 'hammer_cli_foreman_remote_execution/template_input'
   require 'hammer_cli_foreman_remote_execution/foreign_input_set'
+  require 'hammer_cli_foreman_remote_execution/remote_execution_feature'
 
   def self.exception_handler_class
     HammerCLIForeman::ExceptionHandler

data/lib/hammer_cli_foreman_remote_execution/foreign_input_set.rb

@@ -5,8 +5,8 @@ module HammerCLIForemanRemoteExecution
 
     class ListCommand < HammerCLIForeman::ListCommand
       output do
-        field :id, _('Id')
-        field :target_template_id, _('Target template id')
+        field :id, _('ID')
+        field :target_template_id, _('Target template ID')
         field :target_template_name, _('Target template name')
       end
 
@@ -15,9 +15,9 @@ module HammerCLIForemanRemoteExecution
 
     class InfoCommand < HammerCLIForeman::InfoCommand
       output do
-        field :id, _('Id')
+        field :id, _('ID')
         field :name, _('Name')
-        field :target_template_id, _('Target template id')
+        field :target_template_id, _('Target template ID')
         field :target_template_name, _('Target template name')
         field :include_all, _('Include all')
         field :include, _('Include')

data/lib/hammer_cli_foreman_remote_execution/i18n.rb

@@ -2,7 +2,9 @@ require 'hammer_cli/i18n'
 
 module HammerCLIForemanRemoteExecution
   module I18n
+
     class LocaleDomain < HammerCLI::I18n::LocaleDomain
+
       def translated_files
         Dir.glob(File.join(File.dirname(__FILE__), '../**/*.rb'))
       end
@@ -15,7 +17,17 @@ module HammerCLIForemanRemoteExecution
         'hammer-cli-foreman-remote-execution'
       end
     end
+
+    class SystemLocaleDomain < LocaleDomain
+
+      def locale_dir
+        '/usr/share/locale'
+      end
+
+    end
+
   end
 end
 
-HammerCLI::I18n.add_domain(HammerCLIForemanRemoteExecution::I18n::LocaleDomain.new)
+domain = [HammerCLIForemanRemoteExecution::I18n::LocaleDomain.new, HammerCLIForemanRemoteExecution::I18n::SystemLocaleDomain.new].find { |d| d.available? }
+HammerCLI::I18n.add_domain(domain) if domain

data/lib/hammer_cli_foreman_remote_execution/job_invocation.rb

@@ -2,9 +2,15 @@ module HammerCLIForemanRemoteExecution
   class JobInvocation < HammerCLIForeman::Command
     resource :job_invocations
 
+    module WithoutNameOption
+      def create_option_builder
+        HammerCLI::Apipie::OptionBuilder.new(resource, resource.action(action), :require_options => false)
+      end
+    end
+
     class ListCommand < HammerCLIForeman::ListCommand
       output do
-        field :id, _('Id')
+        field :id, _('ID')
         field :description, _('Description')
         field :status_label, _('Status')
         field :succeeded, _('Success')
@@ -12,6 +18,7 @@ module HammerCLIForemanRemoteExecution
         field :pending, _('Pending')
         field :total, _('Total')
         field :start_at, _('Start')
+        field :randomized_ordering, _('Randomized ordering')
       end
 
       def extend_data(invocation)
@@ -22,6 +29,7 @@ module HammerCLIForemanRemoteExecution
     end
 
     class InfoCommand < HammerCLIForeman::InfoCommand
+      extend WithoutNameOption
       output ListCommand.output_definition do
         field :job_category, _('Job Category')
         field :mode, _('Mode')
@@ -54,17 +62,39 @@ module HammerCLIForemanRemoteExecution
           puts line['output']
           since = line['timestamp']
         end
+        since
+      end
 
-        if output['refresh'] && !option_async?
-          sleep 1
-          print_data(resource.call(action, request_params.merge(:since => since), request_headers, request_options))
+      def execute
+        data = get_output
+        if data['delayed']
+          puts _('The job is scheduled to start at %{timestamp}') % { :timestamp => data['start_at'] }
+          return HammerCLI::EX_OK if option_async?
         end
+        since = print_data(data)
+
+        output_loop(data, since)
+        return HammerCLI::EX_OK
       end
 
       build_options do |o|
         o.expand(:all).except(:job_invocations)
         o.without(:since)
       end
+
+      private
+
+      def output_loop(data, since = nil)
+        while data['refresh'] && !option_async? do
+          sleep 1
+          data = get_output(since)
+          since = print_data(data)
+        end
+      end
+
+      def get_output(since = nil)
+        resource.call(action, request_params.merge(:since => since), request_headers, request_options)
+      end
     end
 
     class CreateCommand < HammerCLIForeman::CreateCommand
@@ -112,9 +142,11 @@ module HammerCLIForemanRemoteExecution
         super(task)
       end
 
+      alias original_option_async? option_async?
+
       def option_async?
         if immediate?
-          defined?(option_async) ? option_async : false
+          original_option_async?
         else
           true
         end
@@ -129,9 +161,35 @@ module HammerCLIForemanRemoteExecution
       end
     end
 
+    class CancelCommand < HammerCLIForeman::Command
+      extend WithoutNameOption
+
+      action :cancel
+      command_name 'cancel'
+      desc _('Cancel the job')
+      success_message _('Job invocation %{id} cancelled')
+      failure_message _('Could not cancel the job invocation')
+
+      build_options { |o| o.expand(:none) }
+    end
+
+    class RerunCommand < HammerCLIForeman::CreateCommand
+      extend WithoutNameOption
+
+      action :rerun
+      command_name 'rerun'
+      desc _('Rerun the job')
+      success_message _('Job invocation was rerun as %{id}')
+
+      build_options { |o| o.expand(:none) }
+    end
+
     def self.extend_data(invocation)
-      if invocation['targeting'] && invocation['targeting']['hosts']
-        invocation['hosts'] = "\n" + invocation['targeting']['hosts'].map { |host| " - #{host['name']}" }.join("\n")
+      if (targeting = invocation['targeting']) && invocation['targeting']['hosts']
+        invocation['randomized_ordering'] = targeting['randomized_ordering']
+        if (hosts = targeting['hosts'])
+          invocation['hosts'] = "\n" + hosts.map { |host| " - #{host['name']}" }.join("\n")
+        end
       end
 
       if invocation['recurrence']

data/lib/hammer_cli_foreman_remote_execution/job_template.rb

@@ -4,7 +4,7 @@ module HammerCLIForemanRemoteExecution
 
     class ListCommand < HammerCLIForeman::ListCommand
       output do
-        field :id, _('Id')
+        field :id, _('ID')
         field :name, _('Name')
         field :job_category, _('Job Category')
         field :provider_type, _('Provider')
@@ -20,6 +20,7 @@ module HammerCLIForemanRemoteExecution
 
     class InfoCommand < HammerCLIForeman::InfoCommand
       output ListCommand.output_definition do
+        field :description, _('Description'), Fields::Text
         field :template_inputs, _('Inputs')
         HammerCLIForeman::References.taxonomies(self)
       end
@@ -55,6 +56,35 @@ module HammerCLIForemanRemoteExecution
       end
     end
 
+    class ImportCommand < HammerCLIForeman::CreateCommand
+      command_name 'import'
+      action :import
+
+      option '--file', 'TEMPLATE', N_('Path to a file that contains the template - must include ERB metadata'),
+             :attribute_name => :option_template, :required => true,
+             :format => HammerCLI::Options::Normalizers::File.new
+
+      success_message _('Job template imported')
+      failure_message _('Could not import the job template')
+
+      build_options do |o|
+        o.without(:template)
+      end
+    end
+
+    class ExportCommand < HammerCLIForeman::InfoCommand
+      command_name 'export'
+      action :export
+
+      desc _('Export a template including all metadata')
+
+      def print_data(template)
+        puts template
+      end
+
+      build_options
+    end
+
     class UpdateCommand < HammerCLIForeman::UpdateCommand
       option '--file', 'TEMPLATE', N_('Path to a file that contains the template'),
              :attribute_name => :option_template,