foreman_remote_execution 4.3.0 → 4.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f170eb66eb23ab9e671ff1137c9ca830041743eb83836947cf11da32432f119d
-  data.tar.gz: 0f4d52cce40bc8c9f89eb4e65242b1e3a25e4d0ce5ba9cf24b5fc9ff23346267
+  metadata.gz: e6f79124fa44d1ce9756c7c680a43ea7c9c1d309836641e4f1d91fe713a75fdb
+  data.tar.gz: 1db640940ff3ba7a44b183c017ee0c1c3262e5263553365e930695b5f1686b8e
 SHA512:
-  metadata.gz: 5964ee1b1bc9b3983f6f2677f9e38dbaf41416d16ace8ee1dcfc43f63d7250154b62722b191cc62b2b29c073d8035e0f813d5e576db167b05b1a2ea56cef6ce4
-  data.tar.gz: 3cf702ec56abf119a67f6bbbd1a0d2b6b2dbb067ee99ea31735d2b5bcedc87b194d992e48ffcfe8848799cc16eb872623523d73d16b5f8e6ddd8d47400d51e80
+  metadata.gz: 9c105b218161cc5e509c5da55ca76d339d37d217e318aff139609361ece08ff0fa36c0b70fbb41e0c2bfac2633c86218fd4539e762e1c4f0e1ed49dc778ec728
+  data.tar.gz: 9d148bc9b8af5f27c6b5bb91d8e28ea27bbff870ce1239a2e87413d5cf49b5740ccad18f713f22a1d348ff5fe185bdef015dd2bbd1b85f2efe802547e88fe193

data/app/controllers/api/v2/job_invocations_controller.rb

@@ -64,24 +64,31 @@ module Api
           param :description_format, String, :required => false, :desc => N_('Override the description format from the template for this invocation only')
           param :execution_timeout_interval, Integer, :required => false, :desc => N_('Override the timeout interval from the template for this invocation only')
           param :feature, String, :required => false, :desc => N_('Remote execution feature label that should be triggered, job template assigned to this feature will be used')
+
+          RemoteExecutionProvider.providers.each_value do |provider|
+            next if !provider.respond_to?(:provider_inputs_doc) || provider.provider_inputs_doc.empty?
+            doc = provider.provider_inputs_doc
+            param doc[:namespace], Hash, doc[:opts] do
+              doc[:children].map do |input|
+                param input[:name], input[:type], input[:opts]
+              end
+            end
+          end
         end
       end
 
       api :POST, '/job_invocations/', N_('Create a job invocation')
       param_group :job_invocation, :as => :create
       def create
-        if job_invocation_params[:feature].present?
-          composer = composer_for_feature
-        else
-          validate_template
-          composer = JobInvocationComposer.from_api_params(
-            job_invocation_params
-          )
-        end
+        composer = JobInvocationComposer.from_api_params(
+          job_invocation_params
+        )
         composer.trigger!
         @job_invocation = composer.job_invocation
         @hosts = @job_invocation.targeting.hosts
         process_response @job_invocation
+      rescue JobInvocationComposer::JobTemplateNotFound, JobInvocationComposer::FeatureNotFound => e
+        not_found(error: { message: e.message })
       end
 
       api :GET, '/job_invocations/:id/hosts/:host_id', N_('Get output for a host')
@@ -118,7 +125,7 @@ module Api
           render :json => { :cancelled => result, :id => @job_invocation.id }
         else
           render :json => { :message => _('The job could not be cancelled.') },
-                 :status => :unprocessable_entity
+            :status => :unprocessable_entity
         end
       end
 
@@ -133,7 +140,7 @@ module Api
           process_response @job_invocation
         else
           render :json => { :error => _('Could not rerun job %{id} because its template could not be found') % { :id => composer.reruns } },
-                 :status => :not_found
+            :status => :not_found
         end
       end
 
@@ -180,30 +187,28 @@ module Api
         not_found({ :error => { :message => (_("Host with id '%{id}' was not found") % { :id => params['host_id'] }) } })
       end
 
