foreman-tasks 1.0.1 → 2.0.1

data/webpack/ForemanTasks/Components/TaskActions/TaskActionHelpers.js

@@ -0,0 +1,67 @@
+import { translate as __, sprintf } from 'foremanReact/common/I18n';
+import { addToast } from 'foremanReact/redux/actions/toasts';
+import { TASKS_DASHBOARD_JS_QUERY_MODES } from '../TasksDashboard/TasksDashboardConstants';
+import { timeToHoursNumber } from '../TasksDashboard/TasksDashboardHelper';
+import {
+  successToastData,
+  errorToastData,
+  warningToastData,
+} from '../common/ToastsHelpers';
+
+export const convertDashboardQuery = query => {
+  const {
+    time_mode: timeMode,
+    time_horizon: timeHorizon,
+    state,
+    result,
+    search,
+  } = query;
+
+  const hours = timeToHoursNumber(timeHorizon);
+  const timestamp = new Date(new Date() - hours * 60 * 60 * 1000);
+  let dashboardTime = '';
+  const stateQuery = state ? `state=${state}` : '';
+  const resultQuery = result ? `result=${result}` : '';
+  if (timeMode === TASKS_DASHBOARD_JS_QUERY_MODES.RECENT) {
+    dashboardTime = `(state_updated_at>${timestamp.toISOString()} or state_updated_at = NULL)`;
+  } else if (timeMode === TASKS_DASHBOARD_JS_QUERY_MODES.OLDER) {
+    dashboardTime = `(state_updated_at>${timestamp.toISOString()})`;
+  }
+  const newQuery = [stateQuery, resultQuery, search, dashboardTime]
+    .filter(Boolean)
+    .join(' and ');
+  return newQuery;
+};
+
+export const resumeToastInfo = {
+  resumed: successToastData(__('was resumed')),
+  failed: errorToastData(__('could not be resumed')),
+  skipped: warningToastData(__('task has to be resumable')),
+};
+
+export const cancelToastInfo = {
+  cancelled: successToastData(__('was cancelled')),
+  skipped: warningToastData(__('task has to be cancellable')),
+};
+
+export const forceCancelToastInfo = {
+  forceCancelled: successToastData(__('resources were unlocked with force.')),
+  failed: warningToastData(__('cannot be cancelled with force at the moment.')),
+};
+
+export const unlockToastInfo = {
+  unlocked: successToastData(__('resources were unlocked ')),
+  failed: warningToastData(__('resources cannot be unlocked at the moment.')),
+};
+
+export const toastDispatch = ({ type, name, toastInfo, dispatch }) => {
+  dispatch(
+    addToast({
+      type: toastInfo[type].type,
+      message: sprintf('%(name)s Task execution %(type)s', {
+        name,
+        type: toastInfo[type].message,
+      }),
+    })
+  );
+};

data/webpack/ForemanTasks/Components/TaskActions/TaskActionHelpers.test.js

@@ -0,0 +1,46 @@
+import { convertDashboardQuery } from './TaskActionHelpers';
+import {
+  TASKS_DASHBOARD_JS_QUERY_MODES,
+  TASKS_DASHBOARD_AVAILABLE_TIMES,
+} from '../TasksDashboard/TasksDashboardConstants';
+
+let realDate;
+
+describe('convertDashboardQuery', () => {
+  it('convertDashboardQuery should work with full query', () => {
+    // Setup
+    const currentDate = new Date('2020-05-08T11:01:58.135Z');
+    realDate = Date;
+    global.Date = class extends Date {
+      constructor(date) {
+        if (date) {
+          // eslint-disable-next-line constructor-super
+          return super(date);
+        }
+        return currentDate;
+      }
+    };
+    const query = {
+      time_mode: TASKS_DASHBOARD_JS_QUERY_MODES.RECENT,
+      time_horizon: TASKS_DASHBOARD_AVAILABLE_TIMES.WEEK,
+      state: 'stopped',
+      result: 'error',
+      search: 'action~job',
+    };
+    expect(convertDashboardQuery(query)).toEqual(
+      'state=stopped and result=error and action~job and (state_updated_at>2020-05-01T11:01:58.135Z or state_updated_at = NULL)'
+    );
+    // Cleanup
+    global.Date = realDate;
+  });
+  it('convertDashboardQuery should work with only search query', () => {
+    const query = {
+      search: 'action~job',
+    };
+    expect(convertDashboardQuery(query)).toEqual('action~job');
+  });
+  it('convertDashboardQuery should work with no query', () => {
+    const query = {};
+    expect(convertDashboardQuery(query)).toEqual('');
+  });
+});

