foreman_remote_execution 4.1.0 → 4.3.0

data/Gemfile

@@ -2,7 +2,4 @@ source 'http://rubygems.org'
 
 gemspec :name => 'foreman_remote_execution'
 
-gem 'rubocop', '~> 0.80.0'
-gem 'rubocop-minitest'
-gem 'rubocop-performance'
-gem 'rubocop-rails'
+gem 'theforeman-rubocop', '~> 0.1.0.pre'

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

@@ -6,7 +6,7 @@ module Api
 
       before_action :find_optional_nested_object, :only => %w{output raw_output}
       before_action :find_host, :only => %w{output raw_output}
-      before_action :find_resource, :only => %w{show update destroy clone cancel rerun}
+      before_action :find_resource, :only => %w{show update destroy clone cancel rerun outputs}
 
       wrap_parameters JobInvocation, :include => (JobInvocation.attribute_names + [:ssh])
 
@@ -137,6 +137,24 @@ module Api
         end
       end
 
+      api :GET, '/job_invocations/:id/outputs', N_('Get outputs of hosts in a job')
+      param :id, :identifier, :required => true
+      param :search_query, :identifier, :required => false
+      param :since, String, :required => false
+      param :raw, String, :required => false
+      def outputs
+        hosts = @job_invocation.targeting.hosts.authorized(:view_hosts, Host)
+        hosts = hosts.search_for(params['search_query']) if params['search_query']
+        raw = ActiveRecord::Type::Boolean.new.cast params['raw']
+        default_value = raw ? '' : []
+        outputs = hosts.map do |host|
+          host_output(@job_invocation, host, :default => default_value, :since => params['since'], :raw => raw)
+            .merge(host_id: host.id)
+        end
+
+        render :json => { :outputs => outputs }
+      end
+
       private
 
       def allowed_nested_id
@@ -145,7 +163,7 @@ module Api
 
       def action_permission
         case params[:action]
-        when 'output', 'raw_output'
+        when 'output', 'raw_output', 'outputs'
           :view
         when 'cancel'
           :cancel
@@ -196,7 +214,7 @@ module Api
       end
 
       def host_output(job_invocation, host, default: nil, since: nil, raw: false)
-        refresh = true
+        refresh = !job_invocation.finished?
 
         if (task = job_invocation.sub_task_for_host(host))
           refresh = task.pending?

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

@@ -0,0 +1,26 @@
+module ForemanRemoteExecution
+  module Concerns
+    module Api::V2::RegistrationControllerExtensions
+      module ApipieExtensions
+        extend Apipie::DSL::Concern
+
+        update_api(:global, :host) do
+          param :remote_execution_interface, String, desc: N_("Identifier of the Host interface for Remote execution")
+        end
+      end
+
+      extend ActiveSupport::Concern
+
+      def host_setup_extension
+        remote_execution_interface
+        super
+      end
+
+      def remote_execution_interface
+        return unless params['remote_execution_interface'].present?
+
+        @host.set_execution_interface(params['remote_execution_interface'])
+      end
+    end
+  end
+end

data/app/controllers/job_templates_controller.rb

@@ -36,7 +36,7 @@ class JobTemplatesController < ::TemplatesController
 
     @template = JobTemplate.import_raw(contents, :update => Foreman::Cast.to_bool(params[:imported_template][:overwrite]))
     if @template&.save
-      flash[:notice] = _('Job template imported successfully.')
+      flash[:success] = _('Job template imported successfully.')
       redirect_to job_templates_path(:search => "name = \"#{@template.name}\"")
     else
       @template ||= JobTemplate.import_raw(contents, :build_new => true)

data/app/controllers/ui_job_wizard_controller.rb

@@ -0,0 +1,18 @@
+class UiJobWizardController < ::Api::V2::BaseController
+  def categories
+    job_categories = resource_scope
+                     .search_for("job_category ~ \"#{params[:search]}\"")
+                     .select(:job_category).distinct
+                     .reorder(:job_category)
+                     .pluck(:job_category)
+    render :json => {:job_categories =>job_categories}
+  end
+
+  def resource_class
+    JobTemplate
+  end
+
+  def action_permission
+    :view_job_templates
+  end
+end

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

