foreman-tasks 9.2.3 → 10.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cd550a681ae53c5133f3017a5f8bee019a119cd0bdfb23d8b64c830304cd5c1
-  data.tar.gz: 195c7013c5c9c7ad31064cf3552fe10f6084a100b2903dc1753e10c62f2ef31f
+  metadata.gz: 4a7506ccab551c52f9408df7fcfca78e6a565753bc35ca7263bd2265a5aa95bf
+  data.tar.gz: 2a6a714e7cfc082139d7fd73f1f7c2547817e4e9ace0b02c681bad6b8f63043b
 SHA512:
-  metadata.gz: 93df3af963db3e2ac838954834bd54ef3d2ac21778fc1940bdb7971bb2f2de9e0bd7ed4abe6f7cbf9338cd636f7f3d4160b3eec25ca5eb5c7ca1586479fe13c1
-  data.tar.gz: 9c13f2ad52f111a01c501294f3a43e75188401b2d48fecaa39fdea214db3ea8ac1751828d5ce27d8c564a53741ffceff121cf3c0d918f3f5d41d890a66f43fcb
+  metadata.gz: 3c1f0897789b528c739a77a21b39b2471f841759472c2755228b288e698485c11aee37224106c96725cd858d98c970fbe71948adceeb1553b83931a75e817676
+  data.tar.gz: fe5eb0b8a95b15ada47a46b4839c79e5b45d43042a28ca13fd1ad318a1dbeb7afe0257138eea96b3006613baf4fe0ec7d51c98854347b1a5f908cea6eefabf77

data/.gitignore

