foreman-tasks 0.14.6 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 675f98353547dd5b378bfe5055c60e976618b39754e4d46e0d361641ee8640e0
-  data.tar.gz: 2de7b22aaaacdb644d953e0aeb4c0e7ba6083e2f9650248baf021b78d0ff7474
+  metadata.gz: e29d69e4d1a7ad804db75f4ce19d20004bdebced6e85e04d2648bcb5c571c2b1
+  data.tar.gz: 50e6b2708a35731579806eaef2a13c83dee4c92244db7a1a8f73c712e565891a
 SHA512:
-  metadata.gz: bab26f5c355c09ea6d292e2b10fc011d41c769c91fa863985a89a43075d831b2115f5222c3f5c276054f09272fb39e4d03b9957dbb0d75a50b6a7025b4031e57
-  data.tar.gz: 2651f86adccfd7469c01268c7408115547e94e90723a752a9d047c59c4431204cbb606815b40245893ff8d142657cf65e7a493d063a20d89416fd7f0a917879d
+  metadata.gz: 311b48cc5a9cd2d8a502635f70a544b8e73fae9f7495148d67976f5e2ae0615c96ef7ca184b6992923e885abe942f0354e3f6ce0c76d0449f65099c1aede8077
+  data.tar.gz: f92ebcdad66e0f02ea0b3f27a954520792fe2e31a0057639fcec59e68658be686db75086c936aae6811b5ded4307cb9effccdec95e0554d7d7b047f6fb7d5762

data/app/controllers/foreman_tasks/api/tasks_controller.rb

@@ -21,7 +21,7 @@ module ForemanTasks
 
       api :GET, '/tasks/summary', 'Show task summary'
       def summary
-        render :json => ForemanTasks::Task::Summarizer.new(resource_scope).summarize_by_status
+        render :json => ForemanTasks::Task::Summarizer.new.summarize_by_status
       end
 
       api :GET, '/tasks/:id', 'Show task details'
@@ -160,7 +160,7 @@ module ForemanTasks
         ForemanTasks.dynflow.world.event(task.external_id,
                                          params[:callback][:step_id].to_i,
                                          # We need to call .to_unsafe_h to unwrap the hash from ActionController::Parameters
-                                         ::Actions::ProxyAction::CallbackData.new(params[:data].to_unsafe_h))
+                                         ::Actions::ProxyAction::CallbackData.new(params[:data].to_unsafe_h, :request_id => ::Logging.mdc['request']))
         render :json => { :message => 'processing' }.to_json
       end
 
@@ -248,7 +248,7 @@ module ForemanTasks
       end
 
       def find_task
-        @task = resource_scope.find(params[:id])
+        @task = Task.find(params[:id])
       end
 
       def resource_scope(_options = {})
@@ -257,7 +257,7 @@ module ForemanTasks
 
       def action_permission
         case params[:action]
-        when 'bulk_search', 'summary'
+        when 'bulk_search'
           :view
         when 'bulk_resume'
           :edit

data/app/controllers/foreman_tasks/tasks_controller.rb

@@ -6,7 +6,8 @@ module ForemanTasks
     before_action :restrict_dangerous_actions, :only => [:unlock, :force_unlock]
 
     def show
-      @task = resource_base.find(params[:id])
+      @task = Task.find(params[:id])
+      render :layout => !request.xhr?
     end
 
     def index
@@ -24,7 +25,7 @@ module ForemanTasks
     end
 
     def sub_tasks
-      task   = resource_base.find(params[:id])
+      task   = Task.find(params[:id])
       @tasks = filter(task.sub_tasks)
       render :index
     end
@@ -96,10 +97,6 @@ module ForemanTasks
       ForemanTasks::Task
     end
 
-    def auto_complete_controller_name
-      '/foreman_tasks/tasks'
-    end
-
     private
 
     def restrict_dangerous_actions

data/app/lib/actions/middleware/keep_current_request_id.rb

