foreman_remote_execution 3.0.2 → 3.2.2

data/app/models/job_invocation_task_group.rb

@@ -2,7 +2,7 @@ class JobInvocationTaskGroup < ::ForemanTasks::TaskGroup
 
   has_one :job_invocation, :foreign_key => :task_group_id, :dependent => :nullify
 
-  alias resource job_invocation
+  alias_method :resource, :job_invocation
 
   def resource_name
     N_('Job Invocation')

data/app/models/job_template.rb

@@ -7,8 +7,8 @@ class JobTemplate < ::Template
   end
 
   attr_exportable :job_category, :description_format,
-                  :foreign_input_sets, :provider_type,
-                  { :kind => ->(template) { template.class.name.underscore } }.merge(taxonomy_exportable)
+    :foreign_input_sets, :provider_type,
+    { :kind => ->(template) { template.class.name.underscore } }.merge(taxonomy_exportable)
 
   include Authorizable
   extend FriendlyId
@@ -65,7 +65,7 @@ class JobTemplate < ::Template
 
     def import_raw!(contents, options = {})
       template = import_raw(contents, options)
-      template.save! if template
+      template&.save!
       template
     end
 

data/app/models/remote_execution_feature.rb

@@ -23,7 +23,6 @@ class RemoteExecutionFeature < ApplicationRecord
     self.find_by(label: label) || raise(::Foreman::Exception.new(N_('Unknown remote execution feature %s'), label))
   end
 
-  # rubocop:disable Metrics/PerceivedComplexity
   def self.register(label, name, options = {})
     begin
       return false unless RemoteExecutionFeature.table_exists?
@@ -61,5 +60,4 @@ class RemoteExecutionFeature < ApplicationRecord
       return feature
     end
   end
-  # rubocop:enable Metrics/PerceivedComplexity
 end

data/app/models/remote_execution_provider.rb

@@ -89,9 +89,11 @@ class RemoteExecutionProvider
       host.host_param(setting.to_s) || Setting[setting]
     end
 
-    def ssh_password(_host) end
+    def ssh_password(_host)
+    end
 
-    def ssh_key_passphrase(_host) end
+    def ssh_key_passphrase(_host)
+    end
 
     def proxy_action_class
       ForemanRemoteExecutionCore::Actions::RunScript

data/app/models/setting/remote_execution.rb

@@ -2,79 +2,77 @@ class Setting::RemoteExecution < Setting
 
   ::Setting::BLANK_ATTRS.concat %w{remote_execution_ssh_password remote_execution_ssh_key_passphrase remote_execution_sudo_password remote_execution_cockpit_url remote_execution_form_job_template}
 
