smart_proxy_dynflow 0.2.2 → 0.5.0

data/lib/smart_proxy_dynflow/settings.rb

@@ -0,0 +1,9 @@
+# require 'ostruct'
+
+module Proxy::Dynflow
+  class Settings
+    def self.instance
+      Proxy::Dynflow::Plugin.settings
+    end
+  end
+end

data/lib/smart_proxy_dynflow/settings_loader.rb

@@ -0,0 +1,53 @@
+module Proxy::Dynflow
+  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/smart_proxy_dynflow/task_launcher.rb

@@ -0,0 +1,9 @@
+module Proxy::Dynflow
+  module TaskLauncher
+  end
+end
+
+require 'smart_proxy_dynflow/task_launcher/abstract'
+require 'smart_proxy_dynflow/task_launcher/single'
+require 'smart_proxy_dynflow/task_launcher/batch'
+require 'smart_proxy_dynflow/task_launcher/group'

data/lib/smart_proxy_dynflow/task_launcher/abstract.rb

@@ -0,0 +1,44 @@
+module Proxy::Dynflow
+  module TaskLauncher
+    class Abstract
+      attr_reader :callback, :options, :results, :world
+      def initialize(world, callback, options = {})
+        @world = world
+        @callback = callback
+        @options = options
+        @results = {}
+      end
+
+      def launch!(_input)
+        raise NotImplementedError
+      end
+
+      def self.input_format; end
+
+      private
+
+      def format_result(result)
+        if result.triggered?
+          { :result => 'success', :task_id => result.execution_plan_id }
+        else
+          plan = world.persistence.load_execution_plan(result.id)
+          { :result => 'error', :errors => plan.errors }
+        end
+      end
+
+      def action_class(input)
+        options[:action_class_override] || ::Dynflow::Utils.constantize(input['action_class'])
+      end
+
+      def with_callback(input)
+        input.merge(:callback_host => callback)
+      end
+
+      def trigger(parent, klass, *input)
+        world.trigger do
+          world.plan_with_options(caller_action: parent, action_class: klass, args: input)
+        end
+      end
+    end
+  end
+end

data/lib/smart_proxy_dynflow/task_launcher/batch.rb

@@ -0,0 +1,37 @@
+module Proxy::Dynflow
+  module TaskLauncher
+    class Batch < Abstract
+      def launch!(input)
+        trigger(nil, Proxy::Dynflow::Action::Batch, self, input)
+      end
+
+      def launch_children(parent, input_hash)
+        input_hash.each do |task_id, 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/smart_proxy_dynflow/task_launcher/group.rb

@@ -0,0 +1,48 @@
+require 'smart_proxy_dynflow/runner'
+
+module Proxy::Dynflow
+  module TaskLauncher
+    class AbstractGroup < Batch
+      def self.runner_class
+        raise NotImplementedError
+      end
+
+      def launch!(input)
+        trigger(nil, Action::SingleRunnerBatch, self, input)
+      end
+
+      def launch_children(parent, input_hash)
+        super(parent, input_hash)
+        trigger(parent, Action::BatchRunner, 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 => Action::OutputCollector)
+      end
+
+      def transform_input(input)
+        wipe_callback(input)
+      end
+
+      def wipe_callback(input)
+        callback = input['action_input']['callback']
+        input.merge('action_input' => input['action_input'].merge('callback' => nil, :task_id => callback['task_id']))
+      end
+    end
+  end
+end

data/lib/smart_proxy_dynflow/task_launcher/single.rb

@@ -0,0 +1,17 @@
+module Proxy::Dynflow
+  module TaskLauncher
+    class Single < Abstract
+      def self.input_format
+        { :action_class => "MyActionClass", :action_input => {} }
+      end
+
+      def launch!(input)
+        triggered = trigger(options[:parent],
+                            action_class(input),
+                            with_callback(input.fetch('action_input', {})))
+        @results = format_result(triggered)
+        triggered
+      end
+    end
+  end
+end

data/lib/smart_proxy_dynflow/task_launcher_registry.rb

@@ -0,0 +1,31 @@
+module Proxy::Dynflow
+  class TaskLauncherRegistry
+    class << self
+      def register(name, launcher)
+        registry[name] = launcher
+      end
+
+      def fetch(name, default = nil)
+        if default.nil?
+          registry.fetch(name)
+        else
+          registry.fetch(name, default)
+        end
+      end
+
+      def key?(name)
+        registry.key?(name)
+      end
+
+      def operations
+        registry.keys
+      end
+
+      private
+
+      def registry
+        @registry ||= {}
+      end
+    end
+  end
+end

data/lib/smart_proxy_dynflow/testing.rb

@@ -0,0 +1,24 @@
+require 'dynflow/testing'
+
+unless defined? DYNFLOW_TESTING_LOG_LEVEL
+  DYNFLOW_TESTING_LOG_LEVEL = 4
+end
+
+module Proxy::Dynflow
+  # Helper for usage in other dependent plugins that need Dynflow
+  # related things, such as testing instance of world etc.
+  module Testing
+    class << self
+      def create_world(&block)
+        Core.ensure_initialized
+        Core.instance.create_world do |config|
+          config.exit_on_terminate = false
+          config.auto_terminate    = false
+          config.logger_adapter    = ::Dynflow::LoggerAdapters::Simple.new $stderr, DYNFLOW_TESTING_LOG_LEVEL
+          config.execution_plan_cleaner = nil
+          yield(config) if block
+        end
+      end
+    end
+  end
+end

