foreman_remote_execution 7.0.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9183b3b81c3033d696f4aedf861cb5eed143fb9eacccb144a23d859e3ccae69
-  data.tar.gz: 4c7c6c09c84f3d4cbef2aaa8330b7bf048d42570e9319ad227c30abc5613770c
+  metadata.gz: aa3c6d67549990da3bbd1d7cbf55408bd4a1dc4d7fc5cbcec8db99eded747964
+  data.tar.gz: ca4e519773be6b0493341fd25ba55e8d4345367c88e0b068183ebe66d020e22e
 SHA512:
-  metadata.gz: b35e41908b57f97f80272070d84b8d2ceeb7e061e22ad673d07c694a643d057399e207af9c8f36d14d535a7ddb3eddefa013e04b3d63689796e66e6d9aeae88b
-  data.tar.gz: 5c0b0d79edaab4c28721ad26df27ad8ac14878e09349929d28175c2cc1714ebb1f81ceb9f4824215d781dc1b4b0662962a9043f4f56963fea4d0aaa3e2483f8d
+  metadata.gz: bbeb56766cc65ed9fcd587f260fb29fca965b961b0787230f0510166702351cb5ff0c78387b3f818b9741f281519f33931bc8d0aa36a923d92e0d50f620d113e
+  data.tar.gz: 3238dc8bc7cdbaa361a6c077e5d611839cb549424ad98daea9e68ac81a932dd6c8de2f233b31f019cc7a1d037b6fea4a656ca3d7e789eb9a794170fb26ac1f68

data/.github/workflows/ruby_ci.yml

@@ -16,8 +16,10 @@ jobs:
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.5
+          ruby-version: 2.7
           bundler-cache: true
+          cache-version: 1
+          rubygems: 3.0.0
       - name: Run rubocop
         if: github.event_name != 'push'
         run: bundle exec rubocop --format github
@@ -36,7 +38,7 @@ jobs:
       fail-fast: false
       matrix:
         foreman-core-branch: [develop]
-        ruby-version: [2.5, 2.7]
+        ruby-version: [2.7]
         node-version: [12]
     steps:
       - run: sudo apt-get update

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

@@ -9,6 +9,7 @@ module ForemanRemoteExecution
             update_api(:create) do
               param :registration_command, Hash do
                 param :remote_execution_interface, String, desc: N_("Identifier of the Host interface for Remote execution")
+                param :setup_remote_execution_pull, :bool, desc: N_("Set 'host_registration_remote_execution_pull' parameter for the host. If it is set to true, pull provider client will be deployed on the host")
               end
             end
           end

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

@@ -6,6 +6,7 @@ module ForemanRemoteExecution
 
         update_api(:global, :host) do
           param :remote_execution_interface, String, desc: N_("Identifier of the Host interface for Remote execution")
+          param :setup_remote_execution_pull, :bool, desc: N_("Set 'host_registration_remote_execution_pull' parameter for the host. If it is set to true, pull provider client will be deployed on the host")
         end
       end
 
@@ -13,10 +14,17 @@ module ForemanRemoteExecution
 
       def host_setup_extension
         remote_execution_interface
+        remote_execution_pull
         reset_host_known_keys! unless @host.new_record?
         super
       end
 
+      def remote_execution_pull
+        HostParameter.where(host: @host, name: 'host_registration_remote_execution_pull').destroy_all
+
+        setup_host_param('host_registration_remote_execution_pull', ActiveRecord::Type::Boolean.new.deserialize(params['setup_remote_execution_pull']))
+      end
+
       def remote_execution_interface
         return unless params['remote_execution_interface'].present?
 

data/app/controllers/ui_job_wizard_controller.rb

@@ -57,4 +57,19 @@ class UiJobWizardController < ApplicationController
     render :json => { :results =>
       resource_list.sort_by { |r| r[:name] }.take(100), :subtotal => resource_list.count}
   end
