foreman-tasks 0.12.2 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c9314affd9bff690bd88cbd4aa26c65033b10eb
-  data.tar.gz: 24fc605d6fd7038ed08a4dfbd55ef1c88a81421c
+  metadata.gz: 0111beaab4e9971f1039c81e0ccf31ad5cbb79e4
+  data.tar.gz: 0077b9efb0e93957f99a37fe4d08469b6f6b62d2
 SHA512:
-  metadata.gz: 60bb278cd278df8fef607c162335e70419da9fc52ebca9a6e4de7b5520976638e2c04e17108ad594e1788933ffca2a16fc754044011ecf289ab1ead78642ae17
-  data.tar.gz: f20a4318e569a2d11ab00c60bf23b21dfb6b579ac0373eb6a0e444325904b56d5ae8fa11a3f782858efdc35b3143f956ef7028feec32fb1691a1862fcf7e3678
+  metadata.gz: 0aff56c13e49c3cca9802a8ae63f0f4c024ba69a4b6bb07d9453e236de2571d284895906192c8b52cc2e8ed8300b083e3643d47bf8894fab8fbde55da5bc3364
+  data.tar.gz: 55255ff6e02f84e834b2ea8927364985830f13a0b456c64af503af56b0a76f286e1a94e5ec2fef04b3ee4da48fe905836a242b9baae4efd90f54afe04ee03944

data/app/helpers/foreman_tasks/foreman_tasks_helper.rb

@@ -58,11 +58,11 @@ module ForemanTasks
     end
 
     def recurring_logic_next_occurrence(recurring_logic)
-      if %w[finished cancelled].include? recurring_logic.state
-        '-'
-      else
-        recurring_logic.next_occurrence_time
-      end
+      default = '-'
+      return default if %w[finished cancelled].include? recurring_logic.state
+
+      last_task = recurring_logic.tasks.order(:start_at).last
+      last_task ? last_task.start_at : default
     end
 
     def time_f(f, attr, field_options = {}, time_options = {}, html_options = {})

data/app/lib/actions/helpers/humanizer.rb

@@ -126,7 +126,7 @@ module Actions
           product_id = fetch_data(data, :product, :id)
           repo_id = fetch_data(data, :repo, :id)
           if product_id && repo_id
-            "#/products/#{product_id}/repositories/#{repo_id}"
+            "/products/#{product_id}/repositories/#{repo_id}"
           end
         end
       end
@@ -152,7 +152,7 @@ module Actions
 
         def link(data)
           if (content_view_id = fetch_data(data, :content_view, :id))
-            "#/content_views/#{content_view_id}/versions"
+            "/content_views/#{content_view_id}/versions"
           end
         end
       end
@@ -168,7 +168,7 @@ module Actions
 
         def link(data)
           if (product_id = fetch_data(data, :product, :id))
-            "#/products/#{product_id}/info"
+            "/products/#{product_id}/"
           end
         end
       end

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

@@ -22,7 +22,7 @@ module Actions
       private
 
       def with_current_taxonomies
-        if has_current_taxonomies?
+        if current_taxonomies?
           yield
         else
           restore_current_taxonomies { yield }
@@ -43,9 +43,9 @@ module Actions
         Location.current = nil
       end
 
-      def has_current_taxonomies?
+      def current_taxonomies?
         (Organization.current || action.input[:current_organization_id].nil?) &&
-        (Location.current || action.input[:current_location_id].nil?)
+          (Location.current || action.input[:current_location_id].nil?)
       end
     end
   end

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

@@ -7,11 +7,6 @@ module Actions
       # After an action is delayed, it checks whether the delay_options
       # hash contains an id of a recurring logic. If so, it adds the task
       # to the recurring logic's task group, otherwise does nothing.
-      #
-      # After the action's plan phase the middleware checks if the task
-      # is associated with a task group of any recurring logic, in which case
-      # it triggers another repeat using the task group's recurring logic,
-      # otherwise does nothing.
       def delay(delay_options, *args)
         pass(delay_options, *args).tap do
           if delay_options[:recurring_logic_id]
@@ -20,13 +15,6 @@ module Actions
         end
       end
 
-      def plan(*args)
-        pass(*args).tap do
-          task_group = task.task_groups.find { |tg| tg.is_a? ::ForemanTasks::TaskGroups::RecurringLogicTaskGroup }
-          task_group.recurring_logic.trigger_repeat(action.class, *args) if task_group
-        end
-      end
-
       private
 
       def recurring_logic(delay_options)

data/app/lib/actions/recurring_action.rb

