foreman_remote_execution 4.7.0 → 5.1.0

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

@@ -0,0 +1,126 @@
+import React, { useState } from 'react';
+import PropTypes from 'prop-types';
+import {
+  DatePicker,
+  TimePicker,
+  ValidatedOptions,
+} from '@patternfly/react-core';
+import { debounce } from 'lodash';
+import { translate as __, documentLocale } from 'foremanReact/common/I18n';
+
+export const DateTimePicker = ({
+  dateTime,
+  setDateTime,
+  isDisabled,
+  ariaLabel,
+  allowEmpty,
+}) => {
+  const [validated, setValidated] = useState();
+  const dateFormat = date =>
+    `${date.getFullYear()}/${(date.getMonth() + 1)
+      .toString()
+      .padStart(2, '0')}/${date
+      .getDate()
+      .toString()
+      .padStart(2, '0')}`;
+
+  const dateObject = dateTime ? new Date(dateTime) : new Date();
+  const formattedDate = dateTime ? dateFormat(dateObject) : '';
+  const dateParse = date =>
+    new Date(`${date} ${dateObject.getHours()}:${dateObject.getMinutes()}`);
+
+  const isValidDate = date => date && !Number.isNaN(date.getTime());
+
+  const isValidTime = time => {
+    if (!time) return false;
+    const split = time.split(':');
+    if (!(split[0].length === 2 && split[1].length === 2)) return false;
+    if (isValidDate(new Date(`${formattedDate} ${time}`))) return true;
+    if (!formattedDate.length && isValidDate(new Date(`01/01/2020 ${time}`))) {
+      const today = new Date();
+      today.setHours(split[0]);
+      today.setMinutes(split[1]);
+      setDateTime(today.toString());
+    }
+    return false;
+  };
+
+  const onDateChange = newDate => {
+    const parsedNewDate = new Date(newDate);
+    if (!newDate.length && allowEmpty) {
+      setDateTime('');
+      setValidated(ValidatedOptions.noval);
+    } else if (isValidDate(parsedNewDate)) {
+      parsedNewDate.setHours(dateObject.getHours());
+      parsedNewDate.setMinutes(dateObject.getMinutes());
+      setDateTime(parsedNewDate.toString());
+      setValidated(ValidatedOptions.noval);
+    } else {
+      setValidated(ValidatedOptions.error);
+    }
+  };
+
+  const onTimeChange = newTime => {
+    if (!newTime.length && allowEmpty) {
+      const parsedNewTime = new Date(`${formattedDate} 00:00`);
+      setDateTime(parsedNewTime.toString());
+      setValidated(ValidatedOptions.noval);
+    } else if (isValidTime(newTime)) {
+      const parsedNewTime = new Date(`${formattedDate} ${newTime}`);
+      setDateTime(parsedNewTime.toString());
+      setValidated(ValidatedOptions.noval);
+    } else {
+      setValidated(ValidatedOptions.error);
+    }
+  };
+  return (
+    <>
+      <DatePicker
+        aria-label={`${ariaLabel} datepicker`}
+        value={formattedDate}
+        placeholder="yyyy/mm/dd"
+        onChange={debounce(onDateChange, 1000, {
+          leading: false,
+          trailing: true,
+        })}
+        dateFormat={dateFormat}
+        dateParse={dateParse}
+        isDisabled={isDisabled}
+        locale={documentLocale()}
+        invalidFormatText={
+          validated === ValidatedOptions.error ? __('Invalid date') : ''
+        }
+        inputProps={{ validated }}
+      />
+      <TimePicker
+        aria-label={`${ariaLabel} timepicker`}
+        className="time-picker"
+        time={dateTime ? dateObject.toString() : ''}
+        inputProps={dateTime ? {} : { value: '' }}
+        placeholder="hh:mm"
+        onChange={debounce(onTimeChange, 1000, {
+          leading: false,
+          trailing: true,
+        })}
+        is24Hour
+        isDisabled={isDisabled}
+        invalidFormatErrorMessage={__('Invalid time format')}
+        menuAppendTo={() => document.body}
+      />
+    </>
+  );
+};
+
+DateTimePicker.propTypes = {
+  dateTime: PropTypes.string,
+  setDateTime: PropTypes.func.isRequired,
+  isDisabled: PropTypes.bool,
+  ariaLabel: PropTypes.string,
+  allowEmpty: PropTypes.bool,
+};
+DateTimePicker.defaultProps = {
+  dateTime: null,
+  isDisabled: false,
+  ariaLabel: '',
+  allowEmpty: true,
+};

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