-      def validate_template
-        JobTemplate.authorized(:view_job_templates).find(job_invocation_params['job_template_id'])
-      rescue ActiveRecord::RecordNotFound
-        not_found({ :error => { :message => (_("Template with id '%{id}' was not found") % { :id => job_invocation_params['job_template_id'] }) } })
-      end
-
       def job_invocation_params
         return @job_invocation_params if @job_invocation_params.present?
 
         job_invocation_params = params.fetch(:job_invocation, {}).dup
+
+        if job_invocation_params[:feature].present? && job_invocation_params[:job_template_id].present?
+          raise _("Only one of feature or job_template_id can be specified")
+        end
+
         if job_invocation_params.key?(:ssh)
           job_invocation_params.merge!(job_invocation_params.delete(:ssh).permit(:effective_user))
         end
+
         job_invocation_params[:inputs] ||= {}
         job_invocation_params[:inputs].permit!
+        permit_provider_inputs job_invocation_params
         @job_invocation_params = job_invocation_params
       end
 
-      def composer_for_feature
-        JobInvocationComposer.for_feature(
-          job_invocation_params[:feature],
-          job_invocation_params[:host_ids],
-          job_invocation_params[:inputs].to_hash
-        )
+      def permit_provider_inputs(invocation_params)
+        providers = RemoteExecutionProvider.providers.values.reject { |provider| !provider.respond_to?(:provider_input_namespace) || provider.provider_input_namespace.empty? }
+        providers.each { |provider| invocation_params[provider.provider_input_namespace]&.permit! }
       end
 
       def output_lines_since(task, time)

data/app/controllers/foreman_remote_execution/concerns/api/v2/registration_commands_controller_extensions.rb

@@ -0,0 +1,19 @@
+module ForemanRemoteExecution
+  module Concerns
+    module Api
+      module V2
+        module RegistrationCommandsControllerExtensions
+          module ApipieExtensions
+            extend Apipie::DSL::Concern
+
+            update_api(:create) do
+              param :registration_command, Hash do
+                param :remote_execution_interface, String, desc: N_("Identifier of the Host interface for Remote execution")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/job_invocations_controller.rb

@@ -67,7 +67,7 @@ class JobInvocationsController < ApplicationController
   end
 
   def index
-    @job_invocations = resource_base_search_and_page.with_task.order('job_invocations.id DESC')
+    @job_invocations = resource_base_search_and_page.preload(:task, :targeting).order('job_invocations.id DESC')
   end
 
   # refreshes the form

data/app/controllers/job_templates_controller.rb

@@ -24,10 +24,10 @@ class JobTemplatesController < ::TemplatesController
       render :plain => output
     else
       render status: :not_acceptable,
-             plain: _(
-               'Problem with previewing the template: %{error}. Note that you must save template input changes before you try to preview it.' %
-               {:error => renderer.error_message}
-             )
+        plain: _(
+          'Problem with previewing the template: %{error}. Note that you must save template input changes before you try to preview it.' %
+          {:error => renderer.error_message}
+        )
     end
   end
 

data/app/controllers/ui_job_wizard_controller.rb

@@ -8,6 +8,18 @@ class UiJobWizardController < ::Api::V2::BaseController
     render :json => {:job_categories =>job_categories}
   end
 
+  def template
+    job_template = JobTemplate.authorized.find(params[:id])
+    render :json => {
+      :job_template => job_template,
+      :effective_user => job_template.effective_user,
+    }
+  end
+
+  def resource_name(nested_resource = nil)
+    nested_resource || 'job_template'
+  end
+
   def resource_class
     JobTemplate
   end

data/app/helpers/job_invocations_helper.rb

@@ -34,8 +34,8 @@ module JobInvocationsHelper
     hosts.map do |host|
       collapsed_preview(host) +
         render(:partial => 'job_invocations/user_input',
-               :locals => { :template_invocation => template_invocation,
-                            :target => host })
+          :locals => { :template_invocation => template_invocation,
+                       :target => host })
     end.reduce(:+)
   end
 

data/app/helpers/remote_execution_helper.rb

