foreman_remote_execution 5.0.4 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59eae566c2961d0c2d5cca855d76ece120748f1c1f6303a5b2fca5928f1b4840
-  data.tar.gz: 1cbb8e8f418e8b8c5823b9b875eed46873735da31b5214601acc60f236d650b1
+  metadata.gz: 910d4fd508188efbad4cfb121085171d077d65881e7ef8b5c9f1dea4092aa182
+  data.tar.gz: af7a5ca195d2b0d6ba269962bb3d726cd19dd6cc23358e6e6dc21cc77b36b3b2
 SHA512:
-  metadata.gz: 77c04207ff68fc2cf97061b77b2d06c40b51f197d2cceb4fa803dc29e2e3512eb4b048131964414f2e29dbc23e2a460b1ff46566718b79e804f7632b375f12ea
-  data.tar.gz: d9bf1681d7e5834c3cc16941a90c4c4c73db3d1b4e812c91b88ffe866bcb27f52eae3841a49740f77c50d0f8fd570203ea7f4f5100cc855ea140403cd0bda49e
+  metadata.gz: 030ed44dd17a6da7b334f3c3621d34cec9d4afc6323f2cbacd1054716520dc4f955f5da4d0aa5bfb93b0f83699c6dd15a3d75a9ff770fa1b9c5d6df2afbba440
+  data.tar.gz: 80d41c53f5e1620919069e08a97b23d22d884406275ad426b49ee08c97dc92c958762fe79ff5bb703b63859f1551fb3cfad838f1b63e75cbc143983dc864e7fd

data/Gemfile

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

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/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

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

@@ -40,8 +40,10 @@ 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
 
         renderer = InputTemplateRenderer.new(template_invocation.template, host, template_invocation)
         script = renderer.render

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

@@ -98,7 +98,7 @@ module ForemanRemoteExecution
         def input(name)
           return template_input_values[name.to_s] if template_input_values.key?(name.to_s)
 
-          input = find_by_name(template.template_inputs_with_foreign, name) # rubocop:disable Rails/DynamicFindBy
+          input = find_by_name(template.template_inputs_with_foreign, name)
           if input
             @preview ? input.preview(self) : input.value(self)
           else

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

data/app/models/job_invocation.rb

@@ -15,8 +15,10 @@ class JobInvocation < ApplicationRecord
 
   belongs_to :targeting, :dependent => :destroy
   has_many :all_template_invocations, :inverse_of => :job_invocation, :dependent => :destroy, :class_name => 'TemplateInvocation'
+  # rubocop:disable Rails/HasManyOrHasOneDependent
   has_many :template_invocations, -> { where('template_invocations.host_id IS NOT NULL') }, :inverse_of => :job_invocation
   has_many :pattern_template_invocations, -> { where('template_invocations.host_id IS NULL') }, :inverse_of => :job_invocation, :class_name => 'TemplateInvocation'
+  # rubocop:enable Rails/HasManyOrHasOneDependent
   has_many :pattern_templates, :through => :pattern_template_invocations, :source => :template
 
   validates :targeting, :presence => true

data/app/models/job_template.rb

@@ -17,8 +17,10 @@ class JobTemplate < ::Template
 
   has_many :audits, :as => :auditable, :class_name => Audited.audit_class.name, :dependent => :nullify
   has_many :all_template_invocations, :dependent => :destroy, :foreign_key => 'template_id', :class_name => 'TemplateInvocation'
+  # rubocop:disable Rails/HasManyOrHasOneDependent
   has_many :template_invocations, -> { where('host_id IS NOT NULL') }, :foreign_key => 'template_id'
   has_many :pattern_template_invocations, -> { where('host_id IS NULL') }, :foreign_key => 'template_id', :class_name => 'TemplateInvocation'
+  # rubocop:enable Rails/HasManyOrHasOneDependent
   has_many :remote_execution_features, :dependent => :nullify
 
   # these can't be shared in parent class, scoped search can't handle STI properly
@@ -192,7 +194,7 @@ class JobTemplate < ::Template
   end
 
   def default_input_values(ignore_keys)
