foreman_remote_execution 4.4.0 → 4.5.0

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

@@ -2,19 +2,12 @@ import React from 'react';
 import * as patternfly from '@patternfly/react-core';
 import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
 import JobWizardPage from '../index';
-import { JobWizard } from '../JobWizard';
 
 jest.spyOn(patternfly, 'Wizard');
-patternfly.Wizard.mockImplementation(props => <div>{props}</div>);
+patternfly.Wizard.mockImplementation(props => <div>{props.navAriaLabel}</div>);
+
 const fixtures = {
   'renders ': {},
 };
-describe('JobWizardPage', () => {
-  describe('rendering', () =>
-    testComponentSnapshotsWithFixtures(JobWizardPage, fixtures));
-});
-
-describe('JobWizard', () => {
-  describe('rendering', () =>
-    testComponentSnapshotsWithFixtures(JobWizard, fixtures));
-});
+describe('JobWizardPage rendering', () =>
+  testComponentSnapshotsWithFixtures(JobWizardPage, fixtures));

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

@@ -1,56 +1,5 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`JobWizard rendering renders  1`] = `
-<mockConstructor
-  className="job-wizard"
-  height="70vh"
-  navAriaLabel="Run Job steps"
-  onClose={[Function]}
-  steps={
-    Array [
-      Object {
-        "component": <ConnectedCategoryAndTemplate
-          category=""
-          jobTemplate={null}
-          setCategory={[Function]}
-          setJobTemplate={[Function]}
-        />,
-        "name": "Category and template",
-      },
-      Object {
-        "canJumpTo": false,
-        "component": <p>
-          TargetHosts 
-        </p>,
-        "name": "Target hosts",
-      },
-      Object {
-        "canJumpTo": false,
-        "component": <p>
-           AdvancedFields 
-        </p>,
-        "name": "Advanced fields",
-      },
-      Object {
-        "canJumpTo": false,
-        "component": <p>
-          Schedule
-        </p>,
-        "name": "Schedule",
-      },
-      Object {
-        "canJumpTo": false,
-        "component": <p>
-          ReviewDetails
-        </p>,
-        "name": "Review details",
-        "nextButtonText": "Run",
-      },
-    ]
-  }
-/>
-`;
-
 exports[`JobWizardPage rendering renders  1`] = `
 <PageLayout
   breadcrumbOptions={

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

@@ -0,0 +1,43 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Job wizard fill should select template: initial 1`] = `
+Array [
+  Object {
+    "key": "JOB_CATEGORIES",
+    "type": "get",
+    "url": "/ui_job_wizard/categories",
+  },
+  Object {
+    "key": "JOB_TEMPLATES",
+    "type": "get",
+    "url": URI {
+      "_deferred_build": true,
+      "_parts": Object {
+        "duplicateQueryParameters": false,
+        "escapeQuerySpace": true,
+        "fragment": null,
+        "hostname": null,
+        "password": null,
+        "path": "foreman/api/v2/job_templates",
+        "port": null,
+        "preventInvalidHostname": false,
+        "protocol": null,
+        "query": "search=job_category%3D%22Ansible+Commands%22&per_page=all",
+        "urn": null,
+        "username": null,
+      },
+      "_string": "",
+    },
+  },
+]
+`;
+
+exports[`Job wizard fill should select template: select template 1`] = `
+Array [
+  Object {
+    "key": "JOB_TEMPLATE",
+    "type": "get",
+    "url": "/ui_job_wizard/template/178",
+  },
+]
+`;

data/webpack/JobWizard/__tests__/fixtures.js

@@ -0,0 +1,26 @@
+const jobTemplate = {
+  id: 178,
+  name: 'Run Command - Ansible Default',
+  template:
+    "---\n- hosts: all\n  tasks:\n    - shell:\n        cmd: |\n<%=       indent(10) { input('command') } %>\n      register: out\n    - debug: var=out",
+  snippet: false,
+  default: true,
+  job_category: 'Ansible Commands',
+  provider_type: 'Ansible',
+  description_format: 'Run %{command}',
+  execution_timeout_interval: 2,
+  description: null,
+};
+
+export const jobTemplates = [jobTemplate];
+
+export const jobTemplateResponse = {
+  job_template: jobTemplate,
+  effective_user: {
+    id: null,
+    job_template_id: 178,
+    value: 'default effective user',
+    overridable: true,
+    current_user: false,
+  },
+};

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

