foreman_remote_execution 12.0.5 → 13.1.0

data/webpack/JobWizard/PermissionDenied.js

@@ -0,0 +1,64 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { translate as __ } from 'foremanReact/common/I18n';
+import { Icon } from 'patternfly-react';
+import {
+  Title,
+  Button,
+  EmptyState,
+  EmptyStateVariant,
+  EmptyStateBody,
+} from '@patternfly/react-core';
+
+const PermissionDenied = ({ missingPermissions, setProceedAnyway }) => {
+  const description = (
+    <span>
+      {__('You are not authorized to perform this action.')}
+      <br />
+      {__(
+        'Please request the required permissions listed below from a Foreman administrator:'
+      )}
+      <br />
+      <ul className="list-unstyled">
+        {missingPermissions.map(permission => (
+          <li key={permission}>
+            <strong>{permission}</strong>
+          </li>
+        ))}
+      </ul>
+    </span>
+  );
+  const handleProceedAnyway = () => {
+    setProceedAnyway(true);
+  };
+
+  return (
+    <EmptyState variant={EmptyStateVariant.xl}>
+      <span className="empty-state-icon">
+        <Icon name="lock" type="fa" size="2x" />
+      </span>
+      <Title ouiaId="empty-state-header" headingLevel="h5" size="4xl">
+        {__('Permission Denied')}
+      </Title>
+      <EmptyStateBody>{description}</EmptyStateBody>
+      <Button
+        ouiaId="job-invocation-proceed-anyway-button"
+        variant="primary"
+        onClick={handleProceedAnyway}
+      >
+        {__('Proceed Anyway')}
+      </Button>
+    </EmptyState>
+  );
+};
+
+PermissionDenied.propTypes = {
+  missingPermissions: PropTypes.array,
+  setProceedAnyway: PropTypes.func.isRequired,
+};
+
+PermissionDenied.defaultProps = {
+  missingPermissions: ['unknown'],
+};
+
+export default PermissionDenied;

data/webpack/JobWizard/StartsBeforeErrorAlert.js