@@ -0,0 +1,27 @@
+module Actions
+  module RecurringAction
+    # When included sets the base action to use the RecurringLogic middleware and configures
+    #   #trigger_repeat to be called when appropriate to trigger the next repeat.
+    def self.included(base)
+      base.middleware.use Actions::Middleware::RecurringLogic
+      base.execution_plan_hooks.use :trigger_repeat, :on => [:planned, :failure]
+    end
+
+    # 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)
+      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
+    end
+
+    private
+
+    def recurring_logic_task_group
+      @task_group ||= task.task_groups
+                          .find { |tg| tg.is_a? ::ForemanTasks::TaskGroups::RecurringLogicTaskGroup }
+    end
+  end
+end

data/app/models/foreman_tasks/recurring_logic.rb

@@ -33,12 +33,13 @@ module ForemanTasks
       trigger_repeat(action_class, *args)
     end
 
-    def trigger_repeat(action_class, *args)
-      if can_continue?
+    def trigger_repeat_after(time, action_class, *args)
+      return if cancelled?
+      if can_continue?(time)
         self.iteration += 1
         save!
         ::ForemanTasks.delay action_class,
-                             generate_delay_options,
+                             generate_delay_options(time),
                              *args
       else
         self.state = 'finished'
@@ -47,6 +48,10 @@ module ForemanTasks
       end
     end
 
+    def trigger_repeat(action_class, *args)
+      trigger_repeat_after(Time.zone.now, action_class, *args)
+    end
+
     def cancel
       self.state = 'cancelled'
       save!
@@ -89,6 +94,10 @@ module ForemanTasks
       state == 'finished'
     end
 
+    def cancelled?
+      state == 'cancelled'
+    end
+
     def humanized_state
       case state
       when 'active'

data/app/models/foreman_tasks/task.rb

@@ -109,10 +109,16 @@ module ForemanTasks
       state == 'paused'
     end
 
+    # returns true if the task is *CURRENTLY* waiting to be executed in the future
+    def scheduled?
+      state == 'scheduled'
+    end
+
     def recurring?
       !recurring_logic_task_group_ids.empty?
     end
 
+    # returns true if the task was planned to execute in the future
     def delayed?
       start_at.to_i != started_at.to_i
     end

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

@@ -8,12 +8,12 @@ module ForemanTasks
     def update_from_dynflow(data)
       utc_zone = ActiveSupport::TimeZone.new('UTC')
       self.external_id    = data[:id]
-      self.started_at     = utc_zone.parse(data[:started_at]) unless data[:started_at].nil?
-      self.ended_at       = utc_zone.parse(data[:ended_at]) unless data[:ended_at].nil?
       self.result         = map_result(data).to_s
       self.state          = data[:state].to_s
-      self.start_at       = utc_zone.parse(data[:start_at]) if data[:start_at]
-      self.start_before   = utc_zone.parse(data[:start_before]) if data[:start_before]
+      self.started_at     = string_to_time(utc_zone, data[:started_at]) unless data[:started_at].nil?
+      self.ended_at       = string_to_time(utc_zone, data[:ended_at]) unless data[:ended_at].nil?
+      self.start_at       = string_to_time(utc_zone, data[:start_at]) if data[:start_at]
+      self.start_before   = string_to_time(utc_zone, data[:start_before]) if data[:start_before]
       self.parent_task_id ||= begin
                                 if main_action.caller_execution_plan_id
                                   DynflowTask.where(:external_id => main_action.caller_execution_plan_id).first!.id
@@ -153,6 +153,11 @@ module ForemanTasks
 
     private
 
+    def string_to_time(zone, time)
+      return time if time.is_a?(Time)
+      zone.parse(time)
+    end
+
     def set_action_field
       self.action = to_label
     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", '~> 0.8.29'
+  s.add_dependency "dynflow", '~> 1.0'
   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/dynflow/configuration.rb

@@ -35,8 +35,8 @@ module ForemanTasks
       options
     end
 
-    def initialize_persistence
-      ForemanTasks::Dynflow::Persistence.new(default_sequel_adapter_options)
+    def persistence_class
+      ForemanTasks::Dynflow::Persistence
     end
   end
 end

data/lib/foreman_tasks/engine.rb

@@ -98,7 +98,7 @@ module ForemanTasks
     end
 
     initializer 'foreman_tasks.register_paths' do |_app|
