foreman_remote_execution 13.1.0 → 13.2.0

data/webpack/JobInvocationDetail/JobInvocationActions.js

@@ -1,9 +1,19 @@
-import { get } from 'foremanReact/redux/API';
+import { translate as __, sprintf } from 'foremanReact/common/I18n';
+import { foremanUrl } from 'foremanReact/common/helpers';
+import { addToast } from 'foremanReact/components/ToastsList';
+import { APIActions, get } from 'foremanReact/redux/API';
 import {
-  withInterval,
   stopInterval,
+  withInterval,
 } from 'foremanReact/redux/middlewares/IntervalMiddleware';
-import { JOB_INVOCATION_KEY } from './JobInvocationConstants';
+import {
+  CANCEL_JOB,
+  CANCEL_RECURRING_LOGIC,
+  CHANGE_ENABLED_RECURRING_LOGIC,
+  GET_TASK,
+  JOB_INVOCATION_KEY,
+  UPDATE_JOB,
+} from './JobInvocationConstants';
 
 export const getData = url => dispatch => {
   const fetchData = withInterval(
@@ -20,3 +30,124 @@ export const getData = url => dispatch => {
 
   dispatch(fetchData);
 };
+
+export const updateJob = jobId => dispatch => {
+  const url = foremanUrl(`/api/job_invocations/${jobId}`);
+  dispatch(
+    APIActions.get({
+      url,
+      key: UPDATE_JOB,
+    })
+  );
+};
+
+export const cancelJob = (jobId, force) => dispatch => {
+  const infoToast = () =>
+    force
+      ? sprintf(__('Trying to abort the job %s.'), jobId)
+      : sprintf(__('Trying to cancel the job %s.'), jobId);
+  const errorToast = response =>
+    force
+      ? sprintf(__(`Could not abort the job %s: ${response}`), jobId)
+      : sprintf(__(`Could not cancel the job %s: ${response}`), jobId);
+  const url = force
+    ? `/job_invocations/${jobId}/cancel?force=true`
+    : `/job_invocations/${jobId}/cancel`;
+
+  dispatch(
+    APIActions.post({
+      url,
+      key: CANCEL_JOB,
+      errorToast: ({ response }) =>
+        errorToast(
+          // eslint-disable-next-line camelcase
+          response?.data?.error?.full_messages ||
+            response?.data?.error?.message ||
+            'Unknown error.'
+        ),
+      handleSuccess: () => {
+        dispatch(
+          addToast({
+            key: `cancel-job-error`,
+            type: 'info',
+            message: infoToast(),
+          })
+        );
+        dispatch(updateJob(jobId));
+      },
+    })
+  );
+};
+
+export const getTask = taskId => dispatch => {
+  dispatch(
+    get({
+      key: GET_TASK,
+      url: `/foreman_tasks/api/tasks/${taskId}`,
+    })
+  );
+};
+
+export const enableRecurringLogic = (
+  recurrenceId,
+  enabled,
+  jobId
+) => dispatch => {
+  const successToast = () =>
+    enabled
+      ? sprintf(__('Recurring logic %s disabled successfully.'), recurrenceId)
+      : sprintf(__('Recurring logic %s enabled successfully.'), recurrenceId);
+  const errorToast = response =>
+    enabled
+      ? sprintf(
+          __(`Could not disable recurring logic %s: ${response}`),
+          recurrenceId
+        )
+      : sprintf(
+          __(`Could not enable recurring logic %s: ${response}`),
+          recurrenceId
+        );
+  const url = `/foreman_tasks/api/recurring_logics/${recurrenceId}`;
+  dispatch(
+    APIActions.put({
+      url,
+      key: CHANGE_ENABLED_RECURRING_LOGIC,
+      params: { recurring_logic: { enabled: !enabled } },
+      successToast,
+      errorToast: ({ response }) =>
+        errorToast(
+          // eslint-disable-next-line camelcase
+          response?.data?.error?.full_messages ||
+            response?.data?.error?.message ||
+            'Unknown error.'
+        ),
+      handleSuccess: () => dispatch(updateJob(jobId)),
+    })
+  );
+};
+
+export const cancelRecurringLogic = (recurrenceId, jobId) => dispatch => {
+  const successToast = () =>
+    sprintf(__('Recurring logic %s cancelled successfully.'), recurrenceId);
+  const errorToast = response =>
+    sprintf(
+      __(`Could not cancel recurring logic %s: ${response}`),
+      recurrenceId
+    );
+  const url = `/foreman_tasks/recurring_logics/${recurrenceId}/cancel`;
+  dispatch(
+    APIActions.post({
+      url,
+      key: CANCEL_RECURRING_LOGIC,
+      successToast,
+      errorToast: ({ response }) =>
+        errorToast(
+          // eslint-disable-next-line camelcase
+          response?.data?.error?.full_messages ||
+            response?.data?.error?.message ||
+            'Unknown error.'
+        ),
+      handleSuccess: () => dispatch(updateJob(jobId)),
+    })
+  );
+};

data/webpack/JobInvocationDetail/JobInvocationConstants.js

@@ -1,9 +1,23 @@
+import { foremanUrl } from 'foremanReact/common/helpers';
+
 export const JOB_INVOCATION_KEY = 'JOB_INVOCATION_KEY';
+export const CURRENT_PERMISSIONS = 'CURRENT_PERMISSIONS';
+export const UPDATE_JOB = 'UPDATE_JOB';
+export const CANCEL_JOB = 'CANCEL_JOB';
+export const GET_TASK = 'GET_TASK';
+export const CHANGE_ENABLED_RECURRING_LOGIC = 'CHANGE_ENABLED_RECURRING_LOGIC';
+export const CANCEL_RECURRING_LOGIC = 'CANCEL_RECURRING_LOGIC';
+export const GET_REPORT_TEMPLATES = 'GET_REPORT_TEMPLATES';
+export const GET_REPORT_TEMPLATE_INPUTS = 'GET_REPORT_TEMPLATE_INPUTS';
+export const currentPermissionsUrl = foremanUrl(
+  '/api/v2/permissions/current_permissions'
+);
 
 export const STATUS = {
   PENDING: 'pending',
   SUCCEEDED: 'succeeded',
   FAILED: 'failed',
+  CANCELLED: 'cancelled',
 };
 
 export const DATE_OPTIONS = {

data/webpack/JobInvocationDetail/JobInvocationDetail.scss

@@ -1,6 +1,8 @@
-.job-invocation-detail-page-section {
+.job-invocation-detail-flex {
   $chart_size: 105px;
-  
+  padding-top: 0px;
+  padding-left: 10px;
+
   .chart-donut {
     height: $chart_size;
     width: $chart_size;
@@ -36,3 +38,4 @@
     height: $chart_size;
   }
 }
+  

data/webpack/JobInvocationDetail/JobInvocationSelectors.js

@@ -3,3 +3,8 @@ import { JOB_INVOCATION_KEY } from './JobInvocationConstants';
 
 export const selectItems = state =>
   selectAPIResponse(state, JOB_INVOCATION_KEY);
+
+export const selectTask = state => selectAPIResponse(state, 'GET_TASK');
+
+export const selectTaskCancelable = state =>
+  selectTask(state).available_actions?.cancellable || false;

data/webpack/JobInvocationDetail/JobInvocationSystemStatusChart.js

@@ -1,6 +1,7 @@
-import React, { useEffect, useState } from 'react';
 import PropTypes from 'prop-types';
+import React, { useEffect, useState } from 'react';
 import { translate as __, sprintf } from 'foremanReact/common/I18n';
+import DefaultLoaderEmptyState from 'foremanReact/components/HostDetails/DetailsCard/DefaultLoaderEmptyState';
 import {
   ChartDonut,
   ChartLabel,
@@ -9,20 +10,19 @@ import {
 } from '@patternfly/react-charts';
 import {
   DescriptionList,
-  DescriptionListTerm,
-  DescriptionListGroup,
   DescriptionListDescription,
+  DescriptionListGroup,
+  DescriptionListTerm,
   FlexItem,
   Text,
 } from '@patternfly/react-core';
 import {
-  global_palette_green_500 as successedColor,
-  global_palette_red_100 as failedColor,
-  global_palette_blue_300 as inProgressColor,
   global_palette_black_600 as canceledColor,
   global_palette_black_500 as emptyChartDonut,
+  global_palette_red_100 as failedColor,
+  global_palette_blue_300 as inProgressColor,
+  global_palette_green_500 as successedColor,
 } from '@patternfly/react-tokens';
-import DefaultLoaderEmptyState from 'foremanReact/components/HostDetails/DetailsCard/DefaultLoaderEmptyState';
 import './JobInvocationDetail.scss';
 
 const JobInvocationSystemStatusChart = ({
@@ -35,9 +35,9 @@ const JobInvocationSystemStatusChart = ({
     failed,
     pending,
     cancelled,
-    total,
     total_hosts: totalHosts, // includes scheduled
   } = data;
+  const total = succeeded + failed + pending + cancelled;
   const chartData = [
     { title: __('Succeeded:'), count: succeeded, color: successedColor.value },
     { title: __('Failed:'), count: failed, color: failedColor.value },
@@ -82,7 +82,11 @@ const JobInvocationSystemStatusChart = ({
             total > 0 ? chartData.map(d => d.color) : [emptyChartDonut.value]
           }
           labelComponent={
-            <ChartTooltip pointerLength={0} constrainToVisibleArea />
+            <ChartTooltip
+              pointerLength={0}
+              constrainToVisibleArea
+              renderInPortal={false}
+            />
           }
           title={chartDonutTitle}
           titleComponent={

data/webpack/JobInvocationDetail/JobInvocationToolbarButtons.js

@@ -0,0 +1,268 @@
+import PropTypes from 'prop-types';
+import React, { useEffect, useState } from 'react';
+import { useDispatch, useSelector } from 'react-redux';
+import {
+  Button,
+  Dropdown,
+  DropdownItem,
+  DropdownPosition,
+  DropdownSeparator,
+  DropdownToggle,
+  Split,
+  SplitItem,
+} from '@patternfly/react-core';
+import { translate as __ } from 'foremanReact/common/I18n';
+import { foremanUrl } from 'foremanReact/common/helpers';
+import { STATUS as APIStatus } from 'foremanReact/constants';
+import { get } from 'foremanReact/redux/API';
+import {
+  cancelJob,
+  cancelRecurringLogic,
+  enableRecurringLogic,
+} from './JobInvocationActions';
+import {
+  STATUS,
+  GET_REPORT_TEMPLATES,
+  GET_REPORT_TEMPLATE_INPUTS,
+} from './JobInvocationConstants';
+import { selectTaskCancelable } from './JobInvocationSelectors';
+
+const JobInvocationToolbarButtons = ({
+  jobId,
+  data,
+  currentPermissions,
+  permissionsStatus,
+}) => {
+  const { succeeded, failed, task, recurrence, permissions } = data;
+  const recurringEnabled = recurrence?.state === 'active';
+  const canViewForemanTasks = permissions
+    ? permissions.view_foreman_tasks
+    : false;
+  const canEditRecurringLogic = permissions
+    ? permissions.edit_recurring_logics
+    : false;
+  const isTaskCancelable = useSelector(selectTaskCancelable);
+  const [isActionOpen, setIsActionOpen] = useState(false);
+  const [reportTemplateJobId, setReportTemplateJobId] = useState(undefined);
+  const [templateInputId, setTemplateInputId] = useState(undefined);
+  const queryParams = new URLSearchParams({
+    [`report_template_report[input_values][${templateInputId}][value]`]: jobId,
+  });
+  const dispatch = useDispatch();
+
+  const onActionFocus = () => {
+    const element = document.getElementById(
+      `toggle-split-button-action-primary-${jobId}`
+    );
+    element.focus();
+  };
+  const onActionSelect = () => {
+    setIsActionOpen(false);
+    onActionFocus();
+  };
+  const hasPermission = permissionRequired =>
+    permissionsStatus === APIStatus.RESOLVED
+      ? currentPermissions?.some(
+          permission => permission.name === permissionRequired
+        )
+      : false;
+
+  useEffect(() => {
+    dispatch(
+      get({
+        key: GET_REPORT_TEMPLATES,
+        url: '/api/report_templates',
+        handleSuccess: ({ data: { results } }) => {
+          setReportTemplateJobId(
+            results.find(result => result.name === 'Job - Invocation Report')
+              ?.id
+          );
+        },
+        handleError: () => {
+          setReportTemplateJobId(undefined);
+        },
+      })
+    );
+  }, [dispatch]);
+  useEffect(() => {
+    if (reportTemplateJobId !== undefined) {
+      dispatch(
+        get({
+          key: GET_REPORT_TEMPLATE_INPUTS,
+          url: `/api/templates/${reportTemplateJobId}/template_inputs`,
+          handleSuccess: ({ data: { results } }) => {
+            setTemplateInputId(
+              results.find(result => result.name === 'job_id')?.id
+            );
+          },
+          handleError: () => {
+            setTemplateInputId(undefined);
+          },
+        })
+      );
+    }
+  }, [dispatch, reportTemplateJobId]);
+
+  const recurrenceDropdownItems = recurrence
+    ? [
+        <DropdownSeparator ouiaId="dropdown-separator-1" key="separator-1" />,
+        <DropdownItem
+          ouiaId="change-enabled-recurring-dropdown-item"
+          onClick={() =>
+            dispatch(
+              enableRecurringLogic(recurrence?.id, recurringEnabled, jobId)
+            )
+          }
+          key="change-enabled-recurring"
+          component="button"
+          isDisabled={
+            recurrence?.id === undefined ||
+            recurrence?.state === 'cancelled' ||
+            !canEditRecurringLogic
+          }
+        >
+          {recurringEnabled ? __('Disable recurring') : __('Enable recurring')}
+        </DropdownItem>,
+        <DropdownItem
+          ouiaId="cancel-recurring-dropdown-item"
+          onClick={() => dispatch(cancelRecurringLogic(recurrence?.id, jobId))}
+          key="cancel-recurring"
+          component="button"
+          isDisabled={
+            recurrence?.id === undefined ||
+            recurrence?.state === 'cancelled' ||
+            !canEditRecurringLogic
+          }
+        >
+          {__('Cancel recurring')}
+        </DropdownItem>,
+      ]
+    : [];
+
+  const dropdownItems = [
+    <DropdownItem
+      ouiaId="rerun-succeeded-dropdown-item"
+      href={foremanUrl(`/job_invocations/${jobId}/rerun?succeeded_only=1`)}
+      key="rerun-succeeded"
+      isDisabled={!(succeeded > 0) || !hasPermission('create_job_invocations')}
+      description="Rerun job on successful hosts"
+    >
+      {__('Rerun successful')}
+    </DropdownItem>,
+    <DropdownItem
+      ouiaId="rerun-failed-dropdown-item"
+      href={foremanUrl(`/job_invocations/${jobId}/rerun?failed_only=1`)}
+      key="rerun-failed"
+      isDisabled={!(failed > 0) || !hasPermission('create_job_invocations')}
+      description="Rerun job on failed hosts"
+    >
+      {__('Rerun failed')}
+    </DropdownItem>,
+    <DropdownItem
+      ouiaId="view-task-dropdown-item"
+      href={foremanUrl(`/foreman_tasks/tasks/${task?.id}`)}
+      key="view-task"
+      isDisabled={!canViewForemanTasks || task === undefined}
+      description="See details of latest task"
+    >
+      {__('View task')}
+    </DropdownItem>,
+    <DropdownSeparator ouiaId="dropdown-separator-0" key="separator-0" />,
+    <DropdownItem
+      ouiaId="cancel-dropdown-item"
+      onClick={() => dispatch(cancelJob(jobId, false))}
+      key="cancel"
+      component="button"
+      isDisabled={!isTaskCancelable || !hasPermission('cancel_job_invocations')}
+      description="Cancel job gracefully"
+    >
+      {__('Cancel')}
+    </DropdownItem>,
+    <DropdownItem
+      ouiaId="abort-dropdown-item"
+      onClick={() => dispatch(cancelJob(jobId, true))}
+      key="abort"
+      component="button"
+      isDisabled={!isTaskCancelable || !hasPermission('cancel_job_invocations')}
+      description="Cancel job immediately"
+    >
+      {__('Abort')}
+    </DropdownItem>,
+    ...recurrenceDropdownItems,
+    <DropdownSeparator ouiaId="dropdown-separator-2" key="separator-2" />,
+    <DropdownItem
+      ouiaId="legacy-ui-dropdown-item"
+      href={`/job_invocations/${jobId}`}
+      key="legacy-ui"
+    >
+      {__('Legacy UI')}
+    </DropdownItem>,
+  ];
+
+  return (
+    <>
+      <Split hasGutter>
+        <SplitItem>
+          <Button
+            component="a"
+            ouiaId="button-create-report"
+            className="button-create-report"
+            href={foremanUrl(
+              `/templates/report_templates/${reportTemplateJobId}/generate?${queryParams.toString()}`
+            )}
+            variant="secondary"
+            isDisabled={
+              task?.state === STATUS.PENDING ||
+              templateInputId === undefined ||
+              !hasPermission('generate_report_templates')
+            }
+          >
+            {__(`Create report`)}
+          </Button>
+        </SplitItem>
+        <SplitItem>
+          <Dropdown
+            ouiaId="job-invocation-global-actions-dropdown"
+            onSelect={onActionSelect}
+            position={DropdownPosition.right}
+            toggle={
+              <DropdownToggle
+                ouiaId="toggle-button-action-primary"
+                id={`toggle-split-button-action-primary-${jobId}`}
+                splitButtonItems={[
+                  <Button
+                    component="a"
+                    ouiaId="button-rerun-all"
+                    key="rerun"
+                    href={foremanUrl(`/job_invocations/${jobId}/rerun`)}
+                    variant="control"
+                    isDisabled={!hasPermission('create_job_invocations')}
+                  >
+                    {__(`Rerun all`)}
+                  </Button>,
+                ]}
+                splitButtonVariant="action"
+                onToggle={setIsActionOpen}
+              />
+            }
+            isOpen={isActionOpen}
+            dropdownItems={dropdownItems}
+          />
+        </SplitItem>
+      </Split>
+    </>
+  );
+};
+
+JobInvocationToolbarButtons.propTypes = {
+  jobId: PropTypes.string.isRequired,
+  data: PropTypes.object.isRequired,
+  currentPermissions: PropTypes.array,
+  permissionsStatus: PropTypes.string,
+};
+JobInvocationToolbarButtons.defaultProps = {
+  currentPermissions: undefined,
+  permissionsStatus: undefined,
+};
+
+export default JobInvocationToolbarButtons;