foreman-tasks 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e52c285f1d8c6c98cc334d7d1028b190cebca6ea
-  data.tar.gz: 3d924a2162dfa1085a7d22c470184c0b5cebed61
+  metadata.gz: b55e0faa2c0c85d85d432c28bd50b9fea076a338
+  data.tar.gz: eb3840f629fe5b52380423e0ca0821f7d1562f95
 SHA512:
-  metadata.gz: f8f42b585c90c6a2b5af2f57022a0bc8bd8c87367007f7dede5ed39c37431cdc84d553de1c3fb0e1876d34b667f31445e9f6afa191b85346e7ac92cad1ac4e21
-  data.tar.gz: 4397ef5b4c91c7598eb67edd6591341d44b725a955b2d048505e06c34a02d7ca3c670949fe7e196c6aa5963e667ef41fdf18a7ca71bdcda5af9baddb76ee7bc4
+  metadata.gz: ddb0a9efe1b688fd922970c6ba03a7ee39518221696c553428d00946ec27ac56bd356b788b808317ce5b6caa346fe2bc830f04c36991ea5cf413ade2e5e4c95c
+  data.tar.gz: 05b76b8b00ea367e193d30b404ef17b824f890ca362938b680bc3a55beb7f3162b21c1221859beb613abde70241312b9419d3e23c1bef9b4c12ad4e4a63445da

data/foreman-tasks.gemspec

@@ -20,7 +20,9 @@ same resource. It also optionally provides Dynflow infrastructure for using it f
 DESC
 
   s.files = `git ls-files`.split("\n").reject do |file|
-    file.end_with? "test.rake"
+    file.end_with?("test.rake") ||
+        file.start_with?('lib/foreman_tasks_core') ||
+        file == 'foreman-tasks-core.gemspec'
   end
 
   s.test_files = `git ls-files test`.split("\n")

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = "0.8.1"
+  VERSION = "0.8.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-07 00:00:00.000000000 Z
+date: 2016-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreman-tasks-core
@@ -204,7 +204,6 @@ files:
 - deploy/foreman-tasks.service
 - deploy/foreman-tasks.sysconfig
 - extra/dynflow-executor.example
-- foreman-tasks-core.gemspec
 - foreman-tasks.gemspec
 - lib/foreman-tasks.rb
 - lib/foreman_tasks.rb
@@ -223,17 +222,6 @@ files:
 - lib/foreman_tasks/test_extensions.rb
 - lib/foreman_tasks/triggers.rb
 - lib/foreman_tasks/version.rb
-- 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
 - lib/tasks/gettext.rake
 - locale/Makefile
 - locale/action_names.rb

data/foreman-tasks-core.gemspec

@@ -1,20 +0,0 @@
-# -*- coding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-
-# Maintain your gem's version:
-require "foreman_tasks_core/version"
-
-# Describe your gem and declare its dependencies:
-Gem::Specification.new do |s|
-  s.name        = "foreman-tasks-core"
-  s.version     = ForemanTasksCore::VERSION
-  s.authors     = ["Ivan Nečas"]
-  s.email       = ["inecas@redhat.com"]
-  s.homepage    = "https://github.com/theforeman/foreman-tasks"
-  s.summary     = "Common code used both at Forman and Foreman proxy regarding tasks"
-  s.description = <<DESC
-Common code used both at Forman and Foreman proxy regarding tasks
-DESC
-
-  s.files = Dir['lib/foreman_tasks_core/**/*'] + ['lib/foreman_tasks_core.rb']
-end

data/lib/foreman_tasks_core.rb

@@ -1,19 +0,0 @@
-# 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

data/lib/foreman_tasks_core/continuous_output.rb

@@ -1,50 +0,0 @@
-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.rb

@@ -1,9 +0,0 @@
-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/runner/action.rb

@@ -1,69 +0,0 @@
-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

@@ -1,60 +0,0 @@
-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

@@ -1,41 +0,0 @@
-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

@@ -1,158 +0,0 @@
-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

@@ -1,21 +0,0 @@
-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/settings_loader.rb

@@ -1,53 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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

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