foreman_remote_execution 7.0.0 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9183b3b81c3033d696f4aedf861cb5eed143fb9eacccb144a23d859e3ccae69
-  data.tar.gz: 4c7c6c09c84f3d4cbef2aaa8330b7bf048d42570e9319ad227c30abc5613770c
+  metadata.gz: b4f9d5aa836e3804a0b602bca132a51f4d3032b1276360f321867c135f9793c3
+  data.tar.gz: 7a6f9b518f336bbe91882e6c431a465b4aa80c3a262dba9e0789fecf1c9edf51
 SHA512:
-  metadata.gz: b35e41908b57f97f80272070d84b8d2ceeb7e061e22ad673d07c694a643d057399e207af9c8f36d14d535a7ddb3eddefa013e04b3d63689796e66e6d9aeae88b
-  data.tar.gz: 5c0b0d79edaab4c28721ad26df27ad8ac14878e09349929d28175c2cc1714ebb1f81ceb9f4824215d781dc1b4b0662962a9043f4f56963fea4d0aaa3e2483f8d
+  metadata.gz: 14cf218a2c1267baedcd0980adbe51207e9beebbe8c262e2506167a5a095fb5c14447bf58147efdb5eaaf3f56120d4463572ad1d01d981f93c33f37050b0115e
+  data.tar.gz: f2b7c73889c483a6f134c213c65df5ba21eddcc61b2b578b5f070a98e7ff9a9a0d269c1ad6dbc341285021189e02b973b0b77e90258537b8995adddd901bc5da

data/.github/workflows/ruby_ci.yml

@@ -18,6 +18,8 @@ jobs:
         with:
           ruby-version: 2.5
           bundler-cache: true
+          cache-version: 1
+          rubygems: 3.0.0
       - name: Run rubocop
         if: github.event_name != 'push'
         run: bundle exec rubocop --format github

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

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/lib/foreman_remote_execution/engine.rb

@@ -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 = '7.2.0'.freeze
 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/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) }
 

data/webpack/JobWizard/steps/AdvancedFields/AdvancedFields.js

@@ -16,6 +16,7 @@ import {
   TimeSpanLevelField,
   TemplateInputsFields,
   ExecutionOrderingField,
+  SSHUserField,
 } from './Fields';
 import { DescriptionField } from './DescriptionField';
 import { WIZARD_TITLES } from '../../JobWizardConstants';
