foreman-tasks 1.0.1 → 1.1.0

data/app/models/foreman_tasks/concerns/action_triggering.rb

@@ -158,7 +158,7 @@ module ForemanTasks
             end
           end
         end
-        return true
+        true
       ensure
         # to not execute the same execution plan twice in a row
         @execution_plan = nil

data/app/models/foreman_tasks/recurring_logic.rb

@@ -14,6 +14,7 @@ module ForemanTasks
     scoped_search :on => :max_iteration, :complete_value => false, :rename => :iteration_limit
     scoped_search :on => :iteration, :complete_value => false
     scoped_search :on => :cron_line, :complete_value => true
+    scoped_search :on => :state, :complete_value => true
 
     before_create do
       task_group.save

data/app/models/foreman_tasks/remote_task.rb

@@ -9,6 +9,7 @@ module ForemanTasks
 
     scope :triggered, -> { where(:state => 'triggered') }
     scope :pending,   -> { where(:state => 'new') }
+    scope :external,  -> { where(:state => 'external') }
 
     delegate :proxy_action_name, :to => :action
 

data/app/models/foreman_tasks/task.rb

@@ -42,6 +42,10 @@ module ForemanTasks
     scoped_search :on => :start_at, :complete_value => false
     scoped_search :on => :ended_at, :complete_value => false
     scoped_search :on => :parent_task_id, :complete_value => true
+    scoped_search :on => :duration, :complete_value => false, :ext_method => :search_by_duration, :operators => %w[> >= = <= <], :only_explicit => true
+
+    # Note: the following searches may return duplicates, this is due to
+    #       one task maybe having multiple locks (e.g. read/write) for the same resource_id
     scoped_search :relation => :locks,  :on => :resource_id, :complete_value => false, :rename => 'location_id', :ext_method => :search_by_taxonomy, :only_explicit => true
     scoped_search :relation => :locks,  :on => :resource_id, :complete_value => false, :rename => 'organization_id', :ext_method => :search_by_taxonomy, :only_explicit => true
     scoped_search :relation => :locks,  :on => :resource_type, :complete_value => true, :rename => 'resource_type', :ext_method => :search_by_generic_resource, :only_explicit => true

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

@@ -228,7 +228,7 @@ module ForemanTasks
           # if we fail updating the data from dynflow, it usually means there is something
           # odd with the data consistency and at this point it is not possible to resume, switching
           # the task to stopped/error
-          task.update_attributes(:state => 'stopped', :result => 'error')
+          task.update(:state => 'stopped', :result => 'error')
           Foreman::Logging.exception("Failed at consistency check for task #{task.id}", e, :logger => 'foreman-tasks')
         end
       end

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

@@ -4,7 +4,8 @@ module ForemanTasks
       def search_by_generic_resource(key, operator, value)
         key = 'resource_type' if key.blank?
         key_name = connection.quote_column_name(key.sub(/^.*\./, ''))
-        condition = sanitize_sql_for_conditions(["foreman_tasks_locks.#{key_name} #{operator} ?", value])
+        value = value.split(',') if operator.index(/IN/i)
+        condition = sanitize_sql_for_conditions(["foreman_tasks_locks.#{key_name} #{operator} (?)", value])
 
         { :conditions => condition, :joins => :locks }
       end
@@ -22,6 +23,15 @@ 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
+
+      # Expects the time in the format "\d+ (seconds|minutes|hours|days|months|years)"
+      SUPPORTED_DURATION_FORMAT = /\A\s*(\d+(\s+\b(seconds?|minutes?|hours?|days?|months?|years?)\b)?)\b\s*\z/i.freeze
+      def search_by_duration(_key, operator, value)
+        raise "Unsupported duration '#{value}' specified for searching" unless value =~ SUPPORTED_DURATION_FORMAT
+        value = value.strip
+        { :conditions => "coalesce(ended_at, current_timestamp) - coalesce(coalesce(started_at, ended_at), current_timestamp) #{operator} ?::interval",
+          :parameter => [value] }
+      end
     end
   end
 end

