foreman-tasks 0.13.4 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fac96114cba4bed5007f60b44da68f30a3660951
-  data.tar.gz: ad625aafcc0ef55569672bd5864813555051c9ff
+  metadata.gz: 99bc7ed098375451dddebc63a0d2c5af37ec3374
+  data.tar.gz: 573580a8808e4c68f84a82db9a05919b960aa771
 SHA512:
-  metadata.gz: 2fe01c9e536d2b991bd452e226935e4832945d92b34e184226dddfd1ddc3f33588ec11ebb4b93ae24a50b772eba0e715d9744a11c6b3edef6907ebebd20bdb27
-  data.tar.gz: 22d258e052528cf2d9ff5f2c3579e9c5bb4c83eb719722edd344b187631d1d74b3bb50d1ccb5d8d64645a3c94a49e2bc0fd3f0a8b5caea14e544c4c700e0527a
+  metadata.gz: 9f37b871477d68c476aef947749d516337e3ae8fe5d71bc7f49f82bc5f0467fa265ac324661cb3ad9a2e7368159e92e017e101cd940422b2f1eaea24e4960948
+  data.tar.gz: a11510b41ff6b00d8d76acaa01a3dede47792c732711ee916e86979e2f56cd02ca861a8d648673ac34e9d8d0bf73452677029969557311446c90b391ecebcb24

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

@@ -2,6 +2,7 @@ module ForemanTasks
   module Api
     class RecurringLogicsController < ::Api::V2::BaseController
       include ::Api::Version2
+      include Concerns::Parameters::RecurringLogic
 
       resource_description do
         resource_id 'recurring_logics'
@@ -9,7 +10,7 @@ module ForemanTasks
         api_base_url '/foreman_tasks/api'
       end
 
-      before_action :find_resource, :only => %w[show cancel]
+      before_action :find_resource, :only => %w[show cancel update]
 
       api :GET, '/recurring_logics', N_('List recurring logics')
       param_group :search_and_pagination, ::Api::V2::BaseController
@@ -21,6 +22,13 @@ module ForemanTasks
       param :id, :identifier, desc: 'ID of the recurring logic', required: true
       def show; end
 
+      api :PUT, '/recurring_logics/:id', N_('Update recurring logic')
+      param :id, :identifier, desc: 'ID of the recurring logic', required: true
+      param :enabled, :boolean, desc: 'Whether the recurring logic is enabled or disabled.', required: false
+      def update
+        process_response @recurring_logic.update(recurring_logic_params)
+      end
+
       api :POST, '/recurring_logics/:id/cancel', N_('Cancel recurring logic')
       param :id, :identifier, desc: 'ID of the recurring logic', required: true
       def cancel

data/app/controllers/foreman_tasks/concerns/parameters/recurring_logic.rb

@@ -0,0 +1,21 @@
+module ForemanTasks
+  module Concerns
+    module Parameters
+      module RecurringLogic
+        extend ActiveSupport::Concern
+
+        class_methods do
+          def recurring_logic_params_filter
+            Foreman::ParameterFilter.new(::ForemanTasks::RecurringLogic).tap do |filter|
+              filter.permit(:enabled)
+            end
+          end
+        end
+
+        def recurring_logic_params
+          self.class.recurring_logic_params_filter.filter_params(params, parameter_filter_context, :recurring_logic)
+        end
+      end
+    end
+  end
+end

data/app/controllers/foreman_tasks/recurring_logics_controller.rb

@@ -1,13 +1,22 @@
 module ForemanTasks
   class RecurringLogicsController < ::ApplicationController
-    before_action :find_recurring_logic, :only => [:show, :cancel]
+    before_action :find_recurring_logic, :only => [:show, :cancel, :enable, :disable]
 
     def index
+      @errors = params[:errors]
       @recurring_logics = filter(resource_base)
     end
 
     def show; end
 
+    def enable
+      change_enabled(true)
+    end
+
+    def disable
+      change_enabled(false)
+    end
+
     def cancel
       @recurring_logic.cancel
       redirect_to :action => :index
@@ -23,6 +32,15 @@ module ForemanTasks
 
     private
 
+    def change_enabled(value)
+      begin
+        @recurring_logic.update!(:enabled => value)
+      rescue RecurringLogicCancelledException => e
+        @errors = e.message
+      end
+      redirect_to :action => :index, :errors => @errors
+    end
+
     def find_recurring_logic
       @recurring_logic ||= ::ForemanTasks::RecurringLogic.find(params[:id])
     end

data/app/helpers/foreman_tasks/foreman_tasks_helper.rb

@@ -1,9 +1,12 @@
 module ForemanTasks
