foreman-tasks 12.1.0 → 12.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faba9c8433d1b6c6faa616d7f6d58bfade42692f3e0afa6de35d67a0f1740bf2
-  data.tar.gz: 912a3a297fde3eddbbef8fca0e3da6e2bec6e6ca5882eb69a37eafe00a443ec9
+  metadata.gz: f3ab9dfe5221351a1c392ddc1ba3c9c8693ba9c7dd6ceea8659aabc30de78d56
+  data.tar.gz: d666650ff5f3073c9c66e3c37ec6d9c2d28ac08e3abd18f13157261cf0e511b6
 SHA512:
-  metadata.gz: bb4842d2685129d098bb05d37a423ce7817294cf523d2dd7f4e867618d80584135564d9df7c24a460bdad68372ac663dde160189d60cdd580bce9b825d3d89f8
-  data.tar.gz: e11dd77bbe8d94f347ed31d5b67dfec2924fba89207007fa370f7053ec5549c46a5d16e1fc34ea4e4f23ad1607abddb40db87aa74413d9b8d51f214aecab9485
+  metadata.gz: 99b91eb15001bc4d8d93605b1e7ffff2d39aab63ae044259d474f84827cf9888233d3e7b7b107e32ab63a7145ed419f5ac163a5c8d8a13857bfa6a2dc2fc935e
+  data.tar.gz: f95f6d9169b3b442fe9a4c8a20a3426984d997365fb9c7bf2708828e4f7e8ca634f78f70b8f07d02f9e22e92ed597b6f59d4140f36bb3661532f459adfd4baa3

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/lib/actions/helpers/lock.rb

@@ -13,12 +13,6 @@ module Actions
         end
       end
 
-      # @see Lock.lock!
-      def lock!(resource, *_lock_names)
-        Foreman::Deprecation.deprecation_warning('2.4', 'locking in foreman-tasks was reworked, please use a combination of exclusive_lock! and link! instead.')
-        exclusive_lock!(resource)
-      end
-
       # @see Lock.link!
       def link!(resource)
         phase! Dynflow::Action::Plan

data/app/lib/actions/middleware/keep_current_user.rb

@@ -12,26 +12,20 @@ module Actions
       end
 
       def run(*args)
-        restore_curent_user { pass(*args) }
+        restore_current_user { pass(*args) }
       end
 
       def finalize
-        current_id = User.current.try(:id)
-        saved_id = action.input[:current_user_id]
-        if User.current && saved_id && current_id != saved_id
-          Foreman::Deprecation.deprecation_warning('2.5', 'relying on per-step setting of current user in finalize phase')
-        end
-
-        restore_curent_user { pass }
+        restore_current_user { pass }
       end
 
       def finalize_phase(execution_plan, *args)
-        restore_curent_user(execution_plan.entry_action) { pass(execution_plan, *args) }
+        restore_current_user(execution_plan.entry_action) { pass(execution_plan, *args) }
       end
 
       # Run all execution plan lifecycle hooks as the original user
       def hook(*args)
-        restore_curent_user { pass(*args) }
+        restore_current_user { pass(*args) }
       end
 
       private
@@ -40,7 +34,7 @@ module Actions
         if User.current || action.input[:current_user_id].nil?
           yield
         else
-          restore_curent_user { yield }
+          restore_current_user { yield }
         end
       end
 
@@ -48,7 +42,7 @@ module Actions
         action.input[:current_user_id] = User.current.try(:id)
       end
 
-      def restore_curent_user(action = self.action)
+      def restore_current_user(action = self.action)
         old_user = User.current
         User.current = User.unscoped.find(action.input[:current_user_id]) if action.input[:current_user_id].present?
         yield

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.0'.freeze
+  VERSION = '12.2.1'.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/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/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);

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

@@ -1,208 +1,227 @@
-import React, { Component } from 'react';
+import React from 'react';
 import PropTypes from 'prop-types';