-  # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
   def self.default_settings
     [
       self.set('remote_execution_fallback_proxy',
-               N_('Search the host for any proxy with Remote Execution, useful when the host has no subnet or the subnet does not have an execution proxy'),
-               false,
-               N_('Fallback to Any Proxy')),
+        N_('Search the host for any proxy with Remote Execution, useful when the host has no subnet or the subnet does not have an execution proxy'),
+        false,
+        N_('Fallback to Any Proxy')),
       self.set('remote_execution_global_proxy',
-               N_('Search for remote execution proxy outside of the proxies assigned to the host. ' +
-               "The search will be limited to the host's organization and location."),
-               true,
-               N_('Enable Global Proxy')),
+        N_('Search for remote execution proxy outside of the proxies assigned to the host. ' +
+        "The search will be limited to the host's organization and location."),
+        true,
+        N_('Enable Global Proxy')),
       self.set('remote_execution_ssh_user',
-               N_('Default user to use for SSH.  You may override per host by setting a parameter called remote_execution_ssh_user.'),
-               'root',
-               N_('SSH User')),
+        N_('Default user to use for SSH.  You may override per host by setting a parameter called remote_execution_ssh_user.'),
+        'root',
+        N_('SSH User')),
       self.set('remote_execution_effective_user',
-               N_('Default user to use for executing the script. If the user differs from the SSH user, su or sudo is used to switch the user.'),
-               'root',
-               N_('Effective User')),
+        N_('Default user to use for executing the script. If the user differs from the SSH user, su or sudo is used to switch the user.'),
+        'root',
+        N_('Effective User')),
       self.set('remote_execution_effective_user_method',
-               N_('What command should be used to switch to the effective user. One of %s') % SSHExecutionProvider::EFFECTIVE_USER_METHODS.inspect,
-               'sudo',
-               N_('Effective User Method'),
-               nil,
-               { :collection => proc { Hash[SSHExecutionProvider::EFFECTIVE_USER_METHODS.map { |method| [method, method] }] } }),
+        N_('What command should be used to switch to the effective user. One of %s') % SSHExecutionProvider::EFFECTIVE_USER_METHODS.inspect,
+        'sudo',
+        N_('Effective User Method'),
+        nil,
+        { :collection => proc { Hash[SSHExecutionProvider::EFFECTIVE_USER_METHODS.map { |method| [method, method] }] } }),
       self.set('remote_execution_sudo_password', N_("Sudo password"), '', N_("Sudo password"), nil, {:encrypted => true}),
       self.set('remote_execution_sync_templates',
-               N_('Whether we should sync templates from disk when running db:seed.'),
-               true,
-               N_('Sync Job Templates')),
+        N_('Whether we should sync templates from disk when running db:seed.'),
+        true,
+        N_('Sync Job Templates')),
       self.set('remote_execution_ssh_port',
-               N_('Port to use for SSH communication. Default port 22. You may override per host by setting a parameter called remote_execution_ssh_port.'),
-               '22',
-               N_('SSH Port')),
+        N_('Port to use for SSH communication. Default port 22. You may override per host by setting a parameter called remote_execution_ssh_port.'),
+        '22',
+        N_('SSH Port')),
       self.set('remote_execution_connect_by_ip',
-               N_('Should the ip addresses on host interfaces be preferred over the fqdn? '\
-               'It is useful, when DNS not resolving the fqdns properly. You may override this per host by setting a parameter called remote_execution_connect_by_ip.'),
-               false,
-               N_('Connect by IP')),
+        N_('Should the ip addresses on host interfaces be preferred over the fqdn? '\
+        'It is useful when DNS not resolving the fqdns properly. You may override this per host by setting a parameter called remote_execution_connect_by_ip. '\
+        'This setting only applies to IPv4. When the host has only an IPv6 address on the interface used for remote execution, hostname will be used even if this setting is set to true.'),
+        false,
+        N_('Connect by IP')),
       self.set('remote_execution_ssh_password',
-               N_('Default password to use for SSH. You may override per host by setting a parameter called remote_execution_ssh_password'),
-               nil,
-               N_('Default SSH password'),
-               nil,
-               { :encrypted => true }),
+        N_('Default password to use for SSH. You may override per host by setting a parameter called remote_execution_ssh_password'),
+        nil,
+        N_('Default SSH password'),
+        nil,
+        { :encrypted => true }),
       self.set('remote_execution_ssh_key_passphrase',
-               N_('Default key passphrase to use for SSH. You may override per host by setting a parameter called remote_execution_ssh_key_passphrase'),
-               nil,
-               N_('Default SSH key passphrase'),
-               nil,
-               { :encrypted => true }),
+        N_('Default key passphrase to use for SSH. You may override per host by setting a parameter called remote_execution_ssh_key_passphrase'),
+        nil,
+        N_('Default SSH key passphrase'),
+        nil,
+        { :encrypted => true }),
       self.set('remote_execution_workers_pool_size',
-               N_('Amount of workers in the pool to handle the execution of the remote execution jobs. Restart of the dynflowd/foreman-tasks service is required.'),
-               5,
-               N_('Workers pool size')),
+        N_('Amount of workers in the pool to handle the execution of the remote execution jobs. Restart of the dynflowd/foreman-tasks service is required.'),
+        5,
+        N_('Workers pool size')),
       self.set('remote_execution_cleanup_working_dirs',
-               N_('When enabled, working directories will be removed after task completion. You may override this per host by setting a parameter called remote_execution_cleanup_working_dirs.'),
-               true,
-               N_('Cleanup working directories')),
+        N_('When enabled, working directories will be removed after task completion. You may override this per host by setting a parameter called remote_execution_cleanup_working_dirs.'),
+        true,
+        N_('Cleanup working directories')),
       self.set('remote_execution_cockpit_url',
-               N_('Where to find the Cockpit instance for the Web Console button.  By default, no button is shown.'),
-               nil,
-               N_('Cockpit URL'),
-               nil),
+        N_('Where to find the Cockpit instance for the Web Console button.  By default, no button is shown.'),
+        nil,
+        N_('Cockpit URL'),
+        nil),
       self.set('remote_execution_form_job_template',
-               N_('Choose a job template that is pre-selected in job invocation form'),
-               'Run Command - SSH Default',
-               _('Form Job Template'),
-               nil,
-               { :collection => proc { Hash[JobTemplate.unscoped.map { |template| [template.name, template.name] }] } })
+        N_('Choose a job template that is pre-selected in job invocation form'),
+        'Run Command - SSH Default',
+        _('Form Job Template'),
+        nil,
+        { :collection => proc { Hash[JobTemplate.unscoped.map { |template| [template.name, template.name] }] } }),
     ]
   end
