foreman_remote_execution 5.1.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 831ec5aca2ec4aaa3df1229f7addd9a968c7c49b0fc49a15253e33d2ab0f5689
-  data.tar.gz: 07a4f17f0d4d694c4b927291ee8e55dafd839cf902a9ef06c79b227fdf65760f
+  metadata.gz: 71b09dd41d7ce39e709e4a45c2c78926d53151ed3625fcf2f4e0d739853cae8e
+  data.tar.gz: d01463507ceb52b52f661fa9a55ce413e2f824d74dfe50958063359f5a6fa8e9
 SHA512:
-  metadata.gz: 75fd11cfe45b5223a2427561c0859c39f19923535283fa919927af9b4ffd67ea56a4c9b791632e73c72c4dff1946f2e1046cb10a1f84ed7dae0e686daff2d90d
-  data.tar.gz: 03557c309e25a902c0def6e7575ad74a02e724482da823b4580f4bbe9b80358eadb2e0781b832f45a2e9101196447edf887476fa79782a3d6ee125640dccd92a
+  metadata.gz: 2840a0f11ef02ba63f3a981075eae66e50e5fa0f7738518c3bf3a74f0bf5b7cf6be3273c2ebb999d00174244fb73295b3d0f8c74b663ef9839a91a16ad9c9878
+  data.tar.gz: 79a0dad8442b9135995a8bcbf62dfde4e112cd765950b61f45db0c490eac0d21e3cf843aea946c2450f69ab8f4d098fe26927b4eafe4cd0b7d6a1097ba04ceb9

data/README.md

@@ -24,6 +24,13 @@ management functionality with remote management functionality.
 
 Check the Foreman manual [remote execution section](http://theforeman.org/plugins/foreman_remote_execution/)
 
+## Compatibility
+
+| Foreman Version | Plugin Version |
+| --------------- | -------------- |
+| >= 3.1          | ~> 5.0.0       |
+| >= 3.2          | >= 6.0.0       |
+
 ## Simulated runs
 There is an option to use an alternative `ScriptRunner` implementation. Instead of doing ssh connections it discards any input its given and gives back fake output.
 

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

@@ -13,6 +13,7 @@ module ForemanRemoteExecution
 
       def host_setup_extension
         remote_execution_interface
+        reset_host_known_keys! unless @host.new_record?
         super
       end
 
@@ -21,6 +22,10 @@ module ForemanRemoteExecution
 
         @host.set_execution_interface(params['remote_execution_interface'])
       end
+
+      def reset_host_known_keys!
+        @host.host_proxy_invocations.destroy_all
+      end
     end
   end
 end

data/app/controllers/ui_job_wizard_controller.rb

@@ -3,10 +3,11 @@ class UiJobWizardController < ApplicationController
   def categories
     job_categories = resource_scope
                      .search_for("job_category ~ \"#{params[:search]}\"")
+                     .where(:snippet => false)
                      .select(:job_category).distinct
                      .reorder(:job_category)
                      .pluck(:job_category)
-    render :json => {:job_categories =>job_categories, :with_katello => with_katello}
+    render :json => {:job_categories => job_categories, :with_katello => with_katello, default_category: default_category, default_template: default_template&.id}
   end
 
   def template
@@ -24,12 +25,22 @@ class UiJobWizardController < ApplicationController
     template_inputs_with_foreign.map { |input| input.attributes.merge({:resource_type_tableize => input.resource_type&.tableize }) }
   end
 
+  def default_category
+    default_template&.job_category
+  end
+
+  def default_template
+    if (setting_value = Setting['remote_execution_form_job_template'])
+      JobTemplate.authorized(:view_job_templates).find_by :name => setting_value
+    end
+  end
+
   def resource_name(nested_resource = nil)
     nested_resource || 'job_template'
   end
 
   def with_katello
-    !!defined?(::Katello)
+    ::Foreman::Plugin.installed? 'katello'
   end
 
   def resource_class

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

@@ -8,7 +8,7 @@ module ForemanRemoteExecution
 
     def multiple_actions
       res = super
-      res += [ [_('Schedule Remote Job'), new_job_invocation_path, false] ] if authorized_for(controller: :job_invocations, action: :new)
+      res += [ [_('Schedule Remote Job'), new_job_invocation_path, false] ] if can_schedule_jobs?
       res
     end
 
@@ -22,20 +22,20 @@ module ForemanRemoteExecution
       end
     end
 
-    def rex_host_features(*args)
-      return unless authorized_for(controller: :job_invocations, action: :create)
+    def rex_host_features(host, *_rest)
+      return [] unless can_execute_on_host?(host)
       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)
