foreman-tasks 3.0.0 → 4.0.0

data/test/controllers/tasks_controller_test.rb

@@ -10,7 +10,7 @@ module ForemanTasks
       # rubocop:enable Naming/AccessorMethodName
 
       def linked_task(resource)
-        FactoryBot.create(:some_task).tap { |t| ForemanTasks::Lock.link!(resource, t.id) }
+        FactoryBot.create(:some_task).tap { |t| ForemanTasks::Link.link!(resource, t) }
       end
 
       def in_taxonomy_scope(organization, location = nil)

data/test/unit/actions/action_with_sub_plans_test.rb

@@ -34,8 +34,9 @@ module ForemanTasks
     describe Actions::ActionWithSubPlans do
       include ForemanTasks::TestHelpers::WithInThreadExecutor
 
+      let(:user) { FactoryBot.create(:user) }
+
       let(:task) do
-        user = FactoryBot.create(:user)
         triggered = ForemanTasks.trigger(ParentAction, user)
         raise triggered.error if triggered.respond_to?(:error)
         triggered.finished.wait(30)
@@ -49,7 +50,9 @@ module ForemanTasks
 
       specify "the locks of the sub-plan don't colide with the locks of its parent" do
         child_task = task.sub_tasks.first
-        assert(child_task.locks.any? { |lock| lock.name == 'write' }, "it's locks don't conflict with parent's")
+        assert_not(child_task.locks.any?, "the lock is ensured by the parent")
+        found = ForemanTasks::Link.for_resource(user).where(:task_id => child_task.id).any?
+        assert(found, "the action is linked properly")
       end
     end
   end

data/test/unit/cleaner_test.rb

@@ -60,18 +60,18 @@ class TasksTest < ActiveSupport::TestCase
                            task.started_at = task.ended_at = Time.zone.now
                            task.save
                          end]
-      lock_to_delete = tasks_to_delete.first.locks.create(:name => 'read', :resource => User.current)
+      link_to_delete = tasks_to_delete.first.links.create(:resource => User.current)
 
       tasks_to_keep = [FactoryBot.create(:dynflow_task, :product_create_task)]
-      lock_to_keep = tasks_to_keep.first.locks.create(:name => 'read', :resource => User.current)
+      link_to_keep = tasks_to_keep.first.links.create(:resource => User.current)
 
       cleaner.expects(:tasks_to_csv)
       cleaner.delete
       _(ForemanTasks::Task.where(id: tasks_to_delete)).must_be_empty
       _(ForemanTasks::Task.where(id: tasks_to_keep)).must_equal tasks_to_keep
 
-      _(ForemanTasks::Lock.find_by(id: lock_to_delete.id)).must_be_nil
-      _(ForemanTasks::Lock.find_by(id: lock_to_keep.id)).wont_be_nil
+      _(ForemanTasks::Link.find_by(id: link_to_delete.id)).must_be_nil
+      _(ForemanTasks::Link.find_by(id: link_to_keep.id)).wont_be_nil
     end
 
     it 'supports passing empty filter (just delete all)' do

data/test/unit/locking_test.rb

