foreman-tasks 12.2.4 → 13.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23f5d844abe59e29a92b15f62c0770e4c3c1b577a1315232c422d976fa77a07e
-  data.tar.gz: 5d6316649f6cb75894b966301e5d8abefa579d472ddb33052d06e9d32210b869
+  metadata.gz: 270e537ec64af9327b2598da48e8422a56adc1716e45ee5105cb57c9bd2d1078
+  data.tar.gz: da3627e82bdecfcd63516cf3e973461b22762023374ee58ac105e7f9e66c2cf7
 SHA512:
-  metadata.gz: 7b16c2a1cd40296f38805bddb2a96879ed09d4288e7dc03c8061ba6b561333c96f9e9aa213b583349bce844580b85cc24833ca49f617e67730d3e6b28edf4773
-  data.tar.gz: 2b147d1a8a95389cb7c6a12c4fefea577cdec04f8c0ca66315b4411e62f968b1255b4a82438c014300bfd8d67eb0b9a0bea6fcaf277f1eb2d7058a8feaf5375f
+  metadata.gz: dc37e5ebbdb2aa62a131d2828a619f00c68b1c6c262a78df83671801b7047eeafd2bd31fd43e52fff79d7a9b2bb69267a950bd2e71babc6569c20d55a90caab2
+  data.tar.gz: ba180fe7ad221035c14474ed9b1cc62795d2d90ff585fdc0304bda52432e43917829d016abd03e18e68ffcb9654f1a73864695d93fe1219214f7a14d43de0033

data/app/controllers/foreman_tasks/tasks_controller.rb

@@ -6,11 +6,6 @@ module ForemanTasks
 
     before_action :find_dynflow_task, only: [:unlock, :force_unlock, :cancel, :abort, :cancel_step, :resume]
 
-    def show
-      @task = resource_base.find(params[:id])
-      render :layout => !request.xhr?
-    end
-
     def index
       params[:order] ||= 'started_at DESC'
       respond_with_tasks resource_base

data/app/services/foreman_tasks/troubleshooting_help_generator.rb

@@ -67,7 +67,7 @@ module ForemanTasks
         i.add_line _('A paused task represents a process that has not finished properly. '\
                         'Any task in paused state can lead to potential inconsistency '\
                         'and needs to be resolved.')
