foreman-tasks 12.1.1 → 12.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51404155da98c410758c31a9dcb5648d4fc6144823baf0f1e9917df7ecf72777
-  data.tar.gz: 37a731595c5e39dd3492fc51f8405bf96806f127f8c7606efe6c327c9e7a0321
+  metadata.gz: 79e3003ee203359edba19b75adac7c38435b94081969faba3ad211601c559345
+  data.tar.gz: b3da633082735d6adf5a5d569744d3d5a6fa1d18d05568e7bc048b922205c674
 SHA512:
-  metadata.gz: 2b5563312efffad6871f30a4adb94c5579d5208205e6733ed35fe52b409e1fdcb0b8d1526a71ffe3ac57d852742eabe015a21e5d4a5b1fe2f359b3f5a3915950
-  data.tar.gz: 60e82330e3f9eedac8729b2c5060c1597d142081287616f4ff3d284c71b5d5d39644de6072f2c825069b9d6d972d564723700dce10baa43cdaf20504208c3910
+  metadata.gz: 6614edd5d7578167024f5df26bc5f950862dd9a2411a75cfd3f591b19755acbc40a1ca4321eff752800023923bb574d0095aa8c81ab4fa953e030999cf3d4547
+  data.tar.gz: fcdd9f699f2a55d3e27bf014f8dbee0dd0e92e3d4f6b6b6921f0a4ba9841cf2cd8aa2392d0376667fa34a85ec41b53ad6e6ff25dae9443fcee9bd625350e82f2

data/Gemfile

@@ -1,3 +1,5 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem 'theforeman-rubocop', '~> 0.1.2', require: false, groups: %i[development rubocop]

data/app/views/foreman_tasks/api/tasks/show.json.rabl

@@ -6,6 +6,6 @@ attributes :id, :label, :pending, :action
 attributes :username, :started_at, :ended_at, :state, :result, :progress
 
 # A workaround for https://github.com/ruby/json/issues/957
-node(:duration) { |t| t.duration&.in_seconds&.to_s if t.respond_to?(:duration) }
+node(:duration) { |t| t.duration&.to_f&.to_s if t.respond_to?(:duration) }
 attributes :input, :output, :humanized, :cli_example, :start_at
 node(:available_actions) { |t| { cancellable: t.execution_plan&.cancellable?, resumable: t.resumable? } }

data/foreman-tasks.gemspec

@@ -33,7 +33,5 @@ same resource. It also optionally provides Dynflow infrastructure for using it f
   s.add_dependency "get_process_mem" # for memory polling
   s.add_dependency "sinatra" # for Dynflow web console
 
-  s.add_development_dependency 'factory_bot_rails', '~> 4.8.0'
-  s.add_development_dependency 'sqlite3'
-  s.add_development_dependency 'theforeman-rubocop', '~> 0.1.0'
+  s.add_development_dependency "sqlite3"
 end

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '12.1.1'.freeze
+  VERSION = '12.2.2'.freeze
 end

data/test/controllers/api/tasks_controller_test.rb

@@ -108,7 +108,7 @@ module ForemanTasks
           get :show, params: { id: task.id }, session: set_session_user
           assert_response :success
           data = JSON.parse(response.body)
-          assert_equal task.duration.in_seconds.to_s, data['duration']
+          assert_equal task.duration.to_f.to_s, data['duration']
         end
       end
 
@@ -118,7 +118,7 @@ module ForemanTasks
           get :index, session: set_session_user
           assert_response :success
           data = JSON.parse(response.body)
-          assert_equal task.duration.in_seconds.to_s, data['results'][0]['duration']
+          assert_equal task.duration.to_f.to_s, data['results'][0]['duration']
         end
       end
 

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

@@ -1,55 +1,75 @@
 import React from 'react';
 import PropTypes from 'prop-types';
+import { capitalize } from 'lodash';
 import {
-  Alert,
-  AlertVariant,
   Grid,
   GridItem,
+  Text,
+  TextVariants,
   Title,
 } from '@patternfly/react-core';
 import { Table, Thead, Tbody, Tr, Th, Td } from '@patternfly/react-table';
 import { translate as __ } from 'foremanReact/common/I18n';
 