data/lib/smart_proxy_dynflow/ticker.rb

@@ -0,0 +1,47 @@
+require 'dynflow'
+
+module Proxy::Dynflow
+  class Ticker < ::Dynflow::Actor
+    attr_reader :clock
+
+    def initialize(clock, logger, refresh_interval)
+      @clock = clock
+      @logger = logger
+      @events = []
+      @refresh_interval = refresh_interval
+      plan_next_tick
+    end
+
+    def tick
+      @logger.debug("Ticker ticking for #{@events.size} events")
+      @events.each do |(target, args)|
+        pass_event(target, args)
+      end
+      @events = []
+    ensure
+      @planned = false
+      plan_next_tick
+    end
+
+    def add_event(target, args)
+      @events << [target, args]
+      plan_next_tick
+    end
+
+    private
+
+    def pass_event(target, args)
+      target.tell(args)
+    rescue => e
+      @logger.error("Failed passing event to #{target} with #{args}")
+      @logger.error(e)
+    end
+
+    def plan_next_tick
+      if !@planned && !@events.empty?
+        @clock.ping(reference, Time.now.getlocal + @refresh_interval, :tick)
+        @planned = true
+      end
+    end
+  end
+end

data/lib/smart_proxy_dynflow/version.rb

@@ -1,5 +1,5 @@
 module Proxy
-  class Dynflow
-    VERSION = '0.2.2'.freeze
+  module Dynflow
+    VERSION = '0.5.0'.freeze
   end
 end

data/settings.d/dynflow.yml.example

@@ -1,4 +1,10 @@
 ---
 :enabled: true
 :database: /var/lib/foreman-proxy/dynflow/dynflow.sqlite
-:core_url: 'http://127.0.0.1:8008'
+
+# Require a valid cert to access Dynflow console
+# :console_auth: true
+
+# Maximum age of execution plans to keep before having them cleaned
+# by the execution plan cleaner (in seconds), defaults to 24 hours
+# :execution_plan_cleaner_age: 86400

metadata

@@ -1,27 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_dynflow
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Ivan Nečas
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-08 00:00:00.000000000 Z
+date: 2021-06-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
@@ -105,37 +119,65 @@ files:
 - LICENSE
 - bundler.plugins.d/dynflow.rb
 - lib/smart_proxy_dynflow.rb
+- lib/smart_proxy_dynflow/action.rb
+- lib/smart_proxy_dynflow/action/batch.rb
+- lib/smart_proxy_dynflow/action/batch_callback.rb
+- lib/smart_proxy_dynflow/action/batch_runner.rb
+- lib/smart_proxy_dynflow/action/output_collector.rb
+- lib/smart_proxy_dynflow/action/runner.rb
+- lib/smart_proxy_dynflow/action/shareable.rb
+- lib/smart_proxy_dynflow/action/single_runner_batch.rb
 - lib/smart_proxy_dynflow/api.rb
 - lib/smart_proxy_dynflow/callback.rb
+- lib/smart_proxy_dynflow/continuous_output.rb
+- lib/smart_proxy_dynflow/core.rb
 - lib/smart_proxy_dynflow/helpers.rb
 - lib/smart_proxy_dynflow/http_config.ru
-- lib/smart_proxy_dynflow/http_config_with_executor.ru
+- lib/smart_proxy_dynflow/log.rb
+- lib/smart_proxy_dynflow/middleware/keep_current_request_id.rb
+- lib/smart_proxy_dynflow/otp_manager.rb
 - lib/smart_proxy_dynflow/plugin.rb
 - lib/smart_proxy_dynflow/proxy_adapter.rb
+- lib/smart_proxy_dynflow/runner.rb
+- lib/smart_proxy_dynflow/runner/base.rb
+- lib/smart_proxy_dynflow/runner/command.rb
+- lib/smart_proxy_dynflow/runner/command_runner.rb
+- lib/smart_proxy_dynflow/runner/dispatcher.rb
+- lib/smart_proxy_dynflow/runner/parent.rb
+- lib/smart_proxy_dynflow/runner/update.rb
+- lib/smart_proxy_dynflow/settings.rb
+- lib/smart_proxy_dynflow/settings_loader.rb
+- lib/smart_proxy_dynflow/task_launcher.rb
+- lib/smart_proxy_dynflow/task_launcher/abstract.rb
+- lib/smart_proxy_dynflow/task_launcher/batch.rb
+- lib/smart_proxy_dynflow/task_launcher/group.rb
+- lib/smart_proxy_dynflow/task_launcher/single.rb
+- lib/smart_proxy_dynflow/task_launcher_registry.rb
+- lib/smart_proxy_dynflow/testing.rb
+- lib/smart_proxy_dynflow/ticker.rb
 - lib/smart_proxy_dynflow/version.rb
 - settings.d/dynflow.yml.example
 homepage: https://github.com/theforeman/smart_proxy_dynflow
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Dynflow runtime for Foreman smart proxy
 test_files: []