foreman-tasks 0.14.3 → 0.14.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ca474011e1808cd85f5566a30769a192a5bb171e
-  data.tar.gz: 7f9d5e194413251db13425c423978d473c14341d
+SHA256:
+  metadata.gz: 6f8451837ba0e15aae21f3bf127323a6b068ebfd160e2b66e703cbff3eb33313
+  data.tar.gz: e0aa650d6b258b8fc7c379055716c8bda2588b6e621f71e43c00cfc99de860ef
 SHA512:
-  metadata.gz: 73ce88e6cf0e8d4b745e792bb615d17d74d41e729db518e9a1fd21737e53432fdb8b17e67f7f4ead0e256448bdebc62cc0b1e860d11a49e7d85717882ac1294c
-  data.tar.gz: 14fc6a89d2d076eadaacc5286a90868f83e6e5aaea69492864653f8ab95d00dc56633abbc43c856fc1c831717b4947a519e11b563d65e616f06a40a5daec202d
+  metadata.gz: 6e14391d65b6c1bea3c60ab6f487a47a24e452eca949672900943abe37add259eb484675f26caef1cf3e627cd5668d97b95caa809d75a64562531cc1a88bd42d
+  data.tar.gz: b35ee50b3ac877d780e145f61892ac9545684bac290c09de2a6a97fbf5bf854e77e3492fe0b14730b235afd8715fde193dd8eead3f3fcf55265778570b2a3919

data/.rubocop.yml

