foreman_remote_execution 6.2.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71b09dd41d7ce39e709e4a45c2c78926d53151ed3625fcf2f4e0d739853cae8e
-  data.tar.gz: d01463507ceb52b52f661fa9a55ce413e2f824d74dfe50958063359f5a6fa8e9
+  metadata.gz: e9183b3b81c3033d696f4aedf861cb5eed143fb9eacccb144a23d859e3ccae69
+  data.tar.gz: 4c7c6c09c84f3d4cbef2aaa8330b7bf048d42570e9319ad227c30abc5613770c
 SHA512:
-  metadata.gz: 2840a0f11ef02ba63f3a981075eae66e50e5fa0f7738518c3bf3a74f0bf5b7cf6be3273c2ebb999d00174244fb73295b3d0f8c74b663ef9839a91a16ad9c9878
-  data.tar.gz: 79a0dad8442b9135995a8bcbf62dfde4e112cd765950b61f45db0c490eac0d21e3cf843aea946c2450f69ab8f4d098fe26927b4eafe4cd0b7d6a1097ba04ceb9
+  metadata.gz: b35e41908b57f97f80272070d84b8d2ceeb7e061e22ad673d07c694a643d057399e207af9c8f36d14d535a7ddb3eddefa013e04b3d63689796e66e6d9aeae88b
+  data.tar.gz: 5c0b0d79edaab4c28721ad26df27ad8ac14878e09349929d28175c2cc1714ebb1f81ceb9f4824215d781dc1b4b0662962a9043f4f56963fea4d0aaa3e2483f8d

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

@@ -45,6 +45,7 @@ module Api
               :required => false,
               :desc => N_('Set password for effective user (using sudo-like mechanisms)')
           end
+          param :ssh_user, String, :required => false, :desc => N_('Set SSH user')
           param :password, String, :required => false, :desc => N_('Set SSH password')
           param :key_passphrase, String, :required => false, :desc => N_('Set SSH key passphrase')
 

data/app/helpers/hosts_extensions_helper.rb

@@ -0,0 +1,62 @@
+module HostsExtensionsHelper
+  def rex_hosts_multiple_actions
+    return [] unless can_schedule_jobs?
+
+    [{ action: [_('Schedule Remote Job'), new_job_invocation_path, false], priority: 1000 }]
+  end
+
+  def rex_host_overview_buttons(host)
+    [
+      { button: link_to_if_authorized(_("Jobs"), hash_for_job_invocations_path(search: "host=#{host.name}"), title: _("Job invocations"), class: 'btn btn-default'), priority: 200 },
+    ]
+  end
+
+  def host_title_actions(*args)
+    title_actions(button_group(schedule_job_multi_button(*args)),
+      button_group(web_console_button(*args)))
+    super(*args)
+  end
+
+  private
+
+  def schedule_job_multi_button(*args)
+    host_features = rex_host_features(*args)
+
+    if host_features.present?
+      action_buttons(schedule_job_button(*args), *host_features)
+    else
+      schedule_job_button(*args)
+    end
+  end
+
+  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 => [host.id], :feature => feature.label), :method => :post)
+    end
+  end
+
+  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 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
+  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

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

@@ -172,6 +172,10 @@ module Actions
         @host ||= ::Host.authorized.find(host_id)
       end
 
+      def self.cleanup_after
+        '90d'
+      end
+
       private
 
       def update_host_status

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

@@ -153,6 +153,10 @@ module Actions
         input[:proxy_batch_size]
       end
 
+      def self.cleanup_after
+        '90d'
+      end
+
       private
 
       def mail_notification_preference

data/app/models/job_invocation_composer.rb

@@ -16,6 +16,7 @@ class JobInvocationComposer
         :host_ids => ui_params[:host_ids],
         :remote_execution_feature_id => job_invocation_base[:remote_execution_feature_id],
         :description_format => job_invocation_base[:description_format],
+        :ssh_user => blank_to_nil(job_invocation_base[:ssh_user]),
         :password => blank_to_nil(job_invocation_base[:password]),
         :key_passphrase => blank_to_nil(job_invocation_base[:key_passphrase]),
         :effective_user_password => blank_to_nil(job_invocation_base[:effective_user_password]),