data/app/services/foreman_tasks/troubleshooting_help_generator.rb

@@ -44,10 +44,6 @@ module ForemanTasks
       # rubocop:enable Rails/OutputSafety
     end
 
-    def generate_text
-      (description + link_descriptions_html).join("\n")
-    end
-
     def link_descriptions_html
       links.map do |link|
         link.description % { link: %(<a href="%{href}">%{title}</a>) % link.to_h }

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

@@ -1,3 +1,4 @@
 object @recurring_logic
 
-attributes :id, :cron_line, :end_time, :iteration, :task_group_id, :state
+attributes :id, :cron_line, :end_time, :iteration, :task_group_id, :state,
+           :max_iteration

data/app/views/foreman_tasks/api/tasks/details.json.rabl

@@ -16,3 +16,4 @@ node(:locks) do
   end
 end
 node(:username_path) { username_link_task(@task.owner, @task.username) }
+node(:dynflow_enable_console) { Setting['dynflow_enable_console'] }

data/app/views/foreman_tasks/api/tasks/show.json.rabl

@@ -2,5 +2,5 @@ object @task if @task
 
 attributes :id, :label, :pending, :action
 attributes :username, :started_at, :ended_at, :state, :result, :progress
-attributes :input, :output, :humanized, :cli_example
+attributes :input, :output, :humanized, :cli_example, :start_at
 node(:available_actions) { |t| { cancellable: t.execution_plan&.cancellable?, resumable: t.resumable? } }

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

@@ -5,6 +5,36 @@
 <%= alert(:class => 'alert-info', :id => 'multiple-alert', :close => false, :header => '', :text => @errors) %>
 <% end %>
 
+<% if authorized_for(:permission => :edit_recurring_logics, :auth_object => @recurring_logics) %>
+  <% title_actions link_to(_('Clear Cancelled'),
+              clear_cancelled_foreman_tasks_recurring_logics_path,
+              class:  ['btn', 'btn-sm', 'btn-danger'],                  
+              :'data-toggle' => "modal",
+              :'data-target' => "#clear_modal") 
+              %>
+
+  <div class="modal fade" id="clear_modal" tabindex="-1" role="dialog" aria-labelledby="Deploy" aria-hidden="true">
+    <div class="modal-dialog">
+      <div class="modal-content">
+        <div class="modal-header">
+          <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
+          <h2 class="modal-title" id="deploy_modal_label">
+            <span class="glyphicon glyphicon-warning-sign"></span>
+            <%= _("Clear Cancelled") %>
+          </h2>
+        </div>
+        <div class="modal-body">
+          <%= _("This action will delete all cancelled recurring logics. Please note that this action can't be reversed.") %>
+        </div>
+        <div class="modal-footer">
+          <button type="button" class="btn btn-default" data-dismiss="modal"><%= _("Cancel") %></button>
+          <%= link_to(_('Clear Cancelled'), clear_cancelled_foreman_tasks_recurring_logics_path, method: :post, class: 'btn btn-danger modal-submit') %>
+        </div>
+      </div>
+    </div>
+  </div>
+<% end %>
+
 <table class="<%= table_css_classes('table-condensed table-fixed') %>">
   <thead>
     <th><%= N_("Cron line") %></th>

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

@@ -5,6 +5,9 @@
 <% content_for(:stylesheets) do %>
   <%= webpacked_plugins_css_for :'foreman-tasks' %>
 <% end %>
