foreman_remote_execution 4.6.0 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14dc89216ec220750d38149b86e0ecded26e13d99678505302a5a157b0c7c9e2
-  data.tar.gz: b2091af78be3ed0fec0d5acea056a49e601e6d1ef96954c49976fd1c0da39ecb
+  metadata.gz: 742978171c8d62de9fdf9e14b2be742235dc1cce90c0c522871d65a90ee1f612
+  data.tar.gz: caae67492773457e26461ae6e39addec2cc1b105bf387a9cf0dbfc667ad25102
 SHA512:
-  metadata.gz: 10d901fec16519db44d05d9b9ecb2b15923e1a2e439f1e0032778b9272ed4c48a446436b4ef7375bb5113f8067d5596035b5a7fa593a522fc37e56a472d51c31
-  data.tar.gz: cb7686bf72b55bf65bbd35cee82910925f12b9dd29ec573dc96bb340fb1cc629833a80239e96317dcef2163d17d00ba93db92f5f50a10c5a4f4363d77647f729
+  metadata.gz: e40d5600dbe09f3ea875179a3ac44a4046ffd8615efe5c88f364828e7bd21b24d2d2a7f5f8ea09954f2f00056bc6d867efc22f7b82b0189de766f225101ae896
+  data.tar.gz: 6875df7248f14be5a915f7b3001cd6d4a50476f84824b0118747d4ba7b2993b977cf85cfe5f9cdde8706b2d2cb4fea20c1770988405adebf09683cc966ba9e70

data/.github/workflows/ruby_ci.yml

@@ -71,3 +71,10 @@ jobs:
         run: |
           bundle exec rake test:foreman_remote_execution
           bundle exec rake test TEST="test/unit/foreman/access_permissions_test.rb"