+
+  def job_invocation
+    job = JobInvocation.authorized.find(params[:id])
+    composer = JobInvocationComposer.from_job_invocation(job, params).params
+    job_template_inputs = JobTemplate.authorized.find(composer[:template_invocations][0][:template_id]).template_inputs_with_foreign
+    inputs = Hash[job_template_inputs.map { |input| ["inputs[#{input[:name]}]", (composer[:template_invocations][0][:input_values].find { |value| value[:template_input_id] == input[:id] })[:value]] }]
+    job_organization = Taxonomy.find_by(id: job.task.input[:current_organization_id])
+    job_location = Taxonomy.find_by(id: job.task.input[:current_location_id])
+    render :json => {
+      :job => composer,
+      :job_organization => job_organization,
+      :job_location => job_location,
+      :inputs => inputs,
+    }
+  end
 end

data/app/helpers/remote_execution_helper.rb

@@ -246,7 +246,7 @@ module RemoteExecutionHelper
   def job_report_template
     template = ReportTemplate.where(name: Setting['remote_execution_job_invocation_report_template']).first
 
-    template if template.template_inputs.where(name: 'job_id').exists?
+    template if template && template.template_inputs.where(name: 'job_id').exists?
   end
 
   def job_report_template_parameters(job_invocation, template)

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

@@ -4,6 +4,12 @@ module ForemanRemoteExecution
 
     included do
       has_many :job_invocations, :dependent => :destroy, :foreign_key => 'task_id'
+      has_one :template_invocation, :inverse_of => :run_host_job_task, :foreign_key => 'run_host_job_task_id', :dependent => :nullify
+      has_one :template, :through => :template_invocation
+      has_many :remote_execution_features, :through => :template
+
+      scoped_search :relation => :remote_execution_features, :on => :name, :rename => 'remote_execution_feature.name'
+      scoped_search :relation => :remote_execution_features, :on => :label, :rename => 'remote_execution_feature.label'
     end
   end
 end

data/app/models/host_status/execution_status.rb

@@ -50,7 +50,8 @@ class HostStatus::ExecutionStatus < HostStatus::Status
   end
 
   def status_link
-    job_invocation = last_stopped_task.parent_task.job_invocations.first
+    job_invocation = last_stopped_task&.parent_task&.job_invocations&.first
+    return unless job_invocation
     return nil unless User.current.can?(:view_job_invocations, job_invocation)
 
     Rails.application.routes.url_helpers.job_invocation_path(job_invocation)

data/app/models/job_invocation.rb

@@ -25,7 +25,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 => :id, :complete_value => true, :validator => ScopedSearch::Validators::INTEGER
   scoped_search :on => :job_category, :complete_value => true
   scoped_search :on => :description, :complete_value => true
 

data/app/models/job_invocation_composer.rb

@@ -219,7 +219,7 @@ class JobInvocationComposer
     def format_datetime(datetime)
       return datetime if datetime.blank?
 
-      Time.parse(datetime).in_time_zone.strftime('%Y-%m-%d %H:%M')
+      Time.zone.parse(datetime).strftime('%Y-%m-%d %H:%M')
     end
   end
 
@@ -441,8 +441,11 @@ class JobInvocationComposer
   end
 
   def valid?
-    targeting.valid? & job_invocation.valid? & !pattern_template_invocations.map(&:valid?).include?(false) &
-      triggering.valid?
+    unless triggering.valid?
+      job_invocation.errors.add(:triggering, 'is invalid')
+      return false
+    end
+    targeting.valid? & job_invocation.valid? & !pattern_template_invocations.map(&:valid?).include?(false)
   end
 
   def save

data/app/models/job_template.rb

@@ -32,6 +32,8 @@ class JobTemplate < ::Template
   scoped_search :on => :snippet, :complete_value => {:true => true, :false => false}
   scoped_search :on => :provider_type, :complete_value => true
   scoped_search :on => :template
+  scoped_search :relation => :remote_execution_features, :on => :name, :rename => 'feature.name'
+  scoped_search :relation => :remote_execution_features, :on => :label, :rename => 'feature.label'
 
   # with proc support, default_scope can no longer be chained
   # include all default scoping here

data/app/models/remote_execution_provider.rb

@@ -28,6 +28,10 @@ class RemoteExecutionProvider
       providers.keys.map(&:to_s)
     end
 
+    def provider_proxy_features
+      providers.values.map(&:proxy_feature).flatten.uniq.compact
+    end
+
     def proxy_command_options(template_invocation, host)
       {:proxy_operation_name => proxy_operation_name}.merge(proxy_command_provider_inputs(template_invocation))
     end

data/app/models/template_invocation.rb

