foreman_remote_execution 13.1.0 → 13.2.0

data/webpack/JobInvocationDetail/__tests__/MainInformation.test.js

@@ -0,0 +1,259 @@
+import React from 'react';
+import configureMockStore from 'redux-mock-store';
+import { fireEvent, render, screen, act } from '@testing-library/react';
+import '@testing-library/jest-dom/extend-expect';
+import { Provider } from 'react-redux';
+import thunk from 'redux-thunk';
+import { foremanUrl } from 'foremanReact/common/helpers';
+import * as api from 'foremanReact/redux/API';
+import JobInvocationDetailPage from '../index';
+import {
+  jobInvocationData,
+  jobInvocationDataScheduled,
+  jobInvocationDataRecurring,
+  mockPermissionsData,
+  mockReportTemplatesResponse,
+  mockReportTemplateInputsResponse,
+} from './fixtures';
+import {
+  cancelJob,
+  enableRecurringLogic,
+  cancelRecurringLogic,
+} from '../JobInvocationActions';
+import {
+  CANCEL_JOB,
+  CANCEL_RECURRING_LOGIC,
+  CHANGE_ENABLED_RECURRING_LOGIC,
+  GET_REPORT_TEMPLATES,
+  GET_REPORT_TEMPLATE_INPUTS,
+  JOB_INVOCATION_KEY,
+} from '../JobInvocationConstants';
+
+jest.spyOn(api, 'get');
+
+jest.mock('foremanReact/common/hooks/API/APIHooks', () => ({
+  useAPI: jest.fn(() => ({
+    response: mockPermissionsData,
+  })),
+}));
+
+jest.mock('foremanReact/routes/common/PageLayout/PageLayout', () =>
+  jest.fn(props => (
+    <div>
+      {props.header && <h1>{props.header}</h1>}
+      {props.toolbarButtons && <div>{props.toolbarButtons}</div>}
+      {props.children}
+    </div>
+  ))
+);
+
+const initialState = {
+  JOB_INVOCATION_KEY: {
+    response: jobInvocationData,
+  },
+  GET_REPORT_TEMPLATES: mockReportTemplatesResponse,
+};
+
+const initialStateScheduled = {
+  JOB_INVOCATION_KEY: {
+    response: jobInvocationDataScheduled,
+  },
+};
+
+api.get.mockImplementation(({ handleSuccess, ...action }) => {
+  if (action.key === 'GET_REPORT_TEMPLATES') {
+    handleSuccess &&
+      handleSuccess({
+        data: mockReportTemplatesResponse,
+      });
+  } else if (action.key === 'GET_REPORT_TEMPLATE_INPUTS') {
+    handleSuccess &&
+      handleSuccess({
+        data: mockReportTemplateInputsResponse,
+      });
+  }
+
+  return { type: 'get', ...action };
+});
+
+const reportTemplateJobId = mockReportTemplatesResponse.results[0].id;
+
+const mockStore = configureMockStore([thunk]);
+
+describe('JobInvocationDetailPage', () => {
+  it('renders main information', async () => {
+    const jobId = jobInvocationData.id;
+    const store = mockStore(initialState);
+
+    const { container } = render(
+      <Provider store={store}>
+        <JobInvocationDetailPage match={{ params: { id: `${jobId}` } }} />
+      </Provider>
+    );
+
+    expect(screen.getByText('Description')).toBeInTheDocument();
+    expect(
+      container.querySelector('.chart-donut .pf-c-chart')
+    ).toBeInTheDocument();
+    expect(screen.getByText('2/6')).toBeInTheDocument();
+    expect(screen.getByText('Systems')).toBeInTheDocument();
+    expect(screen.getByText('System status')).toBeInTheDocument();
+    expect(screen.getByText('Succeeded: 2')).toBeInTheDocument();
+    expect(screen.getByText('Failed: 4')).toBeInTheDocument();
+    expect(screen.getByText('In Progress: 0')).toBeInTheDocument();
+    expect(screen.getByText('Canceled: 0')).toBeInTheDocument();
+
+    const informationToCheck = {
+      'Effective user:': jobInvocationData.effective_user,
+      'Started at:': 'Jan 1, 2024, 11:34 UTC',
+      'SSH user:': 'Not available',
+      'Template:': jobInvocationData.template_name,
+    };
+
+    Object.entries(informationToCheck).forEach(([term, expectedText]) => {
+      const termContainers = container.querySelectorAll(
+        '.pf-c-description-list__term .pf-c-description-list__text'
+      );
+      termContainers.forEach(termContainer => {
+        if (termContainer.textContent.includes(term)) {
+          let descriptionContainer;
+          if (term === 'SSH user:') {
+            descriptionContainer = termContainer
+              .closest('.pf-c-description-list__group')
+              .querySelector(
+                '.pf-c-description-list__description .pf-c-description-list__text .disabled-text'
+              );
+          } else {
+            descriptionContainer = termContainer
+              .closest('.pf-c-description-list__group')
+              .querySelector(
+                '.pf-c-description-list__description .pf-c-description-list__text'
+              );
+          }
+          expect(descriptionContainer.textContent).toContain(expectedText);
+        }
+      });
+    });
+
+    // checks the global actions and if they link to the correct url
+    expect(screen.getByText('Create report').getAttribute('href')).toEqual(
+      foremanUrl(
+        `/templates/report_templates/${mockReportTemplatesResponse.results[0].id}/generate?report_template_report%5Binput_values%5D%5B${mockReportTemplateInputsResponse.results[0].id}%5D%5Bvalue%5D=${jobId}`
+      )
+    );
+    expect(screen.getByText('Rerun all').getAttribute('href')).toEqual(
+      foremanUrl(`/job_invocations/${jobId}/rerun`)
+    );
+    act(() => {
+      fireEvent.click(screen.getByRole('button', { name: 'Select' }));
+    });
+    expect(
+      screen
+        .getByText('Rerun successful')
+        .closest('a')
+        .getAttribute('href')
+    ).toEqual(foremanUrl(`/job_invocations/${jobId}/rerun?succeeded_only=1`));
+    expect(
+      screen
+        .getByText('Rerun failed')
+        .closest('a')
+        .getAttribute('href')
+    ).toEqual(foremanUrl(`/job_invocations/${jobId}/rerun?failed_only=1`));
+    expect(
+      screen
+        .getByText('View task')
+        .closest('a')
+        .getAttribute('href')
+    ).toEqual(foremanUrl(`/foreman_tasks/tasks/${jobInvocationData.task.id}`));
+    expect(screen.getByText('Cancel')).toBeInTheDocument();
+    expect(screen.getByText('Abort')).toBeInTheDocument();
+    expect(screen.queryByText('Enable recurring')).not.toBeInTheDocument();
+    expect(screen.queryByText('Cancel recurring')).not.toBeInTheDocument();
+    expect(
+      screen
+        .getByText('Legacy UI')
+        .closest('a')
+        .getAttribute('href')
+    ).toEqual(`/job_invocations/${jobId}`);
+  });
+
+  it('shows scheduled date', async () => {
+    const store = mockStore(initialStateScheduled);
+    render(
+      <Provider store={store}>
+        <JobInvocationDetailPage
+          match={{ params: { id: `${jobInvocationDataScheduled.id}` } }}
+        />
+      </Provider>
+    );
+
+    expect(screen.getByText('Scheduled at:')).toBeInTheDocument();
+    expect(screen.getByText('Jan 1, 3000, 11:34 UTC')).toBeInTheDocument();
+    expect(screen.getByText('Not yet')).toBeInTheDocument();
+  });
+
+  it('should dispatch global actions', async () => {
+    // recurring in the future
+    const jobId = jobInvocationDataRecurring.id;
+    const recurrenceId = jobInvocationDataRecurring.recurrence.id;
+    const store = mockStore(jobInvocationDataRecurring);
+    render(
+      <Provider store={store}>
+        <JobInvocationDetailPage match={{ params: { id: `${jobId}` } }} />
+      </Provider>
+    );
+
+    const expectedActions = [
+      { key: GET_REPORT_TEMPLATES, url: '/api/report_templates' },
+      {
+        key: JOB_INVOCATION_KEY,
+        url: `/api/job_invocations/${jobId}`,
+      },
+      {
+        key: GET_REPORT_TEMPLATE_INPUTS,
+        url: `/api/templates/${reportTemplateJobId}/template_inputs`,
+      },
+      {
+        key: CANCEL_JOB,
+        url: `/job_invocations/${jobId}/cancel`,
+      },
+      {
+        key: CANCEL_JOB,
+        url: `/job_invocations/${jobId}/cancel?force=true`,
+      },
+      {
+        key: CHANGE_ENABLED_RECURRING_LOGIC,
+        url: `/foreman_tasks/api/recurring_logics/${recurrenceId}`,
+      },
+      {
+        key: CHANGE_ENABLED_RECURRING_LOGIC,
+        url: `/foreman_tasks/api/recurring_logics/${recurrenceId}`,
+      },
+      {
+        key: CANCEL_RECURRING_LOGIC,
+        url: `/foreman_tasks/recurring_logics/${recurrenceId}/cancel`,
+      },
+    ];
+
+    store.dispatch(cancelJob(jobId, false));
+    store.dispatch(cancelJob(jobId, true));
+    store.dispatch(enableRecurringLogic(recurrenceId, true, jobId));
+    store.dispatch(enableRecurringLogic(recurrenceId, false, jobId));
+    store.dispatch(cancelRecurringLogic(recurrenceId, jobId));
+
+    const actualActions = store.getActions();
+    expect(actualActions).toHaveLength(expectedActions.length);
+
+    expectedActions.forEach((expectedAction, index) => {
+      if (actualActions[index].type === 'WITH_INTERVAL') {
+        expect(actualActions[index].key.key).toEqual(expectedAction.key);
+        expect(actualActions[index].key.url).toEqual(expectedAction.url);
+      } else {
+        expect(actualActions[index].key).toEqual(expectedAction.key);
+        if (expectedAction.url) {
+          expect(actualActions[index].url).toEqual(expectedAction.url);
+        }
+      }
+    });
+  });
+});