@@ -40,6 +41,14 @@ export const AdvancedFields = ({
           value={advancedValues.templateValues}
           setValue={newValue => setAdvancedValues({ templateValues: newValue })}
         />
+        <SSHUserField
+          value={advancedValues.sshUser}
+          setValue={newValue =>
+            setAdvancedValues({
+              sshUser: newValue,
+            })
+          }
+        />
         {effectiveUser?.overridable && (
           <EffectiveUserField
             value={advancedValues.effectiveUserValue}

data/webpack/JobWizard/steps/AdvancedFields/Fields.js

@@ -203,6 +203,24 @@ export const ExecutionOrderingField = ({ isRandomizedOrdering, setValue }) => (
 export const TemplateInputsFields = ({ inputs, value, setValue }) => (
   <>{inputs?.map(input => formatter(input, value, setValue))}</>
 );
+
+export const SSHUserField = ({ value, setValue }) => (
+  <FormGroup
+    label={__('SSH user')}
+    labelIcon={helpLabel(__('A user to be used for SSH.'), 'ssh-user')}
+    fieldId="ssh-user"
+  >
+    <TextInput
+      aria-label="ssh user"
+      autoComplete="ssh-user"
+      id="ssh-user"
+      type="text"
+      value={value}
+      onChange={newValue => setValue(newValue)}
+    />
+  </FormGroup>
+);
+
 EffectiveUserField.propTypes = {
   value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
   setValue: PropTypes.func.isRequired,
@@ -240,3 +258,6 @@ TemplateInputsFields.propTypes = {
 TemplateInputsFields.defaultProps = {
   value: {},
 };
+
+SSHUserField.propTypes = EffectiveUserField.propTypes;
+SSHUserField.defaultProps = EffectiveUserField.defaultProps;

data/webpack/JobWizard/steps/AdvancedFields/__tests__/AdvancedFields.test.js

@@ -165,6 +165,11 @@ describe('AdvancedFields', () => {
       fireEvent.click(screen.getByText('Advanced fields'));
     });
 
+    expect(
+      screen.getByLabelText('ssh user', {
+        selector: 'input',
+      }).value
+    ).toBe('');
     expect(
       screen.getByLabelText('effective user', {
         selector: 'input',

data/webpack/JobWizard/steps/ReviewDetails/index.js

@@ -125,6 +125,7 @@ const ReviewDetails = ({
   ].filter(d => d);
 
   const advancedFields = [
+    { label: __('SSH user'), value: advancedValues.sshUser },
     { label: __('Effective user'), value: advancedValues.effectiveUserValue },
     { label: __('Description Template'), value: advancedValues.description },
     { label: __('Timeout to kill'), value: advancedValues.timeoutToKill },

data/webpack/JobWizard/submit.js

@@ -23,6 +23,7 @@ export const submit = ({
     purpose,
   } = scheduleValue;
   const {
+    sshUser,
     effectiveUserValue,
     effectiveUserPassword,
     description,
@@ -64,6 +65,7 @@ export const submit = ({
         : 'dynamic_query',
       randomized_ordering: isRandomizedOrdering,
       inputs: { ...templateValues, ...advancedTemplateValues },
+      ssh_user: sshUser,
       ssh: {
         effective_user: effectiveUserValue,
         effective_user_password: effectiveUserPassword,

data/webpack/react_app/components/FeaturesDropdown/index.js

@@ -52,7 +52,7 @@ const FeaturesDropdown = ({ hostId }) => {
       toggle={
         <DropdownToggle
           splitButtonItems={scheduleJob}
-          toggleVariant="primary"
+          toggleVariant="secondary"
           onToggle={() => setIsOpen(prev => !prev)}
           isDisabled={status === STATUS.PENDING}
           splitButtonVariant="action"

data/webpack/react_app/components/RegistrationExtension/RexPull.js

@@ -0,0 +1,73 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+
+import { translate as __ } from 'foremanReact/common/I18n';
+import LabelIcon from 'foremanReact/components/common/LabelIcon';
+
+import {
+  FormGroup,
+  FormSelectOption,
+  FormSelect,
+} from '@patternfly/react-core';
+
+const options = (value = '') => {
+  const defaultValue = value ? __('yes') : __('no');
+  const defaultLabel = `${__('Inherit from host parameter')} (${defaultValue})`;
+
+  return (
+    <>
+      <FormSelectOption key={0} value="" label={defaultLabel} />
+      <FormSelectOption key={1} value label={__('Yes (override)')} />
+      <FormSelectOption key={2} value={false} label={__('No (override)')} />
+    </>
+  );
+};
+
+const RexPull = ({ isLoading, onChange, pluginValues, configParams }) => (
+  <FormGroup
+    label={__('REX pull mode')}
+    isRequired
+    labelIcon={
+      <LabelIcon
+        text={__(
+          'Setup remote execution pull mode. If set to `Yes`, pull provider client will be deployed on the registered host. The inherited value is based on the `host_registration_remote_execution_pull` parameter. It can be inherited e.g. from host group, operating system, organization. When overridden, the selected value will be stored on host parameter level.'
+        )}
+      />
+    }
+    fieldId="registration_setup_remote_execution_pull"
+  >
+    <FormSelect
+      value={pluginValues.setupRemoteExecutionPull}
+      onChange={setupRemoteExecutionPull =>
+        onChange({ setupRemoteExecutionPull })
+      }
+      className="without_select2"
+      id="registration_setup_remote_execution_pull"
+      isDisabled={isLoading}
+      isRequired
+    >
+      {/* eslint-disable-next-line camelcase */
+      options(configParams?.host_registration_remote_execution_pull)}
+    </FormSelect>
+  </FormGroup>
+);
+
+RexPull.propTypes = {
+  onChange: PropTypes.func,
+  isLoading: PropTypes.bool,
+  pluginValues: PropTypes.shape({
+    setupRemoteExecutionPull: PropTypes.bool,
+  }),
+  configParams: PropTypes.shape({
+    host_registration_remote_execution_pull: PropTypes.bool,
+  }),
+};
+
+RexPull.defaultProps = {
+  onChange: undefined,
+  isLoading: false,
+  pluginValues: {},
+  configParams: {},
+};
+
+export default RexPull;

data/webpack/react_app/extend/Fills.js

@@ -3,6 +3,7 @@ import { addGlobalFill } from 'foremanReact/components/common/Fill/GlobalFill';
 
 import FeaturesDropdown from '../components/FeaturesDropdown';
 import RexInterface from '../components/RegistrationExtension/RexInterface';
+import RexPull from '../components/RegistrationExtension/RexPull';
 import RecentJobsCard from '../components/RecentJobsCard';
 import KebabItems from '../components/HostKebab/KebabItems';
 
@@ -25,6 +26,12 @@ const fills = [
     component: props => <RexInterface {...props} />,
     weight: 500,
   },
+  {
+    slot: 'registrationAdvanced',
+    name: 'pull',
+    component: props => <RexPull {...props} />,
+    weight: 500,
+  },
   {
     slot: '_rex-host-features',
     name: '_rex-host-features',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.2.0
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-16 00:00:00.000000000 Z
+date: 2022-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -389,6 +389,7 @@ files:
 - test/test_plugin_helper.rb
 - test/unit/actions/run_host_job_test.rb
 - test/unit/actions/run_hosts_job_test.rb
+- test/unit/api_params_test.rb
 - test/unit/concerns/foreman_tasks_cleaner_extensions_test.rb
 - test/unit/concerns/host_extensions_test.rb
 - test/unit/concerns/nic_extensions_test.rb
@@ -491,6 +492,7 @@ files:
 - webpack/react_app/components/RecentJobsCard/index.js
 - webpack/react_app/components/RecentJobsCard/styles.scss
 - webpack/react_app/components/RegistrationExtension/RexInterface.js
+- webpack/react_app/components/RegistrationExtension/RexPull.js
 - webpack/react_app/components/RegistrationExtension/__tests__/RexInterface.test.js
 - webpack/react_app/components/RegistrationExtension/__tests__/__snapshots__/RexInterface.test.js.snap
 - webpack/react_app/components/TargetingHosts/TargetingHosts.js
@@ -544,7 +546,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.26
 signing_key:
 specification_version: 4
 summary: A plugin bringing remote execution to the Foreman, completing the config
@@ -571,6 +573,7 @@ test_files:
 - test/test_plugin_helper.rb
 - test/unit/actions/run_host_job_test.rb
 - test/unit/actions/run_hosts_job_test.rb
+- test/unit/api_params_test.rb
 - test/unit/concerns/foreman_tasks_cleaner_extensions_test.rb
 - test/unit/concerns/host_extensions_test.rb
 - test/unit/concerns/nic_extensions_test.rb