foreman-tasks 0.14.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 99bc7ed098375451dddebc63a0d2c5af37ec3374
-  data.tar.gz: 573580a8808e4c68f84a82db9a05919b960aa771
+SHA256:
+  metadata.gz: fddcfe8ab9f1550261511074f70d3391836126c7fe54839857f0c10c31d2d456
+  data.tar.gz: ac4bf4b19d05f6d6af13440655d76fce521ec76a7bdae32207a1ed883cfaa569
 SHA512:
-  metadata.gz: 9f37b871477d68c476aef947749d516337e3ae8fe5d71bc7f49f82bc5f0467fa265ac324661cb3ad9a2e7368159e92e017e101cd940422b2f1eaea24e4960948
-  data.tar.gz: a11510b41ff6b00d8d76acaa01a3dede47792c732711ee916e86979e2f56cd02ca861a8d648673ac34e9d8d0bf73452677029969557311446c90b391ecebcb24
+  metadata.gz: 0d6e2483dfdf63d5b32980889edd41af2d496ba5fce667593887f678781587282c17fb9abf3e77e22750d4c965c7930e45608c9a4ec7fa475d6c8f0b8e3a69e6
+  data.tar.gz: 5345f2fdce7081763d79468b548add5eea06093ec43581efbc3a84614571477d7446faaf4d10bda41b5c3007f0c0e3a207ab9d0d403ece7872aa2ee7ca2825a3

data/README.md

@@ -21,6 +21,7 @@ happening/happened in your Foreman instance. A framework for asynchronous tasks
 | >= 1.16         | ~> 0.10.0      |
 | >= 1.17         | ~> 0.11.0      |
 | >= 1.18         | ~> 0.13.0      |
+| >= 1.20         | ~> 0.14.0      |
 
 Installation
 ------------

data/app/controllers/foreman_tasks/tasks_controller.rb

@@ -11,13 +11,14 @@ module ForemanTasks
 
     def index
       params[:order] ||= 'started_at DESC'
-      @tasks = filter(resource_base)
       respond_to do |format|
         format.html do
+          @tasks = filter(resource_base)
           render :index
         end
         format.csv do
-          csv_response(@tasks, [:action_label, :state, :result, 'started_at.in_time_zone', 'ended_at.in_time_zone', :username], ['Action', 'State', 'Result', 'Started At', 'Ended At', 'User'])
+          @tasks = filter(resource_base, paginate: false)
+          csv_response(@tasks, [:action, :state, :result, 'started_at.in_time_zone', 'ended_at.in_time_zone', :username], ['Action', 'State', 'Result', 'Started At', 'Ended At', 'User'])
         end
       end
     end
@@ -124,11 +125,12 @@ module ForemanTasks
       resource_scope.where(:type => 'ForemanTasks::Task::DynflowTask').find(params[:id])
     end
 
-    def filter(scope)
+    def filter(scope, paginate: true)
       search = current_taxonomy_search
       search = [search, params[:search]].select(&:present?).join(' AND ')
-      scope.search_for(search, :order => params[:order])
-           .paginate(:page => params[:page], :per_page => params[:per_page]).distinct
+      scope = scope.search_for(search, :order => params[:order])
+      scope = scope.paginate(:page => params[:page], :per_page => params[:per_page]) if paginate
+      scope.distinct
     end
 
     def current_taxonomy_search

data/app/lib/actions/action_with_sub_plans.rb

@@ -1,7 +1,5 @@
 module Actions
   class Actions::ActionWithSubPlans < Actions::EntryAction
-    middleware.use Actions::Middleware::KeepCurrentUser
-
     include Dynflow::Action::WithSubPlans
 
     def plan(*_args)

data/app/lib/actions/foreman/host/import_facts.rb

@@ -9,13 +9,13 @@ module Actions
         def plan(_host_type, host_name, facts, certname, proxy_id)
           facts['domain'].try(:downcase!)
           host = if SETTINGS[:version].short > '1.16'
-                   ::Host::Base.import_host(host_name, certname, proxy_id)
+                   ::Host::Managed.import_host(host_name, certname)
                  else
                    # backwards compatibility
                    ::Host::Managed.import_host(host_name, facts['_type'], certname, proxy_id)
                  end
           host.save(:validate => false) if host.new_record?
-          action_subject(host, :facts => facts)
+          action_subject(host, :facts => facts.to_unsafe_h, :proxy_id => proxy_id)
           if host.build?
             ::Foreman::Logging.logger('foreman-tasks').info "Skipping importing of facts for #{host.name} because it's in build mode"
           else
