foreman_remote_execution 4.4.0 → 4.5.3

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

@@ -0,0 +1,84 @@
+import React from 'react';
+import { Provider } from 'react-redux';
+import { mount } from '@theforeman/test';
+import { render, fireEvent, screen, act } from '@testing-library/react';
+import * as api from 'foremanReact/redux/API';
+import { JobWizard } from '../JobWizard';
+import * as selectors from '../JobWizardSelectors';
+import {
+  testSetup,
+  mockApi,
+  jobCategories,
+  jobTemplateResponse as jobTemplate,
+} from './fixtures';
+
+const store = testSetup(selectors, api);
+
+selectors.selectJobTemplate.mockImplementation(() => {});
+
+api.get.mockImplementation(({ handleSuccess, ...action }) => {
+  if (action.key === 'JOB_CATEGORIES') {
+    handleSuccess && handleSuccess({ data: { job_categories: jobCategories } });
+  }
+  return { type: 'get', ...action };
+});
+describe('Job wizard fill', () => {
+  it('should select template', async () => {
+    const wrapper = mount(
+      <Provider store={store}>
+        <JobWizard advancedValues={{}} setAdvancedValues={jest.fn()} />
+      </Provider>
+    );
+    expect(wrapper.find('.pf-c-wizard__nav-link.pf-m-disabled')).toHaveLength(
+      4
+    );
+    selectors.selectJobCategoriesStatus.mockImplementation(() => 'RESOLVED');
+    expect(store.getActions()).toMatchSnapshot('initial');
+
+    selectors.selectJobTemplate.mockImplementation(() => jobTemplate);
+    wrapper.find('.pf-c-button.pf-c-select__toggle-button').simulate('click');
+    await act(async () => {
+      await wrapper
+        .find('.pf-c-select__menu-item')
+        .first()
+        .simulate('click');
+      await wrapper.update();
+    });
+    expect(store.getActions().slice(-1)).toMatchSnapshot('select template');
+    expect(wrapper.find('.pf-c-wizard__nav-link.pf-m-disabled')).toHaveLength(
+      0
+    );
+  });
+
+  it('have all steps', async () => {
+    selectors.selectJobCategoriesStatus.mockImplementation(() => null);
+    selectors.selectJobTemplate.mockRestore();
+    selectors.selectJobTemplates.mockRestore();
+    selectors.selectJobCategories.mockRestore();
+    mockApi(api);
+
+    render(
+      <Provider store={store}>
+        <JobWizard />
+      </Provider>
+    );
+    const steps = [
+      'Target Hosts',
+      'Advanced Fields',
+      'Schedule',
+      'Review Details',
+      'Category and Template',
+    ];
+    // eslint-disable-next-line no-unused-vars
+    for await (const step of steps) {
+      const stepSelector = screen.getByText(step);
+      const stepTitle = screen.getAllByText(step);
+      expect(stepTitle).toHaveLength(1);
+      await act(async () => {
+        await fireEvent.click(stepSelector);
+      });
+      const stepTitles = screen.getAllByText(step);
+      expect(stepTitles).toHaveLength(3);
+    }
+  });
+});

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

@@ -0,0 +1,110 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { useSelector } from 'react-redux';
+import { Title, Form } from '@patternfly/react-core';
+import { translate as __ } from 'foremanReact/common/I18n';
+import {
+  selectEffectiveUser,
+  selectAdvancedTemplateInputs,
+  selectTemplateInputs,
+} from '../../JobWizardSelectors';
+import {
+  EffectiveUserField,
+  TimeoutToKillField,
+  PasswordField,
+  KeyPassphraseField,
+  EffectiveUserPasswordField,
+  ConcurrencyLevelField,
+  TimeSpanLevelField,
+  TemplateInputsFields,
+} from './Fields';
+import { DescriptionField } from './DescriptionField';
+
+export const AdvancedFields = ({ advancedValues, setAdvancedValues }) => {
+  const effectiveUser = useSelector(selectEffectiveUser);
+  const advancedTemplateInputs = useSelector(selectAdvancedTemplateInputs);
+  const templateInputs = useSelector(selectTemplateInputs);
+  return (
+    <>
+      <Title headingLevel="h2" className="advanced-fields-title">
+        {__('Advanced Fields')}
+      </Title>
+      <Form id="advanced-fields-job-template" autoComplete="off">
+        <TemplateInputsFields
+          inputs={advancedTemplateInputs}
+          value={advancedValues.templateValues}
+          setValue={newValue => setAdvancedValues({ templateValues: newValue })}
+        />
+        {effectiveUser?.overridable && (
+          <EffectiveUserField
+            value={advancedValues.effectiveUserValue}
+            setValue={newValue =>
+              setAdvancedValues({
+                effectiveUserValue: newValue,
+              })
+            }
+          />
+        )}
+        <DescriptionField
+          inputs={templateInputs}
+          value={advancedValues.description}
+          setValue={newValue => setAdvancedValues({ description: newValue })}
+        />
+        <TimeoutToKillField
+          value={advancedValues.timeoutToKill}
+          setValue={newValue =>
+            setAdvancedValues({
+              timeoutToKill: newValue,
+            })
+          }
+        />
+        <PasswordField
+          value={advancedValues.password}
+          setValue={newValue =>
+            setAdvancedValues({
+              password: newValue,
+            })
+          }
+        />
+        <KeyPassphraseField
+          value={advancedValues.keyPassphrase}
+          setValue={newValue =>
+            setAdvancedValues({
+              keyPassphrase: newValue,
+            })
+          }
+        />
+        <EffectiveUserPasswordField
+          value={advancedValues.effectiveUserPassword}
+          setValue={newValue =>
+            setAdvancedValues({
+              effectiveUserPassword: newValue,
+            })
+          }
+        />
+        <ConcurrencyLevelField
+          value={advancedValues.concurrencyLevel}
+          setValue={newValue =>
+            setAdvancedValues({
+              concurrencyLevel: newValue,
+            })
+          }
+        />
+        <TimeSpanLevelField
+          value={advancedValues.timeSpan}
+          setValue={newValue =>
+            setAdvancedValues({
+              timeSpan: newValue,
+            })
+          }
+        />
+      </Form>
+    </>
+  );
+};
+
+AdvancedFields.propTypes = {
+  advancedValues: PropTypes.object.isRequired,
+  setAdvancedValues: PropTypes.func.isRequired,
+};
+export default AdvancedFields;

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

