foreman_remote_execution 8.0.0 → 8.1.0

data/webpack/JobWizard/steps/form/ResourceSelect.js

@@ -1,29 +1,116 @@
-import React from 'react';
+import React, { useState, useEffect } from 'react';
+import PropTypes from 'prop-types';
+import { Select, SelectOption, SelectVariant } from '@patternfly/react-core';
+import Immutable from 'seamless-immutable';
+import { sprintf, translate as __ } from 'foremanReact/common/I18n';
 import { useSelector, useDispatch } from 'react-redux';
 import URI from 'urijs';
 import { get } from 'foremanReact/redux/API';
 import { selectResponse, selectIsLoading } from '../../JobWizardSelectors';
-import { SearchSelect } from '../form/SearchSelect';
+import { DEBOUNCE_API } from '../../JobWizardConstants';
 
-export const useNameSearchAPI = (apiKey, url) => {
+export const ResourceSelect = ({
+  name,
+  selected,
+  setSelected,
+  placeholderText,
+  apiKey,
+  url,
+}) => {
+  const maxResults = 100;
   const dispatch = useDispatch();
   const uri = new URI(url);
   const onSearch = search => {
     dispatch(
       get({
         key: apiKey,
-        url: uri.addSearch({
-          name: search,
-        }),
+        url: uri.addSearch(search),
       })
     );
   };
 
   const response = useSelector(state => selectResponse(state, apiKey));
   const isLoading = useSelector(state => selectIsLoading(state, apiKey));
-  return [onSearch, response, isLoading];
+  const [isOpen, setIsOpen] = useState(false);
+  const [typingTimeout, setTypingTimeout] = useState(null);
+  useEffect(() => {
+    onSearch(selected ? { id: selected } : {});
+    if (typingTimeout) {
+      return () => clearTimeout(typingTimeout);
+    }
+    return undefined;
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
+  let selectOptions = [];
+  if (response.subtotal > maxResults) {
+    selectOptions = [
+      <SelectOption
+        isDisabled
+        key={0}
+        description={__('Please refine your search.')}
+      >
+        {sprintf(
+          __('You have %s results to display. Showing first %s results'),
+          response.subtotal,
+          maxResults
+        )}
+      </SelectOption>,
+    ];
+  }
+  selectOptions = [
+    ...selectOptions,
+    ...Immutable.asMutable(response?.results || [])?.map((result, index) => (
+      <SelectOption key={index + 1} value={result.id}>
+        {result.name}
+      </SelectOption>
+    )),
+  ];
+
+  const onSelect = (event, selection) => {
+    setSelected(selection);
+    setIsOpen(false);
+  };
+  const autoSearch = searchTerm => {
+    if (typingTimeout) clearTimeout(typingTimeout);
+    setTypingTimeout(
+      setTimeout(() => onSearch({ name: searchTerm }), DEBOUNCE_API)
+    );
+  };
+  return (
+    <Select
+      toggleAriaLabel={`${name} toggle`}
+      chipGroupComponent={<></>}
+      variant={SelectVariant.typeahead}
+      selections={selected}
+      loadingVariant={isLoading ? 'spinner' : null}
+      onSelect={onSelect}
+      onToggle={setIsOpen}
+      isOpen={isOpen}
+      className="without_select2"
+      maxHeight="45vh"
+      onTypeaheadInputChanged={value => {
+        autoSearch(value || '');
+      }}
+      placeholderText={placeholderText}
+      typeAheadAriaLabel={`${name} typeahead input`}
+    >
+      {selectOptions}
+    </Select>
+  );
 };
 
-export const ResourceSelectAPI = props => (
-  <SearchSelect {...props} useNameSearch={useNameSearchAPI} />
-);
+ResourceSelect.propTypes = {
+  name: PropTypes.string,
+  selected: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  setSelected: PropTypes.func.isRequired,
+  placeholderText: PropTypes.string,
+  apiKey: PropTypes.string.isRequired,
+  url: PropTypes.string,
+};
+
+ResourceSelect.defaultProps = {
+  name: 'typeahead select',
+  selected: {},
+  placeholderText: '',
+  url: '',
+};

data/webpack/JobWizard/steps/form/SearchSelect.js

@@ -3,6 +3,7 @@ import PropTypes from 'prop-types';
 import { Select, SelectOption, SelectVariant } from '@patternfly/react-core';
 import Immutable from 'seamless-immutable';
 import { sprintf, translate as __ } from 'foremanReact/common/I18n';
+import { DEBOUNCE_API } from '../../JobWizardConstants';
 
 export const maxResults = 100;
 
@@ -19,7 +20,6 @@ export const SearchSelect = ({
   const [onSearch, response, isLoading] = useNameSearch(apiKey, url);
   const [isOpen, setIsOpen] = useState(false);
   const [typingTimeout, setTypingTimeout] = useState(null);
-  const autoSearchDelay = 500;
   useEffect(() => {
     onSearch(selected.name || '');
     if (typingTimeout) {
@@ -71,7 +71,7 @@ export const SearchSelect = ({
   };
   const autoSearch = searchTerm => {
     if (typingTimeout) clearTimeout(typingTimeout);
-    setTypingTimeout(setTimeout(() => onSearch(searchTerm), autoSearchDelay));
+    setTypingTimeout(setTimeout(() => onSearch(searchTerm), DEBOUNCE_API));
   };
   return (
     <Select

data/webpack/JobWizard/steps/form/SelectField.js

@@ -3,6 +3,7 @@ import { FormGroup, Select, SelectOption } from '@patternfly/react-core';
 import PropTypes from 'prop-types';
 
 export const SelectField = ({
+  labelInfo,
   label,
   fieldId,
   options,
@@ -29,6 +30,7 @@ export const SelectField = ({
   ];
   return (
     <FormGroup
+      labelInfo={labelInfo}
       label={label}
       fieldId={fieldId}
       labelIcon={labelIcon}
@@ -54,6 +56,7 @@ export const SelectField = ({
 };
 SelectField.propTypes = {
   label: PropTypes.string,
+  labelInfo: PropTypes.node,
   fieldId: PropTypes.string.isRequired,
   options: PropTypes.array,
   value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
@@ -64,6 +67,7 @@ SelectField.propTypes = {
 
 SelectField.defaultProps = {
   label: null,
+  labelInfo: null,
   options: [],
   labelIcon: null,
   value: null,

data/webpack/JobWizard/submit.js

@@ -34,6 +34,7 @@ export const submit = ({
     templateValues: advancedTemplateValues,
     password,
     keyPassphrase,
+    timeToPickup,
   } = advancedValues;
   const getCronLine = () => {
     const [hour, minute] = repeatData.at
@@ -70,7 +71,7 @@ export const submit = ({
         : 'dynamic_query',
       randomized_ordering: isRandomizedOrdering,
       inputs: { ...templateValues, ...advancedTemplateValues },
-      ssh_user: sshUser,
+      ssh_user: sshUser || null,
       ssh: {
         effective_user: effectiveUserValue,
         effective_user_password: effectiveUserPassword,
@@ -107,6 +108,7 @@ export const submit = ({
       description_format: description,
       execution_timeout_interval: timeoutToKill,
       feature: '', // TODO add value after https://github.com/theforeman/foreman_remote_execution/pull/629
+      time_to_pickup: timeToPickup,
     },
   };
 

data/webpack/JobWizard/validation.js

@@ -39,6 +39,7 @@ export const useValidation = ({ advancedValues, templateValues }) => {
     );
     [
       advancedValues.timeoutToKill,
+      advancedValues.timeToPickup,
       advancedValues.concurrencyLevel,
       advancedValues.timeSpan,
     ].forEach(value => {

data/webpack/Routes/routes.js

@@ -4,12 +4,12 @@ import JobWizardPageRerun from '../JobWizard/JobWizardPageRerun';
 
 const ForemanREXRoutes = [
   {
-    path: '/experimental/job_wizard/new',
+    path: '/job_invocations/new',
     exact: true,
-    render: () => <JobWizardPage />,
+    render: props => <JobWizardPage {...props} />,
   },
   {
-    path: '/experimental/job_wizard/:id/rerun',
+    path: '/job_invocations/:id/rerun',
     exact: true,
     render: props => <JobWizardPageRerun {...props} />,
   },

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

@@ -7,7 +7,28 @@ export const runFeature = (hostId, feature, label) => dispatch => {
     `/job_invocations?feature=${feature}&host_ids%5B%5D=${hostId}`
   );
 
-  const successToast = () => sprintf(__('%s job has been invoked'), label);
+  const successToast = ({ request }) => {
+    if (request.responseURL.includes('job_invocations?')) {
+      return __('Opening job invocation form');
+    }
+    return sprintf(__('%s job has been invoked'), label);
+  };
   const errorToast = ({ message }) => message;
-  dispatch(post({ key: feature.toUpperCase(), url, successToast, errorToast }));
+  dispatch(
+    post({
+      key: feature.toUpperCase(),
+      url,
+      successToast,
+      errorToast,
+      handleSuccess: ({ request }) => {
+        if (request.responseURL.includes('job_invocations?')) {
+          // checking if user should be redicted to finish setting up the job
+          window.location.href = request.responseURL.replace(
+            'job_invocations?',
+            'job_invocations/new?'
+          );
+        }
+      },
+    })
+  );
 };

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

@@ -47,10 +47,12 @@ const FeaturesDropdown = ({ hostId }) => {
 
   return (
     <Dropdown
+      ouiaId="schedule-a-job-dropdown"
       alignments={{ default: 'right' }}
       onSelect={() => setIsOpen(false)}
       toggle={
         <DropdownToggle
+          ouiaId="schedule-a-job-dropdown-toggle"
           splitButtonItems={scheduleJob}
           toggleVariant="secondary"
           onToggle={() => setIsOpen(prev => !prev)}

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/extend/Fills.js

@@ -41,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: 8.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-03 00:00:00.000000000 Z
+date: 2022-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 7.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 7.1.0
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
@@ -149,8 +149,10 @@ files:
 - app/helpers/job_invocations_helper.rb
 - app/helpers/remote_execution_helper.rb
 - app/lib/actions/middleware/bind_job_invocation.rb
+- app/lib/actions/remote_execution/proxy_action.rb
 - app/lib/actions/remote_execution/run_host_job.rb
 - app/lib/actions/remote_execution/run_hosts_job.rb
+- app/lib/actions/remote_execution/template_invocation_progress_logging.rb
 - app/lib/foreman_remote_execution/provider_input.rb
 - app/lib/foreman_remote_execution/renderer/scope/input.rb
 - app/lib/proxy_api/remote_execution_ssh.rb
@@ -189,6 +191,7 @@ files:
 - app/models/targeting.rb
 - app/models/targeting_host.rb
 - app/models/template_invocation.rb
+- app/models/template_invocation_event.rb
 - app/models/template_invocation_input_value.rb
 - app/overrides/execution_interface.rb
 - app/overrides/subnet_proxies.rb
@@ -324,6 +327,8 @@ files:
 - db/migrate/20210816100932_rex_setting_category_to_dsl.rb
 - db/migrate/20220321101835_rename_ssh_provider_to_script.rb
 - db/migrate/20220331112719_add_ssh_user_to_job_invocation.rb
+- db/migrate/20220713095705_create_template_invocation_events.rb
+- db/migrate/20220822155946_add_time_to_pickup_to_job_invocation.rb
 - db/seeds.d/100-assign_features_with_templates.rb
 - db/seeds.d/20-permissions.rb
 - db/seeds.d/50-notification_blueprints.rb
@@ -339,6 +344,7 @@ files:
 - jsconfig.json
 - lib/foreman_remote_execution.rb
 - lib/foreman_remote_execution/engine.rb
+- lib/foreman_remote_execution/tasks/explain_proxy_selection.rake
 - lib/foreman_remote_execution/version.rb
 - lib/tasks/foreman_remote_execution_tasks.rake
 - locale/Makefile
@@ -408,6 +414,7 @@ files:
 - webpack/JobWizard/JobWizard.js
 - webpack/JobWizard/JobWizard.scss
 - webpack/JobWizard/JobWizardConstants.js
+- webpack/JobWizard/JobWizardHelpers.js
 - webpack/JobWizard/JobWizardPageRerun.js
 - webpack/JobWizard/JobWizardSelectors.js
 - webpack/JobWizard/__tests__/JobWizardPageRerun.test.js
@@ -548,7 +555,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.3.20
 signing_key:
 specification_version: 4
 summary: A plugin bringing remote execution to the Foreman, completing the config