foreman_remote_execution 4.4.0 → 4.5.3

data/app/models/job_invocation_composer.rb

@@ -1,4 +1,7 @@
 class JobInvocationComposer
+  class JobTemplateNotFound < StandardError; end
+
+  class FeatureNotFound < StandardError; end
 
   class UiParams
     attr_reader :ui_params
@@ -100,6 +103,17 @@ class JobInvocationComposer
 
     def initialize(api_params)
       @api_params = api_params
+
+      if api_params[:feature]
+        # set a default targeting type for backward compatibility
+        # when `for_feature` was used by the API it automatically set a default
+        api_params[:targeting_type] = Targeting::STATIC_TYPE
+      end
+
+      if api_params[:search_query].blank? && api_params[:host_ids].present?
+        translator = HostIdsTranslator.new(api_params[:host_ids])
+        api_params[:search_query] = translator.scoped_search
+      end
     end
 
     def params
@@ -107,12 +121,16 @@ class JobInvocationComposer
         :targeting => targeting_params,
         :triggering => triggering_params,
         :description_format => api_params[:description_format],
-        :remote_execution_feature_id => api_params[:remote_execution_feature_id],
+        :remote_execution_feature_id => remote_execution_feature_id,
         :concurrency_control => concurrency_control_params,
         :execution_timeout_interval => api_params[:execution_timeout_interval] || template.execution_timeout_interval,
         :template_invocations => template_invocations_params }.with_indifferent_access
     end
 
+    def remote_execution_feature_id
+      feature&.id || api_params[:remote_execution_feature_id]
+    end
+
     def targeting_params
       raise ::Foreman::Exception, _('Cannot specify both bookmark_id and search_query') if api_params[:bookmark_id] && api_params[:search_query]
 
@@ -156,7 +174,7 @@ class JobInvocationComposer
         input = template.template_inputs_with_foreign.find { |i| i.name == name }
         unless input
           raise ::Foreman::Exception, _('Unknown input %{input_name} for template %{template_name}') %
-              { :input_name => name, :template_name => template.name }
+            { :input_name => name, :template_name => template.name }
         end
         { :template_input_id => input.id, :value => value }
       end
@@ -170,8 +188,20 @@ class JobInvocationComposer
       inputs.select { |key, value| provider_input_names.include? key }.map { |key, value| { :name => key, :value => value } }
     end
 
+    def feature
+      @feature ||= RemoteExecutionFeature.feature(api_params[:feature]) if api_params[:feature]
+    rescue => e
+      raise(FeatureNotFound, e.message)
+    end
+
+    def job_template_id
+      feature&.job_template_id || api_params[:job_template_id]
+    end
+
     def template
-      @template ||= JobTemplate.authorized(:view_job_templates).find(api_params[:job_template_id])
+      @template ||= JobTemplate.authorized(:view_job_templates).find(job_template_id)
+    rescue ActiveRecord::RecordNotFound
+      raise(JobTemplateNotFound, _("Template with id '%{id}' was not found") % { id: job_template_id })
     end
 
     private
@@ -239,25 +269,38 @@ class JobInvocationComposer
     end
   end
 
+  class HostIdsTranslator
+    attr_reader :bookmark, :hosts, :scoped_search, :host_ids
+
+    def initialize(input)
+      case input
+      when Bookmark
+        @bookmark = input
+      when Host::Base
+        @hosts = [input]
+      when Array
+        @hosts = input.map do |id|
+          Host::Managed.authorized.friendly.find(id)
+        end
+      when String
+        @scoped_search = input
+      else
+        @hosts = input
+      end
+
+      @scoped_search ||= Targeting.build_query_from_hosts(hosts.map(&:id)) if @hosts
+    end
+  end
+
   class ParamsForFeature
     attr_reader :feature_label, :feature, :provided_inputs
 
     def initialize(feature_label, hosts, provided_inputs = {})
       @feature = RemoteExecutionFeature.feature(feature_label)
       @provided_inputs = provided_inputs
