foreman-tasks-core 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c46d9f3def1bf8405c45eb6a32331437dede8c68071d0c0c8a0159a2e489f007
-  data.tar.gz: 24e606e5743d4694c607514b25bbff6492153290d9d3c99546a91b6ce75967d0
+  metadata.gz: 7c036a816a81a10ce427600ce920c1aa98c59bb2c317dcba1662f906941d00e0
+  data.tar.gz: 3e74db375442e42f0ad7e7f5887d1cd5ab79b311d86c1389f24fb5d168146a70
 SHA512:
-  metadata.gz: 5a3c8a38e39d80a3f5f9bc1deebdcf7e4b082838e687ae78846a17448302dddff4c00c24e81235ad455133c12bfd7112d657b7ca630210ce79bddd1f4d04e13f
-  data.tar.gz: c4777a0ca2d8d7562e3b2f0ab02293e7af5039753adcd9c7d0fabe1955726b60cf15e2c9664376410aff9e08de45054459ce9e2ac7a0d4a94ce49e02b3a61936
+  metadata.gz: 7c68ff530abb93733509feb1201d74c7588b1edc3e90c6caf2fd54fce11aedeb760595c2ce3fcf8f208fe5eafbc7bca00aecec08ee4b28d0b1e438c6b81938d1
+  data.tar.gz: f1e5baa029323687099e055874464d1710ddbcc8488207fcb64bdc5f5682ff90311c8db6fbf5ce6eb372a4d9eb821df51ac26a5e151bbc6d4551983a896e6f82

data/lib/foreman_tasks_core.rb

@@ -4,6 +4,11 @@
 require 'foreman_tasks_core/settings_loader'
 require 'foreman_tasks_core/otp_manager'
 require 'foreman_tasks_core/ticker'
+require 'foreman_tasks_core/batch_action'
+require 'foreman_tasks_core/batch_callback_action'
+require 'foreman_tasks_core/batch_runner_action'
+require 'foreman_tasks_core/output_collector_action'
+require 'foreman_tasks_core/single_runner_batch_action'
 require 'foreman_tasks_core/task_launcher'
 
 module ForemanTasksCore

data/lib/foreman_tasks_core/batch_action.rb

@@ -0,0 +1,21 @@
+module ForemanTasksCore
+  class BatchAction < ::Dynflow::Action
+    include Dynflow::Action::WithSubPlans
+    include Dynflow::Action::WithPollingSubPlans
+
+    # { task_id => { :action_class => Klass, :input => input } }
+    def plan(launcher, input_hash)
+      launcher.launch_children(self, input_hash)
+      plan_self
+    end
+
+    def initiate
+      ping suspended_action
+      wait_for_sub_plans sub_plans
+    end
+
+    def rescue_strategy
+      Dynflow::Action::Rescue::Fail
+    end
+  end
+end

data/lib/foreman_tasks_core/batch_callback_action.rb

@@ -0,0 +1,20 @@
+module ForemanTasksCore
+  class BatchCallback < ::Dynflow::Action
+    def plan(input_hash, results)
+      plan_self :targets => input_hash, :results => results
+    end
+
+    def run
+      payload = format_payload(input['targets'], input['results'])
+      SmartProxyDynflowCore::Callback::Request.new.callback({ :callbacks => payload }.to_json)
+    end
+
+    private
+
+    def format_payload(input_hash, results)
+      input_hash.map do |task_id, callback|
+        { :callback => callback, :data => results[task_id] }
+      end
+    end
+  end
+end

data/lib/foreman_tasks_core/batch_runner_action.rb

@@ -0,0 +1,14 @@
+require 'foreman_tasks_core/runner/action'
+
+module ForemanTasksCore
+  class BatchRunnerAction < ::ForemanTasksCore::Runner::Action
+    def plan(launcher, input)
+      plan_self :targets => launcher.runner_input(input), :operation => launcher.operation
+    end
+
+    def initiate_runner
+      launcher = SmartProxyDynflowCore::TaskLauncherRegistry.fetch(input[:operation])
+      launcher.runner_class.new(input[:targets], suspended_action: suspended_action)
+    end
+  end
+end