@@ -0,0 +1,67 @@
+import React, { useState } from 'react';
+import PropTypes from 'prop-types';
+import { FormGroup, TextInput, Button } from '@patternfly/react-core';
+import { translate as __ } from 'foremanReact/common/I18n';
+
+export const DescriptionField = ({ inputs, value, setValue }) => {
+  const generateDesc = () => {
+    let newDesc = value;
+    if (value) {
+      const re = new RegExp('%\\{([^\\}]+)\\}', 'gm');
+      const results = [...newDesc.matchAll(re)].map(result => ({
+        name: result[1],
+        text: result[0],
+      }));
+      results.forEach(result => {
+        newDesc = newDesc.replace(
+          result.text,
+          // TODO: Replace with the value of the input from Target Hosts step
+          inputs.find(input => input.name === result.name)?.name || result.text
+        );
+      });
+    }
+    return newDesc;
+  };
+  const [generatedDesc, setGeneratedDesc] = useState(generateDesc());
+  const [isPreview, setIsPreview] = useState(true);
+
+  const togglePreview = () => {
+    setGeneratedDesc(generateDesc());
+    setIsPreview(v => !v);
+  };
+
+  return (
+    <FormGroup
+      label={__('Description')}
+      fieldId="description"
+      helperText={
+        <Button variant="link" isInline onClick={togglePreview}>
+          {isPreview
+            ? __('Edit job description template')
+            : __('Preview job description')}
+        </Button>
+      }
+    >
+      {isPreview ? (
+        <TextInput id="description-preview" value={generatedDesc} isDisabled />
+      ) : (
+        <TextInput
+          type="text"
+          autoComplete="description"
+          id="description"
+          value={value}
+          onChange={newValue => setValue(newValue)}
+        />
+      )}
+    </FormGroup>
+  );
+};
+
+DescriptionField.propTypes = {
+  inputs: PropTypes.array.isRequired,
+  value: PropTypes.string,
+  setValue: PropTypes.func.isRequired,
+};
+DescriptionField.defaultProps = {
+  value: '',
+};

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