@@ -18,3 +18,7 @@ export const helpLabel = (text, id) => {
     </Popover>
   );
 };
+
+export const isPositiveNumber = text => parseInt(text, 10) > 0;
+
+export const isValidDate = d => d instanceof Date && !Number.isNaN(d);

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

@@ -3,12 +3,16 @@ import { useSelector } from 'react-redux';
 import { FormGroup, TextInput, TextArea } from '@patternfly/react-core';
 import PropTypes from 'prop-types';
 import SearchBar from 'foremanReact/components/SearchBar';
+import { getControllerSearchProps } from 'foremanReact/constants';
 import { helpLabel } from './FormHelpers';
 import { SelectField } from './SelectField';
+import { ResourceSelectAPI } from './ResourceSelect';
+import { noop } from '../../../helpers';
 
 const TemplateSearchField = ({
   name,
   controller,
+  url,
   labelText,
   required,
   defaultValue,
@@ -22,25 +26,28 @@ const TemplateSearchField = ({
     setValue({ ...values, [name]: searchQuery });
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [searchQuery]);
+  const id = name.replace(/ /g, '-');
+  const props = getControllerSearchProps(controller.replace('/', '_'), name);
   return (
     <FormGroup
       label={name}
       labelIcon={helpLabel(labelText, name)}
-      fieldId={name}
+      fieldId={id}
       isRequired={required}
       className="foreman-search-field"
     >
       <SearchBar
         initialQuery={defaultValue}
         data={{
-          controller,
+          ...props,
           autocomplete: {
             id: name,
-            url: `/${controller}/auto_complete_search`,
+            url,
             useKeyShortcuts: true,
           },
+          bookmarks: null,
         }}
-        onSearch={() => null}
+        onSearch={noop}
       />
     </FormGroup>
   );
@@ -51,19 +58,43 @@ export const formatter = (input, values, setValue) => {
   const inputType = input.value_type;
   const isTextType = inputType === 'plain' || !inputType; // null defaults to plain
 
-  const { name, required, hidden_value: hidden } = input;
+  const {
+    name,
+    required,
+    hidden_value: hidden,
+    resource_type: resourceType,
+    value_type: valueType,
+  } = input;
   const labelText = input.description;
   const value = values[name];
-
+  const id = name.replace(/ /g, '-');
+  if (valueType === 'resource') {
+    return (
+      <FormGroup
+        label={name}
+        fieldId={id}
+        labelIcon={helpLabel(labelText, name)}
+        isRequired={required}
+        key={id}
+      >
+        <ResourceSelectAPI
+          name={name}
+          apiKey={resourceType.replace('::', '')}
+          url={`/ui_job_wizard/resources?resource=${resourceType}`}
+          selected={value || {}}
+          setSelected={newValue => setValue({ ...values, [name]: newValue })}
+        />
+      </FormGroup>
+    );
+  }
   if (isSelectType) {
     const options = input.options.split(/\r?\n/).map(option => option.trim());
     return (
       <SelectField
-        aria-label={name}
-        key={name}
+        key={id}
         isRequired={required}
         label={name}
-        fieldId={name}
+        fieldId={id}
         options={options}
         labelIcon={helpLabel(labelText, name)}
         value={value}
@@ -77,7 +108,7 @@ export const formatter = (input, values, setValue) => {
         key={name}
         label={name}
         labelIcon={helpLabel(labelText, name)}
-        fieldId={name}
+        fieldId={id}
         isRequired={required}
       >
         <TextArea
@@ -85,7 +116,7 @@ export const formatter = (input, values, setValue) => {
           className={hidden ? 'masked-input' : null}
           required={required}
           rows={2}
-          id={name}
+          id={id}
           value={value}
           onChange={newValue => setValue({ ...values, [name]: newValue })}
         />
@@ -98,7 +129,7 @@ export const formatter = (input, values, setValue) => {
         key={name}
         label={name}
         labelIcon={helpLabel(labelText, name)}
-        fieldId={name}
+        fieldId={id}
         isRequired={required}
       >
         <TextInput
@@ -106,7 +137,7 @@ export const formatter = (input, values, setValue) => {
           placeholder="YYYY-mm-dd HH:MM"
           className={hidden ? 'masked-input' : null}
           required={required}
-          id={name}
+          id={id}
           type="text"
           value={value}
           onChange={newValue => setValue({ ...values, [name]: newValue })}
@@ -115,14 +146,14 @@ export const formatter = (input, values, setValue) => {
     );
   }
   if (inputType === 'search') {
-    const controller = input.resource_type;
-    // TODO: get text from redux autocomplete
+    const controller = input.resource_type_tableize;
     return (
       <TemplateSearchField
-        key={name}
+        key={id}
         name={name}
         defaultValue={value}
-        controller={controller}
+        controller={resourceType}
+        url={`/${controller}/auto_complete_search`}
         labelText={labelText}
         required={required}
         setValue={setValue}
@@ -137,6 +168,7 @@ export const formatter = (input, values, setValue) => {
 TemplateSearchField.propTypes = {
   name: PropTypes.string.isRequired,
   controller: PropTypes.string.isRequired,
+  url: PropTypes.string.isRequired,
   labelText: PropTypes.string,
   required: PropTypes.bool.isRequired,
   defaultValue: PropTypes.string,

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

@@ -2,21 +2,24 @@ import React, { useState } from 'react';
 import PropTypes from 'prop-types';
 import { FormGroup, TextInput, ValidatedOptions } from '@patternfly/react-core';
 import { translate as __ } from 'foremanReact/common/I18n';
+import { isPositiveNumber } from './FormHelpers';
 
 export const NumberInput = ({ formProps, inputProps }) => {
   const [validated, setValidated] = useState();
+  const name = inputProps.id.replace(/-/g, ' ');
   return (
     <FormGroup
       {...formProps}
-      helperTextInvalid={__('Has to be a number')}
+      helperTextInvalid={__('Has to be a positive number')}
       validated={validated}
     >
       <TextInput
+        aria-label={name}
         type="text"
         {...inputProps}
         onChange={newValue => {
           setValidated(
-            /^\d+$/.test(newValue) || newValue === ''
+            isPositiveNumber(newValue) || newValue === ''
               ? ValidatedOptions.noval
               : ValidatedOptions.error
           );

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

@@ -0,0 +1,29 @@
+import React from 'react';
+import { useSelector, useDispatch } from 'react-redux';
+import URI from 'urijs';
+import { get } from 'foremanReact/redux/API';
+import { selectResponse, selectIsLoading } from '../../JobWizardSelectors';
+import { SearchSelect } from '../form/SearchSelect';
+
+export const useNameSearchAPI = (apiKey, url) => {
+  const dispatch = useDispatch();
+  const uri = new URI(url);
+  const onSearch = search => {
+    dispatch(
+      get({
+        key: apiKey,
+        url: uri.addSearch({
+          name: search,
+        }),
+      })
+    );
+  };
+
+  const response = useSelector(state => selectResponse(state, apiKey));
+  const isLoading = useSelector(state => selectIsLoading(state, apiKey));
+  return [onSearch, response, isLoading];
+};
+
+export const ResourceSelectAPI = props => (
+  <SearchSelect {...props} useNameSearch={useNameSearchAPI} />
+);

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

@@ -0,0 +1,121 @@
+import React, { useState, useEffect } from 'react';
+import PropTypes from 'prop-types';
+import { Select, SelectOption, SelectVariant } from '@patternfly/react-core';
+import Immutable from 'seamless-immutable';
+import { sprintf, translate as __ } from 'foremanReact/common/I18n';
+
+export const maxResults = 100;
+
+export const SearchSelect = ({
+  name,
+  selected,
+  setSelected,
+  placeholderText,
+  useNameSearch,
+  apiKey,
+  url,
+  variant,
+}) => {
+  const [onSearch, response, isLoading] = useNameSearch(apiKey, url);
+  const [isOpen, setIsOpen] = useState(false);
+  const [typingTimeout, setTypingTimeout] = useState(null);
+  const autoSearchDelay = 500;
+  useEffect(() => {
+    onSearch(selected.name || '');
+    if (typingTimeout) {
+      return () => clearTimeout(typingTimeout);
+    }
+    return undefined;
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
+  let selectOptions = [];
+  if (response.subtotal > maxResults) {
+    selectOptions = [
+      <SelectOption
+        isDisabled
+        key={0}
+        description={__('Please refine your search.')}
+      >
+        {sprintf(
+          __('You have %s results to display. Showing first %s results'),
+          response.subtotal,
+          maxResults
+        )}
+      </SelectOption>,
+    ];
+  }
+  selectOptions = [
+    ...selectOptions,
+    ...Immutable.asMutable(response?.results || [])?.map((result, index) => (
+      <SelectOption key={index + 1} value={result.id}>
+        {result.name}
+      </SelectOption>
+    )),
+  ];
+
+  const onSelect = (event, selection) => {
+    if (variant === SelectVariant.typeahead) {
+      setSelected(response.results.find(r => r.id === selection)); // saving the name and id so we will have access to the name between steps
+    } else if (variant === SelectVariant.typeaheadMulti) {
+      if (selected.map(({ id }) => id).includes(selection)) {
+        setSelected(currentSelected =>
+          currentSelected.filter(({ id }) => id !== selection)
+        );
+      } else {
+        setSelected(currentSelected => [
+          ...currentSelected,
+          response.results.find(r => r.id === selection),
+        ]);
+      }
+    }
+  };
+  const autoSearch = searchTerm => {
+    if (typingTimeout) clearTimeout(typingTimeout);
+    setTypingTimeout(setTimeout(() => onSearch(searchTerm), autoSearchDelay));
+  };
+  return (
+    <Select
+      toggleAriaLabel={`${name} toggle`}
+      chipGroupComponent={<></>}
+      variant={variant}
+      selections={
+        variant === SelectVariant.typeahead
+          ? selected.id
+          : selected.map(({ id }) => id)
+      }
+      loadingVariant={isLoading ? 'spinner' : null}
+      onSelect={onSelect}
+      onToggle={setIsOpen}
+      isOpen={isOpen}
+      className="without_select2"
+      maxHeight="45vh"
+      onTypeaheadInputChanged={value => {
+        autoSearch(value || '');
+      }}
+      placeholderText={placeholderText}
+      onFilter={() => null} // https://github.com/patternfly/patternfly-react/issues/6321
+      typeAheadAriaLabel={`${name} typeahead input`}
+    >
+      {selectOptions}
+    </Select>
+  );
+};
+
+SearchSelect.propTypes = {
+  name: PropTypes.string,
+  selected: PropTypes.oneOfType([PropTypes.object, PropTypes.array]),
+  setSelected: PropTypes.func.isRequired,
+  placeholderText: PropTypes.string,
+  apiKey: PropTypes.string.isRequired,
+  url: PropTypes.string,
+  useNameSearch: PropTypes.func.isRequired,
+  variant: PropTypes.string,
+};
+
+SearchSelect.defaultProps = {
+  name: 'typeahead select',
+  selected: {},
+  placeholderText: '',
+  url: '',
+  variant: SelectVariant.typeahead,
+};

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

@@ -17,6 +17,16 @@ export const SelectField = ({
     setIsOpen(false);
   };
   const [isOpen, setIsOpen] = useState(false);
+  const selectOptions = [
+    !isRequired && (
+      <SelectOption key={0} value="">
+        <p> </p>
+      </SelectOption>
+    ),
+    ...options.map((option, index) => (
+      <SelectOption key={index + 1} value={option} />
+    )),
+  ];
   return (
     <FormGroup
       label={label}
@@ -32,11 +42,12 @@ export const SelectField = ({
         className="without_select2"
         maxHeight="45vh"
         menuAppendTo={() => document.body}
+        placeholderText=" " // To prevent showing first option as selected
+        aria-labelledby={fieldId}
+        toggleAriaLabel={`${label} toggle`}
         {...props}
       >
-        {options.map((option, index) => (
-          <SelectOption key={index} value={option} />
-        ))}
+        {selectOptions.filter(option => option)}
       </Select>
     </FormGroup>
   );

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

@@ -0,0 +1,14 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Title } from '@patternfly/react-core';
+
+export const WizardTitle = ({ title, ...props }) => (
+  <Title headingLevel="h2" className="wizard-title" {...props}>
+    {title}
+  </Title>
+);
+
+WizardTitle.propTypes = {
+  title: PropTypes.string.isRequired,
+};
+export default WizardTitle;

data/webpack/JobWizard/steps/form/__tests__/SelectSearch.test.js

@@ -0,0 +1,33 @@
+import React from 'react';
+import { render, fireEvent, screen } from '@testing-library/react';
+import { SearchSelect } from '../SearchSelect';
+
+const apiKey = 'HOSTS_KEY';
+
+describe('SearchSelect', () => {
+  it('too many', () => {
+    const onSearch = jest.fn();
+    render(
+      <SearchSelect
+        selected={['hosts1,host2']}
+        setSelected={jest.fn()}
+        apiKey={apiKey}
+        url="/hosts"
+        placeholderText="Test hosts"
+        useNameSearch={() => [
+          onSearch,
+          { results: ['host1', 'host2', 'host3'], subtotal: 101 },
+          false,
+        ]}
+      />
+    );
+    const openSelectbutton = screen.getByRole('button', {
+      name: 'typeahead select toggle',
+    });
+    fireEvent.click(openSelectbutton);
+    const tooMany = screen.queryAllByText(
+      'You have %s results to display. Showing first %s results + 101 + 100'
+    );
+    expect(tooMany).toHaveLength(1);
+  });
+});

data/webpack/JobWizard/submit.js

@@ -0,0 +1,120 @@
+import { post } from 'foremanReact/redux/API';
+import { repeatTypes, JOB_INVOCATION } from './JobWizardConstants';
+import { buildHostQuery } from './steps/HostsAndInputs/buildHostQuery';
+
+export const submit = ({
+  jobTemplateID,
+  templateValues,
+  advancedValues,
+  scheduleValue,
+  selectedTargets,
+  hostsSearchQuery,
+  location,
+  organization,
+  dispatch,
+}) => {
+  const {
+    repeatAmount,
+    repeatType,
+    repeatData,
+    startsAt,
+    startsBefore,
+    ends,
+    purpose,
+  } = scheduleValue;
+  const {
+    effectiveUserValue,
+    effectiveUserPassword,
+    description,
+    timeoutToKill,
+    isRandomizedOrdering,
+    timeSpan,
+    concurrencyLevel,
+    templateValues: advancedTemplateValues,
+    password,
+    keyPassphrase,
+  } = advancedValues;
+  const getCronLine = () => {
+    const [hour, minute] = repeatData.at
+      ? repeatData.at.split(':')
+      : [null, null];
+    switch (repeatType) {
+      case repeatTypes.cronline:
+        return repeatData.cronline;
+      case repeatTypes.monthly:
+        return `${minute} ${hour} ${repeatData.days} * *`;
+      case repeatTypes.weekly:
+        return `${minute} ${hour} * * ${repeatData.daysOfWeek}`;
+      case repeatTypes.daily:
+        return `${minute} ${hour} * * *`;
+      case repeatTypes.hourly:
+        return `${repeatData.minute} * * * *`;
+      case repeatTypes.noRepeat:
+      default:
+        return null;
+    }
+  };
+  const api = {
+    location,
+    organization,
+    job_invocation: {
+      job_template_id: jobTemplateID,
+      targeting_type: scheduleValue?.isTypeStatic
+        ? 'static_query'
+        : 'dynamic_query',
+      randomized_ordering: isRandomizedOrdering,
+      inputs: { ...templateValues, ...advancedTemplateValues },
+      ssh: {
+        effective_user: effectiveUserValue,
+        effective_user_password: effectiveUserPassword,
+      },
+      password,
+      key_passphrase: keyPassphrase,
+      recurrence:
+        repeatType !== repeatTypes.noRepeat
+          ? {
+              cron_line: getCronLine(),
+              max_iteration: repeatAmount,
+              end_time: ends.length ? new Date(ends).toISOString() : null,
+              purpose,
+            }
+          : null,
+      scheduling:
+        startsAt?.length || startsBefore?.length
+          ? {
+              start_at: startsAt?.length
+                ? new Date(startsAt).toISOString()
+                : null,
+              start_before: startsBefore?.length
+                ? new Date(startsBefore).toISOString()
+                : null,
+            }
+          : null,
+      concurrency_control: {
+        time_span: timeSpan,
+        concurrency_level: concurrencyLevel,
+      },
+      bookmark_id: null,
+      search_query:
+        buildHostQuery(selectedTargets, hostsSearchQuery) || 'name ~ *',
+      description_format: description,
+      execution_timeout_interval: timeoutToKill,
+      feature: '', // TODO add value after https://github.com/theforeman/foreman_remote_execution/pull/629
+    },
+  };
+
+  dispatch(
+    post({
+      key: JOB_INVOCATION,
+      url: '/api/job_invocations',
+      params: api,
+      handleSuccess: ({ data: { id } }) => {
+        window.location.href = `/job_invocations/${id}`;
+      },
+      errorToast: ({ response }) =>
+        response?.date?.error?.message ||
+        response?.message ||
+        response?.statusText,
+    })
+  );
+};