foreman-tasks 2.0.3 → 3.0.0

data/test/unit/troubleshooting_help_generator_test.rb

@@ -29,8 +29,8 @@ module ForemanTasks
 
     it 'generates html from the main action troubleshooting_info' do
       generated_html = subject.generate_html
-      generated_html.must_include "A paused task represents a process that has not finished properly"
-      generated_html.must_include %(See <a href="#{expected_troubleshooting_url}">troubleshooting documentation</a> for more details on how to resolve the issue)
+      _(generated_html).must_include "A paused task represents a process that has not finished properly"
+      _(generated_html).must_include %(See <a href="#{expected_troubleshooting_url}">troubleshooting documentation</a> for more details on how to resolve the issue)
     end
 
     it 'exposes link details' do
@@ -48,10 +48,10 @@ module ForemanTasks
 
       it 'includes additional description in generated html' do
         generated_html = subject.generate_html
-        generated_html.must_include 'A paused task represents a process that has not finished properly'
-        generated_html.must_match %r{See <a href=".*">troubleshooting documentation</a> for more details on how to resolve the issue}
-        generated_html.must_include 'This task requires special handling'
-        generated_html.must_include 'Investigate <a href="/additional_troubleshooting_page">custom link</a> on more details for this custom error'
+        _(generated_html).must_include 'A paused task represents a process that has not finished properly'
+        _(generated_html).must_match %r{See <a href=".*">troubleshooting documentation</a> for more details on how to resolve the issue}
+        _(generated_html).must_include 'This task requires special handling'
+        _(generated_html).must_include 'Investigate <a href="/additional_troubleshooting_page">custom link</a> on more details for this custom error'
       end
 
       it 'includes additional links' do

data/test/unit/ui_notifications_test.rb

@@ -23,11 +23,11 @@ module ForemanTasks
       it 'notifies all admins about current amount of paused tasks when some paused task occurs' do
         trigger_task
         notification = user_notifications(admin_user).first
-        notification.message.must_equal "There is 1 paused task in the system that need attention"
+        _(notification.message).must_equal "There is 1 paused task in the system that need attention"
         links = notification.actions['links']