@@ -16,6 +16,7 @@ class TemplateInvocation < ApplicationRecord
   belongs_to :host, :class_name => 'Host::Managed', :foreign_key => :host_id
   has_one :host_group, :through => :host, :source => :hostgroup
   belongs_to :run_host_job_task, :class_name => 'ForemanTasks::Task'
+  has_many :remote_execution_features, :through => :template
 
   validates_associated :input_values
   validate :provides_required_input_values
@@ -25,6 +26,7 @@ class TemplateInvocation < ApplicationRecord
   scoped_search :relation => :host_group, :on => :name, :rename => 'host_group.name', :complete_value => true
   scoped_search :relation => :template, :on => :job_category, :complete_value => true
   scoped_search :relation => :template, :on => :name, :complete_value => true
+  scoped_search :relation => :remote_execution_features, :on => :name, :rename => 'feature'
 
   class TaskResultMap
     MAP = {

data/app/services/remote_execution_proxy_selector.rb

@@ -7,7 +7,7 @@ class RemoteExecutionProxySelector < ::ForemanTasks::ProxySelector
     return proxies if capability.nil?
 
     proxies.reduce({}) do |acc, (strategy, possible_proxies)|
-      acc.merge(strategy => possible_proxies.select { |proxy| proxy.has_capability?(capability) })
+      acc.merge(strategy => possible_proxies.select { |proxy| proxy.has_capability?(provider, capability) })
     end
   end
 end

data/app/views/overrides/subnets/_rex_tab_pane.html.erb

@@ -1,5 +1,5 @@
 <div class="tab-pane" id="rex_proxies">
   <%= fields_for :subnet do |f| %>
-    <%= multiple_selects f, :remote_execution_proxies, SmartProxy.authorized.with_features(*RemoteExecutionProvider.provider_names).distinct, @subnet.remote_execution_proxy_ids, {:label => _("Proxies"), :help_inline => _("Select as many remote execution proxies as applicable for this subnet.  When multiple proxies with the same provider are added, actions will be load balanced among them.")} %>
+    <%= multiple_selects f, :remote_execution_proxies, SmartProxy.authorized.with_features(*RemoteExecutionProvider.provider_proxy_features).distinct, @subnet.remote_execution_proxy_ids, {:label => _("Proxies"), :help_inline => _("Select as many remote execution proxies as applicable for this subnet.  When multiple proxies with the same provider are added, actions will be load balanced among them.")} %>
   <% end %>
 </div>

data/app/views/templates/script/package_action.erb

@@ -16,6 +16,11 @@ template_inputs:
   input_type: user
   required: true
   options: "install\nupdate\nremove\ngroup install\ngroup remove"
+- name: options
+  description: Additional options for the package manager
+  input_type: user
+  required: false
+  advanced: true
 - name: package
   description: The name of the package, if any
   input_type: user
@@ -87,7 +92,7 @@ handle_zypp_res_codes () {
 
 # Action
 <% if package_manager == 'yum' -%>
-  yum -y <%= action %> <%= input("package") %>
+  yum -y <%= input("options") %> <%= action %> <%= input("package") %>
 <% elsif package_manager == 'apt' -%>
   <%-
     action = 'install' if action == 'group install'
@@ -103,7 +108,7 @@ handle_zypp_res_codes () {
   [ -x "$(command -v subscription-manager)" ] && subscription-manager refresh
   export DEBIAN_FRONTEND=noninteractive
   apt-get -y update
-  apt-get -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" -y <%= action %> <%= input("package") %>
+  apt-get -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" -y <%= input("options") %> <%= action %> <%= input("package") %>
 <% elsif package_manager == 'zypper' -%>
   <%-
     if action == "group install"
@@ -113,7 +118,7 @@ handle_zypp_res_codes () {
     end
   -%>
   zypper refresh
-  zypper -n <%= action %> <%= input("package") %>
+  zypper -n <%= action %> <%= input("options") %> <%= input("package") %>
   handle_zypp_res_codes $?
 <% end -%>
 RETVAL=$?

data/config/routes.rb

@@ -46,8 +46,10 @@ Rails.application.routes.draw do
   get 'ui_job_wizard/categories', to: 'ui_job_wizard#categories'
   get 'ui_job_wizard/template/:id', to: 'ui_job_wizard#template'
   get 'ui_job_wizard/resources', to: 'ui_job_wizard#resources'
+  get 'ui_job_wizard/job_invocation', to: 'ui_job_wizard#job_invocation'
 
-  match '/experimental/job_wizard', to: 'react#index', :via => [:get]
+  match '/experimental/job_wizard/new', to: 'react#index', :via => [:get]
+  match '/experimental/job_wizard/:id/rerun', to: 'react#index', :via => [:get]
 
   namespace :api, :defaults => {:format => 'json'} do
     scope '(:apiv)', :module => :v2, :defaults => {:apiv => 'v2'}, :apiv => /v1|v2/, :constraints => ApiConstraints.new(:version => 2, :default => true) do

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.3'
+        requires_foreman '>= 3.4'
         register_global_js_file 'global'
 
         apipie_documented_controllers ["#{ForemanRemoteExecution::Engine.root}/app/controllers/api/v2/*.rb"]
@@ -152,7 +152,7 @@ module ForemanRemoteExecution
             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: 'Job invocation - report template',
+              default: 'Job - Invocation Report',
               full_name: N_('Job Invocation Report Template'),
               collection: proc { ForemanRemoteExecution.job_invocation_report_templates_select }
           end
@@ -164,7 +164,7 @@ module ForemanRemoteExecution
                                             :'api/v2/job_templates' => [:index, :show, :revision, :export],
                                             :'api/v2/template_inputs' => [:index, :show],
                                             :'api/v2/foreign_input_sets' => [:index, :show],
-                                            :ui_job_wizard => [:categories, :template, :resources]}, :resource_type => 'JobTemplate'
+                                            :ui_job_wizard => [:categories, :template, :resources, :job_invocation]}, :resource_type => 'JobTemplate'
           permission :create_job_templates, { :job_templates => [:new, :create, :clone_template, :import],
                                               :'api/v2/job_templates' => [:create, :clone, :import] }, :resource_type => 'JobTemplate'
           permission :edit_job_templates, { :job_templates => [:edit, :update],
@@ -181,7 +181,7 @@ module ForemanRemoteExecution
           permission :view_job_invocations, { :job_invocations => [:index, :chart, :show, :auto_complete_search], :template_invocations => [:show],
                                               'api/v2/job_invocations' => [:index, :show, :output, :raw_output, :outputs] }, :resource_type => 'JobInvocation'
           permission :view_template_invocations, { :template_invocations => [:show],
-                                                   'api/v2/template_invocations' => [:template_invocations] }, :resource_type => 'TemplateInvocation'
+                                                   'api/v2/template_invocations' => [:template_invocations], :ui_job_wizard => [:job_invocation] }, :resource_type => 'TemplateInvocation'
           permission :create_template_invocations, {}, :resource_type => 'TemplateInvocation'
           permission :execute_jobs_on_infrastructure_hosts, {}, :resource_type => 'JobInvocation'
           permission :cancel_job_invocations, { :job_invocations => [:cancel], 'api/v2/job_invocations' => [:cancel] }, :resource_type => 'JobInvocation'
@@ -242,7 +242,7 @@ module ForemanRemoteExecution
           url_hash: { controller: 'job_wizard', action: :index },
           caption: N_('Job wizard'),
           parent: :lab_features_menu,
-          url: '/experimental/job_wizard',
+          url: '/experimental/job_wizard/new',
           after: :host_wizard
 
         register_custom_status HostStatus::ExecutionStatus
@@ -275,6 +275,7 @@ module ForemanRemoteExecution
 
         # Extend Registration module
         extend_allowed_registration_vars :remote_execution_interface
+        extend_allowed_registration_vars :setup_remote_execution_pull
         ForemanTasks.dynflow.eager_load_actions!
         extend_observable_events(
           ::Dynflow::Action.descendants.select do |klass|

data/lib/foreman_remote_execution/version.rb

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

data/test/functional/api/v2/job_invocations_controller_test.rb

@@ -82,6 +82,14 @@ module Api
           assert_response :success
         end
 
+        test 'should propagate errors from triggering' do
+          @attrs[:recurrence] = { cron_line: 'foo' }
+          post :create, params: { job_invocation: @attrs }
+          invocation = ActiveSupport::JSON.decode(@response.body)
+          assert_match(/foo is not valid format of cron line/, invocation['error']['message'])
+          assert_response 500
+        end
+
         test 'should create with schedule' do
           @attrs[:scheduling] = { start_at: Time.now.to_s }
           post :create, params: { job_invocation: @attrs }

data/test/helpers/remote_execution_helper_test.rb

@@ -37,5 +37,9 @@ class RemoteExecutionHelperTest < ActionView::TestCase
 
       assert_equal template.id, found_template.id
     end
+
+    it 'should not crash if the template cannot be found' do
+      assert_nil job_report_template
+    end
   end
 end

data/test/unit/api_params_test.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class ApiParamsTest < ActiveSupport::TestCase
+  describe '#format_datetime' do
+    let(:params) { JobInvocationComposer::ApiParams.allocate }
+
+    it 'leaves empty string as is' do
+      assert_equal params.send(:format_datetime, ''), ''
+    end
+
+    it 'honors explicitly supplied time zone' do
+      in_time_zone(ActiveSupport::TimeZone['America/New_York']) do
+        assert_equal '2022-07-08 08:53', params.send(:format_datetime, '2022-07-08 12:53:20 UTC')
+      end
+    end
+
+    it 'implicitly honors current user\'s time zone' do
+      in_time_zone(ActiveSupport::TimeZone['America/New_York']) do
+        assert_equal '2022-07-08 12:53', params.send(:format_datetime, '2022-07-08 12:53:20')
+      end
+    end
+  end
+
+  def in_time_zone(zone)
+    old_tz = Time.zone
+    Time.zone = zone
+    yield
+  ensure
+    Time.zone = old_tz
+  end
+end

data/test/unit/job_invocation_report_template_test.rb

@@ -9,7 +9,7 @@ class JobReportTemplateTest < ActiveSupport::TestCase
 
   context 'with valid job invocation report template' do
     let(:job_invocation_template) do
-      file_path = File.read(File.expand_path(Rails.root + "app/views/unattended/report_templates/job_invocation_-_report_template.erb"))
+      file_path = File.read(File.expand_path(Rails.root + "app/views/unattended/report_templates/job_-_invocation_report.erb"))
       template = ReportTemplate.import_without_save("Job Invocation Report Template", file_path)
       template.save!
       template

data/test/unit/job_invocation_test.rb

@@ -95,9 +95,8 @@ class JobInvocationTest < ActiveSupport::TestCase
       end
 
       it 'truncates generated description to 255 characters' do
-        column_limit = 255
+        column_limit = 255 # There is a 255 character limit on the database level
         expected_result = 'a' * column_limit
-        JobInvocation.columns_hash['description'].expects(:limit).returns(column_limit)
         job_invocation.description_format = '%{job_category}'
         job_invocation.job_category = 'a' * 1000
         job_invocation.generate_description

data/test/unit/remote_execution_provider_test.rb

@@ -33,6 +33,10 @@ class RemoteExecutionProviderTest < ActiveSupport::TestCase
     it 'accepts strings' do
       RemoteExecutionProvider.provider_for('SSH').must_equal SSHExecutionProvider
     end
+
+    it 'returns a default one if unknown value is provided' do
+      RemoteExecutionProvider.provider_for('WinRM').must_equal ScriptExecutionProvider
+    end
   end
 
   describe '.provider_names' do
@@ -52,6 +56,28 @@ class RemoteExecutionProviderTest < ActiveSupport::TestCase
     end
   end
 
+  describe '.provider_proxy_features' do
+    it 'returns correct values' do
+      RemoteExecutionProvider.stubs(:providers).returns(
+        :SSH => SSHExecutionProvider,
+        :script => ScriptExecutionProvider
+      )
+
+      features = RemoteExecutionProvider.provider_proxy_features
+      _(features).must_include 'SSH'
+      _(features).must_include 'Script'
+      RemoteExecutionProvider.unstub(:providers)
+    end
+
+    it 'can deal with non-arrays' do
+      provider = OpenStruct.new(proxy_feature: 'Testing')
+      RemoteExecutionProvider.stubs(:providers).returns(:testing => provider)
+      features = RemoteExecutionProvider.provider_proxy_features
+      _(features).must_include 'Testing'
+      RemoteExecutionProvider.unstub(:providers)
+    end
+  end
+
   describe '.host_setting' do
     let(:host) { FactoryBot.create(:host) }