foreman_remote_execution 4.3.0 → 4.5.1

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;

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>
+`;