@@ -27,19 +27,19 @@ module RemoteExecutionHelper
 
     if authorized_for(hash_for_host_path(host).merge(auth_object: host, permission: :view_hosts, authorizer: job_hosts_authorizer))
       links << { title: _('Host detail'),
-                 action: { href: host_path(host), 'data-method': 'get', id: "#{host.name}-actions-detail" } }
+        action: { href: host_path(host), 'data-method': 'get', id: "#{host.name}-actions-detail" } }
     end
 
     if authorized_for(hash_for_rerun_job_invocation_path(id: job_invocation, host_ids: [ host.id ], authorizer: job_hosts_authorizer))
       links << { title: (_('Rerun on %s') % host.name),
-                 action: { href: rerun_job_invocation_path(job_invocation, host_ids: [ host.id ]),
-                           'data-method': 'get', id: "#{host.name}-actions-rerun" } }
+        action: { href: rerun_job_invocation_path(job_invocation, host_ids: [ host.id ]),
+                  'data-method': 'get', id: "#{host.name}-actions-rerun" } }
     end
 
     if host_task.present? && authorized_for(hash_for_foreman_tasks_task_path(host_task).merge(auth_object: host_task, permission: :view_foreman_tasks))
       links << { title: _('Host task'),
-                 action: { href: foreman_tasks_task_path(host_task),
-                           'data-method': 'get', id: "#{host.name}-actions-task" } }
+        action: { href: foreman_tasks_task_path(host_task),
+                  'data-method': 'get', id: "#{host.name}-actions-task" } }
     end
 
     links
@@ -60,6 +60,12 @@ module RemoteExecutionHelper
     job_invocation = task.task_groups.find { |group| group.class == JobInvocationTaskGroup }.job_invocation
     task_authorizer = Authorizer.new(User.current, :collection => [task])
     buttons = []
+    if (template = job_report_template) && authorized_for(controller: :report_templates, action: :generate)
+      buttons << link_to(_('Create Report'), generate_report_template_path(template, job_report_template_parameters(job_invocation, template)),
+        class: 'btn btn-default',
+        title: _('Create report for this job'),
+        disabled: task.pending?)
+    end
     if authorized_for(hash_for_new_job_invocation_path)
       buttons << link_to(_('Rerun'), rerun_job_invocation_path(:id => job_invocation.id),
         :class => 'btn btn-default',
@@ -153,11 +159,11 @@ module RemoteExecutionHelper
       content_tag :pre, preview
     elsif target.nil?
       alert :text => _('Could not render the preview because no host matches the search query.'),
-            :class => 'alert alert-block alert-warning base',
-            :close => false
+        :class => 'alert alert-block alert-warning base',
+        :close => false
     else
       alert :class => 'alert-block alert-danger base in fade has-error',
-            :text => renderer.error_message.html_safe # rubocop:disable Rails/OutputSafety
+        :text => renderer.error_message.html_safe # rubocop:disable Rails/OutputSafety
     end
   end
 
@@ -230,6 +236,27 @@ module RemoteExecutionHelper
     task.execution_plan.actions[1].try(:input).try(:[], 'script')
   end
 
+  def job_report_template
+    template = ReportTemplate.where(name: Setting['remote_execution_job_invocation_report_template']).first
+
+    template if template.template_inputs.where(name: 'job_id').exists?
+  end
+
+  def job_report_template_parameters(job_invocation, template)
+    template_input = template.template_inputs.where(name: 'job_id').first
+    raise "#job_report_template_parameters need template that has 'job_id' input" unless template_input
+
+    {
+      report_template_report: {
+        input_values: {
+          "#{template_input.id}": {
+            value: job_invocation.id,
+          },
+        },
+      },
+    }
+  end
+
   def targeting_hosts(job_invocation, hosts)
     hosts.map do |host|
       template_invocation = job_invocation.template_invocations.find { |template_inv| template_inv.host_id == host.id }

data/app/lib/actions/remote_execution/run_host_job.rb

@@ -5,6 +5,8 @@ module Actions
       include ::Actions::Helpers::WithDelegatedAction
       include ::Actions::ObservableAction
 
+      execution_plan_hooks.use :emit_feature_event, :on => :success
+
       middleware.do_not_use Dynflow::Middleware::Common::Transaction
       middleware.use Actions::Middleware::HideSecrets
 
@@ -17,7 +19,12 @@ module Actions
       end
 
       def plan(job_invocation, host, template_invocation, proxy_selector = ::RemoteExecutionProxySelector.new, options = {})
-        action_subject(host, :job_category => job_invocation.job_category, :description => job_invocation.description, :job_invocation_id => job_invocation.id)
+        features = template_invocation.template.remote_execution_features.pluck(:label).uniq
+        action_subject(host,
+          :job_category => job_invocation.job_category,
+          :description => job_invocation.description,
+          :job_invocation_id => job_invocation.id,
+          :job_features => features)
 
         template_invocation.host_id = host.id
         template_invocation.run_host_job_task_id = task.id
@@ -40,12 +47,16 @@ module Actions
         script = renderer.render
         raise _('Failed rendering template: %s') % renderer.error_message unless script
 
+        first_execution = host.executed_through_proxies.where(:id => proxy.id).none?
+        host.executed_through_proxies << proxy if first_execution
+
         additional_options = { :hostname => provider.find_ip_or_hostname(host),
                                :script => script,
                                :execution_timeout_interval => job_invocation.execution_timeout_interval,
                                :secrets => secrets(host, job_invocation, provider),
                                :use_batch_triggering => true,
-                               :use_concurrency_control => options[:use_concurrency_control]}
+                               :use_concurrency_control => options[:use_concurrency_control],
+                               :first_execution => first_execution }
         action_options = provider.proxy_command_options(template_invocation, host)
                                  .merge(additional_options)
 
