foreman-tasks 11.0.0 → 11.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f24b857f3261425696740e1723b1e7b3aa3f0c1f69a33a7c466fb08f66b8c5a
-  data.tar.gz: 0b696984a0b211d2408208e5402147b2a2c4a5de94af8bd51177457ecbb14eb5
+  metadata.gz: 14937b8abb913127b2f1ab4028a967e25ed56ae35a476dc99dfd4bce07d9ec2a
+  data.tar.gz: 124922626f20e21268d8fd2c341be934af3d17a1e1fe9df34a61d8a90718508f
 SHA512:
-  metadata.gz: ae7c4ada68e2cefaa9d90229a3bd05bc43e12511028085f626af8d4de0c9ed4da006831eaebda82d8833ef37c31744d17639826accc2bb8b199e62b2b15be346
-  data.tar.gz: '078add200bd24fb484e0c2f5435dbad614c7fc535b09e03ed903ace00a297380fc332b62f48244a4c1a88730fe0c1dae65ee44662f020e6867169750d1339d49'
+  metadata.gz: ed4850116bdc86ba5118a2c1a08e4d475285f3236dee047f8b3c98c24c5eb4030b31a409b0293e5016153e92522f90ef31fccca48e901c7ca30f56b95f55d06b
+  data.tar.gz: c93ab2b4c78fac530e6bef4efca4c0baee0d03931522b15726526406881f8e538cec47dbba5ad863f86faca1a3ec025585453b3b47560435cd56fb1cd6fffb20

data/.github/workflows/js_tests.yml

@@ -1,33 +1,14 @@
 name: JavaScript Testing
+
 on:
+  push:
+    branches:
+      - master
   pull_request:
-    paths:
-      - 'webpack/**'
-      - 'package.json'
-      - '.github/workflows/js_tests.yml'
 
 jobs:
   test_js:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        node-version:
-          - 12
-          - 14
-    steps:
-      - uses: actions/checkout@v2
-      - name: Setup Node
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Npm install
-        run: npm install
-      - name: Run plugin linter
-        run: npm run lint
-      - name: Run plugin tests
-        run: npm run test
-      - name: Publish Coveralls
-        uses: coverallsapp/github-action@master
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+    name: JavaScript
+    uses: theforeman/actions/.github/workflows/foreman_plugin_js.yml@v0
+    with:
+      plugin: foreman-tasks

data/app/lib/actions/bulk_action.rb

@@ -23,11 +23,7 @@ module Actions
     end
 
     def humanized_name
-      if task.sub_tasks.first
-        task.sub_tasks.first.humanized[:action]
-      else
-        _('Bulk action')
-      end
+      with_sub_task { |t| t.humanized[:action] } || _('Bulk action')
     end
 
     def rescue_strategy
@@ -35,8 +31,7 @@ module Actions
     end
 
     def humanized_input
-      a_sub_task = task.sub_tasks.first
-      if a_sub_task
+      with_sub_task do |a_sub_task|
         [a_sub_task.humanized[:action].to_s.downcase] +
           Array(a_sub_task.humanized[:input]) + ['...']
       end
@@ -79,5 +74,17 @@ module Actions
     def extract_concurrency_limit(args = [], limit = nil)
       args.find { |arg| arg.is_a?(Hash) && arg.key?(:concurrency_limit) }&.fetch(:concurrency_limit) || limit
     end
+
+    def with_sub_task
+      sub_task = begin
+        task.sub_tasks.first
+      rescue ActiveRecord::RecordNotFound
+        # #task raises if the action has no task linked to it
+        # While it shouldn't happen, there's not much of a difference
+        # between a action not having a task and an action having a
+        # task but no sub tasks
+      end
+      yield sub_task if sub_task
+    end
   end
 end

data/app/models/foreman_tasks/triggering.rb

@@ -8,11 +8,9 @@ module ForemanTasks
     graphql_type '::Types::Triggering'
 
     before_save do
-      if future?
+      unless immediate?
         parse_start_at!
         parse_start_before!
-      else
-        self.start_at ||= Time.zone.now
       end
     end
 
