foreman_remote_execution 3.0.3 → 3.1.0

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,7 +17,7 @@ end
 
 child :targeting do
   attributes :bookmark_id, :search_query, :targeting_type, :user_id, :status, :status_label,
-             :randomized_ordering
+    :randomized_ordering
 
   child :hosts do
     extends 'api/v2/hosts/base'
@@ -31,6 +31,9 @@ end
 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_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>: <%= input_value.template_input.hidden_value ? '*' * 5 : trunc_with_tooltip(input_value.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/_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/_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_value.template_input.hidden_value? ? '*' * 5 : input_value.value %></td>
         </tr>
       <% end %>
       </tbody>

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

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

data/db/seeds.d/90-bookmarks.rb

@@ -10,6 +10,7 @@ Bookmark.without_auditing do
     next if Bookmark.where(:controller => 'job_invocations').find_by(name: input[:name])
     # TODO audit should be fixed once core #13109 gets merged
     next if SeedHelper.audit_modified? Bookmark, input[:name]
+
     attributes = { :public => true }.merge(input)
     b = Bookmark.where(:name => input[:name], :controller => input[:controller]).first || Bookmark.new
     b.attributes = attributes

data/extra/cockpit/foreman-cockpit-session

@@ -44,9 +44,11 @@ end
 def read_control
   size = $stdin.readline.chomp.to_i
   raise ArgumentError, "Invalid frame: invalid size" if size.zero?
+
   data = $stdin.read(size)
   LOG.debug("Received control message #{data.lstrip}")
   raise ArgumentError, "Invalid frame: too short" if data.nil? || data.length < size
+
   JSON.parse(data)
 end
 
@@ -67,6 +69,7 @@ def read_auth_reply
   cmd = read_control
   response = cmd["response"]
   raise ArgumentError, "Did not receive a valid authorize command" if cmd["command"] != "authorize" || !response
+
   response
 end
 
@@ -112,8 +115,8 @@ def foreman_call(path, token)
     return JSON.parse(res.body)
   when "401"
     exit_with_problem("authentication-failed",
-                      "Token was not valid",
-                      { "password" => "not-tried", "token" => "denied" })
+      "Token was not valid",
+      { "password" => "not-tried", "token" => "denied" })
   when "404"
     return nil
   else
@@ -135,6 +138,7 @@ def ssh_read_and_handle_response_header(sock, url, params)
   loop do
     line = sock.readline
     break unless line && (line != "\r\n")
+
     header += line
   end
 
@@ -262,6 +266,7 @@ def ssh_with_proxy(proxy, params)
     end
 
     next unless w.include?($stdout)
+
     n = $stdout.write(out_buf)
     $stdout.flush
     out_buf = out_buf[n..-1]

data/lib/foreman_remote_execution/engine.rb

@@ -78,7 +78,7 @@ module ForemanRemoteExecution
           permission :cancel_job_invocations, { :job_invocations => [:cancel], 'api/v2/job_invocations' => [:cancel] }, :resource_type => 'JobInvocation'
           # this permissions grants user to get auto completion hints when setting up filters
           permission :filter_autocompletion_for_template_invocation, { :template_invocations => [ :auto_complete_search, :index ] },
-                     :resource_type => 'TemplateInvocation'
+            :resource_type => 'TemplateInvocation'
           permission :cockpit_hosts, { 'cockpit' => [:redirect, :host_ssh_params] }, :resource_type => 'Host'
         end
 
@@ -88,7 +88,7 @@ module ForemanRemoteExecution
           :create_job_invocations,
           :create_template_invocations,
           :view_hosts,
-          :view_smart_proxies
+          :view_smart_proxies,
         ].freeze
         MANAGER_PERMISSIONS = USER_PERMISSIONS + [
           :cancel_job_invocations,
@@ -98,32 +98,32 @@ module ForemanRemoteExecution
           :lock_job_templates,
           :view_audit_logs,
           :filter_autocompletion_for_template_invocation,
-          :edit_remote_execution_features
+          :edit_remote_execution_features,
         ]
 
         # Add a new role called 'Remote Execution User ' if it doesn't exist
-        role 'Remote Execution User', USER_PERMISSIONS
-        role 'Remote Execution Manager', MANAGER_PERMISSIONS
+        role 'Remote Execution User', USER_PERMISSIONS, 'Role with permissions to run remote execution jobs against hosts'
+        role 'Remote Execution Manager', MANAGER_PERMISSIONS, 'Role with permissions to manage job templates, remote execution features, cancel jobs and view audit logs'
 
         add_all_permissions_to_default_roles
 
         # add menu entry
         menu :top_menu, :job_templates,
-             url_hash: { controller: :job_templates, action: :index },
-             caption: N_('Job templates'),
-             parent: :hosts_menu,
-             after: :provisioning_templates
+          url_hash: { controller: :job_templates, action: :index },
+          caption: N_('Job templates'),
+          parent: :hosts_menu,
+          after: :provisioning_templates
         menu :admin_menu, :remote_execution_features,
-             url_hash: { controller: :remote_execution_features, action: :index },
-             caption: N_('Remote Execution Features'),
-             parent: :administer_menu,
-             after: :bookmarks
+          url_hash: { controller: :remote_execution_features, action: :index },
+          caption: N_('Remote Execution Features'),
+          parent: :administer_menu,
+          after: :bookmarks
 
         menu :top_menu, :job_invocations,
-             url_hash: { controller: :job_invocations, action: :index },
-             caption: N_('Jobs'),
-             parent: :monitor_menu,
-             after: :audits
+          url_hash: { controller: :job_invocations, action: :index },
+          caption: N_('Jobs'),
+          parent: :monitor_menu,
+          after: :audits
 
         register_custom_status HostStatus::ExecutionStatus
         # add dashboard widget