+  # rubocop:disable Metrics/ModuleLength
   module ForemanTasksHelper
     def recurring_logic_state(recurring_logic)
       icon, status = case recurring_logic.state
                      when 'active'
                        'glyphicon-info-sign'
+                     when 'disabled'
+                       'glyphicon glyphicon-pause'
                      when 'finished'
                        ['glyphicon-ok-sign', 'status-ok']
                      when 'cancelled'
@@ -52,14 +55,16 @@ module ForemanTasks
     def recurring_logic_action_buttons(recurring_logic)
       buttons = []
       if authorized_for(:permission => :edit_recurring_logics, :auth_object => recurring_logic)
-        buttons << link_to(N_('Cancel'), cancel_foreman_tasks_recurring_logic_path(recurring_logic), :method => :post, :class => 'btn btn-danger') unless %w[cancelled finished].include? recurring_logic.state
+        buttons << link_to(N_('Enable'), enable_foreman_tasks_recurring_logic_path(recurring_logic), :method => :put, :class => '') if !recurring_logic.done? && recurring_logic.disabled?
+        buttons << link_to(N_('Disable'), disable_foreman_tasks_recurring_logic_path(recurring_logic), :method => :put, :class => '') if !recurring_logic.done? && recurring_logic.enabled?
+        buttons << link_to(N_('Cancel'), cancel_foreman_tasks_recurring_logic_path(recurring_logic), :method => :post, :class => '') unless recurring_logic.done?
       end
-      button_group buttons
+      action_buttons buttons
     end
 
     def recurring_logic_next_occurrence(recurring_logic)
       default = '-'
-      return default if %w[finished cancelled].include? recurring_logic.state
+      return default if recurring_logic.done? || recurring_logic.disabled?
 
       last_task = recurring_logic.tasks.order(:start_at).last
       last_task ? last_task.start_at : default
@@ -197,4 +202,5 @@ module ForemanTasks
       tags.join.html_safe
     end
   end
+  # rubocop:enable Metrics/ModuleLength
 end

data/app/models/foreman_tasks/recurring_logic.rb

@@ -20,7 +20,30 @@ module ForemanTasks
     end
 
     def self.allowed_states
-      %w[active finished cancelled failed]
+      %w[active disabled finished cancelled failed]
+    end
+
+    def enabled=(value)
+      task = tasks.find_by(:state => :scheduled)
+      if task
+        ForemanTasks.dynflow.world.persistence.set_delayed_plan_frozen(task.execution_plan.id, !value, next_occurrence_time)
+        if value
+          task.update!(:start_at => next_occurrence_time) if task.start_at < Time.zone.now
+          update(:state => 'active')
+        else
+          update(:state => 'disabled')
+        end
+      else
+        raise RecurringLogicCancelledException
+      end
+    end
+
+    def enabled?
+      state != 'disabled'
+    end
+
+    def disabled?
+      !enabled?
     end
 
     def start(action_class, *args)
@@ -67,7 +90,8 @@ module ForemanTasks
       {
         :start_at => next_occurrence_time(time),
         :start_before => options['start_before'],
-        :recurring_logic_id => id
+        :recurring_logic_id => id,
+        :frozen => disabled?
       }
     end
 
@@ -87,7 +111,7 @@ module ForemanTasks
     end
 
     def can_continue?(time = Time.zone.now)
-      state == 'active' && can_start?(time)
+      %w[active disabled].include?(state) && can_start?(time)
     end
 
     def finished?
@@ -98,6 +122,10 @@ module ForemanTasks
       state == 'cancelled'
     end
 
+    def done?
+      %w[cancelled finished].include?(state)
+    end
+
     def humanized_state
       case state
       when 'active'
@@ -106,6 +134,8 @@ module ForemanTasks
         N_('Cancelled')
       when 'finished'
         N_('Finished')
+      when 'disabled'
+        N_('Disabled')
       else
         N_('N/A')
       end

data/app/models/foreman_tasks/recurring_logic_cancelled_exception.rb

@@ -0,0 +1,7 @@
+module ForemanTasks
+  class RecurringLogicCancelledException < ::Foreman::Exception
+    def initialize(msg = N_("Cannot update a cancelled Recurring Logic."))
+      super
+    end
+  end
+end

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

@@ -65,6 +65,14 @@ module ForemanTasks
       nil
     end
 
+    def frozen
+      delayed_plan.try(:frozen)
+    end
+
+    def delayed_plan
+      ForemanTasks.dynflow.world.persistence.load_delayed_plan(external_id) if state == :scheduled
+    end
+
     def execution_plan!
       execution_plan(false)
     end

data/app/views/foreman_tasks/api/recurring_logics/update.json.rabl

