diff --git a/app/controllers/foreman_tasks/tasks_controller.rb b/app/controllers/foreman_tasks/tasks_controller.rb index 678495a8b..59c001304 100644 --- a/app/controllers/foreman_tasks/tasks_controller.rb +++ b/app/controllers/foreman_tasks/tasks_controller.rb @@ -7,8 +7,9 @@ class TasksController < ::ApplicationController 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? + @task = resource_scope.find(params[:id]) + + render('react/index', :layout => 'layouts/react_application') end def index diff --git a/app/views/foreman_tasks/tasks/show.html.erb b/app/views/foreman_tasks/tasks/show.html.erb deleted file mode 100644 index ad454da05..000000000 --- a/app/views/foreman_tasks/tasks/show.html.erb +++ /dev/null @@ -1,18 +0,0 @@ -<% stylesheet 'foreman_tasks/foreman_tasks' %> -<% content_for(:javascripts) do %> - <%= webpacked_plugins_js_for :'foreman-tasks' %> -<% end %> -<% content_for(:stylesheets) do %> - <%= webpacked_plugins_css_for :'foreman-tasks' %> -<% end %> - -<% title _("Details of %s task") % @task.to_s %> - -<%= breadcrumbs( - items: breadcrumb_items, - name_field: 'action', - resource_url: foreman_tasks_api_tasks_path, - switcher_item_url: foreman_tasks_task_path(:id => ':id') -) %> - -<%= react_component('TaskDetails') %> diff --git a/config/routes.rb b/config/routes.rb index 212a05e4e..49979c41c 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -35,6 +35,7 @@ resources :tasks, :only => [:index], constraints: ->(req) { req.format == :csv } match '/tasks', to: '/react#index', via: :get + get '/tasks/:id', :to => 'tasks#show' match '/tasks/:id/sub_tasks', to: '/react#index', via: :get match '/ex_tasks/:id', to: '/react#index', via: :get diff --git a/test/controllers/tasks_controller_test.rb b/test/controllers/tasks_controller_test.rb index dd3c684ba..1e80e957e 100644 --- a/test/controllers/tasks_controller_test.rb +++ b/test/controllers/tasks_controller_test.rb @@ -83,12 +83,20 @@ def in_taxonomy_scope(organization, location = nil) end describe 'show' do - it 'does not allow user without permissions to see task details' do + it 'does not allow user without permissions to see task details page' 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 + + it 'serves react shell when user may view the task' do + task = FactoryBot.create(:some_task) + get :show, params: { id: task.id }, session: set_session_user + + assert_response :success + assert_includes @response.body, '/webpack/' + end end describe 'index' do diff --git a/webpack/ForemanTasks/Components/TaskDetails/Components/Errors.js b/webpack/ForemanTasks/Components/TaskDetails/Components/Errors.js index 7cd5ac2ef..7469e44f2 100644 --- a/webpack/ForemanTasks/Components/TaskDetails/Components/Errors.js +++ b/webpack/ForemanTasks/Components/TaskDetails/Components/Errors.js @@ -1,69 +1,212 @@ -import React from 'react'; +import React, { useState, useEffect } from 'react'; import PropTypes from 'prop-types'; -import { Alert } from '@patternfly/react-core'; -import { translate as __ } from 'foremanReact/common/I18n'; +import { + Alert, + AlertVariant, + CodeBlock, + CodeBlockCode, + EmptyState, + EmptyStateBody, + EmptyStateHeader, + Icon, + EmptyStateVariant, + Flex, + FlexItem, + Grid, + GridItem, + Split, + SplitItem, + Stack, + StackItem, +} from '@patternfly/react-core'; +import { CheckCircleIcon } from '@patternfly/react-icons'; +import { translate as __, sprintf } from 'foremanReact/common/I18n'; -const Errors = ({ ...props }) => { - const { failedSteps, executionPlan } = props; - if (!executionPlan) +const TRANSPARENT_CODE_BLOCK_STYLE = { + '--pf-v5-c-code-block--BackgroundColor': 'transparent', + backgroundColor: 'transparent', +}; + +const ErrorDetailSection = ({ label, children }) => ( + + + + {label} + + + + {children} + + + + +); + +ErrorDetailSection.propTypes = { + label: PropTypes.node.isRequired, + children: PropTypes.node.isRequired, +}; + +const ErrorDetailsPane = ({ step }) => { + if (!step) { + return null; + } + + return ( + + {step.input} + + {step.output} + + {step.error && ( + <> + + {step.error.exception_class}: {step.error.message} + + + {(step.error.backtrace || []).join('\n')} + + + )} + + ); +}; + +ErrorDetailsPane.propTypes = { + step: PropTypes.shape({ + input: PropTypes.node, + output: PropTypes.node, + error: PropTypes.shape({ + exception_class: PropTypes.string, + message: PropTypes.string, + backtrace: PropTypes.array, + }), + }), +}; + +ErrorDetailsPane.defaultProps = { + step: null, +}; + +const Errors = ({ executionPlan, failedSteps }) => { + const [selectedIndex, setSelectedIndex] = useState(0); + + useEffect(() => { + setSelectedIndex(idx => { + if (idx >= failedSteps.length) { + return Math.max(0, failedSteps.length - 1); + } + + return idx; + }); + }, [failedSteps.length]); + + if (!executionPlan) { return ( - + {__('Execution plan data not available ')} ); - if (!failedSteps.length) + } + + if (!failedSteps.length) { return ( - + + + + + + + + + } + /> + + {__('The task finished with no errors or warnings.')} + + + + + + ); + } + + const selectedStep = failedSteps[selectedIndex]; + return ( -
- {failedSteps.map((step, i) => ( - + + - {__('Action')}: - - 
{step.action_class}
- - {__('Input')}: - - 
{step.input}
- - {__('Output')}: - - 
{step.output}
- - {step.error && ( - - {__('Exception')}: - - 
-                  {step.error.exception_class}: {step.error.message}
-
- - {__('Backtrace')}: - - 
{(step.error.backtrace || []).join('\n')}
- - - )} - - ))} -
+ + {failedSteps.map((step, i) => { + const summary = + step.error?.message || step.action_class || __('Unknown error'); + const isStoppedStep = ['skipped', 'skipping'].includes( + String(step.state ?? '') + ); + const variant = isStoppedStep + ? AlertVariant.warning + : AlertVariant.danger; + const titleKey = isStoppedStep + ? __('Stopped task: %s') + : __('Failed task: %s'); + const selected = i === selectedIndex; + + return ( + + setSelectedIndex(i)} + onKeyDown={event => { + if (event.key === 'Enter' || event.key === ' ') { + event.preventDefault(); + setSelectedIndex(i); + } + }} + style={{ + cursor: 'pointer', + }} + > + + + + ); + })} + + + + + + + ); }; diff --git a/webpack/ForemanTasks/Components/TaskDetails/Components/RunningSteps.js b/webpack/ForemanTasks/Components/TaskDetails/Components/RunningSteps.js index 0db0a862f..2f68a9dc3 100644 --- a/webpack/ForemanTasks/Components/TaskDetails/Components/RunningSteps.js +++ b/webpack/ForemanTasks/Components/TaskDetails/Components/RunningSteps.js @@ -1,68 +1,174 @@ import React from 'react'; import PropTypes from 'prop-types'; -import { Alert, AlertVariant, Button } from '@patternfly/react-core'; +import { + Alert, + AlertVariant, + Button, + EmptyState, + EmptyStateBody, + EmptyStateHeader, + EmptyStateIcon, + EmptyStateVariant, + Flex, + FlexItem, + Grid, + GridItem, + Stack, + StackItem, +} from '@patternfly/react-core'; +import { HourglassStartIcon } from '@patternfly/react-icons'; import { translate as __, sprintf } from 'foremanReact/common/I18n'; +const RunningStepDetailBlock = ({ label, children }) => ( + + + + {label} + + {children} + + +); + +RunningStepDetailBlock.propTypes = { + label: PropTypes.node.isRequired, + children: PropTypes.node.isRequired, +}; + const RunningSteps = ({ + executionPlan, + result, runningSteps, id, cancelStep, taskReload, taskReloadStart, }) => { - if (!runningSteps.length) return {__('No running steps')}; - return ( -
- {runningSteps.map((step, i) => ( + const planState = executionPlan?.state; + const resultIsPending = String(result) === 'pending'; + + if (!runningSteps.length) { + if (planState === 'running' && resultIsPending) { + return ( - {step.cancellable && ( -

- -

- )} - -

- {__('Action')}: - -

- 
{step.action_class}
-

- {__('State')}: - {step.state} -

- {__('Input')}: - - 
{step.input}
- - {__('Output')}: - - 
{step.output}
- + {__('The task is still being processed. Please wait.')} + ); + } + + if (planState === 'planned' && resultIsPending) { + return ( + + + + + + } + /> + + {__('The task has not started yet.')} + + + + + + + ); + } + + return {__('No running steps')}; + } + + return ( + + {runningSteps.map((step, i) => ( + + + + {step.cancellable && ( + + + + + + + + )} + + + + {`${__('Action')}:`} + + {step.action_class} + + + + + + {`${__('State')}:`} + + {step.state} + + + + 
{step.input}
+ + + 
{step.output}
+ + + + ))} -
+ ); }; RunningSteps.propTypes = { + executionPlan: PropTypes.shape({ state: PropTypes.string }), + result: PropTypes.string, runningSteps: PropTypes.array, id: PropTypes.string.isRequired, cancelStep: PropTypes.func.isRequired, @@ -72,6 +178,8 @@ RunningSteps.propTypes = { RunningSteps.defaultProps = { runningSteps: [], + executionPlan: {}, + result: undefined, }; export default RunningSteps; diff --git a/webpack/ForemanTasks/Components/TaskDetails/Components/TaskInfo.js b/webpack/ForemanTasks/Components/TaskDetails/Components/TaskInfo.js index a206c1043..550b17af1 100644 --- a/webpack/ForemanTasks/Components/TaskDetails/Components/TaskInfo.js +++ b/webpack/ForemanTasks/Components/TaskDetails/Components/TaskInfo.js @@ -5,17 +5,12 @@ import { GridItem, Progress, ProgressVariant, - Icon, } from '@patternfly/react-core'; -import { - CheckCircleIcon, - ExclamationCircleIcon, - ExclamationTriangleIcon, - QuestionCircleIcon, -} from '@patternfly/react-icons'; import { translate as __ } from 'foremanReact/common/I18n'; import RelativeDateTime from 'foremanReact/components/common/dates/RelativeDateTime'; +import { taskResultIconEl } from '../../common/taskResultIcon'; + const isDelayed = ({ startAt, startedAt }) => { if ( startAt == null || @@ -35,41 +30,6 @@ const isDelayed = ({ startAt, startedAt }) => { return a.getTime() !== b.getTime(); }; -const resultIconEl = (state, result) => { - if (state !== 'stopped') - return ( - - - - ); - switch (result) { - case 'success': - return ( - - - - ); - case 'error': - return ( - - - - ); - case 'warning': - return ( - - - - ); - default: - return ( - - - - ); - } -}; - const progressVariantForResult = result => { switch (result) { case 'error': @@ -117,7 +77,7 @@ const TaskInfo = props => { title: 'Result', value: ( - {resultIconEl(state, result)} {result} + {taskResultIconEl(state, result)} {result} ), }, @@ -213,12 +173,6 @@ const TaskInfo = props => { 
{output}
)} - {errors && errors.length > 0 && ( - - {__('Errors:')} - 
{errors}
- - )} ); }; diff --git a/webpack/ForemanTasks/Components/TaskDetails/Components/__tests__/Errors.test.js b/webpack/ForemanTasks/Components/TaskDetails/Components/__tests__/Errors.test.js index b760f8ae0..9c41ce5e3 100644 --- a/webpack/ForemanTasks/Components/TaskDetails/Components/__tests__/Errors.test.js +++ b/webpack/ForemanTasks/Components/TaskDetails/Components/__tests__/Errors.test.js @@ -1,5 +1,5 @@ import React from 'react'; -import { render, screen } from '@testing-library/react'; +import { render, screen, fireEvent } from '@testing-library/react'; import '@testing-library/jest-dom'; import Errors from '../Errors'; @@ -20,6 +20,8 @@ const failedStepFixture = { output: '{}\n', }; +const executionPlan = { state: 'paused', cancellable: false }; + describe('Errors', () => { it('renders warning when execution plan is missing', () => { render(); @@ -30,14 +32,18 @@ describe('Errors', () => { it('renders success state when there are no failed steps', () => { render(); - const noErrors = screen.getAllByText(/^no errors$/i); - expect(noErrors.length).toBeGreaterThanOrEqual(1); + expect( + screen.getByRole('heading', { level: 2, name: /no errors found/i }) + ).toBeInTheDocument(); + expect( + screen.getByText(/the task finished with no errors or warnings/i) + ).toBeInTheDocument(); }); it('renders failed step details when failedSteps is non-empty', () => { const { container } = render( ); @@ -47,13 +53,199 @@ describe('Errors', () => { expect(stepAlert).toBeInTheDocument(); expect(stepAlert).toHaveClass('pf-m-inline'); expect( - screen.getByText('Actions::Katello::EventQueue::Monitor') + screen.getByRole('heading', { + level: 4, + name: /failed task: action actions::katello::eventqueue::monitor is already active/i, + }) + ).toBeInTheDocument(); + expect( + screen.getByRole('listbox', { name: /failed task errors/i }) ).toBeInTheDocument(); + expect(screen.getByText('Input')).toBeInTheDocument(); + expect(screen.getByText('Output')).toBeInTheDocument(); + expect(screen.getByText('Exception:')).toBeInTheDocument(); + expect(screen.getByText('Backtrace')).toBeInTheDocument(); expect(screen.getByText(/runtimeerror/i)).toBeInTheDocument(); + expect(screen.getByText(/singleton_lock/i)).toBeInTheDocument(); + }); + + it('switches detail pane when a different error option is clicked', () => { + const firstStep = { + ...failedStepFixture, + action_class: 'Action::First', + input: 'INPUT_FROM_FIRST_STEP', + output: '{}', + }; + const secondStep = { + ...failedStepFixture, + action_class: 'Action::Second', + error: { + exception_class: 'StandardError', + message: 'second step failure', + backtrace: [], + }, + input: 'INPUT_FROM_SECOND_STEP', + output: 'OUTPUT_SECOND', + state: 'error', + }; + + render( + + ); + + expect(screen.getByText('INPUT_FROM_FIRST_STEP')).toBeInTheDocument(); + expect(screen.queryByText('INPUT_FROM_SECOND_STEP')).not.toBeInTheDocument(); + + const options = screen.getAllByRole('option'); + expect(options[0]).toHaveAttribute('aria-selected', 'true'); + expect(options[1]).toHaveAttribute('aria-selected', 'false'); + + fireEvent.click(options[1]); + + expect(screen.getByText('INPUT_FROM_SECOND_STEP')).toBeInTheDocument(); + expect(screen.queryByText('INPUT_FROM_FIRST_STEP')).not.toBeInTheDocument(); + expect(options[0]).toHaveAttribute('aria-selected', 'false'); + expect(options[1]).toHaveAttribute('aria-selected', 'true'); + expect(screen.getByText('OUTPUT_SECOND')).toBeInTheDocument(); + }); + + it('selects an error option with Enter', () => { + const firstStep = { + ...failedStepFixture, + action_class: 'Action::First', + input: 'ONLY_FIRST', + output: '{}', + }; + const secondStep = { + ...failedStepFixture, + action_class: 'Action::Second', + error: { + ...failedStepFixture.error, + message: 'other', + }, + input: 'ONLY_SECOND', + output: '{}', + state: 'error', + }; + + render( + + ); + + const options = screen.getAllByRole('option'); + fireEvent.keyDown(options[1], { key: 'Enter', preventDefault: jest.fn() }); + + expect(screen.getByText('ONLY_SECOND')).toBeInTheDocument(); + expect(screen.queryByText('ONLY_FIRST')).not.toBeInTheDocument(); + }); + + it('selects an error option with Space', () => { + const firstStep = { + ...failedStepFixture, + action_class: 'Action::A', + input: 'INPUT_A_UNIQUE', + output: '{}', + }; + const secondStep = { + ...failedStepFixture, + action_class: 'Action::B', + input: 'INPUT_B_UNIQUE', + output: '{}', + state: 'error', + }; + + render( + + ); + + fireEvent.keyDown(screen.getAllByRole('option')[1], { + key: ' ', + preventDefault: jest.fn(), + }); + + expect(screen.getByText('INPUT_B_UNIQUE')).toBeInTheDocument(); + }); + + it('clamps selection when failedSteps shrinks', () => { + const firstStep = { + ...failedStepFixture, + action_class: 'Action::First', + input: 'AFTER_CLAMP', + output: '{}', + }; + const secondStep = { + ...failedStepFixture, + action_class: 'Action::Second', + input: 'REMOVED', + output: '{}', + state: 'error', + }; + + const { rerender } = render( + + ); + + fireEvent.click(screen.getAllByRole('option')[1]); + expect(screen.getByText('REMOVED')).toBeInTheDocument(); + + rerender( + + ); + + expect(screen.getAllByRole('option')).toHaveLength(1); + expect(screen.getByText('AFTER_CLAMP')).toBeInTheDocument(); + }); + + it('uses stopped task title and warning for skipped steps', () => { + const skippedStep = { + action_class: 'Actions::Example', + state: 'skipped', + input: '{}', + output: '{}', + }; + + const { container } = render( + + ); + expect( - screen.getByText( - /action actions::katello::eventqueue::monitor is already active/i - ) + screen.getByRole('heading', { + level: 4, + name: /stopped task: actions::example/i, + }) ).toBeInTheDocument(); + + const alert = container.querySelector('[data-ouia-component-id="task-error-0"]'); + expect(alert).toHaveClass('pf-m-warning'); + }); + + it('omits exception and backtrace when step has no error object', () => { + const stepWithoutError = { + action_class: 'Actions::NoError', + state: 'error', + input: 'plain-input', + output: 'plain-output', + }; + + render( + + ); + + expect(screen.getByText('plain-input')).toBeInTheDocument(); + expect(screen.getByText('plain-output')).toBeInTheDocument(); + expect(screen.queryByText('Exception:')).not.toBeInTheDocument(); + expect(screen.queryByText('Backtrace')).not.toBeInTheDocument(); }); }); diff --git a/webpack/ForemanTasks/Components/TaskDetails/Components/__tests__/RunningSteps.test.js b/webpack/ForemanTasks/Components/TaskDetails/Components/__tests__/RunningSteps.test.js index 30e2ee97d..ff4b40747 100644 --- a/webpack/ForemanTasks/Components/TaskDetails/Components/__tests__/RunningSteps.test.js +++ b/webpack/ForemanTasks/Components/TaskDetails/Components/__tests__/RunningSteps.test.js @@ -27,6 +27,45 @@ describe('RunningSteps', () => { expect(screen.getByText(/no running steps/i)).toBeInTheDocument(); }); + it('shows suspended warning when plan is running, result pending, no steps', () => { + render( + + ); + + expect( + screen.getByRole('heading', { + level: 4, + name: /temporarily suspended step/i, + }) + ).toBeInTheDocument(); + expect( + screen.getByText(/the task is still being processed/i) + ).toBeInTheDocument(); + }); + + it('shows planned empty state when plan is planned, result pending, no steps', () => { + render( + + ); + + expect( + screen.getByRole('heading', { level: 2, name: /planned task/i }) + ).toBeInTheDocument(); + expect( + screen.getByText(/the task has not started yet/i) + ).toBeInTheDocument(); + }); + it('renders running step fields and Cancel when step is cancellable', () => { const cancelStep = jest.fn(); render( diff --git a/webpack/ForemanTasks/Components/TaskDetails/ExecutionDetails.js b/webpack/ForemanTasks/Components/TaskDetails/ExecutionDetails.js new file mode 100644 index 000000000..ca18f3ff8 --- /dev/null +++ b/webpack/ForemanTasks/Components/TaskDetails/ExecutionDetails.js @@ -0,0 +1,62 @@ +import React from 'react'; +import PropTypes from 'prop-types'; +import RunningSteps from './Components/RunningSteps'; +import Errors from './Components/Errors'; + +const ExecutionDetails = ({ + state, + runningSteps, + cancelStep, + id, + taskReload, + taskReloadStart, + executionPlan, + failedSteps, + result, +}) => { + const showingRunningSteps = + state === 'running' || state === 'pending' || runningSteps.length > 0; + + return ( +
+ {showingRunningSteps ? ( + + ) : ( + + )} +
+ ); +}; + +ExecutionDetails.propTypes = { + state: PropTypes.string, + result: PropTypes.string, + runningSteps: PropTypes.array, + cancelStep: PropTypes.func.isRequired, + id: PropTypes.string.isRequired, + taskReload: PropTypes.bool.isRequired, + taskReloadStart: PropTypes.func.isRequired, + executionPlan: PropTypes.shape({}), + failedSteps: PropTypes.array, +}; + +ExecutionDetails.defaultProps = { + state: '', + result: undefined, + runningSteps: [], + executionPlan: {}, + failedSteps: [], +}; + +export default ExecutionDetails; diff --git a/webpack/ForemanTasks/Components/TaskDetails/TaskDetails.js b/webpack/ForemanTasks/Components/TaskDetails/TaskDetails.js index 3d0ef51ed..8f73c45aa 100644 --- a/webpack/ForemanTasks/Components/TaskDetails/TaskDetails.js +++ b/webpack/ForemanTasks/Components/TaskDetails/TaskDetails.js @@ -1,20 +1,29 @@ import React, { useEffect, useState } from 'react'; import PropTypes from 'prop-types'; -import { Tabs, Tab, TabTitleText } from '@patternfly/react-core'; +import { + Tabs, + Tab, + TabTitleText, +} from '@patternfly/react-core'; import { translate as __, sprintf } from 'foremanReact/common/I18n'; import { STATUS } from 'foremanReact/constants'; import MessageBox from 'foremanReact/components/common/MessageBox'; import Task from './Components/Task'; -import RunningSteps from './Components/RunningSteps'; -import Errors from './Components/Errors'; import Locks from './Components/Locks'; import Raw from './Components/Raw'; +import ExecutionDetails from './ExecutionDetails'; import Dependencies from './Components/Dependencies'; import { getTaskID } from './TasksDetailsHelper'; import { TaskSkeleton } from './Components/TaskSkeleton'; import './TaskDetails.scss'; +export const TASK_DETAILS_TAB_KEYS = Object.freeze({ + EXECUTION: 'execution', + LOCKS: 'locks', + RAW: 'raw', +}); + const TaskDetails = ({ executionPlan, failedSteps, @@ -31,7 +40,7 @@ const TaskDetails = ({ }) => { const id = getTaskID(); const { taskReload, status, isLoading } = props; - const [activeTabKey, setActiveTabKey] = useState(1); + const [activeTab, setActiveTab] = useState(TASK_DETAILS_TAB_KEYS.EXECUTION); useEffect(() => { taskReloadStart(id); @@ -61,7 +70,7 @@ const TaskDetails = ({ const cancellable = executionPlan ? executionPlan.cancellable : false; const lockRecords = locks.concat(links); - const taskComponentProps = { + const taskProps = { ...props, cancellable, resumable, @@ -72,70 +81,61 @@ const TaskDetails = ({ }; return ( -
+
+
+ {isLoading ? ( + + ) : ( + + )} +
setActiveTabKey(tabKey)} + activeKey={activeTab} mountOnEnter + onSelect={(_e, tabKey) => setActiveTab(tabKey)} > {__('Task')}} - aria-label={__('Task')} - ouiaId="task-details-tab-task" - > - {isLoading ? : } - - {__('Running Steps')}} - isDisabled={isLoading} - aria-label={__('Running Steps')} - ouiaId="task-details-tab-running-steps" + eventKey={TASK_DETAILS_TAB_KEYS.EXECUTION} + title={{__('Execution details')}} + aria-label={__('Execution details')} > - + {!isLoading && ( + + )} - {__('Errors')}} - isDisabled={isLoading} - aria-label={__('Errors')} - ouiaId="task-details-tab-errors" - > - + + {__('Locks')}} isDisabled={isLoading} aria-label={__('Locks')} - ouiaId="task-details-tab-locks" > {__('Dependencies')}} - isDisabled={isLoading} - aria-label={__('Dependencies')} - ouiaId="task-details-tab-dependencies" - > - - - {__('Raw')}} isDisabled={isLoading} aria-label={__('Raw')} - ouiaId="task-details-tab-raw" > { + it('renders execution details panel with OUIA id', () => { + render( + + ); + + expect( + document.querySelector('[data-ouia-component-id="execution-details-panel"]') + ).toBeInTheDocument(); + expect(document.getElementById('execution-details-panel')).toBeInTheDocument(); + }); + + it('shows Errors pane when stopped with no running steps', () => { + render( + + ); + + expect(screen.getByRole('heading', { name: /^no errors found$/i })).toBeInTheDocument(); + expect( + screen.getByText(/the task finished with no errors or warnings/i) + ).toBeInTheDocument(); + }); + + it('shows RunningSteps when stopped but runningSteps list is non-empty', () => { + render( + + ); + + expect( + screen.getByRole('heading', { name: 'Warning alert: Running step 1' }) + ).toBeInTheDocument(); + }); + + it('forwards executionPlan and result to RunningSteps when state is pending without steps', () => { + render( + + ); + + expect( + screen.getByRole('heading', { level: 2, name: /planned task/i }) + ).toBeInTheDocument(); + }); + + it('shows temporarily suspended messaging when pending, plan running, result pending', () => { + render( + + ); + + expect( + screen.getByRole('heading', { + level: 4, + name: /temporarily suspended step/i, + }) + ).toBeInTheDocument(); + }); + + it('routes failed steps through Errors pane when stopped', () => { + render( + + ); + + expect( + screen.getByRole('heading', { + level: 4, + name: /failed task/i, + }) + ).toBeInTheDocument(); + }); + + it('renders RunningSteps with cancel when task is running', () => { + const cancelStep = jest.fn(); + + render( + + ); + + expect(screen.getByRole('button', { name: /cancel/i })).toBeInTheDocument(); + }); +}); diff --git a/webpack/ForemanTasks/Components/TaskDetails/__tests__/TaskDetails.fixtures.js b/webpack/ForemanTasks/Components/TaskDetails/__tests__/TaskDetails.fixtures.js index 84bb4c07b..2d549b92b 100644 --- a/webpack/ForemanTasks/Components/TaskDetails/__tests__/TaskDetails.fixtures.js +++ b/webpack/ForemanTasks/Components/TaskDetails/__tests__/TaskDetails.fixtures.js @@ -6,3 +6,103 @@ export const minProps = { taskProgressToggle: jest.fn(), status: 'RESOLVED', }; + +/** Props for snapshots that exercise the Execution details tab alongside the overview. */ +export const taskDetailsWithExecutionTabDefaults = { + ...minProps, + locks: [ + { + exclusive: false, + resource_type: 'User', + resource_id: 4, + link: null, + }, + ], + links: [], + executionPlan: { state: 'stopped', cancellable: false }, + failedSteps: [], + runningSteps: [], + dependsOn: [], + blocks: [], + action: 'Refresh foo', + state: 'stopped', + result: 'success', + progress: 100, + startAt: '', + startedAt: '', + endedAt: '', + startBefore: '', +}; + +const SAMPLE_FAILED_STEP = { + error: { + exception_class: 'RuntimeError', + message: + 'Action Actions::Katello::EventQueue::Monitor is already active', + backtrace: [ + "/home/example/gems/dynflow-1.2.3/lib/dynflow/action/singleton.rb:15:in `rescue in singleton_lock!'", + ], + }, + action_class: 'Actions::Katello::EventQueue::Monitor', + state: 'error', + input: + '{"locale"=>"en",\n "current_request_id"=>nil,\n "current_user_id"=>4}\n', + output: '{}\n', +}; + +const SAMPLE_RUNNING_STEP = { + cancellable: false, + id: 1, + action_class: 'Actions::DynflowExample', + state: 'running', + input: '{}', + output: '{}', +}; + +const SAMPLE_DEPENDS_ON = [ + { + id: '123', + action: 'Actions::FooBar', + humanized: 'Foo Bar Action', + state: 'stopped', + result: 'success', + }, +]; + +export const fixtureFailedExecutionDetail = { + ...taskDetailsWithExecutionTabDefaults, + result: 'error', + state: 'stopped', + failedSteps: [SAMPLE_FAILED_STEP], +}; + +export const fixtureRunningExecutionDetail = { + ...taskDetailsWithExecutionTabDefaults, + state: 'running', + runningSteps: [SAMPLE_RUNNING_STEP], +}; + +export const fixtureStoppedWithTaskMessages = { + ...taskDetailsWithExecutionTabDefaults, + help: 'See logs for more.', + output: { + messages: ['partial output'], + result: 'error', + failedModules: {}, + }, + errors: ['Validation failed'], +}; + +export const fixtureWithDependenciesTables = { + ...taskDetailsWithExecutionTabDefaults, + dependsOn: SAMPLE_DEPENDS_ON, + blocks: [ + { + id: '789', + action: 'Actions::Test', + humanized: 'Test Action', + state: 'paused', + result: 'warning', + }, + ], +}; diff --git a/webpack/ForemanTasks/Components/TaskDetails/__tests__/TaskDetails.test.js b/webpack/ForemanTasks/Components/TaskDetails/__tests__/TaskDetails.test.js index 8e8cad961..07e9d43bc 100644 --- a/webpack/ForemanTasks/Components/TaskDetails/__tests__/TaskDetails.test.js +++ b/webpack/ForemanTasks/Components/TaskDetails/__tests__/TaskDetails.test.js @@ -24,25 +24,23 @@ describe('TaskDetails', () => { ).toBeInTheDocument(); }); - it('shows skeleton while loading on the Task tab', () => { + it('shows skeleton in the overview while loading', () => { const { container } = render(); expect( container.querySelector('.react-loading-skeleton') ).toBeInTheDocument(); }); - it('renders six tabs with expected labels', () => { + it('renders four tabs with expected labels', () => { render(); expect(document.getElementById('task-details-tabs')).toBeInTheDocument(); - expect(screen.getByRole('tab', { name: /^task$/i })).toBeInTheDocument(); expect( - screen.getByRole('tab', { name: /running steps/i }) + screen.getByRole('tab', { name: /execution details/i }) ).toBeInTheDocument(); - expect(screen.getByRole('tab', { name: /errors/i })).toBeInTheDocument(); - expect(screen.getByRole('tab', { name: /locks/i })).toBeInTheDocument(); expect( screen.getByRole('tab', { name: /dependencies/i }) ).toBeInTheDocument(); + expect(screen.getByRole('tab', { name: /locks/i })).toBeInTheDocument(); expect(screen.getByRole('tab', { name: /raw/i })).toBeInTheDocument(); }); }); diff --git a/webpack/ForemanTasks/Components/common/taskResultIcon.js b/webpack/ForemanTasks/Components/common/taskResultIcon.js new file mode 100644 index 000000000..6698160cc --- /dev/null +++ b/webpack/ForemanTasks/Components/common/taskResultIcon.js @@ -0,0 +1,52 @@ +import React from 'react'; +import { Icon } from '@patternfly/react-core'; +import { + CheckCircleIcon, + ExclamationCircleIcon, + ExclamationTriangleIcon, + QuestionCircleIcon, +} from '@patternfly/react-icons'; + +/** + * Icon reflecting task state/result (aligned with TaskInfo / tasks table). + * + * @param {string} state Dynflow task state (e.g. stopped, running). + * @param {string} [result] Result when stopped (success, error, warning, …). + * @returns {React.ReactElement} + */ +export const taskResultIconEl = (state, result) => { + if (state !== 'stopped') { + return ( + + + + ); + } + + switch (result) { + case 'success': + return ( + + + + ); + case 'error': + return ( + + + + ); + case 'warning': + return ( + + + + ); + default: + return ( + + + + ); + } +}; diff --git a/webpack/ForemanTasks/Routes/ShowTaskDetails/TaskDetailsPage.js b/webpack/ForemanTasks/Routes/ShowTaskDetails/TaskDetailsPage.js new file mode 100644 index 000000000..2317b90b5 --- /dev/null +++ b/webpack/ForemanTasks/Routes/ShowTaskDetails/TaskDetailsPage.js @@ -0,0 +1,68 @@ +import React from 'react'; +import PropTypes from 'prop-types'; +import { useSelector } from 'react-redux'; +import { Flex, FlexItem, TextContent, Text } from '@patternfly/react-core'; +import PageLayout from 'foremanReact/routes/common/PageLayout/PageLayout'; +import { translate as __, sprintf } from 'foremanReact/common/I18n'; +import TaskDetails from '../../Components/TaskDetails'; +import { + selectAction, + selectResult, + selectState, +} from '../../Components/TaskDetails/TaskDetailsSelectors'; +import { taskResultIconEl } from '../../Components/common/taskResultIcon'; + +const TaskDetailsPage = props => { + const { id } = props.match.params; + const action = useSelector(selectAction); + const taskState = useSelector(selectState); + const taskResult = useSelector(selectResult); + const headerText = action + ? sprintf(__('Details of %s task'), action) + : __('Task details'); + + const header = ( + + + + {headerText} + + + + {taskResultIconEl(taskState, taskResult)} + + + ); + + return ( + + + + ); +}; + +TaskDetailsPage.propTypes = { + match: PropTypes.shape({ + params: PropTypes.shape({ + id: PropTypes.string.isRequired, + }).isRequired, + }).isRequired, +}; + +export default TaskDetailsPage; diff --git a/webpack/ForemanTasks/Routes/ShowTaskDetails/__tests__/TaskDetailsPage.test.js b/webpack/ForemanTasks/Routes/ShowTaskDetails/__tests__/TaskDetailsPage.test.js new file mode 100644 index 000000000..5015c257b --- /dev/null +++ b/webpack/ForemanTasks/Routes/ShowTaskDetails/__tests__/TaskDetailsPage.test.js @@ -0,0 +1,186 @@ +import React from 'react'; +import { render, screen, within } from '@testing-library/react'; +import '@testing-library/jest-dom'; +import { combineReducers, configureStore } from '@reduxjs/toolkit'; +import { IntlProvider } from 'react-intl'; +import { Provider } from 'react-redux'; + +import breadcrumbBarReducer from 'foremanReact/components/BreadcrumbBar/BreadcrumbBarReducer'; +import { STATUS } from 'foremanReact/constants'; +import intervalsReducer from 'foremanReact/redux/middlewares/IntervalMiddleware/IntervalReducer'; + +import { FOREMAN_TASK_DETAILS } from '../../../Components/TaskDetails/TaskDetailsConstants'; +import TaskDetailsPage from '../TaskDetailsPage'; + +const TASK_DETAILS_TITLE_ROW_OUIA_ID = 'foreman-tasks-task-details-title-row'; + +const routerPropsBase = { + history: { push: jest.fn(), replace: jest.fn(), go: jest.fn() }, + location: { + pathname: '/foreman_tasks/tasks/task-route-id', + search: '', + hash: '', + state: undefined, + }, +}; + +const matchDefault = { + params: { id: 'task-route-id' }, + path: '/foreman_tasks/tasks/:id', + url: '/foreman_tasks/tasks/task-route-id', + isExact: true, +}; + +const baseTaskPayload = { + action: '', + input: [], + output: {}, + locks: [], + links: [], + depends_on: [], + blocks: [], + failed_steps: [], + running_steps: [], + execution_plan: {}, + state: 'running', + result: '', +}; + +const createStoreForTaskPayload = overrides => ({ + API: { + [FOREMAN_TASK_DETAILS]: { + response: { ...baseTaskPayload, ...overrides }, + status: STATUS.RESOLVED, + payload: {}, + }, + }, +}); + +const rootReducer = combineReducers({ + API: (state = {}, action) => state, + intervals: intervalsReducer, + breadcrumbBar: breadcrumbBarReducer, + foremanTasks: (state = {}, action) => state, +}); + +function renderPage(apiPayloadOverrides = {}, propsOverrides = {}) { + const store = configureStore({ + reducer: rootReducer, + preloadedState: createStoreForTaskPayload(apiPayloadOverrides), + middleware: getDefaultMiddleware => + getDefaultMiddleware({ + immutableCheck: false, + serializableCheck: false, + }), + }); + + window.history.pushState( + {}, + '', + `/foreman_tasks/tasks/${matchDefault.params.id}` + ); + + return render( + + + + + + ); +} + +function breadcrumbTitleHeadings() { + return screen.getAllByRole('heading', { level: 1 }).filter( + heading => heading.getAttribute('data-ouia-component-id') === 'breadcrumb_title' + ); +} + +/** + * Title row (`customHeader` root `Flex`): same OUIA pattern as `Locks.test.js`. + */ +function taskDetailsTitleRegion(container) { + const el = container.querySelector( + `[data-ouia-component-id="${TASK_DETAILS_TITLE_ROW_OUIA_ID}"]` + ); + + expect(el).toBeTruthy(); + + return el; +} + +describe('TaskDetailsPage', () => { + afterEach(() => { + window.history.pushState({}, '', '/'); + }); + + const expectToolbarHeadingText = substring => { + const headings = breadcrumbTitleHeadings(); + + expect(headings.length).toBeGreaterThan(0); + + headings.forEach(heading => { + expect(heading).toHaveTextContent(substring); + }); + }; + + it('shows generic title and breadcrumb from route id when action is unset', () => { + const page = renderPage({}); + expectToolbarHeadingText('Task details'); + + expect(screen.getByRole('navigation', { name: 'Breadcrumb' })).toHaveTextContent( + 'Tasks' + ); + expect( + within(screen.getByRole('navigation', { name: 'Breadcrumb' })).getByText( + /task-route-id/ + ) + ).toBeInTheDocument(); + + const titleRegion = taskDetailsTitleRegion(page.container); + + expect( + within(titleRegion).getAllByRole('img', { hidden: true }).length + ).toBeGreaterThan(0); + expect(titleRegion.querySelector('[class*="danger"]')).toBeNull(); + }); + + it('uses task action for title and breadcrumb when loaded', () => { + renderPage({ action: 'Refresh hosts' }); + + expectToolbarHeadingText('Details of Refresh hosts task'); + + expect(screen.getByRole('link', { name: /^Tasks$/ })).toHaveAttribute( + 'href', + '/foreman_tasks/tasks' + ); + expect( + within(screen.getByRole('navigation', { name: 'Breadcrumb' })).getByText( + 'Refresh hosts' + ) + ).toBeInTheDocument(); + }); + + it('shows error status styling in the heading when task is stopped with error result', () => { + const page = renderPage({ + action: 'Some action', + state: 'stopped', + result: 'error', + }); + + expectToolbarHeadingText('Details of Some action task'); + + expect( + taskDetailsTitleRegion(page.container).querySelector('[class*="danger"]') + ).toBeTruthy(); + + expect( + within(screen.getByRole('navigation', { name: 'Breadcrumb' })).getByText( + 'Some action' + ) + ).toBeInTheDocument(); + }); +}); diff --git a/webpack/Routes/routes.js b/webpack/Routes/routes.js index 4fe83f36b..dc99e67cc 100644 --- a/webpack/Routes/routes.js +++ b/webpack/Routes/routes.js @@ -1,6 +1,7 @@ import React from 'react'; import TasksTableIndexPage from '../ForemanTasks/Components/TasksTable/TasksIndexPage'; import ShowTask from '../ForemanTasks/Routes/ShowTask/ShowTask'; +import TaskDetailsPage from '../ForemanTasks/Routes/ShowTaskDetails/TaskDetailsPage'; const ForemanTasksRoutes = [ { @@ -8,6 +9,11 @@ const ForemanTasksRoutes = [ exact: true, render: props => , }, + { + path: '/foreman_tasks/tasks/:id', + exact: true, + render: props => , + }, { path: '/foreman_tasks/tasks/:id/sub_tasks', exact: true, diff --git a/webpack/Routes/routes.test.js b/webpack/Routes/routes.test.js index a21aebef7..dbadc7cd4 100644 --- a/webpack/Routes/routes.test.js +++ b/webpack/Routes/routes.test.js @@ -20,6 +20,14 @@ jest.mock( } ); +jest.mock( + '../ForemanTasks/Routes/ShowTaskDetails/TaskDetailsPage', + () => + function TaskDetailsPageStub() { + return
; + } +); + const routerProps = { history: { push: jest.fn(), replace: jest.fn(), go: jest.fn() }, location: { @@ -42,6 +50,7 @@ describe('ForemanTasks routes', () => { ForemanTasksRoutes.map(({ path, exact }) => ({ path, exact })) ).toEqual([ { path: '/foreman_tasks/tasks', exact: true }, + { path: '/foreman_tasks/tasks/:id', exact: true }, { path: '/foreman_tasks/tasks/:id/sub_tasks', exact: true }, { path: '/foreman_tasks/ex_tasks/:id', exact: undefined }, ]); @@ -58,6 +67,15 @@ describe('ForemanTasks routes', () => { url: '/foreman_tasks/tasks', }, }, + { + ...routerProps, + match: { + ...routerProps.match, + params: { id: '99' }, + path: '/foreman_tasks/tasks/:id', + url: '/foreman_tasks/tasks/99', + }, + }, { ...routerProps, match: { @@ -81,7 +99,11 @@ describe('ForemanTasks routes', () => { ForemanTasksRoutes.forEach((route, index) => { const { unmount } = render(route.render(propsByIndex[index])); - if (index === 2) { + if (index === 1) { + expect( + screen.getByTestId('task-details-page-stub') + ).toBeInTheDocument(); + } else if (index === 3) { expect(screen.getByTestId('show-task-stub')).toBeInTheDocument(); } else { expect(