data/lib/foreman_tasks_core/output_collector_action.rb

@@ -0,0 +1,8 @@
+module ForemanTasksCore
+  class OutputCollectorAction < ::ForemanTasksCore::Runner::Action
+    def init_run
+      output[:result] = []
+      suspend
+    end
+  end
+end

data/lib/foreman_tasks_core/runner/command.rb

@@ -0,0 +1,40 @@
+module ForemanTasksCore
+  module Runner
+    module Command
+      def initialize_command(*command)
+        @command_out, @command_in, @command_pid = PTY.spawn(*command)
+      rescue Errno::ENOENT => e
+        publish_exception("Error running command '#{command.join(' ')}'", e)
+      end
+
+      def refresh
+        return if @command_out.nil?
+        ready_outputs, * = IO.select([@command_out], nil, nil, 0.1)
+        if ready_outputs
+          if @command_out.nread > 0
+            lines = @command_out.read_nonblock(@command_out.nread)
+          else
+            close_io
+            Process.wait(@command_pid)
+            publish_exit_status($CHILD_STATUS.exitstatus)
+          end
+          publish_data(lines, 'stdout') if lines && !lines.empty?
+        end
+      end
+
+      def close
+        close_io
+      end
+
+      private
+
+      def close_io
+        @command_out.close if @command_out && !@command_out.closed?
+        @command_out = nil
+
+        @command_in.close if @command_in && !@command_in.closed?
+        @command_in = nil
+      end
+    end
+  end
+end

data/lib/foreman_tasks_core/runner/command_runner.rb

@@ -1,41 +1,11 @@
 require 'io/wait'
 require 'pty'
+require 'foreman_tasks_core/runner/command'
 
 module ForemanTasksCore
   module Runner
-    class CommandRunner < Runner::Base
-      def initialize_command(*command)
-        @command_out, @command_in, @command_pid = PTY.spawn(*command)
-      end
-
-      def refresh
-        return if @command_out.nil?
-        ready_outputs, * = IO.select([@command_out], nil, nil, 0.1)
-        if ready_outputs
-          if @command_out.nread > 0
-            lines = @command_out.read_nonblock(@command_out.nread)
-          else
-            close_io
-            Process.wait(@command_pid)
-            publish_exit_status($CHILD_STATUS.exitstatus)
-          end
-          publish_data(lines, 'stdout') if lines && !lines.empty?
-        end
-      end
-
-      def close
-        close_io
-      end
-
-      private
-
-      def close_io
-        @command_out.close if @command_out && !@command_out.closed?
-        @command_out = nil
-
-        @command_in.close if @command_in && !@command_in.closed?
-        @command_in = nil
-      end
+    class CommandRunner < Base
+      include Command
     end
   end
 end

data/lib/foreman_tasks_core/runner/parent.rb

@@ -1,10 +1,11 @@
 module ForemanTasksCore
   module Runner
     class Parent < Base
-      # targets = { hostname => { :execution_plan_id => "...", :run_step_id => id,
+      # targets = { identifier => { :execution_plan_id => "...", :run_step_id => id,
       #                           :input => { ... } }
       def initialize(targets = {}, suspended_action: nil)
         @targets = targets
+        @exit_statuses = {}
         super suspended_action: suspended_action
       end
 
@@ -13,9 +14,11 @@ module ForemanTasksCore
           if value.empty? && @exit_status.nil?
             acc
           else
-            @outputs[key] = ForemanTasksCore::ContinuousOutput.new
-            key = host_action(key) unless key == @suspended_action
-            acc.merge(key => Runner::Update.new(value, @exit_status))
+            identifier = key
+            @outputs[identifier] = ForemanTasksCore::ContinuousOutput.new
+            key = host_action(identifier) unless identifier == @suspended_action
+            exit_status = @exit_statuses[identifier] || @exit_status if @exit_status
+            acc.merge(key => Runner::Update.new(value, exit_status))
           end
         end
       end
@@ -26,9 +29,9 @@ module ForemanTasksCore
         end
       end
 
