foreman-tasks 0.16.1 → 0.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75231de648b74702c80ca64886f1d6c19caf3a7920d547807f892e130194cedb
-  data.tar.gz: bf5f7331818981dbf841c3a696e0e768bec3328b9e349df13532d1757bbe86a9
+  metadata.gz: 753e1fdc22bc3c7c13f3bb3f22d4fb87598209363fabbd774c700e47fba723fa
+  data.tar.gz: a18ed71a7cd485770be04d40b0e30ac101dd83ee61c2b79623428b0df96d7cc8
 SHA512:
-  metadata.gz: 8699acec8437f71f4fb52fb89a79dc96857cb08cd09375c7d33d9d4e72d67de8e95ee53352b14f1f80f1a62b880943df996d6fca16a666022ca030dcfdb4cd7d
-  data.tar.gz: fc3e36ab57cadf68fa033a4224890c2fdc71a76e18d782b0758cac2bef7748a2cc5e3f30b3f7a37641cb2b9f3ff8d1c79f3b2d2e90cfb0e2050381f04e2a7794
+  metadata.gz: ba29345ff133bc71f39519dea6dff37d8a35331c158677faecaf50a949ff2655e713bec5ac2f7c35e1e9cb81171fbda8802abef81d7cc8fab4927f92572d19af
+  data.tar.gz: 6c9589f8d31aec28475186d7f64cc15232ef597f7ca07f84dc928c2f8706202e03da9d7cd9ac75b07380cd99e8638bb07e4b56214e8c15c4b851d067845df83e

data/app/controllers/foreman_tasks/tasks_controller.rb

@@ -16,7 +16,8 @@ module ForemanTasks
     end
 
     def summary
-      render json: Task::Summarizer.new(resource_base, params[:recent_timeframe].to_i).summary
+      scope = resource_base.search_for(current_taxonomy_search).select(:id)
+      render json: Task::Summarizer.new(Task.where(:id => scope), params[:recent_timeframe].to_i).summary
     end
 
     def sub_tasks

data/app/models/foreman_tasks/task.rb

@@ -49,10 +49,12 @@ module ForemanTasks
     scoped_search :on => :user_id,
                   :complete_value => true,
                   :rename => 'user.id',
-                  :validator => ->(value) { ScopedSearch::Validators::INTEGER.call(value) || value == 'current_user' },
-                  :aliases => ['owner.id'], :ext_method => :search_by_owner, :only_explicit => true
-    scoped_search :relation => :user, :on => :login, :rename => 'user.login', :complete_value => true, :aliases => ['owner.login', 'user'], :ext_method => :search_by_owner, :only_explicit => true
-    scoped_search :relation => :user, :on => :firstname, :rename => 'user.firstname', :complete_value => true, :aliases => ['owner.firstname'], :ext_method => :search_by_owner, :only_explicit => true
+                  :validator => ->(value) { ScopedSearch::Validators::INTEGER.call(value) },
+                  :value_translation => ->(value) { value == 'current_user' ? User.current.id : value },
+                  :special_values => %w[current_user],
+                  :aliases => ['owner.id'], :only_explicit => true
+    scoped_search :relation => :user, :on => :login, :complete_value => true, :aliases => ['owner.login', 'user'], :only_explicit => true
+    scoped_search :relation => :user, :on => :firstname, :rename => 'user.firstname', :complete_value => true, :aliases => ['owner.firstname'], :only_explicit => true
     scoped_search :relation => :task_groups, :on => :id, :complete_value => true, :rename => 'task_group.id', :validator => ScopedSearch::Validators::INTEGER
 
     scope :active, -> {  where('foreman_tasks_tasks.state != ?', :stopped) }

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

@@ -22,31 +22,6 @@ module ForemanTasks
         sql = "foreman_tasks_locks_taxonomy#{uniq_suffix}.resource_id #{operator} ? OR foreman_tasks_locks_taxonomy#{uniq_suffix}.resource_id IS NULL"
         { :conditions => sanitize_sql_for_conditions([sql, value]), :joins => joins }
       end
-
-      def search_by_owner(key, operator, value)
-        return { :conditions => '0 = 1' } if value == 'current_user' && User.current.nil?
-
-        key = 'owners.login' if key == 'user'
-        # 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_tasks.user_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 joins_for_user_search(key, uniq_suffix)
-        return '' if key =~ /\.id\Z/
-        "INNER JOIN users AS users_#{uniq_suffix} ON users_#{uniq_suffix}.id = foreman_tasks_tasks.user_id"
-      end
     end
   end
 end

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '0.16.1'.freeze
+  VERSION = '0.16.2'.freeze
 end

data/test/controllers/tasks_controller_test.rb

@@ -41,6 +41,41 @@ module ForemanTasks
           response = JSON.parse(@response.body)
           assert_equal 0, response['stopped']['total']
         end