@@ -3,6 +3,7 @@ module Actions
     class RunHostJob < Actions::EntryAction
       include ::Actions::Helpers::WithContinuousOutput
       include ::Actions::Helpers::WithDelegatedAction
+      include ::Actions::ObservableAction
 
       middleware.do_not_use Dynflow::Middleware::Common::Transaction
       middleware.use Actions::Middleware::HideSecrets
@@ -16,7 +17,7 @@ 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)
+        action_subject(host, :job_category => job_invocation.job_category, :description => job_invocation.description, :job_invocation_id => job_invocation.id)
 
         template_invocation.host_id = host.id
         template_invocation.run_host_job_task_id = task.id
@@ -121,6 +122,26 @@ module Actions
         delegated_output[:exit_status]
       end
 
+      def host_id
+        input['host']['id']
+      end
+
+      def host_name
+        input['host']['name']
+      end
+
+      def job_invocation_id
+        input['job_invocation_id']
+      end
+
+      def job_invocation
+        @job_invocation ||= ::JobInvocation.authorized.find(job_invocation_id)
+      end
+
+      def host
+        @host ||= ::Host.authorized.find(host_id)
+      end
+
       private
 
       def update_host_status
@@ -173,6 +194,22 @@ module Actions
         end
         proxy
       end
+
+      extend ApipieDSL::Class
+      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]
+        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"
+        property :host, object_of: 'Host', desc: "Returns the host"
+        property :job_invocation_id, Integer, desc: "Returns the id of the job invocation"
+        property :job_invocation, object_of: 'JobInvocation', desc: "Returns the job invocation"
+      end
+      class Jail < ::Actions::ObservableAction::Jail
+        allow :host_name, :host_id, :host, :job_invocation_id, :job_invocation
+      end
     end
   end
 end

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

@@ -65,8 +65,16 @@ module Actions
         hosts.offset(from).limit(size)
       end
 
+      def initiate
+        output[:host_count] = total_count
+        super
+      end
+
       def total_count
-        output[:total_count] || hosts.count
+        # For compatibility with already existing tasks
+        return output[:total_count] unless output.has_key?(:host_count) || task.pending?
+
+        output[:host_count] || hosts.count
       end
 
       def hosts

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

@@ -44,29 +44,33 @@ module ForemanRemoteExecution
       @execution_status_label ||= get_status(HostStatus::ExecutionStatus).to_label(options)
     end
 
+    # rubocop:disable Naming/MemoizedInstanceVariableName
     def host_params_hash
-      params = super
-      keys = remote_execution_ssh_keys
-      source = 'global'
-      if keys.present?
-        value, safe_value = params.fetch('remote_execution_ssh_keys', {}).values_at(:value, :safe_value).map { |v| [v].flatten.compact }
-        params['remote_execution_ssh_keys'] = {:value => value + keys, :safe_value => safe_value + keys, :source => source}
-      end
-      [:remote_execution_ssh_user, :remote_execution_effective_user_method,
-       :remote_execution_connect_by_ip].each do |key|
-        value = Setting[key]
-        params[key.to_s] = {:value => value, :safe_value => value, :source => source} unless params.key?(key.to_s)
-      end
-      params
+      @cached_rex_host_params_hash ||= extend_host_params_hash(super)
     end
+    # rubocop:enable Naming/MemoizedInstanceVariableName
 
     def execution_interface
       get_interface_by_flag(:execution)
     end
 
+    def set_execution_interface(identifier)
+      if interfaces.find_by(identifier: identifier).nil?
+        msg = (N_("Interface with the '%s' identifier was specified as a remote execution interface, however the interface was not found on the host. If the interface exists, it needs to be created in Foreman during the registration.") % identifier)
+        raise ActiveRecord::RecordNotFound, msg
+      end
+
+      # Only one interface at time can be used for REX, all other must be set to false
+      interfaces.each { |int| int.execution = (int.identifier == identifier) }
+      interfaces.each(&:save!)
+    end
+
     def remote_execution_proxies(provider, authorized = true)
       proxies = {}