+        link_to(_('%s') % feature.name, job_invocations_path(:host_ids => [host.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')
+    def schedule_job_button(host, *_rest)
+      return unless can_execute_on_host?(host)
+      link_to(_('Schedule Remote Job'), new_job_invocation_path(:host_ids => [host.id]), :id => :run_button, :class => 'btn btn-default')
     end
 
     def web_console_button(host, *args)
-      return unless authorized_for(permission: 'cockpit_hosts', auth_object: host)
+      return if !authorized_for(permission: 'cockpit_hosts', auth_object: host) || !can_execute_on_infrastructure_host?(host)
 
       url = SSHExecutionProvider.cockpit_url_for_host(host.name)
       url ? link_to(_('Web Console'), url, :class => 'btn btn-default', :id => :'web-console-button', :target => '_new') : nil
@@ -46,6 +46,17 @@ module ForemanRemoteExecution
         button_group(web_console_button(*args)))
       super(*args)
     end
-  end
 
+    def can_schedule_jobs?
+      authorized_for(controller: :job_invocations, action: :create)
+    end
+
+    def can_execute_on_host?(host)
+      can_schedule_jobs? && can_execute_on_infrastructure_host?(host)
+    end
+
+    def can_execute_on_infrastructure_host?(host)
+      !host.infrastructure_host? || User.current.can?(:execute_jobs_on_infrastructure_hosts)
+    end
+  end
 end

data/app/helpers/remote_execution_helper.rb

@@ -1,6 +1,6 @@
 module RemoteExecutionHelper
   def providers_options
-    RemoteExecutionProvider.providers.map { |key, provider| [ key, _(provider.humanized_name) ] }
+    RemoteExecutionProvider.providers.reject { |key, _provider| key == 'SSH' }.map { |key, provider| [ key, _(provider.humanized_name) ] }
   end
 
   def job_hosts_authorizer
@@ -31,7 +31,7 @@ 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: current_host_details_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))
@@ -147,9 +147,10 @@ module RemoteExecutionHelper
     end
   end
 
-  def invocation_description(invocation)
+  def invocation_description(invocation, keep_tooltip: true)
     description = invocation.description.try(:capitalize) || invocation.job_category
-    trunc_with_tooltip(description, 80)
+    description = trunc_with_tooltip(description, 80) if keep_tooltip
+    description
   end
 
   def invocation_result(invocation, key)

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

@@ -40,7 +40,7 @@ module Actions
         provider = template_invocation.template.provider
         proxy_selector = provider.required_proxy_selector_for(template_invocation.template) || proxy_selector
 
-        provider_type = template_invocation.template.provider_type.to_s
+        provider_type = provider.proxy_feature
         proxy = determine_proxy!(proxy_selector, provider_type, host)
         link!(proxy)
         input[:proxy_id] = proxy.id

data/app/mailers/rex_job_mailer.rb

@@ -1,5 +1,5 @@
 class RexJobMailer < ApplicationMailer
-  add_template_helper(ApplicationHelper)
+  helper ApplicationHelper
 
   def job_finished(job, opts = {})
     @job = job

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

@@ -46,6 +46,10 @@ module ForemanRemoteExecution
       end
     end
 
+    def cockpit_url
+      SSHExecutionProvider.cockpit_url_for_host(self.name)
+    end
+
     def execution_status(options = {})
       @execution_status ||= get_status(HostStatus::ExecutionStatus).to_status(options)
     end
@@ -98,7 +102,7 @@ module ForemanRemoteExecution
     end
 
     def remote_execution_ssh_keys
-      remote_execution_proxies('SSH', false).values.flatten.uniq.map { |proxy| proxy.pubkey }.compact.uniq
+      remote_execution_proxies(%w(SSH Script), false).values.flatten.uniq.map { |proxy| proxy.pubkey }.compact.uniq
     end
 
     def drop_execution_interface_cache
@@ -121,6 +125,10 @@ module ForemanRemoteExecution
       @cached_rex_host_params_hash = nil
     end
 
+    def infrastructure_host?
+      infrastructure_facet&.foreman_instance || infrastructure_facet&.smart_proxy_id
+    end
+
     private
 
     def extend_host_params_hash(params)

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

@@ -3,16 +3,18 @@ module ForemanRemoteExecution
     extend ActiveSupport::Concern
 
     included do
-      before_validation :set_execution_flag
       validate :exclusive_execution_interface
+      before_validation :move_execution_flag
     end
 
     private
 
-    def set_execution_flag
-      return unless primary? && host.present?
+    def move_execution_flag
+      return unless host && self.execution?
 