data/webpack/ForemanTasks/Components/TaskActions/TaskActionsConstants.js

@@ -0,0 +1,16 @@
+export const UNLOCK_MODAL = 'unlockModal';
+export const FORCE_UNLOCK_MODAL = 'forceUnlockModal';
+
+export const TASKS_RESUME_REQUEST = 'TASKS_RESUME_REQUEST';
+export const TASKS_RESUME_SUCCESS = 'TASKS_RESUME_SUCCESS';
+export const TASKS_RESUME_FAILURE = 'TASKS_RESUME_FAILURE';
+export const TASKS_CANCEL_REQUEST = 'TASKS_CANCEL_REQUEST';
+export const TASKS_CANCEL_SUCCESS = 'TASKS_CANCEL_SUCCESS';
+export const TASKS_CANCEL_FAILURE = 'TASKS_CANCEL_FAILURE';
+
+export const TASKS_FORCE_CANCEL_REQUEST = 'TASKS_FORCE_CANCEL_REQUEST';
+export const TASKS_FORCE_CANCEL_SUCCESS = 'TASKS_FORCE_CANCEL_SUCCESS';
+export const TASKS_FORCE_CANCEL_FAILURE = 'TASKS_FORCE_CANCEL_FAILURE';
+export const TASKS_UNLOCK_REQUEST = 'TASKS_UNLOCK_REQUEST';
+export const TASKS_UNLOCK_SUCCESS = 'TASKS_UNLOCK_SUCCESS';
+export const TASKS_UNLOCK_FAILURE = 'TASKS_UNLOCK_FAILURE';

data/webpack/ForemanTasks/Components/TaskActions/UnlockModals.js

@@ -0,0 +1,60 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { translate as __, sprintf } from 'foremanReact/common/I18n';
+import { ClickConfirmation } from '../common/ClickConfirmation';
+import { UNLOCK_MODAL, FORCE_UNLOCK_MODAL } from './TaskActionsConstants';
+
+const confirmationMessage = __(
+  'I understand that this may cause harm and have working database backups of all backend services.'
+);
+
+export const UnlockModal = ({ onClick, id }) => (
+  <ClickConfirmation
+    id={id}
+    title={__('Unlock')}
+    body={__(
+      "This will unlock the resources that the task is running against. Please note that this might lead to inconsistent state and should be used with caution, after making sure that the task can't be resumed."
+    )}
+    confirmationMessage={confirmationMessage}
+    confirmAction={__('Unlock')}
+    onClick={onClick}
+    confirmType="warning"
+  />
+);
+
+export const ForceUnlockModal = ({ onClick, id, selectedRowsLen }) => (
+  <ClickConfirmation
+    id={id}
+    title={__('Force Unlock')}
+    body={sprintf(
+      __(
+        `Resources for %s task(s) will be unlocked and will not prevent other tasks from being run. As the task(s) might be still running, it should be avoided to use this unless you are really sure the task(s) got stuck.`
+      ),
+      selectedRowsLen
+    )}
+    confirmationMessage={confirmationMessage}
+    confirmAction={__('Force Unlock')}
+    onClick={onClick}
+    confirmType="danger"
+  />
+);
+
+UnlockModal.propTypes = {
+  onClick: PropTypes.func.isRequired,
+  id: PropTypes.string,
+};
+
+ForceUnlockModal.propTypes = {
+  onClick: PropTypes.func.isRequired,
+  id: PropTypes.string,
+  selectedRowsLen: PropTypes.number,
+};
+
+UnlockModal.defaultProps = {
+  id: UNLOCK_MODAL,
+};
+
+ForceUnlockModal.defaultProps = {
+  id: FORCE_UNLOCK_MODAL,
+  selectedRowsLen: 1,
+};