@@ -0,0 +1,3 @@
+object @recurring_logic
+
+extends "foreman_tasks/api/recurring_logics/show"

data/app/views/foreman_tasks/recurring_logics/index.html.erb

@@ -1,6 +1,10 @@
 <% title _("Recurring logics") %>
 <% title_actions SETTINGS[:version].short <= '1.13' ? help_path : help_button %>
 
+<% if @errors %>
+<%= alert(:class => 'alert-info', :id => 'multiple-alert', :close => false, :header => '', :text => @errors) %>
+<% end %>
+
 <table class="<%= table_css_classes('table-condensed table-fixed') %>">
   <thead>
     <th><%= N_("Cron line") %></th>

data/app/views/foreman_tasks/tasks/_details.html.erb

@@ -114,7 +114,7 @@
     </div>
     <div>
       <span class="param-name list-group-item-heading"><%= _("Execution type") %>:</span>
-      <span class="param-value"><%= _(@task.execution_type) %></span>
+      <span class="param-value"><%= _(@task.execution_type) %> <%= _("(Disabled)") if @task.frozen %></span>
     </div>
   </div>
 

data/app/views/foreman_tasks/tasks/index.html.erb

@@ -17,7 +17,7 @@
         <%= link_to_if_authorized(format_task_input(task),
                                   hash_for_foreman_tasks_task_path(:id => task)) %>
       </td>
-      <td class="ellipsis"><%= task.state %></td>
+      <td class="ellipsis"><%= task.state %> <%= _("(Disabled)") if task.frozen %></td>
       <td class="ellipsis"><%= task.result %></td>
       <td class="ellipsis"><%= task.started_at.try(:in_time_zone) %></td>
       <td class="ellipsis"><%= task.ended_at.try(:in_time_zone) %></td>

data/config/routes.rb

@@ -3,6 +3,8 @@ Foreman::Application.routes.draw do
     resources :recurring_logics, :only => [:index, :show] do
       member do
         post :cancel
+        put :enable
+        put :disable
       end
     end
 
@@ -22,7 +24,7 @@ Foreman::Application.routes.draw do
     end
 
     namespace :api do
-      resources :recurring_logics, :only => [:index, :show] do
+      resources :recurring_logics, :only => [:index, :show, :update] do
         member do
           post :cancel
         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.0.5'
+  s.add_dependency "dynflow", '~> 1.0', '>= 1.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/engine.rb

@@ -66,8 +66,8 @@ module ForemanTasks
           permission :view_recurring_logics, { :'foreman_tasks/recurring_logics' => [:index, :show],
                                                :'foreman_tasks/api/recurring_logics' => [:index, :show] }, :resource_type => ForemanTasks::RecurringLogic.name
 
-          permission :edit_recurring_logics, { :'foreman_tasks/recurring_logics' => [:cancel],
-                                               :'foreman_tasks/api/recurring_logics' => [:cancel] }, :resource_type => ForemanTasks::RecurringLogic.name
+          permission :edit_recurring_logics, { :'foreman_tasks/recurring_logics' => [:cancel, :enable, :disable],
+                                               :'foreman_tasks/api/recurring_logics' => [:cancel, :update] }, :resource_type => ForemanTasks::RecurringLogic.name
         end
 
         add_all_permissions_to_default_roles

data/lib/foreman_tasks/version.rb

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

data/test/controllers/api/recurring_logics_controller_test.rb

@@ -28,6 +28,17 @@ module ForemanRecurringLogic
         end
       end
 
+      describe 'PUT /api/recurring_logics/:id' do
+        it 'updates a recurring logic' do
+          @recurring_logic.start(::Support::DummyRecurringDynflowAction)
+
+          put :update, params: { :id => @recurring_logic.id, :recurring_logic => { :enabled => false } }
+          assert_response :success
+          assert_template 'api/recurring_logics/update'
+          assert @recurring_logic.reload.disabled?
+        end
+      end
+
       describe 'POST /api/recurring_logics/:id/cancel' do
         it 'cancels recurring logic' do
           post :cancel, params: { :id => @recurring_logic.id }

data/test/controllers/recurring_logics_controller_test.rb

@@ -1,14 +1,37 @@
+require 'test_helper'
 require 'foreman_tasks_test_helper'
 
 module ForemanTasks
   class RecurringLogicsControllerTest < ActionController::TestCase
-    basic_index_test('recurring_logics')
-    basic_pagination_per_page_test
+    describe ForemanTasks::RecurringLogicsController do
+      basic_index_test('recurring_logics')
+      basic_pagination_per_page_test
 
