foreman-tasks-core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a8b2eaeb4519b3538cd8d76919d5ce6d0adb43a
+  data.tar.gz: 51c3e5a7c71129c8104f6fc753c8db0d090fc2d8
+SHA512:
+  metadata.gz: 5214dcc03b6e1a2be518bb29eac25e6158adc6e90b21798622ff1f5e2e3a8aa6c74907a769566e4564669ee846c66996ff2803e7f3055beb229c2946d5f7d663
+  data.tar.gz: 0ad9eac594955242b38937ebd6e4217dfa447f26bda5f81c456fa2dec4e6e3500f19b0cc1834a82555b18caa7976ceb0e032662142491f25d71793c95264f074

data/lib/foreman_tasks_core/continuous_output.rb

@@ -0,0 +1,50 @@
+module ForemanTasksCore
+  class ContinuousOutput
+    attr_accessor :raw_outputs
+
+    def initialize(raw_outputs = [])
+      @raw_outputs = []
+      raw_outputs.each { |raw_output| add_raw_output(raw_output) }
+    end
+
+    def add_raw_output(raw_output)
+      missing_args = %w[output_type output timestamp] - raw_output.keys
+      unless missing_args.empty?
+        raise ArgumentError, "Missing args for raw output: #{missing_args.inspect}"
+      end
+      @raw_outputs << raw_output
+    end
+
+    def empty?
+      @raw_outputs.empty?
+    end
+
+    def last_timestamp
+      return if @raw_outputs.empty?
+      @raw_outputs.last.fetch('timestamp')
+    end
+
+    def sort!
+      @raw_outputs.sort_by! { |record| record['timestamp'].to_f }
+    end
+
+    def humanize
+      sort!
+      raw_outputs.map { |output| output['output'] }.join("\n")
+    end
+
+    def add_exception(context, exception, timestamp = Time.now.getlocal)
+      add_output(context + ": #{exception.class} - #{exception.message}", 'debug', timestamp)
+    end
+
+    def add_output(*args)
+      add_raw_output(self.class.format_output(*args))
+    end
+
+    def self.format_output(message, type = 'debug', timestamp = Time.now.getlocal)
+      { 'output_type' => type,
+        'output' => message,
+        'timestamp' => timestamp.to_f }
+    end
+  end
+end

data/lib/foreman_tasks_core/runner/action.rb

@@ -0,0 +1,69 @@
+require 'foreman_tasks_core/shareable_action'
+module ForemanTasksCore
+  module Runner
+    class Action < ::ForemanTasksCore::ShareableAction
+      include ::Dynflow::Action::Cancellable
+
+      def run(event = nil)
+        case event
+        when nil
+          init_run
+        when Runner::Update
+          process_update(event)
+        when ::Dynflow::Action::Cancellable::Cancel
+          kill_run
+        else
+          raise "Unexpected event #{event.inspect}"
+        end
+      rescue => e
+        action_logger.error(e)
+        process_update(Runner::Update.encode_exception("Proxy error", e))
+      end
+
+      def finalize
+        # To mark the task as a whole as failed
+        error! "Script execution failed" if failed_run?
+      end
+
+      def rescue_strategy_for_self
+        ::Dynflow::Action::Rescue::Fail
+      end
+
+      def initiate_runner
+        raise NotImplementedError
+      end
+
+      def init_run
+        output[:result] = []
+        output[:runner_id] = runner_dispatcher.start(suspended_action, initiate_runner)
+        suspend
+      end
+
+      def runner_dispatcher
+        Runner::Dispatcher.instance
+      end
+
+      def kill_run
+        runner_dispatcher.kill(output[:runner_id])
+        suspend
+      end
+
+      def finish_run(update)
+        output[:exit_status] = update.exit_status
+      end
+
+      def process_update(update)
+        output[:result].concat(update.continuous_output.raw_outputs)
+        if update.exit_status
+          finish_run(update)
+        else
+          suspend
+        end
+      end
+
+      def failed_run?
+        output[:exit_status] != 0
+      end
+    end
+  end
+end

data/lib/foreman_tasks_core/runner/base.rb

@@ -0,0 +1,60 @@
+module ForemanTasksCore
+  module Runner
+    # Runner is an object that is able to initiate some action and
+    # provide update data on refresh call.
+    class Base
+      attr_reader :id
+      attr_accessor :logger
+
+      def initialize(*args)
+        @id = SecureRandom.uuid
+        @continuous_output = ::ForemanTasksCore::ContinuousOutput.new
+      end
+
+      def logger
+        @logger ||= Logger.new(STDERR)
+      end
+
+      def run_refresh
+        logger.debug("refreshing runner")
+        refresh
+        new_data = @continuous_output
+        @continuous_output = ForemanTasksCore::ContinuousOutput.new
+        if !new_data.empty? || @exit_status
+          return Runner::Update.new(new_data, @exit_status)
+        end
+      end
+
+      def start
+        raise NotImplementedError
+      end
+
+      def refresh
+        raise NotImplementedError
+      end
+
+      def kill
+        # Override when you can kill the runner in the middle
+      end
+
+      def close
+        # if cleanup is needed
+      end
+
+      def publish_data(data, type)
+        @continuous_output.add_output(data, type)
+      end
+
+      def publish_exception(context, exception, fatal = true)
+        logger.error("#{context} - #{exception.class} #{exception.message}:\n" + \
+                     exception.backtrace.join("\n"))
+        @continuous_output.add_exception(context, exception)
+        publish_exit_status('EXCEPTION') if fatal
+      end
+
+      def publish_exit_status(status)
+        @exit_status = status
+      end
+    end
+  end
+end