-        i.add_line _("The recommended approach is to investigate the error messages below and in 'errors' tab, "\
+        i.add_line _("The recommended approach is to investigate the error messages below and in 'Execution details' tab, "\
                      'address the primary cause of the issue and resume the task.')
         if (link = troubleshooting_link)
           i.add_link(link)

data/config/routes.rb

@@ -12,7 +12,7 @@ Foreman::Application.routes.draw do
       end
     end
 
-    resources :tasks, :only => [:show] do
+    resources :tasks, :only => [] do
       collection do
         get 'auto_complete_search'
         get '/summary/:recent_timeframe', action: 'summary'
@@ -27,7 +27,7 @@ Foreman::Application.routes.draw do
         post :cancel_step
       end
     end
-    resources :tasks, :only => [:show], constraints: ->(req) { req.format == :csv } do
+    resources :tasks, :only => [], constraints: ->(req) { req.format == :csv } do
       member do
         get :sub_tasks
       end
@@ -35,6 +35,7 @@ Foreman::Application.routes.draw do
     resources :tasks, :only => [:index], constraints: ->(req) { req.format == :csv }
 
     match '/tasks', to: '/react#index', via: :get
+    match '/tasks/:id', to: '/react#index', via: :get, :as => :task
     match '/tasks/:id/sub_tasks', to: '/react#index', via: :get
 
     namespace :api do

data/lib/foreman_tasks/engine.rb

@@ -20,7 +20,7 @@ module ForemanTasks
       require 'foreman/cron'
 
       Foreman::Plugin.register :"foreman-tasks" do
-        requires_foreman '>= 3.19'
+        requires_foreman '>= 5.0'
         register_global_js_file 'global'
         divider :top_menu, :parent => :monitor_menu, :last => true, :caption => N_('Foreman Tasks')
         menu :top_menu, :tasks,
@@ -36,7 +36,7 @@ module ForemanTasks
              :last     => true
 
         security_block :foreman_tasks do |_map|
-          permission :view_foreman_tasks, { :'foreman_tasks/tasks' => [:auto_complete_search, :sub_tasks, :index, :summary, :summary_sub_tasks, :show],
+          permission :view_foreman_tasks, { :'foreman_tasks/tasks' => [:auto_complete_search, :sub_tasks, :index, :summary, :summary_sub_tasks],
                                             :'foreman_tasks/api/tasks' => [:bulk_search, :show, :index, :summary, :summary_sub_tasks, :details, :sub_tasks] }, :resource_type => 'ForemanTasks::Task'
           permission :edit_foreman_tasks, { :'foreman_tasks/tasks' => [:resume, :unlock, :force_unlock, :cancel_step, :cancel, :abort],
                                             :'foreman_tasks/api/tasks' => [:bulk_resume, :bulk_cancel, :bulk_stop] }, :resource_type => 'ForemanTasks::Task'

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '12.2.4'.freeze
+  VERSION = '13.1.0'.freeze
 end

data/test/controllers/tasks_controller_test.rb

@@ -82,15 +82,6 @@ module ForemanTasks
         assert_include response.body.lines[1], 'Some action'
       end
 
-      describe 'show' do
-        it 'does not allow user without permissions to see task details' do
-          setup_user('view', 'foreman_tasks', 'owner.id = current_user')
-          get :show, params: { id: FactoryBot.create(:some_task).id },
-                     session: set_session_user(User.current)
-          assert_response :not_found
-        end
-      end
-
       describe 'index' do
         it 'shows duration column' do
           task = ForemanTasks::Task.select_duration.find(FactoryBot.create(:some_task).id)

data/test/foreman_tasks_test_helper.rb

@@ -9,8 +9,8 @@ require_relative './support/history_tasks_builder'
 require 'dynflow/testing'
 require 'foreman_tasks/test_helpers'
 
-FactoryBot.definition_file_paths = ["#{ForemanTasks::Engine.root}/test/factories"]
-FactoryBot.find_definitions
+FactoryBot.definition_file_paths << "#{ForemanTasks::Engine.root}/test/factories"
+FactoryBot.reload
 
 ForemanTasks.dynflow.require!
 ForemanTasks.dynflow.config.disable_active_record_actions = true

data/test/integration/tasks_test.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../test_plugin_helper'
+require 'integration_test_helper'
+
+class TasksIntegrationTest < IntegrationTestWithJavascript
+  test 'does not allow user without permissions to see task details' do
+    setup_user('view', 'foreman_tasks', 'owner.id = current_user')
+    task = FactoryBot.create(:some_task)
+    set_request_user(User.current)
+
+    visit "/foreman_tasks/tasks/#{task.id}"
+
+    assert_selector 'h5', text: /Unable to load task/i
+    assert_no_selector '#task-details-tabs'
+  end
+end

data/test/test_plugin_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# This calls the main test_helper in Foreman-core
+require 'test_helper'
+
+# Add plugin to FactoryBot's paths
+FactoryBot.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+FactoryBot.reload

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

@@ -1,75 +1,13 @@
-import React, { useState } from 'react';
-import PropTypes from 'prop-types';
+import React from 'react';
+import { Stack, StackItem } from '@patternfly/react-core';
 import TaskInfo from './TaskInfo';
-import {
-  ForceUnlockConfirmationModal,
-  UnlockConfirmationModal,
-} from '../../common/ClickConfirmation';
-import { TaskButtons } from './TaskButtons';
 
-const Task = props => {
-  const {
-    taskReload,
-    id,
-    forceCancelTaskRequest,
-    unlockTaskRequest,
-    action,
-    taskReloadStart,
-  } = props;
-  const forceUnlock = () => {
-    if (!taskReload) {
-      taskReloadStart(id);
-    }
-    forceCancelTaskRequest(id, action);
-  };
-  const unlock = () => {
-    if (!taskReload) {
-      taskReloadStart(id);
-    }
-    unlockTaskRequest(id, action);
-  };
-  const [unlockModalOpen, setUnlockModalOpen] = useState(false);
-  const [forceUnlockModalOpen, setForceUnlockModalOpen] = useState(false);
-
-  return (
-    <React.Fragment>
-      <UnlockConfirmationModal
-        onClick={unlock}
-        isOpen={unlockModalOpen}
-        setModalClosed={() => setUnlockModalOpen(false)}
-      />
-      <ForceUnlockConfirmationModal
-        onClick={forceUnlock}
-        isOpen={forceUnlockModalOpen}
-        setModalClosed={() => setForceUnlockModalOpen(false)}
-      />
-      <TaskButtons
-        taskReloadStart={taskReloadStart}
-        setUnlockModalOpen={setUnlockModalOpen}
-        setForceUnlockModalOpen={setForceUnlockModalOpen}
-        {...props}
-      />
+const Task = props => (
+  <Stack hasGutter>
+    <StackItem>
       <TaskInfo {...props} />
-    </React.Fragment>
-  );
-};
-
-Task.propTypes = {
-  taskReload: PropTypes.bool,
-  id: PropTypes.string,
-  forceCancelTaskRequest: PropTypes.func,
-  unlockTaskRequest: PropTypes.func,
-  action: PropTypes.string,
-  taskReloadStart: PropTypes.func,
-};
-
-Task.defaultProps = {
-  taskReload: false,
-  id: '',
-  forceCancelTaskRequest: () => null,
-  unlockTaskRequest: () => null,
-  action: '',
-  taskReloadStart: () => null,
-};
+    </StackItem>
+  </Stack>
+);
 
 export default Task;

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

@@ -1,9 +1,12 @@
 import React from 'react';
 import PropTypes from 'prop-types';
-import { Button, Icon } from '@patternfly/react-core';
-import { SyncAltIcon } from '@patternfly/react-icons';
+import { Button, Flex, FlexItem, Icon } from '@patternfly/react-core';
+import { SimpleDropdown } from '@patternfly/react-templates';
+import { EllipsisVIcon, SyncAltIcon } from '@patternfly/react-icons';
 import { translate as __ } from 'foremanReact/common/I18n';
 
+import './TaskButtons.scss';
+
 export const TaskButtons = ({
   canEdit,
   dynflowEnableConsole,
@@ -30,120 +33,128 @@ export const TaskButtons = ({
     ? undefined
     : `dynflow_enable_console ${__('Setting is off')}`;
 
+  const overflowItems = [
+    {
+      value: 'reload',
+      ouiaId: 'task-buttons-reload-button',
+      content: (
+        <>
+          <Icon>
+            <SyncAltIcon className={taskReload ? 'spin' : ''} />
+          </Icon>
+          &nbsp;
+          {taskReload ? __('Stop auto-reloading') : __('Start auto-reloading')}
+        </>
+      ),
+      onClick: taskProgressToggle,
+    },
+    {
+      value: 'resume',
+      ouiaId: 'task-buttons-resume-button',
+      content: __('Resume'),
+      onClick: () => {
+        if (!taskReload) {
+          taskReloadStart(id);
+        }
+
+        resumeTaskRequest(id, action);
+      },
+      isDisabled: !canEdit || !resumable,
+      tooltip: editActionsTitle,
+    },
+    ...(parentTask
+      ? [
+          {
+            value: 'parent',
+            ouiaId: 'task-buttons-parent-button',
+            content: __('Parent task'),
+            to: `/foreman_tasks/tasks/${parentTask}`,
+          },
+        ]
+      : []),
+    ...(hasSubTasks
+      ? [
+          {
+            value: 'subtasks',
+            ouiaId: 'task-buttons-subtask-button',
+            content: __('Sub tasks'),
+            to: `/foreman_tasks/tasks/${id}/sub_tasks`,
+          },
+        ]
+      : []),
+    {
+      value: 'unlock',
+      ouiaId: 'task-buttons-unlock-button',
+      content: __('Unlock'),
+      onClick: () => setUnlockModalOpen(true),
+      isDisabled: !canEdit || state !== 'paused',
+      tooltip: editActionsTitle,
+    },
+    {
+      value: 'force-unlock',
+      ouiaId: 'task-buttons-force-unlock-button',
+      content: __('Force Unlock'),
+      onClick: () => setForceUnlockModalOpen(true),
+      isDisabled: !canEdit || state === 'stopped',
+      tooltip: editActionsTitle,
+    },
+  ];
+
   return (
-    <>
-      <Button
-        variant="secondary"
-        ouiaId="task-buttons-reload-button"
-        className="reload-button"
-        size="sm"
-        onClick={taskProgressToggle}
-      >
-        <Icon className={taskReload ? 'spin' : ''}>
-          <SyncAltIcon />
-        </Icon>
-        {taskReload ? __('Stop auto-reloading') : __('Start auto-reloading')}
-      </Button>
-      <Button
-        variant="secondary"
-        ouiaId="task-buttons-dynflow-button"
-        className="dynflow-button"
-        size="sm"
-        component="a"
-        href={`/foreman_tasks/dynflow/${externalId}`}
-        isDisabled={!dynflowEnableConsole}
-        target="_blank"
-        rel="noopener noreferrer"
-      >
-        <span title={dynflowTitle} data-original-title={dynflowTitle}>
-          {__('Dynflow console')}
-        </span>
-      </Button>
-      <Button
-        variant="secondary"
-        ouiaId="task-buttons-resume-button"
-        className="resume-button"
-        size="sm"
-        title={editActionsTitle}
-        data-original-title={editActionsTitle}
-        isDisabled={!canEdit || !resumable}
-        onClick={() => {
-          if (!taskReload) {
-            taskReloadStart(id);
-          }
-          resumeTaskRequest(id, action);
-        }}
-      >
-        {__('Resume')}
-      </Button>
-      <Button
-        variant="secondary"
-        ouiaId="task-buttons-cancel-button"
-        className="cancel-button"
-        size="sm"
-        title={editActionsTitle}
-        data-original-title={editActionsTitle}
-        isDisabled={!canEdit || !cancellable}
-        onClick={() => {
-          if (!taskReload) {
-            taskReloadStart(id);
-          }
-          cancelTaskRequest(id, action);
-        }}
-      >
-        {__('Cancel')}
-      </Button>
-      {parentTask && (
+    <Flex
+      className="task-buttons"
+      display={{ default: 'inlineFlex' }}
+      alignItems={{ default: 'alignItemsCenter' }}
+      spaceItems={{ default: 'spaceItemsSm' }}
+    >
+      <FlexItem>
         <Button
           variant="secondary"
-          ouiaId="task-buttons-parent-button"
-          className="parent-button"
+          ouiaId="task-buttons-cancel-button"
+          className="cancel-button"
           size="sm"
-          href={`/foreman_tasks/tasks/${parentTask}`}
-          component="a"
+          title={editActionsTitle}
+          data-original-title={editActionsTitle}
+          isDisabled={!canEdit || !cancellable}
+          onClick={() => {
+            if (!taskReload) {
+              taskReloadStart(id);
+            }
+
+            cancelTaskRequest(id, action);
+          }}
         >
-          {__('Parent task')}
+          {__('Cancel')}
         </Button>
-      )}
-      {hasSubTasks && (
+      </FlexItem>
+      <FlexItem>
         <Button
           variant="secondary"
-          ouiaId="task-buttons-subtask-button"
-          className="subtask-button"
+          ouiaId="task-buttons-dynflow-button"
+          className="dynflow-button"
           size="sm"
-          href={`/foreman_tasks/tasks/${id}/sub_tasks`}
           component="a"
+          href={`/foreman_tasks/dynflow/${externalId}`}
+          isDisabled={!dynflowEnableConsole}
+          target="_blank"
+          rel="noopener noreferrer"
         >
-          {__('Sub tasks')}
+          <span title={dynflowTitle} data-original-title={dynflowTitle}>
+            {__('Dynflow console')}
+          </span>
         </Button>
-      )}
-      <Button
-        variant="secondary"
-        ouiaId="task-buttons-unlock-button"
-        className="unlock-button"
-        size="sm"
-        isDisabled={!canEdit || state !== 'paused'}
-        onClick={() => {
-          setUnlockModalOpen(true);
-        }}
-        title={editActionsTitle}
-        data-original-title={editActionsTitle}
-      >
-        {__('Unlock')}
-      </Button>
-      <Button
-        variant="secondary"
-        ouiaId="task-buttons-force-unlock-button"
-        className="force-unlock-button"
-        size="sm"
-        isDisabled={!canEdit || state === 'stopped'}
-        onClick={() => setForceUnlockModalOpen(true)}
-        title={editActionsTitle}
-        data-original-title={editActionsTitle}
-      >
-        {__('Force Unlock')}
-      </Button>
-    </>
+      </FlexItem>
+      <FlexItem>
+        <SimpleDropdown
+          ouiaId="task-buttons-overflow-dropdown"
+          toggleVariant="plain"
+          toggleContent={<EllipsisVIcon aria-hidden="true" />}
+          popperProps={{ position: 'right' }}
+          initialItems={overflowItems}
+          toggleProps={{ 'aria-label': __('Task actions') }}
+        />
+      </FlexItem>
+    </Flex>
   );
 };
 

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

@@ -0,0 +1,45 @@
+.task-buttons {
+  .spin {
+    -webkit-animation: spin 1s infinite linear;
+    -moz-animation: spin 1s infinite linear;
+    -o-animation: spin 1s infinite linear;
+    animation: spin 1s infinite linear;
+    -webkit-transform-origin: 50% 50%;
+    transform-origin: 50% 50%;
+    -ms-transform-origin: 50% 50%; /* IE 9 */
+  }
+
+  @-moz-keyframes spin {
+    from {
+      -moz-transform: rotate(0deg);
+    }
+
+    to {
+      -moz-transform: rotate(360deg);
+    }
+  }
+
+  @-webkit-keyframes spin {
+    from {
+      -webkit-transform: rotate(0deg);
+    }
+
+    to {
+      -webkit-transform: rotate(360deg);
+    }
+  }
+
+  @keyframes spin {
+    from {
+      transform: rotate(0deg);
+    }
+
+    to {
+      transform: rotate(360deg);
+    }
+  }
+
+  .dynflow-button > span {
+    pointer-events: auto;
+  }
+}

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

@@ -22,3 +22,57 @@ export const durationInWords = (
 
 const numberWithDelimiter = x =>
   x.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ',');
+
+export const isDelayed = ({ startAt, startedAt }) => {
+  if (
+    startAt == null ||
+    startedAt == null ||
+    startAt === '' ||
+    startedAt === ''
+  ) {
+    return false;
+  }
+
+  const a = new Date(startAt);
+  const b = new Date(startedAt);
+
+  if (Number.isNaN(a.getTime()) || Number.isNaN(b.getTime())) {
+    return false;
+  }
+
+  a.setMilliseconds(0);
+  b.setMilliseconds(0);
+
+  return a.getTime() !== b.getTime();
+};
+
+export const parseUsernameLinkHref = usernamePath => {
+  if (!usernamePath || typeof usernamePath !== 'string') {
+    return null;
+  }
+
+  const match = usernamePath.match(/href=(["'])(.*?)\1/i);
+
+  return match ? match[2] : null;
+};
+
+export const formatTaskDuration = (startedAtStr, endedAtStr, state) => {
+  if (state !== 'stopped' || !startedAtStr || !endedAtStr) {
+    return __('N/A');
+  }
+
+  const startMs = new Date(startedAtStr).getTime();
+  const endMs = new Date(endedAtStr).getTime();
+
+  if (Number.isNaN(startMs) || Number.isNaN(endMs) || endMs < startMs) {
+    return __('N/A');
+  }
+
+  const duration = durationInWords(startedAtStr, endedAtStr);
+
+  if (typeof duration === 'string') {
+    return duration;
+  }
+
+  return duration.text;
+};