-      if hosts.is_a? Bookmark
-        @host_bookmark = hosts
-      elsif hosts.is_a? Host::Base
-        @host_objects = [hosts]
-      elsif hosts.is_a? Array
-        @host_objects = hosts.map do |id|
-          Host::Managed.authorized.friendly.find(id)
-        end
-      elsif hosts.is_a? String
-        @host_scoped_search = hosts
-      else
-        @host_objects = hosts
-      end
+      translator = HostIdsTranslator.new(hosts)
+      @host_bookmark = translator.bookmark
+      @host_scoped_search = translator.scoped_search
     end
 
     def params
@@ -275,7 +318,6 @@ class JobInvocationComposer
       ret = {}
       ret['targeting_type'] = Targeting::STATIC_TYPE
       ret['search_query'] = @host_scoped_search if @host_scoped_search
-      ret['search_query'] = Targeting.build_query_from_hosts(@host_objects) if @host_objects
       ret['bookmark_id'] = @host_bookmark.id if @host_bookmark
       ret['user_id'] = User.current.id
       ret
@@ -363,7 +405,7 @@ class JobInvocationComposer
     job_invocation.effective_user_password = params[:effective_user_password]
 
     if @reruns && job_invocation.targeting.static?
-      job_invocation.targeting.host_ids = JobInvocation.find(@reruns).targeting.host_ids
+      job_invocation.targeting.assign_host_ids(JobInvocation.find(@reruns).targeting.host_ids)
       job_invocation.targeting.mark_resolved!
     end
 
@@ -553,7 +595,7 @@ class JobInvocationComposer
 
     params[:template_invocations].select { |t| valid_template_ids.include?(t[:template_id].to_i) }.map do |template_invocation_params|
       template_invocation = job_invocation.pattern_template_invocations.build(:template_id => template_invocation_params[:template_id],
-                                                                              :effective_user => build_effective_user(template_invocation_params))
+        :effective_user => build_effective_user(template_invocation_params))
       build_input_values_for(template_invocation, template_invocation_params)
       template_invocation
     end

data/app/models/remote_execution_provider.rb

@@ -50,7 +50,7 @@ class RemoteExecutionProvider
       method = host_setting(host, :remote_execution_effective_user_method)
       unless EFFECTIVE_USER_METHODS.include?(method)
         raise _('Effective user method "%{current_value}" is not one of %{valid_methods}') %
-                  { :current_value => method, :valid_methods => EFFECTIVE_USER_METHODS}
+          { :current_value => method, :valid_methods => EFFECTIVE_USER_METHODS}
       end
       method
     end

data/app/models/setting/remote_execution.rb

@@ -70,13 +70,13 @@ class Setting::RemoteExecution < Setting
       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'),
+        N_('Form Job Template'),
         nil,
         { :collection => proc { Hash[JobTemplate.unscoped.map { |template| [template.name, template.name] }] } }),
       self.set('remote_execution_job_invocation_report_template',
         N_('Select a report template used for generating a report for a particular remote execution job'),
         'Jobs - Invocation report template',
-        _('Job Invocation Report Template'),
+        N_('Job Invocation Report Template'),
         nil,
         { :collection => proc { self.job_invocation_report_templates_select } }),
     ]

data/app/models/ssh_execution_provider.rb

@@ -2,10 +2,10 @@ class SSHExecutionProvider < RemoteExecutionProvider
   class << self
     def proxy_command_options(template_invocation, host)
       super.merge(:ssh_user => ssh_user(host),
-                  :effective_user => effective_user(template_invocation),
-                  :effective_user_method => effective_user_method(host),
-                  :cleanup_working_dirs => cleanup_working_dirs?(host),
-                  :ssh_port => ssh_port(host))
+        :effective_user => effective_user(template_invocation),
+        :effective_user_method => effective_user_method(host),
+        :cleanup_working_dirs => cleanup_working_dirs?(host),
+        :ssh_port => ssh_port(host))
     end
 
     def humanized_name

data/app/models/targeting.rb