-  # rubocop:enable AbcSize
-  # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
 end

data/app/models/ssh_execution_provider.rb

@@ -32,7 +32,7 @@ class SSHExecutionProvider < RemoteExecutionProvider
       {
         :ssh_password => ssh_password(host),
         :key_passphrase => ssh_key_passphrase(host),
-        :sudo_password => sudo_password(host)
+        :sudo_password => sudo_password(host),
       }
     end
 
@@ -45,7 +45,7 @@ class SSHExecutionProvider < RemoteExecutionProvider
         :ssh_user => ssh_user(host),
         :ssh_port => ssh_port(host),
         :ssh_password => ssh_password(host),
-        :ssh_key_passphrase => ssh_key_passphrase(host)
+        :ssh_key_passphrase => ssh_key_passphrase(host),
       }
     end
 

data/app/models/targeting.rb

@@ -61,6 +61,7 @@ class Targeting < ApplicationRecord
 
   def self.build_query_from_hosts(ids)
     return '' if ids.empty?
+
     hosts = Host.where(:id => ids).distinct.pluck(:name)
     "name ^ (#{hosts.join(', ')})"
   end

data/app/models/template_invocation.rb

@@ -31,13 +31,12 @@ class TemplateInvocation < ApplicationRecord
       :error     => :failed,
       :pending   => :pending,
       :success   => :success,
-      :warning   => :failed
+      :warning   => :failed,
     }.with_indifferent_access
 
-    REVERSE_MAP = MAP.reduce({}) do |acc, (key, value)|
+    REVERSE_MAP = MAP.each_with_object({}) do |(key, value), acc|
       acc[value] ||= []
       acc[value] << key
-      acc
     end.with_indifferent_access
 
     class << self

data/app/views/api/v2/job_invocations/base.json.rabl

@@ -7,7 +7,7 @@ node do |invocation|
     :succeeded => invocation_count(invocation, :output_key => :success_count),
     :failed    => invocation_count(invocation, :output_key => :failed_count),
     :pending   => invocation_count(invocation, :output_key => :pending_count),
-    :total     => invocation_count(invocation, :output_key => :total_count)
+    :total     => invocation_count(invocation, :output_key => :total_count),
   }
 end
 

data/app/views/api/v2/job_invocations/main.json.rabl

@@ -17,9 +17,9 @@ end
 
 child :targeting do
   attributes :bookmark_id, :search_query, :targeting_type, :user_id, :status, :status_label,
-             :randomized_ordering
+    :randomized_ordering
 
-  child :hosts do
+  child @hosts do
     extends 'api/v2/hosts/base'
   end
 end
@@ -28,9 +28,12 @@ child :task do
   attributes :id, :state
 end
 
-child :template_invocations do
+child @template_invocations do
   attributes :template_id, :template_name
   child :input_values do
-    attributes :template_input_name, :template_input_id, :value
+    attributes :template_input_name, :template_input_id
+    node :value do |iv|
+      iv.template_input.respond_to?(:hidden_value) && iv.template_input.hidden_value? ? '*' * 5 : iv.value
+    end
   end
 end

data/app/views/job_invocations/_card_results.html.erb

@@ -5,6 +5,7 @@
     </h2>
     <div class="card-pf-body">
       <div id='status_chart'>
+        <%= react_component('JobInvocationContainer', data: { url: "/job_invocations/chart?id=#{job_invocation.id}" }) %>
       </div>
     </div>
   </div>