@@ -0,0 +1,59 @@
+module Actions
+  module Middleware
+    class KeepCurrentRequestID < Dynflow::Middleware
+      def delay(*args)
+        pass(*args).tap { store_current_request_id }
+      end
+
+      def plan(*args)
+        with_current_request_id do
+          pass(*args).tap { store_current_request_id }
+        end
+      end
+
+      def run(*args)
+        restore_current_request_id { pass(*args) }
+      end
+
+      def finalize
+        restore_current_request_id { pass }
+      end
+
+      # Run all execution plan lifecycle hooks as the original request_id
+      def hook(*args)
+        restore_current_request_id { pass(*args) }
+      end
+
+      private
+
+      def with_current_request_id
+        if action.input[:current_request_id].nil?
+          yield
+        else
+          restore_current_request_id { yield }
+        end
+      end
+
+      def store_current_request_id
+        action.input[:current_request_id] = ::Logging.mdc['request']
+      end
+
+      def restore_current_request_id
+        if (restored_id = action.input[:current_request_id]).present?
+          old_id = ::Logging.mdc['request']
+          if old_id.present? && old_id != restored_id
+            action.action_logger.warn(_('Changing request id %{request_id} to saved id %{saved_id}') % { :saved_id => restored_id, :request_id => old_id })
+          end
+          ::Logging.mdc['request'] = restored_id
+        end
+        yield
+      ensure
+        # Reset to original request id only when not nil
+        # Otherwise, keep the id until it's cleaned in  Dynflow's run_user_code block
+        # so that it will stay valid for the rest of the processing of the current step
+        # (even outside of the middleware lifecycle)
+        ::Logging.mdc['request'] = old_id if old_id.present?
+      end
+    end
+  end
+end

data/app/lib/actions/proxy_action.rb

@@ -8,10 +8,11 @@ module Actions
     execution_plan_hooks.use :wipe_secrets!, :on => :stopped
 
     class CallbackData
-      attr_reader :data
+      attr_reader :data, :meta
 
-      def initialize(data)
+      def initialize(data, meta = {})
         @data = data
+        @meta = meta
       end
     end
 
@@ -46,7 +47,7 @@ module Actions
         when ::Dynflow::Action::Cancellable::Abort
           abort_proxy_task
         when CallbackData
-          on_data(event.data)
+          on_data(event.data, event.meta)
         when ProxyActionMissing
           on_proxy_action_missing
         when ProxyActionStopped
@@ -106,7 +107,8 @@ module Actions
     end
 
     # @override to put custom logic on event handling
-    def on_data(data)
+    def on_data(data, meta = {})
+      action_logger.info(_('Event delivered by request %{request_id}') % { :request_id => meta[:request_id] }) if meta[:request_id].present?
       output[:proxy_output] = data
     end
 

data/app/lib/actions/recurring_action.rb

@@ -1,3 +1,5 @@
+require 'securerandom'
+
 module Actions
   module RecurringAction
     # When included sets the base action to use the RecurringLogic middleware and configures
@@ -10,11 +12,15 @@ module Actions
     # Hook to be called when a repetition needs to be triggered. This either happens when the plan goes into planned state
     #   or when it fails.
     def trigger_repeat(execution_plan)
+      request_id = ::Logging.mdc['request']
+      ::Logging.mdc['request'] = SecureRandom.uuid
       if execution_plan.delay_record && recurring_logic_task_group
         args = execution_plan.delay_record.args
         logic = recurring_logic_task_group.recurring_logic
         logic.trigger_repeat_after(task.start_at, self.class, *args)
       end
+    ensure
+      ::Logging.mdc['request'] = request_id
     end
 
     private

data/app/models/foreman_tasks/task/summarizer.rb

@@ -1,19 +1,15 @@
 module ForemanTasks
   class Task::Summarizer
-    def initialize(scope = Task.authorized)
-      @scope = scope
-    end
-
     def summarize_by_status(since = nil)
-      result = @scope.where("result <> 'success'")
-                     .select('count(state) AS count, state, result, max(started_at) AS started_at')
-                     .group(:state, :result).order(:state)
+      result = ::ForemanTasks::Task.where("result <> 'success'")
+                                   .select('count(state) AS count, state, result, max(started_at) AS started_at')
+                                   .group(:state, :result).order(:state)
       result = result.where('started_at > ?', since) if since
       result
     end
 
     def latest_tasks_in_errors_warning(limit = 5)
-      @scope.where('result in (?)', %w[error warning]).order('started_at DESC').limit(limit)
+      ::ForemanTasks::Task.where('result in (?)', %w[error warning]).order('started_at DESC').limit(limit)
     end
   end
 end

data/foreman-tasks.gemspec

@@ -29,7 +29,7 @@ same resource. It also optionally provides Dynflow infrastructure for using it f
   s.extra_rdoc_files = Dir['README*', 'LICENSE']
 
   s.add_dependency "foreman-tasks-core"
-  s.add_dependency "dynflow", '~> 1.0', '>= 1.1.5'
+  s.add_dependency "dynflow", '>= 1.2.1'
   s.add_dependency "sinatra" # for Dynflow web console
   s.add_dependency "parse-cron", '~> 0.1.4'
   s.add_dependency "get_process_mem" # for memory polling

data/lib/foreman_tasks/engine.rb

@@ -119,6 +119,7 @@ module ForemanTasks
         world.middleware.use Actions::Middleware::KeepCurrentTaxonomies
         world.middleware.use Actions::Middleware::KeepCurrentUser
         world.middleware.use Actions::Middleware::KeepCurrentTimezone