-      proxies[:subnet]   = execution_interface.subnet.remote_execution_proxies.with_features(provider) if execution_interface&.subnet
+      proxies[:subnet] = []
+      proxies[:subnet] += execution_interface.subnet6.remote_execution_proxies.with_features(provider) if execution_interface&.subnet6
+      proxies[:subnet] += execution_interface.subnet.remote_execution_proxies.with_features(provider) if execution_interface&.subnet
+      proxies[:subnet].uniq!
       proxies[:fallback] = smart_proxies.with_features(provider) if Setting[:remote_execution_fallback_proxy]
 
       if Setting[:remote_execution_global_proxy]
@@ -102,8 +106,28 @@ module ForemanRemoteExecution
       super(*args)
     end
 
+    def clear_host_parameters_cache!
+      super
+      @cached_rex_host_params_hash = nil
+    end
+
     private
 
+    def extend_host_params_hash(params)
+      keys = remote_execution_ssh_keys
+      source = 'global'
+      if keys.present?
+        value, safe_value = params.fetch('remote_execution_ssh_keys', {}).values_at(:value, :safe_value).map { |v| [v].flatten.compact }
+        params['remote_execution_ssh_keys'] = {:value => value + keys, :safe_value => safe_value + keys, :source => source}
+      end
+      [:remote_execution_ssh_user, :remote_execution_effective_user_method,
+       :remote_execution_connect_by_ip].each do |key|
+        value = Setting[key]
+        params[key.to_s] = {:value => value, :safe_value => value, :source => source} unless params.key?(key.to_s)
+      end
+      params
+    end
+
     def build_required_interfaces(attrs = {})
       super(attrs)
       self.primary_interface.execution = true if self.execution_interface.nil?

data/app/models/foreign_input_set.rb

@@ -4,7 +4,7 @@ class ForeignInputSet < ApplicationRecord
   class CircularDependencyError < Foreman::Exception
   end
 
-  attr_exportable :exclude, :include, :include_all, :template => ->(input_set) { input_set.template.name }
+  attr_exportable :exclude, :include, :include_all, :template => ->(input_set) { input_set.target_template.name }
 
   belongs_to :template
   belongs_to :target_template, :class_name => 'Template'

data/app/models/host_status/execution_status.rb

@@ -49,6 +49,13 @@ class HostStatus::ExecutionStatus < HostStatus::Status
     end
   end
 
+  def status_link
+    job_invocation = last_stopped_task.parent_task.job_invocations.first
+    return nil unless User.current.can?(:view_job_invocations, job_invocation)
+
+    Rails.application.routes.url_helpers.job_invocation_path(job_invocation)
+  end
+
   class ExecutionTaskStatusMapper
     attr_accessor :task
 

data/app/models/job_invocation.rb

@@ -22,6 +22,7 @@ class JobInvocation < ApplicationRecord
   validates :job_category, :presence => true
   validates_associated :targeting, :all_template_invocations
 
+  scoped_search :on => :id, :complete_value => true
   scoped_search :on => :job_category, :complete_value => true
   scoped_search :on => :description, :complete_value => true
 
@@ -240,7 +241,7 @@ class JobInvocation < ApplicationRecord
   end
 
   def finished?
-    !task.pending?
+    !(task.nil? || task.pending?)
   end
 
   def missing_hosts_count

data/app/models/job_invocation_composer.rb

@@ -482,7 +482,7 @@ class JobInvocationComposer
 
   def input_value_for(input)
     invocations = pattern_template_invocations
-    default = TemplateInvocationInputValue.new
+    default = TemplateInvocationInputValue.new(:template_input_id => input.id)
     invocations.map(&:input_values).flatten.detect { |iv| iv.template_input_id == input.id } || default
   end
 

data/app/models/remote_execution_feature.rb

@@ -1,5 +1,5 @@
 class RemoteExecutionFeature < ApplicationRecord
-  VALID_OPTIONS = [:provided_inputs, :description, :host_action_button, :notification_builder].freeze
+  VALID_OPTIONS = [:provided_inputs, :description, :host_action_button, :notification_builder, :proxy_selector_override].freeze
   validates :label, :name, :presence => true, :uniqueness => true
 
   belongs_to :job_template