-      def host_action(hostname)
-        options = @targets[hostname].slice('execution_plan_id', 'run_step_id')
-                                    .merge(:world => ForemanTasksCore.dynflow_world)
+      def host_action(identifier)
+        options = @targets[identifier].slice('execution_plan_id', 'run_step_id')
+                                      .merge(:world => ForemanTasksCore.dynflow_world)
         Dynflow::Action::Suspended.new OpenStruct.new(options)
       end
 
@@ -36,13 +39,21 @@ module ForemanTasksCore
         @outputs.each { |_k, output| output.add_output(data, type) }
       end
 
-      def publish_data_for(hostname, data, type)
-        @outputs[hostname].add_output(data, type)
+      def publish_data(data, type)
+        @outputs[@suspended_action].add_output(data, type)
+      end
+
+      def publish_data_for(identifier, data, type)
+        @outputs[identifier].add_output(data, type)
       end
 
       def dispatch_exception(context, exception)
         @outputs.values.each { |output| output.add_exception(context, exception) }
       end
+
+      def publish_exit_status_for(identifier, exit_status)
+        @exit_statuses[identifier] = exit_status
+      end
     end
   end
 end

data/lib/foreman_tasks_core/single_runner_batch_action.rb

@@ -0,0 +1,39 @@
+module ForemanTasksCore
+  class SingleRunnerBatchAction < ForemanTasksCore::BatchAction
+    def plan(launcher, input_hash)
+      launcher.launch_children(self, input_hash)
+      sequence do
+        results = plan_self
+        plan_action BatchCallback, launcher.prepare_batch(input_hash), results.output[:results]
+      end
+    end
+
+    def run(event = nil)
+      super unless event == Dynflow::Action::Skip
+    end
+
+    def initiate
+      ping suspended_action
+      wait_for_sub_plans sub_plans
+    end
+
+    def check_for_errors!(optional = true)
+      super unless optional
+    end
+
+    def on_finish
+      output[:results] = sub_plans.map(&:entry_action).reduce({}) do |acc, cur|
+        acc.merge(cur.execution_plan_id => cur.output)
+      end
+    end
+
+    def finalize
+      output.delete(:results)
+      check_for_errors!
+    end
+
+    def rescue_strategy_for_self
+      Dynflow::Action::Rescue::Skip
+    end
+  end
+end

data/lib/foreman_tasks_core/task_launcher.rb

@@ -6,3 +6,4 @@ end
 require 'foreman_tasks_core/task_launcher/abstract'
 require 'foreman_tasks_core/task_launcher/single'
 require 'foreman_tasks_core/task_launcher/batch'
+require 'foreman_tasks_core/task_launcher/group'

data/lib/foreman_tasks_core/task_launcher/abstract.rb

@@ -13,6 +13,8 @@ module ForemanTasksCore
         raise NotImplementedError
       end
 
+      def self.input_format; end
+
       private
 
       def format_result(result)
@@ -25,7 +27,7 @@ module ForemanTasksCore
       end
 
       def action_class(input)
-        ::Dynflow::Utils.constantize(input['action_class'])
+        options[:action_class_override] || ::Dynflow::Utils.constantize(input['action_class'])
       end
 
       def with_callback(input)

data/lib/foreman_tasks_core/task_launcher/batch.rb

@@ -1,37 +1,37 @@
 module ForemanTasksCore
   module TaskLauncher
-    class ParentAction < ::Dynflow::Action
-      include Dynflow::Action::WithSubPlans
-      include Dynflow::Action::WithPollingSubPlans
-
-      # { task_id => { :action_class => Klass, :input => input } }
-      def plan(launcher, input_hash)
-        launcher.launch_children(self, input_hash)
-        plan_self
-      end
-
-      def initiate
-        ping suspended_action
-        wait_for_sub_plans sub_plans
-      end
-
-      def rescue_strategy
-        Dynflow::Action::Rescue::Fail
-      end
-    end
-
     class Batch < Abstract
       def launch!(input)
-        trigger(nil, ParentAction, self, input)
+        trigger(nil, BatchAction, self, input)
       end
 
       def launch_children(parent, input_hash)
         input_hash.each do |task_id, input|
