hammer_cli_foreman_remote_execution 0.0.6 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f879c32ae742ceb90ab61bbc02322b2a44416df7
-  data.tar.gz: a66b9ac45d9714ebc8350d7ec51074d6f2eb860f
+SHA256:
+  metadata.gz: a8cd0e41c73966cfa7089868144153770421ab767e7c85e7e4a1ea904c95bd67
+  data.tar.gz: 6e9c15d1174bbf9037c6548c814c88bd56dbef7eb338f0729302e233b9cc9572
 SHA512:
-  metadata.gz: 81171fd1db3da7eec1d8e25ebcf59df15dca78981a74f09decb181b8fdd500f844a07a84f8cfe2ec0b1ab7612643dadedabaebb9ec9dfd81224ae5bb007f8052
-  data.tar.gz: c9153fc2750b9f9653e9655370f2547dc8880fb5c5746be9914ab9764091f3edd6f7f4172b302c9007ba384595827fa5605d7975ef71d21090ba41d518370b31
+  metadata.gz: f4bf60dc1d75ff17914e15257faafaefbb6aceb6b0d3e5d550bee2f915747553fc769d9deab994d38c31cb4639131efc2164a6a09686b9128459389a4d832dde
+  data.tar.gz: 523f21e8d58871c5dbf43b73841117e570332fbe665d7eec45d261076637692dc5bbbeb06a25855c6ff5e5aca957c16f352f983c59c4af70279c9d2fd9004c38

data/.travis.yml

@@ -1,8 +1,9 @@
 ---
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
-  - 2.3.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-remote-execution]
+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/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

@@ -9,6 +9,8 @@ module HammerCLIForemanRemoteExecution
   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'
+  require 'hammer_cli_foreman_remote_execution/interface_extensions'
+  require 'hammer_cli_foreman_remote_execution/subnet_extensions'
 
   def self.exception_handler_class
     HammerCLIForeman::ExceptionHandler

data/lib/hammer_cli_foreman_remote_execution/interface_extensions.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'hammer_cli_foreman/interface'
+
+module HammerCLIForemanRemoteExecution
+  class InterfaceExtensionsInfo < ::HammerCLI::CommandExtensions
+    output do |definition|
+      definition.append do
+        field :execution, _('Execution'), Fields::Boolean
+      end
+    end
+  end
+
+  module InterfaceExtensionsList
+    def format_type(nic)
+      type = super(nic)
+      if nic['execution']
+        if nic['primary'] || nic['provision']
+          type[-1] = ', '+_('execution') +')'
+        else
+          type += ' ('+_('execution') +')'
+        end
+      end
+      type
+    end
+  end
+
+  ::HammerCLIForeman::Interface.singleton_class.prepend InterfaceExtensionsList
+  ::HammerCLIForeman::Interface::InfoCommand.extend_with(InterfaceExtensionsInfo.new)
+end

data/lib/hammer_cli_foreman_remote_execution/job_invocation.rb

@@ -2,17 +2,31 @@ module HammerCLIForemanRemoteExecution
   class JobInvocation < HammerCLIForeman::Command
     resource :job_invocations
 
-    class ListCommand < HammerCLIForeman::ListCommand
-      output do
-        field :id, _('ID')
-        field :description, _('Description')
-        field :status_label, _('Status')
-        field :succeeded, _('Success')
-        field :failed, _('Failed')
-        field :pending, _('Pending')
-        field :total, _('Total')
-        field :start_at, _('Start')
+    module WithoutNameOption
+      def create_option_builder
+        HammerCLI::Apipie::OptionBuilder.new(resource, resource.action(action), :require_options => false)
       end