+        world.middleware.use Actions::Middleware::KeepCurrentRequestID
       end
 
       ::ForemanTasks.dynflow.config.on_init do |world|

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '0.14.6'.freeze
+  VERSION = '0.15.0'.freeze
 end

data/test/controllers/api/tasks_controller_test.rb

@@ -25,13 +25,6 @@ module ForemanTasks
           assert_response :missing
           assert_includes @response.body, 'Resource task not found by id'
         end
-
-        it 'does not show task the user is not allowed to see' do
-          setup_user('view', 'foreman_tasks', 'owner.id = current_user')
-          get :show, params: { id: FactoryBot.create(:some_task).id },
-                     session: set_session_user(User.current)
-          assert_response :not_found
-        end
       end
 
       describe 'GET /api/tasks/summary' do
@@ -48,41 +41,24 @@ module ForemanTasks
               suspend
             end
           end
-
-          def self.while_suspended
-            triggered = ForemanTasks.trigger(DummyTestSummaryAction, true)
-            wait_for { ForemanTasks::Task.find_by(external_id: triggered.id).state == 'running' }
-            wait_for do
-              w = ForemanTasks.dynflow.world
-              w.persistence.load_step(triggered.id, 2, w).state == :suspended
-            end
-            yield
-            ForemanTasks.dynflow.world.event(triggered.id, 2, nil)
-            triggered.finished.wait
-          end
         end
 
         test_attributes :pid => 'bdcab413-a25d-4fe1-9db4-b50b5c31ebce'
         it 'get tasks summary' do
-          DummyTestSummaryAction.while_suspended do
-            get :summary
-            assert_response :success
-            response = JSON.parse(@response.body)
-            assert_kind_of Array, response
-            assert_not response.empty?
-            assert_kind_of Hash, response[0]
-          end
-        end
-
-        it 'gets tasks summary only for tasks the user is allowed to see' do
-          DummyTestSummaryAction.while_suspended do
-            setup_user('view', 'foreman_tasks', 'owner.id = current_user')
-            get :summary
-            assert_response :success
-            response = JSON.parse(@response.body)
-            assert_kind_of Array, response
-            assert response.empty?
+          triggered = ForemanTasks.trigger(DummyTestSummaryAction, true)
+          wait_for { ForemanTasks::Task.find_by(external_id: triggered.id).state == 'running' }
+          wait_for do
+            w = ForemanTasks.dynflow.world
+            w.persistence.load_step(triggered.id, 2, w).state == :suspended
           end
+          get :summary
+          assert_response :success
+          response = JSON.parse(@response.body)
+          assert_kind_of Array, response
+          assert_not response.empty?
+          assert_kind_of Hash, response[0]
+          ForemanTasks.dynflow.world.event(triggered.id, 2, nil)
+          triggered.finished.wait
         end
       end
 

data/test/controllers/tasks_controller_test.rb

@@ -32,24 +32,6 @@ module ForemanTasks
         assert_include response.body.lines[1], 'Some action'
       end
 
-      describe 'show' do
-        it 'does not allow user without permissions to see task details' do
-          setup_user('view', 'foreman_tasks', 'owner.id = current_user')
-          get :show, params: { id: FactoryBot.create(:some_task).id },
-                     session: set_session_user(User.current)
-          assert_response :not_found
-        end
-      end
-
-      describe 'sub_tasks' do
-        it 'does not allow user without permissions to see task details' do
-          setup_user('view', 'foreman_tasks', 'owner.id = current_user')
-          get :sub_tasks, params: { id: FactoryBot.create(:some_task).id },
-                          session: set_session_user(User.current)
-          assert_response :not_found
-        end
-      end
-
       describe 'taxonomy scoping' do
         let(:organizations) { (0..1).map { FactoryBot.create(:organization) } }
         let(:tasks) { organizations.map { |o| linked_task(o) } + [FactoryBot.create(:some_task)] }

data/test/lib/actions/middleware/keep_current_request_id_test.rb

@@ -0,0 +1,50 @@
+require 'foreman_tasks_test_helper'
+
+module ForemanTasks
+  class KeepCurrentRequestIDTest < ActiveSupport::TestCase
+    class DummyAction < Actions::EntryAction
+      middleware.use ::Actions::Middleware::KeepCurrentRequestID
+
+      def plan(plan = false)
+        plan_self if plan
+      end
+
+      def run
+        output[:run_result] = ::Logging.mdc['request']
+      end
+
+      def finalize
+        output[:finalize_result] = ::Logging.mdc['request']
+      end
+    end
+
+    describe Actions::Middleware::KeepCurrentRequestID do
+      include ::Dynflow::Testing
+
+      before { @old_id = ::Logging.mdc['request'] }
+      after  { ::Logging.mdc['request'] = @old_id }
+
+      let(:expected_id) { 'an_id' }
+
+      it 'stores the id on planning' do
+        ::Logging.mdc['request'] = expected_id
+        action = create_and_plan_action(DummyAction)
+        action.input[:current_request_id].must_equal expected_id
+      end
+
+      it 'restores the id for run' do
+        ::Logging.mdc['request'] = expected_id
+        action = create_and_plan_action(DummyAction, true)
+        action = run_action action
+        action.output[:run_result].must_equal expected_id
+      end
+
+      it 'restores the id for finalize' do
+        ::Logging.mdc['request'] = expected_id
+        action = create_and_plan_action(DummyAction, true)
+        action = finalize_action(run_action(action))
+        action.output[:finalize_result].must_equal expected_id
+      end
+    end
+  end
+end