@@ -31,20 +29,20 @@ module ForemanTasks
                            :inclusion => { :in => ALLOWED_INPUT_TYPES,
                                            :message => _('%{value} is not allowed input type') }
     validates :start_at_raw, format: { :with => TIME_REGEXP, :if => ->(triggering) { triggering.future? || (triggering.recurring? && triggering.start_at_raw) },
-                                       :message => _('%{value} is wrong format') }
+                                       :message => _('%{value} is wrong format'), :allow_blank => true }
     validates :start_before_raw, format: { :with => TIME_REGEXP, :if => :future?,
                                            :message => _('%{value} is wrong format'), :allow_blank => true }
     validates :days, format: { :with => DAYS_REGEXP,
                                :if => proc { |t| t.recurring? && t.input_type == :monthly } }
     validate :can_start_recurring, :if => :recurring?
     validate :can_start_future, :if => :future?
+    validate :start_at_is_not_past, :if => ->(triggering) { triggering.start_at_relevant? && triggering.start_at_changed? }
 
     def self.new_from_params(params = {})
       new(params.except(:mode, :start_at, :start_before)).tap do |triggering|
         triggering.mode = params.fetch(:mode, :immediate).to_sym
         triggering.input_type = params.fetch(:input_type, :daily).to_sym
         triggering.end_time_limited = params[:end_time_limited] == 'true'
-        triggering.start_at_raw ||= Time.zone.now.strftime(TIME_FORMAT)
         triggering.recurring_logic = ::ForemanTasks::RecurringLogic.new_from_triggering(triggering) if triggering.recurring?
       end
     end
@@ -76,7 +74,7 @@ module ForemanTasks
 
     def delay_options
       {
-        :start_at => start_at.utc,
+        :start_at => start_at.try(:utc),
         :start_before => start_before.try(:utc),
       }
     end
@@ -107,6 +105,11 @@ module ForemanTasks
       self.start_before ||= Time.zone.parse(start_before_raw) if start_before_raw.present?
     end
 
+    # start_at is required for future execution and optional for recurring execution
+    def start_at_relevant?
+      future? || (recurring? && (start_at || start_at_raw))
+    end
+
     private
 
     def can_start_recurring
@@ -121,5 +124,9 @@ module ForemanTasks
       parse_start_at!
       errors.add(:start_before_raw, _('The task could not be started')) if !start_before.nil? && start_before < start_at
     end
+
+    def start_at_is_not_past
+      errors.add(:start_at, _('is in the past')) if !start_at.nil? && start_at < Time.zone.now
+    end
   end
 end

data/lib/foreman_tasks/engine.rb

@@ -16,121 +16,122 @@ module ForemanTasks
       SETTINGS[:foreman_tasks] = { :assets => { :precompile => assets_to_precompile } }
     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.15'
-          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
+      Foreman::Plugin.register :"foreman-tasks" do
+        requires_foreman '>= 3.15'
+        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 } })
-            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 } })
           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_mutation_field :cancel_recurring_logic, '::Mutations::RecurringLogics::Cancel'
+        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
 
-          logger :dynflow, :enabled => true
-          logger :action, :enabled => true
+        register_graphql_mutation_field :cancel_recurring_logic, '::Mutations::RecurringLogics::Cancel'
 
-          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'
+        logger :dynflow, :enabled => true
+        logger :action, :enabled => true
 
-          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')
+        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'
 
-          register_gettext domain: "foreman_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')
 
-          ForemanTasks.dynflow.eager_load_actions!
-          extend_observable_events(::Dynflow::Action.descendants.select { |klass| klass <= ::Actions::ObservableAction }.map(&:namespaced_event_names))
-        end
+        register_gettext domain: "foreman_tasks"
       end
     end
 
+    config.after_initialize do
+      ForemanTasks.dynflow.eager_load_actions!
+      plugin = ::Foreman::Plugin.find("foreman-tasks")
+      plugin.extend_observable_events(::Dynflow::Action.descendants.select { |klass| klass <= ::Actions::ObservableAction }.map(&:namespaced_event_names))
+    end
+
     initializer 'foreman_tasks.apipie' do
       # this condition is here for compatibility reason to work with Foreman 1.4.x
       if Apipie.configuration.api_controllers_matcher.is_a?(Array) &&

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '11.0.0'.freeze
+  VERSION = '11.0.2'.freeze
 end