@@ -24,8 +24,10 @@ class RemoteExecutionFeature < ApplicationRecord
   end
 
   def self.register(label, name, options = {})
+    pending_migrations = ::Foreman::Plugin.registered_plugins[:foreman_remote_execution]&.pending_migrations
     begin
-      return false unless RemoteExecutionFeature.table_exists?
+      # Let's not try to register features if rex is not registered as a plugin
+      return false if pending_migrations || pending_migrations.nil?
     rescue ActiveRecord::NoDatabaseError => e
       # just ignore the problem if DB does not exist yet (rake db:create call)
       return false
@@ -41,6 +43,7 @@ class RemoteExecutionFeature < ApplicationRecord
                    :provided_input_names => options[:provided_inputs],
                    :description => options[:description],
                    :host_action_button => options[:host_action_button],
+                   :proxy_selector_override => options[:proxy_selector_override],
                    :notification_builder => builder }
     # in case DB does not have the attribute created yet but plugin initializer registers the feature, we need to skip this attribute
     attrs = [ :host_action_button, :notification_builder ]

data/app/models/remote_execution_provider.rb

@@ -101,7 +101,12 @@ class RemoteExecutionProvider
 
     # Return a specific proxy selector to use for running a given template
     # Returns either nil to use the default selector or an instance of a (sub)class of ::ForemanTasks::ProxySelector
-    def required_proxy_selector_for(_template)
+    def required_proxy_selector_for(template)
+      if template.remote_execution_features
+                 .where(:proxy_selector_override => ::RemoteExecutionProxySelector::INTERNAL_PROXY)
+                 .any?
+        ::DefaultProxyProxySelector.new
+      end
     end
   end
 end

data/app/services/remote_execution_proxy_selector.rb

@@ -1,4 +1,7 @@
 class RemoteExecutionProxySelector < ::ForemanTasks::ProxySelector
+
+  INTERNAL_PROXY = 'internal'.freeze
+
   def available_proxies(host, provider)
     host.remote_execution_proxies(provider)
   end

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

@@ -35,7 +35,7 @@ child :task do
 end
 
 child @template_invocations do
-  attributes :template_id, :template_name
+  attributes :template_id, :template_name, :host_id
   child :input_values do
     attributes :template_input_name, :template_input_id
     node :value do |iv|

data/app/views/api/v2/registration/_form.html.erb

@@ -0,0 +1,12 @@
+<div class='form-group'>
+  <label class='col-md-2 control-label'>
+    <%= _('Remote Execution Interface') %>
+    <% help = _('Identifier of the Host interface for Remote execution') %>
+    <a rel="popover" data-content="<%= help %>" data-trigger="focus" data-container="body" data-html="true" tabindex="-1">
+      <span class="pficon pficon-info "></span>
+    </a>
+  </label>
+  <div class='col-md-4'>
+    <%= text_field_tag 'remote_execution_interface', params[:remote_execution_interface], class: 'form-control' %>
+  </div>
+</div>

data/app/views/template_invocations/_output_line_set.html.erb

@@ -1,7 +1,7 @@
 <% output_line_set['output'].gsub("\r\n", "\n").sub(/\n\Z/, '').split("\n", -1).each do |line| %>
   <%= content_tag :div, :class => 'line ' + output_line_set['output_type'], :data => { :timestamp => output_line_set['timestamp'] } do %>
 
-    <%= content_tag(:span, (@line_counter += 1).to_s.rjust(4).gsub(' ', '&nbsp;').html_safe + ':', :class => 'counter', :title => (output_line_set['timestamp'] && Time.at(output_line_set['timestamp']))) %>
+    <%= content_tag(:span, (@line_counter += 1).to_s.rjust(4).gsub(' ', '&nbsp;').html_safe + ':', :class => 'counter', :title => (output_line_set['timestamp'] && Time.at(output_line_set['timestamp'].to_f))) %>
     <%= content_tag(:div, colorize_line(line.gsub(JobInvocationOutputHelper::COLOR_PATTERN, '').empty? ? "#{line}\n" : line).html_safe, :class => 'content') %>
   <% end %>
 <% end %>

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