+    end
+
+    module BaseOutput
+      def self.included(base)
+        base.output do
+          field :id, _('ID')
+          field :description, _('Description')
+          field :status_label, _('Status')
+          field :succeeded, _('Success')
+          field :failed, _('Failed')
+          field :pending, _('Pending')
+          field :total, _('Total')
+          field :start_at, _('Start')
+          field :randomized_ordering, _('Randomized ordering')
+          field :inputs, _('Inputs'), nil, :hide_blank => true
+        end
+      end
+    end
+
+    class ListCommand < HammerCLIForeman::ListCommand
+      include BaseOutput
 
       def extend_data(invocation)
         JobInvocation.extend_data(invocation)
@@ -22,24 +36,57 @@ module HammerCLIForemanRemoteExecution
     end
 
     class InfoCommand < HammerCLIForeman::InfoCommand
-      output ListCommand.output_definition do
-        field :job_category, _('Job Category')
-        field :mode, _('Mode')
-        field :cron_line, _('Cron line')
-        field :recurring_logic_id, _('Recurring logic ID')
-        field :hosts, _('Hosts')
+      extend WithoutNameOption
+      include BaseOutput
+      option '--show-inputs', :flag, _('Show the complete input of the job')
+      option '--show-host-status', :flag, _('Show job status for the hosts')
+
+      extend_output_definition do |definition|
+        definition.insert(:before, :total) do
+          field :missing, _('Missing')
+        end
+        definition.append do
+          field :job_category, _('Job Category')
+          field :mode, _('Mode')
+          field :cron_line, _('Cron line')
+          field :recurring_logic_id, _('Recurring logic ID')
+          field :hosts, _('Hosts')
+        end
       end
 
-      def extend_data(invocation)
-        JobInvocation.extend_data(invocation)
+      def adapter
+        if option_id
+          :yaml
+        else
+          :base
+        end
       end
 
-      def self.create_option_builder
-        HammerCLI::Apipie::OptionBuilder.new(resource, resource.action(action), :require_options => false)
+      def extend_data(invocation)
+        if option_show_inputs?
+          invocation['template_invocations']&.each do |template|
+            input_values = template['template_invocation_input_values']
+            values_for_host = {}
+            input_values&.each do |input_value|
+              values_for_host[input_value['template_input_name']] = input_value['value']
+            end
+            hosts = invocation.dig('targeting', 'hosts')
+            host_index = hosts&.index { |h| h['id'] == template['host_id'] }
+            invocation['targeting']['hosts'][host_index][:inputs] = values_for_host if host_index
+          end
+        end
+        JobInvocation.extend_data(invocation)
       end
 
       build_options do |o|
         o.expand(:none)
+        o.without(:host_status)
+      end
+
+      def request_params
+        params = super
+        params[:host_status] = true if option_show_host_status?
+        params
       end
     end
 
@@ -58,17 +105,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
@@ -135,9 +204,37 @@ 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']
+
+        hosts = targeting['hosts'].map do |host|
+          { 'Name' => host['name'], 'Job status' => host['job_status'], 'Inputs' => host[:inputs] }.compact
+        end
+        invocation['hosts'] = hosts
       end
 
       if invocation['recurrence']

data/lib/hammer_cli_foreman_remote_execution/job_template.rb

@@ -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

data/lib/hammer_cli_foreman_remote_execution/subnet_extensions.rb

@@ -0,0 +1,16 @@
+require 'hammer_cli_foreman/subnet'
+
+module HammerCLIForemanRemoteExecution
+  class SubnetExtensions < ::HammerCLI::CommandExtensions
+    output do |definition|
+      definition.insert(:after, _("Smart Proxies"))do
+        collection :remote_execution_proxies, _('Remote execution proxies'), :numbered => false do
+          field :id, _('Id')
+          field :name, _('Name')
+        end
+      end
+    end
+  end
+
+  ::HammerCLIForeman::Subnet::InfoCommand.extend_with(SubnetExtensions.new)
+end

data/lib/hammer_cli_foreman_remote_execution/template_input.rb