@@ -46,9 +46,13 @@ class Targeting < ApplicationRecord
     #   pluck(:id) returns duplicate results for HostCollections
     host_ids = User.as(user.login) { Host.authorized(RESOLVE_PERMISSION, Host).search_for(search_query).order(:name, :id).pluck(:id).uniq }
     host_ids.shuffle!(random: Random.new) if randomized_ordering
+    self.assign_host_ids(host_ids)
+    self.save(:validate => false)
+  end
+
+  def assign_host_ids(host_ids)
     # this can be optimized even more, by introducing bulk insert
     self.targeting_hosts.build(host_ids.map { |id| { :host_id => id } })
-    self.save(:validate => false)
   end
 
   def dynamic?

data/app/overrides/execution_interface.rb

@@ -1,9 +1,9 @@
-Deface::Override.new(:virtual_path    => 'hosts/_form',
-                     :name            => 'add_execution_interface_js',
-                     :insert_before   => 'div#primary',
-                     :text            => '<%= javascript "foreman_remote_execution/execution_interface" %>')
+Deface::Override.new(:virtual_path => 'hosts/_form',
+  :name            => 'add_execution_interface_js',
+  :insert_before   => 'div#primary',
+  :text            => '<%= javascript "foreman_remote_execution/execution_interface" %>')
 
-Deface::Override.new(:virtual_path  => 'nic/_base_form',
-                     :name          => 'add_execution_interface',
-                     :insert_after  => 'erb[loud]:contains("interface_provision")',
-                     :partial       => 'overrides/nics/execution_interface')
+Deface::Override.new(:virtual_path => 'nic/_base_form',
+  :name          => 'add_execution_interface',
+  :insert_after  => 'erb[loud]:contains("interface_provision")',
+  :partial       => 'overrides/nics/execution_interface')

data/app/overrides/subnet_proxies.rb

@@ -1,9 +1,9 @@
 Deface::Override.new(:virtual_path => 'subnets/_form',
-                     :name => 'add_remote_execution_proxies_tab',
-                     :insert_after => 'li.active',
-                     :partial => 'overrides/subnets/rex_tab')
+  :name => 'add_remote_execution_proxies_tab',
+  :insert_after => 'li.active',
+  :partial => 'overrides/subnets/rex_tab')
 
 Deface::Override.new(:virtual_path => 'subnets/_form',
-                     :name => 'add_remote_execution_proxies_tab_pane',
-                     :insert_after => 'div#proxies',
-                     :partial => 'overrides/subnets/rex_tab_pane')
+  :name => 'add_remote_execution_proxies_tab_pane',
+  :insert_after => 'div#proxies',
+  :partial => 'overrides/subnets/rex_tab_pane')

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

@@ -21,7 +21,7 @@
     <% @job_invocations.each do |invocation| %>
       <tr>
         <td class="text_warp"><%= link_to_if_authorized invocation_description(invocation), hash_for_job_invocation_path(invocation).merge(:auth_object => invocation, :permission => :view_job_invocations, :authorizer => authorizer) %></td>
-        <td><%= trunc_with_tooltip(invocation&.targeting&.search_query, 15) %></td>
+        <td><%= trunc_with_tooltip(invocation.targeting.search_query, 15) %></td>
         <td><%= link_to_invocation_task_if_authorized(invocation) %></td>
         <td><%= invocation_result(invocation, :success_count) %></td>
         <td><%= invocation_result(invocation, :failed_count) %></td>

data/app/views/templates/ssh/module_action.erb

@@ -29,6 +29,7 @@ template_inputs:
   input_type: user
   required: false
   advanced: true
+feature: katello_module_stream_action
 %>
 
 <%

data/app/views/templates/ssh/puppet_run_once.erb

@@ -10,6 +10,7 @@ template_inputs:
   description: Additional options to pass to puppet
   input_type: user
   required: false
+feature: puppet_run_host
 %>
 <% if @host.operatingsystem.family == 'Debian' -%>
 export PATH=/opt/puppetlabs/bin:$PATH

