foreman_remote_execution 4.3.0 → 4.5.1

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

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

@@ -0,0 +1,94 @@
+import React, { useEffect } from 'react';
+import { useSelector, useDispatch } from 'react-redux';
+import PropTypes from 'prop-types';
+import URI from 'urijs';
+import { get } from 'foremanReact/redux/API';
+import {
+  selectJobCategories,
+  selectJobTemplates,
+  selectJobCategoriesStatus,
+  filterJobTemplates,
+  selectCategoryError,
+  selectAllTemplatesError,
+  selectTemplateError,
+} from '../../JobWizardSelectors';
+import { CategoryAndTemplate } from './CategoryAndTemplate';
+
+import {
+  JOB_TEMPLATES,
+  JOB_CATEGORIES,
+  templatesUrl,
+} from '../../JobWizardConstants';
+
+const ConnectedCategoryAndTemplate = ({
+  jobTemplate,
+  setJobTemplate,
+  category,
+  setCategory,
+}) => {
+  const dispatch = useDispatch();
+
+  const jobCategoriesStatus = useSelector(selectJobCategoriesStatus);
+  useEffect(() => {
+    if (!jobCategoriesStatus) {
+      // Don't reload categories if they are already loaded
+      dispatch(
+        get({
+          key: JOB_CATEGORIES,
+          url: '/ui_job_wizard/categories',
+          handleSuccess: response =>
+            setCategory(response.data.job_categories[0] || ''),
+        })
+      );
+    }
+  }, [jobCategoriesStatus, dispatch, setCategory]);
+
+  const jobCategories = useSelector(selectJobCategories);
+  useEffect(() => {
+    if (category) {
+      const templatesUrlObject = new URI(templatesUrl);
+      dispatch(
+        get({
+          key: JOB_TEMPLATES,
+          url: templatesUrlObject.addSearch({
+            search: `job_category="${category}"`,
+            per_page: 'all',
+          }),
+          handleSuccess: response =>
+            setJobTemplate(
+              Number(filterJobTemplates(response?.data?.results)[0]?.id) || null
+            ),
+        })
+      );
+    }
+  }, [category, dispatch, setJobTemplate]);
+
+  const jobTemplates = useSelector(selectJobTemplates);
+
+  const errors = {
+    categoryError: useSelector(selectCategoryError),
+    allTemplatesError: useSelector(selectAllTemplatesError),
+    templateError: useSelector(selectTemplateError),
+  };
+  return (
+    <CategoryAndTemplate
+      jobTemplates={jobTemplates}
+      jobCategories={jobCategories}
+      setJobTemplate={setJobTemplate}
+      selectedTemplateID={jobTemplate}
+      setCategory={setCategory}
+      selectedCategory={category}
+      errors={errors}
+    />
+  );
+};
+
+ConnectedCategoryAndTemplate.propTypes = {
+  jobTemplate: PropTypes.number,
+  setJobTemplate: PropTypes.func.isRequired,
+  category: PropTypes.string.isRequired,
+  setCategory: PropTypes.func.isRequired,
+};
+ConnectedCategoryAndTemplate.defaultProps = { jobTemplate: null };
+
+export default ConnectedCategoryAndTemplate;

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

@@ -0,0 +1,19 @@
+import React from 'react';
+import { Popover } from '@patternfly/react-core';
+import { HelpIcon } from '@patternfly/react-icons';
+import { translate as __ } from 'foremanReact/common/I18n';
+
+export const helpLabel = (text, id) => {
+  if (!text) return null;
+  return (
+    <Popover id={`${id}-help`} bodyContent={text} aria-label="help-text">
+      <button
+        aria-label={__('open-help-tooltip-button')}
+        onClick={e => e.preventDefault()}
+        className="pf-c-form__group-label-help"
+      >
+        <HelpIcon noVerticalAlign />
+      </button>
+    </Popover>
+  );
+};

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

@@ -0,0 +1,91 @@
+import React, { useState } from 'react';
+import PropTypes from 'prop-types';
+import {
+  SelectOption,
+  Select,
+  SelectGroup,
+  SelectVariant,
+  FormGroup,
+} from '@patternfly/react-core';
+
+export const GroupedSelectField = ({
+  label,
+  fieldId,
+  groups,
+  selected,
+  setSelected,
+  ...props
+}) => {
+  const [isOpen, setIsOpen] = useState(false);
+  const onSelect = selection => {
+    setIsOpen(false);
+    setSelected(selection);
+  };
+
+  const onClear = () => {
+    onSelect(null);
+  };
+
+  const options = groups.map((group, groupIndex) => (
+    <SelectGroup key={groupIndex} label={group.groupLabel}>
+      {group.options.map((option, optionIndex) => (
+        <SelectOption
+          key={optionIndex}
+          value={option.label}
+          onClick={() => onSelect(option.value)}
+        />
+      ))}
+    </SelectGroup>
+  ));
+
+  const onFilter = evt => {
+    const textInput = evt?.target?.value || '';
+    if (textInput === '') {
+      return options;
+    }
+    return options
+      .map(group => {
+        const filteredGroup = React.cloneElement(group, {
+          children: group.props.children.filter(item =>
+            item.props.value.toLowerCase().includes(textInput.toLowerCase())
+          ),
+        });
+        if (filteredGroup.props.children.length > 0) return filteredGroup;
+        return null;
+      })
+      .filter(newGroup => newGroup);
+  };
+
+  return (
+    <FormGroup label={label} fieldId={fieldId}>
+      <Select
+        isGrouped
+        variant={SelectVariant.typeahead}
+        onToggle={setIsOpen}
+        onFilter={onFilter}
+        isOpen={isOpen}
+        onSelect={() => null}
+        selections={selected}
+        className="without_select2"
+        onClear={onClear}
+        menuAppendTo={() => document.body}
+        {...props}
+      >
+        {options}
+      </Select>
+    </FormGroup>
+  );
+};
+
+GroupedSelectField.propTypes = {
+  label: PropTypes.string.isRequired,
+  fieldId: PropTypes.string.isRequired,
+  groups: PropTypes.array,
+  selected: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  setSelected: PropTypes.func.isRequired,
+};
+
+GroupedSelectField.defaultProps = {
+  groups: [],
+  selected: null,
+};