@@ -58,6 +69,22 @@ module Actions
         check_exit_status
       end
 
+      def self.feature_job_event_name(label, suffix = :success)
+        ::Foreman::Observable.event_name_for("#{::Actions::RemoteExecution::RunHostJob.event_name_base}_#{label}_#{::Actions::RemoteExecution::RunHostJob.event_name_suffix(suffix)}")
+      end
+
+      def emit_feature_event(execution_plan, hook = :success)
+        return unless root_action?
+
+        payload = event_payload(execution_plan)
+        if input["job_features"]&.any?
+          input['job_features'].each do |feature|
+            name = "#{self.class.event_name_base}_#{feature}_#{self.class.event_name_suffix(hook)}"
+            trigger_hook name, payload: payload
+          end
+        end
+      end
+
       def secrets(host, job_invocation, provider)
         job_secrets = { :ssh_password => job_invocation.password,
                         :key_passphrase => job_invocation.key_passphrase,
@@ -78,7 +105,7 @@ module Actions
 
       def humanized_input
         N_('%{description} on %{host}') % { :host => input[:host].try(:[], :name),
-                                            :description => input[:description].try(:capitalize) || input[:job_category] }
+          :description => input[:description].try(:capitalize) || input[:job_category] }
       end
 
       def humanized_name
@@ -186,10 +213,13 @@ module Actions
             'All %{count} applicable proxies are down. Tried %{proxy_names}',
             offline_proxies.count) % settings
         elsif proxy == :not_defined
-          settings = { :global_proxy => 'remote_execution_global_proxy',
-                       :fallback_proxy => 'remote_execution_fallback_proxy' }
+          settings = {
+            global_proxy: 'remote_execution_global_proxy',
+            fallback_proxy: 'remote_execution_fallback_proxy',
+            provider: provider,
+          }
 