data/app/views/job_invocations/_card_target_hosts.html.erb

@@ -20,6 +20,18 @@
       <% key = job_invocation.targeting.randomized_ordering ? Targeting::RANDOMIZED : Targeting::ORDERED %>
       <%= _('Execution order') %>: <strong><%= Targeting::ORDERINGS[key].downcase %></strong>
     </p>
+    <p>
+      <%= _('Organization') %>:
+      <strong>
+        <%= show_job_organization(@job_organization) %>
+      </strong>
+    </p>
+    <p>
+      <%= _('Location') %>:
+      <strong>
+        <%= show_job_location(@job_location) %>
+      </strong>
+    </p>
   </div>
   <div class='card-pf-footer'>
     <p>

data/app/views/job_invocations/_card_user_input.html.erb

@@ -8,7 +8,7 @@
     <p>
     <ul>
       <% template_invocation.input_values.joins(:template_input).each do |input_value| %>
-        <li><b><%= input_value.template_input.name %></b>: <%= trunc_with_tooltip(input_value.value, 255) %></li>
+        <li><b><%= input_value.template_input.name %></b>: <%= trunc_with_tooltip(input_safe_value(input_value), 255) %></li>
       <% end %>
     </ul>
     </p>

data/app/views/job_invocations/_form.html.erb

@@ -99,8 +99,8 @@
     </div>
 
     <div class="advanced hidden">
-      <%= number_f f, :concurrency_level, :label => _('Concurrency level'), :placeholder => 'N', :min => 1, :label_help => N_("Run at most N tasks at a time") %>
-      <%= number_f f, :time_span, :label => _('Time span'), :placeholder => 'N', :min => 1, :label_help => N_("Distribute execution over N seconds")  %>
+      <%= number_f f, :concurrency_level, :label => _('Concurrency level'), :placeholder => 'N', :min => 1, :label_help => N_("Run at most N tasks at a time. If this is set and proxy batch triggering is enabled, then tasks are triggered on the smart proxy in batches of size 1.") %>
+      <%= number_f f, :time_span, :label => _('Time span'), :placeholder => 'N', :min => 1, :label_help => N_("Distribute execution over N seconds. If this is set and proxy batch triggering is enabled, then tasks are triggered on the smart proxy in batches of size 1.") %>
     </div>
 
     <div class="form-group advanced hidden">
@@ -126,5 +126,6 @@
 
   <%= render :partial => 'preview_hosts_modal' %>
 
+  <%= render partial: 'rerun_taxonomies' if action_name == 'rerun' %>
   <%= submit_or_cancel f, false, :cancel_path => job_invocations_path, :disabled => !@composer.rerun_possible? %>
 <% end %>

data/app/views/job_invocations/_host_status_td.html.erb

@@ -1 +1 @@
-<td class="host_status" id="<%= dom_id(host) %>-status" data-refresh_required="<%= task.nil? || task.pending? ? 'true' : '' %>" data-id="<%= host.id %>"><%= template_invocation_status(task) %></td>
+<td class="host_status" id="<%= dom_id(host) %>-status" data-refresh_required="<%= task.nil? || task.pending? ? 'true' : '' %>" data-id="<%= host.id %>"><%= template_invocation_status(task, job_invocation.task) %></td>

data/app/views/job_invocations/_rerun_taxonomies.html.erb

@@ -0,0 +1,22 @@
+<% if Organization.current != @job_organization %>
+  <div class="form-group">
+    <div class="col-md-6">
+      <div class="alert alert-warning">
+        <span class="pficon pficon-warning-triangle-o"></span>
+        <%= _("Current organization %{org_c} is different from job's organization %{org_j}.") % { org_c: show_job_organization(Organization.current),
+                                                                                                  org_j: show_job_organization(@job_organization) } %>
+      </div>
+    </div>
+  </div>
+<% end %>
+<% if Location.current != @job_location %>
+  <div class="form-group">
+    <div class="col-md-6">
+      <div class="alert alert-warning">
+        <span class="pficon pficon-warning-triangle-o"></span>
+        <%= _("Current location %{loc_c} is different from job's location %{loc_j}.") % { loc_c: show_job_location(Location.current),
+                                                                                          loc_j: show_job_location(@job_location) } %>
+      </div>
+    </div>
+  </div>
+<% end %>