data/test/factories/triggering_factory.rb

@@ -3,7 +3,7 @@ FactoryBot.define do
     mode { :immediate }
 
     trait :future do
-      time = Time.zone.now
+      time = Time.zone.now + 1.year
       mode { :future }
       start_at { time }
       start_at_raw { time.strftime(ForemanTasks::Triggering::TIME_FORMAT) }

data/test/unit/triggering_test.rb

@@ -13,6 +13,13 @@ class TriggeringTest < ActiveSupport::TestCase
       assert_not_predicate(triggering, :valid?)
     end
 
+    it 'is invalid when future execution is in the past' do
+      triggering = FactoryBot.build(:triggering, :future)
+      assert_predicate(triggering, :valid?)
+      triggering.start_at = Time.zone.now - 1.day
+      assert_not_predicate(triggering, :valid?)
+    end
+
     it 'is invalid when recurring logic is invalid' do
       triggering = FactoryBot.build(:triggering, :recurring)
       assert_predicate(triggering, :valid?)
@@ -41,6 +48,22 @@ class TriggeringTest < ActiveSupport::TestCase
       triggering = FactoryBot.build(:triggering, :recurring_logic => logic, :mode => :recurring, :input_type => :cronline, :cronline => '* * * * *')
       assert_predicate(triggering, :valid?)
     end
+
+    it 'is valid by default' do
+      triggering = ForemanTasks::Triggering.new_from_params
+      assert triggering.save
+      assert_predicate triggering.start_at, :blank?
+      assert_predicate triggering, :valid?
+    end
+
+    it 'stays valid once created' do
+      triggering = ForemanTasks::Triggering.new_from_params({ :mode => "future" })
+      triggering.start_at = Time.zone.now + 1.second
+      triggering.save!
+      assert_predicate(triggering, :valid?)
+      Time.zone.expects(:now).never # No time comparisons should be done as nothing changed
+      assert_predicate(triggering, :valid?)
+    end
   end
 
   it 'cannot have mode set to arbitrary value' do

data/webpack/ForemanTasks/Components/TasksDashboard/Components/TasksCardsGrid/Components/StoppedTasksCard/OtherInfo.js

@@ -30,6 +30,7 @@ export const OtherInfo = ({ updateQuery, otherCount, query }) => {
         </span>
       </Tooltip>
       <Button
+        ouiaId="stopped-other-tasks-button"
         variant="link"
         onClick={() =>
           updateQuery({

data/webpack/ForemanTasks/Components/TasksDashboard/Components/TasksCardsGrid/Components/StoppedTasksCard/__snapshots__/OtherInfo.test.js.snap

@@ -21,6 +21,7 @@ exports[`OtherInfo render 1`] = `
   </Tooltip>
   <Button
     onClick={[Function]}
+    ouiaId="stopped-other-tasks-button"
     variant="link"
   >
     7

data/webpack/ForemanTasks/Components/TasksDashboard/Components/TasksLabelsRow/TasksLabelsRow.scss

@@ -1,4 +1,4 @@
-@import '~@theforeman/vendor/scss/variables';
+@import 'foremanReact/common/variables';
 
 .tasks-labels-row {
   margin: 0;

data/webpack/ForemanTasks/Components/TasksDashboard/TasksDashboard.scss

@@ -1,5 +1,5 @@
-@import '~@theforeman/vendor/scss/variables';
-@import '~@theforeman/vendor/scss/mixins';
+@import 'foremanReact/common/variables';
+@import 'foremanReact/common/scss/mixins';
 
 @mixin create-tasks-dashboard-column($columns: 12, $screen-min: 0, $gutter: $grid-gutter-width) {
   @media (min-width: $screen-min) {

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 11.0.0
+  version: 11.0.2
 platform: ruby
 authors:
 - Ivan Nečas
 bindir: bin
 cert_chain: []
-date: 2025-03-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dynflow
@@ -117,8 +117,8 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE
+- README.md
 files:
 - ".eslintrc"
 - ".github/workflows/js_tests.yml"
@@ -640,7 +640,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Foreman plugin for showing tasks information for resources and users
 test_files: