foreman_remote_execution 7.1.0 → 7.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7c8e05850731a1f10e902deaa2e6797b869bb3363607af339e6a683225fa78a
-  data.tar.gz: b5a2001957310aeb3a7353efa65592bae1dbb3fcabb68677516220674cea94b2
+  metadata.gz: 893050d86f8ab746da3173f25cc9a062454bf9262316f0a6fbb5f89a6282c15f
+  data.tar.gz: 02e623b7202ec926f0d744cbfadbbe5f86a7950cd3665c91a3b7ec74a2b02cd2
 SHA512:
-  metadata.gz: 03daea7eb15788a97f841d80fddeb3c40c89e79bba550ca7ef9a2eab5ad6646ec13de8d134490a5fb5171d8aeb937e792a88f62588a468613a71948cb0212ba3
-  data.tar.gz: e1ed8ff83ae15794ca4bcca7bdeb7cd7fef930f6c41394538e14fafa5fcb5f738535a3e1096bd6ee1856f3b95a4299ebdb6cf50aafa94ea233724599cea67395
+  metadata.gz: c488b0d6edc98ce77e66edefc2c0f298c323bfd0aa6f0d46a3dbbc4b4642bbe9ac8f2112c237460095f47c5494d5ad7112482475fc886d596e9698fe0cac128f
+  data.tar.gz: eb73a3df7acbfa047699d349fcb03393850b5ddded2ed31b3cd30e38b15d3a516e608a17e33f29237271e012c9de69bb7929801de4f8605d8a4b3b59590b73e8

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/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
 
@@ -62,14 +62,16 @@ class JobInvocation < ApplicationRecord
 
   has_many :targeted_hosts, :through => :targeting, :source => :hosts
   scoped_search :on => 'targeted_host_id', :rename => 'targeted_host_id', :operators => ['= '],
-    :complete_value => false, :only_explicit => true, :ext_method => :search_by_targeted_host
+    :complete_value => false, :only_explicit => true, :ext_method => :search_by_targeted_host,
+    :validator => ScopedSearch::Validators::INTEGER
 
   scoped_search :on => 'pattern_template_name', :rename => 'pattern_template_name', :operators => ['= '],
     :complete_value => false, :only_explicit => true, :ext_method => :search_by_pattern_template
 
   scoped_search :relation => :recurring_logic, :on => 'purpose', :rename => 'recurring_logic.purpose'
 
-  scoped_search :relation => :recurring_logic, :on => 'id', :rename => 'recurring_logic.id'
+  scoped_search :relation => :recurring_logic, :on => 'id', :rename => 'recurring_logic.id',
+    :validator => ScopedSearch::Validators::INTEGER
 
   scoped_search :relation => :recurring_logic, :on => 'id', :rename => 'recurring',
     :ext_method => :search_by_recurring_logic, :only_explicit => 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/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/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.1.0'.freeze
+  VERSION = '7.2.1'.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/react_app/components/HostKebab/KebabItems.js

@@ -14,6 +14,7 @@ const HostKebabItems = () => {
   if (!consoleUrl) return null;
   return (
     <DropdownItem
+      ouiaId="web-console-dropdown-item"
       icon={<CodeIcon />}
       href={consoleUrl}
       target="_blank"

data/webpack/react_app/components/RecentJobsCard/RecentJobsCard.js

@@ -27,6 +27,7 @@ const RecentJobsCard = ({ hostDetails: { name, id } }) => {
         <DropdownItem
           href={foremanUrl(`${JOB_BASE_URL}${name}`)}
           key="link-to-all"
+          ouiaId="link-to-all-dropdown-item"
         >
           {__('View all jobs')}
         </DropdownItem>,
@@ -35,24 +36,28 @@ const RecentJobsCard = ({ hostDetails: { name, id } }) => {
             `${JOB_BASE_URL}${name}+and+status+%3D+failed+or+status%3D+succeeded`
           )}
           key="link-to-finished"
+          ouiaId="link-to-finished-dropdown-item"
         >
           {__('View finished jobs')}
         </DropdownItem>,
         <DropdownItem
           href={foremanUrl(`${JOB_BASE_URL}${name}+and+status+%3D+running`)}
           key="link-to-running"
+          ouiaId="link-to-running-dropdown-item"
         >
           {__('View running jobs')}
         </DropdownItem>,
         <DropdownItem
           href={foremanUrl(`${JOB_BASE_URL}${name}+and+status+%3D+queued`)}
           key="link-to-scheduled"
+          ouiaId="link-to-scheduled-dropdown-item"
         >
           {__('View scheduled jobs')}
         </DropdownItem>,
       ]}
     >
       <Tabs