@@ -0,0 +1,85 @@
+require 'ostruct'
+require 'foreman_tasks_test_helper'
+
+module ForemanTasks
+  class LockTest < ::ActiveSupport::TestCase
+    describe ::ForemanTasks::Lock::LockConflict do
+      class FakeLockConflict < ForemanTasks::Lock::LockConflict
+        def _(val)
+          val.freeze
+        end
+      end
+
+      it 'does not modify frozen strings' do
+        required_lock = OpenStruct.new(:name => 'my_lock')
+        # Before #21770 the next line would raise
+        #   RuntimeError: can't modify frozen String
+        conflict = FakeLockConflict.new(required_lock, [])
+        assert conflict._('this should be frozen').frozen?
+      end
+    end
+
+    describe 'locking and linking' do
+      before { [Lock, Link].each(&:destroy_all) }
+      let(:task1) { FactoryBot.create(:some_task) }
+      let(:task2) { FactoryBot.create(:some_task) }
+      let(:resource) { FactoryBot.create(:user) }
+
+      describe Lock do
+        it 'can lock a resource for a single task' do
+          Lock.lock!(resource, task1)
+        end
+
+        it 'can lock a resource for a single task only once' do
+          Lock.lock!(resource, task1)
+          _(Lock.for_resource(resource).count).must_equal 1
+          Lock.lock!(resource, task1)
+          _(Lock.for_resource(resource).count).must_equal 1
+        end
+
+        it 'cannot lock a resource for multiple tasks' do
+          lock = Lock.lock!(resource, task1)
+          _(Lock.colliding_locks(resource, task2)).must_equal [lock]
+          assert_raises Lock::LockConflict do
+            Lock.lock!(resource, task2)
+          end
+        end
+
+        it 'raises LockConflict when enforced by db' do
+          lock = Lock.lock!(resource, task1)
+          Lock.any_instance
+              .expects(:colliding_locks).twice.returns([], [lock])
+          exception = assert_raises Lock::LockConflict do
+            Lock.lock!(resource, task2)
+          end
+          _(exception.message).must_match(/#{lock.task_id}/)
+        end
+
+        it 'creates a link when creating a lock for a resource' do
+          Lock.lock!(resource, task1)
+          link = Link.for_resource(resource).first
+          _(link.task_id).must_equal task1.id
+        end
+      end
+
+      describe Link do
+        it 'can link a resource to a single task' do
+          Link.link!(resource, task1)
+        end
+
+        it 'can link a resource for a single task only once' do
+          Link.link!(resource, task1)
+          _(Link.for_resource(resource).count).must_equal 1
+          Link.link!(resource, task1)
+          _(Link.for_resource(resource).count).must_equal 1
+        end
+
+        it 'can link a resource to multiple tasks' do
+          Link.link!(resource, task1)
+          Link.link!(resource, task2)
+          _(Link.for_resource(resource).count).must_equal 2
+        end
+      end
+    end
+  end
+end

data/test/unit/recurring_logic_test.rb

@@ -148,6 +148,12 @@ class RecurringLogicsTest < ActiveSupport::TestCase
         assert ForemanTasks.dynflow.world.persistence.load_delayed_plan(task.execution_plan.id).frozen
       end
 
+      it 'handles if the task has been deleted' do
+        logic.tasks.find_by(:state => 'scheduled').destroy
+        logic.update!(:enabled => false)
+        assert_equal 'disabled', logic.state
+      end
+
       it 'properly re-enables on disable' do
         logic.update!(:enabled => false)
         logic.update!(:enabled => true)

data/test/unit/task_test.rb

@@ -129,6 +129,16 @@ class TasksTest < ActiveSupport::TestCase
         _ { proc { ForemanTasks::Task.search_for('duration = "25 potatoes"') } }.must_raise ScopedSearch::QueryNotSupported
       end
     end
+
+    context 'by taxonomies' do
+      test 'can search by taxonomies using IN' do
+        assert_nothing_raised(PG::SyntaxError) { ForemanTasks::Task.search_for('location_id ^ (1)').first }
+        assert_nothing_raised(PG::SyntaxError) { ForemanTasks::Task.search_for('organization_id ^ (1)').first }
+        assert_nothing_raised(PG::SyntaxError) { ForemanTasks::Task.search_for('location_id ^ (1,2)').first }
+        assert_nothing_raised(PG::SyntaxError) { ForemanTasks::Task.search_for('organization_id ^ (1,2)').first }
+        assert_nothing_raised(PG::SyntaxError) { ForemanTasks::Task.search_for('organization_id = 1').first }
+      end
+    end
   end
 
   describe 'users' do

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

@@ -21,10 +21,10 @@ const Locks = ({ locks }) => (
                     lock.exclusive ? 'fa-lock' : 'fa-unlock-alt'
                   }`}
                 />
-                {lock.name}
+                {lock.resource_type}
               </Card.Title>
               <Card.Body>
-                {`${lock.resource_type} id:${lock.resource_id}`}
+                {`id:${lock.resource_id}`}
                 <br />
               </Card.Body>
             </Card>

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

@@ -69,6 +69,7 @@ class TaskInfo extends Component {
         {
           title: 'Name',
           value: action || __('N/A'),
+          className: 'details-name',
         },
         {
           title: 'Start at',
@@ -129,7 +130,7 @@ class TaskInfo extends Component {
                 {__(items[0].title)}:
               </span>
             </Col>
-            <Col md={5} sm={6}>
+            <Col md={5} sm={6} className={items[0].className}>
               <span>{items[0].value}</span>
             </Col>
             <Col md={2} sm={6}>
@@ -137,7 +138,7 @@ class TaskInfo extends Component {
                 {__(items[1].title)}:
               </span>
             </Col>
-            <Col md={3} sm={6}>
+            <Col md={3} sm={6} className={items[1].className}>
               {items[1].value}
             </Col>
           </Row>

data/webpack/ForemanTasks/Components/TaskDetails/Components/__tests__/__snapshots__/Locks.test.js.snap

@@ -39,12 +39,12 @@ exports[`Locks rendering render with Props 1`] = `
             <span
               className="fa fa-unlock-alt"
             />
-            task_owner
+            User
           </CardTitle>
           <CardBody
             className=""
           >
-            User id:4
+            id:4
             <br />
           </CardBody>
         </Card>
@@ -71,12 +71,12 @@ exports[`Locks rendering render with Props 1`] = `
             <span
               className="fa fa-unlock-alt"
             />
-            task_owner2
+            User
           </CardTitle>
           <CardBody
             className=""
           >
-            User id:2
+            id:2
             <br />
           </CardBody>
         </Card>

data/webpack/ForemanTasks/Components/TaskDetails/Components/__tests__/__snapshots__/TaskInfo.test.js.snap

@@ -27,6 +27,7 @@ exports[`TaskInfo rendering render with Props 1`] = `
     </Col>
     <Col
       bsClass="col"
+      className="details-name"
       componentClass="div"
       md={5}
       sm={6}
@@ -330,6 +331,7 @@ exports[`TaskInfo rendering render without Props 1`] = `
     </Col>
     <Col
       bsClass="col"
+      className="details-name"
       componentClass="div"
       md={5}
       sm={6}

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

@@ -19,6 +19,7 @@ const TaskDetails = ({
   failedSteps,
   runningSteps,
   locks,
+  links,
   cancelStep,
   taskReloadStart,
   taskReloadStop,
@@ -87,7 +88,7 @@ const TaskDetails = ({
           <Errors executionPlan={executionPlan} failedSteps={failedSteps} />
         </Tab>
         <Tab eventKey={4} disabled={isLoading} title={__('Locks')}>
-          <Locks locks={locks} />
+          <Locks locks={locks.concat(links)} />
         </Tab>
         <Tab eventKey={5} disabled={isLoading} title={__('Raw')}>
           <Raw
@@ -114,6 +115,7 @@ TaskDetails.propTypes = {
   APIerror: PropTypes.object,
   taskReloadStop: PropTypes.func.isRequired,
   taskReloadStart: PropTypes.func.isRequired,
+  links: PropTypes.array,
   ...Task.propTypes,
   ...Errors.propTypes,
   ...Locks.propTypes,
@@ -124,6 +126,7 @@ TaskDetails.defaultProps = {
   runningSteps: [],
   APIerror: null,
   status: STATUS.PENDING,
+  links: [],
   ...Task.defaultProps,
   ...RunningSteps.defaultProps,
   ...Errors.defaultProps,

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

@@ -49,4 +49,18 @@
   .dynflow-button > span {
     pointer-events: auto;
   }
+
+  pre {
+    white-space: pre-wrap;
+    word-break: normal;
+  }
+
+  .param-name {
+    display: inline-block;
+    width: 10em;
+  }
+
+  .details-name {
+    overflow-wrap: anywhere;
+  }
 }

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

@@ -70,6 +70,9 @@ export const selectHasSubTasks = state =>
 export const selectLocks = state =>
   selectTaskDetailsResponse(state).locks || [];
 
+export const selectLinks = state =>
+  selectTaskDetailsResponse(state).links || [];
+
 export const selectUsernamePath = state =>
   selectTaskDetailsResponse(state)?.username_path;
 

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

@@ -9,6 +9,7 @@ import {
   selectStartBefore,
   selectStartedAt,
   selectLocks,
+  selectLinks,
   selectInput,
   selectOutput,
   selectResumable,
@@ -56,6 +57,7 @@ const mapStateToProps = state => ({
   help: selectHelp(state),
   hasSubTasks: selectHasSubTasks(state),
   locks: selectLocks(state),
+  links: selectLinks(state),
   usernamePath: selectUsernamePath(state),
   action: selectAction(state),
   state: selectState(state),

data/webpack/ForemanTasks/Components/TasksDashboard/Components/TasksCardsGrid/Components/ScheduledTasksCard/ScheduledTasksCard.scss

@@ -1,15 +1,19 @@
 .scheduled-tasks-card {
   text-align: center;
+
   .scheduled-data {
+    margin-top: 30px;
     padding-right: 15px;
     cursor: pointer;
     font-size: 40px;
     font-weight: 300;
     transition: font-weight 50ms ease-in;
+
     p {
       font-size: 20px;
       margin: 0;
     }
+
     * {
       margin: 10px;
     }

data/webpack/ForemanTasks/Components/TasksDashboard/Components/TasksCardsGrid/Components/StoppedTasksCard/OtherInfo.js

@@ -0,0 +1,53 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import classNames from 'classnames';
+
+import { Icon, Button, OverlayTrigger, Tooltip } from 'patternfly-react';
+import { translate as __ } from 'foremanReact/common/I18n';
+import {
+  TASKS_DASHBOARD_AVAILABLE_QUERY_STATES,
+  TASKS_DASHBOARD_AVAILABLE_QUERY_RESULTS,
+} from '../../../../TasksDashboardConstants';
+import { queryPropType } from '../../../../TasksDashboardPropTypes';
+
+const tooltip = (
+  <Tooltip id="stopped-tooltip">
+    {__('Other includes all stopped tasks that are cancelled or pending')}
+  </Tooltip>
+);
+
+export const OtherInfo = ({ updateQuery, otherCount, query }) => {
+  const { OTHER } = TASKS_DASHBOARD_AVAILABLE_QUERY_RESULTS;
+  const { STOPPED } = TASKS_DASHBOARD_AVAILABLE_QUERY_STATES;
+  const active = query.state === STOPPED && query.result === OTHER;
+  return (
+    <span className={classNames(active && 'other-active')}>
+      <OverlayTrigger
+        overlay={tooltip}
+        trigger={['hover', 'focus']}
+        placement="bottom"
+      >
+        <span>
+          <Icon type="pf" name="info" />
+          <span>{__('Other:')} </span>
+        </span>
+      </OverlayTrigger>
+      <Button
+        bsStyle="link"
+        onClick={() =>
+          updateQuery({
+            state: STOPPED,
+            result: OTHER,
+          })
+        }
+      >
+        {otherCount}
+      </Button>
+    </span>
+  );
+};
+OtherInfo.propTypes = {
+  updateQuery: PropTypes.func.isRequired,
+  otherCount: PropTypes.number.isRequired,
+  query: queryPropType.isRequired,
+};

data/webpack/ForemanTasks/Components/TasksDashboard/Components/TasksCardsGrid/Components/StoppedTasksCard/OtherInfo.test.js

@@ -0,0 +1,14 @@
+import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
+
+import { OtherInfo } from './OtherInfo';
+
+const fixtures = {
+  render: {
+    updateQuery: jest.fn,
+    otherCount: 7,
+    query: { state: 'STOPPED', result: 'OTHER' },
+  },
+};
+
+describe('OtherInfo', () =>
+  testComponentSnapshotsWithFixtures(OtherInfo, fixtures));

data/webpack/ForemanTasks/Components/TasksDashboard/Components/TasksCardsGrid/Components/StoppedTasksCard/StoppedTasksCard.js

@@ -4,8 +4,8 @@ import { Card } from 'patternfly-react';
 import classNames from 'classnames';
 import { noop } from 'foremanReact/common/helpers';
 import { translate as __ } from 'foremanReact/common/I18n';
-
-import { StoppedTable } from './StoppedTasksCardHelper';
+import { OtherInfo } from './OtherInfo';
+import { StoppedTable } from './StoppedTasksCardTable';
 import {
   timePropType,
   queryPropType,
@@ -14,7 +14,6 @@ import {
   TASKS_DASHBOARD_AVAILABLE_TIMES,
   TASKS_DASHBOARD_AVAILABLE_QUERY_STATES,
 } from '../../../../TasksDashboardConstants';
-import { getQueryValueText } from '../../../../TasksDashboardHelper';
 import './StoppedTasksCard.scss';
 
 const StoppedTasksCard = ({
@@ -44,16 +43,19 @@ const StoppedTasksCard = ({
         {__('Stopped')}
       </Card.Title>
       <Card.Body>
-        <table className="table table-bordered table-striped stopped-table">
-          <thead>
-            <tr>
-              <th />
-              <th>{__('Total')}</th>
-              <th>{getQueryValueText(time)}</th>
-            </tr>
-          </thead>
-          <tbody>{StoppedTable(data, query, time, updateQuery)}</tbody>
-        </table>
+        <React.Fragment>
+          <StoppedTable
+            data={data.results}
+            query={query}
+            time={time}
+            updateQuery={updateQuery}
+          />
+          <OtherInfo
+            updateQuery={updateQuery}
+            otherCount={data.other}
+            query={query}
+          />
+        </React.Fragment>
       </Card.Body>
     </Card>
   );
@@ -66,9 +68,12 @@ const resultPropType = PropTypes.shape({
 
 StoppedTasksCard.propTypes = {
   data: PropTypes.shape({
-    error: resultPropType.isRequired,
-    warning: resultPropType.isRequired,
-    success: resultPropType.isRequired,
+    results: PropTypes.shape({
+      error: resultPropType.isRequired,
+      warning: resultPropType.isRequired,
+      success: resultPropType.isRequired,
+    }),
+    other: PropTypes.number,
   }),
   time: timePropType,
   query: queryPropType,
@@ -78,9 +83,12 @@ StoppedTasksCard.propTypes = {
 
 StoppedTasksCard.defaultProps = {
   data: {
-    error: { total: 0, last: 0 },
-    warning: { total: 0, last: 0 },
-    success: { total: 0, last: 0 },
+    results: {
+      error: { total: 0, last: 0 },
+      warning: { total: 0, last: 0 },
+      success: { total: 0, last: 0 },
+    },
+    other: 0,
   },
   time: TASKS_DASHBOARD_AVAILABLE_TIMES.H24,
   query: {},