foreman_remote_execution 8.0.0 → 8.1.0

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

@@ -1,3 +1,4 @@
+/* eslint-disable camelcase */
 import React from 'react';
 import PropTypes from 'prop-types';
 import { useSelector } from 'react-redux';
@@ -5,10 +6,13 @@ import { Form } from '@patternfly/react-core';
 import {
   selectEffectiveUser,
   selectAdvancedTemplateInputs,
+  selectJobTemplate,
 } from '../../JobWizardSelectors';
+import { generateDefaultDescription } from '../../JobWizardHelpers';
 import {
   EffectiveUserField,
   TimeoutToKillField,
+  TimeToPickupField,
   PasswordField,
   KeyPassphraseField,
   EffectiveUserPasswordField,
@@ -29,6 +33,7 @@ export const AdvancedFields = ({
 }) => {
   const effectiveUser = useSelector(selectEffectiveUser);
   const advancedTemplateInputs = useSelector(selectAdvancedTemplateInputs);
+  const jobTemplate = useSelector(selectJobTemplate);
   return (
     <>
       <WizardTitle
@@ -40,9 +45,11 @@ export const AdvancedFields = ({
           inputs={advancedTemplateInputs}
           value={advancedValues.templateValues}
           setValue={newValue => setAdvancedValues({ templateValues: newValue })}
+          defaultValue={jobTemplate}
         />
         <SSHUserField
           value={advancedValues.sshUser}
+          defaultValue={jobTemplate.ssh_user}
           setValue={newValue =>
             setAdvancedValues({
               sshUser: newValue,
@@ -52,6 +59,7 @@ export const AdvancedFields = ({
         {effectiveUser?.overridable && (
           <EffectiveUserField
             value={advancedValues.effectiveUserValue}
+            defaultValue={jobTemplate.effective_user?.value}
             setValue={newValue =>
               setAdvancedValues({
                 effectiveUserValue: newValue,
@@ -63,15 +71,30 @@ export const AdvancedFields = ({
           inputValues={{ ...templateValues, ...advancedValues.templateValues }}
           value={advancedValues.description}
           setValue={newValue => setAdvancedValues({ description: newValue })}
+          defaultValue={generateDefaultDescription({
+            description_format: jobTemplate.job_template.description_format,
+            advancedInputs: jobTemplate.advanced_template_inputs,
+            inputs: jobTemplate.template_inputs,
+            name: jobTemplate.job_template.name,
+          })}
         />
         <TimeoutToKillField
           value={advancedValues.timeoutToKill}
+          defaultValue={jobTemplate.job_template.execution_timeout_interval}
           setValue={newValue =>
             setAdvancedValues({
               timeoutToKill: newValue,
             })
           }
         />
+        <TimeToPickupField
+          value={advancedValues.timeToPickup}
+          setValue={newValue =>
+            setAdvancedValues({
+              timeToPickup: newValue,
+            })
+          }
+        />
         <PasswordField
           value={advancedValues.password}
           setValue={newValue =>
@@ -98,6 +121,7 @@ export const AdvancedFields = ({
         />
         <ConcurrencyLevelField
           value={advancedValues.concurrencyLevel}
+          defaultValue={jobTemplate.concurrency_control?.level}
           setValue={newValue =>
             setAdvancedValues({
               concurrencyLevel: newValue,
@@ -106,6 +130,7 @@ export const AdvancedFields = ({
         />
         <TimeSpanLevelField
           value={advancedValues.timeSpan}
+          defaultValue={jobTemplate.concurrency_control?.time_span}
           setValue={newValue =>
             setAdvancedValues({
               timeSpan: newValue,

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

@@ -7,8 +7,14 @@ import {
   selectTemplateInputs,
   selectAdvancedTemplateInputs,
 } from '../../JobWizardSelectors';
+import { ResetDefault } from '../form/FormHelpers';
 
-export const DescriptionField = ({ inputValues, value, setValue }) => {
+export const DescriptionField = ({
+  inputValues,
+  value,
+  setValue,
+  defaultValue,
+}) => {
   const inputs = [
     ...useSelector(selectTemplateInputs),
     ...useSelector(selectAdvancedTemplateInputs),
@@ -45,6 +51,9 @@ export const DescriptionField = ({ inputValues, value, setValue }) => {
   return (
     <FormGroup
       label={__('Description')}
+      labelInfo={
+        <ResetDefault setValue={setValue} defaultValue={defaultValue} />
+      }
       fieldId="description"
       helperText={
         <Button variant="link" isInline onClick={togglePreview}>
@@ -84,7 +93,9 @@ DescriptionField.propTypes = {
   inputValues: PropTypes.object.isRequired,
   value: PropTypes.string,
   setValue: PropTypes.func.isRequired,
+  defaultValue: PropTypes.string,
 };
 DescriptionField.defaultProps = {
   value: '',
+  defaultValue: '',
 };

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

@@ -2,11 +2,11 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import { FormGroup, TextInput, Radio } from '@patternfly/react-core';
 import { translate as __ } from 'foremanReact/common/I18n';
-import { helpLabel } from '../form/FormHelpers';
+import { helpLabel, ResetDefault } from '../form/FormHelpers';
 import { formatter } from '../form/Formatter';
 import { NumberInput } from '../form/NumberInput';
 
-export const EffectiveUserField = ({ value, setValue }) => (
+export const EffectiveUserField = ({ value, setValue, defaultValue }) => (
   <FormGroup
     label={__('Effective user')}
     labelIcon={helpLabel(
@@ -16,6 +16,7 @@ export const EffectiveUserField = ({ value, setValue }) => (
       'effective-user'
     )}
     fieldId="effective-user"
+    labelInfo={<ResetDefault setValue={setValue} defaultValue={defaultValue} />}
   >
     <TextInput
       aria-label="effective user"
@@ -28,7 +29,7 @@ export const EffectiveUserField = ({ value, setValue }) => (
   </FormGroup>
 );
 
-export const TimeoutToKillField = ({ value, setValue }) => (
+export const TimeoutToKillField = ({ value, setValue, defaultValue }) => (
   <NumberInput
     formProps={{
       label: __('Timeout to kill'),
@@ -39,6 +40,9 @@ export const TimeoutToKillField = ({ value, setValue }) => (
         'timeout-to-kill'
       ),
       fieldId: 'timeout-to-kill',
+      labelInfo: (
+        <ResetDefault setValue={setValue} defaultValue={defaultValue} />
+      ),
     }}
     inputProps={{
       value,
@@ -49,6 +53,26 @@ export const TimeoutToKillField = ({ value, setValue }) => (
     }}
   />
 );
+export const TimeToPickupField = ({ value, setValue }) => (
+  <NumberInput
+    formProps={{
+      label: __('Time to pickup'),
+      labelIcon: helpLabel(
+        __(
+          'Interval in seconds, if the job is not picked up by a client within this interval it will be cancelled.'
+        ),
+        'time-to-pickup'
+      ),
+      fieldId: 'time-to-pickup',
+    }}
+    inputProps={{
+      value,
+      autoComplete: 'time-to-pickup',
+      id: 'time-to-pickup',
+      onChange: newValue => setValue(newValue),
+    }}
+  />
+);
 
 export const PasswordField = ({ value, setValue }) => (
   <FormGroup
@@ -119,7 +143,7 @@ export const EffectiveUserPasswordField = ({ value, setValue }) => (
   </FormGroup>
 );
 
-export const ConcurrencyLevelField = ({ value, setValue }) => (
+export const ConcurrencyLevelField = ({ value, setValue, defaultValue }) => (
   <NumberInput
     formProps={{
       label: __('Concurrency level'),
@@ -130,6 +154,9 @@ export const ConcurrencyLevelField = ({ value, setValue }) => (
         'concurrency-level'
       ),
       fieldId: 'concurrency-level',
+      labelInfo: (
+        <ResetDefault setValue={setValue} defaultValue={defaultValue} />
+      ),
     }}
     inputProps={{
       min: 1,
@@ -142,7 +169,7 @@ export const ConcurrencyLevelField = ({ value, setValue }) => (
   />
 );
 
-export const TimeSpanLevelField = ({ value, setValue }) => (
+export const TimeSpanLevelField = ({ value, setValue, defaultValue }) => (
   <NumberInput
     formProps={{
       label: __('Time span'),
@@ -153,6 +180,9 @@ export const TimeSpanLevelField = ({ value, setValue }) => (
         'time-span'
       ),
       fieldId: 'time-span',
+      labelInfo: (
+        <ResetDefault setValue={setValue} defaultValue={defaultValue} />
+      ),
     }}
     inputProps={{
       min: 1,
@@ -204,11 +234,12 @@ export const TemplateInputsFields = ({ inputs, value, setValue }) => (
   <>{inputs?.map(input => formatter(input, value, setValue))}</>
 );
 
-export const SSHUserField = ({ value, setValue }) => (
+export const SSHUserField = ({ value, setValue, defaultValue }) => (
   <FormGroup
     label={__('SSH user')}
     labelIcon={helpLabel(__('A user to be used for SSH.'), 'ssh-user')}
     fieldId="ssh-user"
+    labelInfo={<ResetDefault setValue={setValue} defaultValue={defaultValue} />}
   >
     <TextInput
       aria-label="ssh user"
@@ -224,13 +255,17 @@ export const SSHUserField = ({ value, setValue }) => (
 EffectiveUserField.propTypes = {
   value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
   setValue: PropTypes.func.isRequired,
+  defaultValue: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
 };
 EffectiveUserField.defaultProps = {
   value: '',
+  defaultValue: null,
 };
 
 TimeoutToKillField.propTypes = EffectiveUserField.propTypes;
 TimeoutToKillField.defaultProps = EffectiveUserField.defaultProps;
+TimeToPickupField.propTypes = EffectiveUserField.propTypes;
+TimeToPickupField.defaultProps = EffectiveUserField.defaultProps;
 PasswordField.propTypes = EffectiveUserField.propTypes;
 PasswordField.defaultProps = EffectiveUserField.defaultProps;
 KeyPassphraseField.propTypes = EffectiveUserField.propTypes;

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

@@ -315,7 +315,7 @@ describe('AdvancedFields', () => {
             data: {
               ...jobTemplateResponse,
               job_template: {
-                ...jobTemplateResponse.jobTemplate,
+                ...jobTemplateResponse.job_template,
                 description_format: 'Run %{command}',
               },
 

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

@@ -49,7 +49,7 @@ Array [
         "port": null,
         "preventInvalidHostname": false,
         "protocol": null,
-        "query": "resource=ForemanTasks%3A%3ATask&name=",
+        "query": "resource=ForemanTasks%3A%3ATask",
         "urn": null,
         "username": null,
       },

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

@@ -42,8 +42,10 @@ export const CategoryAndTemplate = ({
   )?.name;
 
   const onSelectCategory = newCategory => {
-    setCategory(newCategory);
-    setJobTemplate(null);
+    if (selectedCategory !== newCategory) {
+      setCategory(newCategory);
+      setJobTemplate(null);
+    }
   };
   const { categoryError, allTemplatesError, templateError } = errors;
   const isError = !!(categoryError || allTemplatesError || templateError);

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

@@ -43,14 +43,18 @@ describe('Category And Template', () => {
 
     // Template
     fireEvent.click(
-      screen.getByDisplayValue('template1', { selector: 'button' })
+      screen.getByDisplayValue('Puppet Agent Disable - Script Default', {
+        selector: 'button',
+      })
     );
     await act(async () => {
       await fireEvent.click(screen.getByText('template2'));
     });
     fireEvent.click(screen.getAllByText(WIZARD_TITLES.categoryAndTemplate)[0]); // to remove focus
     expect(
-      screen.queryAllByDisplayValue('template1', { selector: 'button' })
+      screen.queryAllByDisplayValue('Puppet Agent Disable - Script Default', {
+        selector: 'button',
+      })
     ).toHaveLength(0);
     expect(
       screen.queryAllByDisplayValue('template2', { selector: 'button' })

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

@@ -11,6 +11,7 @@ import {
   selectCategoryError,
   selectAllTemplatesError,
   selectTemplateError,
+  selectJobTemplatesSearch,
 } from '../../JobWizardSelectors';
 import { CategoryAndTemplate } from './CategoryAndTemplate';
 
@@ -46,7 +47,8 @@ const ConnectedCategoryAndTemplate = ({
           }) => {
             if (!isCategoryPreselected) {
               setCategory(defaultCategory || jobCategories[0] || '');
-              if (defaultTemplate) setJobTemplate(defaultTemplate);
+              if (defaultTemplate)
+                setJobTemplate(current => current || defaultTemplate);
             }
           },
         })
@@ -56,27 +58,33 @@ const ConnectedCategoryAndTemplate = ({
   }, [jobCategoriesStatus]);
 
   const jobCategories = useSelector(selectJobCategories);
+  const jobTemplatesSearch = useSelector(selectJobTemplatesSearch);
   useEffect(() => {
     if (category) {
-      const templatesUrlObject = new URI(templatesUrl);
-      dispatch(
-        get({
-          key: JOB_TEMPLATES,
-          url: templatesUrlObject.addSearch({
-            search: `job_category="${category}"`,
-            per_page: 'all',
-          }),
-          handleSuccess: response => {
-            if (!jobTemplate)
-              setJobTemplate(
-                current =>
-                  current ||
-                  Number(filterJobTemplates(response?.data?.results)[0]?.id) ||
-                  null
-              );
-          },
-        })
-      );
+      const newJobTemplatesSearch = `job_category="${category}"`;
+      if (jobTemplatesSearch !== newJobTemplatesSearch) {
+        const templatesUrlObject = new URI(templatesUrl);
+        dispatch(
+          get({
+            key: JOB_TEMPLATES,
+            url: templatesUrlObject.addSearch({
+              search: newJobTemplatesSearch,
+              per_page: 'all',
+            }),
+            handleSuccess: response => {
+              if (!jobTemplate)
+                setJobTemplate(
+                  current =>
+                    current ||
+                    Number(
+                      filterJobTemplates(response?.data?.results)[0]?.id
+                    ) ||
+                    null
+                );
+            },
+          })
+        );
+      }
     }
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [category, dispatch]);

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

@@ -50,4 +50,36 @@ describe('TemplateInputs', () => {
     });
     expect(textField.value).toBe(textValue);
   });
+  it('should set back default data', async () => {
+    render(
+      <MockedProvider mocks={gqlMock} addTypename={false}>
+        <Provider store={store}>
+          <JobWizard />
+        </Provider>
+      </MockedProvider>
+    );
+    await act(async () => {
+      fireEvent.click(screen.getByText(WIZARD_TITLES.hostsAndInputs));
+    });
+    const textValue = 'I am a plain text';
+    const textField = screen.getByLabelText('plain hidden', {
+      selector: 'textarea',
+    });
+
+    await act(async () => {
+      await fireEvent.change(textField, {
+        target: { value: textValue },
+      });
+    });
+    expect(
+      screen.getByLabelText('plain hidden', {
+        selector: 'textarea',
+      }).value
+    ).toBe(textValue);
+
+    await act(async () => {
+      fireEvent.click(screen.getByText('Reset to default'));
+    });
+    expect(textField.value).toBe('Default val');
+  });
 });

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

@@ -35,7 +35,7 @@ import {
   hostQuerySearchID,
   HOSTS_API,
   HOSTS_TO_PREVIEW_AMOUNT,
-  DEBOUNCE_HOST_COUNT,
+  DEBOUNCE_API,
 } from '../../JobWizardConstants';
 import { WizardTitle } from '../form/WizardTitle';
 import { SelectAPI } from './SelectAPI';
@@ -66,7 +66,7 @@ const HostsAndInputs = ({
           },
         })
       );
-    }, DEBOUNCE_HOST_COUNT)();
+    }, DEBOUNCE_API)();
   }, [
     dispatch,
     selected,

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

@@ -127,6 +127,7 @@ const ReviewDetails = ({
     { label: __('Effective user'), value: advancedValues.effectiveUserValue },
     { label: __('Description Template'), value: advancedValues.description },
     { label: __('Timeout to kill'), value: advancedValues.timeoutToKill },
+    { label: __('Time to pickup'), value: advancedValues.timeToPickup },
     { label: __('Concurrency level'), value: advancedValues.concurrencyLevel },
     { label: __('Time span'), value: advancedValues.timeSpan },
     {

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

@@ -1,5 +1,6 @@
 import React from 'react';
-import { Popover } from '@patternfly/react-core';
+import PropTypes from 'prop-types';
+import { Popover, Button } from '@patternfly/react-core';
 import { HelpIcon } from '@patternfly/react-icons';
 import { translate as __ } from 'foremanReact/common/I18n';
 
@@ -22,3 +23,22 @@ export const helpLabel = (text, id) => {
 export const isPositiveNumber = text => parseInt(text, 10) > 0;
 
 export const isValidDate = d => d instanceof Date && !Number.isNaN(d);
+
+export const ResetDefault = ({ setValue, defaultValue }) =>
+  defaultValue && (
+    <Button
+      className="reset-default"
+      component="a"
+      variant="link"
+      isSmall
+      onClick={() => setValue(defaultValue)}
+    >
+      {__('Reset to default')}
+    </Button>
+  );
+
+ResetDefault.propTypes = {
+  setValue: PropTypes.func.isRequired,
+  defaultValue: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+};
+ResetDefault.defaultProps = { defaultValue: null };

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

@@ -6,9 +6,9 @@ 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 { helpLabel, ResetDefault } from './FormHelpers';
 import { SelectField } from './SelectField';
-import { ResourceSelectAPI } from './ResourceSelect';
+import { ResourceSelect } from './ResourceSelect';
 import { DateTimePicker } from '../form/DateTimePicker';
 import { noop } from '../../../helpers';
 
@@ -48,12 +48,15 @@ const TemplateSearchField = ({
     <FormGroup
       label={name}
       labelIcon={helpLabel(labelText, name)}
+      labelInfo={
+        <ResetDefault defaultValue={defaultValue} setValue={setSearch} />
+      }
       fieldId={id}
       isRequired={required}
       className="foreman-search-field"
     >
       <SearchBar
-        initialQuery={defaultValue}
+        initialQuery={values[name]}
         data={{
           ...props,
           autocomplete: {
@@ -80,10 +83,19 @@ export const formatter = (input, values, setValue) => {
     hidden_value: hidden,
     resource_type: resourceType,
     value_type: valueType,
+    default: defaultValue,
   } = input;
   const labelText = input.description;
   const value = values[name];
   const id = name.replace(/ /g, '-');
+
+  const labelInfo = (
+    <ResetDefault
+      defaultValue={defaultValue}
+      setValue={newValue => setValue({ ...values, [name]: newValue })}
+    />
+  );
+
   if (valueType === 'resource') {
     return (
       <FormGroup
@@ -92,12 +104,13 @@ export const formatter = (input, values, setValue) => {
         labelIcon={helpLabel(labelText, name)}
         isRequired={required}
         key={id}
+        labelInfo={labelInfo}
       >
-        <ResourceSelectAPI
+        <ResourceSelect
           name={name}
           apiKey={resourceType.replace('::', '')}
           url={`/ui_job_wizard/resources?resource=${resourceType}`}
-          selected={value || {}}
+          selected={value || ''}
           setSelected={newValue => setValue({ ...values, [name]: newValue })}
         />
       </FormGroup>
@@ -107,6 +120,7 @@ export const formatter = (input, values, setValue) => {
     const options = input.options.split(/\r?\n/).map(option => option.trim());
     return (
       <SelectField
+        labelInfo={labelInfo}
         key={id}
         isRequired={required}
         label={name}
@@ -121,6 +135,7 @@ export const formatter = (input, values, setValue) => {
   if (isTextType) {
     return (
       <FormGroup
+        labelInfo={labelInfo}
         key={name}
         label={name}
         labelIcon={helpLabel(labelText, name)}
@@ -142,6 +157,7 @@ export const formatter = (input, values, setValue) => {
   if (inputType === 'date') {
     return (
       <FormGroup
+        labelInfo={labelInfo}
         key={name}
         label={name}
         labelIcon={helpLabel(labelText, name)}
@@ -165,7 +181,7 @@ export const formatter = (input, values, setValue) => {
       <TemplateSearchField
         key={id}
         name={name}
-        defaultValue={value}
+        defaultValue={defaultValue}
         controller={controller}
         url={`/${controller}/auto_complete_search`}
         labelText={labelText}