@@ -0,0 +1,156 @@
+import React from 'react';
+import { Provider } from 'react-redux';
+import configureMockStore from 'redux-mock-store';
+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 { jobTemplates, jobTemplateResponse as jobTemplate } from './fixtures';
+
+jest.spyOn(api, 'get');
+jest.spyOn(selectors, 'selectJobTemplate');
+jest.spyOn(selectors, 'selectJobTemplates');
+jest.spyOn(selectors, 'selectJobCategories');
+jest.spyOn(selectors, 'selectJobCategoriesStatus');
+
+const jobCategories = ['Ansible Commands', 'Puppet', 'Services'];
+
+api.get.mockImplementation(({ handleSuccess, ...action }) => {
+  if (action.key === 'JOB_CATEGORIES') {
+    handleSuccess && handleSuccess({ data: { job_categories: jobCategories } });
+  } else if (action.key === 'JOB_TEMPLATE') {
+    handleSuccess &&
+      handleSuccess({
+        data: jobTemplate,
+      });
+  }
+  return { type: 'get', ...action };
+});
+
+selectors.selectJobTemplate.mockImplementation(() => null);
+selectors.selectJobCategories.mockImplementation(() => jobCategories);
+selectors.selectJobCategoriesStatus.mockImplementation(() => null);
+selectors.selectJobTemplates.mockImplementation(() => jobTemplates);
+
+const mockStore = configureMockStore([]);
+const store = mockStore({});
+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').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('should save data between steps for advanced fields', async () => {
+    const wrapper = mount(
+      <Provider store={store}>
+        <JobWizard advancedValues={{}} setAdvancedValues={jest.fn()} />
+      </Provider>
+    );
+    // setup
+    selectors.selectJobCategoriesStatus.mockImplementation(() => 'RESOLVED');
+    selectors.selectJobTemplate.mockImplementation(() => jobTemplate);
+    wrapper.find('.pf-c-button.pf-c-select__toggle-button').simulate('click');
+    wrapper.find('.pf-c-select__menu-item').simulate('click');
+
+    // test
+    expect(wrapper.find('.pf-c-wizard__nav-link.pf-m-disabled')).toHaveLength(
+      0
+    );
+    wrapper
+      .find('.pf-c-wizard__nav-link')
+      .at(2)
+      .simulate('click'); // Advanced step
+    const effectiveUserInput = () => wrapper.find('input#effective-user');
+    const effectiveUesrValue = 'effective user new value';
+    effectiveUserInput().getDOMNode().value = effectiveUesrValue;
+    await act(async () => {
+      await effectiveUserInput().simulate('change');
+      wrapper.update();
+    });
+
+    expect(effectiveUserInput().prop('value')).toEqual(effectiveUesrValue);
+
+    wrapper
+      .find('.pf-c-wizard__nav-link')
+      .at(1)
+      .simulate('click');
+
+    expect(wrapper.find('.pf-c-wizard__nav-link.pf-m-current').text()).toEqual(
+      'Target Hosts'
+    );
+    wrapper
+      .find('.pf-c-wizard__nav-link')
+      .at(2)
+      .simulate('click'); // Advanced step
+
+    expect(effectiveUserInput().prop('value')).toEqual(effectiveUesrValue);
+  });
+
+  it('have all steps', async () => {
+    selectors.selectJobCategoriesStatus.mockImplementation(() => null);
+    selectors.selectJobTemplate.mockRestore();
+    selectors.selectJobTemplates.mockRestore();
+    selectors.selectJobCategories.mockRestore();
+    api.get.mockImplementation(({ handleSuccess, ...action }) => {
+      if (action.key === 'JOB_CATEGORIES') {
+        handleSuccess &&
+          handleSuccess({ data: { job_categories: jobCategories } });
+      } else if (action.key === 'JOB_TEMPLATE') {
+        handleSuccess &&
+          handleSuccess({
+            data: jobTemplate,
+          });
+      } else if (action.key === 'JOB_TEMPLATES') {
+        handleSuccess &&
+          handleSuccess({
+            data: { results: [jobTemplate.job_template] },
+          });
+      }
+      return { type: 'get', ...action };
+    });
+
+    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,93 @@
+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 { selectJobTemplate } from '../../JobWizardSelectors';
+import {
+  EffectiveUserField,
+  TimeoutToKillField,
+  PasswordField,
+  KeyPassphraseField,
+  EffectiveUserPasswordField,
+  ConcurrencyLevelField,
+  TimeSpanLevelField,
+} from './Fields';
+
+export const AdvancedFields = ({ advancedValues, setAdvancedValues }) => {
+  const jobTemplate = useSelector(selectJobTemplate);
+  const effectiveUser = jobTemplate.effective_user;
+  return (
+    <>
+      <Title headingLevel="h2" className="advanced-fields-title">
+        {__('Advanced Fields')}
+      </Title>
+      <Form>
+        {effectiveUser?.overridable && (
+          <EffectiveUserField
+            value={advancedValues.effectiveUserValue}
+            setValue={newValue =>
+              setAdvancedValues({
+                effectiveUserValue: 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/Fields.js

@@ -0,0 +1,181 @@
+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';
+
+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 }) => (
+  <FormGroup
+    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"
+  >
+    <TextInput
+      type="number"
+      value={value}
+      placeholder={__('For example: 1, 2, 3, 4, 5...')}
+      autoComplete="timeout-to-kill"
+      id="timeout-to-kill"
+      onChange={newValue => setValue(newValue)}
+    />
+  </FormGroup>
+);
+
+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="password"
+  >
+    <TextInput
+      autoComplete="password"
+      id="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 }) => (
+  <FormGroup
+    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"
+  >
+    <TextInput
+      min={1}
+      type="number"
+      autoComplete="concurrency-level"
+      id="concurrency-level"
+      placeholder={__('For example: 1, 2, 3, 4, 5...')}
+      value={value}
+      onChange={newValue => setValue(newValue)}
+    />
+  </FormGroup>
+);
+
+export const TimeSpanLevelField = ({ value, setValue }) => (
+  <FormGroup
+    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"
+  >
+    <TextInput
+      min={1}
+      type="number"
+      autoComplete="time-span"
+      id="time-span"
+      placeholder={__('For example: 1, 2, 3, 4, 5...')}
+      value={value}
+      onChange={newValue => setValue(newValue)}
+    />
+  </FormGroup>
+);
+
+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;