-    # rubocop:disable Naming/AccessorMethodName
-    def get_factory_name
-      :recurring_logic
+      # rubocop:disable Naming/AccessorMethodName
+      def get_factory_name
+        :recurring_logic
+      end
+      # rubocop:enable Naming/AccessorMethodName
+
+      describe 'PUT /recurring_logics/ID/enable' do
+        let(:recurring_logic) do
+          recurring_logic = FactoryBot.create(:recurring_logic)
+          recurring_logic.start(::Support::DummyRecurringDynflowAction)
+          recurring_logic
+        end
+
+        it 'disables' do
+          put :enable, params: { :id => recurring_logic.id }, session: set_session_user
+          assert_redirected_to '/foreman_tasks/recurring_logics'
+        end
+
+        it 'enables' do
+          recurring_logic.update(:enabled => false)
+          put :disable, params: { :id => recurring_logic.id }, session: set_session_user
+
+          assert_redirected_to '/foreman_tasks/recurring_logics'
+        end
+      end
     end
-    # rubocop:enable Naming/AccessorMethodName
   end
 end

data/test/unit/recurring_logic_test.rb

@@ -75,7 +75,7 @@ class RecurringLogicsTest < ActiveSupport::TestCase
       parser = ForemanTasks::RecurringLogic.new_from_cronline('* * * * *')
       parser.stubs(:id).returns(1)
       reference_time = Time.utc(2015, 9, 29, 15)
-      expected_hash = { :start_at => reference_time + 60, :start_before => nil, :recurring_logic_id => parser.id }
+      expected_hash = { :start_at => reference_time + 60, :start_before => nil, :recurring_logic_id => parser.id, :frozen => false }
       parser.generate_delay_options(reference_time).must_equal expected_hash
       parser.generate_delay_options(reference_time, 'start_before' => reference_time + 3600)
             .must_equal expected_hash.merge(:start_before => reference_time + 3600)
@@ -122,6 +122,36 @@ class RecurringLogicsTest < ActiveSupport::TestCase
       recurring_logic.trigger_repeat('this is not important', 'neither is this')
     end
 
+    describe 'enable/disable' do
+      let(:logic) do
+        recurring_logic = ForemanTasks::RecurringLogic.new_from_cronline('0 15 * * *')
+
+        future_time = Time.zone.now - 1.week
+        recurring_logic.start(::Support::DummyRecurringDynflowAction, future_time)
+        recurring_logic
+      end
+
+      it 'properly updates on disable' do
+        logic.update!(:enabled => false)
+
+        assert_equal 'disabled', logic.state
+
+        task = logic.tasks.find_by(:state => 'scheduled')
+        assert ForemanTasks.dynflow.world.persistence.load_delayed_plan(task.execution_plan.id).frozen
+      end
+
+      it 'properly re-enables on disable' do
+        logic.update!(:enabled => false)
+        logic.update!(:enabled => true)
+
+        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 task.start_at > Time.zone.now
+      end
+    end
+
     describe 'validation' do
       let(:logic) { FactoryBot.build(:recurring_logic) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 0.13.4
+  version: 0.14.0
 platform: ruby
 authors:
 - Ivan Nečas
@@ -33,7 +33,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -127,6 +127,7 @@ files:
 - app/controllers/foreman_tasks/api/recurring_logics_controller.rb
 - app/controllers/foreman_tasks/api/tasks_controller.rb
 - app/controllers/foreman_tasks/concerns/hosts_controller_extension.rb
+- app/controllers/foreman_tasks/concerns/parameters/recurring_logic.rb
 - app/controllers/foreman_tasks/concerns/parameters/triggering.rb
 - app/controllers/foreman_tasks/recurring_logics_controller.rb
 - app/controllers/foreman_tasks/tasks_controller.rb
@@ -159,6 +160,7 @@ files:
 - app/models/foreman_tasks/concerns/host_action_subject.rb
 - app/models/foreman_tasks/lock.rb
 - app/models/foreman_tasks/recurring_logic.rb
+- app/models/foreman_tasks/recurring_logic_cancelled_exception.rb
 - app/models/foreman_tasks/remote_task.rb
 - app/models/foreman_tasks/task.rb
 - app/models/foreman_tasks/task/dynflow_task.rb
@@ -176,6 +178,7 @@ files:
 - app/views/foreman_tasks/api/recurring_logics/index.json.rabl
 - app/views/foreman_tasks/api/recurring_logics/main.json.rabl
 - app/views/foreman_tasks/api/recurring_logics/show.json.rabl
+- app/views/foreman_tasks/api/recurring_logics/update.json.rabl
 - app/views/foreman_tasks/api/tasks/show.json.rabl
 - app/views/foreman_tasks/recurring_logics/_tab_related.html.erb
 - app/views/foreman_tasks/recurring_logics/index.html.erb