data/webpack/JobInvocationDetail/__tests__/fixtures.js

@@ -0,0 +1,117 @@
+export const jobInvocationData = {
+  id: 123,
+  description: 'Description',
+  job_category: 'Commands',
+  targeting_id: 123,
+  status: 1,
+  start_at: '2024-01-01 12:34:56 +0100',
+  status_label: 'failed',
+  ssh_user: null,
+  time_to_pickup: null,
+  template_id: 321,
+  template_name: 'Run Command - Script Default',
+  effective_user: 'root',
+  succeeded: 2,
+  failed: 4,
+  pending: 0,
+  cancelled: 0,
+  total: 6,
+  missing: 5,
+  total_hosts: 6,
+  task: {
+    id: '37ad5ead-51de-4798-bc73-a17687c4d5aa',
+    state: 'stopped',
+  },
+  template_invocations: [
+    {
+      template_id: 321,
+      template_name: 'Run Command - Script Default',
+      host_id: 1,
+      template_invocation_input_values: [
+        {
+          template_input_name: 'command',
+          template_input_id: 59,
+          value:
+            'echo start; for i in $(seq 1 120); do echo $i; sleep 1; done; echo done',
+        },
+      ],
+    },
+  ],
+};
+
+export const jobInvocationDataScheduled = {
+  id: 456,
+  description: 'Description',
+  job_category: 'Commands',
+  targeting_id: 456,
+  status: 1,
+  start_at: '3000-01-01 12:34:56 +0100',
+  status_label: 'failed',
+  ssh_user: null,
+  time_to_pickup: null,
+  template_id: 321,
+  template_name: 'Run Command - Script Default',
+  effective_user: 'root',
+  succeeded: 2,
+  failed: 4,
+  pending: 0,
+  cancelled: 0,
+  total: 6,
+  missing: 5,
+  total_hosts: 6,
+};
+
+export const jobInvocationDataRecurring = {
+  id: 789,
+  description: 'Description',
+  job_category: 'Commands',
+  targeting_id: 456,
+  status: 2,
+  start_at: '3000-01-01 12:00:00 +0100',
+  status_label: 'queued',
+  ssh_user: null,
+  time_to_pickup: null,
+  template_id: 321,
+  template_name: 'Run Command - Script Default',
+  effective_user: 'root',
+  succeeded: 0,
+  failed: 0,
+  pending: 0,
+  cancelled: 0,
+  total: 'N/A',
+  missing: 0,
+  total_hosts: 1,
+  task: {
+    id: '37ad5ead-51de-4798-bc73-a17687c4d5aa',
+    state: 'scheduled',
+  },
+  mode: 'recurring',
+  recurrence: {
+    id: 1,
+    cron_line: '00 12 * * *',
+    end_time: null,
+    iteration: 1,
+    task_group_id: 12,
+    state: 'active',
+    max_iteration: null,
+    purpose: null,
+    task_count: 1,
+    action: 'Run hosts job:',
+    last_occurence: null,
+    next_occurence: '3000-01-01 12:00:00 +0100',
+  },
+};
+
+export const mockPermissionsData = {
+  edit_job_templates: true,
+  view_foreman_tasks: true,
+  edit_recurring_logics: true,
+};
+
+export const mockReportTemplatesResponse = {
+  results: [{ id: '12', name: 'Job - Invocation Report' }],
+};
+
+export const mockReportTemplateInputsResponse = {
+  results: [{ id: '34', name: 'job_id' }],
+};