data/test/support/dummy_proxy_action.rb

@@ -7,13 +7,13 @@ module Support
 
       def initialize
         @log = Hash.new { |h, k| h[k] = [] }
-        @task_triggered = defined?(Concurrent::Promises) ? Concurrent::Promises.resolvable_future : Concurrent.future
+        @task_triggered = Concurrent::Promises.resolvable_future
         @uuid = SecureRandom.uuid
       end
 
       def trigger_task(*args)
         @log[:trigger_task] << args
-        defined?(Concurrent::Promises) ? @task_triggered.fulfill(true) : @task_triggered.success(true)
+        @task_triggered.fulfill(true)
         { 'task_id' => @uuid }
       end
 

data/test/unit/actions/recurring_action_test.rb

@@ -82,6 +82,27 @@ module ForemanTasks
         # Check no new repetitions were planned
         recurring_logic.tasks.count.must_equal 2
       end
+
+      specify 'it resets the request id on repetition' do
+        begin
+          expected_id = 'an_id'
+          new_id = SecureRandom.uuid
+          old_id = ::Logging.mdc['request']
+          ::Logging.mdc['request'] = expected_id
+
+          delay_options = recurring_logic.generate_delay_options
+          task = ForemanTasks.delay HookedAction, delay_options, true, args.last
+          task.input[:current_request_id].must_equal expected_id
+
+          SecureRandom.stubs(:uuid).returns(new_id)
+          # Perform the planning (trigger repeat)
+          task.execution_plan.delay_record.plan
+          repetition = recurring_logic.tasks.find { |t| t.id != task.id }
+          repetition.input[:current_request_id].must_equal new_id
+        ensure
+          ::Logging.mdc['request'] = old_id
+        end
+      end
     end
   end
 end

data/test/unit/task_test.rb

@@ -84,11 +84,9 @@ class TasksTest < ActiveSupport::TestCase
   end
 
   describe 'task without valid execution plan' do
-    let(:missing_task_uuid) { '11111111-2222-3333-4444-555555555555' }
-
     let(:task) do
       task = FactoryBot.create(:dynflow_task).tap do |task|
-        task.external_id = missing_task_uuid
+        task.external_id = 'missing-task'
         task.save
       end
       ForemanTasks::Task.find(task.id)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 0.14.6
+  version: 0.15.0
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-16 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreman-tasks-core
@@ -28,22 +28,16 @@ dependencies:
   name: dynflow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +140,7 @@ files:
 - app/lib/actions/helpers/with_delegated_action.rb
 - app/lib/actions/middleware/hide_secrets.rb
 - app/lib/actions/middleware/inherit_task_groups.rb
+- app/lib/actions/middleware/keep_current_request_id.rb
 - app/lib/actions/middleware/keep_current_taxonomies.rb
 - app/lib/actions/middleware/keep_current_timezone.rb
 - app/lib/actions/middleware/keep_current_user.rb
@@ -258,6 +253,7 @@ files:
 - test/factories/triggering_factory.rb
 - test/foreman_tasks_test_helper.rb
 - test/helpers/foreman_tasks/tasks_helper_test.rb
+- test/lib/actions/middleware/keep_current_request_id_test.rb
 - test/lib/actions/middleware/keep_current_taxonomies_test.rb
 - test/lib/actions/middleware/keep_current_timezone_test.rb
 - test/lib/actions/middleware/keep_current_user_test.rb
@@ -299,7 +295,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Foreman plugin for showing tasks information for resoruces and users
@@ -313,6 +310,7 @@ test_files:
 - test/factories/triggering_factory.rb
 - test/foreman_tasks_test_helper.rb
 - test/helpers/foreman_tasks/tasks_helper_test.rb
+- test/lib/actions/middleware/keep_current_request_id_test.rb
 - test/lib/actions/middleware/keep_current_taxonomies_test.rb
 - test/lib/actions/middleware/keep_current_timezone_test.rb
 - test/lib/actions/middleware/keep_current_user_test.rb