@@ -135,6 +135,7 @@ module ForemanRemoteExecution
         end
 
         extend_rabl_template 'api/v2/smart_proxies/main', 'api/v2/smart_proxies/pubkey'
+        describe_host { overview_buttons_provider :host_overview_buttons }
       end
     end
 

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '3.0.3'.freeze
+  VERSION = '3.1.0'.freeze
 end

data/test/benchmark/run_hosts_job_benchmark.rb

@@ -37,7 +37,7 @@ class ActionTester
 
   def run_action(*args)
     action = create_action(Actions::RemoteExecution::RunHostsJob)
-    @task.update_attributes(:external_id => action.execution_plan_id)
+    @task.update(:external_id => action.execution_plan_id)
     plan_action(action, *args)
   end
 end

data/test/factories/foreman_remote_execution_factories.rb

@@ -128,7 +128,7 @@ FactoryBot.modify do
       domain
       subnet do
         overrides = {
-          :remote_execution_proxies => [FactoryBot.create(:smart_proxy, :ssh)]
+          :remote_execution_proxies => [FactoryBot.create(:smart_proxy, :ssh)],
         }
 
         overrides[:locations] = [location] unless location.nil?

data/test/functional/api/v2/job_invocations_controller_test.rb

@@ -78,9 +78,9 @@ module Api
         context 'with_feature' do
           setup do
             @feature = FactoryBot.create(:remote_execution_feature,
-                                         :job_template => @template)
+              :job_template => @template)
             @attrs = {
-              feature: @feature.label
+              feature: @feature.label,
             }
           end
 
@@ -171,7 +171,7 @@ module Api
           assert_equal result['complete'], false
           assert_equal result['delayed'], true
           assert_nil result['output']
-          Time.parse(result['start_at']).to_f.must_be_close_to start_time.to_f
+          _(Time.parse(result['start_at']).to_f).must_be_close_to start_time.to_f
           assert_response :success
         end
 
@@ -227,8 +227,8 @@ module Api
         assert_response :success
         result = ActiveSupport::JSON.decode(@response.body)
         targeting = Targeting.find(result['targeting_id'])
-        targeting.user_id.must_equal users(:admin).id
-        targeting.search_query.must_equal @invocation.targeting.search_query
+        _(targeting.user_id).must_equal users(:admin).id
+        _(targeting.search_query).must_equal @invocation.targeting.search_query
       end
 
       test 'should not raise an exception when reruning failed has no hosts' do
@@ -241,8 +241,8 @@ module Api
         assert_response :success
         result = ActiveSupport::JSON.decode(@response.body)
         targeting = Targeting.find(result['targeting_id'])
-        targeting.user_id.must_equal users(:admin).id
-        targeting.search_query.must_equal 'name ^ ()'
+        _(targeting.user_id).must_equal users(:admin).id
+        _(targeting.search_query).must_equal 'name ^ ()'
       end
 
       test 'should rerun failed only' do
@@ -260,8 +260,8 @@ module Api
         result = ActiveSupport::JSON.decode(@response.body)
         targeting = Targeting.find(result['targeting_id'])
         hostnames = @invocation.template_invocations.map { |ti| ti.host.name }
-        targeting.user_id.must_equal users(:admin).id
-        targeting.search_query.must_equal "name ^ (#{hostnames.join(',')})"
+        _(targeting.user_id).must_equal users(:admin).id
+        _(targeting.search_query).must_equal "name ^ (#{hostnames.join(',')})"
       end
 
       test 'should return 404 if template is not found' do

data/test/functional/api/v2/job_templates_controller_test.rb

@@ -39,7 +39,7 @@ module Api
         valid_attrs = { :template => 'This is a test template', :name => 'RandomName', :provider_type => 'ssh' }
         post :create, params: { :job_template => valid_attrs }
         template = ActiveSupport::JSON.decode(@response.body)
-        assert template['name'] == 'RandomName'
+        assert_equal template['name'], 'RandomName'
         assert_response :success
       end
 

data/test/functional/api/v2/remote_execution_features_controller_test.rb

@@ -5,8 +5,8 @@ module Api
     class RemoteExecutionFeaturesControllerTest < ActionController::TestCase
       setup do
         @remote_execution_feature = RemoteExecutionFeature.register(:my_awesome_feature, 'My awesome feature',
-                                                                    :description => 'You will not believe what it does',
-                                                                    :provided_inputs => ['awesomeness_level'])
+          :description => 'You will not believe what it does',
+          :provided_inputs => ['awesomeness_level'])
         @template = FactoryBot.create(:job_template, :with_input)
       end
 

data/test/functional/api/v2/template_invocations_controller_test.rb

@@ -13,8 +13,8 @@ module Api
       test 'should get template invocations belonging to job invocation' do
         get :template_invocations, params: { :id => @job.id }
         invocations = ActiveSupport::JSON.decode(@response.body)
-        invocations['results'].count.must_equal @job.template_invocations.count
-        invocations['total'].must_equal @job.template_invocations.count
+        _(invocations['results'].count).must_equal @job.template_invocations.count
+        _(invocations['total']).must_equal @job.template_invocations.count
 
         expected_result = {
           'id'                   => @template_invocation.id,
@@ -23,9 +23,9 @@ module Api
           'template_id'          => @template_invocation.template_id,
           'effective_user'       => @template_invocation.effective_user,
           'job_invocation_id'    => @job.id,
-          'run_host_job_task_id' => @template_invocation.run_host_job_task_id
+          'run_host_job_task_id' => @template_invocation.run_host_job_task_id,
         }
-        invocations['results'].must_equal [expected_result]
+        _(invocations['results']).must_equal [expected_result]
         assert_response :success
       end
     end