data/app/views/job_invocations/_tab_overview.html.erb

@@ -1,7 +1,7 @@
 <% template_invocations = job_invocation.pattern_template_invocations %>
 <div class='row'>
   <div class="col-xs-6 col-sm-6 col-md-6">
-    <%= render :partial => 'card_results' %>
+    <%= render :partial => 'card_results', :locals => { :job_invocation => job_invocation } %>
     <%= render :partial => 'card_schedule', :locals => { :job_invocation => job_invocation } %>
   </div>
   <div class='col-xs-12 col-sm-6 col-md-6'>

data/app/views/job_invocations/_user_input.html.erb

@@ -12,7 +12,7 @@
       <% template_invocation.input_values.joins(:template_input).each do |input_value| %>
         <tr>
           <td><b><%= input_value.template_input.name %></b></td>
-          <td><%= input_value.value %></td>
+          <td><%= input_safe_value(input_value) %></td>
         </tr>
       <% end %>
       </tbody>

data/app/views/job_invocations/show.html.erb

@@ -1,7 +1,7 @@
 <% title @job_invocation.description %>
 <% stylesheet 'foreman_remote_execution/foreman_remote_execution' %>
 <% javascript 'charts', 'foreman_remote_execution/template_invocation' %>
-<%= javascript_include_tag *webpack_asset_paths('foreman_remote_execution', :extension => 'js'), "data-turbolinks-track" => true, 'defer' => 'defer' %>
+<% javascript *webpack_asset_paths('foreman_remote_execution', :extension => 'js') %>
 
 <%= breadcrumbs name_field: 'description' %>
 
@@ -19,6 +19,7 @@
   <% if @job_invocation.recurring_logic.present? %>
     <li><a href="#recurring_logic" data-toggle="tab"><%= _('Recurring logic') %></a></li>
   <% end %>
+  <%= render_tab_header_for(:main_tabs, subject: @job_invocation) %>
 </ul>
 
 <div class="tab-content">
@@ -38,6 +39,7 @@
     </div>
   </div>
   <% end %>
+  <%= render_tab_content_for(:main_tabs, subject: @job_invocation) %>
 </div>
 
 <script id="job_invocation_refresh" data-refresh-url="<%= job_invocation_path(@job_invocation) %>">

data/config/routes.rb

@@ -16,7 +16,8 @@ Rails.application.routes.draw do
     end
   end
 
-  resources :job_invocations, :only => [:new, :create, :show, :index] do
+  match 'job_invocations/new', to: 'job_invocations#new', via: [:get, :post], as: 'new_job_invocation'
+  resources :job_invocations, :only => [:create, :show, :index] do
     collection do
       post 'refresh'
       get 'chart'

data/db/migrate/20151215114631_add_host_id_to_template_invocation.rb

@@ -15,6 +15,7 @@ class AddHostIdToTemplateInvocation < ActiveRecord::Migration[4.2]
         :'foreman_tasks_locks.resource_id' => template_invocation.id
       ).first
       next if task.nil? # skip invocations from very early versions of remote executions
+
       host_id = task.locks.where(:'foreman_tasks_locks.resource_type' => 'Host::Managed').first.resource_id
       next unless Host.find_by(id: host_id)
 

data/db/migrate/20180110104432_rename_template_invocation_permission.rb

@@ -14,6 +14,7 @@ class RenameTemplateInvocationPermission < ActiveRecord::Migration[4.2]
   def switch_filtering_permission!(old, new)
     old_permission = Permission.find_by(:name => old)
     return if old_permission.nil?
+
     new_permission = Permission.find_or_create_by(:name => new,
                                                   :resource_type => 'TemplateInvocation')
     old_permission.filterings.each do |filtering|

data/db/seeds.d/50-notification_blueprints.rb

@@ -9,10 +9,10 @@ blueprints = [
       links:
       [
         path_method: :job_invocation_path,
-        title: N_('Job Details')
-      ]
-    }
-  }
+        title: N_('Job Details'),
+      ],
+    },
+  },
 ]
 
 blueprints.each { |blueprint| UINotifications::Seed.new(blueprint).configure }