+
+<% title _("Details of %s task") % @task.to_s %>
+
 <%= breadcrumbs(
   items: breadcrumb_items,
   name_field: 'action',

data/config/routes.rb

@@ -6,6 +6,9 @@ Foreman::Application.routes.draw do
         put :enable
         put :disable
       end
+      collection do
+        post :clear_cancelled
+      end
     end
 
     resources :tasks, :only => [:show] do
@@ -39,6 +42,9 @@ Foreman::Application.routes.draw do
         member do
           post :cancel
         end
+        collection do
+          post :bulk_destroy
+        end
       end
 
       resources :tasks, :only => [:show, :index] do
@@ -49,6 +55,7 @@ Foreman::Application.routes.draw do
         collection do
           post :bulk_search
           post :bulk_resume
+          post :bulk_cancel
           get :summary
           get '/summary/:id/sub_tasks/', action: 'summary_sub_tasks'
           post :callback

data/foreman-tasks.gemspec

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 
 # Maintain your gem's version:
 require "foreman_tasks/version"
@@ -29,11 +27,11 @@ same resource. It also optionally provides Dynflow infrastructure for using it f
   s.test_files = `git ls-files test`.split("\n")
   s.extra_rdoc_files = Dir['README*', 'LICENSE']
 
-  s.add_dependency "foreman-tasks-core"
   s.add_dependency "dynflow", '>= 1.2.3'
-  s.add_dependency "sinatra" # for Dynflow web console
-  s.add_dependency "parse-cron", '~> 0.1.4'
+  s.add_dependency "foreman-tasks-core"
   s.add_dependency "get_process_mem" # for memory polling
+  s.add_dependency "parse-cron", '~> 0.1.4'
+  s.add_dependency "sinatra" # for Dynflow web console
 
   s.add_development_dependency 'factory_bot_rails', '~> 4.8.0'
 end

data/lib/foreman_tasks/dynflow/console_authorizer.rb

@@ -34,7 +34,7 @@ module ForemanTasks
       # console no matter what task it is...
       edit_permission = Permission.where(:name => :edit_foreman_tasks, :resource_type => ForemanTasks::Task.name).first
       if @user.filters.joins(:filterings).unlimited.where('filterings.permission_id' => edit_permission).first
-        return true
+        true
       end
     end
 
@@ -43,7 +43,7 @@ module ForemanTasks
         begin
           original_user = User.current
           User.current = @user
-          return Authorizer.new(@user).can?(:edit_foreman_tasks, task)
+          Authorizer.new(@user).can?(:edit_foreman_tasks, task)
         ensure
           User.current = original_user
         end

data/lib/foreman_tasks/engine.rb

@@ -7,10 +7,10 @@ module ForemanTasks
     engine_name 'foreman_tasks'
 
     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
+      require_dependency File.expand_path('../../app/models/setting/foreman_tasks.rb', __dir__) if begin
                                                                                                          Setting.table_exists?
-                                                                                                       rescue
-                                                                                                         false
+                                                                                                   rescue
+                                                                                                     false
                                                                                                        end
     end
 
@@ -26,7 +26,7 @@ module ForemanTasks
     end
 
     initializer 'foreman_tasks.register_gettext', :after => :load_config_initializers do
-      locale_dir = File.join(File.expand_path('../../..', __FILE__), 'locale')
+      locale_dir = File.join(File.expand_path('../..', __dir__), 'locale')
       locale_domain = 'foreman_tasks'
 
       Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
@@ -53,15 +53,15 @@ module ForemanTasks
                                             :'foreman_tasks/react' => [:index],
                                             :'foreman_tasks/api/tasks' => [:bulk_search, :show, :index, :summary, :summary_sub_tasks, :details, :sub_tasks] }, :resource_type => ForemanTasks::Task.name
           permission :edit_foreman_tasks, { :'foreman_tasks/tasks' => [:resume, :unlock, :force_unlock, :cancel_step, :cancel, :abort],
-                                            :'foreman_tasks/api/tasks' => [:bulk_resume] }, :resource_type => ForemanTasks::Task.name
+                                            :'foreman_tasks/api/tasks' => [:bulk_resume, :bulk_cancel] }, :resource_type => ForemanTasks::Task.name
 
           permission :create_recurring_logics, {}, :resource_type => ForemanTasks::RecurringLogic.name
 
           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, :enable, :disable],