@@ -5,6 +5,7 @@ import { translate as __ } from 'foremanReact/common/I18n';
 export const StartsBeforeErrorAlert = () => (
   <>
     <Alert
+      ouiaId="starts-before-error-alert"
       variant="danger"
       title={__("'Starts before' date must in the future")}
     >

data/webpack/JobWizard/__tests__/fixtures.js

@@ -227,9 +227,9 @@ export const gqlMock = [
         hosts: {
           totalCount: 3,
           nodes: [
-            { id: 'MDE6SG9zdC0x', name: 'host1' },
-            { id: 'MDE6SG9zdC0y', name: 'host2' },
-            { id: 'MDE6SG9zdC0z', name: 'host3' },
+            { id: 'MDE6SG9zdC0x', name: 'host1', displayName: 'host1' },
+            { id: 'MDE6SG9zdC0y', name: 'host2', displayName: 'host2' },
+            { id: 'MDE6SG9zdC0z', name: 'host3', displayName: 'host3' },
           ],
         },
       },

data/webpack/JobWizard/autofill.js

@@ -39,10 +39,14 @@ export const useAutoFill = ({
             handleSuccess: ({ data }) => {
               setSelectedTargets(currentTargets => ({
                 ...currentTargets,
-                hosts: (data.results || []).map(({ id, name }) => ({
-                  id,
-                  name,
-                })),
+                hosts: (data.results || []).map(
+                  // eslint-disable-next-line camelcase
+                  ({ id, name, display_name }) => ({
+                    id,
+                    // eslint-disable-next-line camelcase
+                    name: display_name || name,
+                  })
+                ),
               }));
             },
           })

data/webpack/JobWizard/index.js

@@ -1,9 +1,17 @@
-import React from 'react';
+import React, { useState } from 'react';
+import { isEmpty } from 'lodash';
 import PropTypes from 'prop-types';
 import { Button } from '@patternfly/react-core';
 import { translate as __ } from 'foremanReact/common/I18n';
+import { STATUS } from 'foremanReact/constants';
 import PageLayout from 'foremanReact/routes/common/PageLayout/PageLayout';
+import { useAPI } from 'foremanReact/common/hooks/API/APIHooks';
+import PermissionDenied from './PermissionDenied';
 import { JobWizard } from './JobWizard';
+import {
+  CURRENT_PERMISSIONS,
+  currentPermissionsUrl,
+} from './JobWizardConstants';
 
 const JobWizardPage = ({ location: { search } }) => {
   const title = __('Run job');
@@ -13,6 +21,37 @@ const JobWizardPage = ({ location: { search } }) => {
       { caption: title },
     ],
   };
+  const [proceedAnyway, setProceedAnyway] = useState(false);
+
+  const { response, status } = useAPI(
+    'get',
+    currentPermissionsUrl,
+    CURRENT_PERMISSIONS
+  );
+  const desiredPermissions = [
+    'view_hosts',
+    'view_smart_proxies',
+    'view_job_templates',
+    'create_job_invocations',
+    'create_template_invocations',
+  ];
+  const missingPermissions =
+    status === STATUS.RESOLVED
+      ? desiredPermissions.filter(
+          permission =>
+            !response.results.map(result => result.name).includes(permission)
+        )
+      : [];
+
+  if (!isEmpty(missingPermissions) && !proceedAnyway) {
+    return (
+      <PermissionDenied
+        missingPermissions={missingPermissions}
+        setProceedAnyway={setProceedAnyway}
+      />
+    );
+  }
+
   return (
     <PageLayout
       header={title}
@@ -20,6 +59,7 @@ const JobWizardPage = ({ location: { search } }) => {
       searchable={false}
       toolbarButtons={
         <Button
+          ouiaId="legacy-form"
           variant="link"
           component="a"
           href={`/old/job_invocations/new${search}`}

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

@@ -56,7 +56,12 @@ export const DescriptionField = ({
       }
       fieldId="description"
       helperText={
-        <Button variant="link" isInline onClick={togglePreview}>
+        <Button
+          ouiaId="description-preview-button"
+          variant="link"
+          isInline
+          onClick={togglePreview}
+        >
           {isPreview
             ? __('Edit job description template')
             : __('Preview job description')}
@@ -68,6 +73,7 @@ export const DescriptionField = ({
           <div>
             {/* div wrapper so the tooltip will be shown in chrome */}
             <TextInput
+              ouiaId="description-preview"
               aria-label="description preview"
               id="description-preview"
               value={generatedDesc}
@@ -77,6 +83,7 @@ export const DescriptionField = ({
         </Tooltip>
       ) : (
         <TextInput
+          ouiaId="description-edit"
           aria-label="description edit"
           type="text"
           autoComplete="description"

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

@@ -19,6 +19,7 @@ export const EffectiveUserField = ({ value, setValue, defaultValue }) => (
     labelInfo={<ResetDefault setValue={setValue} defaultValue={defaultValue} />}
   >
     <TextInput
+      ouiaId="effective-user"
       aria-label="effective user"
       autoComplete="effective-user"
       id="effective-user"
@@ -86,6 +87,7 @@ export const PasswordField = ({ value, setValue }) => (
     fieldId="job-password"
   >
     <TextInput
+      ouiaId="job-password"
       aria-label="job password"
       autoComplete="new-password" // to prevent firefox from autofilling the user password
       id="job-password"
@@ -109,6 +111,7 @@ export const KeyPassphraseField = ({ value, setValue }) => (
     fieldId="key-passphrase"
   >
     <TextInput
+      ouiaId="key-passphrase"
       aria-label="key passphrase"
       autoComplete="key-passphrase"
       id="key-passphrase"
@@ -132,6 +135,7 @@ export const EffectiveUserPasswordField = ({ value, setValue }) => (
     fieldId="effective-user-password"
   >
     <TextInput
+      ouiaId="effective-user-password"
       aria-label="effective userpassword"
       autoComplete="effective-user-password"
       id="effective-user-password"
@@ -186,6 +190,7 @@ export const ExecutionOrderingField = ({ isRandomizedOrdering, setValue }) => (
     isInline
   >
     <Radio
+      ouiaId="execution-order-alphabetical"
       aria-label="execution order alphabetical"
       isChecked={!isRandomizedOrdering}
       name="execution-order"
@@ -194,6 +199,7 @@ export const ExecutionOrderingField = ({ isRandomizedOrdering, setValue }) => (
       label={__('Alphabetical')}
     />
     <Radio
+      ouiaId="execution-order-randomized"
       aria-label="execution order randomized"
       isChecked={isRandomizedOrdering}
       name="execution-order"
@@ -216,6 +222,7 @@ export const SSHUserField = ({ value, setValue, defaultValue }) => (
     labelInfo={<ResetDefault setValue={setValue} defaultValue={defaultValue} />}
   >
     <TextInput
+      ouiaId="ssh-user"
       aria-label="ssh user"
       autoComplete="ssh-user"
       id="ssh-user"

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

@@ -1,13 +1,17 @@
 import React from 'react';
+import { isEmpty } from 'lodash';
 import PropTypes from 'prop-types';
 import { useSelector } from 'react-redux';
 import { Text, TextVariants, Form, Alert } from '@patternfly/react-core';
 import { translate as __ } from 'foremanReact/common/I18n';
+import {
+  selectJobCategoriesMissingPermissions,
+  selectIsLoading,
+} from '../../JobWizardSelectors';
 import { SelectField } from '../form/SelectField';
 import { GroupedSelectField } from '../form/GroupedSelectField';
 import { WizardTitle } from '../form/WizardTitle';
 import { WIZARD_TITLES, JOB_TEMPLATES } from '../../JobWizardConstants';
-import { selectIsLoading } from '../../JobWizardSelectors';
 
 export const CategoryAndTemplate = ({
   jobCategories,
@@ -57,11 +61,22 @@ export const CategoryAndTemplate = ({
   };
 
   const { categoryError, allTemplatesError, templateError } = errors;
-  const isError = !!(categoryError || allTemplatesError || templateError);
+  const missingPermissions = useSelector(selectJobCategoriesMissingPermissions);
+  const isError = !!(
+    (categoryError && isEmpty(missingPermissions)) ||
+    allTemplatesError ||
+    templateError
+  );
+
   return (
     <>
       <WizardTitle title={WIZARD_TITLES.categoryAndTemplate} />
-      <Text component={TextVariants.p}>{__('All fields are required.')}</Text>
+      <Text
+        ouiaId="category-and-template-required-fields"
+        component={TextVariants.p}
+      >
+        {__('All fields are required.')}
+      </Text>
       <Form>
         <SelectField
           label={__('Job category')}
@@ -69,7 +84,7 @@ export const CategoryAndTemplate = ({
           options={jobCategories}
           setValue={onSelectCategory}
           value={selectedCategory}
-          placeholderText={categoryError ? __('Error') : ''}
+          placeholderText={categoryError ? __('Not available') : ''}
           isDisabled={!!categoryError}
           isRequired
         />
@@ -82,11 +97,30 @@ export const CategoryAndTemplate = ({
           isDisabled={
             !!(categoryError || allTemplatesError || isTemplatesLoading)
           }
-          placeholderText={allTemplatesError ? __('Error') : ''}
+          placeholderText={allTemplatesError ? __('Not available') : ''}
         />
+        {!isEmpty(missingPermissions) && (
+          <Alert
+            ouiaId="category-and-template-access-denied"
+            variant="warning"
+            title={__('Access denied')}
+          >
+            <span>
+              {__(
+                `Missing the required permissions: ${missingPermissions.join(
+                  ', '
+                )}`
+              )}
+            </span>
+          </Alert>
+        )}
         {isError && (
-          <Alert variant="danger" title={__('Errors:')}>
-            {categoryError && (
+          <Alert
+            variant="danger"
+            title={__('Errors:')}
+            ouiaId="category-and-template-errors"
+          >
+            {categoryError && isEmpty(missingPermissions) && (
               <span>
                 {__('Categories list failed with:')} {categoryError}
               </span>

data/webpack/JobWizard/steps/HostsAndInputs/HostPreviewModal.js

@@ -5,6 +5,7 @@ import URI from 'urijs';
 import { List, ListItem, Modal, Button } from '@patternfly/react-core';
 import { translate as __, sprintf } from 'foremanReact/common/I18n';
 import { foremanUrl } from 'foremanReact/common/helpers';
+import { HOSTS_PATH } from 'foremanReact/routes/Hosts/constants';
 import { selectHosts, selectHostCount } from '../../JobWizardSelectors';
 import { HOSTS_TO_PREVIEW_AMOUNT } from '../../JobWizardConstants';
 
@@ -15,6 +16,7 @@ export const HostPreviewModal = ({ isOpen, setIsOpen, searchQuery }) => {
 
   return (
     <Modal
+      ouiaId="host-preview-modal"
       title={__('Preview Hosts')}
       isOpen={isOpen}
       onClose={() => setIsOpen(false)}
@@ -22,22 +24,24 @@ export const HostPreviewModal = ({ isOpen, setIsOpen, searchQuery }) => {
     >
       <List isPlain>
         {hosts.map(host => (
-          <ListItem key={host}>
+          <ListItem key={host.name}>
             <Button
+              ouiaId={`host-preview-${host}`}
               component="a"
-              href={foremanUrl(`/hosts/${host}`)}
+              href={foremanUrl(`${HOSTS_PATH}/${host.name}`)}
               variant="link"
               target="_blank"
               rel="noreferrer"
               isInline
             >
-              {host}
+              {host.display_name}
             </Button>
           </ListItem>
         ))}
         {hostsCount > HOSTS_TO_PREVIEW_AMOUNT && (
           <ListItem>
             <Button
+              ouiaId="host-preview-more"
               component="a"
               href={url.addSearch({ search: searchQuery })}
               variant="link"

data/webpack/JobWizard/steps/HostsAndInputs/SelectGQL.js

@@ -38,6 +38,7 @@ export const useNameSearchGQL = apiKey => {
         data?.[dataName[apiKey]]?.nodes.map(node => ({
           id: decodeId(node.id),
           name: node.name,
+          displayName: node.displayName,
         })) || [],
     },
     loading,

data/webpack/JobWizard/steps/HostsAndInputs/SelectedChips.js

@@ -4,7 +4,7 @@ import { Chip, ChipGroup, Button } from '@patternfly/react-core';
 import { sprintf, translate as __ } from 'foremanReact/common/I18n';
 import { hostMethods } from '../../JobWizardConstants';
 
-const SelectedChip = ({ selected, setSelected, categoryName }) => {
+const SelectedChip = ({ selected, setSelected, categoryName, setLabel }) => {
   const deleteItem = itemToRemove => {
     setSelected(oldSelected =>
       oldSelected.filter(({ id }) => id !== itemToRemove)
@@ -14,6 +14,7 @@ const SelectedChip = ({ selected, setSelected, categoryName }) => {
   return (
     <>
       <ChipGroup
+        ouiaId="hosts-chip-group"
         className="hosts-chip-group"
         categoryName={categoryName}
         isClosable
@@ -24,14 +25,15 @@ const SelectedChip = ({ selected, setSelected, categoryName }) => {
           setSelected(() => []);
         }}
       >
-        {selected.map(({ name, id }, index) => (
+        {selected.map((result, index) => (
           <Chip
+            ouiaId={`${categoryName}-${result.id}`}
             key={index}
-            id={`${categoryName}-${id}`}
-            onClick={() => deleteItem(id)}
-            closeBtnAriaLabel={`Remove ${name}`}
+            id={`${categoryName}-${result.id}`}
+            onClick={() => deleteItem(result.id)}
+            closeBtnAriaLabel={`Remove ${result.name}`}
           >
-            {name}
+            {setLabel(result)}
           </Chip>
         ))}
       </ChipGroup>
@@ -49,6 +51,7 @@ export const SelectedChips = ({
   setSelectedHostGroups,
   hostsSearchQuery,
   clearSearch,
+  setLabel,
 }) => {
   const clearAll = () => {
     setSelectedHosts(() => []);
@@ -67,16 +70,19 @@ export const SelectedChips = ({
         selected={selectedHosts}
         categoryName={hostMethods.hosts}
         setSelected={setSelectedHosts}
+        setLabel={setLabel}
       />
       <SelectedChip
         selected={selectedHostCollections}
         categoryName={hostMethods.hostCollections}
         setSelected={setSelectedHostCollections}
+        setLabel={setLabel}
       />
       <SelectedChip
         selected={selectedHostGroups}
         categoryName={hostMethods.hostGroups}
         setSelected={setSelectedHostGroups}
+        setLabel={setLabel}
       />
       <SelectedChip
         selected={
@@ -86,9 +92,15 @@ export const SelectedChips = ({
         }
         categoryName={hostMethods.searchQuery}
         setSelected={clearSearch}
+        setLabel={setLabel}
       />
       {showClear && (
-        <Button variant="link" className="clear-chips" onClick={clearAll}>
+        <Button
+          ouiaId="clear-chips"
+          variant="link"
+          className="clear-chips"
+          onClick={clearAll}
+        >
           {__('Clear all filters')}
         </Button>
       )}
@@ -105,10 +117,12 @@ SelectedChips.propTypes = {
   setSelectedHostGroups: PropTypes.func.isRequired,
   hostsSearchQuery: PropTypes.string.isRequired,
   clearSearch: PropTypes.func.isRequired,
+  setLabel: PropTypes.func.isRequired,
 };
 
 SelectedChip.propTypes = {
   categoryName: PropTypes.string.isRequired,
   selected: PropTypes.array.isRequired,
   setSelected: PropTypes.func.isRequired,
+  setLabel: PropTypes.func.isRequired,
 };

data/webpack/JobWizard/steps/HostsAndInputs/hosts.gql

@@ -4,6 +4,7 @@ query($search: String!) {
     nodes {
       id
       name
+      displayName
     }
   }
 }

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

@@ -1,5 +1,7 @@
 import React, { useEffect, useState } from 'react';
+import { isEmpty, debounce } from 'lodash';
 import {
+  Alert,
   Button,
   Form,
   FormGroup,
@@ -10,13 +12,13 @@ import {
 import PropTypes from 'prop-types';
 import { useSelector, useDispatch } from 'react-redux';
 import { FilterIcon } from '@patternfly/react-icons';
-import { debounce } from 'lodash';
 import { get } from 'foremanReact/redux/API';
 import { translate as __ } from 'foremanReact/common/I18n';
 import {
   selectTemplateInputs,
   selectWithKatello,
   selectHostCount,
+  selectHostsMissingPermissions,
   selectIsLoadingHosts,
 } from '../../JobWizardSelectors';
 import { SelectField } from '../form/SelectField';
@@ -98,9 +100,11 @@ const HostsAndInputs = ({
   ]);
   const withKatello = useSelector(selectWithKatello);
   const hostCount = useSelector(selectHostCount);
+  const missingPermissions = useSelector(selectHostsMissingPermissions);
   const dispatch = useDispatch();
 
   const selectedHosts = selected.hosts;
+  const setLabel = result => result.displayName || result.name;
   const setSelectedHosts = newSelected =>
     setSelected(prevSelected => ({
       ...prevSelected,
@@ -126,6 +130,7 @@ const HostsAndInputs = ({
   const [errorText, setErrorText] = useState(
     __('Please select at least one host')
   );
+
   return (
     <div className="target-hosts-and-inputs">
       <WizardTitle title={WIZARD_TITLES.hostsAndInputs} />
@@ -187,6 +192,7 @@ const HostsAndInputs = ({
                 apiKey={HOSTS}
                 name="hosts"
                 placeholderText={__('Filter by hosts')}
+                setLabel={setLabel}
               />
             )}
             {hostMethod === hostMethods.hostCollections && (
@@ -197,6 +203,7 @@ const HostsAndInputs = ({
                 name="host collections"
                 url="/katello/api/host_collections?per_page=100"
                 placeholderText={__('Filter by host collections')}
+                setLabel={setLabel}
               />
             )}
             {hostMethod === hostMethods.hostGroups && (
@@ -206,6 +213,7 @@ const HostsAndInputs = ({
                 apiKey={HOST_GROUPS}
                 name="host groups"
                 placeholderText={__('Filter by host groups')}
+                setLabel={setLabel}
               />
             )}
           </InputGroup>
@@ -219,10 +227,12 @@ const HostsAndInputs = ({
           setSelectedHostGroups={setSelectedHostGroups}
           hostsSearchQuery={hostsSearchQuery}
           clearSearch={clearSearch}
+          setLabel={setLabel}
         />
-        <Text>
+        <Text ouiaId="host-preview-label">
           {__('Apply to')}{' '}
           <Button
+            ouiaId="host-preview-open-button"
             variant="link"
             isInline
             onClick={() => setHostPreviewOpen(true)}
@@ -237,6 +247,21 @@ const HostsAndInputs = ({
           value={templateValues}
           setValue={setTemplateValues}
         />
+        {!isEmpty(missingPermissions) && (
+          <Alert
+            ouiaId="host-access-denied"
+            variant="warning"
+            title={__('Access denied')}
+          >
+            <span>
+              {__(
+                `Missing the required permissions: ${missingPermissions.join(
+                  ', '
+                )}`
+              )}
+            </span>
+          </Alert>
+        )}
       </Form>
     </div>
   );

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

@@ -46,6 +46,7 @@ const ReviewDetails = ({
   // eslint-disable-next-line react/prop-types
   const StepButton = ({ stepName, children }) => (
     <Button
+      ouiaId={`step-button-${stepName}`}
       variant="link"
       isInline
       onClick={() => {
@@ -79,17 +80,19 @@ const ReviewDetails = ({
 
   const hostsCount = useSelector(selectHostCount);
   const [hostPreviewOpen, setHostPreviewOpen] = useState(false);
+  const NUM_CHIPS = 3;
   const stringHosts = () => {
     if (hosts.length === 0) {
       return __('No Target Hosts');
     }
-    if (hosts.length === 1 || hosts.length === 2) {
-      return hosts.join(', ');
+    if (hosts.length < NUM_CHIPS) {
+      return hosts.map(host => host.display_name).join(', ');
     }
     return (
       <div>
         {hostsCount} {__('hosts')}{' '}
         <Button
+          ouiaId="view-host-names"
           variant="link"
           isInline
           onClick={() => setHostPreviewOpen(true)}
@@ -139,6 +142,7 @@ const ReviewDetails = ({
       ),
       value: isAdvancedShown ? (
         <Button
+          ouiaId="hide-advanced-fields"
           variant="link"
           isInline
           onClick={() => {
@@ -149,6 +153,7 @@ const ReviewDetails = ({
         </Button>
       ) : (
         <Button
+          ouiaId="show-advanced-fields"
           variant="link"
           isInline
           onClick={() => {

data/webpack/JobWizard/steps/Schedule/PurposeField.js

@@ -14,6 +14,7 @@ export const PurposeField = ({ purpose, setPurpose }) => (
     )}
   >
     <TextInput
+      ouiaId="purpose"
       aria-label="purpose"
       type="text"
       value={purpose}

data/webpack/JobWizard/steps/Schedule/QueryType.js

@@ -15,6 +15,7 @@ export const QueryType = ({ isTypeStatic, setIsTypeStatic }) => (
       )}
     >
       <Radio
+        ouiaId="query-type-static"
         isChecked={isTypeStatic}
         name="query-type"
         onChange={() => setIsTypeStatic(true)}
@@ -25,6 +26,7 @@ export const QueryType = ({ isTypeStatic, setIsTypeStatic }) => (
     </FormGroup>
     <FormGroup fieldId="query-type-dynamic">
       <Radio
+        ouiaId="query-type-dynamic"
         isChecked={!isTypeStatic}
         name="query-type"
         onChange={() => setIsTypeStatic(false)}

data/webpack/JobWizard/steps/Schedule/RepeatCron.js

@@ -65,6 +65,7 @@ export const RepeatCron = ({ repeatData, setRepeatData, setValid }) => {
       isRequired
     >
       <TextInput
+        ouiaId="cronline"
         isRequired
         validated={cronline ? ValidatedOptions.noval : ValidatedOptions.error}
         aria-label="cronline"