foreman-tasks-core 0.3.2 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c036a816a81a10ce427600ce920c1aa98c59bb2c317dcba1662f906941d00e0
-  data.tar.gz: 3e74db375442e42f0ad7e7f5887d1cd5ab79b311d86c1389f24fb5d168146a70
+  metadata.gz: 774254a2eeb7a396c3035410552edc56882d54a1b96a9a800c726f6db96951b8
+  data.tar.gz: 53221a9224ebd106fe67d5c2d51f681d601eb1c1f40a50b88b05b900644edb13
 SHA512:
-  metadata.gz: 7c68ff530abb93733509feb1201d74c7588b1edc3e90c6caf2fd54fce11aedeb760595c2ce3fcf8f208fe5eafbc7bca00aecec08ee4b28d0b1e438c6b81938d1
-  data.tar.gz: f1e5baa029323687099e055874464d1710ddbcc8488207fcb64bdc5f5682ff90311c8db6fbf5ce6eb372a4d9eb821df51ac26a5e151bbc6d4551983a896e6f82
+  metadata.gz: 186a69b1cae292b820cf97834139ad447b0a8dc75376b2fe9cd1b7c2f70e48b63504e5a2589b2e483cbc7021f18ece002e8995fe80f3892b4b44174a2cbb4999
+  data.tar.gz: 7d9f89140bfe0000b59c42704ed3b5fb16f5645b5bd5ecb95e0aa446c34b93678a575390cdabdd6afe29bf22edfa8f226d3f1810a8f0a928d22f434562abd44c

data/lib/foreman_tasks_core/otp_manager.rb

@@ -17,10 +17,15 @@ module ForemanTasksCore
         @password ||= {}
       end
 
-      def authenticate(hash)
+      def authenticate(hash, expected_user: nil, clear: true)
         plain = Base64.decode64(hash)
         username, otp = plain.split(':', 2)
-        drop_otp(username, otp)
+        if expected_user
+          return false unless expected_user == username
+        end
+        password_matches = passwords[username] == otp
+        passwords.delete(username) if clear && password_matches
+        password_matches
       end
 
       def tokenize(username, password)

data/lib/foreman_tasks_core/runner/base.rb

@@ -22,6 +22,13 @@ module ForemanTasksCore
         generate_updates
       end
 
+      # by default, external event just causes the refresh to be triggered: this allows the descendants
+      # of the Base to add custom logic to process the external events.
+      # Similarly as `run_refresh`, it's expected to return updates to be dispatched.
+      def external_event(_event)
+        run_refresh
+      end
+
       def start
         raise NotImplementedError
       end
@@ -69,10 +76,18 @@ module ForemanTasksCore
       end
 
       def generate_updates
-        return {} if @continuous_output.empty? && @exit_status.nil?
+        return no_update if @continuous_output.empty? && @exit_status.nil?
         new_data = @continuous_output
         @continuous_output = ForemanTasksCore::ContinuousOutput.new
-        { @suspended_action => Runner::Update.new(new_data, @exit_status) }
+        new_update(new_data, @exit_status)
+      end
+
+      def no_update
+        {}
+      end
+
+      def new_update(data, exit_status)
+        { @suspended_action => Runner::Update.new(data, exit_status) }
       end
 
       def initialize_continuous_outputs

data/lib/foreman_tasks_core/runner/dispatcher.rb

@@ -37,17 +37,19 @@ module ForemanTasksCore
 
         def refresh_runner
           @logger.debug("refresh runner #{@runner.id}")
-          updates = @runner.run_refresh
+          dispatch_updates(@runner.run_refresh)
+        ensure
+          @refresh_planned = false
+          plan_next_refresh
+        end
 
+        def dispatch_updates(updates)
           updates.each { |receiver, update| (receiver || @suspended_action) << update }
 
           # This is a workaround when the runner does not accept the suspended action
           main_key = updates.keys.any?(&:nil?) ? nil : @suspended_action
           main_process = updates[main_key]
           finish if main_process && main_process.exit_status
