foreman-tasks 3.0.4 → 4.1.1

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/actions/proxy_action_test.rb

@@ -14,6 +14,9 @@ module ForemanTasks
         Support::DummyProxyAction.any_instance.stubs(:with_batch_triggering?).returns(batch_triggering)
         Support::DummyProxyAction.reset
         RemoteTask.any_instance.stubs(:proxy).returns(Support::DummyProxyAction.proxy)
+        Setting.stubs(:[]).with('foreman_tasks_proxy_action_retry_interval')
+        Setting.stubs(:[]).with('foreman_tasks_proxy_action_retry_count')
+        Setting.stubs(:[]).with('foreman_tasks_proxy_batch_trigger')
         @action = create_and_plan_action(Support::DummyProxyAction,
                                          Support::DummyProxyAction.proxy,
                                          'Proxy::DummyAction',
@@ -107,7 +110,7 @@ module ForemanTasks
         _(action.world.clock.pending_pings.length).must_equal 1
         _(action.output[:metadata][:failed_proxy_tasks].length).must_equal 1
         2.times { action.output[:metadata][:failed_proxy_tasks] << {} }
-        _ { proc { action = run_stubbed_action.call action } }.must_raise(Errno::ECONNREFUSED)
+        _(proc { action = run_stubbed_action.call action }).must_raise(Errno::ECONNREFUSED)
         _(action.state).must_equal :error
       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/task_test.rb

@@ -31,9 +31,9 @@ class TasksTest < ActiveSupport::TestCase
         assert_equal [@task_one], ForemanTasks::Task.search_for("user = #{@user_one.login}")
       end
 
-      test 'cannot search by arbitrary key' do
-        _ { proc { ForemanTasks::Task.search_for('user.my_key ~ 5') } }.must_raise(ScopedSearch::QueryNotSupported)
-        _ { proc { ForemanTasks::Task.search_for('user. = 5') } }.must_raise(ScopedSearch::QueryNotSupported)
+      it 'cannot search by arbitrary key' do
+        _(proc { ForemanTasks::Task.search_for('user.my_key ~ 5') }).must_raise(ScopedSearch::QueryNotSupported)
+        _(proc { ForemanTasks::Task.search_for('user. = 5') }).must_raise(ScopedSearch::QueryNotSupported)
       end
 
       test 'can search the tasks by negated user' do
@@ -59,8 +59,8 @@ class TasksTest < ActiveSupport::TestCase
       end
 
       test 'cannot glob on user\'s id' do
-        _ { proc { ForemanTasks::Task.search_for("user.id ~ something") } }.must_raise(ScopedSearch::QueryNotSupported)
-        _ { proc { ForemanTasks::Task.search_for("user.id ~ 5") } }.must_raise(ScopedSearch::QueryNotSupported)
+        _(proc { ForemanTasks::Task.search_for("user.id ~ something") }).must_raise(ScopedSearch::QueryNotSupported)
+        _(proc { ForemanTasks::Task.search_for("user.id ~ 5") }).must_raise(ScopedSearch::QueryNotSupported)
       end
 
       test 'can search the tasks by user with wildcards' do
@@ -126,15 +126,17 @@ class TasksTest < ActiveSupport::TestCase
       end
 
       it 'raises an exception if duration is unknown' do
-        _ { proc { ForemanTasks::Task.search_for('duration = "25 potatoes"') } }.must_raise ScopedSearch::QueryNotSupported
+        _(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('organization_id = 1').first }
+        assert_nothing_raised { ForemanTasks::Task.search_for('location_id ^ (1)').first }
+        assert_nothing_raised { ForemanTasks::Task.search_for('organization_id ^ (1)').first }
+        assert_nothing_raised { ForemanTasks::Task.search_for('location_id ^ (1,2)').first }
+        assert_nothing_raised { ForemanTasks::Task.search_for('organization_id ^ (1,2)').first }
+        assert_nothing_raised { ForemanTasks::Task.search_for('organization_id = 1').first }
       end
     end
   end
@@ -300,7 +302,7 @@ class TasksTest < ActiveSupport::TestCase
       resource_type = 'restype1'
 
       task1_old = FactoryBot.create(
-        :task_with_locks,
+        :task_with_links,
         started_at: '2019-10-01 11:15:55',
         ended_at: '2019-10-01 11:15:57',
         resource_id: 1,
@@ -308,7 +310,7 @@ class TasksTest < ActiveSupport::TestCase
         resource_type: resource_type
       )
       task1_new = FactoryBot.create(
-        :task_with_locks,
+        :task_with_links,
         started_at: '2019-10-02 11:15:55',
         ended_at: '2019-10-02 11:15:57',
         resource_id: 1,
@@ -316,7 +318,7 @@ class TasksTest < ActiveSupport::TestCase
         resource_type: resource_type
       )
       task2 = FactoryBot.create(
-        :task_with_locks,
+        :task_with_links,
         started_at: '2019-10-03 11:15:55',
         ended_at: '2019-10-03 11:15:57',
         resource_id: 2,
@@ -324,7 +326,7 @@ class TasksTest < ActiveSupport::TestCase
         resource_type: resource_type
       )
       task3 = FactoryBot.create(
-        :task_with_locks,
+        :task_with_links,
         started_at: '2019-10-03 11:15:55',
         ended_at: '2019-10-03 11:15:57',
         resource_id: 3,

data/test/unit/triggering_test.rb

@@ -24,7 +24,7 @@ class TriggeringTest < ActiveSupport::TestCase
   it 'cannot have mode set to arbitrary value' do
     triggering = FactoryBot.build(:triggering)
     _(triggering).must_be :valid?
-    _ { proc { triggering.mode = 'bogus' } }.must_raise ArgumentError
-    _ { proc { triggering.mode = 27 } }.must_raise ArgumentError
+    _(proc { triggering.mode = 'bogus' }).must_raise ArgumentError
+    _(proc { triggering.mode = 27 }).must_raise ArgumentError
   end
 end

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

@@ -51,7 +51,7 @@
   }
 
   pre {
-    white-space: pre;
+    white-space: pre-wrap;
     word-break: normal;
   }
 
@@ -59,4 +59,8 @@
     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/TasksTable/TasksTablePage.scss

@@ -1,8 +1,9 @@
-.tasks-pagination {
-  margin-top: -6px;
-}
 .tasks-table {
   margin-bottom: 70px;
+
+  .action-name-tasks-table {
+    overflow-wrap: anywhere;
+  }
 }
 
 .tasks-table-wrapper {

data/webpack/ForemanTasks/Components/TasksTable/__tests__/__snapshots__/TasksTablePage.test.js.snap

@@ -17,7 +17,7 @@ exports[`TasksTablePage rendering render with Breadcrubs and edit permissions 1`
   />
   <PageLayout
     beforeToolbarComponent={
-      <UNDEFINED
+      <Memo(Connect(TasksDashboard))
         history={
           Object {
             "location": Object {
@@ -169,7 +169,7 @@ exports[`TasksTablePage rendering render with minimal props 1`] = `
   />
   <PageLayout
     beforeToolbarComponent={
-      <UNDEFINED
+      <Memo(Connect(TasksDashboard))
         history={
           Object {
             "location": Object {

data/webpack/ForemanTasks/Components/TasksTable/formatters/__test__/__snapshots__/actionNameCellFormatter.test.js.snap

@@ -2,10 +2,9 @@
 
 exports[`actionNameCellFormatter render 1`] = `
 <a
+  className="action-name-tasks-table"
   href="/some-url/some-id"
 >
-  <EllipisWithTooltip>
-    action-name
-  </EllipisWithTooltip>
+  action-name
 </a>
 `;