data/webpack/JobInvocationDetail/index.js

@@ -1,20 +1,24 @@
-import React, { useEffect } from 'react';
-import { useSelector, useDispatch } from 'react-redux';
 import PropTypes from 'prop-types';
-import { Divider, PageSection, Flex } from '@patternfly/react-core';
+import React, { useEffect } from 'react';
+import { useDispatch, useSelector } from 'react-redux';
+import { Divider, Flex } from '@patternfly/react-core';
 import { translate as __, documentLocale } from 'foremanReact/common/I18n';
 import PageLayout from 'foremanReact/routes/common/PageLayout/PageLayout';
+import { useAPI } from 'foremanReact/common/hooks/API/APIHooks';
 import { stopInterval } from 'foremanReact/redux/middlewares/IntervalMiddleware';
-import { getData } from './JobInvocationActions';
-import { selectItems } from './JobInvocationSelectors';
-import JobInvocationOverview from './JobInvocationOverview';
-import JobInvocationSystemStatusChart from './JobInvocationSystemStatusChart';
+import { getData, getTask } from './JobInvocationActions';
 import {
+  CURRENT_PERMISSIONS,
+  DATE_OPTIONS,
   JOB_INVOCATION_KEY,
   STATUS,
-  DATE_OPTIONS,
+  currentPermissionsUrl,
 } from './JobInvocationConstants';
 import './JobInvocationDetail.scss';