+        ouiaId="tabs"
         mountOnEnter
         unmountOnExit
         activeKey={activeTab}

data/webpack/react_app/components/RecentJobsCard/RecentJobsTable.js

@@ -1,15 +1,7 @@
 import PropTypes from 'prop-types';
 import React from 'react';
-import {
-  DataList,
-  DataListItem,
-  DataListItemRow,
-  DataListItemCells,
-  DataListCell,
-  DataListWrapModifier,
-  Text,
-  Bullseye,
-} from '@patternfly/react-core';
+import { Text, Bullseye } from '@patternfly/react-core';
+import { TableComposable, Tr, Tbody, Td } from '@patternfly/react-table';
 import { STATUS } from 'foremanReact/constants';
 
 import RelativeDateTime from 'foremanReact/components/common/dates/RelativeDateTime';
@@ -33,55 +25,55 @@ const RecentJobsTable = ({ status, hostId }) => {
   } = useAPI('get', jobsUrl, RECENT_JOBS_KEY);
 
   return (
-    <DataList aria-label="recent-jobs-table" isCompact>
-      <SkeletonLoader
-        skeletonProps={{ count: 3 }}
-        status={responseStatus || STATUS.PENDING}
-        emptyState={
-          <Bullseye>
-            <Text style={{ marginTop: '20px' }} component="p">
-              {__('No results found')}
-            </Text>
-          </Bullseye>
-        }
-      >
-        {jobs?.length &&
-          jobs.map(
-            ({
-              status: jobStatus,
-              status_label: label,
-              id,
-              start_at: startAt,
-              description,
-            }) => (
-              <DataListItem key={id}>
-                <DataListItemRow>
-                  <DataListItemCells
-                    dataListCells={[
-                      <DataListCell
-                        wrapModifier={DataListWrapModifier.truncate}
-                        key={`name-${id}`}
-                      >
-                        <a href={foremanUrl(`/job_invocations/${id}`)}>
-                          {description}
-                        </a>
-                      </DataListCell>,
-                      <DataListCell key={`date-${id}`}>
-                        <RelativeDateTime date={startAt} />
-                      </DataListCell>,
-                      <DataListCell key={`status-${id}`}>
-                        <JobStatusIcon status={jobStatus}>
-                          {label}
-                        </JobStatusIcon>
-                      </DataListCell>,
-                    ]}
-                  />
-                </DataListItemRow>
-              </DataListItem>
-            )
-          )}
-      </SkeletonLoader>
-    </DataList>
+    <SkeletonLoader
+      skeletonProps={{ count: 3 }}
+      status={responseStatus || STATUS.PENDING}
+      emptyState={
+        <Bullseye>
+          <Text
+            ouiaId="no-results-text"
+            style={{ marginTop: '20px' }}
+            component="p"
+          >
+            {__('No results found')}
+          </Text>
+        </Bullseye>
+      }
+    >
+      {!!jobs?.length && (
+        <TableComposable
+          aria-label="recent-jobs-table"
+          variant="compact"
+          borders="compactBorderless"
+        >
+          <Tbody>
+            {jobs.map(
+              ({
+                status: jobStatus,
+                status_label: label,
+                id,
+                start_at: startAt,
+                description,
+              }) => (
+                <Tr key={id}>
+                  <Td modifier="truncate" key={`name-${id}`}>
+                    <a href={foremanUrl(`/job_invocations/${id}`)}>
+                      {description}
+                    </a>
+                  </Td>
+                  <Td modifier="truncate" key={`date-${id}`}>
+                    <RelativeDateTime date={startAt} />
+                  </Td>
+                  <Td modifier="truncate" key={`status-${id}`}>
+                    <JobStatusIcon status={jobStatus}>{label}</JobStatusIcon>
+                  </Td>
+                </Tr>
+              )
+            )}
+          </Tbody>
+        </TableComposable>
+      )}
+    </SkeletonLoader>
   );
 };
 

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',
@@ -34,11 +41,11 @@ const fills = [
 ];
 
 const registerFills = () => {
-  fills.forEach(({ slot, id, component: Component, weight, metadata }) =>
+  fills.forEach(({ slot, name, component: Component, weight, metadata }) =>
     addGlobalFill(
       slot,
-      id,
-      <Component key={`rex-fill-${id}`} />,
+      `rex-${name}`,
+      <Component key={`rex-${name}`} />,
       weight,
       metadata
     )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 7.2.1
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-13 00:00:00.000000000 Z
+date: 2022-09-06 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.3.20
 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