-                                               :'foreman_tasks/api/recurring_logics' => [:cancel, :update] }, :resource_type => ForemanTasks::RecurringLogic.name
+          permission :edit_recurring_logics, { :'foreman_tasks/recurring_logics' => [:cancel, :enable, :disable, :clear_cancelled],
+                                               :'foreman_tasks/api/recurring_logics' => [:cancel, :update, :bulk_destroy] }, :resource_type => ForemanTasks::RecurringLogic.name
         end
 
         add_all_permissions_to_default_roles
@@ -69,8 +69,10 @@ module ForemanTasks
         logger :dynflow, :enabled => true
         logger :action, :enabled => true
 
-        role 'Tasks Manager', [:view_foreman_tasks, :edit_foreman_tasks]
-        role 'Tasks Reader', [:view_foreman_tasks]
+        role 'Tasks Manager', [:view_foreman_tasks, :edit_foreman_tasks],
+             'Role granting permissions to inspect, cancel, resume and unlock tasks'
+        role 'Tasks Reader', [:view_foreman_tasks],
+             'Role granting permissions to inspect tasks'
 
         widget 'foreman_tasks/tasks/dashboard/tasks_status', :sizex => 6, :sizey => 1, :name => N_('Task Status')
         widget 'foreman_tasks/tasks/dashboard/latest_tasks_in_error_warning', :sizex => 6, :sizey => 1, :name => N_('Latest Warning/Error Tasks')
@@ -133,16 +135,16 @@ module ForemanTasks
     # to enable async Foreman operations using Dynflow
     if ENV['FOREMAN_TASKS_MONKEYS'] == 'true'
       config.to_prepare do
-        ::Api::V2::HostsController.send :prepend, ForemanTasks::Concerns::HostsControllerExtension
-        ::Host::Base.send :include, ForemanTasks::Concerns::HostActionSubject
+        ::Api::V2::HostsController.prepend ForemanTasks::Concerns::HostsControllerExtension
+        ::Host::Base.include ForemanTasks::Concerns::HostActionSubject
       end
     end
 
     config.to_prepare do
       ForemanTasks.dynflow.eager_load_actions! if ForemanTasks.dynflow.initialized?
 
-      Authorizer.send(:prepend, AuthorizerExt)
-      User.send(:include, ForemanTasks::Concerns::UserExtensions)
+      Authorizer.prepend AuthorizerExt
+      User.include ForemanTasks::Concerns::UserExtensions
     end
 
     rake_tasks do

data/lib/foreman_tasks/tasks/cleanup.rake

@@ -1,6 +1,6 @@
 namespace :foreman_tasks do
   namespace :cleanup do
-    desc <<-DESC.strip_heredoc
+    desc <<~DESC
       Clean tasks based on filter and age. ENV variables:
 
         * TASK_SEARCH : scoped search filter (example: 'label = "Actions::Foreman::Host::ImportFacts"')

data/lib/foreman_tasks/tasks/export_tasks.rake

@@ -7,7 +7,7 @@
 require 'csv'
 
 namespace :foreman_tasks do
-  desc <<-DESC.strip_heredoc
+  desc <<~DESC
     Export dynflow tasks based on filter. ENV variables:
 
       * TASK_SEARCH     : scoped search filter (example: 'label = "Actions::Foreman::Host::ImportFacts"')
@@ -259,7 +259,7 @@ namespace :foreman_tasks do
 
         File.open(File.join(tmp_dir, 'index.html'), 'w') { |file| file.write(PageHelper.pagify(PageHelper.generate_index(tasks))) }
 
-        sh("tar cvzf #{export_filename} #{tmp_dir} > /dev/null")
+        system("tar", "czf", export_filename, tmp_dir)
       end
     elsif format == 'csv'
       CSV.open(export_filename, 'wb') do |csv|

data/lib/foreman_tasks/test_extensions.rb

@@ -14,4 +14,4 @@ module ForemanTasks
   end
 end
 