@@ -16,3 +16,4 @@ locale/*/*.po.time_stamp
 node_modules
 package-lock.json
 coverage/
+locale/action_names.rb

data/Gemfile

@@ -1,5 +1,3 @@
 source "https://rubygems.org"
 
 gemspec
-
-gem 'theforeman-rubocop', '~> 0.1.0'

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

@@ -1,6 +1,6 @@
 module Actions
   module Middleware
-    class KeepCurrentRequestID < Dynflow::Middleware
+    class KeepCurrentRequestId < Dynflow::Middleware
       def delay(*args)
         pass(*args).tap { store_current_request_id }
       end

data/foreman-tasks.gemspec

@@ -33,4 +33,5 @@ same resource. It also optionally provides Dynflow infrastructure for using it f
 
   s.add_development_dependency 'factory_bot_rails', '~> 4.8.0'
   s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'theforeman-rubocop', '~> 0.1.0'
 end

data/lib/foreman_tasks/cleaner.rb

@@ -252,7 +252,7 @@ module ForemanTasks
 
     def prepare_filter
       filter_parts = [filter]
-      filter_parts << %(started_at < "#{after.ago.to_s(:db)}") if after > 0
+      filter_parts << %(started_at < "#{after.ago.to_formatted_s(:db)}") if after > 0
       filter_parts << "state ^ (#{states.join(',')})" if states.any?
       filter_parts.select(&:present?).map { |segment| "(#{segment})" }.join(' AND ')
     end

data/lib/foreman_tasks/engine.rb

@@ -16,116 +16,118 @@ module ForemanTasks
       SETTINGS[:foreman_tasks] = { :assets => { :precompile => assets_to_precompile } }
     end
 
-    initializer 'foreman_tasks.register_plugin', :before => :finisher_hook do |_app|
-      Foreman::Plugin.register :"foreman-tasks" do
-        requires_foreman '>= 3.9'
-        divider :top_menu, :parent => :monitor_menu, :last => true, :caption => N_('Foreman Tasks')
-        menu :top_menu, :tasks,
-             :url_hash => { :controller => 'foreman_tasks/tasks', :action => :index },
-             :caption  => N_('Tasks'),
-             :parent   => :monitor_menu,
-             :last     => true
-
-        menu :top_menu, :recurring_logics,
-             :url_hash => { :controller => 'foreman_tasks/recurring_logics', :action => :index },
-             :caption  => N_('Recurring Logics'),
-             :parent   => :monitor_menu,
-             :last     => true
-
-        security_block :foreman_tasks do |_map|
-          permission :view_foreman_tasks, { :'foreman_tasks/tasks' => [:auto_complete_search, :sub_tasks, :index, :summary, :summary_sub_tasks, :show],
-                                            :'foreman_tasks/react' => [:index],
-                                            :'foreman_tasks/api/tasks' => [:bulk_search, :show, :index, :summary, :summary_sub_tasks, :details, :sub_tasks] }, :resource_type => 'ForemanTasks::Task'
-          permission :edit_foreman_tasks, { :'foreman_tasks/tasks' => [:resume, :unlock, :force_unlock, :cancel_step, :cancel, :abort],
-                                            :'foreman_tasks/api/tasks' => [:bulk_resume, :bulk_cancel, :bulk_stop] }, :resource_type => 'ForemanTasks::Task'
-
-          permission :create_recurring_logics, {}, :resource_type => 'ForemanTasks::RecurringLogic'
-
-          permission :view_recurring_logics, { :'foreman_tasks/recurring_logics' => [:auto_complete_search, :index, :show],
-                                               :'foreman_tasks/api/recurring_logics' => [:index, :show] }, :resource_type => 'ForemanTasks::RecurringLogic'
-
-          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'
-        end
+    initializer 'foreman_tasks.register_plugin', :before => :finisher_hook do |app|
+      app.reloader.to_prepare do
+        Foreman::Plugin.register :"foreman-tasks" do
+          requires_foreman '>= 3.13'
+          divider :top_menu, :parent => :monitor_menu, :last => true, :caption => N_('Foreman Tasks')
+          menu :top_menu, :tasks,
+               :url_hash => { :controller => 'foreman_tasks/tasks', :action => :index },
+               :caption  => N_('Tasks'),
+               :parent   => :monitor_menu,
+               :last     => true
+
+          menu :top_menu, :recurring_logics,
+               :url_hash => { :controller => 'foreman_tasks/recurring_logics', :action => :index },
+               :caption  => N_('Recurring Logics'),
+               :parent   => :monitor_menu,
+               :last     => true
+
+          security_block :foreman_tasks do |_map|
+            permission :view_foreman_tasks, { :'foreman_tasks/tasks' => [:auto_complete_search, :sub_tasks, :index, :summary, :summary_sub_tasks, :show],
+                                              :'foreman_tasks/react' => [:index],
+                                              :'foreman_tasks/api/tasks' => [:bulk_search, :show, :index, :summary, :summary_sub_tasks, :details, :sub_tasks] }, :resource_type => 'ForemanTasks::Task'
+            permission :edit_foreman_tasks, { :'foreman_tasks/tasks' => [:resume, :unlock, :force_unlock, :cancel_step, :cancel, :abort],
+                                              :'foreman_tasks/api/tasks' => [:bulk_resume, :bulk_cancel, :bulk_stop] }, :resource_type => 'ForemanTasks::Task'
+
+            permission :create_recurring_logics, {}, :resource_type => 'ForemanTasks::RecurringLogic'
+
+            permission :view_recurring_logics, { :'foreman_tasks/recurring_logics' => [:auto_complete_search, :index, :show],
+                                                 :'foreman_tasks/api/recurring_logics' => [:index, :show] }, :resource_type => 'ForemanTasks::RecurringLogic'
+
+            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'
+          end
 
-        add_all_permissions_to_default_roles
-
-        settings do
-          category(:tasks, N_('Tasks')) do
-            setting('foreman_tasks_sync_task_timeout',
-                    type: :integer,
-                    description: N_('Number of seconds to wait for synchronous task to finish.'),
-                    default: 120,
-                    full_name: N_('Sync task timeout'))
-            setting('dynflow_enable_console',
-                    type: :boolean,
-                    description: N_('Enable the dynflow console (/foreman_tasks/dynflow) for debugging'),
-                    default: true,
-                    full_name: N_('Enable dynflow console'))
-            setting('dynflow_console_require_auth',
-                    type: :boolean,
-                    description: N_('Require user to be authenticated as user with admin rights when accessing dynflow console'),
-                    default: true,
-                    full_name: N_('Require auth for dynflow console'))
-            setting('foreman_tasks_proxy_action_retry_count',
-                    type: :integer,
-                    description: N_('Number of attempts to start a task on the smart proxy before failing'),
-                    default: 4,
-                    full_name: N_('Proxy action retry count'))
-            setting('foreman_tasks_proxy_action_retry_interval',
-                    type: :integer,
-                    description: N_('Time in seconds between retries'),
-                    default: 15,
-                    full_name: N_('Proxy action retry interval'))
-            setting('foreman_tasks_proxy_batch_trigger',
-                    type: :boolean,
-                    description: N_('Allow triggering tasks on the smart proxy in batches'),
-                    default: true,
-                    full_name: N_('Allow proxy batch tasks'))
-            setting('foreman_tasks_proxy_batch_size',
-                    type: :integer,
-                    description: N_('Number of tasks which should be sent to the smart proxy in one request, if foreman_tasks_proxy_batch_trigger is enabled'),
-                    default: 100,
-                    full_name: N_('Proxy tasks batch size'))
-            setting('foreman_tasks_troubleshooting_url',
-                    type: :string,
-                    description: N_('Url pointing to the task troubleshooting documentation. '\
-                                    'It should contain %{label} placeholder, that will be replaced with normalized task label '\
-                                    '(restricted to only alphanumeric characters)). %{version} placeholder is also available.'),
-                    default: nil,
-                    full_name: N_('Tasks troubleshooting URL'))
-            setting('foreman_tasks_polling_multiplier',
-                    type: :integer,
-                    description: N_('Polling multiplier which is used to multiply the default polling intervals. '\
-                         'This can be used to prevent polling too frequently for long running tasks.'),
-                    default: 1,
-                    full_name: N_("Polling intervals multiplier"),
-                    validate: { numericality: { greater_than: 0 } })
+          add_all_permissions_to_default_roles
+
+          settings do
+            category(:tasks, N_('Tasks')) do
+              setting('foreman_tasks_sync_task_timeout',
+                      type: :integer,
+                      description: N_('Number of seconds to wait for synchronous task to finish.'),
+                      default: 120,
+                      full_name: N_('Sync task timeout'))
+              setting('dynflow_enable_console',
+                      type: :boolean,
+                      description: N_('Enable the dynflow console (/foreman_tasks/dynflow) for debugging'),
+                      default: true,
+                      full_name: N_('Enable dynflow console'))
+              setting('dynflow_console_require_auth',
+                      type: :boolean,
+                      description: N_('Require user to be authenticated as user with admin rights when accessing dynflow console'),
+                      default: true,
+                      full_name: N_('Require auth for dynflow console'))
+              setting('foreman_tasks_proxy_action_retry_count',
+                      type: :integer,
+                      description: N_('Number of attempts to start a task on the smart proxy before failing'),
+                      default: 4,
+                      full_name: N_('Proxy action retry count'))
+              setting('foreman_tasks_proxy_action_retry_interval',
+                      type: :integer,
+                      description: N_('Time in seconds between retries'),
+                      default: 15,
+                      full_name: N_('Proxy action retry interval'))
+              setting('foreman_tasks_proxy_batch_trigger',
+                      type: :boolean,
+                      description: N_('Allow triggering tasks on the smart proxy in batches'),
+                      default: true,
+                      full_name: N_('Allow proxy batch tasks'))
+              setting('foreman_tasks_proxy_batch_size',
+                      type: :integer,
+                      description: N_('Number of tasks which should be sent to the smart proxy in one request, if foreman_tasks_proxy_batch_trigger is enabled'),
+                      default: 100,
+                      full_name: N_('Proxy tasks batch size'))
+              setting('foreman_tasks_troubleshooting_url',
+                      type: :string,
+                      description: N_('Url pointing to the task troubleshooting documentation. '\
+                                      'It should contain %{label} placeholder, that will be replaced with normalized task label '\
+                                      '(restricted to only alphanumeric characters)). %{version} placeholder is also available.'),
+                      default: nil,
+                      full_name: N_('Tasks troubleshooting URL'))
+              setting('foreman_tasks_polling_multiplier',
+                      type: :integer,
+                      description: N_('Polling multiplier which is used to multiply the default polling intervals. '\
+                           'This can be used to prevent polling too frequently for long running tasks.'),
+                      default: 1,
+                      full_name: N_("Polling intervals multiplier"),
+                      validate: { numericality: { greater_than: 0 } })
+            end
           end
-        end
 
-        register_graphql_query_field :task, '::Types::Task', :record_field
-        register_graphql_query_field :tasks, '::Types::Task', :collection_field
-        register_graphql_query_field :recurring_logic, '::Types::RecurringLogic', :record_field
-        register_graphql_query_field :recurring_logics, '::Types::RecurringLogic', :collection_field
+          register_graphql_query_field :task, '::Types::Task', :record_field
+          register_graphql_query_field :tasks, '::Types::Task', :collection_field
+          register_graphql_query_field :recurring_logic, '::Types::RecurringLogic', :record_field
+          register_graphql_query_field :recurring_logics, '::Types::RecurringLogic', :collection_field
 
-        register_graphql_mutation_field :cancel_recurring_logic, '::Mutations::RecurringLogics::Cancel'
+          register_graphql_mutation_field :cancel_recurring_logic, '::Mutations::RecurringLogics::Cancel'
 
-        logger :dynflow, :enabled => true
-        logger :action, :enabled => true
+          logger :dynflow, :enabled => true
+          logger :action, :enabled => true
 
-        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'
+          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')
+          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')
 
-        register_gettext domain: "foreman_tasks"
+          register_gettext domain: "foreman_tasks"
 
-        ForemanTasks.dynflow.eager_load_actions!
-        extend_observable_events(::Dynflow::Action.descendants.select { |klass| klass <= ::Actions::ObservableAction }.map(&:namespaced_event_names))
+          ForemanTasks.dynflow.eager_load_actions!
+          extend_observable_events(::Dynflow::Action.descendants.select { |klass| klass <= ::Actions::ObservableAction }.map(&:namespaced_event_names))
+        end
       end
     end
 
@@ -160,7 +162,7 @@ module ForemanTasks
         world.middleware.use Actions::Middleware::KeepCurrentTaxonomies
         world.middleware.use Actions::Middleware::KeepCurrentUser, :before => ::Dynflow::Middleware::Common::Transaction
         world.middleware.use Actions::Middleware::KeepCurrentTimezone
-        world.middleware.use Actions::Middleware::KeepCurrentRequestID
+        world.middleware.use Actions::Middleware::KeepCurrentRequestId
         world.middleware.use ::Actions::Middleware::LoadSettingValues
         ForemanTasks.register_scheduled_task(Actions::CheckLongRunningTasks, ENV['FOREMAN_TASKS_CHECK_LONG_RUNNING_TASKS_CRONLINE'] || '0 0 * * *')
       end

data/lib/foreman_tasks/tasks/export_tasks.rake

@@ -310,15 +310,15 @@ namespace :foreman_tasks do
     SKIP_ERRORS = ['true', '1', 'y', 'yes'].include? (ENV['SKIP_FAILED'] || '').downcase
 
     filter = if ENV['TASK_SEARCH'].nil? && ENV['TASK_DAYS'].nil?
-               "started_at > \"#{7.days.ago.to_s(:db)}\" || " \
-                 "(result != success && started_at > \"#{60.days.ago.to_s(:db)})\""
+               "started_at > \"#{7.days.ago.to_formatted_s(:db)}\" || " \
+                 "(result != success && started_at > \"#{60.days.ago.to_formatted_s(:db)})\""
              else
                ENV['TASK_SEARCH'] || ''
              end
 
     if (days = ENV['TASK_DAYS'])
       filter += ' && ' unless filter == ''
-      filter += "started_at > \"#{days.to_i.days.ago.to_s(:db)}\""
+      filter += "started_at > \"#{days.to_i.days.ago.to_formatted_s(:db)}\""
     end
 
     format = ENV['TASK_FORMAT'] || 'html'

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '9.2.3'.freeze
+  VERSION = '10.0.1'.freeze
 end

data/lib/tasks/gettext.rake

@@ -8,22 +8,33 @@ if gettext_find_task
   namespace :gettext do
     task :store_action_names => :environment do
       storage_file = "#{locale_path}/action_names.rb"
-      puts "writing action translations to: #{storage_file}"
-
-      klasses = Actions::EntryAction
-                .subclasses
-                .uniq
-                .select do |action|
-        src, = Object.const_source_location(action.to_s)
-        src.start_with? @engine.root.to_s
+      method_names = [:plan, :run, :finalize]
+      instances = Actions::EntryAction
+                  .descendants
+                  .uniq
+                  .map(&:allocate)
+                  .select do |action|
+        method_names.any? do |method_name|
+          if action.respond_to?(method_name)
+            src, = action.method(method_name).source_location
+            src.start_with? @engine.root.to_s
+          end
+        end
       end
 
-      File.write storage_file,
-                 "# Autogenerated!\n" +
-                 klasses
-                 .map { |klass| %[_("#{klass.allocate.humanized_name}")] }
-                 .sort
-                 .join("\n") + "\n"
+      if instances.any?
+        puts "writing action translations to: #{storage_file}"
+
+        File.write storage_file,
+                   "# Autogenerated!\n" +
+                   instances
+                   .map { |instance| %[_("#{instance.humanized_name}")] }
+                   .sort
+                   .join("\n") + "\n"
+      elsif File.exist? storage_file
+        puts "Removing empty action translations file: #{storage_file}"
+        File.delete storage_file
+      end
     end
   end
 

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

@@ -1,9 +1,9 @@
 require 'foreman_tasks_test_helper'
 
 module ForemanTasks
-  class KeepCurrentRequestIDTest < ActiveSupport::TestCase
+  class KeepCurrentRequestIdTest < ActiveSupport::TestCase
     class DummyAction < Actions::EntryAction
-      middleware.use ::Actions::Middleware::KeepCurrentRequestID
+      middleware.use ::Actions::Middleware::KeepCurrentRequestId
 
       def plan(plan = false)
         plan_self if plan
@@ -18,7 +18,7 @@ module ForemanTasks
       end
     end
 
-    describe Actions::Middleware::KeepCurrentRequestID do
+    describe Actions::Middleware::KeepCurrentRequestId do
       include ::Dynflow::Testing
 
       before { @old_id = ::Logging.mdc['request'] }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 9.2.3
+  version: 10.0.1
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-24 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dynflow
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: theforeman-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 description: |
   The goal of this plugin is to unify the way of showing task statuses across the Foreman instance.
   It defines Task model for keeping the information about the tasks and Lock for assigning the tasks
@@ -304,7 +318,6 @@ files:
 - lib/foreman_tasks/version.rb
 - lib/tasks/gettext.rake
 - locale/Makefile
-- locale/action_names.rb
 - locale/de/LC_MESSAGES/foreman_tasks.mo
 - locale/de/foreman_tasks.po
 - locale/en/LC_MESSAGES/foreman_tasks.mo

data/locale/action_names.rb

@@ -1,6 +0,0 @@
-# Autogenerated!
-_("Action with sub plans")
-_("Check for long running tasks")
-_("Deliver notifications about long running tasks")
-_("Import Puppet classes")
-_("Import facts")