foreman_remote_execution 5.1.0 → 6.2.0

data/package.json

@@ -21,20 +21,19 @@
   },
   "devDependencies": {
     "@babel/core": "^7.7.0",
-    "@theforeman/builder": "^8.16.0",
-    "@theforeman/eslint-plugin-foreman": "^8.16.0",
-    "@theforeman/stories": "^8.16.0",
-    "@theforeman/test": "^8.16.0",
-    "@theforeman/vendor-dev": "^8.16.0",
+    "@theforeman/builder": "^10.1.0",
+    "@theforeman/eslint-plugin-foreman": "^10.1.0",
+    "@theforeman/stories": "^10.1.0",
+    "@theforeman/test": "^10.1.0",
+    "@theforeman/vendor-dev": "^10.1.0",
     "babel-eslint": "^10.0.0",
     "eslint": "^6.8.0",
     "prettier": "^1.19.1",
-    "@patternfly/react-catalog-view-extension": "^4.8.126",
     "redux-mock-store": "^1.2.2",
     "graphql-tag": "^2.11.0",
     "graphql": "^15.5.0"
   },
   "peerDependencies": {
-    "@theforeman/vendor": "^8.16.0"
+    "@theforeman/vendor": "^10.1.0"
   }
 }

data/test/unit/concerns/host_extensions_test.rb

@@ -67,7 +67,8 @@ class ForemanRemoteExecutionHostExtensionsTest < ActiveSupport::TestCase
     it 'should only have one execution interface' do
       host.interfaces << FactoryBot.build(:nic_managed)
       host.interfaces.each { |interface| interface.execution = true }
-      _(host).wont_be :valid?
+      _(host).must_be :valid?
+      _(host.interfaces.count(&:execution?)).must_equal 1
     end
 
     it 'returns the execution interface' do

data/test/unit/remote_execution_provider_test.rb

@@ -6,9 +6,11 @@ class RemoteExecutionProviderTest < ActiveSupport::TestCase
     it { _(providers).must_be_kind_of HashWithIndifferentAccess }
     it 'makes providers accessible using symbol' do
       _(providers[:SSH]).must_equal SSHExecutionProvider
+      _(providers[:script]).must_equal ScriptExecutionProvider
     end
     it 'makes providers accessible using string' do
       _(providers['SSH']).must_equal SSHExecutionProvider
+      _(providers['script']).must_equal ScriptExecutionProvider
     end
   end
 

data/webpack/JobWizard/JobWizard.js

@@ -20,6 +20,8 @@ import {
   selectTemplateError,
   selectJobTemplate,
   selectIsSubmitting,
+  selectRouterSearch,
+  selectIsLoading,
 } from './JobWizardSelectors';
 import Schedule from './steps/Schedule/';
 import HostsAndInputs from './steps/HostsAndInputs/';
@@ -41,6 +43,7 @@ export const JobWizard = () => {
     hostGroups: [],
   });
   const [hostsSearchQuery, setHostsSearchQuery] = useState('');