-ActiveSupport::TestCase.send(:include, ForemanTasks::TestExtensions::AccessPermissionsTestExtension)
+ActiveSupport::TestCase.include ForemanTasks::TestExtensions::AccessPermissionsTestExtension

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/locale/action_names.rb

@@ -2,4 +2,4 @@
 _("Remote action:")
 _("Import Puppet classes")
 _("Import facts")
-_("Action with sub plans")
+_("Action with sub plans")

data/package.json

@@ -27,6 +27,7 @@
   "dependencies": {
     "c3": "^0.4.11",
     "humanize-duration": "^3.20.1",
+    "react-html-parser": "^2.0.2",
     "react-intl": "^2.8.0"
   },
   "devDependencies": {
@@ -38,10 +39,8 @@
     "@theforeman/vendor-dev": "^4.0.2",
     "babel-eslint": "^10.0.3",
     "eslint": "^6.7.2",
-    "identity-obj-proxy": "^3.0.0",
     "jed": "^1.1.1",
     "prettier": "^1.13.5",
-    "react-remarkable": "^1.1.3",
     "stylelint": "^9.3.0",
     "stylelint-config-standard": "^18.0.0",
     "surge": "^0.20.3"

data/script/rails

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
 
-ENGINE_ROOT = File.expand_path('../..', __FILE__)
-ENGINE_PATH = File.expand_path('../../lib/foreman_tasks/engine', __FILE__)
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/foreman_tasks/engine', __dir__)
 
 require 'rails/all'
 require 'rails/engine/commands'

data/test/factories/task_factory.rb

@@ -22,7 +22,7 @@ FactoryBot.define do
         execution_plan = ForemanTasks.dynflow.world.plan(Support::DummyDynflowAction)
         # remove the task created automatically by the persistence
         ForemanTasks::Task.where(:external_id => execution_plan.id).delete_all
-        task.update_attributes!(:external_id => execution_plan.id)
+        task.update!(:external_id => execution_plan.id)
         if evaluator.sync_with_dynflow
           task.update_from_dynflow(execution_plan.to_hash)
         end
@@ -38,9 +38,41 @@ FactoryBot.define do
 
       trait :inconsistent_dynflow_task do
         after(:build) do |task|
-          task.update_attributes!(:state => 'running')
+          task.update!(:state => 'running')
+        end
+      end
+
+      factory :task_with_locks do
+        # posts_count is declared as a transient attribute and available in
+        # attributes on the factory, as well as the callback via the evaluator
+        transient do
+          locks_count { 3 }
+          resource_id { 1 }
+          resource_type { 'type1' }
+        end
+
+        # the after(:create) yields two values; the user instance itself and the
+        # evaluator, which stores all values from the factory, including transient
+        # attributes; `create_list`'s second argument is the number of records
+        # to create and we make sure the user is associated properly to the post
+        after(:create) do |task, evaluator|
+          create_list(
+            :lock,
+            evaluator.locks_count,
+            task: task,
+            resource_type: evaluator.resource_type,
+            resource_id: evaluator.resource_id
+          )
         end
       end
     end
   end
+
+  factory :lock, :class => ForemanTasks::Lock do
+    name { 'read' }
+    resource_type { 'Katello::Repository' }
+    resource_id { 1 }
+    exclusive { true }
+    association :task, factory: :task_with_locks
+  end
 end

data/test/foreman_tasks_test_helper.rb

@@ -27,3 +27,7 @@ def wait_for(waiting_message = 'something to happen')
   end
   raise "waiting for #{waiting_message} was not successful"
 end
+
+def on_postgresql?
+  ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
+end

data/test/unit/actions/action_with_sub_plans_test.rb

@@ -8,7 +8,7 @@ module ForemanTasks
     end
 
     # to be able to use the locking
-    ::User.send(:include, ForemanTasks::Concerns::ActionSubject)
+    ::User.include ForemanTasks::Concerns::ActionSubject
 
     class ParentAction < Actions::ActionWithSubPlans
       def plan(user)