@@ -121,6 +122,7 @@ class JobInvocationComposer
         :targeting => targeting_params,
         :triggering => triggering_params,
         :description_format => api_params[:description_format],
+        :ssh_user => api_params[:ssh_user],
         :password => api_params[:password],
         :remote_execution_feature_id => remote_execution_feature_id,
         :effective_user_password => api_params[:effective_user_password],
@@ -237,6 +239,7 @@ class JobInvocationComposer
       { :job_category => job_invocation.job_category,
         :targeting => targeting_params,
         :triggering => triggering_params,
+        :ssh_user => job_invocation.ssh_user,
         :description_format => job_invocation.description_format,
         :concurrency_control => concurrency_control_params,
         :execution_timeout_interval => job_invocation.execution_timeout_interval,
@@ -399,7 +402,7 @@ class JobInvocationComposer
 
   def compose
     job_invocation.job_category = validate_job_category(params[:job_category])
-    job_invocation.job_category ||= resolve_job_category(available_job_categories.first) { |tempate| template.job_category } if @set_defaults
+    job_invocation.job_category ||= resolve_job_category(available_job_categories.first) { |template| template.job_category } if @set_defaults
     job_invocation.remote_execution_feature_id = params[:remote_execution_feature_id]
     job_invocation.targeting = build_targeting
     job_invocation.triggering = build_triggering
@@ -411,6 +414,7 @@ class JobInvocationComposer
     job_invocation.password = params[:password]
     job_invocation.key_passphrase = params[:key_passphrase]
     job_invocation.effective_user_password = params[:effective_user_password]
+    job_invocation.ssh_user = params[:ssh_user]
 
     if @reruns && job_invocation.targeting.static?
       job_invocation.targeting.assign_host_ids(JobInvocation.find(@reruns).targeting.host_ids)
@@ -544,7 +548,7 @@ class JobInvocationComposer
 
   def input_value_for(input)
     invocations = pattern_template_invocations
-    default = TemplateInvocationInputValue.new(:template_input_id => input.id)
+    default = TemplateInvocationInputValue.new(:template_input_id => input.id, :value => input.default)
     invocations.map(&:input_values).flatten.detect { |iv| iv.template_input_id == input.id } || default
   end
 

data/app/models/job_template.rb

@@ -196,7 +196,10 @@ class JobTemplate < ::Template
   def default_input_values(ignore_keys)
     result = self.template_inputs_with_foreign.select { |ti| !ti.required? && ti.input_type == 'user' }.map { |ti| ti.name.to_s }
     result -= ignore_keys.map(&:to_s)
-    Hash[result.map { |k| [ k, nil ] }]
+    default_values = self.template_inputs_with_foreign.reduce({}) do |acc, input|
+      acc.merge(input.name.to_s => input.default)
+    end
+    Hash[result.map { |k| [ k, default_values[k]] }]
   end
 
   private

data/app/models/ssh_execution_provider.rb

@@ -1,7 +1,7 @@
 class ScriptExecutionProvider < RemoteExecutionProvider
   class << self
     def proxy_command_options(template_invocation, host)
-      super.merge(:ssh_user => ssh_user(host),
+      super.merge(:ssh_user => ssh_user(host, template_invocation.job_invocation),
         :effective_user => effective_user(template_invocation),
         :effective_user_method => effective_user_method(host),
         :cleanup_working_dirs => cleanup_working_dirs?(host),
@@ -58,8 +58,8 @@ class ScriptExecutionProvider < RemoteExecutionProvider
 
     private
 
-    def ssh_user(host)
-      host.host_param('remote_execution_ssh_user')
+    def ssh_user(host, job_invocation = nil)
+      job_invocation&.ssh_user || host.host_param('remote_execution_ssh_user')
     end
 
     def ssh_port(host)

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

@@ -1,6 +1,6 @@
 object @job_invocation
 
-attributes :id, :description, :job_category, :targeting_id, :status, :start_at, :status_label
+attributes :id, :description, :job_category, :targeting_id, :status, :start_at, :status_label, :ssh_user
 
 node do |invocation|
   {

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

@@ -32,6 +32,14 @@
         <%= show_job_location(@job_location) %>
       </strong>
     </p>
+    <% if job_invocation[:ssh_user] %>
+      <p>
+        <%= _('SSH User') %>:
+        <strong>
+          <%= job_invocation[:ssh_user] %>
+        </strong>
+      </p>
+    <% end %>
   </div>
   <div class='card-pf-footer'>
     <p>

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

@@ -82,6 +82,8 @@
                         <% end %>
                       <% end %>
 
+                      <%= text_f f, :ssh_user, :value => f.object.ssh_user, :label => _('SSH user'), :label_help => N_('A user to be used for SSH.') %>
+
                       <% if job_template.effective_user.overridable? %>
                         <%= text_f job_template_fields, :effective_user, :value => @composer.template_invocation(job_template).try(:effective_user), :label => _('Effective user'), :label_help => N_("A user to be used for executing the script. If it differs from the SSH user, su or sudo is used to switch the accounts.") %>
                       <% end %>

data/db/migrate/20220331112719_add_ssh_user_to_job_invocation.rb

@@ -0,0 +1,5 @@
+class AddSshUserToJobInvocation < ActiveRecord::Migration[6.0]
+  def change
+    add_column :job_invocations, :ssh_user, :string
+  end
+end

data/lib/foreman_remote_execution/engine.rb

@@ -47,7 +47,7 @@ module ForemanRemoteExecution
 
     initializer 'foreman_remote_execution.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_remote_execution do
-        requires_foreman '>= 3.2'
+        requires_foreman '>= 3.3'
         register_global_js_file 'global'
 
         apipie_documented_controllers ["#{ForemanRemoteExecution::Engine.root}/app/controllers/api/v2/*.rb"]
@@ -267,7 +267,11 @@ module ForemanRemoteExecution
         extend_rabl_template 'api/v2/subnets/show', 'api/v2/subnets/remote_execution_proxies'
         extend_rabl_template 'api/v2/hosts/main', 'api/v2/host/main'
         parameter_filter ::Subnet, :remote_execution_proxy_ids
-        describe_host { overview_buttons_provider :host_overview_buttons }
+
+        describe_host do
+          multiple_actions_provider :rex_hosts_multiple_actions
+          overview_buttons_provider :rex_host_overview_buttons
+        end
 
         # Extend Registration module
         extend_allowed_registration_vars :remote_execution_interface
@@ -316,7 +320,6 @@ module ForemanRemoteExecution
       end
 
       Bookmark.include ForemanRemoteExecution::BookmarkExtensions
-      HostsHelper.prepend ForemanRemoteExecution::HostsHelperExtensions
       ProvisioningTemplatesHelper.prepend ForemanRemoteExecution::JobTemplatesExtensions
       TemplateInput.include ForemanRemoteExecution::TemplateInputExtensions
 

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '6.2.0'.freeze
+  VERSION = '7.0.0'.freeze
 end

data/locale/action_names.rb

@@ -1,5 +1,5 @@
 # Autogenerated!
 _("Remote action:")
-_("»Import facts«")
-_("»Import Puppet classes«")
-_("»Action with sub plans«")
+_("Import Puppet classes")
+_("Import facts")
+_("Action with sub plans")

data/locale/de/foreman_remote_execution.po

@@ -24,6 +24,9 @@ msgstr "%s"
 msgid "%s ago"
 msgstr "vor %s"
 
+msgid "%s job has been invoked"
+msgstr ""
+
 msgid "%{description} on %{host}"
 msgstr "%{description} auf %{host}"
 
@@ -68,15 +71,15 @@ msgstr "Ein Benutzer, der für die Ausführung des Skripts verwendet werden soll
 msgid "Abort Job"
 msgstr ""
 
+msgid "Action with sub plans"
+msgstr ""
+
 msgid "Actions"
 msgstr "Aktionen"
 
 msgid "Add Foreign Input Set"
 msgstr "Fremdeingabe-Satz hinzufügen"
 
-msgid "Advanced Fields"
-msgstr ""
-
 msgid "Advanced fields"
 msgstr ""
 
@@ -467,9 +470,15 @@ msgstr ""
 msgid "Import"
 msgstr "Import"
 
+msgid "Import Puppet classes"
+msgstr ""
+
 msgid "Import a job template from ERB"
 msgstr "Job-Vorlage aus ERB importieren"
 
+msgid "Import facts"
+msgstr ""
+
 msgid "Include all inputs from the foreign template"
 msgstr "Alle Eingaben aus Fremdvorlage einschließen"
 
@@ -503,9 +512,6 @@ msgstr "Jobtyp, einer von %s"
 msgid "Job"
 msgstr "Job"
 
-msgid "Job Category"
-msgstr ""
-
 msgid "Job Details"
 msgstr ""
 
@@ -829,7 +835,7 @@ msgstr "Wird aufgelöst zu"
 msgid "Results"
 msgstr ""
 
-msgid "Review Details"
+msgid "Review details"
 msgstr ""
 
 msgid "Run"
@@ -853,9 +859,6 @@ msgstr ""
 msgid "Running"
 msgstr ""
 
-msgid "SSH"
-msgstr "SSH"
-
 msgid "SSH Port"
 msgstr ""
 
@@ -871,6 +874,9 @@ msgstr "Plan"
 msgid "Schedule Remote Job"
 msgstr ""
 
+msgid "Schedule a job"
+msgstr ""
+
 msgid "Schedule for future execution"
 msgstr ""
 
@@ -892,6 +898,9 @@ msgstr ""
 msgid "Scheduled to start before"
 msgstr ""
 
+msgid "Script"
+msgstr ""
+
 msgid "Scroll to bottom"
 msgstr "Zum Ende scrollen"
 
@@ -1212,16 +1221,16 @@ msgstr "Benutzereingabe"
 msgid "Value"
 msgstr "Wert"
 
-msgid "View All Jobs"
+msgid "View all jobs"
 msgstr ""
 
-msgid "View Finished Jobs"
+msgid "View finished jobs"
 msgstr ""
 
-msgid "View Running Jobs"
+msgid "View running jobs"
 msgstr ""
 
-msgid "View Scheduled Jobs"
+msgid "View scheduled jobs"
 msgstr ""
 
 msgid "Web Console"
@@ -1367,12 +1376,3 @@ msgstr ""
 
 msgid "using Smart Proxy"
 msgstr ""
-
-msgid "»Action with sub plans«"
-msgstr ""
-
-msgid "»Import Puppet classes«"
-msgstr ""
-
-msgid "»Import facts«"
-msgstr ""

data/locale/en/foreman_remote_execution.po

@@ -23,6 +23,9 @@ msgstr ""
 msgid "%s ago"
 msgstr ""
 
+msgid "%s job has been invoked"
+msgstr ""
+
 msgid "%{description} on %{host}"
 msgstr ""
 
@@ -67,13 +70,13 @@ msgstr ""
 msgid "Abort Job"
 msgstr ""
 
-msgid "Actions"
+msgid "Action with sub plans"
 msgstr ""
 
-msgid "Add Foreign Input Set"
+msgid "Actions"
 msgstr ""
 
-msgid "Advanced Fields"
+msgid "Add Foreign Input Set"
 msgstr ""
 
 msgid "Advanced fields"
@@ -466,9 +469,15 @@ msgstr ""
 msgid "Import"
 msgstr ""
 
+msgid "Import Puppet classes"
+msgstr ""
+
 msgid "Import a job template from ERB"
 msgstr ""
 
+msgid "Import facts"
+msgstr ""
+
 msgid "Include all inputs from the foreign template"
 msgstr ""
 
@@ -502,9 +511,6 @@ msgstr ""
 msgid "Job"
 msgstr ""
 
-msgid "Job Category"
-msgstr ""
-
 msgid "Job Details"
 msgstr ""
 
@@ -826,7 +832,7 @@ msgstr ""
 msgid "Results"
 msgstr ""
 
-msgid "Review Details"
+msgid "Review details"
 msgstr ""
 
 msgid "Run"
@@ -850,9 +856,6 @@ msgstr ""
 msgid "Running"
 msgstr ""
 
-msgid "SSH"
-msgstr ""
-
 msgid "SSH Port"
 msgstr ""
 
@@ -868,6 +871,9 @@ msgstr ""
 msgid "Schedule Remote Job"
 msgstr ""
 
+msgid "Schedule a job"
+msgstr ""
+
 msgid "Schedule for future execution"
 msgstr ""
 
@@ -889,6 +895,9 @@ msgstr ""
 msgid "Scheduled to start before"
 msgstr ""
 
+msgid "Script"
+msgstr ""
+
 msgid "Scroll to bottom"
 msgstr ""
 
@@ -1209,16 +1218,16 @@ msgstr ""
 msgid "Value"
 msgstr ""
 
-msgid "View All Jobs"
+msgid "View all jobs"
 msgstr ""
 
-msgid "View Finished Jobs"
+msgid "View finished jobs"
 msgstr ""
 
-msgid "View Running Jobs"
+msgid "View running jobs"
 msgstr ""
 
-msgid "View Scheduled Jobs"
+msgid "View scheduled jobs"
 msgstr ""
 
 msgid "Web Console"
@@ -1364,12 +1373,3 @@ msgstr ""
 
 msgid "using Smart Proxy"
 msgstr ""
-
-msgid "»Action with sub plans«"
-msgstr ""
-
-msgid "»Import Puppet classes«"
-msgstr ""
-
-msgid "»Import facts«"
-msgstr ""

data/locale/en_GB/foreman_remote_execution.po

@@ -24,6 +24,9 @@ msgstr ""
 msgid "%s ago"
 msgstr "%s ago"
 
+msgid "%s job has been invoked"
+msgstr ""
+
 msgid "%{description} on %{host}"
 msgstr ""
 
@@ -68,13 +71,13 @@ msgstr ""
 msgid "Abort Job"
 msgstr ""
 
-msgid "Actions"
+msgid "Action with sub plans"
 msgstr ""
 
-msgid "Add Foreign Input Set"
+msgid "Actions"
 msgstr ""
 
-msgid "Advanced Fields"
+msgid "Add Foreign Input Set"
 msgstr ""
 
 msgid "Advanced fields"
@@ -467,9 +470,15 @@ msgstr ""
 msgid "Import"
 msgstr ""
 
+msgid "Import Puppet classes"
+msgstr ""
+
 msgid "Import a job template from ERB"
 msgstr ""
 
+msgid "Import facts"
+msgstr ""
+
 msgid "Include all inputs from the foreign template"
 msgstr ""
 
@@ -503,9 +512,6 @@ msgstr ""
 msgid "Job"
 msgstr ""
 
-msgid "Job Category"
-msgstr ""
-
 msgid "Job Details"
 msgstr ""
 
@@ -827,7 +833,7 @@ msgstr ""
 msgid "Results"
 msgstr ""
 
-msgid "Review Details"
+msgid "Review details"
 msgstr ""
 
 msgid "Run"
@@ -851,9 +857,6 @@ msgstr ""
 msgid "Running"
 msgstr ""
 
-msgid "SSH"
-msgstr ""
-
 msgid "SSH Port"
 msgstr ""
 
@@ -869,6 +872,9 @@ msgstr ""
 msgid "Schedule Remote Job"
 msgstr ""
 
+msgid "Schedule a job"
+msgstr ""
+
 msgid "Schedule for future execution"
 msgstr ""
 
@@ -890,6 +896,9 @@ msgstr ""
 msgid "Scheduled to start before"
 msgstr ""
 
+msgid "Script"
+msgstr ""
+
 msgid "Scroll to bottom"
 msgstr ""
 
@@ -1210,16 +1219,16 @@ msgstr ""
 msgid "Value"
 msgstr "Value"
 
-msgid "View All Jobs"
+msgid "View all jobs"
 msgstr ""
 
-msgid "View Finished Jobs"
+msgid "View finished jobs"
 msgstr ""
 
-msgid "View Running Jobs"
+msgid "View running jobs"
 msgstr ""
 
-msgid "View Scheduled Jobs"
+msgid "View scheduled jobs"
 msgstr ""
 
 msgid "Web Console"
@@ -1365,12 +1374,3 @@ msgstr ""
 
 msgid "using Smart Proxy"
 msgstr ""
-
-msgid "»Action with sub plans«"
-msgstr ""
-
-msgid "»Import Puppet classes«"
-msgstr ""
-
-msgid "»Import facts«"
-msgstr ""