foreman_remote_execution 4.2.2 → 4.5.0

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

@@ -0,0 +1,25 @@
+import React from 'react';
+import { Provider } from 'react-redux';
+import configureMockStore from 'redux-mock-store';
+import * as patternfly from '@patternfly/react-core';
+import { mount } from '@theforeman/test';
+import { AdvancedFields } from '../AdvancedFields';
+
+jest.spyOn(patternfly, 'FormGroup');
+patternfly.FormGroup.mockImplementation(props => (
+  <div>{props.navAriaLabel}</div>
+));
+const mockStore = configureMockStore([]);
+const store = mockStore({
+  JOB_TEMPLATE: { response: { effective_user: { overridable: true } } },
+});
+describe('AdvancedFields', () => {
+  it('rendring', () => {
+    const component = mount(
+      <Provider store={store}>
+        <AdvancedFields advancedValues={{}} setAdvancedValues={jest.fn()} />
+      </Provider>
+    );
+    expect(component).toMatchSnapshot();
+  });
+});

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

@@ -0,0 +1,249 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AdvancedFields rendring 1`] = `
+<Provider
+  store={
+    Object {
+      "clearActions": [Function],
+      "dispatch": [Function],
+      "getActions": [Function],
+      "getState": [Function],
+      "replaceReducer": [Function],
+      "subscribe": [Function],
+    }
+  }
+>
+  <AdvancedFields
+    advancedValues={Object {}}
+    setAdvancedValues={[MockFunction]}
+  >
+    <Title
+      className="advanced-fields-title"
+      headingLevel="h2"
+    >
+      <h2
+        className="pf-c-title pf-m-xl advanced-fields-title"
+      >
+        Advanced Fields
+      </h2>
+    </Title>
+    <Form>
+      <form
+        className="pf-c-form"
+        noValidate={true}
+      >
+        <EffectiveUserField
+          setValue={[Function]}
+          value=""
+        >
+          <mockConstructor
+            fieldId="effective-user"
+            label="Effective user"
+            labelIcon={
+              <Popover
+                aria-label="help-text"
+                bodyContent="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."
+                id="effective-user-help"
+              >
+                <button
+                  aria-label="open-help-tooltip-button"
+                  className="pf-c-form__group-label-help"
+                  onClick={[Function]}
+                >
+                  <HelpIcon
+                    color="currentColor"
+                    noVerticalAlign={true}
+                    size="sm"
+                  />
+                </button>
+              </Popover>
+            }
+          >
+            <div />
+          </mockConstructor>
+        </EffectiveUserField>
+        <TimeoutToKillField
+          setValue={[Function]}
+          value=""
+        >
+          <mockConstructor
+            fieldId="timeout-to-kill"
+            label="Timeout to kill"
+            labelIcon={
+              <Popover
+                aria-label="help-text"
+                bodyContent="Time in seconds from the start on the remote host after which the job should be killed."
+                id="timeout-to-kill-help"
+              >
+                <button
+                  aria-label="open-help-tooltip-button"
+                  className="pf-c-form__group-label-help"
+                  onClick={[Function]}
+                >
+                  <HelpIcon
+                    color="currentColor"
+                    noVerticalAlign={true}
+                    size="sm"
+                  />
+                </button>
+              </Popover>
+            }
+          >
+            <div />
+          </mockConstructor>
+        </TimeoutToKillField>
+        <PasswordField
+          setValue={[Function]}
+          value=""
+        >
+          <mockConstructor
+            fieldId="password"
+            label="Password"
+            labelIcon={
+              <Popover
+                aria-label="help-text"
+                bodyContent="Password is stored encrypted in DB until the job finishes. For future or recurring executions, it is removed after the last execution."
+                id="password-help"
+              >
+                <button
+                  aria-label="open-help-tooltip-button"
+                  className="pf-c-form__group-label-help"
+                  onClick={[Function]}
+                >
+                  <HelpIcon
+                    color="currentColor"
+                    noVerticalAlign={true}
+                    size="sm"
+                  />
+                </button>
+              </Popover>
+            }
+          >
+            <div />
+          </mockConstructor>
+        </PasswordField>
+        <KeyPassphraseField
+          setValue={[Function]}
+          value=""
+        >
+          <mockConstructor
+            fieldId="key-passphrase"
+            label="Private key passphrase"
+            labelIcon={
+              <Popover
+                aria-label="help-text"
+                bodyContent="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."
+                id="key-passphrase-help"
+              >
+                <button
+                  aria-label="open-help-tooltip-button"
+                  className="pf-c-form__group-label-help"
+                  onClick={[Function]}
+                >
+                  <HelpIcon
+                    color="currentColor"
+                    noVerticalAlign={true}
+                    size="sm"
+                  />
+                </button>
+              </Popover>
+            }
+          >
+            <div />
+          </mockConstructor>
+        </KeyPassphraseField>
+        <EffectiveUserPasswordField
+          setValue={[Function]}
+          value=""
+        >
+          <mockConstructor
+            fieldId="effective-user-password"
+            label="Effective user password"
+            labelIcon={
+              <Popover
+                aria-label="help-text"
+                bodyContent="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."
+                id="effective-user-password-help"
+              >
+                <button
+                  aria-label="open-help-tooltip-button"
+                  className="pf-c-form__group-label-help"
+                  onClick={[Function]}
+                >
+                  <HelpIcon
+                    color="currentColor"
+                    noVerticalAlign={true}
+                    size="sm"
+                  />
+                </button>
+              </Popover>
+            }
+          >
+            <div />
+          </mockConstructor>
+        </EffectiveUserPasswordField>
+        <ConcurrencyLevelField
+          setValue={[Function]}
+          value=""
+        >
+          <mockConstructor
+            fieldId="concurrency-level"
+            label="Concurrency level"
+            labelIcon={
+              <Popover
+                aria-label="help-text"
+                bodyContent="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."
+                id="concurrency-level-help"
+              >
+                <button
+                  aria-label="open-help-tooltip-button"
+                  className="pf-c-form__group-label-help"
+                  onClick={[Function]}
+                >
+                  <HelpIcon
+                    color="currentColor"
+                    noVerticalAlign={true}
+                    size="sm"
+                  />
+                </button>
+              </Popover>
+            }
+          >
+            <div />
+          </mockConstructor>
+        </ConcurrencyLevelField>
+        <TimeSpanLevelField
+          setValue={[Function]}
+          value=""
+        >
+          <mockConstructor
+            fieldId="time-span"
+            label="Time span"
+            labelIcon={
+              <Popover
+                aria-label="help-text"
+                bodyContent="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."
+                id="time-span-help"
+              >
+                <button
+                  aria-label="open-help-tooltip-button"
+                  className="pf-c-form__group-label-help"
+                  onClick={[Function]}
+                >
+                  <HelpIcon
+                    color="currentColor"
+                    noVerticalAlign={true}
+                    size="sm"
+                  />
+                </button>
+              </Popover>
+            }
+          >
+            <div />
+          </mockConstructor>
+        </TimeSpanLevelField>
+      </form>
+    </Form>
+  </AdvancedFields>
+</Provider>
+`;

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

@@ -0,0 +1,109 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Title, 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';
+
+export const CategoryAndTemplate = ({
+  jobCategories,
+  jobTemplates,
+  setJobTemplate,
+  selectedTemplateID,
+  selectedCategory,
+  setCategory,
+  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 selectedTemplate = jobTemplates.find(
+    template => template.id === selectedTemplateID
+  )?.name;
+
+  const onSelectCategory = newCategory => {
+    setCategory(newCategory);
+    setJobTemplate(null);
+  };
+  const { categoryError, allTemplatesError, templateError } = errors;
+  const isError = !!(categoryError || allTemplatesError || templateError);
+  return (
+    <>
+      <Title headingLevel="h2">{__('Category and Template')}</Title>
+      <Text component={TextVariants.p}>{__('All fields are required.')}</Text>
+      <Form>
+        <SelectField
+          label={__('Job category')}
+          fieldId="job_category"
+          options={jobCategories}
+          setValue={onSelectCategory}
+          value={selectedCategory}
+          placeholderText={categoryError ? __('Error') : ''}
+          isDisabled={!!categoryError}
+        />
+        <GroupedSelectField
+          label={__('Job template')}
+          fieldId="job_template"
+          groups={Object.values(templatesGroups)}
+          setSelected={setJobTemplate}
+          selected={selectedTemplate}
+          isDisabled={!!(categoryError || allTemplatesError)}
+          placeholderText={allTemplatesError ? __('Error') : ''}
+        />
+        {isError && (
+          <Alert variant="danger" title={__('Errors:')}>
+            {categoryError && (
+              <span>
+                {__('Categories list failed with:')} {categoryError}
+              </span>
+            )}
+            {allTemplatesError && (
+              <span>
+                {__('Templates list failed with:')} {allTemplatesError}
+              </span>
+            )}
+            {templateError && (
+              <span>
+                {__('Template failed with:')} {templateError}
+              </span>
+            )}
+          </Alert>
+        )}
+      </Form>
+    </>
+  );
+};
+
+CategoryAndTemplate.propTypes = {
+  jobCategories: PropTypes.array,
+  jobTemplates: PropTypes.array,
+  setJobTemplate: PropTypes.func.isRequired,
+  selectedTemplateID: PropTypes.number,
+  setCategory: PropTypes.func.isRequired,
+  selectedCategory: PropTypes.string,
+  errors: PropTypes.shape({
+    categoryError: PropTypes.string,
+    allTemplatesError: PropTypes.string,
+    templateError: PropTypes.string,
+  }),
+};
+CategoryAndTemplate.defaultProps = {
+  jobCategories: [],
+  jobTemplates: [],
+  selectedTemplateID: null,
+  selectedCategory: null,
+  errors: {},
+};
+
+export default CategoryAndTemplate;

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

@@ -0,0 +1,52 @@
+import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
+import { CategoryAndTemplate } from './CategoryAndTemplate';
+
+const baseProps = {
+  setJobTemplate: jest.fn(),
+  selectedTemplateID: 190,
+  setCategory: jest.fn(),
+};
+const fixtures = {
+  'renders with props': {
+    ...baseProps,
+    jobCategories: [
+      'Commands',
+      'Ansible Playbook',
+      'Ansible Galaxy',
+      'Ansible Roles Installation',
+    ],
+    jobTemplates: [
+      {
+        id: 190,
+        name: 'ab Run Command - SSH Default clone',
+        job_category: 'Commands',
+        provider_type: 'SSH',
+        snippet: false,
+      },
+      {
+        id: 168,
+        name: 'Ansible Roles - Ansible Default',
+        job_category: 'Ansible Playbook',
+        provider_type: 'Ansible',
+        snippet: false,
+      },
+      {
+        id: 170,
+        name: 'Ansible Roles - Install from git',
+        job_category: 'Ansible Roles Installation',
+        provider_type: 'Ansible',
+        snippet: false,
+      },
+    ],
+    selectedCategory: 'I am a category',
+  },
+  'render with error': {
+    ...baseProps,
+    errors: { allTemplatesError: 'I have an error' },
+  },
+};
+
+describe('CategoryAndTemplate', () => {
+  describe('rendering', () =>
+    testComponentSnapshotsWithFixtures(CategoryAndTemplate, fixtures));
+});

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

@@ -0,0 +1,113 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`CategoryAndTemplate rendering render with error 1`] = `
+<Fragment>
+  <Title
+    headingLevel="h2"
+  >
+    Category and Template
+  </Title>
+  <Text
+    component="p"
+  >
+    All fields are required.
+  </Text>
+  <Form>
+    <SelectField
+      fieldId="job_category"
+      isDisabled={false}
+      label="Job category"
+      options={Array []}
+      placeholderText=""
+      setValue={[Function]}
+      value={null}
+    />
+    <GroupedSelectField
+      fieldId="job_template"
+      groups={Array []}
+      isDisabled={true}
+      label="Job template"
+      placeholderText="Error"
+      selected={null}
+      setSelected={[MockFunction]}
+    />
+    <Alert
+      title="Errors:"
+      variant="danger"
+    >
+      <span>
+        Templates list failed with:
+         
+        I have an error
+      </span>
+    </Alert>
+  </Form>
+</Fragment>
+`;
+
+exports[`CategoryAndTemplate rendering renders with props 1`] = `
+<Fragment>
+  <Title
+    headingLevel="h2"
+  >
+    Category and Template
+  </Title>
+  <Text
+    component="p"
+  >
+    All fields are required.
+  </Text>
+  <Form>
+    <SelectField
+      fieldId="job_category"
+      isDisabled={false}
+      label="Job category"
+      options={
+        Array [
+          "Commands",
+          "Ansible Playbook",
+          "Ansible Galaxy",
+          "Ansible Roles Installation",
+        ]
+      }
+      placeholderText=""
+      setValue={[Function]}
+      value="I am a category"
+    />
+    <GroupedSelectField
+      fieldId="job_template"
+      groups={
+        Array [
+          Object {
+            "groupLabel": "SSH",
+            "options": Array [
+              Object {
+                "label": "ab Run Command - SSH Default clone",
+                "value": 190,
+              },
+            ],
+          },
+          Object {
+            "groupLabel": "Ansible",
+            "options": Array [
+              Object {
+                "label": "Ansible Roles - Ansible Default",
+                "value": 168,
+              },
+              Object {
+                "label": "Ansible Roles - Install from git",
+                "value": 170,
+              },
+            ],
+          },
+        ]
+      }
+      isDisabled={false}
+      label="Job template"
+      placeholderText=""
+      selected="ab Run Command - SSH Default clone"
+      setSelected={[MockFunction]}
+    />
+  </Form>
+</Fragment>
+`;