data/config/routes.rb

@@ -44,6 +44,7 @@ Rails.application.routes.draw do
   end
   get 'cockpit/redirect', to: 'cockpit#redirect'
   get 'ui_job_wizard/categories', to: 'ui_job_wizard#categories'
+  get 'ui_job_wizard/template/:id', to: 'ui_job_wizard#template'
 
   match '/experimental/job_wizard', to: 'react#index', :via => [:get]
 

data/db/migrate/20180110104432_rename_template_invocation_permission.rb

@@ -16,7 +16,7 @@ class RenameTemplateInvocationPermission < ActiveRecord::Migration[4.2]
     return if old_permission.nil?
 
     new_permission = Permission.find_or_create_by(:name => new,
-                                                  :resource_type => 'TemplateInvocation')
+      :resource_type => 'TemplateInvocation')
     old_permission.filterings.each do |filtering|
       filtering.permission_id = new_permission.id
       filtering.save!

data/db/migrate/20190111153330_remove_remote_execution_without_proxy_setting.rb

@@ -5,9 +5,9 @@ class RemoveRemoteExecutionWithoutProxySetting < ActiveRecord::Migration[5.2]
 
   def down
     Setting.create!(:name => 'remote_execution_without_proxy',
-                    :description => N_('When enabled, the remote execution will try to run '\
-                                       'the commands directly, when no proxy with remote execution '\
-                                       'feature is configured for the host.'),
-                    :default => false, :full_name => N_('Fallback Without Proxy'))
+      :description => N_('When enabled, the remote execution will try to run '\
+                         'the commands directly, when no proxy with remote execution '\
+                         'feature is configured for the host.'),
+      :default => false, :full_name => N_('Fallback Without Proxy'))
   end
 end

data/db/migrate/2021051713291621250977_add_host_proxy_invocations.rb

@@ -0,0 +1,12 @@
+class AddHostProxyInvocations < ActiveRecord::Migration[6.0]
+  def change
+    # rubocop:disable Rails/CreateTableWithTimestamps
+    create_table :host_proxy_invocations do |t|
+      t.references :host, :null => false
+      t.references :smart_proxy, :null => false
+    end
+    # rubocop:enable Rails/CreateTableWithTimestamps
+
+    add_index :host_proxy_invocations, [:host_id, :smart_proxy_id], unique: true
+  end
+end

data/extra/cockpit/foreman-cockpit-session

@@ -56,13 +56,13 @@ end
 
 def send_auth_challenge(challenge)
   send_control({ "command" => "authorize",
-                 "cookie" => "1234", # must be present, but value doesn't matter
-                 "challenge" => challenge})
+    "cookie" => "1234", # must be present, but value doesn't matter
+    "challenge" => challenge})
 end
 
 def send_auth_response(response)
   send_control({ "command" => "authorize",
-                 "response" => response})
+    "response" => response})
 end
 
 def read_auth_reply
@@ -76,9 +76,9 @@ end
 def exit_with_problem(problem, message, auth_methods)
   LOG.error("#{problem} - #{message}")
   send_control({ "command" => "init",
-                 "problem" => problem,
-                 "message" => message,
-                 "auth-method-results" => auth_methods})
+    "problem" => problem,
+    "message" => message,
+    "auth-method-results" => auth_methods})
   exit 1
 end
 

data/lib/foreman_remote_execution/engine.rb

@@ -51,14 +51,13 @@ module ForemanRemoteExecution
 
     initializer 'foreman_remote_execution.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_remote_execution do
-        register_global_js_file 'global'
         requires_foreman '>= 2.2'
+        register_global_js_file 'global'
 
         apipie_documented_controllers ["#{ForemanRemoteExecution::Engine.root}/app/controllers/api/v2/*.rb"]
         ApipieDSL.configuration.dsl_classes_matchers += [
           "#{ForemanRemoteExecution::Engine.root}/app/lib/foreman_remote_execution/renderer/**/*.rb",
         ]