@@ -23,20 +23,28 @@ module HammerCLIForemanRemoteExecution
         field :variable_name, _('Variable name')
         field :puppet_parameter_name, _('Puppet parameter name')
         field :options, _('Options'), Fields::List, :width => 25, :hide_blank => true
+        field :default, _('Default value')
       end
 
       build_options
     end
 
     class CreateCommand < HammerCLIForeman::CreateCommand
-      success_message _('Template input created')
+      success_message _('Template input created.')
       failure_message _('Could not create the template input')
 
       build_options
     end
 
+    class UpdateCommand < HammerCLIForeman::UpdateCommand
+      success_message _('Template input updated.')
+      failure_message _('Could not update the template input')
+
+      build_options
+    end
+
     class DeleteCommand < HammerCLIForeman::DeleteCommand
-      success_message _('Template input deleted')
+      success_message _('Template input deleted.')
       failure_message _('Could not delete the template input')
 
       build_options

data/lib/hammer_cli_foreman_remote_execution/version.rb

@@ -1,5 +1,5 @@
 module HammerCLIForemanRemoteExecution
   def self.version
-    @version ||= Gem::Version.new '0.0.6'
+    @version ||= Gem::Version.new '0.2.1'
   end
 end

data/locale/README.md

@@ -1,11 +1,11 @@
 Updating the translations
 -------------------------
 