-        links.must_include('href' => '/foreman_tasks/tasks?search=state%3Dpaused',
+        _(links).must_include('href' => '/foreman_tasks/tasks?search=state%3Dpaused',
                            'title' => 'List of tasks')
-        links.must_include('name' => 'troubleshooting',
+        _(links).must_include('name' => 'troubleshooting',
                            'title' => 'Troubleshooting Documentation',
                            'description' => 'See %{link} for more details on how to resolve the issue',
                            'href' => "https://theforeman.org/manuals/#{SETTINGS[:version].short}/tasks_troubleshooting.html#",
@@ -37,19 +37,19 @@ module ForemanTasks
       it 'aggregates the notification when multiple tasks get paused' do
         trigger_task
         recipient1 = NotificationRecipient.find_by(user_id: admin_user)
-        recipient1.notification.message.must_match(/1 paused task/)
+        _(recipient1.notification.message).must_match(/1 paused task/)
 
         new_admin_user = FactoryBot.create(:user, :admin)
 
         trigger_task
 
-        NotificationRecipient.find_by(id: recipient1.id).must_be_nil
-        Notification.find_by(id: recipient1.notification.id).must_be_nil
+        _(NotificationRecipient.find_by(id: recipient1.id)).must_be_nil
+        _(Notification.find_by(id: recipient1.notification.id)).must_be_nil
         recipient2 = NotificationRecipient.find_by(user_id: admin_user)
-        recipient2.notification.message.must_match(/2 paused tasks/)
+        _(recipient2.notification.message).must_match(/2 paused tasks/)
 
         new_recipient = NotificationRecipient.find_by(user_id: new_admin_user)
-        new_recipient.notification.must_equal recipient2.notification
+        _(new_recipient.notification).must_equal recipient2.notification
       end
     end
 
@@ -59,11 +59,11 @@ module ForemanTasks
         notifications = user_notifications(task_owner)
         assert_equal 1, notifications.size, 'Only notification for the main action should be triggered'
         notification = notifications.first
-        notification.message.must_equal "The task 'Dummy pause action' got paused"
+        _(notification.message).must_equal "The task 'Dummy pause action' got paused"
         links = notification.actions['links']
-        links.must_include("href" => "/foreman_tasks/tasks/#{task.id}",
+        _(links).must_include("href" => "/foreman_tasks/tasks/#{task.id}",
                            "title" => "Task Details")
-        links.must_include('name' => 'troubleshooting',
+        _(links).must_include('name' => 'troubleshooting',
                            'title' => 'Troubleshooting Documentation',
                            'description' => 'See %{link} for more details on how to resolve the issue',
                            'href' => "https://theforeman.org/manuals/#{SETTINGS[:version].short}/tasks_troubleshooting.html#Support::DummyPauseAction",

data/webpack/ForemanTasks/Components/TaskDetails/Components/RunningSteps.js

@@ -8,7 +8,7 @@ const RunningSteps = ({
   id,
   cancelStep,
   taskReload,
-  taskProgressToggle,
+  taskReloadStart,
 }) => {
   if (!runningSteps.length) return <span>{__('No running steps')}</span>;
   return (
@@ -21,7 +21,7 @@ const RunningSteps = ({
                 bsSize="small"
                 onClick={() => {
                   if (!taskReload) {
-                    taskProgressToggle();
+                    taskReloadStart(id);
                   }
                   cancelStep(id, step.id);
                 }}
@@ -59,7 +59,7 @@ RunningSteps.propTypes = {
   id: PropTypes.string.isRequired,
   cancelStep: PropTypes.func.isRequired,
   taskReload: PropTypes.bool.isRequired,
-  taskProgressToggle: PropTypes.func.isRequired,
+  taskReloadStart: PropTypes.func.isRequired,
 };
 
 RunningSteps.defaultProps = {

data/webpack/ForemanTasks/Components/TaskDetails/Components/Task.js

@@ -1,159 +1,37 @@
 import React from 'react';
-import PropTypes from 'prop-types';
-import { Grid, Row, Col, Button } from 'patternfly-react';
-import { translate as __ } from 'foremanReact/common/I18n';
-import { useForemanModal } from 'foremanReact/components/ForemanModal/ForemanModalHooks';
+import { Grid, Row } from 'patternfly-react';
 import TaskInfo from './TaskInfo';
-import {
-  UNLOCK_MODAL,
-  FORCE_UNLOCK_MODAL,
-} from '../../TaskActions/TaskActionsConstants';
 import { ForceUnlockModal, UnlockModal } from '../../TaskActions/UnlockModals';
+import { TaskButtons } from './TaskButtons';
 
 const Task = props => {
-  const unlockModalActions = useForemanModal({
-    id: UNLOCK_MODAL,
-  });
-  const forceUnlockModalActions = useForemanModal({
-    id: FORCE_UNLOCK_MODAL,
-  });
-
   const {
     taskReload,
-    externalId,
     id,
-    state,
-    resumable,
-    cancellable,
-    hasSubTasks,
-    parentTask,
-    cancelTaskRequest,
-    resumeTaskRequest,
     forceCancelTaskRequest,
     unlockTaskRequest,
     action,
-    dynflowEnableConsole,
-    taskProgressToggle,
-    canEdit,
+    taskReloadStart,
   } = props;
   const forceUnlock = () => {
     if (!taskReload) {
-      taskProgressToggle();
+      taskReloadStart(id);
     }
     forceCancelTaskRequest(id, action);
   };
   const unlock = () => {
     if (!taskReload) {
-      taskProgressToggle();
+      taskReloadStart(id);
     }
     unlockTaskRequest(id, action);
   };
-  const editActionsTitle = canEdit
-    ? undefined
-    : __('You do not have permission');
-  const dynflowTitle = dynflowEnableConsole
-    ? undefined
-    : `dynflow_enable_console ${__('Setting is off')}`;
   return (
     <React.Fragment>
       <UnlockModal onClick={unlock} />
       <ForceUnlockModal onClick={forceUnlock} />
       <Grid>
         <Row>
-          <Col xs={12}>
-            <Button
-              className="reload-button"
-              bsSize="small"
-              onClick={taskProgressToggle}
-            >
-              <span
-                className={`glyphicon glyphicon-refresh ${
-                  taskReload ? 'spin' : ''
-                }`}
-              />
-              {__(`${taskReload ? 'Stop' : 'Start'}  auto-reloading`)}
-            </Button>
-            <Button
-              className="dynflow-button"
-              bsSize="small"
-              href={`/foreman_tasks/dynflow/${externalId}`}
-              disabled={!dynflowEnableConsole}
-              rel="noopener noreferrer"
-              target="_blank"
-            >
-              <span title={dynflowTitle} data-original-title={dynflowTitle}>
-                {__('Dynflow console')}
-              </span>
-            </Button>
-            <Button
-              className="resume-button"
-              bsSize="small"
-              title={editActionsTitle}
-              data-original-title={editActionsTitle}
-              disabled={!canEdit || !resumable}
-              onClick={() => {
-                if (!taskReload) {
-                  taskProgressToggle();
-                }
-                resumeTaskRequest(id, action);
-              }}
-            >
-              {__('Resume')}
-            </Button>
-            <Button
-              className="cancel-button"
-              bsSize="small"
-              title={editActionsTitle}
-              data-original-title={editActionsTitle}
-              disabled={!canEdit || !cancellable}
-              onClick={() => {
-                if (!taskReload) {
-                  taskProgressToggle();
-                }
-                cancelTaskRequest(id, action);
-              }}
-            >
-              {__('Cancel')}
-            </Button>
-            {parentTask && (
-              <Button
-                className="parent-button"
-                bsSize="small"
-                href={`/foreman_tasks/tasks/${parentTask}`}
-              >
-                {__('Parent task')}
-              </Button>
-            )}
-            {hasSubTasks && (
-              <Button
-                className="subtask-button"
-                bsSize="small"
-                href={`/foreman_tasks/tasks/${id}/sub_tasks`}
-              >
-                {__('Sub tasks')}
-              </Button>
-            )}
-            <Button
-              className="unlock-button"
-              bsSize="small"
-              disabled={!canEdit || state !== 'paused'}
-              onClick={unlockModalActions.setModalOpen}
-              title={editActionsTitle}
-              data-original-title={editActionsTitle}
-            >
-              {__('Unlock')}
-            </Button>
-            <Button
-              className="force-unlock-button"
-              bsSize="small"
-              disabled={!canEdit || state === 'stopped'}
-              onClick={forceUnlockModalActions.setModalOpen}
-              title={editActionsTitle}
-              data-original-title={editActionsTitle}
-            >
-              {__('Force Unlock')}
-            </Button>
-          </Col>
+          <TaskButtons taskReloadStart={taskReloadStart} {...props} />
         </Row>
         <TaskInfo {...props} />
       </Grid>
@@ -163,39 +41,12 @@ const Task = props => {
 
 Task.propTypes = {
   ...TaskInfo.PropTypes,
-  state: PropTypes.string,
-  resumable: PropTypes.bool,
-  cancellable: PropTypes.bool,
-  refetchTaskDetails: PropTypes.func,
-  hasSubTasks: PropTypes.bool,
-  parentTask: PropTypes.string,
-  taskReload: PropTypes.bool,
-  taskReloadStop: PropTypes.func,
-  timeoutId: PropTypes.number,
-  externalId: PropTypes.string,
-  id: PropTypes.string.isRequired,
-  cancelTaskRequest: PropTypes.func,
-  resumeTaskRequest: PropTypes.func,
-  dynflowEnableConsole: PropTypes.bool,
-  canEdit: PropTypes.bool,
+  ...TaskButtons.PropTypes,
 };
 
 Task.defaultProps = {
   ...TaskInfo.defaultProps,
-  state: '',
-  resumable: false,
-  cancellable: false,
-  refetchTaskDetails: () => null,
-  hasSubTasks: false,
-  parentTask: '',
-  taskReload: false,
-  taskReloadStop: () => null,
-  timeoutId: null,
-  externalId: '',
-  cancelTaskRequest: () => null,
-  resumeTaskRequest: () => null,
-  dynflowEnableConsole: false,
-  canEdit: false,
+  ...TaskButtons.defaultProps,
 };
 
 export default Task;

data/webpack/ForemanTasks/Components/TaskDetails/Components/TaskButtons.js

@@ -0,0 +1,168 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Col, Button } from 'patternfly-react';
+import { useForemanModal } from 'foremanReact/components/ForemanModal/ForemanModalHooks';
+import { translate as __ } from 'foremanReact/common/I18n';
+import {
+  UNLOCK_MODAL,
+  FORCE_UNLOCK_MODAL,
+} from '../../TaskActions/TaskActionsConstants';
+
+export const TaskButtons = ({
+  canEdit,
+  dynflowEnableConsole,
+  taskReloadStart,
+  taskProgressToggle,
+  taskReload,
+  externalId,
+  id,
+  action,
+  state,
+  resumable,
+  cancellable,
+  hasSubTasks,
+  parentTask,
+  cancelTaskRequest,
+  resumeTaskRequest,
+}) => {
+  const unlockModalActions = useForemanModal({
+    id: UNLOCK_MODAL,
+  });
+  const forceUnlockModalActions = useForemanModal({
+    id: FORCE_UNLOCK_MODAL,
+  });
+  const editActionsTitle = canEdit
+    ? undefined
+    : __('You do not have permission');
+  const dynflowTitle = dynflowEnableConsole
+    ? undefined
+    : `dynflow_enable_console ${__('Setting is off')}`;
+
+  return (
+    <Col xs={12}>
+      <Button
+        className="reload-button"
+        bsSize="small"
+        onClick={taskProgressToggle}
+      >
+        <span
+          className={`glyphicon glyphicon-refresh ${taskReload ? 'spin' : ''}`}
+        />
+        {__(`${taskReload ? 'Stop' : 'Start'}  auto-reloading`)}
+      </Button>
+      <Button
+        className="dynflow-button"
+        bsSize="small"
+        href={`/foreman_tasks/dynflow/${externalId}`}
+        disabled={!dynflowEnableConsole}
+        rel="noopener noreferrer"
+        target="_blank"
+      >
+        <span title={dynflowTitle} data-original-title={dynflowTitle}>
+          {__('Dynflow console')}
+        </span>
+      </Button>
+      <Button
+        className="resume-button"
+        bsSize="small"
+        title={editActionsTitle}
+        data-original-title={editActionsTitle}
+        disabled={!canEdit || !resumable}
+        onClick={() => {
+          if (!taskReload) {
+            taskReloadStart(id);
+          }
+          resumeTaskRequest(id, action);
+        }}
+      >
+        {__('Resume')}
+      </Button>
+      <Button
+        className="cancel-button"
+        bsSize="small"
+        title={editActionsTitle}
+        data-original-title={editActionsTitle}
+        disabled={!canEdit || !cancellable}
+        onClick={() => {
+          if (!taskReload) {
+            taskReloadStart(id);
+          }
+          cancelTaskRequest(id, action);
+        }}
+      >
+        {__('Cancel')}
+      </Button>
+      {parentTask && (
+        <Button
+          className="parent-button"
+          bsSize="small"
+          href={`/foreman_tasks/tasks/${parentTask}`}
+        >
+          {__('Parent task')}
+        </Button>
+      )}
+      {hasSubTasks && (
+        <Button
+          className="subtask-button"
+          bsSize="small"
+          href={`/foreman_tasks/tasks/${id}/sub_tasks`}
+        >
+          {__('Sub tasks')}
+        </Button>
+      )}
+      <Button
+        className="unlock-button"
+        bsSize="small"
+        disabled={!canEdit || state !== 'paused'}
+        onClick={unlockModalActions.setModalOpen}
+        title={editActionsTitle}
+        data-original-title={editActionsTitle}
+      >
+        {__('Unlock')}
+      </Button>
+      <Button
+        className="force-unlock-button"
+        bsSize="small"
+        disabled={!canEdit || state === 'stopped'}
+        onClick={forceUnlockModalActions.setModalOpen}
+        title={editActionsTitle}
+        data-original-title={editActionsTitle}
+      >
+        {__('Force Unlock')}
+      </Button>
+    </Col>
+  );
+};
+
+TaskButtons.propTypes = {
+  canEdit: PropTypes.bool,
+  dynflowEnableConsole: PropTypes.bool,
+  taskReloadStart: PropTypes.func.isRequired,
+  taskProgressToggle: PropTypes.func.isRequired,
+  taskReload: PropTypes.bool,
+  externalId: PropTypes.string,
+  id: PropTypes.string.isRequired,
+  action: PropTypes.string,
+  state: PropTypes.string,
+  resumable: PropTypes.bool,
+  cancellable: PropTypes.bool,
+  hasSubTasks: PropTypes.bool,
+  parentTask: PropTypes.string,
+  cancelTaskRequest: PropTypes.func,
+  resumeTaskRequest: PropTypes.func,
+};
+
+TaskButtons.defaultProps = {
+  canEdit: false,
+  dynflowEnableConsole: false,
+  taskReload: false,
+  externalId: '',
+  action: '',
+  state: '',
+  resumable: false,
+  cancellable: false,
+  hasSubTasks: false,
+  parentTask: '',
+  cancelTaskRequest: () => null,
+  resumeTaskRequest: () => null,
+};