-    result = self.template_inputs_with_foreign.select { |ti| !ti.required? && ti.user_template_input? }.map { |ti| ti.name.to_s }
+    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 ] }]
   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?
@@ -53,6 +53,10 @@ class SSHExecutionProvider < RemoteExecutionProvider
       Setting[:remote_execution_cockpit_url] % { :host => host } if Setting[:remote_execution_cockpit_url].present?
     end
 
+    def proxy_feature
+      'SSH'
+    end
+
     private
 
     def ssh_user(host)
@@ -64,3 +68,5 @@ class SSHExecutionProvider < RemoteExecutionProvider
     end
   end
 end
+
+SSHExecutionProvider = ScriptExecutionProvider

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

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

data/app/views/job_templates/_custom_tabs.html.erb

@@ -1,14 +1,9 @@
 <div class="tab-pane" id="template_job">
 
-  <%= field(f, :job_category, :label => _('Job category')) do %>
-    <%= auto_complete_search(:job_category,
-                             f.object.job_category,
-                             :placeholder => _("Job category") + ' ...',
-                             :name => 'job_template[job_category]',
-                             :id => 'search',
-                             :disabled => @template.locked?) %>
-  <% end %>
-
+  <%= autocomplete_f(f, :job_category,
+        :search_query => '',
+        :placeholder => _("Job category") + ' ...',
+        :disabled => @template.locked?) %>
   <%= text_f f, :description_format,
              :disabled => @template.locked?,
              :label_help => description_format_help %>

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

@@ -28,7 +28,13 @@ end
   </div>
 </div>
 <% if @host %>
-  <h3><%= _('Target: ') %><%= link_to(@host.name, current_host_details_path(@host)) %></h3>
+  <% proxy_id = @template_invocation_task.input[:proxy_id] %>
+  <h3>
+    <%= _('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 %>
+  </h3>
 
   <div class="preview hidden">
     <%= preview_box(@template_invocation, @host) %>

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

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/jsconfig.json

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

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.1'
+        requires_foreman '>= 3.2'
         register_global_js_file 'global'
 
         apipie_documented_controllers ["#{ForemanRemoteExecution::Engine.root}/app/controllers/api/v2/*.rb"]
@@ -146,13 +146,13 @@ module ForemanRemoteExecution
             setting 'remote_execution_form_job_template',
               type: :string,
               description: N_('Choose a job template that is pre-selected in job invocation form'),
-              default: 'Run Command - SSH Default',
+              default: 'Run Command - Script Default',
               full_name: N_('Form Job Template'),
               collection: proc { Hash[JobTemplate.unscoped.map { |template| [template.name, template.name] }] }
             setting 'remote_execution_job_invocation_report_template',
               type: :string,
               description: N_('Select a report template used for generating a report for a particular remote execution job'),
-              default: 'Jobs - Invocation report template',
+              default: 'Job invocation - report template',
               full_name: N_('Job Invocation Report Template'),
               collection: proc { ForemanRemoteExecution.job_invocation_report_templates_select }
           end
@@ -265,6 +265,7 @@ module ForemanRemoteExecution
         extend_rabl_template 'api/v2/smart_proxies/main', 'api/v2/smart_proxies/pubkey'
         extend_rabl_template 'api/v2/interfaces/main', 'api/v2/interfaces/execution_flag'
         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 }
 
@@ -328,7 +329,8 @@ module ForemanRemoteExecution
       require_dependency 'foreman_tasks/task'
       ForemanTasks::Task.include ForemanRemoteExecution::ForemanTasksTaskExtensions
       ForemanTasks::Cleaner.include ForemanRemoteExecution::ForemanTasksCleanerExtensions
-      RemoteExecutionProvider.register(:SSH, SSHExecutionProvider)
+      RemoteExecutionProvider.register(:SSH, ::SSHExecutionProvider)
+      RemoteExecutionProvider.register(:script, ::ScriptExecutionProvider)
 
       ForemanRemoteExecution.register_rex_feature
 

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '5.0.4'.freeze
+  VERSION = '6.1.0'.freeze
 end

data/locale/action_names.rb

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