@@ -1,12 +1,16 @@
 <% items = [{ :caption => _('Job invocations'), :url => job_invocations_path },
             { :caption => @template_invocation.job_invocation.description,
-              :url => job_invocation_path(@template_invocation.job_invocation_id) },
-            { :caption => _('Template Invocation for %s') % @template_invocation.host.name }] %>
+              :url => job_invocation_path(@template_invocation.job_invocation_id) }]
 
-<% breadcrumbs(:resource_url => template_invocations_api_job_invocation_path(@template_invocation.job_invocation_id),
+if @host
+  items << { :caption => _('Template Invocation for %s') % @host.name }
+  breadcrumbs(:resource_url => template_invocations_api_job_invocation_path(@template_invocation.job_invocation_id),
                :name_field => 'host_name',
                :switcher_item_url => template_invocation_path(':id'),
                :items => items)
+else
+  breadcrumbs(items: items, switchable: false)
+end
 %>
 
 <% stylesheet 'foreman_remote_execution/foreman_remote_execution' %>
@@ -18,31 +22,34 @@
     <%= button_group(link_to_function(_('Toggle command'), '$("div.preview").toggle()', :class => 'btn btn-default'),
                      link_to_function(_('Toggle STDERR'), '$("div.line.stderr").toggle()', :class => 'btn btn-default'),
                      link_to_function(_('Toggle STDOUT'), '$("div.line.stdout").toggle()', :class => 'btn btn-default'),
-                     link_to_function(_('Toggle DEBUG'), '$("div.line.debug").toggle()', :class => 'btn btn-default')) %>
+                     link_to_function(_('Toggle DEBUG'), '$("div.line.debug").toggle()', :class => 'btn btn-default')) if @host %>
     <%= button_group(template_invocation_task_buttons(@template_invocation_task, @template_invocation.job_invocation)) %>
   </div>
 </div>
+<% if @host %>
+  <h3><%= _('Target: ') %><%= link_to(@host.name, host_path(@host)) %></h3>
 
-<h3><%= _('Target: ') %><%= link_to(@host.name, host_path(@host)) %></h3>
-
-<div class="preview hidden">
-  <%= preview_box(@template_invocation, @host) %>
-</div>
+  <div class="preview hidden">
+    <%= preview_box(@template_invocation, @host) %>
+  </div>
 
-<div class="terminal" data-refresh-url="<%= template_invocation_path(@template_invocation) %>">
-  <% if @error %>
-    <div class="line error"><%= @error %></div>
-  <% else %>
-    <%= link_to_function(_('Scroll to bottom'), '$("html, body").animate({ scrollTop: $(document).height() }, "slow");', :class => 'pull-right scroll-link-bottom') %>
+  <div class="terminal" data-refresh-url="<%= template_invocation_path(@template_invocation) %>">
+    <% if @error %>
+      <div class="line error"><%= @error %></div>
+    <% else %>
+      <%= link_to_function(_('Scroll to bottom'), '$("html, body").animate({ scrollTop: $(document).height() }, "slow");', :class => 'pull-right scroll-link-bottom') %>
 
-    <div class="printable">
-      <%= render :partial => 'output_line_set', :collection => normalize_line_sets(@line_sets) %>
-    </div>
+      <div class="printable">
+        <%= render :partial => 'output_line_set', :collection => normalize_line_sets(@line_sets) %>
+      </div>
 
-    <%= link_to_function(_('Scroll to top'), '$("html, body").animate({ scrollTop: 0 }, "slow");', :class => 'pull-right scroll-link-top') %>
-  <% end %>
-</div>
+      <%= link_to_function(_('Scroll to top'), '$("html, body").animate({ scrollTop: 0 }, "slow");', :class => 'pull-right scroll-link-top') %>
+    <% end %>
+  </div>
 
-<script>
-  <%= render :partial => 'refresh.js' %>
-</script>
+  <script>
+    <%= render :partial => 'refresh.js' %>
+  </script>
+<% else %>
+  <%= _("Could not display data for job invocation.") %>
+<% end %>