-      ForemanTasks.dynflow.config.eager_load_paths.concat(%W[#{ForemanTasks::Engine.root}/app/lib/actions])
+      ForemanTasks.dynflow.config.eager_load_paths.concat(%W[#{ForemanTasks::Engine.root}/app/lib/actions #{ForemanTasks::Engine.root}/app/lib/hooks])
     end
 
     initializer 'foreman_tasks.test_exceptions' do |_app|

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '0.12.2'.freeze
+  VERSION = '0.13.0'.freeze
 end

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

@@ -0,0 +1,67 @@
+require 'foreman_tasks_test_helper'
+
+module Actions
+  module Middleware
+    class KeepCurrentTaxonomiesTest < ActiveSupport::TestCase
+      include ::Dynflow::Testing
+
+      class TestAction < Support::DummyDynflowAction
+        middleware.use KeepCurrentTaxonomies
+
+        def run; end
+      end
+
+      before do
+        @org = mock('organization')
+        @org.stubs(:id).returns(1)
+        @loc = mock('location')
+        @loc.stubs(:id).returns(2)
+      end
+
+      describe 'plan' do
+        test 'with current taxonomies set' do
+          Organization.expects(:current).twice.returns(@org)
+          Location.expects(:current).twice.returns(@loc)
+
+          @action = create_and_plan_action(TestAction)
+          assert_equal(@org.id, @action.input['current_organization_id'])
+          assert_equal(@loc.id, @action.input['current_location_id'])
+        end
+
+        test 'with one current taxonomy set (organization)' do
+          Organization.expects(:current).twice.returns(@org)
+          Location.expects(:current).twice
+
+          @action = create_and_plan_action(TestAction)
+          assert_equal(@org.id, @action.input['current_organization_id'])
+          assert_nil(@action.input['current_location_id'])
+        end
+      end
+
+      describe 'run' do
+        before do
+          Organization.stubs(:current).returns(@org)
+          Location.stubs(:current).returns(@loc)
+
+          @action = create_and_plan_action(TestAction)
+
+          Organization.stubs(:current)
+          Location.stubs(:current)
+        end
+
+        test 'with current taxonomies as input' do
+          Organization.unscoped.class.any_instance.expects(:find).with(@org.id).returns(@org)
+          Location.unscoped.class.any_instance.expects(:find).with(@loc.id).returns(@loc)
+
+          Organization.expects(:current=).with(@org)
+          Location.expects(:current=).with(@loc)
+
+          Organization.stubs(:current=).with(nil)
+          Location.stubs(:current=).with(nil)
+
+          @action = run_action(@action)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+require 'foreman_tasks_test_helper'
+
+module Actions
+  module Middleware
+    class KeepCurrentUserTest < ActiveSupport::TestCase
+      include ::Dynflow::Testing
+
+      class TestAction < Support::DummyDynflowAction
+        middleware.use KeepCurrentUser
+
+        def run; end
+      end
+
+      before do
+        @user = mock('user')
+        @user.stubs(:id).returns(1)
+      end
+
+      describe 'plan' do
+        test 'with current user set' do
+          User.expects(:current).twice.returns(@user)
+
+          @action = create_and_plan_action(TestAction)
+          assert_equal(@user.id, @action.input['current_user_id'])
+        end
+      end
+
+      describe 'run' do
+        before do
+          User.stubs(:current).returns(@user)
+
+          @action = create_and_plan_action(TestAction)
+
+          User.stubs(:current)
+        end
+
+        test 'with current user as input' do
+          User.unscoped.class.any_instance.expects(:find).with(@user.id).returns(@user)
+
+          User.expects(:current=).with(@user)
+
+          User.stubs(:current=).with(nil)
+
+          @action = run_action(@action)
+        end
+      end
+    end
+  end
+end

data/test/unit/actions/recurring_action_test.rb

@@ -0,0 +1,87 @@
+require 'foreman_tasks_test_helper'
+
+module ForemanTasks
+  class RecurringActionTest < ActiveSupport::TestCase
+    class HookedAction < Actions::EntryAction
+      include Actions::RecurringAction
+
+      def plan(should_fail, _numbers)
+        plan_self(:should_fail => should_fail)
+      end
+
+      def run
+        raise "A controlled failure" if input[:should_fail]
+      end
+    end
+
+    describe Actions::RecurringAction do
+      include ::Dynflow::Testing
+
+      let(:preset) do
+        {
+          :minutes => 0,
+          :hours => 12,
+          :days => 1,
+          :months => (Time.zone.now.month + 1) % 12
+        }
+      end
+
+      let(:recurring_logic) do
+        cronline = ForemanTasks::RecurringLogic.assemble_cronline(preset)
+        logic = ForemanTasks::RecurringLogic.new_from_cronline(cronline)
+        logic.state = 'active'
+        logic.save!
+        logic
+      end
+
+      let(:args) { [false, [1, 2, 3]] }
+
+      let(:recurring_task) do
+        recurring_logic.start(HookedAction, *args)
+        recurring_logic.tasks.first
+      end
+
+      specify 'it triggers the repeat when task is cancelled' do
+        recurring_task.must_be :delayed?
+        recurring_logic.tasks.count.must_equal 1
+        cancelled_events = recurring_task.execution_plan.cancel
+        cancelled_events.each(&:wait!)
+        recurring_logic.reload
+        recurring_logic.tasks.count.must_equal 2
+        new_task = recurring_logic.tasks.find { |task| task.id != recurring_task.id }
+        new_task.execution_plan.delay_record.args.must_equal args
+        new_task.start_at.must_equal(recurring_task.start_at + 1.year)
+      end
+
+      specify 'it triggers the repeat when the task goes into planned state' do
+        delay_options = recurring_logic.generate_delay_options
+        task = ForemanTasks.delay HookedAction, delay_options, args
+        recurring_logic.tasks.count.must_equal 1
+
+        # Perform planning of the delayed plan
+        task.execution_plan.delay_record.plan
+
+        # Check a repetition was planned
+        recurring_logic.tasks.count.must_equal 2
+      end
+
+      specify 'it does not trigger repeat when failing in run' do
+        delay_options = recurring_logic.generate_delay_options
+        task = ForemanTasks.delay HookedAction, delay_options, true, args.last
+        recurring_logic.tasks.count.must_equal 1
+
+        # Perform the planning (trigger repeat)
+        task.execution_plan.delay_record.plan
+        recurring_logic.tasks.count.must_equal 2
+
+        # Let it fail
+        task.execution_plan.delay_record.execute.finished.wait
+        task.reload
+        task.result.must_equal 'error'
+
+        # Check no new repetitions were planned
+        recurring_logic.tasks.count.must_equal 2
+      end
+    end
+  end
+end

data/test/unit/recurring_logic_test.rb

@@ -106,6 +106,13 @@ class RecurringLogicsTest < ActiveSupport::TestCase
       logic.end_time.must_be_close_to(triggering.end_time, 1.second)
     end
 
+    it 'cannot trigger tasks when cancelled' do
+      recurring_logic = ForemanTasks::RecurringLogic.new_from_cronline('* * * * *')
+      recurring_logic.state = 'cancelled'
+      recurring_logic.expects(:can_continue?).never
+      recurring_logic.trigger_repeat('this is not important', 'neither is this')
+    end
+
     describe 'validation' do
       let(:logic) { FactoryBot.build(:recurring_logic) }
 

data/test/unit/task_test.rb

@@ -122,7 +122,7 @@ class TasksTest < ActiveSupport::TestCase
 
   describe 'recurring task' do
     let(:logic) { FactoryBot.build(:recurring_logic) }
-    let(:task) { FactoryBot.create(:some_task) }
+    let(:task) { FactoryBot.create(:dynflow_task) }
 
     it 'can indicate it is recurring' do
       refute task.recurring?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.13.0
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreman-tasks-core
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.29
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.29
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -144,6 +144,7 @@ files:
 - app/lib/actions/middleware/rails_executor_wrap.rb
 - app/lib/actions/middleware/recurring_logic.rb
 - app/lib/actions/proxy_action.rb
+- app/lib/actions/recurring_action.rb
 - app/lib/actions/serializers/active_record_serializer.rb
 - app/lib/proxy_api/foreman_dynflow/dynflow_proxy.rb
 - app/models/foreman_tasks/concerns/action_subject.rb
@@ -244,12 +245,15 @@ 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_taxonomies_test.rb
+- test/lib/actions/middleware/keep_current_user_test.rb
 - test/support/dummy_dynflow_action.rb
 - test/support/dummy_proxy_action.rb
 - 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/proxy_action_test.rb
+- test/unit/actions/recurring_action_test.rb
 - test/unit/cleaner_test.rb
 - test/unit/config/environment.rb
 - test/unit/dynflow_console_authorizer_test.rb
@@ -279,7 +283,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Foreman plugin for showing tasks information for resoruces and users
@@ -293,12 +297,15 @@ 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_taxonomies_test.rb
+- test/lib/actions/middleware/keep_current_user_test.rb
 - test/support/dummy_dynflow_action.rb
 - test/support/dummy_proxy_action.rb
 - 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/proxy_action_test.rb
+- test/unit/actions/recurring_action_test.rb
 - test/unit/cleaner_test.rb
 - test/unit/config/environment.rb
 - test/unit/dynflow_console_authorizer_test.rb