@@ -0,0 +1,195 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { FormGroup, TextInput } from '@patternfly/react-core';
+import { translate as __ } from 'foremanReact/common/I18n';
+import { helpLabel } from '../form/FormHelpers';
+import { formatter } from '../form/Formatter';
+import { NumberInput } from '../form/NumberInput';
+
+export const EffectiveUserField = ({ value, setValue }) => (
+  <FormGroup
+    label={__('Effective user')}
+    labelIcon={helpLabel(
+      __(
+        'A user to be used for executing the script. If it differs from the SSH user, su or sudo is used to switch the accounts.'
+      ),
+      'effective-user'
+    )}
+    fieldId="effective-user"
+  >
+    <TextInput
+      autoComplete="effective-user"
+      id="effective-user"
+      type="text"
+      value={value}
+      onChange={newValue => setValue(newValue)}
+    />
+  </FormGroup>
+);
+
+export const TimeoutToKillField = ({ value, setValue }) => (
+  <NumberInput
+    formProps={{
+      label: __('Timeout to kill'),
+      labelIcon: helpLabel(
+        __(
+          'Time in seconds from the start on the remote host after which the job should be killed.'
+        ),
+        'timeout-to-kill'
+      ),
+      fieldId: 'timeout-to-kill',
+    }}
+    inputProps={{
+      value,
+      placeholder: __('For example: 1, 2, 3, 4, 5...'),
+      autoComplete: 'timeout-to-kill',
+      id: 'timeout-to-kill',
+      onChange: newValue => setValue(newValue),
+    }}
+  />
+);
+
+export const PasswordField = ({ value, setValue }) => (
+  <FormGroup
+    label={__('Password')}
+    labelIcon={helpLabel(
+      __(
+        'Password is stored encrypted in DB until the job finishes. For future or recurring executions, it is removed after the last execution.'
+      ),
+      'password'
+    )}
+    fieldId="job-password"
+  >
+    <TextInput
+      autoComplete="new-password" // to prevent firefox from autofilling the user password
+      id="job-password"
+      type="password"
+      placeholder="*****"
+      value={value}
+      onChange={newValue => setValue(newValue)}
+    />
+  </FormGroup>
+);
+
+export const KeyPassphraseField = ({ value, setValue }) => (
+  <FormGroup
+    label={__('Private key passphrase')}
+    labelIcon={helpLabel(
+      __(
+        'Key passphrase is only applicable for SSH provider. Other providers ignore this field. Passphrase is stored encrypted in DB until the job finishes. For future or recurring executions, it is removed after the last execution.'
+      ),
+      'key-passphrase'
+    )}
+    fieldId="key-passphrase"
+  >
+    <TextInput
+      autoComplete="key-passphrase"
+      id="key-passphrase"
+      type="password"
+      placeholder="*****"
+      value={value}
+      onChange={newValue => setValue(newValue)}
+    />
+  </FormGroup>
+);
+
+export const EffectiveUserPasswordField = ({ value, setValue }) => (
+  <FormGroup
+    label={__('Effective user password')}
+    labelIcon={helpLabel(
+      __(
+        'Effective user password is only applicable for SSH provider. Other providers ignore this field. Password is stored encrypted in DB until the job finishes. For future or recurring executions, it is removed after the last execution.'
+      ),
+      'effective-user-password'
+    )}
+    fieldId="effective-user-password"
+  >
+    <TextInput
+      autoComplete="effective-user-password"
+      id="effective-user-password"
+      type="password"
+      placeholder="*****"
+      value={value}
+      onChange={newValue => setValue(newValue)}
+    />
+  </FormGroup>
+);
+
+export const ConcurrencyLevelField = ({ value, setValue }) => (
+  <NumberInput
+    formProps={{
+      label: __('Concurrency level'),
+      labelIcon: helpLabel(
+        __(
+          'Run at most N tasks at a time. If this is set and proxy batch triggering is enabled, then tasks are triggered on the smart proxy in batches of size 1.'
+        ),
+        'concurrency-level'
+      ),
+      fieldId: 'concurrency-level',
+    }}
+    inputProps={{
+      min: 1,
+      autoComplete: 'concurrency-level',
+      id: 'concurrency-level',
+      placeholder: __('For example: 1, 2, 3, 4, 5...'),
+      value,
+      onChange: newValue => setValue(newValue),
+    }}
+  />
+);
+
+export const TimeSpanLevelField = ({ value, setValue }) => (
+  <NumberInput
+    formProps={{
+      label: __('Time span'),
+      labelIcon: helpLabel(
+        __(
+          'Distribute execution over N seconds. If this is set and proxy batch triggering is enabled, then tasks are triggered on the smart proxy in batches of size 1.'
+        ),
+        'time-span'
+      ),
+      fieldId: 'time-span',
+    }}
+    inputProps={{
+      min: 1,
+      autoComplete: 'time-span',
+      id: 'time-span',
+      placeholder: __('For example: 1, 2, 3, 4, 5...'),
+      value,
+      onChange: newValue => setValue(newValue),
+    }}
+  />
+);
+
+export const TemplateInputsFields = ({ inputs, value, setValue }) => (
+  <>{inputs?.map(input => formatter(input, value, setValue))}</>
+);
+EffectiveUserField.propTypes = {
+  value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  setValue: PropTypes.func.isRequired,
+};
+EffectiveUserField.defaultProps = {
+  value: '',
+};
+
+TimeoutToKillField.propTypes = EffectiveUserField.propTypes;
+TimeoutToKillField.defaultProps = EffectiveUserField.defaultProps;
+PasswordField.propTypes = EffectiveUserField.propTypes;
+PasswordField.defaultProps = EffectiveUserField.defaultProps;
+KeyPassphraseField.propTypes = EffectiveUserField.propTypes;
+KeyPassphraseField.defaultProps = EffectiveUserField.defaultProps;
+EffectiveUserPasswordField.propTypes = EffectiveUserField.propTypes;
+EffectiveUserPasswordField.defaultProps = EffectiveUserField.defaultProps;
+ConcurrencyLevelField.propTypes = EffectiveUserField.propTypes;
+ConcurrencyLevelField.defaultProps = EffectiveUserField.defaultProps;
+TimeSpanLevelField.propTypes = EffectiveUserField.propTypes;
+TimeSpanLevelField.defaultProps = EffectiveUserField.defaultProps;
+TemplateInputsFields.propTypes = {
+  inputs: PropTypes.array.isRequired,
+  value: PropTypes.object,
+  setValue: PropTypes.func.isRequired,
+};
+
+TemplateInputsFields.defaultProps = {
+  value: {},
+};