foreman_remote_execution 4.6.0 → 5.0.1

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

@@ -0,0 +1,90 @@
+import React, { useState, useEffect, useCallback } from 'react';
+import { useSelector } from 'react-redux';
+import PropTypes from 'prop-types';
+import { FormGroup, TextInput, Tooltip, Button } from '@patternfly/react-core';
+import { translate as __ } from 'foremanReact/common/I18n';
+import {
+  selectTemplateInputs,
+  selectAdvancedTemplateInputs,
+} from '../../JobWizardSelectors';
+
+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');
+      const results = [...newDesc.matchAll(re)].map(result => ({
+        name: result[1],
+        text: result[0],
+      }));
+      results.forEach(result => {
+        newDesc = newDesc.replace(
+          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);
+  };
+
+  return (
+    <FormGroup
+      label={__('Description')}
+      fieldId="description"
+      helperText={
+        <Button variant="link" isInline onClick={togglePreview}>
+          {isPreview
+            ? __('Edit job description template')
+            : __('Preview job description')}
+        </Button>
+      }
+    >
+      {isPreview ? (
+        <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"
+          value={value}
+          onChange={newValue => setValue(newValue)}
+        />
+      )}
+    </FormGroup>
+  );
+};
+
+DescriptionField.propTypes = {
+  inputValues: PropTypes.object.isRequired,
+  value: PropTypes.string,
+  setValue: PropTypes.func.isRequired,
+};
+DescriptionField.defaultProps = {
+  value: '',
+};

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

@@ -1,8 +1,10 @@
 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';
+import { NumberInput } from '../form/NumberInput';
 
 export const EffectiveUserField = ({ value, setValue }) => (
   <FormGroup
@@ -16,6 +18,7 @@ export const EffectiveUserField = ({ value, setValue }) => (
     fieldId="effective-user"
   >
     <TextInput
+      aria-label="effective user"
       autoComplete="effective-user"
       id="effective-user"
       type="text"
@@ -26,25 +29,25 @@ export const EffectiveUserField = ({ value, setValue }) => (
 );
 
 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.'
+  <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'
       ),
-      '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>
+      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 }) => (
@@ -56,11 +59,12 @@ export const PasswordField = ({ value, setValue }) => (
       ),
       'password'
     )}
-    fieldId="password"
+    fieldId="job-password"
   >
     <TextInput
-      autoComplete="password"
-      id="password"
+      aria-label="job password"
+      autoComplete="new-password" // to prevent firefox from autofilling the user password
+      id="job-password"
       type="password"
       placeholder="*****"
       value={value}
@@ -81,6 +85,7 @@ export const KeyPassphraseField = ({ value, setValue }) => (
     fieldId="key-passphrase"
   >
     <TextInput
+      aria-label="key passphrase"
       autoComplete="key-passphrase"
       id="key-passphrase"
       type="password"
@@ -103,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"
@@ -114,51 +120,89 @@ export const EffectiveUserPasswordField = ({ value, setValue }) => (
 );
 
 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.'
+  <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'
       ),
-      '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>
+      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 ExecutionOrderingField = ({ isRandomizedOrdering, setValue }) => (
   <FormGroup
-    label={__('Time span')}
+    label={__('Execution ordering')}
+    fieldId="schedule-type"
     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'
+      <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'
     )}
-    fieldId="time-span"
+    isInline
   >
-    <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)}
+    <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))}</>
+);
 EffectiveUserField.propTypes = {
   value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
   setValue: PropTypes.func.isRequired,
@@ -179,3 +223,20 @@ 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,
+  setValue: PropTypes.func.isRequired,
+};
+
+TemplateInputsFields.defaultProps = {
+  value: {},
+};