+
+        describe 'taxonomy scoping' do
+          before do
+            @organizations = [0, 0].map { FactoryBot.create(:organization) }
+            @locations = [0, 0].map { FactoryBot.create(:location) }
+            @tasks = [0, 0].map { FactoryBot.create(:some_task) }
+            @tasks.zip(@organizations, @locations).each do |task, org, loc|
+              Lock.link!(org, task.id)
+              Lock.link!(loc, task.id)
+            end
+          end
+
+          it 'does not limit if unset' do
+            get(:summary, params: { recent_timeframe: 24 }, session: set_session_user)
+            assert_response :success
+            response = JSON.parse(@response.body)
+            assert_equal 2, response['stopped']['total']
+          end
+
+          it 'finds only tasks with matching taxonomies' do
+            get(:summary, params: { recent_timeframe: 24 },
+                          session: set_session_user.merge(:organization_id => @organizations.first, :location_id => @locations.first))
+            assert_response :success
+            response = JSON.parse(@response.body)
+            assert_equal 1, response['stopped']['total']
+          end
+
+          it 'find no tasks when taxonomy combination contains no tasks' do
+            get(:summary, params: { recent_timeframe: 24 },
+                          session: set_session_user.merge(:organization_id => @organizations.first, :location_id => @locations.last))
+            assert_response :success
+            response = JSON.parse(@response.body)
+            assert_equal 0, response['stopped']['total']
+          end
+        end
       end
 
       it 'supports csv export' do

data/test/unit/task_test.rb

@@ -30,20 +30,66 @@ class TasksTest < ActiveSupport::TestCase
       assert_equal [@task_one], ForemanTasks::Task.search_for("user = #{@user_one.login}")
     end
 
+    test 'cannot search by arbitrary key' do
+      proc { ForemanTasks::Task.search_for('user.my_key ~ 5') }.must_raise(ScopedSearch::QueryNotSupported)
+      proc { ForemanTasks::Task.search_for('user. = 5') }.must_raise(ScopedSearch::QueryNotSupported)
+    end
+
+    test 'can search the tasks by negated user' do
+      assert_equal [@task_one], ForemanTasks::Task.search_for("user != #{@user_two.login}")
+      assert_equal [@task_one], ForemanTasks::Task.search_for("user <> #{@user_two.login}")
+      SecureRandom.stubs(:hex).returns('abc')
+      assert_equal ForemanTasks::Task.search_for("user != #{@user_two.login}").to_sql,
+                   ForemanTasks::Task.search_for("user <> #{@user_two.login}").to_sql
+    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}")
+      assert_equal [@task_one], ForemanTasks::Task.search_for("user.id != #{@user_two.id}")
+      assert_equal [@task_one], ForemanTasks::Task.search_for("owner.id != #{@user_two.id}")
+    end
+
+    test 'can search by array of user ids' 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})")
+      assert_equal [@task_one], ForemanTasks::Task.search_for("user.id !^ (#{@user_two.id})")
+      assert_equal [@task_one], ForemanTasks::Task.search_for("owner.id !^ (#{@user_two.id})")
+    end
+
+    test 'cannot glob on user\'s id' do
+      proc { ForemanTasks::Task.search_for("user.id ~ something") }.must_raise(ScopedSearch::QueryNotSupported)
+      proc { ForemanTasks::Task.search_for("user.id ~ 5") }.must_raise(ScopedSearch::QueryNotSupported)
     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}")
+      part = @user_one.login[1..-1] # search for '*ser1' if login is 'user1'
+      # The following two should be equivalent
+      assert_equal [@task_one], ForemanTasks::Task.search_for("user ~ #{part}")
+      assert_equal [@task_one], ForemanTasks::Task.search_for("user ~ *#{part}*")
+      SecureRandom.stubs(:hex).returns('abc')
+      assert_equal ForemanTasks::Task.search_for("user ~ #{part}").to_sql,
+                   ForemanTasks::Task.search_for("user ~ *#{part}*").to_sql
+    end
+
+    test 'can search the tasks by user with negated wildcards' do
+      part = @user_two.login[1..-1] # search for '*ser1' if login is 'user1'
+      # The following two should be equivalent
+      assert_equal [@task_one], ForemanTasks::Task.search_for("user !~ #{part}")
+      assert_equal [@task_one], ForemanTasks::Task.search_for("user !~ *#{part}*")
+      SecureRandom.stubs(:hex).returns('abc')
+      assert_equal ForemanTasks::Task.search_for("user !~ #{part}").to_sql,
+                   ForemanTasks::Task.search_for("user !~ *#{part}*").to_sql
     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
 
+    test 'can search the tasks by negated array' do
+      assert_equal [@task_one], ForemanTasks::Task.search_for("user !^ (this_user, #{@user_two.login}, that_user)")
+    end
+
     test 'properly returns username' do
       assert_equal @task_one.username, @user_one.login
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.16.2
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-05 00:00:00.000000000 Z
+date: 2019-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreman-tasks-core