foreman_remote_execution 4.7.0 → 5.1.0

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

@@ -1,10 +1,19 @@
-import React, { useState } from 'react';
+import React, { useState, useEffect, useCallback } from 'react';
+import { useSelector } from 'react-redux';
 import PropTypes from 'prop-types';
-import { FormGroup, TextInput, Button } from '@patternfly/react-core';
+import { FormGroup, TextInput, Tooltip, Button } from '@patternfly/react-core';
 import { translate as __ } from 'foremanReact/common/I18n';
+import {
+  selectTemplateInputs,
+  selectAdvancedTemplateInputs,
+} from '../../JobWizardSelectors';
 
-export const DescriptionField = ({ inputs, value, setValue }) => {
-  const generateDesc = () => {
+export const DescriptionField = ({ inputValues, value, setValue }) => {
+  const inputs = [
+    ...useSelector(selectTemplateInputs),
+    ...useSelector(selectAdvancedTemplateInputs),
+  ].map(input => input.name);
+  const generateDesc = useCallback(() => {
     let newDesc = value;
     if (value) {
       const re = new RegExp('%\\{([^\\}]+)\\}', 'gm');
@@ -15,16 +24,19 @@ export const DescriptionField = ({ inputs, value, setValue }) => {
       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
+          inputValues[result.name] ||
+            (inputs.includes(result.name) ? '' : result.text)
         );
       });
     }
     return newDesc;
-  };
+  }, [inputs, value, inputValues]);
   const [generatedDesc, setGeneratedDesc] = useState(generateDesc());
   const [isPreview, setIsPreview] = useState(true);
 