-      self.execution = true if host.interfaces.detect(&:execution).nil?
+      host.interfaces
+          .select { |i| i.execution? && i != self }
+          .each { |i| i.execution = false }
     end
 
     def exclusive_execution_interface

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

@@ -11,7 +11,7 @@ module ForemanRemoteExecution
     end
 
     def update_pubkey
-      return unless has_feature?('SSH')
+      return unless has_feature?(%w(SSH Script))
 
       key = ::ProxyAPI::RemoteExecutionSSH.new(:url => url).pubkey
       self.update_attribute(:pubkey, key) if key

data/app/models/job_invocation_composer.rb

@@ -217,7 +217,7 @@ class JobInvocationComposer
     def format_datetime(datetime)
       return datetime if datetime.blank?
 
-      Time.parse(datetime).utc.strftime('%Y-%m-%d %H:%M')
+      Time.parse(datetime).in_time_zone.strftime('%Y-%m-%d %H:%M')
     end
   end
 

data/app/models/remote_execution_provider.rb

@@ -4,7 +4,16 @@ class RemoteExecutionProvider
 
   class << self
     def provider_for(type)
-      providers[type.to_s] || providers[:SSH]
+      providers[type.to_s] || providers[:script]
+    end
+
+    def registered_name
+      klass = self
+      providers.key(klass)
+    end
+
+    def proxy_feature
+      registered_name
     end
 
     def providers

data/app/models/ssh_execution_provider.rb