-        ensure
-          @refresh_planned = false
-          plan_next_refresh
         end
 
         def timeout_runner
@@ -77,8 +79,8 @@ module ForemanTasksCore
           finish_termination
         end
 
-        def external_event(_event)
-          refresh_runner
+        def external_event(event)
+          dispatch_updates(@runner.external_event(event))
         end
 
         private
@@ -118,39 +120,33 @@ module ForemanTasksCore
 
       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
+          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
 
       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
+          runner_actor = @runner_actors[runner_id]
+          runner_actor.tell(:kill) if runner_actor
+        rescue => exception
+          _handle_command_exception(runner_id, exception, false)
         end
       end
 
       def finish(runner_id)
         synchronize do
-          begin
-            _finish(runner_id)
-          rescue => exception
-            _handle_command_exception(runner_id, exception, false)
-          end
+          _finish(runner_id)
+        rescue => exception
+          _handle_command_exception(runner_id, exception, false)
         end
       end
 

data/lib/foreman_tasks_core/runner/parent.rb

@@ -10,21 +10,19 @@ module ForemanTasksCore
       end
 
       def generate_updates
-        @outputs.reduce({}) do |acc, (key, value)|
-          if value.empty? && @exit_status.nil?
-            acc
-          else
-            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
+        base = {}
+        base[@suspended_action] = Runner::Update.new(ForemanTasksCore::ContinuousOutput.new, @exit_status) if @exit_status
+        # Operate on all hosts if the main process ended or only on hosts for which we have updates
+        @outputs.reject { |_, output| @exit_status.nil? && output.empty? }
+                .reduce(base) do |acc, (identifier, output)|
+                  @outputs[identifier] = ForemanTasksCore::ContinuousOutput.new # Create a new ContinuousOutput for next round of updates
+                  exit_status = @exit_statuses[identifier] || @exit_status if @exit_status
+                  acc.merge(host_action(identifier) => Runner::Update.new(output, exit_status))
+                end
       end
 
       def initialize_continuous_outputs
-        @outputs = ([@suspended_action] + @targets.keys).reduce({}) do |acc, target|
+        @outputs = @targets.keys.reduce({}) do |acc, target|
           acc.merge(target => ForemanTasksCore::ContinuousOutput.new)
         end
       end
@@ -39,8 +37,8 @@ module ForemanTasksCore
         @outputs.each { |_k, output| output.add_output(data, type) }
       end
 
-      def publish_data(data, type)
-        @outputs[@suspended_action].add_output(data, type)
+      def publish_data(_data, _type)
+        true
       end
 
       def publish_data_for(identifier, data, type)

data/lib/foreman_tasks_core/task_launcher/group.rb

@@ -40,7 +40,8 @@ module ForemanTasksCore
       end
 
       def wipe_callback(input)
-        input.merge('action_input' => input['action_input'].merge('callback' => nil))
+        callback = input['action_input']['callback']
+        input.merge('action_input' => input['action_input'].merge('callback' => nil, :task_id => callback['task_id']))
       end
     end
   end

data/lib/foreman_tasks_core/ticker.rb

@@ -1,3 +1,5 @@
+require 'dynflow'
+
 module ForemanTasksCore
   class Ticker < ::Dynflow::Actor
     attr_reader :clock

data/lib/foreman_tasks_core/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks-core
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.6
 platform: ruby
 authors:
 - Ivan Nečas
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-09 00:00:00.000000000 Z
+date: 2021-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dynflow
@@ -26,7 +26,7 @@ dependencies:
         version: 1.2.0
 description: 'Common code used both at Forman and Foreman proxy regarding tasks
 
-'
+  '
 email:
 - inecas@redhat.com
 executables: []
@@ -60,9 +60,10 @@ files:
 - lib/foreman_tasks_core/ticker.rb
 - lib/foreman_tasks_core/version.rb
 homepage: https://github.com/theforeman/foreman-tasks
-licenses: []
+licenses:
+- GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -77,9 +78,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Common code used both at Forman and Foreman proxy regarding tasks
 test_files: []