+  const [fills, setFills] = useState(useSelector(selectRouterSearch));
   const dispatch = useDispatch();
 
   const setDefaults = useCallback(
@@ -49,17 +52,26 @@ export const JobWizard = () => {
         template_inputs,
         advanced_template_inputs,
         effective_user,
-        job_template: { name, execution_timeout_interval, description_format },
+        job_template: {
+          name,
+          execution_timeout_interval,
+          description_format,
+          job_category,
+        },
       },
     }) => {
+      if (!category.length) {
+        setCategory(current => (current.length ? current : job_category));
+      }
       const advancedTemplateValues = {};
       const defaultTemplateValues = {};
       const inputs = template_inputs;
       const advancedInputs = advanced_template_inputs;
       if (inputs) {
-        setTemplateValues(() => {
+        setTemplateValues(prev => {
           inputs.forEach(input => {
-            defaultTemplateValues[input.name] = input?.default || '';
+            defaultTemplateValues[input.name] =
+              prev[input.name] || input?.default || '';
           });
           return defaultTemplateValues;
         });
@@ -67,7 +79,8 @@ export const JobWizard = () => {
       setAdvancedValues(currentAdvancedValues => {
         if (advancedInputs) {
           advancedInputs.forEach(input => {
-            advancedTemplateValues[input.name] = input?.default || '';
+            advancedTemplateValues[input.name] =
+              currentAdvancedValues[input.name] || input?.default || '';
           });
         }
         const generateDefaultDescription = () => {
@@ -89,7 +102,7 @@ export const JobWizard = () => {
         };
       });
     },
-    []
+    [category.length]
   );
   useEffect(() => {
     if (jobTemplateID) {
@@ -108,15 +121,24 @@ export const JobWizard = () => {
     templateValues,
   });
   useAutoFill({
+    fills,
+    setFills,
     setSelectedTargets,
     setHostsSearchQuery,
+    setJobTemplateID,
+    setTemplateValues,
   });
   const templateError = !!useSelector(selectTemplateError);
   const templateResponse = useSelector(selectJobTemplate);
   const isSubmitting = useSelector(selectIsSubmitting);
+  const isTemplatesLoading = useSelector(state =>
+    selectIsLoading(state, JOB_TEMPLATE)
+  );
   const isTemplate =
-    !templateError && !!jobTemplateID && templateResponse.job_template;
-
+    !isTemplatesLoading &&
+    !templateError &&
+    !!jobTemplateID &&
+    templateResponse.job_template;
   const steps = [
     {
       name: WIZARD_TITLES.categoryAndTemplate,
@@ -126,6 +148,7 @@ export const JobWizard = () => {
           setJobTemplate={setJobTemplateID}
           category={category}
           setCategory={setCategory}
+          isFeature={!!fills.feature}
         />
       ),
       enableNext: isTemplate,

data/webpack/JobWizard/JobWizard.scss

@@ -103,4 +103,9 @@
       margin-left: 10px;
     }
   }
+  .foreman-search-field {
+    .autocomplete-search-btn {
+      display: none;
+    }
+  }
 }

data/webpack/JobWizard/JobWizardConstants.js

@@ -47,7 +47,7 @@ export const hostMethods = {
   searchQuery: __('Search query'),
 };
 
-export const hostQuerySearchID = 'searchBar'; // until https://projects.theforeman.org/issues/33737 is used
+export const hostQuerySearchID = 'mainHostQuery';
 export const hostsController = 'hosts';
 
 export const dataName = {
@@ -58,3 +58,4 @@ export const HOSTS_TO_PREVIEW_AMOUNT = 20;
 
 export const DEBOUNCE_HOST_COUNT = 700;
 export const HOST_IDS = 'HOST_IDS';
+export const REX_FEATURE = 'REX_FEATURE';

data/webpack/JobWizard/__tests__/fixtures.js

@@ -69,6 +69,7 @@ export const jobTemplateResponse = {
       default: '',
       hidden_value: false,
       url: 'foreman_tasks/tasks',
+      resource_type_tableize: 'hosts',
     },
     {
       name: 'adv date',
@@ -96,7 +97,7 @@ export const jobTemplateResponse = {
   ],
 };
 
-export const jobCategories = ['Ansible Commands', 'Puppet', 'Services'];
+export const jobCategories = ['Services', 'Ansible Commands', 'Puppet'];
 
 export const testSetup = (selectors, api) => {
   jest.spyOn(api, 'get');
@@ -149,7 +150,12 @@ export const mockApi = api => {
   api.get.mockImplementation(({ handleSuccess, ...action }) => {
     if (action.key === 'JOB_CATEGORIES') {
       handleSuccess &&
-        handleSuccess({ data: { job_categories: jobCategories } });
+        handleSuccess({
+          data: {
+            job_categories: jobCategories,
+            default_category: 'Ansible Commands',
+          },
+        });
     } else if (action.key === 'JOB_TEMPLATE') {
       handleSuccess &&
         handleSuccess({
@@ -165,6 +171,11 @@ export const mockApi = api => {
         handleSuccess({
           data: { results: [{ name: 'host1' }, { name: 'host3' }] },
         });
+    } else if (action.key === 'REX_FEATURE') {
+      handleSuccess &&
+        handleSuccess({
+          data: { job_template_id: 178 },
+        });
     }
     return { type: 'get', ...action };
   });

data/webpack/JobWizard/__tests__/integration.test.js

@@ -22,7 +22,12 @@ describe('Job wizard fill', () => {
     api.get.mockImplementation(({ handleSuccess, ...action }) => {
       if (action.key === 'JOB_CATEGORIES') {
         handleSuccess &&
-          handleSuccess({ data: { job_categories: jobCategories } });
+          handleSuccess({
+            data: {
+              job_categories: jobCategories,
+              default_category: 'Ansible Commands',
+            },
+          });
       } else if (action.key === 'JOB_TEMPLATE') {
         handleSuccess &&
           handleSuccess({

data/webpack/JobWizard/autofill.js

@@ -1,22 +1,29 @@
 import { useEffect } from 'react';
-import { useDispatch, useSelector } from 'react-redux';
+import { useDispatch } from 'react-redux';
 import { get } from 'foremanReact/redux/API';
-import { HOST_IDS } from './JobWizardConstants';
-import { selectRouterSearch } from './JobWizardSelectors';
+import { HOST_IDS, REX_FEATURE } from './JobWizardConstants';
 import './JobWizard.scss';
 
-export const useAutoFill = ({ setSelectedTargets, setHostsSearchQuery }) => {
-  const fills = useSelector(selectRouterSearch);
+export const useAutoFill = ({
+  fills,
+  setFills,
+  setSelectedTargets,
+  setHostsSearchQuery,
+  setJobTemplateID,
+  setTemplateValues,
+}) => {
   const dispatch = useDispatch();
 
   useEffect(() => {
     if (Object.keys(fills).length) {
-      if (fills['host_ids[]']) {
+      const { 'host_ids[]': hostIds, search, feature, ...rest } = { ...fills };
+      setFills({});
+      if (hostIds) {
         dispatch(
           get({
             key: HOST_IDS,
             url: '/api/hosts',
-            params: { search: `id = ${fills['host_ids[]'].join(' or id = ')}` },
+            params: { search: `id = ${hostIds.join(' or id = ')}` },
             handleSuccess: ({ data }) => {
               setSelectedTargets(currentTargets => ({
                 ...currentTargets,
@@ -29,8 +36,26 @@ export const useAutoFill = ({ setSelectedTargets, setHostsSearchQuery }) => {
           })
         );
       }
-      if (fills.search) {
-        setHostsSearchQuery(fills.search);
+      if (search) {
+        setHostsSearchQuery(search);
+      }
+      if (feature) {
+        dispatch(
+          get({
+            key: REX_FEATURE,
+            url: `/api/remote_execution_features/${feature}`,
+            handleSuccess: ({ data }) => {
+              setJobTemplateID(data.job_template_id);
+            },
+          })
+        );
+        Object.keys(rest).forEach(key => {
+          const re = /inputs\[(?<input>.*)\]/g;
+          const input = re.exec(key)?.groups?.input;
+          if (input) {
+            setTemplateValues(prev => ({ ...prev, [input]: rest[key] }));
+          }
+        });
       }
     }
     // eslint-disable-next-line react-hooks/exhaustive-deps

data/webpack/JobWizard/index.js

@@ -1,5 +1,4 @@
 import React from 'react';
-import PropTypes from 'prop-types';
 import { Title, Divider } from '@patternfly/react-core';
 import { translate as __ } from 'foremanReact/common/I18n';
 import PageLayout from 'foremanReact/routes/common/PageLayout/PageLayout';
@@ -30,10 +29,4 @@ const JobWizardPage = () => {
   );
 };
 
-JobWizardPage.propTypes = {
-  location: PropTypes.shape({
-    search: PropTypes.string,
-  }).isRequired,
-};
-
 export default JobWizardPage;

data/webpack/JobWizard/steps/CategoryAndTemplate/CategoryAndTemplate.js

@@ -1,11 +1,13 @@
 import React from 'react';
 import PropTypes from 'prop-types';
+import { useSelector } from 'react-redux';
 import { Text, TextVariants, Form, Alert } from '@patternfly/react-core';
 import { translate as __ } from 'foremanReact/common/I18n';
 import { SelectField } from '../form/SelectField';
 import { GroupedSelectField } from '../form/GroupedSelectField';
 import { WizardTitle } from '../form/WizardTitle';
-import { WIZARD_TITLES } from '../../JobWizardConstants';
+import { WIZARD_TITLES, JOB_TEMPLATES } from '../../JobWizardConstants';
+import { selectIsLoading } from '../../JobWizardSelectors';
 
 export const CategoryAndTemplate = ({
   jobCategories,
@@ -17,18 +19,23 @@ export const CategoryAndTemplate = ({
   errors,
 }) => {
   const templatesGroups = {};
-  jobTemplates.forEach(template => {
-    if (templatesGroups[template.provider_type]?.options)
-      templatesGroups[template.provider_type].options.push({
-        label: template.name,
-        value: template.id,
-      });
-    else
-      templatesGroups[template.provider_type] = {
-        options: [{ label: template.name, value: template.id }],
-        groupLabel: template.provider_type,
-      };
-  });
+  const isTemplatesLoading = useSelector(state =>
+    selectIsLoading(state, JOB_TEMPLATES)
+  );
+  if (!isTemplatesLoading) {
+    jobTemplates.forEach(template => {
+      if (templatesGroups[template.provider_type]?.options)
+        templatesGroups[template.provider_type].options.push({
+          label: template.name,
+          value: template.id,
+        });
+      else
+        templatesGroups[template.provider_type] = {
+          options: [{ label: template.name, value: template.id }],
+          groupLabel: template.provider_type,
+        };
+    });
+  }
 
   const selectedTemplate = jobTemplates.find(
     template => template.id === selectedTemplateID
@@ -60,8 +67,10 @@ export const CategoryAndTemplate = ({
           fieldId="job_template"
           groups={Object.values(templatesGroups)}
           setSelected={setJobTemplate}
-          selected={selectedTemplate}
-          isDisabled={!!(categoryError || allTemplatesError)}
+          selected={isTemplatesLoading ? [] : selectedTemplate}
+          isDisabled={
+            !!(categoryError || allTemplatesError || isTemplatesLoading)
+          }
           placeholderText={allTemplatesError ? __('Error') : ''}
         />
         {isError && (

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

@@ -25,6 +25,7 @@ const ConnectedCategoryAndTemplate = ({
   setJobTemplate,
   category,
   setCategory,
+  isFeature,
 }) => {
   const dispatch = useDispatch();
 
@@ -36,12 +37,23 @@ const ConnectedCategoryAndTemplate = ({
         get({
           key: JOB_CATEGORIES,
           url: '/ui_job_wizard/categories',
-          handleSuccess: response =>
-            setCategory(response.data.job_categories[0] || ''),
+          handleSuccess: ({
+            data: {
+              default_category: defaultCategory,
+              job_categories: jobCategories,
+              default_template: defaultTemplate,
+            },
+          }) => {
+            if (!isFeature) {
+              setCategory(defaultCategory || jobCategories[0] || '');
+              if (defaultTemplate) setJobTemplate(defaultTemplate);
+            }
+          },
         })
       );
     }
-  }, [jobCategoriesStatus, dispatch, setCategory]);
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [jobCategoriesStatus]);
 
   const jobCategories = useSelector(selectJobCategories);
   useEffect(() => {
@@ -55,14 +67,19 @@ const ConnectedCategoryAndTemplate = ({
             per_page: 'all',
           }),
           handleSuccess: response => {
-            setJobTemplate(
-              Number(filterJobTemplates(response?.data?.results)[0]?.id) || null
-            );
+            if (!jobTemplate)
+              setJobTemplate(
+                current =>
+                  current ||
+                  Number(filterJobTemplates(response?.data?.results)[0]?.id) ||
+                  null
+              );
           },
         })
       );
     }
-  }, [category, dispatch, setJobTemplate]);
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [category, dispatch]);
 
   const jobTemplates = useSelector(selectJobTemplates);
 
@@ -89,6 +106,7 @@ ConnectedCategoryAndTemplate.propTypes = {
   setJobTemplate: PropTypes.func.isRequired,
   category: PropTypes.string.isRequired,
   setCategory: PropTypes.func.isRequired,
+  isFeature: PropTypes.bool.isRequired,
 };
 ConnectedCategoryAndTemplate.defaultProps = { jobTemplate: null };
 

data/webpack/JobWizard/steps/HostsAndInputs/HostSearch.js

@@ -10,7 +10,7 @@ import { noop } from '../../../helpers';
 
 export const HostSearch = ({ value, setValue }) => {
   const searchQuery = useSelector(
-    state => state.autocomplete?.hostsSearch?.searchQuery
+    state => state.autocomplete?.[hostQuerySearchID]?.searchQuery
   );
   useEffect(() => {
     setValue(searchQuery || '');

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

@@ -148,4 +148,32 @@ describe('Hosts', () => {
     });
     expect(screen.queryAllByText('os=gnome')).toHaveLength(1);
   });
+
+  it('input fill from url', async () => {
+    const inputText = 'test text';
+    routerSelectors.selectRouterLocation.mockImplementation(() => ({
+      search: `feature=test_feature&inputs[plain hidden]=${inputText}`,
+    }));
+    render(
+      <MockedProvider mocks={gqlMock} addTypename={false}>
+        <Provider store={store}>
+          <JobWizard />
+        </Provider>
+      </MockedProvider>
+    );
+    api.get.mock.calls.forEach(call => {
+      if (call[0].key === 'REX_FEATURE') {
+        expect(call[0].url).toEqual(
+          '/api/remote_execution_features/test_feature'
+        );
+      }
+    });
+    await act(async () => {
+      fireEvent.click(screen.getByText('Target hosts and inputs'));
+    });
+    const textField = screen.getByLabelText('plain hidden', {
+      selector: 'textarea',
+    });
+    expect(textField.value).toBe(inputText);
+  });
 });

data/webpack/JobWizard/steps/Schedule/RepeatOn.js

@@ -21,7 +21,7 @@ export const RepeatOn = ({
 }) => {
   const [repeatValidated, setRepeatValidated] = useState('default');
   const handleRepeatInputChange = newValue => {
-    setRepeatValidated(newValue >= 1 ? 'default' : 'error');
+    setRepeatValidated(!newValue || newValue >= 1 ? 'default' : 'error');
     setRepeatAmount(newValue);
   };
 

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

@@ -1,9 +1,11 @@
 import React, { useEffect } from 'react';
-import { useSelector } from 'react-redux';
+import { useSelector, useDispatch } from 'react-redux';
 import { FormGroup, TextInput, TextArea } from '@patternfly/react-core';
 import PropTypes from 'prop-types';
 import SearchBar from 'foremanReact/components/SearchBar';
 import { getControllerSearchProps } from 'foremanReact/constants';
+import { TRIGGERS } from 'foremanReact/components/AutoComplete/AutoCompleteConstants';
+import { getResults } from 'foremanReact/components/AutoComplete/AutoCompleteActions';
 import { helpLabel } from './FormHelpers';
 import { SelectField } from './SelectField';
 import { ResourceSelectAPI } from './ResourceSelect';
@@ -22,12 +24,25 @@ const TemplateSearchField = ({
   const searchQuery = useSelector(
     state => state.autocomplete?.[name]?.searchQuery
   );
+  const dispatch = useDispatch();
   useEffect(() => {
     setValue({ ...values, [name]: searchQuery });
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [searchQuery]);
   const id = name.replace(/ /g, '-');
   const props = getControllerSearchProps(controller.replace('/', '_'), name);
+
+  const setSearch = newSearchQuery => {
+    dispatch(
+      getResults({
+        url,
+        searchQuery: newSearchQuery,
+        controller,
+        trigger: TRIGGERS.INPUT_CHANGE,
+        id: name,
+      })
+    );
+  };
   return (
     <FormGroup
       label={name}
@@ -45,9 +60,9 @@ const TemplateSearchField = ({
             url,
             useKeyShortcuts: true,
           },
-          bookmarks: null,
         }}
         onSearch={noop}
+        onBookmarkClick={search => setSearch(search)}
       />
     </FormGroup>
   );
@@ -152,7 +167,7 @@ export const formatter = (input, values, setValue) => {
         key={id}
         name={name}
         defaultValue={value}
-        controller={resourceType}
+        controller={controller}
         url={`/${controller}/auto_complete_search`}
         labelText={labelText}
         required={required}

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

@@ -69,6 +69,8 @@ export const GroupedSelectField = ({
         className="without_select2"
         onClear={onClear}
         menuAppendTo={() => document.body}
+        aria-labelledby={fieldId}
+        toggleAriaLabel={`${label} toggle`}
         {...props}
       >
         {options}
@@ -81,7 +83,11 @@ GroupedSelectField.propTypes = {
   label: PropTypes.string.isRequired,
   fieldId: PropTypes.string.isRequired,
   groups: PropTypes.array,
-  selected: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  selected: PropTypes.oneOfType([
+    PropTypes.string,
+    PropTypes.number,
+    PropTypes.array,
+  ]),
   setSelected: PropTypes.func.isRequired,
 };
 

data/webpack/__mocks__/foremanReact/components/Pagination.js

@@ -0,0 +1,2 @@
+const Pagination = () => jest.fn();
+export default Pagination;

data/webpack/__mocks__/foremanReact/constants.js

@@ -17,6 +17,7 @@ export const getControllerSearchProps = (
     useKeyShortcuts: true,
   },
   bookmarks: {
+    id,
     url: '/api/bookmarks',
     canCreate,
     documentationUrl: `4.1.5Searching`,

data/webpack/global_index.js

@@ -2,9 +2,13 @@ import { registerRoutes } from 'foremanReact/routes/RoutingService';
 import routes from './Routes/routes';
 import fillregistrationAdvanced from './react_app/extend/fillregistrationAdvanced';
 import fillRecentJobsCard from './react_app/extend/fillRecentJobsCard';
+import fillFeaturesDropdown from './react_app/extend/fillRexFeaturesDropdown';
+import fillKebabItems from './react_app/extend/fillKebabItems';
 import registerReducers from './react_app/extend/reducers';
 
 registerReducers();
 registerRoutes('foreman_remote_execution', routes);
+fillFeaturesDropdown();
 fillRecentJobsCard();
 fillregistrationAdvanced();
+fillKebabItems();

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

@@ -0,0 +1,13 @@
+import { foremanUrl } from 'foremanReact/common/helpers';
+import { sprintf, translate as __ } from 'foremanReact/common/I18n';
+import { post } from 'foremanReact/redux/API';
+
+export const runFeature = (hostId, feature, label) => dispatch => {
+  const url = foremanUrl(
+    `/job_invocations?feature=${feature}&host_ids%5B%5D=${hostId}`
+  );
+
+  const successToast = () => sprintf(__('%s job has been invoked'), label);
+  const errorToast = ({ message }) => message;
+  dispatch(post({ key: feature.toUpperCase(), url, successToast, errorToast }));
+};

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

@@ -0,0 +1,2 @@
+export const REX_FEATURES_API = '/api/remote_execution_features';
+export const NEW_JOB_PAGE = '/job_invocations/new?host_ids%5B%5D';