@@ -26,7 +26,7 @@ module Actions
         def run
           ::User.as :admin do
             host           = ::Host.find(input[:host][:id])
-            state          = host.import_facts(input[:facts])
+            state          = host.import_facts(input[:facts], proxy)
             output[:state] = state
           end
         rescue ::Foreman::Exception => e
@@ -36,6 +36,10 @@ module Actions
           raise e unless e.code == 'ERF51-9911'
         end
 
+        def proxy
+          SmartProxy.find_by(id: input[:proxy_id]) if input[:proxy_id].present?
+        end
+
         def rescue_strategy
           ::Dynflow::Action::Rescue::Skip
         end

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

@@ -64,9 +64,9 @@ module Actions
           task
         end
       rescue => e
-        # We could not reach the remote task, we assume it's gone
+        # We could not reach the remote task, we'll try again next time
         action.action_logger.warn(_('Failed to check on tasks on proxy at %{url}: %{exception}') % { :url => url, :exception => e.message })
-        tasks
+        []
       end
     end
   end

data/app/models/foreman_tasks/task.rb

@@ -51,7 +51,8 @@ module ForemanTasks
                   :complete_value => true,
                   :rename => 'owner.id',
                   :ext_method => :search_by_owner,
-                  :validator => ->(value) { ScopedSearch::Validators::INTEGER.call(value) || value == 'current_user' }
+                  :validator => ->(value) { ScopedSearch::Validators::INTEGER.call(value) || value == 'current_user' },
+                  :aliases => ['user.id']
     scoped_search :relation => :owners,  :on => :login, :complete_value => true, :rename => 'owner.login', :ext_method => :search_by_owner, :aliases => [:user]
     scoped_search :relation => :owners,  :on => :firstname, :complete_value => true, :rename => 'owner.firstname', :ext_method => :search_by_owner
     scoped_search :relation => :task_groups, :on => :id, :complete_value => true, :rename => 'task_group.id', :validator => ScopedSearch::Validators::INTEGER
@@ -85,8 +86,24 @@ module ForemanTasks
       delayed? ? N_('Delayed') : N_('Immediate')
     end
 
+    def get_humanized(method)
+      attr = case method
+             when :humanized_name
+               :action
+             when :humanized_input
+               :input
+             when :humanized_output
+               :output
+             end
+      if attr
+        humanized[attr]
+      else
+        _('N/A')
+      end
+    end
+
     def humanized