data/webpack/ForemanTasks/Components/TaskActions/UnlockModals.test.js

@@ -0,0 +1,14 @@
+import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
+
+import { UnlockModal, ForceUnlockModal } from './UnlockModals';
+
+const fixtures = {
+  render: { taskID: 'some-id', onClick: jest.fn() },
+};
+
+describe('UnlockModal', () => {
+  testComponentSnapshotsWithFixtures(UnlockModal, fixtures);
+});
+describe('ForceUnlockModal', () => {
+  testComponentSnapshotsWithFixtures(ForceUnlockModal, fixtures);
+});

data/webpack/ForemanTasks/Components/TaskActions/__snapshots__/TaskAction.test.js.snap

@@ -0,0 +1,233 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Tasks actions should cancelTaskRequest and fail 1`] = `
+Array [
+  Array [
+    Object {
+      "payload": Object {
+        "message": Object {
+          "message": "Trying to cancel some-name task",
+          "type": "info",
+        },
+      },
+      "type": "TOASTS_ADD",
+    },
+  ],
+  Array [
+    Object {
+      "type": "TASKS_CANCEL_REQUEST",
+    },
+  ],
+  Array [
+    Object {
+      "payload": [Error: Network Error],
+      "type": "TASKS_CANCEL_FAILURE",
+    },
+  ],
+  Array [
+    Object {
+      "payload": Object {
+        "message": Object {
+          "message": "some-name Task execution task has to be cancellable",
+          "type": "warning",
+        },
+      },
+      "type": "TOASTS_ADD",
+    },
+  ],
+]
+`;
+
+exports[`Tasks actions should cancelTaskRequest and succeed 1`] = `
+Array [
+  Array [
+    Object {
+      "payload": Object {
+        "message": Object {
+          "message": "Trying to cancel some-name task",
+          "type": "info",
+        },
+      },
+      "type": "TOASTS_ADD",
+    },
+  ],
+  Array [
+    Object {
+      "type": "TASKS_CANCEL_REQUEST",
+    },
+  ],
+  Array [
+    Object {
+      "type": "TASKS_CANCEL_SUCCESS",
+    },
+  ],
+  Array [
+    Object {
+      "payload": Object {
+        "message": Object {
+          "message": "some-name Task execution was cancelled",
+          "type": "success",
+        },
+      },
+      "type": "TOASTS_ADD",
+    },
+  ],
+]
+`;
+
+exports[`Tasks actions should forceCancelTaskRequest and fail 1`] = `
+Array [
+  Array [
+    Object {
+      "type": "TASKS_FORCE_CANCEL_REQUEST",
+    },
+  ],
+  Array [
+    Object {
+      "type": "TASKS_FORCE_CANCEL_FAILURE",
+    },
+  ],
+  Array [
+    Object {
+      "payload": Object {
+        "message": Object {
+          "message": "some-name Task execution cannot be cancelled with force at the moment.",
+          "type": "warning",
+        },
+      },
+      "type": "TOASTS_ADD",
+    },
+  ],
+]
+`;
+
+exports[`Tasks actions should forceCancelTaskRequest and succeed 1`] = `
+Array [
+  Array [
+    Object {
+      "type": "TASKS_FORCE_CANCEL_REQUEST",
+    },
+  ],
+  Array [
+    Object {
+      "type": "TASKS_FORCE_CANCEL_SUCCESS",
+    },
+  ],
+  Array [
+    Object {
+      "payload": Object {
+        "message": Object {
+          "message": "some-name Task execution resources were unlocked with force.",
+          "type": "success",
+        },
+      },
+      "type": "TOASTS_ADD",
+    },
+  ],
+]
+`;
+
+exports[`Tasks actions should resumeTaskRequest and fail 1`] = `
+Array [
+  Array [
+    Object {
+      "type": "TASKS_RESUME_REQUEST",
+    },
+  ],
+  Array [
+    Object {
+      "payload": [Error: Network Error],
+      "type": "TASKS_RESUME_FAILURE",
+    },
+  ],
+  Array [
+    Object {
+      "payload": Object {
+        "message": Object {
+          "message": "some-name Task execution could not be resumed",
+          "type": "error",
+        },
+      },
+      "type": "TOASTS_ADD",
+    },
+  ],
+]
+`;
+
+exports[`Tasks actions should resumeTaskRequest and succeed 1`] = `
+Array [
+  Array [
+    Object {
+      "type": "TASKS_RESUME_REQUEST",
+    },
+  ],
+  Array [
+    Object {
+      "type": "TASKS_RESUME_SUCCESS",
+    },
+  ],
+  Array [
+    Object {
+      "payload": Object {
+        "message": Object {
+          "message": "some-name Task execution was resumed",
+          "type": "success",
+        },
+      },
+      "type": "TOASTS_ADD",
+    },
+  ],
+]
+`;
+
+exports[`Tasks actions should unlockTaskRequest and fail 1`] = `
+Array [
+  Array [
+    Object {
+      "type": "TASKS_FORCE_CANCEL_REQUEST",
+    },
+  ],
+  Array [
+    Object {
+      "type": "TASKS_FORCE_CANCEL_FAILURE",
+    },
+  ],
+  Array [
+    Object {
+      "payload": Object {
+        "message": Object {
+          "message": "some-name Task execution cannot be cancelled with force at the moment.",
+          "type": "warning",
+        },
+      },
+      "type": "TOASTS_ADD",
+    },
+  ],
+]
+`;
+
+exports[`Tasks actions should unlockTaskRequest and succeed 1`] = `
+Array [
+  Array [
+    Object {
+      "type": "TASKS_UNLOCK_REQUEST",
+    },
+  ],
+  Array [
+    Object {
+      "type": "TASKS_UNLOCK_SUCCESS",
+    },
+  ],
+  Array [
+    Object {
+      "payload": Object {
+        "message": Object {
+          "message": "some-name Task execution resources were unlocked ",
+          "type": "success",
+        },
+      },
+      "type": "TOASTS_ADD",
+    },
+  ],
+]
+`;

data/webpack/ForemanTasks/Components/TaskActions/__snapshots__/UnlockModals.test.js.snap

@@ -0,0 +1,25 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`ForceUnlockModal render 1`] = `
+<ClickConfirmation
+  body="Resources for 1 task(s) will be unlocked and will not prevent other tasks from being run. As the task(s) might be still running, it should be avoided to use this unless you are really sure the task(s) got stuck."
+  confirmAction="Force Unlock"
+  confirmType="danger"
+  confirmationMessage="I understand that this may cause harm and have working database backups of all backend services."
+  id="forceUnlockModal"
+  onClick={[MockFunction]}
+  title="Force Unlock"
+/>
+`;
+
+exports[`UnlockModal render 1`] = `
+<ClickConfirmation
+  body="This will unlock the resources that the task is running against. Please note that this might lead to inconsistent state and should be used with caution, after making sure that the task can't be resumed."
+  confirmAction="Unlock"
+  confirmType="warning"
+  confirmationMessage="I understand that this may cause harm and have working database backups of all backend services."
+  id="unlockModal"
+  onClick={[MockFunction]}
+  title="Unlock"
+/>
+`;