Refs #38991 - chain() now accepts Task objects

Author: ianballou

lib/foreman_tasks.rb

@@ -62,14 +62,26 @@ def self.delay(action, delay_options, *args)
     ForemanTasks::Task::DynflowTask.where(:external_id => result.id).first!
   end
 
-  # Chain a task to wait for prerequisite task(s) to finish before executing.
-  # The chained task remains 'scheduled' until all prerequisites reach 'stopped' state.
+  # Chain a task to wait for dependency task(s) to finish before executing.
+  # The chained task remains 'scheduled' until all dependencies reach 'stopped' state.
   #
-  # @param plan_uuids [String, Array<String>] UUID(s) of prerequisite execution plan(s)
+  # @param dependencies [ForemanTasks::Task, Array<ForemanTasks::Task>, ActiveRecord::Relation]
+  #   Dependency ForemanTasks task object(s) or an ActiveRecord relation of tasks.
   # @param action [Class] Action class to execute
   # @param args Arguments to pass to the action
   # @return [ForemanTasks::Task::DynflowTask] The chained task
-  def self.chain(plan_uuids, action, *args)
+  def self.chain(dependencies, action, *args)
+    plan_uuids =
+      if dependencies.is_a?(ActiveRecord::Relation)
+        dependencies.pluck(:external_id)
+      else
+        Array(dependencies).map(&:external_id)
+      end
+
+    if plan_uuids.any?(&:blank?)
+      raise ArgumentError, 'All dependency tasks must have external_id set'
+    end
+
     result = dynflow.world.chain(plan_uuids, action, *args)
     ForemanTasks::Task::DynflowTask.where(:external_id => result.id).first!
   end

lib/foreman_tasks/triggers.rb

@@ -25,5 +25,9 @@ def sync_task(action, *args, &block)
     def delay(action, delay_options, *args)
       foreman_tasks.delay(action, delay_options, *args)
     end
+
+    def chain(dependencies, action, *args)
+      foreman_tasks.chain(dependencies, action, *args)
+    end
   end
 end

test/unit/chaining_test.rb

@@ -8,28 +8,55 @@ class ChainingTest < ActiveSupport::TestCase
       User.current = User.where(:login => 'apiadmin').first
     end
 
-    it 'creates a scheduled task chained to a prerequisite execution plan' do
-      prerequisite_plan = ForemanTasks.dynflow.world.plan(Support::DummyDynflowAction)
+    it 'creates a scheduled task chained to a dependency task' do
+      triggered = ForemanTasks.trigger(Support::DummyDynflowAction)
+      triggered.finished.wait(30)
+      dependency_task = ForemanTasks::Task::DynflowTask.find_by!(:external_id => triggered.id)
 
-      task = ForemanTasks.chain(prerequisite_plan.id, Support::DummyDynflowAction)
+      task = ForemanTasks.chain(dependency_task, Support::DummyDynflowAction)
 
       assert_kind_of ForemanTasks::Task::DynflowTask, task
       assert_predicate task, :scheduled?
 
       dependencies = ForemanTasks.dynflow.world.persistence.find_execution_plan_dependencies(task.execution_plan.id)
-      assert_includes dependencies, prerequisite_plan.id
+      assert_includes dependencies, dependency_task.external_id
     end
 
-    it 'accepts multiple prerequisite execution plans' do
-      prerequisite_plan_1 = ForemanTasks.dynflow.world.plan(Support::DummyDynflowAction)
-      prerequisite_plan_2 = ForemanTasks.dynflow.world.plan(Support::DummyDynflowAction)
+    it 'accepts multiple dependency tasks' do
+      triggered_1 = ForemanTasks.trigger(Support::DummyDynflowAction)
+      triggered_2 = ForemanTasks.trigger(Support::DummyDynflowAction)
+      triggered_1.finished.wait(30)
+      triggered_2.finished.wait(30)
+      dependency_task_1 = ForemanTasks::Task::DynflowTask.find_by!(:external_id => triggered_1.id)
+      dependency_task_2 = ForemanTasks::Task::DynflowTask.find_by!(:external_id => triggered_2.id)
 
-      task = ForemanTasks.chain([prerequisite_plan_1.id, prerequisite_plan_2.id], Support::DummyDynflowAction)
+      task = ForemanTasks.chain([dependency_task_1, dependency_task_2], Support::DummyDynflowAction)
 
       dependencies = ForemanTasks.dynflow.world.persistence.find_execution_plan_dependencies(task.execution_plan.id)
-      assert_includes dependencies, prerequisite_plan_1.id
-      assert_includes dependencies, prerequisite_plan_2.id
+      assert_includes dependencies, dependency_task_1.external_id
+      assert_includes dependencies, dependency_task_2.external_id
+    end
+
+    it 'accepts dependency task objects' do
+      triggered = ForemanTasks.trigger(Support::DummyDynflowAction)
+      triggered.finished.wait(30)
+      dependency_task = ForemanTasks::Task::DynflowTask.find_by!(:external_id => triggered.id)
+
+      task = ForemanTasks.chain(dependency_task, Support::DummyDynflowAction)
+
+      dependencies = ForemanTasks.dynflow.world.persistence.find_execution_plan_dependencies(task.execution_plan.id)
+      assert_includes dependencies, dependency_task.external_id
+    end
+
+    it 'accepts dependency tasks as a relation' do
+      triggered = ForemanTasks.trigger(Support::DummyDynflowAction)
+      triggered.finished.wait(30)
+      dependency_task = ForemanTasks::Task::DynflowTask.find_by!(:external_id => triggered.id)
+
+      task = ForemanTasks.chain(ForemanTasks::Task::DynflowTask.where(:id => dependency_task.id), Support::DummyDynflowAction)
+
+      dependencies = ForemanTasks.dynflow.world.persistence.find_execution_plan_dependencies(task.execution_plan.id)
+      assert_includes dependencies, dependency_task.external_id
     end
   end
 end
-