data/lib/foreman_tasks_core/runner/command_runner.rb

@@ -0,0 +1,41 @@
+require 'io/wait'
+require 'pty'
+
+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($?.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/dispatcher.rb

@@ -0,0 +1,158 @@
+module ForemanTasksCore
+  module Runner
+    class Dispatcher
+      def self.instance
+        return @instance if @instance
+        @instance = self.new(ForemanTasksCore.dynflow_world.clock,
+                             ForemanTasksCore.dynflow_world.logger)
+      end
+
+      class RunnerActor < ::Dynflow::Actor
+        def initialize(dispatcher, suspended_action, runner, clock, logger, options = {})
+          @dispatcher = dispatcher
+          @clock = clock
+          @logger = logger
+          @suspended_action = suspended_action
+          @runner = runner
+          @finishing = false
+          @refresh_interval = options[:refresh_interval] || 1
+        end
+
+        def on_envelope(*args)
+          super
+        rescue => e
+          handle_exception(e)
+        end
+
+        def start_runner
+          @logger.debug("start runner #{@runner.id}")
+          @runner.start
+          refresh_runner
+        ensure
+          plan_next_refresh
+        end
+
+        def refresh_runner
+          @logger.debug("refresh runner #{@runner.id}")
+          if update = @runner.run_refresh
+            @suspended_action << update
+            finish if update.exit_status
+          end
+        ensure
+          @refresh_planned = false
+          plan_next_refresh
+        end
+
+        def kill
+          @logger.debug("kill runner #{@runner.id}")
+          @runner.kill
+        rescue => e
+          handle_exception(e, false)
+        end
+
+        def finish
+          @logger.debug("finish runner #{@runner.id}")
+          @finishing = true
+          @dispatcher.finish(@runner.id)
+        end
+
+        def start_termination(*args)
+          @logger.debug("terminate #{@runner.id}")
+          super
+          @runner.close
+          finish_termination
+        end
+
+        private
+
+        def plan_next_refresh
+          if !@finishing && !@refresh_planned
+            @logger.debug("planning to refresh #{@runner.id}")
+            @clock.ping(reference, Time.now + @refresh_interval, :refresh_runner)
+            @refresh_planned = true
+          end
+        end
+
+        def handle_exception(exception, fatal = true)
+          @dispatcher.handle_command_exception(@runner.id, exception, fatal)
+        end
+      end
+
+      def initialize(clock, logger)
+        @mutex = Mutex.new
+        @clock = clock
+        @logger = logger
+        @runner_actors = {}
+        @runner_suspended_actions = {}
+      end
+
+      def synchronize(&block)
+        @mutex.synchronize(&block)
+      end
+
+      def start(suspended_action, runner)
+        synchronize do
+          begin
+            raise "Actor with runner id #{runner.id} already exists" if @runner_actors[runner.id]
+            runner.logger = @logger
+            runner_actor = RunnerActor.spawn("runner-actor-#{runner.id}", self, suspended_action, runner, @clock, @logger)
+            @runner_actors[runner.id] = runner_actor
+            @runner_suspended_actions[runner.id] = suspended_action
+            runner_actor.tell(:start_runner)
+            return runner.id
+          rescue => exception
+            _handle_command_exception(runner.id, exception)
+            return nil
+          end
+        end
+      end
+
+      def kill(runner_id)
+        synchronize do
+          begin
+            runner_actor = @runner_actors[runner_id]
+            runner_actor.tell(:kill) if runner_actor
+          rescue => exception
+            _handle_command_exception(runner_id, exception, false)
+          end
+        end
+      end
+
+      def finish(runner_id)
+        synchronize do
+          begin
+            _finish(runner_id)
+          rescue => exception
+            _handle_command_exception(runner_id, exception, false)
+          end
+        end
+      end
+
+      def handle_command_exception(*args)
+        synchronize { _handle_command_exception(*args) }
+      end
+
+      private
+
+      def _finish(runner_id)
+        runner_actor = @runner_actors.delete(runner_id)
+        return unless runner_actor
+        @logger.debug("closing session for command [#{runner_id}]," +
+                      "#{@runner_actors.size} actors left ")
+        runner_actor.tell([:start_termination, Concurrent.future])
+      ensure
+        @runner_suspended_actions.delete(runner_id)
+      end
+
+      def _handle_command_exception(runner_id, exception, fatal = true)
+        @logger.error("error while dispatching request to runner #{runner_id}:"\
+                      "#{exception.class} #{exception.message}:\n #{exception.backtrace.join("\n")}")
+        suspended_action = @runner_suspended_actions[runner_id]
+        if suspended_action
+          suspended_action << Runner::Update.encode_exception("Runner error", exception, fatal)
+        end
+        _finish(runner_id) if fatal
+      end
+    end
+  end
+end

data/lib/foreman_tasks_core/runner/update.rb

@@ -0,0 +1,21 @@
+require 'foreman_tasks_core/continuous_output'
+
+module ForemanTasksCore
+  module Runner
+    # Runner::Update represents chunk of data produced by runner that
+    # can be consumed by other components, such as RunnerAction
+    class Update
+      attr_reader :continuous_output, :exit_status
+      def initialize(continuous_output, exit_status)
+        @continuous_output = continuous_output
+        @exit_status = exit_status
+      end
+
+      def self.encode_exception(context, exception, fatal = true)
+        continuous_output = ::ForemanTasksCore::ContinuousOutput.new
+        continuous_output.add_exception(context, exception)
+        return self.new(continuous_output, fatal ? 'EXCEPTION' : nil)
+      end
+    end
+  end
+end

data/lib/foreman_tasks_core/runner.rb

@@ -0,0 +1,9 @@
+module ForemanTasksCore
+  module Runner
+  end
+end
+
+require 'foreman_tasks_core/runner/update'
+require 'foreman_tasks_core/runner/base'
+require 'foreman_tasks_core/runner/dispatcher'
+require 'foreman_tasks_core/runner/action'

data/lib/foreman_tasks_core/settings_loader.rb

@@ -0,0 +1,53 @@
+module ForemanTasksCore
+  module SettingsLoader
+    def self.settings_registry
+      @settings_registry ||= {}
+    end
+
+    def self.name_to_settings
+      @name_to_settings ||= {}
+    end
+
+    def self.settings_keys
+      @settings_keys ||= []
+    end
+
+    def self.settings_registered?(name)
+      name_to_settings.key?(name)
+    end
+
+    def self.register_settings(names, object)
+      names = [names] unless names.is_a? Array
+      names.each do |name|
+        raise "settings name has to be a symbol" unless name.is_a? Symbol
+        raise "settings #{name} already registered" if SettingsLoader.settings_registered?(name)
+        name_to_settings[name] = object
+      end
+      settings_registry[names] = object
+    end
+
+    def self.setup_settings(name, settings)
+      raise "Settings for #{name} were not registered" unless settings_registered?(name)
+      name_to_settings[name].initialize_settings(settings)
+    end
+
+    def register_settings(names, defaults = {})
+      SettingsLoader.register_settings(names, self)
+      @defaults = defaults
+    end
+
+    def initialize_settings(settings = {})
+      @settings = @defaults.merge(settings)
+      validate_settings!
+    end
+
+    def settings
+      raise "Settings for #{self} not initalized" unless @settings
+      @settings
+    end
+
+    def validate_settings!
+      raise "Only symbols expected in keys" unless @settings.keys.all? { |key| key.is_a? Symbol }
+    end
+  end
+end

data/lib/foreman_tasks_core/shareable_action.rb

@@ -0,0 +1,19 @@
+module ForemanTasksCore
+  class ShareableAction < ::Dynflow::Action
+    def plan(input)
+      input = input.dup
+      callback = input.delete('callback')
+      if callback
+        input[:task_id] = callback['task_id']
+      else
+        input[:task_id] ||= SecureRandom.uuid
+      end
+
+      planned_action = plan_self(input)
+      # code only applicable, when run with SmartProxyDynflowCore in place
+      if defined?(SmartProxyDynflowCore::Callback) && callback
+        plan_action(SmartProxyDynflowCore::Callback::Action, callback, planned_action.output)
+      end
+    end
+  end
+end

data/lib/foreman_tasks_core/version.rb

@@ -0,0 +1,3 @@
+module ForemanTasksCore
+  VERSION = '0.1.0'
+end

data/lib/foreman_tasks_core.rb

@@ -0,0 +1,19 @@
+# The goal of ForemanTasksCore is to collect parts of foreman-tasks
+# that can be shared by the Foreman server and Foreman proxy
+
+require 'foreman_tasks_core/settings_loader'
+
+module ForemanTasksCore
+  def self.dynflow_world
+    raise "Dynflow world not set. Call initialize first" unless @dynflow_world
+    @dynflow_world
+  end
+
+  def self.dynflow_present?
+    defined? Dynflow
+  end
+
+  def self.dynflow_setup(dynflow_world)
+    @dynflow_world = dynflow_world
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: foreman-tasks-core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Nečas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-07 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Common code used both at Forman and Foreman proxy regarding tasks
+email:
+- inecas@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/foreman_tasks_core.rb
+- lib/foreman_tasks_core/continuous_output.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_runner.rb
+- lib/foreman_tasks_core/runner/dispatcher.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/version.rb
+homepage: https://github.com/theforeman/foreman-tasks
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Common code used both at Forman and Foreman proxy regarding tasks
+test_files: []