-import { Grid, Row, Col, ProgressBar } from 'patternfly-react';
+import {
+  Grid,
+  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';
 
-class TaskInfo extends Component {
-  isDelayed = () => {
-    const startAt = new Date(this.props.startAt);
-    const startedAt = new Date(this.props.startedAt);
-    startAt.setMilliseconds(0);
-    startedAt.setMilliseconds(0);
-    return startAt.getTime() !== startedAt.getTime();
-  };
-  resultIcon = () => {
-    if (this.props.state !== 'stopped') return 'task-status pficon-help';
-    const { result } = this.props;
-    let icon;
-    switch (result) {
-      case 'success':
-        icon = 'pficon-ok';
-        break;
-      case 'error':
-        icon = 'pficon-error-circle-o';
-        break;
-      case 'warning':
-        icon = 'pficon-ok status-warn';
-        break;
-      default:
-        icon = 'pficon-help';
-        break;
-    }
-    return `task-status ${icon}`;
-  };
-
-  progressBarType = () => {
-    const { result } = this.props;
-    switch (result) {
-      case 'error':
-        return 'danger';
-      case 'success':
-        return 'success';
-      case 'warning':
-        return 'warning';
-      default:
-        return null;
-    }
-  };
-
-  render() {
-    const {
-      action,
-      endedAt,
-      result,
-      startAt,
-      startBefore,
-      startedAt,
-      state,
-      help,
-      output,
-      errors,
-      progress,
-      username,
-      usernamePath,
-    } = this.props;
+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();
+};
 
-    const details = [
-      [
-        {
-          title: 'Name',
-          value: action || __('N/A'),
-          className: 'details-name',
-        },
-        {
-          title: 'Start at',
-          value: <RelativeDateTime defaultValue={__('N/A')} date={startAt} />,
-        },
-      ],
-      [
-        {
-          title: 'Result',
-          value: (
-            <React.Fragment>
-              <i className={this.resultIcon()} />
-              <span> {result}</span>
-            </React.Fragment>
-          ),
-        },
-        {
-          title: 'Started at',
-          value: <RelativeDateTime defaultValue={__('N/A')} date={startedAt} />,
-        },
-      ],
-      [
-        {
-          title: 'Triggered by',
-          value: (usernamePath || '').includes('href') ? (
-            <a href={usernamePath.split('"')[1]}>{username}</a>
-          ) : (
-            username || ''
-          ),
-        },
-        {
-          title: 'Ended at',
-          value: <RelativeDateTime defaultValue={__('N/A')} date={endedAt} />,
-        },
-      ],
-      [
-        {
-          title: 'Execution type',
-          value: __(this.isDelayed() ? 'Delayed' : 'Immediate'),
-        },
-        {
-          title: 'Start before',
-          value: startBefore ? (
-            <RelativeDateTime defaultValue={__('N/A')} date={startBefore} />
-          ) : (
-            '-'
-          ),
-        },
-      ],
-    ];
+const resultIconEl = (state, result) => {
+  if (state !== 'stopped')
     return (
-      <Grid>
-        <br />
-        {details.map((items, key) => (
-          <Row key={key}>
-            <Col md={2} sm={6}>
-              <span className="list-group-item-heading">
-                {__(items[0].title)}:
-              </span>
-            </Col>
-            <Col md={5} sm={6} className={items[0].className}>
-              <span>{items[0].value}</span>
-            </Col>
-            <Col md={2} sm={6}>
-              <span className="list-group-item-heading">
-                {__(items[1].title)}:
-              </span>
-            </Col>
-            <Col md={3} sm={6} className={items[1].className}>
-              {items[1].value}
-            </Col>
-          </Row>
-        ))}
-        <br />
-        <Row>
-          <Col xs={6}>
-            <div className="progress-description">
-              <span className="list-group-item-heading">{__('State')}: </span>
-              {state}
-            </div>
-          </Col>
-          <Col xs={3} xsOffset={3} className="progress-label-top-right">
-            <span>{`${progress}% ${__('Complete')}`}</span>
-          </Col>
-          <Col xs={12}>
-            <ProgressBar
-              now={progress}
-              bsStyle={this.progressBarType()}
-              striped
-            />
-          </Col>
-        </Row>
-        <br />
-        {help && (
-          <Row>
-            <Col xs={12}>
-              <p>
-                <span>
-                  <b>{__('Troubleshooting')}</b>
-                </span>
-              </p>
-              <p dangerouslySetInnerHTML={{ __html: help }} />
-            </Col>
-          </Row>
-        )}
-        {output && output.length > 0 && (
-          <Row>
-            <Col xs={12}>
-              <p>
-                <span>
-                  <b>{__('Output:')}</b>
-                </span>
-              </p>
-              <pre>{output}</pre>
-            </Col>
-          </Row>
-        )}
-        {errors && errors.length > 0 && (
-          <Row>
-            <Col xs={12}>
-              <div>
-                <span>
-                  <b>{__('Errors:')}</b>
-                </span>
-              </div>
-              <pre>{errors}</pre>
-            </Col>
-          </Row>
-        )}
-      </Grid>
+      <Icon>
+        <QuestionCircleIcon />
+      </Icon>
     );
+  switch (result) {
+    case 'success':
+      return (
+        <Icon status="success">
+          <CheckCircleIcon />
+        </Icon>
+      );
+    case 'error':
+      return (
+        <Icon status="danger">
+          <ExclamationCircleIcon />
+        </Icon>
+      );
+    case 'warning':
+      return (
+        <Icon status="warning">
+          <ExclamationTriangleIcon />
+        </Icon>
+      );
+    default:
+      return (
+        <Icon>
+          <QuestionCircleIcon />
+        </Icon>
+      );
+  }
+};
+
+const progressVariantForResult = result => {
+  switch (result) {
+    case 'error':
+      return ProgressVariant.danger;
+    case 'success':
+      return ProgressVariant.success;
+    case 'warning':
+      return ProgressVariant.warning;
+    default:
+      return undefined;
   }
-}
+};
+
+const TaskInfo = props => {
+  const {
+    action,
+    endedAt,
+    result,
+    startAt,
+    startBefore,
+    startedAt,
+    state,
+    help,
+    output,
+    errors,
+    progress,
+    username,
+    usernamePath,
+  } = props;
+
+  const details = [
+    [
+      {
+        title: 'Name',
+        value: action || __('N/A'),
+        className: 'details-name',
+      },
+      {
+        title: 'Start at',
+        value: <RelativeDateTime defaultValue={__('N/A')} date={startAt} />,
+      },
+    ],
+    [
+      {
+        title: 'Result',
+        value: (
+          <span>
+            {resultIconEl(state, result)} {result}
+          </span>
+        ),
+      },
+      {
+        title: 'Started at',
+        value: <RelativeDateTime defaultValue={__('N/A')} date={startedAt} />,
+      },
+    ],
+    [
+      {
+        title: 'Triggered by',
+        value: (usernamePath || '').includes('href') ? (
+          <a href={usernamePath.split('"')[1]}>{username}</a>
+        ) : (
+          username || ''
+        ),
+      },
+      {
+        title: 'Ended at',
+        value: <RelativeDateTime defaultValue={__('N/A')} date={endedAt} />,
+      },
+    ],
+    [
+      {
+        title: 'Execution type',
+        value: __(isDelayed(props) ? 'Delayed' : 'Immediate'),
+      },
+      {
+        title: 'Start before',
+        value: startBefore ? (
+          <RelativeDateTime defaultValue={__('N/A')} date={startBefore} />
+        ) : (
+          '-'
+        ),
+      },
+    ],
+  ];
+
+  const progVariant = progressVariantForResult(result);
+
+  return (
+    <Grid>
+      <GridItem span={12} className="pf-v5-u-pb-lg" />
+      {details.map((items, key) => (
+        <React.Fragment key={key}>
+          <GridItem md={2} sm={6}>
+            <span className="list-group-item-heading">
+              {__(items[0].title)}:
+            </span>
+          </GridItem>
+          <GridItem md={5} sm={6} className={items[0].className}>
+            <span>{items[0].value}</span>
+          </GridItem>
+          <GridItem md={2} sm={6}>
+            <span className="list-group-item-heading">
+              {__(items[1].title)}:
+            </span>
+          </GridItem>
+          <GridItem md={3} sm={6} className={items[1].className}>
+            {items[1].value}
+          </GridItem>
+        </React.Fragment>
+      ))}
+      <GridItem span={12} className="pf-v5-u-pb-lg" />
+      <GridItem span={6}>
+        <div className="progress-description">
+          <span className="list-group-item-heading">{__('State')}: </span>
+          {state}
+        </div>
+      </GridItem>
+      <GridItem span={6} className="progress-label-top-right">
+        <span>{`${progress}% ${__('Complete')}`}</span>
+      </GridItem>
+      <GridItem span={12}>
+        <Progress
+          value={progress}
+          max={100}
+          aria-label={`${progress}% ${__('Complete')}`}
+          measureLocation="outside"
+          {...(progVariant ? { variant: progVariant } : {})}
+        />
+      </GridItem>
+      <GridItem span={12} className="pf-v5-u-pb-lg" />
+      {help && (
+        <GridItem span={12}>
+          <b>{__('Troubleshooting')}</b>
+          <p dangerouslySetInnerHTML={{ __html: help }} />
+        </GridItem>
+      )}
+      {output && output.length > 0 && (
+        <GridItem span={12}>
+          <b>{__('Output:')}</b>
+          <pre>{output}</pre>
+        </GridItem>
+      )}
+      {errors && errors.length > 0 && (
+        <GridItem span={12}>
+          <b>{__('Errors:')}</b>
+          <pre>{errors}</pre>
+        </GridItem>
+      )}
+    </Grid>
+  );
+};
 
 TaskInfo.propTypes = {
   action: PropTypes.string,
@@ -217,10 +236,7 @@ TaskInfo.propTypes = {
   progress: PropTypes.number,
   username: PropTypes.string,
   usernamePath: PropTypes.string,
-  output: PropTypes.PropTypes.oneOfType([
-    PropTypes.string,
-    PropTypes.shape({}),
-  ]),
+  output: PropTypes.oneOfType([PropTypes.string, PropTypes.shape({})]),
 };
 
 TaskInfo.defaultProps = {