-const DependencyTable = ({ title, tasks }) => {
-  const tableId = title.toLowerCase().replace(/\s+/g, '-');
-  return (
-    <div>
-      <Title headingLevel="h4" size="md" ouiaId={`${tableId}-title`}>
-        {title}
-      </Title>
-      {tasks.length === 0 ? (
-        <p className="text-muted">{__('None')}</p>
-      ) : (
-        <Table aria-label={title} variant="compact" ouiaId={`${tableId}-table`}>
-          <Thead>
-            <Tr ouiaId={`${tableId}-table-header`}>
-              <Th width={50}>{__('Action')}</Th>
-              <Th width={25}>{__('State')}</Th>
-              <Th width={25}>{__('Result')}</Th>
-            </Tr>
-          </Thead>
-          <Tbody>
-            {tasks.map(task => (
-              <Tr key={task.id} ouiaId={`${tableId}-table-row-${task.id}`}>
-                <Td>
-                  <a href={`/foreman_tasks/tasks/${task.id}`}>
-                    {task.humanized || task.action}
-                  </a>
-                </Td>
-                <Td>{task.state}</Td>
-                <Td>{task.result}</Td>
+const DependencyTable = ({ title, tasks, ouiaSectionId }) => (
+  <React.Fragment>
+    <Title headingLevel="h3" size="lg" ouiaId={`${ouiaSectionId}-title`}>
+      {title}
+    </Title>
+    <Grid hasGutter>
+      <GridItem span={12} xl={8}>
+        {tasks.length === 0 ? (
+          <Text component={TextVariants.small} ouiaId={`${ouiaSectionId}-none`}>
+            {__('None')}
+          </Text>
+        ) : (
+          <Table
+            aria-label={title}
+            variant="compact"
+            ouiaId={`${ouiaSectionId}-table`}
+          >
+            <Thead>
+              <Tr ouiaId={`${ouiaSectionId}-table-header`}>
+                <Th>{__('Name')}</Th>
+                <Th>{__('State')}</Th>
+                <Th>{__('Result')}</Th>
               </Tr>
-            ))}
-          </Tbody>
-        </Table>
-      )}
-    </div>
-  );
-};
+            </Thead>
+            <Tbody>
+              {tasks.map(task => (
+                <Tr
+                  key={task.id}
+                  ouiaId={`${ouiaSectionId}-table-row-${task.id}`}
+                >
+                  <Td dataLabel={__('Name')}>
+                    <Text
+                      component={TextVariants.a}
+                      href={`/foreman_tasks/tasks/${task.id}`}
+                      ouiaId={`${ouiaSectionId}-task-link-${task.id}`}
+                    >
+                      {task.humanized || task.action}
+                    </Text>
+                  </Td>
+                  <Td dataLabel={__('State')}>
+                    {capitalize(String(task.state || ''))}
+                  </Td>
+                  <Td dataLabel={__('Result')}>
+                    {capitalize(String(task.result || ''))}
+                  </Td>
+                </Tr>
+              ))}
+            </Tbody>
+          </Table>
+        )}
+      </GridItem>
+    </Grid>
+  </React.Fragment>
+);
 
 DependencyTable.propTypes = {
   title: PropTypes.string.isRequired,
   tasks: PropTypes.array,
+  ouiaSectionId: PropTypes.string.isRequired,
 };
 
 DependencyTable.defaultProps = {
@@ -57,27 +77,18 @@ DependencyTable.defaultProps = {
 };
 
 const Dependencies = ({ dependsOn, blocks }) => (
-  <div>
-    <Alert
-      variant={AlertVariant.info}
-      isInline
-      title={__('Task dependencies')}
-      ouiaId="task-dependencies-info-alert"
-    >
-      {__(
-        'This task may have dependencies on other tasks or may be blocking other tasks from executing. Dependencies are established through task chaining relationships.'
-      )}
-    </Alert>
-    <br />
-    <Grid hasGutter>
-      <GridItem span={6}>
-        <DependencyTable title={__('Depends on')} tasks={dependsOn} />
-      </GridItem>
-      <GridItem span={6}>
-        <DependencyTable title={__('Blocks')} tasks={blocks} />
-      </GridItem>
-    </Grid>
-  </div>
+  <React.Fragment>
+    <DependencyTable
+      title={__('Task depends on')}
+      tasks={dependsOn}
+      ouiaSectionId="task-dependencies-depends-on"
+    />
+    <DependencyTable
+      title={__('Task blocks')}
+      tasks={blocks}
+      ouiaSectionId="task-dependencies-blocks"
+    />
+  </React.Fragment>
 );
 
 Dependencies.propTypes = {

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

@@ -1,20 +1,40 @@
 import React from 'react';
 import PropTypes from 'prop-types';
-import { Alert } from 'patternfly-react';
+import { Alert } from '@patternfly/react-core';
 import { translate as __ } from 'foremanReact/common/I18n';
 
 const Errors = ({ ...props }) => {
   const { failedSteps, executionPlan } = props;
   if (!executionPlan)
     return (
-      <Alert type="error">{__('Execution plan data not available ')}</Alert>
+      <Alert
+        variant="danger"
+        isInline
+        ouiaId="task-errors-plan-missing"
+        title={__('Execution plan unavailable')}
+      >
+        {__('Execution plan data not available ')}
+      </Alert>
     );
   if (!failedSteps.length)
-    return <Alert type="success">{__('No errors')}</Alert>;
+    return (
+      <Alert
+        variant="success"
+        isInline
+        ouiaId="task-errors-none"
+        title={__('No errors')}
+      />
+    );
   return (
     <div>
       {failedSteps.map((step, i) => (
-        <Alert type="error" key={i}>
+        <Alert
+          variant="danger"
+          isInline
+          key={i}
+          ouiaId={`task-error-${i}`}
+          title={__('Step error')}
+        >
           <span>{__('Action')}:</span>
           <span>
             <pre>{step.action_class}</pre>
@@ -37,7 +57,7 @@ const Errors = ({ ...props }) => {
               </span>
               <span>{__('Backtrace')}:</span>
               <span>
-                <pre>{step.error.backtrace.join('\n')}</pre>
+                <pre>{(step.error.backtrace || []).join('\n')}</pre>
               </span>
             </React.Fragment>
           )}

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

@@ -1,56 +1,183 @@
 import React from 'react';
 import PropTypes from 'prop-types';
-import { Alert, Card, Row, Col } from 'patternfly-react';
-import { translate as __ } from 'foremanReact/common/I18n';
+import {
+  EmptyState,
+  EmptyStateBody,
+  EmptyStateHeader,
+  EmptyStateIcon,
+  EmptyStateVariant,
+  Flex,
+  FlexItem,
+  Grid,
+  GridItem,
+  Icon,
+  Text,
+  TextContent,
+  TextVariants,
+  Title,
+} from '@patternfly/react-core';
+import { Table, Tbody, Tr, Td } from '@patternfly/react-table';
+import { LockIcon, LockOpenIcon } from '@patternfly/react-icons';
+import { translate as __, sprintf } from 'foremanReact/common/I18n';
 
-const ConditionalLink = ({ children, link }) =>
-  link ? <a href={link}>{children}</a> : children;
+const LocksSection = ({
+  title,
+  description,
+  items,
+  RowIcon,
+  ouiaSectionId,
+}) => (
+  <Flex direction={{ default: 'column' }}>
+    <FlexItem spacer={{ default: 'spacerSm' }}>
+      <Flex
+        alignItems={{ default: 'alignItemsCenter' }}
+        spaceItems={{ default: 'spaceItemsSm' }}
+      >
+        <FlexItem>
+          <Title
+            headingLevel="h3"
+            size="lg"
+            style={{ margin: '0' }}
+            ouiaId={`${ouiaSectionId}-title`}
+          >
+            {title}
+          </Title>
+        </FlexItem>
+        <FlexItem>
+          <RowIcon aria-hidden />
+        </FlexItem>
+      </Flex>
+    </FlexItem>
+    <FlexItem>
+      <TextContent>
+        <Text
+          component={TextVariants.p}
+          ouiaId={`${ouiaSectionId}-description`}
+        >
+          {description}
+        </Text>
+      </TextContent>
+    </FlexItem>
+    <FlexItem>
+      <Grid>
+        <GridItem span={5}>
+          <Table
+            aria-label={title}
+            variant="compact"
+            ouiaId={`${ouiaSectionId}-table`}
+          >
+            <Tbody>
+              {items.map((lock, index) => (
+                <Tr
+                  key={`${lock.resource_type}-${lock.resource_id}-${index}`}
+                  ouiaId={`${ouiaSectionId}-row-${index}`}
+                >
+                  <Td>
+                    <Flex
+                      alignItems={{ default: 'alignItemsCenter' }}
+                      spaceItems={{ default: 'spaceItemsSm' }}
+                      flexWrap={{ default: 'nowrap' }}
+                    >
+                      <FlexItem>
+                        <Icon size="sm">
+                          <RowIcon />
+                        </Icon>
+                      </FlexItem>
+                      <FlexItem>
+                        {lock.link ? (
+                          <a
+                            href={lock.link}
+                            data-ouia-component-id={`${ouiaSectionId}-resource-type-link-${index}`}
+                          >
+                            {lock.resource_type}
+                          </a>
+                        ) : (
+                          lock.resource_type
+                        )}
+                      </FlexItem>
+                    </Flex>
+                  </Td>
+                  <Td>{sprintf(__('id: %s'), String(lock.resource_id))}</Td>
+                </Tr>
+              ))}
+            </Tbody>
+          </Table>
+        </GridItem>
+      </Grid>
+    </FlexItem>
+  </Flex>
+);
 
-ConditionalLink.propTypes = {
-  children: PropTypes.node.isRequired,
-  link: PropTypes.string,
+LocksSection.propTypes = {
+  title: PropTypes.string.isRequired,
+  description: PropTypes.string.isRequired,
+  items: PropTypes.array.isRequired,
+  RowIcon: PropTypes.elementType.isRequired,
+  ouiaSectionId: PropTypes.string.isRequired,
 };
 
-ConditionalLink.defaultProps = {
-  link: null,
-};
+const Locks = ({ locks }) => {
+  const nonExclusive = locks.filter(l => !l.exclusive);
+  const exclusive = locks.filter(l => l.exclusive);
 
-const Locks = ({ locks }) => (
-  <div>
-    <Alert type="info">
-      {__(
-        'You can find resource locks on this page. Exclusive lock marked with locked icon means that no other task can use locked resource while this task is running. Non-exclusive lock marked with unlocked icon means other tasks can access the resource freely, it is only used to indicate the relation of this task with the resource'
+  if (locks.length === 0) {
+    return (
+      <EmptyState variant={EmptyStateVariant.lg}>
+        <EmptyStateHeader
+          headingLevel="h3"
+          titleText={__('No resources')}
+          icon={<EmptyStateIcon icon={LockOpenIcon} />}
+        />
+        <EmptyStateBody>
+          {__(
+            'No resources currently associated with this task. Locking resources prevents conflicting tasks from running simultaneously. Other tasks must wait until this process completes.'
+          )}
+        </EmptyStateBody>
+      </EmptyState>
+    );
+  }
+
+  return (
+    <Flex
+      direction={{ default: 'column' }}
+      gap={{ default: 'gap2xl' }}
+      data-ouia-component-id="task-locks-populated"
+    >
+      {nonExclusive.length > 0 && (
+        <LocksSection
+          title={__('Non-exclusive resources')}
+          description={__(
+            "Other tasks can access the resource simultaneously. This lock tracks the task's relationship to the resource without blocking others."
+          )}
+          items={nonExclusive}
+          RowIcon={LockOpenIcon}
+          ouiaSectionId="task-locks-non-exclusive"
+        />
       )}
-    </Alert>
-    <Card.Grid>
-      <Row>
-        {locks.map((lock, key) => (
-          <Col xs={6} sm={4} md={4} key={key}>
-            <ConditionalLink link={lock.link}>
-              <Card className="card-pf-aggregate-status" accented>
-                <Card.Title>
-                  <span
-                    className={`fa ${
-                      lock.exclusive ? 'fa-lock' : 'fa-unlock-alt'
-                    }`}
-                  />
-                  {lock.resource_type}
-                </Card.Title>
-                <Card.Body>
-                  {`id:${lock.resource_id}`}
-                  <br />
-                </Card.Body>
-              </Card>
-            </ConditionalLink>
-          </Col>
-        ))}
-      </Row>
-    </Card.Grid>
-  </div>
-);
+      {exclusive.length > 0 && (
+        <LocksSection
+          title={__('Exclusive resources')}
+          description={__(
+            'Only this task can access the resource. Other tasks must wait until this process completes.'
+          )}
+          items={exclusive}
+          RowIcon={LockIcon}
+          ouiaSectionId="task-locks-exclusive"
+        />
+      )}
+    </Flex>
+  );
+};
+
+const lockShape = PropTypes.shape({
+  exclusive: PropTypes.bool,
+  resource_type: PropTypes.string,
+  resource_id: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  link: PropTypes.string,
+});
 
 Locks.propTypes = {
-  locks: PropTypes.array,
+  locks: PropTypes.arrayOf(lockShape),
 };
 
 Locks.defaultProps = {

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

@@ -1,7 +1,7 @@
 import React from 'react';
 import PropTypes from 'prop-types';
-import { Alert, Button } from 'patternfly-react';
-import { translate as __ } from 'foremanReact/common/I18n';
+import { Alert, AlertVariant, Button } from '@patternfly/react-core';
+import { translate as __, sprintf } from 'foremanReact/common/I18n';
 
 const RunningSteps = ({
   runningSteps,
@@ -14,11 +14,19 @@ const RunningSteps = ({
   return (
     <div>
       {runningSteps.map((step, i) => (
-        <Alert type="warning" key={i}>
+        <Alert
+          variant={AlertVariant.warning}
+          isInline
+          key={step.id || i}
+          ouiaId={`running-step-${i}`}
+          title={sprintf(__('Running step %s'), i + 1)}
+        >
           {step.cancellable && (
             <p>
               <Button
-                bsSize="small"
+                variant="danger"
+                size="sm"
+                ouiaId={`running-step-cancel-button-${i}`}
                 onClick={() => {
                   if (!taskReload) {
                     taskReloadStart(id);