Refs #38991 - create chain() foreman-tasks method

Author: ianballou

lib/foreman_tasks.rb

@@ -62,6 +62,18 @@ 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.
+  #
+  # @param plan_uuids [String, Array<String>] UUID(s) of prerequisite execution plan(s)
+  # @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)
+    result = dynflow.world.chain(plan_uuids, action, *args)
+    ForemanTasks::Task::DynflowTask.where(:external_id => result.id).first!
+  end
+
   def self.register_scheduled_task(task_class, cronline)
     ForemanTasks::RecurringLogic.transaction(isolation: :serializable) do
       return if ForemanTasks::RecurringLogic.joins(:tasks)

test/unit/chaining_test.rb

@@ -0,0 +1,35 @@
+require 'foreman_tasks_test_helper'
+
+module ForemanTasks
+  class ChainingTest < ActiveSupport::TestCase
+    include ForemanTasks::TestHelpers::WithInThreadExecutor
+
+    before do
+      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)
+
+      task = ForemanTasks.chain(prerequisite_plan.id, 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
+    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)
+
+      task = ForemanTasks.chain([prerequisite_plan_1.id, prerequisite_plan_2.id], 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
+    end
+  end
+end
+