-          raise _('Could not use any proxy. Consider configuring %{global_proxy}, ' +
+          raise _('Could not use any proxy for the %{provider} job. Consider configuring %{global_proxy}, ' +
                   '%{fallback_proxy} in settings') % settings
         end
         proxy
@@ -199,7 +229,7 @@ module Actions
       apipie :class, "An action representing execution of a job against a host" do
         name 'Actions::RemoteExecution::RunHostJob'
         refs 'Actions::RemoteExecution::RunHostJob'
-        sections only: %w[webhooks]
+        sections only: %w[all webhooks]
         property :task, object_of: 'Task', desc: 'Returns the task to which this action belongs'
         property :host_name, String, desc: "Returns the name of the host"
         property :host_id, Integer, desc: "Returns the id of the host"

data/app/lib/foreman_remote_execution/provider_input.rb

@@ -0,0 +1,29 @@
+module ForemanRemoteExecution
+  class ProviderInput
+    attr_reader :name, :label, :description, :options, :value_type, :required
+    attr_accessor :value
+
+    def initialize(name:, label:, value:, description: nil, options: nil, value_type: nil, required: false, hidden: false)
+      @name = name
+      @label = label
+      @value = value
+      @description = description
+      @options = options
+      @value_type = value_type
+      @required = required
+      @hidden = hidden
+    end
+
+    def template_input
+      self
+    end
+
+    def hidden_value?
+      @hidden
+    end
+
+    def options_array
+      options.blank? ? [] : options.split(/\r?\n/).map(&:strip)
+    end
+  end
+end

data/app/lib/foreman_remote_execution/renderer/scope/input.rb

@@ -6,6 +6,7 @@ module ForemanRemoteExecution
         extend ApipieDSL::Class
 
         attr_reader :template, :host, :invocation, :input_template_instance, :current_user
+        attr_accessor :error_message
         delegate :input, to: :input_template_instance
 
         apipie :class, 'Macros related to template rendering' do

data/app/models/concerns/foreman_remote_execution/host_extensions.rb

@@ -6,17 +6,19 @@ module ForemanRemoteExecution
         has_many :template_invocations, :dependent => :destroy, :foreign_key => 'host_id'
         has_one :execution_status_object, :class_name => 'HostStatus::ExecutionStatus', :foreign_key => 'host_id', :dependent => :destroy
         has_many :run_host_job_tasks, :through => :template_invocations
+        has_many :host_proxy_invocations, :foreign_key => 'host_id', :dependent => :destroy
+        has_many :executed_through_proxies, :through => :host_proxy_invocations, :source => 'smart_proxy'
 
         scoped_search :relation => :run_host_job_tasks, :on => :result, :rename => 'job_invocation.result',
-                      :ext_method => :search_by_job_invocation,
-                      :only_explicit => true,
-                      :complete_value => TemplateInvocation::TaskResultMap::REVERSE_MAP
+          :ext_method => :search_by_job_invocation,
+          :only_explicit => true,
+          :complete_value => TemplateInvocation::TaskResultMap::REVERSE_MAP
 
         scoped_search :relation => :template_invocations, :on => :job_invocation_id,
-                      :rename => 'job_invocation.id', :only_explicit => true, :ext_method => :search_by_job_invocation
+          :rename => 'job_invocation.id', :only_explicit => true, :ext_method => :search_by_job_invocation
 
         scoped_search :relation => :execution_status_object, :on => :status, :rename => :execution_status,
-                      :complete_value => { :ok => HostStatus::ExecutionStatus::OK, :error => HostStatus::ExecutionStatus::ERROR }
+          :complete_value => { :ok => HostStatus::ExecutionStatus::OK, :error => HostStatus::ExecutionStatus::ERROR }
 
         def search_by_job_invocation(key, operator, value)
           if key == 'job_invocation.result'

data/app/models/concerns/foreman_remote_execution/smart_proxy_extensions.rb

@@ -1,5 +1,11 @@
 module ForemanRemoteExecution
   module SmartProxyExtensions
+    def self.prepended(base)
+      base.instance_eval do
+        has_many :host_proxy_invocations, :dependent => :destroy
+      end
+    end
+
     def pubkey
       self[:pubkey] || update_pubkey
     end

data/app/models/host_proxy_invocation.rb

@@ -0,0 +1,4 @@
+class HostProxyInvocation < ApplicationRecord
+  belongs_to :host, :class_name => 'Host::Managed', :inverse_of => :host_proxy_invocations
+  belongs_to :smart_proxy
+end