-  1. Check if there are any new languages with progress more than 50% on [transifex](https://www.transifex.com/projects/p/foreman/resource/hammer-cli-foreman/). If so, do the following for each of the new languages:
+  1. Check if there are any new languages with progress more than 50% on [transifex](https://www.transifex.com/projects/p/foreman/resource/hammer-cli-foreman-remote-execution/). If so, do the following for each of the new languages:
 
   ```
     mkdir locale/<lang>
-    cp locale/hammer-cli-foreman.pot locale/<lang>/hammer-cli-foreman.po
+    cp locale/hammer-cli-foreman-remote-execution.pot locale/<lang>/hammer-cli-foreman-remote-execution.po
   ```
   2. Make sure you have `transifex-client` installed
 

data/locale/de/hammer-cli-foreman-remote-execution.po

@@ -0,0 +1,262 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the hammer_cli_foreman_tasks package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: hammer-cli-foreman-remote-execution 0.2.0\n"
+"Report-Msgid-Bugs-To: \n"
+"PO-Revision-Date: 2016-02-18 10:36-0500\n"
+"Last-Translator: Wiederoder <stefanwiederoder@googlemail.com>, 2017\n"
+"Language-Team: German (https://www.transifex.com/foreman/teams/114/de/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: de\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+msgid "Manage foreign input sets"
+msgstr ""
+
+msgid "ID"
+msgstr "ID"
+
+#, fuzzy
+msgid "Target template ID"
+msgstr "ID"
+
+msgid "Target template name"
+msgstr ""
+
+msgid "Name"
+msgstr "Name"
+
+msgid "Include all"
+msgstr ""
+
+msgid "Include"
+msgstr ""
+
+msgid "Exclude"
+msgstr ""
+
+msgid "Foreign input set updated"
+msgstr ""
+
+msgid "Could not update the input set"
+msgstr ""
+
+msgid "Foreign input set created"
+msgstr ""
+
+msgid "Could not create the input set"
+msgstr ""
+
+msgid "Foreign input set deleted"
+msgstr ""
+
+msgid "Could not delete the input set"
+msgstr ""
+
+msgid "Description"
+msgstr ""
+
+#, fuzzy
+msgid "Status"
+msgstr "Status"
+
+msgid "Success"
+msgstr ""
+
+msgid "Failed"
+msgstr ""
+
+msgid "Pending"
+msgstr ""
+
+msgid "Total"
+msgstr ""
+
+#, fuzzy
+msgid "Start"
+msgstr "Status"
+
+msgid "Job Category"
+msgstr ""
+
+msgid "Mode"
+msgstr ""
+
+msgid "Cron line"
+msgstr "Cron-Zeile"
+
+#, fuzzy
+msgid "Recurring logic ID"
+msgstr "ID"
+
+msgid "Hosts"
+msgstr ""
+
+msgid "View the output for a host"
+msgstr ""
+
+msgid "Do not wait for job to complete, shows current output only"
+msgstr ""
+
+msgid "The job is scheduled to start at %{timestamp}"
+msgstr ""
+
+msgid "Job invocation %{id} created"
+msgstr ""
+
+msgid "Schedule the execution for a later time"
+msgstr ""
+
+msgid "Execution should be cancelled if it cannot be started before --start-at"
+msgstr ""
+
+msgid "Create a recurring execution"
+msgstr ""
+
+msgid "Perform no more executions after this time, used with --cron-line"
+msgstr ""
+
+msgid "Specify inputs from command line"
+msgstr ""
+
+msgid "Read input values from files"
+msgstr ""
+
+msgid "Dynamic search queries are evaluated at run time"
+msgstr ""
+
+msgid "Cancel the job"
+msgstr ""
+
+msgid "Job invocation %{id} cancelled"
+msgstr ""
+
+msgid "Could not cancel the job invocation"
+msgstr ""
+
+msgid "Rerun the job"
+msgstr ""
+
+msgid "Job invocation was rerun as %{id}"
+msgstr ""
+
+msgid "Manage job invocations"
+msgstr ""
+
+msgid "Provider"
+msgstr ""
+
+msgid "Type"
+msgstr ""
+
+msgid "Inputs"
+msgstr ""
+
+msgid "View job template content"
+msgstr ""
+
+msgid "Path to a file that contains the template"
+msgstr ""
+
+msgid "Job template created"
+msgstr ""
+
+msgid "Could not create the job template"
+msgstr ""
+
+msgid "Path to a file that contains the template - must include ERB metadata"
+msgstr ""
+
+msgid "Job template imported"
+msgstr ""
+
+msgid "Could not import the job template"
+msgstr ""
+
+msgid "Export a template including all metadata"
+msgstr ""
+
+msgid "Job template updated"
+msgstr ""
+
+msgid "Could not update the job template"
+msgstr ""
+
+msgid "Job template deleted"
+msgstr ""
+
+msgid "Could not delete the job template"
+msgstr ""
+
+msgid "Manage job templates"
+msgstr ""
+
+msgid ""
+"Comma-separated list of key=file, where file is a path to a text file to be re"
+"ad"
+msgstr ""
+
+#, fuzzy
+msgid ""
+"Cron line format 'a b c d e', where:\n"
+"  a. is minute (range: 0-59)\n"
+"  b. is hour (range: 0-23)\n"
+"  c. is day of month (range: 1-31)\n"
+"  d. is month (range: 1-12)\n"
+"  e. is day of week (range: 0-6)"
+msgstr "Cron-Zeile"
+
+msgid "Manage remote execution features"
+msgstr ""
+
+msgid "Job template name"
+msgstr ""
+
+msgid "Label"
+msgstr ""
+
+#, fuzzy
+msgid "Job template ID"
+msgstr "ID"
+
+msgid "Remote execution feature updated"
+msgstr ""
+
+msgid "Could not update the remote execution feature"
+msgstr ""
+
+msgid "Manage template inputs"
+msgstr ""
+
+msgid "Input type"
+msgstr ""
+
+msgid "Fact name"
+msgstr ""
+
+msgid "Variable name"
+msgstr ""
+
+msgid "Puppet parameter name"
+msgstr ""
+
+msgid "Options"
+msgstr ""
+
+msgid "Template input created"
+msgstr ""
+
+msgid "Could not create the template input"
+msgstr ""
+
+msgid "Template input deleted"
+msgstr ""
+
+msgid "Could not delete the template input"
+msgstr ""