+      - name: 'Upload logs'
+        uses: actions/upload-artifact@v2
+        if: failure()
+        with:
+          name: logs
+          path: log/*.log
+          retention-days: 5

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/ui_job_wizard_controller.rb

@@ -10,9 +10,12 @@ class UiJobWizardController < ::Api::V2::BaseController
 
   def template
     job_template = JobTemplate.authorized.find(params[:id])
+    advanced_template_inputs, template_inputs = map_template_inputs(job_template.template_inputs_with_foreign).partition { |x| x["advanced"] }
     render :json => {
       :job_template => job_template,
       :effective_user => job_template.effective_user,
+      :template_inputs => template_inputs,
+      :advanced_template_inputs => advanced_template_inputs,
     }
   end
 
@@ -20,6 +23,10 @@ class UiJobWizardController < ::Api::V2::BaseController
     nested_resource || 'job_template'
   end
 
+  def map_template_inputs(template_inputs_with_foreign)
+    template_inputs_with_foreign.map { |input| input.attributes.merge({:resource_type => input.resource_type&.tableize }) }
+  end
+
   def resource_class
     JobTemplate
   end

data/app/graphql/types/job_invocation.rb

@@ -0,0 +1,16 @@
+module Types
+  class JobInvocation < BaseObject
+    description 'A Job Invocation'
+
+    global_id_field :id
+    field :job_category, String
+    field :description, String
+    field :time_span, Integer
+    field :start_at, GraphQL::Types::ISO8601DateTime
+    field :status_label, String
+
+    belongs_to :triggering, Types::Triggering
+    belongs_to :task, Types::Task
+    field :recurring_logic, Types::RecurringLogic
+  end
+end

data/app/helpers/concerns/foreman_remote_execution/hosts_helper_extensions.rb

@@ -7,7 +7,9 @@ module ForemanRemoteExecution
     end
 
     def multiple_actions
-      super + [ [_('Schedule Remote Job'), new_job_invocation_path, false] ]
+      res = super
+      res += [ [_('Schedule Remote Job'), new_job_invocation_path, false] ] if authorized_for(controller: :job_invocations, action: :new)
+      res
     end
 
     def schedule_job_multi_button(*args)
@@ -21,12 +23,14 @@ module ForemanRemoteExecution
     end
 
     def rex_host_features(*args)
+      return unless authorized_for(controller: :job_invocations, action: :create)
       RemoteExecutionFeature.with_host_action_button.order(:label).map do |feature|
         link_to(_('%s') % feature.name, job_invocations_path(:host_ids => [args.first.id], :feature => feature.label), :method => :post)
       end
     end
 
     def schedule_job_button(*args)
+      return unless authorized_for(controller: :job_invocations, action: :new)
       link_to(_('Schedule Remote Job'), new_job_invocation_path(:host_ids => [args.first.id]), :id => :run_button, :class => 'btn btn-default')
     end
 

data/app/helpers/remote_execution_helper.rb

@@ -7,6 +7,10 @@ module RemoteExecutionHelper
     @job_hosts_authorizer ||= Authorizer.new(User.current, :collection => @hosts)
   end
 
+  def host_tasks_authorizer
+    @host_tasks_authorizer ||= Authorizer.new(User.current, :collection => @job_invocation.sub_tasks)
+  end
+
   def host_counter(label, count)
     content_tag(:div, :class => 'host_counter') do
       content_tag(:div, label, :class => 'header') + content_tag(:div, count.to_s, :class => 'count')
@@ -36,7 +40,7 @@ module RemoteExecutionHelper
                   '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))
+    if host_task.present? && authorized_for(hash_for_foreman_tasks_task_path(host_task).merge(auth_object: host_task, permission: :view_foreman_tasks, authorizer: host_tasks_authorizer))
       links << { title: _('Host task'),
         action: { href: foreman_tasks_task_path(host_task),
                   'data-method': 'get', id: "#{host.name}-actions-task" } }
@@ -109,12 +113,14 @@ module RemoteExecutionHelper
         :class => 'btn btn-danger',
         :title => _('Try to cancel the job on a host'),
         :disabled => !task.cancellable?,
-        :method => :post)
+        :method => :post,
+        :remote => true)
       buttons << link_to(_('Abort Job'), abort_foreman_tasks_task_path(task),
         :class => 'btn btn-danger',
         :title => _('Try to abort the job on a host without waiting for its result'),
         :disabled => !task.cancellable?,
-        :method => :post)
+        :method => :post,
+        :remote => true)
     end
     buttons
   end

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

@@ -47,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)
 

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

@@ -72,7 +72,7 @@ module Actions
 
       def total_count
         # For compatibility with already existing tasks
-        return output[:total_count] unless output.has_key?(:host_count) || task.pending?
+        return output[:total_count] || hosts.count unless output.has_key?(:host_count) || task.pending?
 
         output[:host_count] || hosts.count
       end

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

@@ -6,6 +6,8 @@ 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,

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

data/app/models/host_status/execution_status.rb

@@ -64,11 +64,11 @@ class HostStatus::ExecutionStatus < HostStatus::Status
 
       case status
         when OK
-          [ "foreman_tasks_tasks.state = 'stopped' AND result = 'success'" ]
+          [ "foreman_tasks_tasks.state = 'stopped' AND foreman_tasks_tasks.result = 'success'" ]
         when CANCELLED
-          [ "foreman_tasks_tasks.state = 'stopped' AND result = 'cancelled'" ]
+          [ "foreman_tasks_tasks.state = 'stopped' AND foreman_tasks_tasks.result = 'cancelled'" ]
         when ERROR
-          [ "foreman_tasks_tasks.state = 'stopped' AND (result = 'error' OR result = 'warning')" ]
+          [ "foreman_tasks_tasks.state = 'stopped' AND (foreman_tasks_tasks.result = 'error' OR foreman_tasks_tasks.result = 'warning')" ]
         when QUEUED
           [ "foreman_tasks_tasks.state = 'scheduled' OR foreman_tasks_tasks.state IS NULL" ]
         when RUNNING

data/app/models/job_invocation.rb

@@ -65,8 +65,6 @@ class JobInvocation < ApplicationRecord
   scoped_search :on => 'pattern_template_name', :rename => 'pattern_template_name', :operators => ['= '],
     :complete_value => false, :only_explicit => true, :ext_method => :search_by_pattern_template
 
-  scope :with_task, -> { references(:task) }
-
   scoped_search :relation => :recurring_logic, :on => 'id', :rename => 'recurring_logic.id'
 
   scoped_search :relation => :recurring_logic, :on => 'id', :rename => 'recurring',
@@ -99,7 +97,7 @@ class JobInvocation < ApplicationRecord
   def self.search_by_status(key, operator, value)
     conditions = HostStatus::ExecutionStatus::ExecutionTaskStatusMapper.sql_conditions_for(value)
     conditions[0] = "NOT (#{conditions[0]})" if operator == '<>'
-    { :conditions => sanitize_sql_for_conditions(conditions), :include => :task }
+    { :conditions => sanitize_sql_for_conditions(conditions), :joins => :task }
   end
 
   def self.search_by_recurring_logic(key, operator, value)
@@ -193,11 +191,16 @@ class JobInvocation < ApplicationRecord
   end
 
   def total_hosts_count
+    count = _('N/A')
+
     if targeting.resolved?
-      task&.main_action&.total_count || targeting.hosts.count
-    else
-      _('N/A')
+      count = if task&.main_action.respond_to?(:total_count)
+                task.main_action.total_count
+              else
+                targeting.hosts.count
+              end
     end
+    count
   end
 
   def pattern_template_invocation_for_host(host)

data/app/models/job_invocation_composer.rb

@@ -209,7 +209,7 @@ class JobInvocationComposer
     def format_datetime(datetime)
       return datetime if datetime.blank?
 
-      Time.parse(datetime).strftime('%Y-%m-%d %H:%M')
+      Time.parse(datetime).utc.strftime('%Y-%m-%d %H:%M')
     end
   end
 
@@ -296,7 +296,7 @@ class JobInvocationComposer
     attr_reader :feature_label, :feature, :provided_inputs
 
     def initialize(feature_label, hosts, provided_inputs = {})
-      @feature = RemoteExecutionFeature.feature(feature_label)
+      @feature = RemoteExecutionFeature.feature!(feature_label)
       @provided_inputs = provided_inputs
       translator = HostIdsTranslator.new(hosts)
       @host_bookmark = translator.bookmark
@@ -405,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
 
@@ -513,7 +513,7 @@ class JobInvocationComposer
   end
 
   def available_bookmarks
-    Bookmark.authorized(:view_bookmarks).my_bookmarks.where(:controller => ['hosts', 'dashboard'])
+    Bookmark.my_bookmarks.where(:controller => ['hosts', 'dashboard'])
   end
 
   def targeted_hosts

data/app/models/job_template.rb

@@ -83,7 +83,7 @@ class JobTemplate < ::Template
     end
 
     def acceptable_template_input_types
-      [ :user, :fact, :variable, :puppet_parameter ]
+      [ :user, :fact, :variable ]
     end
 
     def default_render_scope_class

data/app/models/remote_execution_feature.rb

@@ -20,7 +20,11 @@ class RemoteExecutionFeature < ApplicationRecord
   end
 
   def self.feature(label)
-    self.find_by(label: label) || raise(::Foreman::Exception.new(N_('Unknown remote execution feature %s'), label))
+    self.find_by(label: label)
+  end
+
+  def self.feature!(label)
+    feature(label) || raise(::Foreman::Exception.new(N_('Unknown remote execution feature %s'), label))
   end
 
   def self.register(label, name, options = {})

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/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/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/power_action.erb

@@ -13,6 +13,8 @@ template_inputs:
   required: true
 %>
 
+PATH="$PATH:/usr/sbin:/sbin"
+
 echo <%= input('action') %> host && sleep 3
 <%= case input('action')
       when 'restart'

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/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/foreman_remote_execution.gemspec

@@ -16,8 +16,7 @@ Gem::Specification.new do |s|
                   'management functionality with remote management functionality.'
 
   s.files = `git ls-files`.split("\n").reject do |file|
-    file.start_with?('scripts', 'lib/foreman_remote_execution_core') ||
-      file == 'foreman_remote_execution_core.gemspec'
+    file.start_with?('scripts')
   end
 
   s.test_files =       `git ls-files test`.split("\n")
@@ -25,7 +24,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'deface'
   s.add_dependency 'dynflow', '>= 1.0.2', '< 2.0.0'
-  s.add_dependency 'foreman-tasks', '>= 4.1.0'
+  s.add_dependency 'foreman-tasks', '>= 5.0.0'
 
   s.add_development_dependency 'factory_bot_rails', '~> 4.8.0'
   s.add_development_dependency 'rdoc'

data/lib/foreman_remote_execution/engine.rb

@@ -152,6 +152,9 @@ module ForemanRemoteExecution
           ctx.permit :execution
         end
 
+        register_graphql_query_field :job_invocations, '::Types::JobInvocation', :collection_field
+        register_graphql_query_field :job_invocation, '::Types::JobInvocation', :record_field
+
         extend_template_helpers ForemanRemoteExecution::RendererMethods
 
         extend_rabl_template 'api/v2/smart_proxies/main', 'api/v2/smart_proxies/pubkey'
@@ -201,12 +204,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.6.0'.freeze
+  VERSION = '4.7.0'.freeze
 end