+import JobInvocationOverview from './JobInvocationOverview';
+import { selectItems } from './JobInvocationSelectors';
+import JobInvocationSystemStatusChart from './JobInvocationSystemStatusChart';
+import JobInvocationToolbarButtons from './JobInvocationToolbarButtons';
 
 const JobInvocationDetailPage = ({
   match: {
@@ -30,8 +34,15 @@ const JobInvocationDetailPage = ({
     start_at: startAt,
   } = items;
   const finished =
-    statusLabel === STATUS.FAILED || statusLabel === STATUS.SUCCEEDED;
+    statusLabel === STATUS.FAILED ||
+    statusLabel === STATUS.SUCCEEDED ||
+    statusLabel === STATUS.CANCELLED;
   const autoRefresh = task?.state === STATUS.PENDING || false;
+  const { response, status } = useAPI(
+    'get',
+    currentPermissionsUrl,
+    CURRENT_PERMISSIONS
+  );
 
   let isAlreadyStarted = false;
   let formattedStartDate;
@@ -56,6 +67,12 @@ const JobInvocationDetailPage = ({
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [dispatch, id, finished, autoRefresh]);
 
+  useEffect(() => {
+    if (task?.id !== undefined) {
+      dispatch(getTask(`${task?.id}`));
+    }
+  }, [dispatch, task]);
+
   const breadcrumbOptions = {
     breadcrumbItems: [
       { caption: __('Jobs'), url: `/job_invocations` },
@@ -68,38 +85,41 @@ const JobInvocationDetailPage = ({
     <PageLayout
       header={description}
       breadcrumbOptions={breadcrumbOptions}
+      toolbarButtons={
+        <JobInvocationToolbarButtons
+          jobId={id}
+          data={items}
+          currentPermissions={response.results}
+          permissionsStatus={status}
+        />
+      }
       searchable={false}
     >
-      <React.Fragment>
-        <PageSection
-          className="job-invocation-detail-page-section"
-          isFilled
-          variant="light"
+      <Flex
+        className="job-invocation-detail-flex"
+        alignItems={{ default: 'alignItemsFlexStart' }}
+      >
+        <JobInvocationSystemStatusChart
+          data={items}
+          isAlreadyStarted={isAlreadyStarted}
+          formattedStartDate={formattedStartDate}
+        />
+        <Divider
+          orientation={{
+            default: 'vertical',
+          }}
+        />
+        <Flex
+          className="job-overview"
+          alignItems={{ default: 'alignItemsCenter' }}
         >
-          <Flex alignItems={{ default: 'alignItemsFlexStart' }}>
-            <JobInvocationSystemStatusChart
-              data={items}
-              isAlreadyStarted={isAlreadyStarted}
-              formattedStartDate={formattedStartDate}
-            />
-            <Divider
-              orientation={{
-                default: 'vertical',
-              }}
-            />
-            <Flex
-              className="job-overview"
-              alignItems={{ default: 'alignItemsCenter' }}
-            >
-              <JobInvocationOverview
-                data={items}
-                isAlreadyStarted={isAlreadyStarted}
-                formattedStartDate={formattedStartDate}
-              />
-            </Flex>
-          </Flex>
-        </PageSection>
-      </React.Fragment>
+          <JobInvocationOverview
+            data={items}
+            isAlreadyStarted={isAlreadyStarted}
+            formattedStartDate={formattedStartDate}
+          />
+        </Flex>
+      </Flex>
     </PageLayout>
   );
 };

data/webpack/JobWizard/JobWizardPageRerun.js

@@ -1,15 +1,15 @@
-import React from 'react';
 import PropTypes from 'prop-types';
+import React from 'react';
 import URI from 'urijs';
-import { Alert, Divider, Skeleton, Button } from '@patternfly/react-core';
-import { sprintf, translate as __ } from 'foremanReact/common/I18n';
-import { useAPI } from 'foremanReact/common/hooks/API/APIHooks';
-import PageLayout from 'foremanReact/routes/common/PageLayout/PageLayout';
-import { STATUS } from 'foremanReact/constants';
+import { Alert, Button, Divider, Skeleton } from '@patternfly/react-core';
 import {
-  useForemanOrganization,
   useForemanLocation,
+  useForemanOrganization,
 } from 'foremanReact/Root/Context/ForemanContext';
+import { translate as __, sprintf } from 'foremanReact/common/I18n';
+import { useAPI } from 'foremanReact/common/hooks/API/APIHooks';
+import { STATUS } from 'foremanReact/constants';
+import PageLayout from 'foremanReact/routes/common/PageLayout/PageLayout';
 import { JobWizard } from './JobWizard';
 import { JOB_API_KEY } from './JobWizardConstants';
 
@@ -21,11 +21,16 @@ const JobWizardPageRerun = ({
 }) => {
   const uri = new URI(search);
   const { failed_only: failedOnly } = uri.search(true);
+  const { succeeded_only: succeededOnly } = uri.search(true);
+  let queryParams = '';
+  if (failedOnly) {
+    queryParams = '&failed_only=1';
+  } else if (succeededOnly) {
+    queryParams = '&succeeded_only=1';
+  }
   const { response, status } = useAPI(
     'get',
-    `/ui_job_wizard/job_invocation?id=${id}${
-      failedOnly ? '&failed_only=1' : ''
-    }`,
+    `/ui_job_wizard/job_invocation?id=${id}${queryParams}`,
     JOB_API_KEY
   );
   const title = __('Run job');
@@ -53,7 +58,7 @@ const JobWizardPageRerun = ({
           component="a"
           href={`/old/job_invocations/${id}/rerun${search}`}
         >
-          {__('Use old form')}
+          {__('Use legacy form')}
         </Button>
       }
     >

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

@@ -4,16 +4,18 @@ import { useSelector } from 'react-redux';
 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 {
+  useForemanHostsPageUrl,
+  useForemanHostDetailsPageUrl,
+} from 'foremanReact/Root/Context/ForemanContext';
 import { selectHosts, selectHostCount } from '../../JobWizardSelectors';
 import { HOSTS_TO_PREVIEW_AMOUNT } from '../../JobWizardConstants';
 
 export const HostPreviewModal = ({ isOpen, setIsOpen, searchQuery }) => {
   const hosts = useSelector(selectHosts);
   const hostsCount = useSelector(selectHostCount);
-  const url = new URI(foremanUrl('/hosts'));
-
+  const hostsUrl = new URI(useForemanHostsPageUrl());
+  const hostUrl = useForemanHostDetailsPageUrl();
   return (
     <Modal
       ouiaId="host-preview-modal"
@@ -28,7 +30,7 @@ export const HostPreviewModal = ({ isOpen, setIsOpen, searchQuery }) => {
             <Button
               ouiaId={`host-preview-${host}`}
               component="a"
-              href={foremanUrl(`${HOSTS_PATH}/${host.name}`)}
+              href={`${hostUrl}${host.name}`}
               variant="link"
               target="_blank"
               rel="noreferrer"
@@ -43,7 +45,7 @@ export const HostPreviewModal = ({ isOpen, setIsOpen, searchQuery }) => {
             <Button
               ouiaId="host-preview-more"
               component="a"
-              href={url.addSearch({ search: searchQuery })}
+              href={hostsUrl.addSearch({ search: searchQuery })}
               variant="link"
               target="_blank"
               rel="noreferrer"

data/webpack/__mocks__/foremanReact/Root/Context/ForemanContext/index.js

@@ -1,3 +1,5 @@
 export const useForemanOrganization = () => ({ id: 1 });
 export const useForemanLocation = () => ({ id: 2 });
 export const useForemanVersion = () => '3.7';
+export const useForemanHostsPageUrl = () => '/hosts';
+export const useForemanHostDetailsPageUrl = () => '/hosts/';

data/webpack/__mocks__/foremanReact/components/BreadcrumbBar/index.js

@@ -0,0 +1,4 @@
+import React from 'react';
+
+const BreadcrumbBar = () => <div />;
+export default BreadcrumbBar;

data/webpack/__mocks__/foremanReact/components/Head/index.js

@@ -0,0 +1,10 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+
+const Head = ({ children }) => <div>{children}</div>;
+
+Head.propTypes = {
+  children: PropTypes.node.isRequired,
+};
+
+export default Head;

data/webpack/__mocks__/foremanReact/components/HostDetails/DetailsCard/DefaultLoaderEmptyState.js

@@ -0,0 +1,8 @@
+import React from 'react';
+import { translate as __ } from '../../../common/I18n';
+
+const DefaultLoaderEmptyState = () => (
+  <span className="disabled-text">{__('Not available')}</span>
+);
+
+export default DefaultLoaderEmptyState;

data/webpack/__mocks__/foremanReact/components/ToastsList/index.js

@@ -0,0 +1,3 @@
+import React from 'react';
+
+export const ToastsList = () => <div />;

data/webpack/__mocks__/foremanReact/redux/API/APIActions.js

@@ -0,0 +1,21 @@
+import { API_OPERATIONS } from 'foremanReact/redux/API/APIConstants';
+
+const { GET, POST, PUT, DELETE, PATCH } = API_OPERATIONS;
+
+const apiAction = (type, payload) => ({ type, payload });
+
+export const get = payload => apiAction(GET, payload);
+
+export const post = payload => apiAction(POST, payload);
+
+export const put = payload => apiAction(PUT, payload);
+
+export const patch = payload => apiAction(PATCH, payload);
+
+export const APIActions = {
+  get,
+  post,
+  put,
+  patch,
+  delete: payload => apiAction(DELETE, payload),
+};

data/webpack/__mocks__/foremanReact/redux/API/APIConstants.js

@@ -0,0 +1,7 @@
+export const API_OPERATIONS = {
+  GET: 'API_GET',
+  POST: 'API_POST',
+  PUT: 'API_PUT',
+  DELETE: 'API_DELETE',
+  PATCH: 'API_PATCH',
+};