-      { action: label,
+      { action: action,
         input:  '',
         output: '' }
     end
@@ -158,6 +175,20 @@ module ForemanTasks
       # using uniq suffix to avoid colisions when searching by two different owners via ScopedSearch
       uniq_suffix = SecureRandom.hex(3)
       key_name = connection.quote_column_name(key.sub(/^.*\./, ''))
+      value.sub!('*', '%%')
+      condition = if key.blank?
+                    sanitize_sql_for_conditions(["users#{uniq_suffix}.login #{operator} ? or users#{uniq_suffix}.firstname #{operator} ? ", value, value])
+                  elsif key =~ /\.id\Z/
+                    value = User.current.id if value == 'current_user'
+                    sanitize_sql_for_conditions(["foreman_tasks_locks_owner#{uniq_suffix}.resource_id #{operator} ?", value])
+                  else
+                    placeholder, value = operator == 'IN' ? ['(?)', value.split(',').map(&:strip)] : ['?', value]
+                    sanitize_sql_for_conditions(["users#{uniq_suffix}.#{key_name} #{operator} #{placeholder}", value])
+                  end
+      { :conditions => condition, :joins => joins_for_user_search(key, uniq_suffix) }
+    end
+
+    def self.joins_for_user_search(key, uniq_suffix)
       joins = <<-SQL
       INNER JOIN foreman_tasks_locks AS foreman_tasks_locks_owner#{uniq_suffix}
                  ON (foreman_tasks_locks_owner#{uniq_suffix}.task_id = foreman_tasks_tasks.id AND
@@ -170,15 +201,7 @@ module ForemanTasks
                    ON (users#{uniq_suffix}.id = foreman_tasks_locks_owner#{uniq_suffix}.resource_id)
         SQL
       end
-      condition = if key.blank?
-                    sanitize_sql_for_conditions(["users#{uniq_suffix}.login #{operator} ? or users#{uniq_suffix}.firstname #{operator} ? ", value, value])
-                  elsif key =~ /\.id\Z/
-                    value = User.current.id if value == 'current_user'
-                    sanitize_sql_for_conditions(["foreman_tasks_locks_owner#{uniq_suffix}.resource_id #{operator} ?", value])
-                  else
-                    sanitize_sql_for_conditions(["users#{uniq_suffix}.#{key_name} #{operator} ?", value])
-                  end
-      { :conditions => condition, :joins => joins }
+      joins
     end
 
     def progress

data/app/models/setting/foreman_tasks.rb

@@ -5,6 +5,7 @@ class Setting::ForemanTasks < Setting
 
     transaction do
       [
+        set('foreman_tasks_sync_task_timeout', N_('Number of seconds to wait for synchronous task to finish.'), 120),
         set('dynflow_allow_dangerous_actions', N_('Allow unlocking actions which can have dangerous consequences.'), false),
         set('dynflow_enable_console', N_('Enable the dynflow console (/foreman_tasks/dynflow) for debugging'), true),
         set('dynflow_console_require_auth', N_('Require user to be authenticated as user with admin rights when accessing dynflow console'), true),

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.0'
+  s.add_dependency "dynflow", '~> 1.0', '>= 1.1.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.rb

@@ -27,8 +27,15 @@ module ForemanTasks
               raise error
             end),
             (on ::Dynflow::World::Triggered.call(execution_plan_id: ~any, future: ~any) do |id, finished|
-              finished.wait if async == false
-              ForemanTasks::Task::DynflowTask.where(:external_id => id).first!
+              unless async
+                timeout = Setting['foreman_tasks_sync_task_timeout']
+                finished.wait(timeout)
+                task = ForemanTasks::Task::DynflowTask.where(:external_id => id).first
+                if task.nil? || task.pending?
+                  raise TimeoutError, "The time waiting for task #{task.try(:id)} to finish exceeded the 'foreman_tasks_sync_task_timeout' (#{timeout}s)"
+                end
+              end
+              task || ForemanTasks::Task::DynflowTask.where(:external_id => id).first!
             end)
     end
   end

data/lib/foreman_tasks/engine.rb

@@ -115,8 +115,12 @@ module ForemanTasks
 
     initializer 'foreman_tasks.require_dynflow', :before => 'foreman_tasks.initialize_dynflow' do |_app|
       ForemanTasks.dynflow.require!
-      ::ForemanTasks.dynflow.config.on_init do |world|
+      ::ForemanTasks.dynflow.config.on_init(false) do |world|
+        world.middleware.use Actions::Middleware::KeepCurrentTaxonomies
         world.middleware.use Actions::Middleware::KeepCurrentUser
+      end
+
+      ::ForemanTasks.dynflow.config.on_init do |world|
         ForemanTasksCore.dynflow_setup(world)
       end
     end

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '0.14.0'.freeze
+  VERSION = '0.14.1'.freeze
 end

data/test/controllers/tasks_controller_test.rb

@@ -24,6 +24,14 @@ module ForemanTasks
         Organization.current = Location.current = nil
       end
 
+      it 'supports csv export' do
+        FactoryBot.create(:some_task, :action => 'Some action')
+        get(:index, params: { format: :csv }, session: set_session_user)
+        assert_response :success
+        assert_equal 2, response.body.lines.size
+        assert_include response.body.lines[1], 'Some action'
+      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/unit/task_test.rb

@@ -21,6 +21,24 @@ class TasksTest < ActiveSupport::TestCase
     test 'can search the tasks by current_user in combination with implicit search' do
       assert_equal [@task_one], ForemanTasks::Task.search_for("owner.id = current_user AND #{@task_one.label}")
     end
+
+    test 'can search the tasks by user' do
+      assert_equal [@task_one], ForemanTasks::Task.search_for("user = #{@user_one.login}")
+    end
+
+    test 'can search the tasks by user\'s id' do
+      assert_equal [@task_one], ForemanTasks::Task.search_for("user.id = #{@user_one.id}")
+      assert_equal [@task_one], ForemanTasks::Task.search_for("owner.id = #{@user_one.id}")
+    end
+
+    test 'can search the tasks by user with wildcards' do
+      glob = '*' + @user_one.login[1..-1] # search for '*ser1' if login is 'user1'
+      assert_equal [@task_one], ForemanTasks::Task.search_for("user ~ #{glob}")
+    end
+
+    test 'can search the tasks by array' do
+      assert_equal [@task_one], ForemanTasks::Task.search_for("user ^ (this_user, #{@user_one.login}, that_user)")
+    end
   end
 
   describe 'authorization filtering' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2018-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreman-tasks-core
@@ -33,7 +33,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -297,7 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Foreman plugin for showing tasks information for resoruces and users