+  useEffect(() => {
+    setGeneratedDesc(generateDesc());
+  }, [generateDesc]);
   const togglePreview = () => {
     setGeneratedDesc(generateDesc());
     setIsPreview(v => !v);
@@ -43,9 +55,20 @@ export const DescriptionField = ({ inputs, value, setValue }) => {
       }
     >
       {isPreview ? (
-        <TextInput id="description-preview" value={generatedDesc} isDisabled />
+        <Tooltip content={generatedDesc}>
+          <div>
+            {/* div wrapper so the tooltip will be shown in chrome */}
+            <TextInput
+              aria-label="description preview"
+              id="description-preview"
+              value={generatedDesc}
+              isDisabled
+            />
+          </div>
+        </Tooltip>
       ) : (
         <TextInput
+          aria-label="description edit"
           type="text"
           autoComplete="description"
           id="description"
@@ -58,7 +81,7 @@ export const DescriptionField = ({ inputs, value, setValue }) => {
 };
 
 DescriptionField.propTypes = {
-  inputs: PropTypes.array.isRequired,
+  inputValues: PropTypes.object.isRequired,
   value: PropTypes.string,
   setValue: PropTypes.func.isRequired,
 };

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

@@ -1,6 +1,6 @@
 import React from 'react';
 import PropTypes from 'prop-types';
-import { FormGroup, TextInput } from '@patternfly/react-core';
+import { FormGroup, TextInput, Radio } from '@patternfly/react-core';
 import { translate as __ } from 'foremanReact/common/I18n';
 import { helpLabel } from '../form/FormHelpers';
 import { formatter } from '../form/Formatter';
@@ -18,6 +18,7 @@ export const EffectiveUserField = ({ value, setValue }) => (
     fieldId="effective-user"
   >
     <TextInput
+      aria-label="effective user"
       autoComplete="effective-user"
       id="effective-user"
       type="text"
@@ -61,6 +62,7 @@ export const PasswordField = ({ value, setValue }) => (
     fieldId="job-password"
   >
     <TextInput
+      aria-label="job password"
       autoComplete="new-password" // to prevent firefox from autofilling the user password
       id="job-password"
       type="password"
@@ -83,6 +85,7 @@ export const KeyPassphraseField = ({ value, setValue }) => (
     fieldId="key-passphrase"
   >
     <TextInput
+      aria-label="key passphrase"
       autoComplete="key-passphrase"
       id="key-passphrase"
       type="password"
@@ -105,6 +108,7 @@ export const EffectiveUserPasswordField = ({ value, setValue }) => (
     fieldId="effective-user-password"
   >
     <TextInput
+      aria-label="effective userpassword"
       autoComplete="effective-user-password"
       id="effective-user-password"
       type="password"
@@ -161,6 +165,41 @@ export const TimeSpanLevelField = ({ value, setValue }) => (
   />
 );
 
+export const ExecutionOrderingField = ({ isRandomizedOrdering, setValue }) => (
+  <FormGroup
+    label={__('Execution ordering')}
+    fieldId="schedule-type"
+    labelIcon={helpLabel(
+      <div
+        dangerouslySetInnerHTML={{
+          __html: __(
+            'Execution ordering determines whether the jobs should be executed on hosts in alphabetical order or in randomized order.<br><ul><li><b>Ordered</b> - executes the jobs on hosts in alphabetical order</li><li><b>Randomized</b> - randomizes the order in which jobs are executed on hosts</li></ul>'
+          ),
+        }}
+      />,
+      'effective-user-password'
+    )}
+    isInline
+  >
+    <Radio
+      aria-label="execution order alphabetical"
+      isChecked={!isRandomizedOrdering}
+      name="execution-order"
+      onChange={() => setValue(false)}
+      id="execution-order-alphabetical"
+      label={__('Alphabetical')}
+    />
+    <Radio
+      aria-label="execution order randomized"
+      isChecked={isRandomizedOrdering}
+      name="execution-order"
+      onChange={() => setValue(true)}
+      id="execution-order-randomized"
+      label={__('Randomized')}
+    />
+  </FormGroup>
+);
+
 export const TemplateInputsFields = ({ inputs, value, setValue }) => (
   <>{inputs?.map(input => formatter(input, value, setValue))}</>
 );
@@ -184,6 +223,14 @@ ConcurrencyLevelField.propTypes = EffectiveUserField.propTypes;
 ConcurrencyLevelField.defaultProps = EffectiveUserField.defaultProps;
 TimeSpanLevelField.propTypes = EffectiveUserField.propTypes;
 TimeSpanLevelField.defaultProps = EffectiveUserField.defaultProps;
+ExecutionOrderingField.propTypes = {
+  isRandomizedOrdering: PropTypes.bool,
+  setValue: PropTypes.func.isRequired,
+};
+ExecutionOrderingField.defaultProps = {
+  isRandomizedOrdering: false,
+};
+
 TemplateInputsFields.propTypes = {
   inputs: PropTypes.array.isRequired,
   value: PropTypes.object,

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

@@ -1,39 +1,38 @@
+/* eslint-disable max-lines */
 import React from 'react';
 import { Provider } from 'react-redux';
 import { mount } from '@theforeman/test';
 import { fireEvent, screen, render, act } from '@testing-library/react';
+import { MockedProvider } from '@apollo/client/testing';
 import * as api from 'foremanReact/redux/API';
 import { JobWizard } from '../../../JobWizard';
 import * as selectors from '../../../JobWizardSelectors';
 import {
-  jobTemplateResponse as jobTemplate,
+  jobTemplateResponse,
+  jobTemplate,
   testSetup,
   mockApi,
+  jobCategories,
+  gqlMock,
 } from '../../../__tests__/fixtures';
+import { WIZARD_TITLES } from '../../../JobWizardConstants';
 
 const store = testSetup(selectors, api);
 mockApi(api);
 
 jest.spyOn(selectors, 'selectEffectiveUser');
-jest.spyOn(selectors, 'selectTemplateInputs');
-jest.spyOn(selectors, 'selectAdvancedTemplateInputs');
 
 selectors.selectEffectiveUser.mockImplementation(
-  () => jobTemplate.effective_user
-);
-selectors.selectTemplateInputs.mockImplementation(
-  () => jobTemplate.template_inputs
-);
-
-selectors.selectAdvancedTemplateInputs.mockImplementation(
-  () => jobTemplate.advanced_template_inputs
+  () => jobTemplateResponse.effective_user
 );
 describe('AdvancedFields', () => {
   it('should save data between steps for advanced fields', async () => {
     const wrapper = mount(
-      <Provider store={store}>
-        <JobWizard advancedValues={{}} setAdvancedValues={jest.fn()} />
-      </Provider>
+      <MockedProvider mocks={gqlMock} addTypename={false}>
+        <Provider store={store}>
+          <JobWizard />
+        </Provider>
+      </MockedProvider>
     );
     // setup
     wrapper.find('.pf-c-button.pf-c-select__toggle-button').simulate('click');
@@ -72,7 +71,7 @@ describe('AdvancedFields', () => {
       .simulate('click');
 
     expect(wrapper.find('.pf-c-wizard__nav-link.pf-m-current').text()).toEqual(
-      'Target Hosts'
+      'Target hosts and inputs'
     );
     wrapper
       .find('.pf-c-wizard__nav-link')
@@ -86,12 +85,14 @@ describe('AdvancedFields', () => {
   });
   it('fill template fields', async () => {
     render(
-      <Provider store={store}>
-        <JobWizard />
-      </Provider>
+      <MockedProvider mocks={gqlMock} addTypename={false}>
+        <Provider store={store}>
+          <JobWizard />
+        </Provider>
+      </MockedProvider>
     );
     await act(async () => {
-      fireEvent.click(screen.getByText('Advanced Fields'));
+      fireEvent.click(screen.getByText(WIZARD_TITLES.advanced));
     });
     const searchValue = 'search test';
     const textValue = 'I am a text';
@@ -99,7 +100,10 @@ describe('AdvancedFields', () => {
     const textField = screen.getByLabelText('adv plain hidden', {
       selector: 'textarea',
     });
-    const selectField = screen.getByText('option 1');
+    const selectField = screen.getByLabelText('adv plain select toggle');
+    const resourceSelectField = screen.getByLabelText(
+      'adv resource select toggle'
+    );
     const searchField = screen.getByPlaceholderText('Filter...');
     const dateField = screen.getByLabelText('adv date', {
       selector: 'input',
@@ -108,7 +112,11 @@ describe('AdvancedFields', () => {
     fireEvent.click(selectField);
     await act(async () => {
       await fireEvent.click(screen.getByText('option 2'));
-      fireEvent.click(screen.getAllByText('Advanced Fields')[0]); // to remove focus
+      fireEvent.click(screen.getAllByText(WIZARD_TITLES.advanced)[0]); // to remove focus
+
+      fireEvent.click(resourceSelectField);
+      await fireEvent.click(screen.getByText('resource2'));
+
       await fireEvent.change(textField, {
         target: { value: textValue },
       });
@@ -128,9 +136,11 @@ describe('AdvancedFields', () => {
     expect(searchField.value).toBe(searchValue);
     expect(dateField.value).toBe(dateValue);
     await act(async () => {
-      fireEvent.click(screen.getByText('Category and Template'));
+      fireEvent.click(screen.getByText(WIZARD_TITLES.categoryAndTemplate));
     });
-    expect(screen.getAllByText('Category and Template')).toHaveLength(3);
+    expect(screen.getAllByText(WIZARD_TITLES.categoryAndTemplate)).toHaveLength(
+      3
+    );
 
     await act(async () => {
       fireEvent.click(screen.getByText('Advanced Fields'));
@@ -140,5 +150,214 @@ describe('AdvancedFields', () => {
     expect(dateField.value).toBe(dateValue);
     expect(screen.queryAllByText('option 1')).toHaveLength(0);
     expect(screen.queryAllByText('option 2')).toHaveLength(1);
+    expect(screen.queryAllByDisplayValue('resource1')).toHaveLength(0);
+    expect(screen.queryAllByDisplayValue('resource2')).toHaveLength(1);
+  });
+  it('fill defaults into fields', async () => {
+    render(
+      <MockedProvider mocks={gqlMock} addTypename={false}>
+        <Provider store={store}>
+          <JobWizard />
+        </Provider>
+      </MockedProvider>
+    );
+    await act(async () => {
+      fireEvent.click(screen.getByText('Advanced Fields'));
+    });
+
+    expect(
+      screen.getByLabelText('effective user', {
+        selector: 'input',
+      }).value
+    ).toBe('default effective user');
+    expect(
+      screen.getByLabelText('timeout to kill', {
+        selector: 'input',
+      }).value
+    ).toBe('2');
+
+    expect(
+      screen.getByLabelText('description preview', {
+        selector: 'input',
+      }).value
+    ).toBe(
+      'template1 with inputs adv plain hidden="Default val" adv plain select="" adv resource select="" adv search="" adv date="" plain hidden="Default val"'
+    );
+  });
+  it('DescriptionField', async () => {
+    render(
+      <Provider store={store}>
+        <JobWizard />
+      </Provider>
+    );
+    await act(async () => {
+      fireEvent.click(screen.getByText(WIZARD_TITLES.advanced));
+    });
+
+    const textField = screen.getByLabelText('adv plain hidden', {
+      selector: 'textarea',
+    });
+    await act(async () => {
+      await fireEvent.change(textField, {
+        target: { value: 'test command' },
+      });
+    });
+    const descriptionValue = 'Run %{adv plain hidden} %{wrong command name}';
+
+    await act(async () => {
+      fireEvent.click(screen.getByText('Edit job description template'));
+    });
+
+    const editText = screen.getByLabelText('description edit', {
+      selector: 'input',
+    });
+    await fireEvent.change(editText, {
+      target: { value: descriptionValue },
+    });
+    await act(async () => {
+      fireEvent.click(screen.getByText('Preview job description'));
+    });
+    expect(
+      screen.getByLabelText('description preview', {
+        selector: 'input',
+      }).value
+    ).toBe('Run test command %{wrong command name}');
+  });
+
+  it('DescriptionField with no inputs', async () => {
+    jest.spyOn(api, 'get');
+
+    jest.spyOn(selectors, 'selectTemplateInputs');
+    jest.spyOn(selectors, 'selectAdvancedTemplateInputs');
+    selectors.selectTemplateInputs.mockImplementation(() => []);
+    selectors.selectAdvancedTemplateInputs.mockImplementation(() => []);
+    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: {
+              ...jobTemplateResponse,
+              advanced_template_inputs: [],
+              template_inputs: [],
+            },
+          });
+      } else if (action.key === 'JOB_TEMPLATES') {
+        handleSuccess &&
+          handleSuccess({
+            data: { results: [jobTemplate] },
+          });
+      }
+      return { type: 'get', ...action };
+    });
+    render(
+      <Provider store={store}>
+        <JobWizard />
+      </Provider>
+    );
+    await act(async () => {
+      fireEvent.click(screen.getByText(WIZARD_TITLES.advanced));
+    });
+    expect(
+      screen.getByLabelText('description preview', {
+        selector: 'input',
+      }).value
+    ).toBe('template1');
+  });
+
+  it('DescriptionField with description_format', async () => {
+    jest.spyOn(api, 'get');
+    jest.spyOn(selectors, 'selectTemplateInputs');
+    selectors.selectTemplateInputs.mockImplementation(() => [
+      {
+        name: 'command',
+        required: true,
+        input_type: 'user',
+        description: 'some Description',
+        advanced: true,
+        value_type: 'plain',
+        resource_type: 'ansible_roles',
+        default: 'Default val',
+        hidden_value: true,
+      },
+    ]);
+    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: {
+              ...jobTemplateResponse,
+              job_template: {
+                ...jobTemplateResponse.jobTemplate,
+                description_format: 'Run %{command}',
+              },
+
+              template_inputs: [
+                {
+                  name: 'command',
+                  required: true,
+                  input_type: 'user',
+                  description: 'some Description',
+                  advanced: true,
+                  value_type: 'plain',
+                  resource_type: 'ansible_roles',
+                  default: 'Default val',
+                  hidden_value: true,
+                },
+              ],
+            },
+          });
+      } else if (action.key === 'JOB_TEMPLATES') {
+        handleSuccess &&
+          handleSuccess({
+            data: { results: [jobTemplate] },
+          });
+      }
+      return { type: 'get', ...action };
+    });
+    render(
+      <Provider store={store}>
+        <JobWizard />
+      </Provider>
+    );
+    await act(async () => {
+      fireEvent.click(screen.getByText(WIZARD_TITLES.advanced));
+    });
+    expect(
+      screen.getByLabelText('description preview', {
+        selector: 'input',
+      }).value
+    ).toBe('Run Default val');
+  });
+
+  it('search resources action', async () => {
+    jest.useFakeTimers();
+    mockApi(api);
+    const newStore = testSetup(selectors, api);
+    render(
+      <Provider store={newStore}>
+        <JobWizard />
+      </Provider>
+    );
+    await act(async () => {
+      fireEvent.click(screen.getByText(WIZARD_TITLES.advanced));
+    });
+    const resourceSelectField = screen.getByLabelText(
+      'adv resource select typeahead input'
+    );
+
+    await act(async () => {
+      await fireEvent.change(resourceSelectField, {
+        target: { value: 'some search' },
+      });
+
+      await jest.runAllTimers();
+    });
+    expect(newStore.getActions()).toMatchSnapshot('resource search');
   });
 });

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

@@ -0,0 +1,82 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AdvancedFields search resources action: resource search 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": "",
+    },
+  },
+  Object {
+    "key": "JOB_TEMPLATE",
+    "type": "get",
+    "url": "/ui_job_wizard/template/178",
+  },
+  Object {
+    "key": "ForemanTasksTask",
+    "type": "get",
+    "url": URI {
+      "_deferred_build": true,
+      "_parts": Object {
+        "duplicateQueryParameters": false,
+        "escapeQuerySpace": true,
+        "fragment": null,
+        "hostname": null,
+        "password": null,
+        "path": "/ui_job_wizard/resources",
+        "port": null,
+        "preventInvalidHostname": false,
+        "protocol": null,
+        "query": "resource=ForemanTasks%3A%3ATask&name=",
+        "urn": null,
+        "username": null,
+      },
+      "_string": "",
+    },
+  },
+  Object {
+    "key": "ForemanTasksTask",
+    "type": "get",
+    "url": URI {
+      "_deferred_build": true,
+      "_parts": Object {
+        "duplicateQueryParameters": false,
+        "escapeQuerySpace": true,
+        "fragment": null,
+        "hostname": null,
+        "password": null,
+        "path": "/ui_job_wizard/resources",
+        "port": null,
+        "preventInvalidHostname": false,
+        "protocol": null,
+        "query": "resource=ForemanTasks%3A%3ATask&name=some+search",
+        "urn": null,
+        "username": null,
+      },
+      "_string": "",
+    },
+  },
+]
+`;

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

@@ -1,9 +1,11 @@
 import React from 'react';
 import PropTypes from 'prop-types';
-import { Title, Text, TextVariants, Form, Alert } from '@patternfly/react-core';
+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';
 
 export const CategoryAndTemplate = ({
   jobCategories,
@@ -40,7 +42,7 @@ export const CategoryAndTemplate = ({
   const isError = !!(categoryError || allTemplatesError || templateError);
   return (
     <>
-      <Title headingLevel="h2">{__('Category and Template')}</Title>
+      <WizardTitle title={WIZARD_TITLES.categoryAndTemplate} />
       <Text component={TextVariants.p}>{__('All fields are required.')}</Text>
       <Form>
         <SelectField
@@ -51,6 +53,7 @@ export const CategoryAndTemplate = ({
           value={selectedCategory}
           placeholderText={categoryError ? __('Error') : ''}
           isDisabled={!!categoryError}
+          isRequired
         />
         <GroupedSelectField
           label={__('Job template')}

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

@@ -5,6 +5,7 @@ import * as api from 'foremanReact/redux/API';
 import { JobWizard } from '../../JobWizard';
 import * as selectors from '../../JobWizardSelectors';
 import { testSetup, mockApi } from '../../__tests__/fixtures';
+import { WIZARD_TITLES } from '../../JobWizardConstants';
 
 const store = testSetup(selectors, api);
 mockApi(api);
@@ -32,7 +33,7 @@ describe('Category And Template', () => {
     await act(async () => {
       await fireEvent.click(screen.getByText('Puppet'));
     });
-    fireEvent.click(screen.getAllByText('Category and Template')[0]); // to remove focus
+    fireEvent.click(screen.getAllByText(WIZARD_TITLES.categoryAndTemplate)[0]); // to remove focus
     expect(
       screen.queryAllByLabelText('Ansible Commands', { selector: 'button' })
     ).toHaveLength(0);
@@ -47,7 +48,7 @@ describe('Category And Template', () => {
     await act(async () => {
       await fireEvent.click(screen.getByText('template2'));
     });
-    fireEvent.click(screen.getAllByText('Category and Template')[0]); // to remove focus
+    fireEvent.click(screen.getAllByText(WIZARD_TITLES.categoryAndTemplate)[0]); // to remove focus
     expect(
       screen.queryAllByDisplayValue('template1', { selector: 'button' })
     ).toHaveLength(0);

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

@@ -54,10 +54,11 @@ const ConnectedCategoryAndTemplate = ({
             search: `job_category="${category}"`,
             per_page: 'all',
           }),
-          handleSuccess: response =>
+          handleSuccess: response => {
             setJobTemplate(
               Number(filterJobTemplates(response?.data?.results)[0]?.id) || null
-            ),
+            );
+          },
         })
       );
     }