-          launcher = Single.new(world, callback, :parent => parent)
-          launcher.launch!(input)
+          launcher = child_launcher(parent)
+          launcher.launch!(transform_input(input))
           results[task_id] = launcher.results
         end
       end
+
+      def prepare_batch(input_hash)
+        success_tasks = input_hash.select do |task_id, _input|
+          results[task_id][:result] == 'success'
+        end
+        success_tasks.reduce({}) do |acc, (key, value)|
+          acc.merge(results[key][:task_id] => value['action_input']['callback'])
+        end
+      end
+
+      private
+
+      def child_launcher(parent)
+        Single.new(world, callback, :parent => parent)
+      end
+
+      # Identity by default
+      def transform_input(input)
+        input
+      end
     end
   end
 end

data/lib/foreman_tasks_core/task_launcher/group.rb

@@ -0,0 +1,47 @@
+require 'foreman_tasks_core/runner'
+
+module ForemanTasksCore
+  module TaskLauncher
+    class AbstractGroup < Batch
+      def self.runner_class
+        raise NotImplementedError
+      end
+
+      def launch!(input)
+        trigger(nil, SingleRunnerBatchAction, self, input)
+      end
+
+      def launch_children(parent, input_hash)
+        super(parent, input_hash)
+        trigger(parent, BatchRunnerAction, self, input_hash)
+      end
+
+      def operation
+        raise NotImplementedError
+      end
+
+      def runner_input(input)
+        input.reduce({}) do |acc, (id, input)|
+          input = { :execution_plan_id => results[id][:task_id],
+                    :run_step_id => 2,
+                    :input => input }
+          acc.merge(id => input)
+        end
+      end
+
+      private
+
+      def child_launcher(parent)
+        Single.new(world, callback, :parent => parent, :action_class_override => OutputCollectorAction)
+      end
+
+      def transform_input(input)
+        wipe_callback(input)
+      end
+
+      def wipe_callback(input)
+        input.merge('action_input' => input['action_input'].merge('callback' => nil))
+      end
+    end
+  end
+end

data/lib/foreman_tasks_core/task_launcher/single.rb

@@ -1,7 +1,10 @@
 module ForemanTasksCore
   module TaskLauncher
     class Single < Abstract
-      # { :action_class => "MyActionClass", :action_input => {} }
+      def self.input_format
+        { :action_class => "MyActionClass", :action_input => {} }
+      end
+
       def launch!(input)
         triggered = trigger(options[:parent],
                             action_class(input),

data/lib/foreman_tasks_core/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasksCore
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.3.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks-core
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-15 00:00:00.000000000 Z
+date: 2019-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dynflow
@@ -35,20 +35,27 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - lib/foreman_tasks_core.rb
+- lib/foreman_tasks_core/batch_action.rb
+- lib/foreman_tasks_core/batch_callback_action.rb
+- lib/foreman_tasks_core/batch_runner_action.rb
 - lib/foreman_tasks_core/continuous_output.rb
 - lib/foreman_tasks_core/otp_manager.rb
+- lib/foreman_tasks_core/output_collector_action.rb
 - lib/foreman_tasks_core/runner.rb
 - lib/foreman_tasks_core/runner/action.rb
 - lib/foreman_tasks_core/runner/base.rb
+- lib/foreman_tasks_core/runner/command.rb
 - lib/foreman_tasks_core/runner/command_runner.rb
 - lib/foreman_tasks_core/runner/dispatcher.rb
 - lib/foreman_tasks_core/runner/parent.rb
 - lib/foreman_tasks_core/runner/update.rb
 - lib/foreman_tasks_core/settings_loader.rb
 - lib/foreman_tasks_core/shareable_action.rb
+- lib/foreman_tasks_core/single_runner_batch_action.rb
 - lib/foreman_tasks_core/task_launcher.rb
 - lib/foreman_tasks_core/task_launcher/abstract.rb
 - lib/foreman_tasks_core/task_launcher/batch.rb
+- lib/foreman_tasks_core/task_launcher/group.rb
 - lib/foreman_tasks_core/task_launcher/single.rb
 - lib/foreman_tasks_core/ticker.rb
 - lib/foreman_tasks_core/version.rb