@@ -75,6 +75,9 @@ Layout/IndentHeredoc:
     - '*.gemspec'
     - bin/*
 
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
 Style/RescueStandardError:
   Enabled: false
 

data/app/lib/actions/base.rb

@@ -27,22 +27,14 @@ module Actions
 
     # This method should return String or Array<String> describing input for the task
     def humanized_input
-      if task_input.blank?
-        ''
-      else
-        task_input.pretty_inspect
-      end
+      ''
     end
 
     # This method should return String describing output for the task.
     # It should aggregate the data from subactions as well and it's used for humanized
     # description of restuls of the action
     def humanized_output
-      if task_output.blank?
-        ''
-      else
-        task_output.pretty_inspect
-      end
+      ''
     end
 
     # This method should return String or Array<String> describing the errors during the action

data/app/lib/actions/bulk_action.rb

@@ -48,7 +48,9 @@ module Actions
       target_class = input[:target_class].constantize
       targets = target_class.where(:id => current_batch)
 
-      targets.map do |target|
+      missing = Array.new((current_batch - targets.map(&:id)).count) { nil }
+
+      (targets + missing).map do |target|
         trigger(action_class, target, *input[:args])
       end
     end

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

@@ -0,0 +1,50 @@
+module Actions
+  module Middleware
+    class KeepCurrentTimezone < Dynflow::Middleware
+      def delay(*args)
+        pass(*args).tap { store_current_timezone }
+      end
+
+      def plan(*args)
+        with_current_timezone do
+          pass(*args).tap { store_current_timezone }
+        end
+      end
+
+      def run(*args)
+        restore_curent_timezone { pass(*args) }
+      end
+
+      def finalize
+        restore_curent_timezone { pass }
+      end
+
+      # Run all execution plan lifecycle hooks as the original timezone
+      def hook(*args)
+        restore_curent_timezone { pass(*args) }
+      end
+
+      private
+
+      def with_current_timezone
+        if action.input[:current_timezone].nil?
+          yield
+        else
+          restore_curent_timezone { yield }
+        end
+      end
+
+      def store_current_timezone
+        action.input[:current_timezone] = Time.zone.name
+      end
+
+      def restore_curent_timezone
+        old_zone = Time.zone
+        Time.zone = Time.find_zone(action.input[:current_timezone]) if action.input[:current_timezone].present?
+        yield
+      ensure
+        Time.zone = old_zone
+      end
+    end
+  end
+end

data/app/models/foreman_tasks/recurring_logic.rb

@@ -158,7 +158,7 @@ module ForemanTasks
       cronline = if triggering.input_type == :cronline
                    triggering.cronline
                  else
-                   ::ForemanTasks::RecurringLogic.assemble_cronline(cronline_hash(triggering.input_type, triggering.time, triggering.days_of_week))
+                   ::ForemanTasks::RecurringLogic.assemble_cronline(cronline_hash(triggering.input_type, triggering.time, triggering.days, triggering.days_of_week))
                  end
       ::ForemanTasks::RecurringLogic.new_from_cronline(cronline).tap do |manager|
         manager.end_time = triggering.end_time if triggering.end_time_limited.present?
@@ -167,11 +167,10 @@ module ForemanTasks
       end
     end
 
-    def self.cronline_hash(recurring_type, time_hash, days_of_week_hash)
+    def self.cronline_hash(recurring_type, time_hash, days, days_of_week_hash)
       hash = Hash[[:years, :months, :days, :hours, :minutes].zip(time_hash.values)]
-      hash.update :days_of_week => days_of_week_hash
-        .select { |_key, value| value == '1' }
-        .keys.join(',')
+      days_of_week = days_of_week_hash.select { |_key, value| value == '1' }.keys.join(',')
+      hash.update :days_of_week => days_of_week, :days => days
       allowed_keys = case recurring_type
                      when :monthly
                        [:minutes, :hours, :days]

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.1'
+  s.add_dependency "dynflow", '~> 1.0', '>= 1.1.5'
   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

@@ -8,10 +8,10 @@ module ForemanTasks
 
     initializer 'foreman_tasks.load_default_settings', :before => :load_config_initializers do
       require_dependency File.expand_path('../../../app/models/setting/foreman_tasks.rb', __FILE__) if begin
-                                                                                                          Setting.table_exists?
-                                                                                                        rescue
-                                                                                                          (false)
-                                                                                                        end
+                                                                                                         Setting.table_exists?
+                                                                                                       rescue
+                                                                                                         false
+                                                                                                       end
     end
 
     # Precompile any JS or CSS files under app/assets/
@@ -118,6 +118,7 @@ module ForemanTasks
       ::ForemanTasks.dynflow.config.on_init(false) do |world|
         world.middleware.use Actions::Middleware::KeepCurrentTaxonomies
         world.middleware.use Actions::Middleware::KeepCurrentUser
+        world.middleware.use Actions::Middleware::KeepCurrentTimezone
       end
 
       ::ForemanTasks.dynflow.config.on_init do |world|

data/lib/foreman_tasks/tasks/export_tasks.rake

@@ -201,7 +201,7 @@ namespace :foreman_tasks do
           #{template}
        <body>
        </html>
-         HTML
+        HTML
       end
 
       def self.copy_assets(tmp_dir)

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '0.14.3'.freeze
+  VERSION = '0.14.4'.freeze
 end

data/test/controllers/api/tasks_controller_test.rb

@@ -30,20 +30,35 @@ module ForemanTasks
       describe 'GET /api/tasks/summary' do
         class DummyTestSummaryAction < Support::DummyDynflowAction
           # a dummy test action that do nothing
+          def plan(suspend = false)
+            plan_self :suspend => suspend
+          end
+
           def run
             # a dummy run method
+            if input[:suspend] && output[:suspended].nil?
+              output[:suspended] = true
+              suspend
+            end
           end
         end
 
         test_attributes :pid => 'bdcab413-a25d-4fe1-9db4-b50b5c31ebce'
         it 'get tasks summary' do
-          ForemanTasks.trigger(DummyTestSummaryAction)
+          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
-          refute response.empty?
+          assert_not response.empty?
           assert_kind_of Hash, response[0]
+          ForemanTasks.dynflow.world.event(triggered.id, 2, nil)
+          triggered.finished.wait
         end
       end
 
@@ -56,6 +71,7 @@ module ForemanTasks
                                            'Proxy::DummyAction',
                                            'foo' => 'bar')
           Support::DummyProxyAction.proxy.task_triggered.wait(5)
+          wait_for { ForemanTasks::Task.find_by(external_id: triggered.id).state == 'running' }
 
           task = ForemanTasks::Task.where(:external_id => triggered.id).first
           task.state.must_equal 'running'

data/test/foreman_tasks_test_helper.rb

@@ -12,3 +12,14 @@ FactoryBot.find_definitions
 
 ForemanTasks.dynflow.require!
 ForemanTasks.dynflow.config.disable_active_record_actions = true
+
+# waits for the passed block to return non-nil value and reiterates it while getting false
+# (till some reasonable timeout). Useful for forcing the tests for some event to occur
+def wait_for(waiting_message = 'something to happen')
+  30.times do
+    ret = yield
+    return ret if ret
+    sleep 0.3
+  end
+  raise "waiting for #{waiting_message} was not successful"
+end

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

@@ -0,0 +1,52 @@
+require 'foreman_tasks_test_helper'
+
+module Actions
+  module Middleware
+    class KeepCurrentTimezoneTest < ActiveSupport::TestCase
+      include ::Dynflow::Testing
+
+      class TestAction < Support::DummyDynflowAction
+        middleware.use KeepCurrentTimezone
+
+        def run; end
+      end
+
+      describe 'plan' do
+        let(:zone) { Time.find_zone('Pacific/Honolulu') }
+        test 'with current user set' do
+          Time.expects(:zone).returns(zone)
+          action = create_and_plan_action(TestAction)
+          assert_equal(zone.name, action.input['current_timezone'])
+        end
+      end
+
+      describe 'run' do
+        let(:zone) { Time.find_zone('Pacific/Honolulu') }
+
+        before do
+          @real_zone = Time.zone
+          @action = create_and_plan_action(TestAction)
+        end
+
+        test 'when timezone is not set in input' do
+          # It saves and restore the real zone
+          Time.expects(:zone=).with(@real_zone)
+          @action.stubs(:input).returns({})
+          run_action(@action)
+        end
+
+        test 'with current timezone as input' do
+          # We plan the @action in @real_zone
+          # We run the action in Pacific/Honolulu
+          Time.stubs(:zone).returns(zone)
+          # It restores the orinal time zone
+          Time.expects(:zone=).with(zone)
+
+          # It restores the saved time zone
+          Time.expects(:zone=).with(@real_zone)
+          run_action(@action)
+        end
+      end
+    end
+  end
+end

data/test/unit/actions/bulk_action_test.rb

@@ -0,0 +1,47 @@
+require 'foreman_tasks_test_helper'
+
+module ForemanTasks
+  class BulkActionTest < ActiveSupport::TestCase
+    before do
+      User.current = User.where(:login => 'apiadmin').first
+    end
+
+    Target = Struct.new(:id)
+
+    class ParentAction < Actions::BulkAction; end
+
+    class ChildAction < Actions::EntryAction
+      def plan(target)
+        target.id
+      end
+    end
+
+    describe Actions::BulkAction do
+      let(:targets) { (1..5).map { |i| Target.new i } }
+      let(:task) do
+        triggered = ForemanTasks.trigger(ParentAction, ChildAction, targets)
+        task = ForemanTasks::Task.where(:external_id => triggered.id).first
+        wait_for { task.reload.state == 'stopped' }
+        task
+      end
+
+      specify 'it plans a task for each target' do
+        Target.expects(:where).with(:id => targets.map(&:id)).returns(targets)
+
+        task.sub_tasks.count.must_equal targets.count
+        success, failed = task.sub_tasks.partition { |sub_task| sub_task.result == 'success' }
+        failed.must_be :empty?
+        success.count.must_equal 5
+      end
+
+      specify 'it plans a task for each target even if target cannot be found' do
+        Target.expects(:where).with(:id => targets.map(&:id)).returns(targets.take(4))
+
+        task.sub_tasks.count.must_equal targets.count
+        success, failed = task.sub_tasks.partition { |sub_task| sub_task.result == 'success' }
+        success.count.must_equal 4
+        failed.count.must_equal 1
+      end
+    end
+  end
+end

data/test/unit/actions/proxy_action_test.rb

@@ -114,7 +114,7 @@ module ForemanTasks
         action.world.stubs(:persistence).returns(persistence)
         action.wipe_secrets!(nil)
 
-        refute action.input.key?(:secrets)
+        assert_not action.input.key?(:secrets)
       end
     end
   end

data/test/unit/actions/recurring_action_test.rb

@@ -22,7 +22,7 @@ module ForemanTasks
           :minutes => 0,
           :hours => 12,
           :days => 1,
-          :months => (Time.zone.now.month + 1) % 12
+          :months => ((Time.zone.now.month + 1) % 12) + 1
         }
       end
 

data/test/unit/dynflow_console_authorizer_test.rb

@@ -57,18 +57,18 @@ module ForemanTasks
       end
 
       it 'can see only the tasks he has permissions on' do
-        refute dynflow_console_authorized?
+        assert_not dynflow_console_authorized?
         assert dynflow_console_authorized?(own_task)
-        refute dynflow_console_authorized?(foreign_task)
+        assert_not dynflow_console_authorized?(foreign_task)
       end
     end
 
     describe 'user without edit_foreman_tasks permissions' do
       let(:user) { FactoryBot.create(:user) }
       it 'can not see any tasks' do
-        refute dynflow_console_authorized?
-        refute dynflow_console_authorized?(own_task)
-        refute dynflow_console_authorized?(foreign_task)
+        assert_not dynflow_console_authorized?
+        assert_not dynflow_console_authorized?(own_task)
+        assert_not dynflow_console_authorized?(foreign_task)
       end
     end
   end

data/test/unit/recurring_logic_test.rb

@@ -43,15 +43,15 @@ class RecurringLogicsTest < ActiveSupport::TestCase
       hours = '12'
       days = '11'
       days_of_week = { '1' => '1', '2' => '0', '3' => '0', '4' => '1', '5' => '0', '6' => '1', '7' => '0' }
-      time_hash = { '0' => '2015', '1' => '12', '2' => '11', '3' => hours, '4' => minutes }
+      time_hash = { '0' => '2015', '1' => '12', '2' => '10', '3' => hours, '4' => minutes }
       expected_result_hourly  = { :minutes => minutes }
       expected_result_daily   = { :minutes => minutes, :hours => hours }
       expected_result_weekly  = { :minutes => minutes, :hours => hours, :days_of_week => '1,4,6' }
       expected_result_monthly = { :minutes => minutes, :hours => hours, :days => days }
-      ForemanTasks::RecurringLogic.cronline_hash(:hourly,  time_hash, days_of_week).must_equal expected_result_hourly
-      ForemanTasks::RecurringLogic.cronline_hash(:daily,   time_hash, days_of_week).must_equal expected_result_daily
-      ForemanTasks::RecurringLogic.cronline_hash(:weekly,  time_hash, days_of_week).must_equal expected_result_weekly
-      ForemanTasks::RecurringLogic.cronline_hash(:monthly, time_hash, days_of_week).must_equal expected_result_monthly
+      ForemanTasks::RecurringLogic.cronline_hash(:hourly,  time_hash, days, days_of_week).must_equal expected_result_hourly
+      ForemanTasks::RecurringLogic.cronline_hash(:daily,   time_hash, days, days_of_week).must_equal expected_result_daily
+      ForemanTasks::RecurringLogic.cronline_hash(:weekly,  time_hash, days, days_of_week).must_equal expected_result_weekly
+      ForemanTasks::RecurringLogic.cronline_hash(:monthly, time_hash, days, days_of_week).must_equal expected_result_monthly
     end
 
     it 'can have limited number of repeats' do
@@ -94,7 +94,9 @@ class RecurringLogicsTest < ActiveSupport::TestCase
       future_time = Time.zone.now + 1.week
       recurring_logic.start_after(::Support::DummyRecurringDynflowAction, future_time)
 
-      assert_equal future_time.change(:min => future_time.min + 1, :sec => 0), recurring_logic.tasks.first.start_at
+      # Add one minute to the time, set seconds to 0
+      target_time = (future_time + 1.minute).change(:sec => 0)
+      assert_equal target_time, recurring_logic.tasks.first.start_at
     end
 
     it 'has a task group associated to all tasks that were created as part of the recurring logic' do
@@ -147,7 +149,7 @@ class RecurringLogicsTest < ActiveSupport::TestCase
         assert_equal 'active', logic.state
 
         task = logic.tasks.find_by(:state => 'scheduled')
-        refute ForemanTasks.dynflow.world.persistence.load_delayed_plan(task.execution_plan.id).frozen
+        assert_not ForemanTasks.dynflow.world.persistence.load_delayed_plan(task.execution_plan.id).frozen
         assert task.start_at > Time.zone.now
       end
     end

data/test/unit/task_test.rb

@@ -152,7 +152,7 @@ class TasksTest < ActiveSupport::TestCase
     let(:task) { FactoryBot.create(:dynflow_task) }
 
     it 'can indicate it is recurring' do
-      refute task.recurring?
+      assert_not task.recurring?
       task.add_missing_task_groups(logic.task_group)
       task.reload
       assert task.recurring?
@@ -163,7 +163,7 @@ class TasksTest < ActiveSupport::TestCase
     let(:task) { FactoryBot.create(:some_task) }
 
     it 'can indicate it is delayed' do
-      refute task.delayed?
+      assert_not task.delayed?
       task.execution_type.must_equal 'Immediate'
       task.start_at = Time.now.utc + 100
       assert task.delayed?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 0.14.3
+  version: 0.14.4
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-22 00:00:00.000000000 Z
+date: 2018-12-11 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.1
+        version: 1.1.5
   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.1
+        version: 1.1.5
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -147,6 +147,7 @@ files:
 - app/lib/actions/middleware/hide_secrets.rb
 - app/lib/actions/middleware/inherit_task_groups.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
 - app/lib/actions/middleware/rails_executor_wrap.rb
 - app/lib/actions/middleware/recurring_logic.rb
@@ -258,6 +259,7 @@ files:
 - test/foreman_tasks_test_helper.rb
 - test/helpers/foreman_tasks/tasks_helper_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
 - test/support/dummy_active_job.rb
 - test/support/dummy_dynflow_action.rb
@@ -266,6 +268,7 @@ files:
 - test/support/dummy_task_group.rb
 - test/tasks/generate_task_actions_test.rb
 - test/unit/actions/action_with_sub_plans_test.rb
+- test/unit/actions/bulk_action_test.rb
 - test/unit/actions/proxy_action_test.rb
 - test/unit/actions/recurring_action_test.rb
 - test/unit/cleaner_test.rb
@@ -297,7 +300,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Foreman plugin for showing tasks information for resoruces and users
@@ -312,6 +315,7 @@ test_files:
 - test/foreman_tasks_test_helper.rb
 - test/helpers/foreman_tasks/tasks_helper_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
 - test/support/dummy_active_job.rb
 - test/support/dummy_dynflow_action.rb
@@ -320,6 +324,7 @@ test_files:
 - test/support/dummy_task_group.rb
 - test/tasks/generate_task_actions_test.rb
 - test/unit/actions/action_with_sub_plans_test.rb
+- test/unit/actions/bulk_action_test.rb
 - test/unit/actions/proxy_action_test.rb
 - test/unit/actions/recurring_action_test.rb
 - test/unit/cleaner_test.rb