@@ -1,4 +1,4 @@
-class SSHExecutionProvider < RemoteExecutionProvider
+class ScriptExecutionProvider < RemoteExecutionProvider
   class << self
     def proxy_command_options(template_invocation, host)
       super.merge(:ssh_user => ssh_user(host),
@@ -9,7 +9,7 @@ class SSHExecutionProvider < RemoteExecutionProvider
     end
 
     def humanized_name
-      _('SSH')
+      _('Script')
     end
 
     def supports_effective_user?
@@ -37,8 +37,7 @@ class SSHExecutionProvider < RemoteExecutionProvider
     end
 
     def ssh_params(host)
-      proxy_selector = ::RemoteExecutionProxySelector.new
-      proxy = proxy_selector.determine_proxy(host, 'SSH')
+      proxy = proxy_for_cockpit(host)
       {
         :hostname => find_ip_or_hostname(host),
         :proxy => proxy.class == Symbol ? proxy : proxy.url,
@@ -53,6 +52,10 @@ class SSHExecutionProvider < RemoteExecutionProvider
       Setting[:remote_execution_cockpit_url] % { :host => host } if Setting[:remote_execution_cockpit_url].present?
     end
 
+    def proxy_feature
+      %w(SSH Script)
+    end
+
     private
 
     def ssh_user(host)
@@ -62,5 +65,15 @@ class SSHExecutionProvider < RemoteExecutionProvider
     def ssh_port(host)
       Integer(host_setting(host, :remote_execution_ssh_port))
     end
+
+    def proxy_for_cockpit(host)
+      proxy_selector = ::RemoteExecutionProxySelector.new
+      proxy = proxy_selector.determine_proxy(host, 'Script', capability: 'cockpit')
+      return proxy unless [:not_defined, :not_available, nil].include?(proxy)
+
+      proxy_selector.determine_proxy(host, 'SSH')
+    end
   end
 end
+
+SSHExecutionProvider = ScriptExecutionProvider

data/app/models/targeting.rb

@@ -67,7 +67,7 @@ class Targeting < ApplicationRecord
     return '' if ids.empty?
 
     hosts = Host.execution_scope.where(:id => ids).distinct.pluck(:name)
-    "name ^ (#{hosts.join(', ')})"
+    hosts.any? ? "name ^ (#{hosts.join(', ')})" : ''
   end
 
   def resolved?

data/app/services/default_proxy_proxy_selector.rb

@@ -7,7 +7,7 @@ class DefaultProxyProxySelector < ::RemoteExecutionProxySelector
     super
   end
 
-  def available_proxies(host, provider)
+  def available_proxies(host, provider, capability: nil)
     # TODO: Once we have a internal proxy marker/feature on the proxy, we can
     # swap the implementation
     raise _('default_capsule method missing from SmartProxy') unless ::SmartProxy.respond_to?(:default_capsule)

data/app/services/remote_execution_proxy_selector.rb

@@ -2,7 +2,12 @@ class RemoteExecutionProxySelector < ::ForemanTasks::ProxySelector
 
   INTERNAL_PROXY = 'internal'.freeze
 
-  def available_proxies(host, provider)
-    host.remote_execution_proxies(provider)
+  def available_proxies(host, provider, capability: nil)
+    proxies = host.remote_execution_proxies(provider)
+    return proxies if capability.nil?
+
+    proxies.reduce({}) do |acc, (strategy, possible_proxies)|
+      acc.merge(strategy => possible_proxies.select { |proxy| proxy.has_capability?(capability) })
+    end
   end
 end

data/app/views/api/v2/host/main.rabl

@@ -0,0 +1 @@
+attributes :cockpit_url

data/app/views/dashboard/_latest-jobs.html.erb

@@ -10,7 +10,7 @@
     </tr>
     <% JobInvocation.latest_jobs.each do |invocation| %>
       <tr>
-        <td class="ellipsis"><%= 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 class="ellipsis"><%= link_to_if_authorized invocation_description(invocation, keep_tooltip: false), hash_for_job_invocation_path(invocation).merge(:auth_object => invocation, :permission => :view_job_invocations, :authorizer => authorizer) %></td>
         <td><%= link_to_invocation_task_if_authorized(invocation) %></td>
         <td><%= time_in_words_span(invocation.start_at) %></td>
       </tr>

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

@@ -7,7 +7,7 @@
 <% if @hosts.any? -%>
   <ul>
     <% @hosts.each do |host| -%>
-        <li><%= link_to h(host.name), host_path(host), :target => '_blank' %></li>
+        <li><%= link_to h(host.name), current_host_details_path(host), :target => '_blank' %></li>
     <% end -%>
 
     <% if @additional > 0 -%>

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

@@ -30,7 +30,7 @@ end
 <% if @host %>
   <% proxy_id = @template_invocation_task.input[:proxy_id] %>
   <h3>
-    <%= _('Target: ') %><%= link_to(@host.name, host_path(@host)) %>
+    <%= _('Target: ') %><%= link_to(@host.name, current_host_details_path(@host)) %>
     <% if proxy_id && proxy = SmartProxy.find_by(id: proxy_id) %>
       <%= _('using Smart Proxy') %> <%= link_to(proxy.name, smart_proxy_path(proxy)) %>
     <% end %>

data/app/views/templates/{ssh → script}/check_update.erb

@@ -1,10 +1,10 @@
 <%#
 kind: job_template
-name: Check Update - SSH Default
+name: Check Update - Script Default
 model: JobTemplate
 job_category: Packages
 description_format: "Check for package updates"
-provider_type: SSH
+provider_type: script
 %>
 
 <%

data/app/views/templates/{ssh → script}/module_action.erb

@@ -1,10 +1,10 @@
 <%#
 kind: job_template
-name: Module Action - SSH Default
+name: Module Action - Script Default
 model: JobTemplate
 job_category: Modules
 description_format: "Module %{action} %{module_spec}"
-provider_type: SSH
+provider_type: script
 template_inputs:
 - name: pre_script
   description: A script to run prior to the module action

data/app/views/templates/{ssh → script}/package_action.erb

@@ -1,10 +1,10 @@
 <%#
 kind: job_template
-name: Package Action - SSH Default
+name: Package Action - Script Default
 model: JobTemplate
 job_category: Packages
 description_format: "%{action} package(s) %{package}"
-provider_type: SSH
+provider_type: script
 template_inputs:
 - name: pre_script
   description: A script to run prior to the package action
@@ -69,8 +69,11 @@ handle_zypp_res_codes () {
 
   if [ "${ZYPP_RES_CODES[$RETVAL]}" != "" ]; then
     echo ${ZYPP_RES_CODES[$RETVAL]}
+  fi
+  if [[ $RETVAL -ge 100 && $RETVAL -le 103 ]]; then
     RETVAL=0
   fi
+
   return $RETVAL
 }
 <% end -%>

data/app/views/templates/{ssh → script}/power_action.erb

@@ -1,10 +1,10 @@
 <%#
 kind: job_template
-name: Power Action - SSH Default
+name: Power Action - Script Default
 model: JobTemplate
 job_category: Power
 description_format: '%{action} host'
-provider_type: SSH
+provider_type: script
 template_inputs:
 - name: action
   description: Action to perform on the service

data/app/views/templates/{ssh → script}/puppet_agent_disable.erb

@@ -1,5 +1,5 @@
 <%#
-name: Puppet Agent Disable - SSH Default
+name: Puppet Agent Disable - Script Default
 model: JobTemplate
 job_category: Puppet
 description_format: Disable Puppet agent
@@ -10,7 +10,7 @@ template_inputs:
   input_type: user
   description: Reason for disabling the Puppet agent
   advanced: false
-provider_type: SSH
+provider_type: script
 kind: job_template
 -%>
 <% if @host.operatingsystem.family == 'Debian' -%>

data/app/views/templates/{ssh → script}/puppet_agent_enable.erb

@@ -1,10 +1,10 @@
 <%#
-name: Puppet Agent Enable - SSH Default
+name: Puppet Agent Enable - Script Default
 model: JobTemplate
 job_category: Puppet
 description_format: Enable Puppet agent
 snippet: false
-provider_type: SSH
+provider_type: script
 kind: job_template
 -%>
 <% if @host.operatingsystem.family == 'Debian' -%>

data/app/views/templates/{ssh → script}/puppet_install_modules_from_forge.erb

@@ -1,5 +1,5 @@
 <%#
-name: Puppet Module - Install from forge - SSH Default
+name: Puppet Module - Install from forge - Script Default
 model: JobTemplate
 job_category: Puppet
 description_format: Install Puppet Module "%{puppet_module}" from forge
@@ -30,7 +30,7 @@ template_inputs:
   input_type: user
   description: Do not attempt to install dependencies. Type "true" to ignore dependencies.
   advanced: true
-provider_type: SSH
+provider_type: script
 kind: job_template
 -%>
 <% if @host.operatingsystem.family == 'Debian' -%>

data/app/views/templates/{ssh → script}/puppet_install_modules_from_git.erb

@@ -1,5 +1,5 @@
 <%#
-name: Puppet Module - Install from git - SSH Default
+name: Puppet Module - Install from git - Script Default
 model: JobTemplate
 job_category: Puppet
 description_format: Install Puppet Module "%{puppet_module}" from git
@@ -15,7 +15,7 @@ template_inputs:
   input_type: user
   description: For example, '/etc/puppetlabs/code/environments/production/modules/puppet'.
   advanced: false
-provider_type: SSH
+provider_type: script
 kind: job_template
 -%>
 git clone <%= input('git_repository') %> <%= input('target_dir') %>

data/app/views/templates/{ssh → script}/puppet_run_once.erb

@@ -1,10 +1,10 @@
 <%#
 kind: job_template
-name: Puppet Run Once - SSH Default
+name: Puppet Run Once - Script Default
 model: JobTemplate
 job_category: Puppet
 description_format: 'Run Puppet once with "%{puppet_options}"'
-provider_type: SSH
+provider_type: script
 template_inputs:
 - name: puppet_options
   description: Additional options to pass to puppet

data/app/views/templates/{ssh → script}/run_command.erb

@@ -1,10 +1,10 @@
 <%#
 kind: job_template
-name: Run Command - SSH Default
+name: Run Command - Script Default
 model: JobTemplate
 job_category: Commands
 description_format: "Run %{command}"
-provider_type: SSH
+provider_type: script
 template_inputs:
 - name: command
   description: Command to run on the host

data/app/views/templates/{ssh → script}/service_action.erb

@@ -1,10 +1,10 @@
 <%#
 kind: job_template
-name: Service Action - SSH Default
+name: Service Action - Script Default
 model: JobTemplate
 job_category: Services
 description_format: '%{action} service %{service}'
-provider_type: SSH
+provider_type: script
 template_inputs:
 - name: action
   description: Action to perform on the service

data/db/migrate/20220321101835_rename_ssh_provider_to_script.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class RenameSshProviderToScript < ActiveRecord::Migration[6.0]
+
+  def do_change(from, to, from_re, new_label)
+    setting = Setting.find_by(:name => 'remote_execution_form_job_template')
+    default_template = nil
+
+    Template.where(:provider_type => from).each do |t|
+      default_template = t if t.name == setting&.value
+      t.provider_type = to
+      t.name = t.name.gsub(from_re, new_label)
+      t.save!
+    end
+
+    if default_template
+      setting.value = default_template.name
+      setting.save!
+    end
+  end
+
+  def up
+    do_change 'SSH', 'script', /SSH Default$/, 'Script Default'
+  end
+
+  def down
+    do_change 'script', 'SSH', /Script Default$/, 'SSH Default'
+  end
+end

data/db/seeds.d/60-ssh_proxy_feature.rb

@@ -1,2 +1,5 @@
 f = Feature.where(:name => 'SSH').first_or_create
 raise "Unable to create proxy feature: #{format_errors f}" if f.nil? || f.errors.any?
+
+f = Feature.where(:name => 'Script').first_or_create
+raise "Unable to create proxy feature: #{format_errors f}" if f.nil? || f.errors.any?

data/jsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "paths": {
+      "foremanReact/*": ["../foreman/webpack/assets/javascripts/react_app/*"]
+    }
+  }
+}