-        register_global_js_file 'global'
         automatic_assets(false)
         precompile_assets(*assets_to_precompile)
 
@@ -68,7 +67,7 @@ module ForemanRemoteExecution
                                             :'api/v2/job_templates' => [:index, :show, :revision, :export],
                                             :'api/v2/template_inputs' => [:index, :show],
                                             :'api/v2/foreign_input_sets' => [:index, :show],
-                                            :ui_job_wizard => [:categories]}, :resource_type => 'JobTemplate'
+                                            :ui_job_wizard => [:categories, :template]}, :resource_type => 'JobTemplate'
           permission :create_job_templates, { :job_templates => [:new, :create, :clone_template, :import],
                                               :'api/v2/job_templates' => [:create, :clone, :import] }, :resource_type => 'JobTemplate'
           permission :edit_job_templates, { :job_templates => [:edit, :update],
@@ -141,7 +140,7 @@ module ForemanRemoteExecution
           url_hash: { controller: 'job_wizard', action: :index },
           caption: N_('Job wizard'),
           parent: :lab_features_menu,
-          url: 'experimental/job_wizard',
+          url: '/experimental/job_wizard',
           after: :host_wizard
 
         register_custom_status HostStatus::ExecutionStatus
@@ -163,9 +162,15 @@ module ForemanRemoteExecution
 
         # Extend Registration module
         extend_allowed_registration_vars :remote_execution_interface
-        register_global_js_file 'fills'
         ForemanTasks.dynflow.eager_load_actions!
-        extend_observable_events(::Dynflow::Action.descendants.select { |klass| klass <= ::Actions::ObservableAction }.map(&:namespaced_event_names))
+        extend_observable_events(
+          ::Dynflow::Action.descendants.select do |klass|
+            klass <= ::Actions::ObservableAction
+          end.map(&:namespaced_event_names) +
+          RemoteExecutionFeature.all.pluck(:label).map do |label|
+            ::Actions::RemoteExecution::RunHostJob.feature_job_event_name(label)
+          end
+        )
       end
     end
 
@@ -196,12 +201,10 @@ module ForemanRemoteExecution
 
       Host::Managed.prepend ForemanRemoteExecution::HostExtensions
       Host::Managed.include ForemanTasks::Concerns::HostActionSubject
-      Host::Managed.include ForemanRemoteExecution::Orchestration::SSH
 
       (Nic::Base.descendants + [Nic::Base]).each do |klass|
         klass.send(:include, ForemanRemoteExecution::NicExtensions)
       end
-      Nic::Managed.include ForemanRemoteExecution::Orchestration::SSH
 
       Bookmark.include ForemanRemoteExecution::BookmarkExtensions
       HostsHelper.prepend ForemanRemoteExecution::HostsHelperExtensions

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '4.4.0'.freeze
+  VERSION = '4.5.3'.freeze
 end

data/package.json

@@ -29,7 +29,8 @@
     "babel-eslint": "^10.0.0",
     "eslint": "^6.8.0",
     "prettier": "^1.19.1",
-    "@patternfly/react-catalog-view-extension": "^4.8.126"
+    "@patternfly/react-catalog-view-extension": "^4.8.126",
+    "redux-mock-store": "^1.2.2"
   },
   "peerDependencies": {
     "@theforeman/vendor": "^8.3.0"

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

@@ -114,11 +114,24 @@ module Api
             assert_response :success
           end
 
-          test 'search_query' do
+          test 'host ids as search_query' do
             @attrs[:host_ids] = 'name = testfqdn'
             post :create, params: { job_invocation: @attrs }
             assert_response :success
           end
+
+          test 'with search_query param' do
+            @attrs[:targeting_type] = 'static_query'
+            @attrs[:search_query] = 'name = testfqdn'
+            post :create, params: { job_invocation: @attrs }
+            assert_response :success
+          end
+
+          test 'with job_template_id param' do
+            @attrs[:job_template_id] = 12_345
+            post :create, params: { job_invocation: @attrs }
+            assert_response :error
+          end
         end
       end