foreman-tasks 9.1.1 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5280ef80f012ccdd9210e1dadd08a201a20cecba8158d78e6c4820cb367c007e
-  data.tar.gz: bba5cbfeadb51c5bd8f998a3f3439e53d52775d86703535c6359b808149ef24f
+  metadata.gz: '09ec7edf2024b4efaeb9904c2f03672efbe85791d08bfe2eae0800cd99b837aa'
+  data.tar.gz: 77057f77a6fe853422c8a45f3c100a70bd45d8b3e03582d58d27c692be192550
 SHA512:
-  metadata.gz: 2226e22a486c65df96a9dd672b1a360a727482b5038a47d6405ff10fc23849b12077978d898c92467e8c911a79558be1be1004685d7abe99d311d9100677ca56
-  data.tar.gz: 9c3d1498b4aa19d45242ebfc333ccad9d4d2b4b09f1b8d466c9f5dfda9ad09b4ff3d45decd083617a5719ca738ada5f2992915f74a96b8c79a14347997d5afc4
+  metadata.gz: 31f56309bd113a01bb91be4dc8d4d9c473ebbc438d3496dd18317a079c5a96301cf42771a7f1673e7bfee6cee5999a6cf92e92344e0e5cf56addf03e48e2dbf0
+  data.tar.gz: 1885aa1016226b0230bcfcb0d4ad7e282b34bf716ed96f6b13a38db0023866fe07f9f4ef55a4ecdee76241618c365abc9c452525eefc7cf51beb5ce357aacc1a

data/.github/workflows/ruby_tests.yml

@@ -11,6 +11,8 @@ jobs:
   rubocop:
     name: Rubocop
     uses: theforeman/actions/.github/workflows/rubocop.yml@v0
+    with:
+      command: bundle exec rubocop --parallel --format github
 
   test:
     name: Ruby

data/.rubocop.yml

@@ -1,10 +1,9 @@
-require:
-  - rubocop-minitest
-  - rubocop-performance
-  - rubocop-rails
-
 inherit_from: .rubocop_todo.yml
 
+inherit_gem:
+  theforeman-rubocop:
+    - lenient.yml
+
 AllCops:
   Exclude:
     - 'node_modules/**/*'
@@ -15,25 +14,10 @@ AllCops:
 Lint/ShadowingOuterLocalVariable:
   Enabled: false
 
-Rails:
-  Enabled: true
-
-# Don't prefer is_a? over kind_of?
-Style/ClassCheck:
-  Enabled: false
-
-# Don't enforce documentation
-Style/Documentation:
-  Enabled: false
-
 # Support both ruby19 and hash_rockets
 Style/HashSyntax:
   Enabled: false
 
-# Both double and single quotes are OK
-Style/StringLiterals:
-  Enabled: false
-
 # Don't enforce frozen string literals
 Style/FrozenStringLiteralComment:
   Enabled: false
@@ -61,21 +45,17 @@ Layout/LineLength:
 
 Naming/FileName:
   Exclude:
-    - '*.gemspec'
+    - "*.gemspec"
     - Gemfile
     - db/seeds.d/*
     - lib/foreman-tasks.rb
     - gemfile.d/foreman-tasks.rb
 
-
 Layout/HeredocIndentation:
   Exclude:
-    - '*.gemspec'
+    - "*.gemspec"
     - bin/*
 
-Layout/EmptyLineAfterGuardClause:
-  Enabled: false
-
 Style/RescueStandardError:
   Enabled: false
 
@@ -111,12 +91,3 @@ Rails/HelperInstanceVariable:
 
 Naming/RescuedExceptionsVariableName:
   Enabled: false
-
-Style/WordArray:
-  Enabled: false
-
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: comma
-
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: comma

data/.rubocop_todo.yml

@@ -1,35 +1,95 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-08-07 08:31:32 UTC using RuboCop version 0.89.0.
+# on 2024-04-12 08:56:48 UTC using RuboCop version 1.23.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: Include.
 # Include: **/*.gemspec
 Gemspec/RequiredRubyVersion:
   Exclude:
     - 'foreman-tasks.gemspec'
 
+# Offense count: 106
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: with_first_argument, with_fixed_indentation
+Layout/ArgumentAlignment:
+  Enabled: false
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleAlignWith, Severity.
+# SupportedStylesAlignWith: start_of_line, begin
+Layout/BeginEndAlignment:
+  Exclude:
+    - 'app/models/foreman_tasks/remote_task.rb'
+    - 'app/models/foreman_tasks/task/dynflow_task.rb'
+    - 'lib/tasks/gettext.rake'
+    - 'test/unit/actions/proxy_action_test.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAliasSyntax, AllowedMethods.
+# AllowedMethods: alias_method, public, protected, private
+Layout/EmptyLinesAroundAttributeAccessor:
+  Exclude:
+    - 'app/models/foreman_tasks/lock.rb'
+    - 'lib/foreman_tasks/cleaner.rb'
+    - 'lib/foreman_tasks/triggers.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: consistent, consistent_relative_to_receiver, special_for_inner_method_call, special_for_inner_method_call_in_parentheses
+Layout/FirstArgumentIndentation:
+  Exclude:
+    - 'test/support/dummy_dynflow_action.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Layout/RescueEnsureAlignment:
+  Exclude:
+    - 'app/models/foreman_tasks/remote_task.rb'
+    - 'lib/foreman_tasks/cleaner.rb'
+    - 'lib/tasks/gettext.rake'
+    - 'test/unit/actions/proxy_action_test.rb'
+
+# Offense count: 8
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'lib/foreman_tasks/tasks/export_tasks.rake'
+    - 'lib/foreman_tasks/tasks/generate_task_actions.rake'
+    - 'test/controllers/api/tasks_controller_test.rb'
+    - 'test/unit/cleaner_test.rb'
+    - 'test/unit/locking_test.rb'
+
+# Offense count: 5
+Lint/MissingSuper:
+  Exclude:
+    - 'app/lib/actions/helpers/humanizer.rb'
+    - 'app/services/ui_notifications/tasks.rb'
+    - 'app/services/ui_notifications/tasks/task_bulk_cancel.rb'
+    - 'app/services/ui_notifications/tasks/task_bulk_resume.rb'
+    - 'app/services/ui_notifications/tasks/task_bulk_stop.rb'
+
 # Offense count: 1
 Lint/UselessAssignment:
   Exclude:
     - 'lib/foreman_tasks/tasks/export_tasks.rake'
 
 # Offense count: 1
-# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, Regex, IgnoreExecutableScripts, AllowedAcronyms.
-# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
-Naming/FileName:
+# Cop supports --auto-correct.
+Minitest/AssertEmptyLiteral:
   Exclude:
-    - '*.gemspec'
-    - 'Gemfile'
-    - 'db/seeds.d/*'
-    - 'lib/foreman-tasks.rb'
-    - 'gemfile.d/foreman-tasks.rb'
+    - 'test/unit/cleaner_test.rb'
 
-# Offense count: 3
+# Offense count: 2
 # Configuration parameters: EnforcedStyleForLeadingUnderscores.
 # SupportedStylesForLeadingUnderscores: disallowed, required, optional
 Naming/MemoizedInstanceVariableName:
@@ -52,9 +112,15 @@ Naming/MethodParameterName:
 # MethodDefinitionMacros: define_method, define_singleton_method
 Naming/PredicateName:
   Exclude:
-    - 'spec/**/*'
     - 'app/models/foreman_tasks/task/status_explicator.rb'
 
+# Offense count: 2
+# Configuration parameters: MinSize.
+Performance/CollectionLiteralInLoop:
+  Exclude:
+    - 'app/lib/actions/middleware/watch_delegated_proxy_sub_tasks.rb'
+    - 'db/seeds.d/61-foreman_tasks_bookmarks.rb'
+
 # Offense count: 6
 # Configuration parameters: Include.
 # Include: db/migrate/*.rb
@@ -67,6 +133,7 @@ Rails/CreateTableWithTimestamps:
     - 'db/migrate/20151112152108_create_triggerings.rb'
 
 # Offense count: 1
+# Cop supports --auto-correct.
 # Configuration parameters: Include.
 # Include: app/**/*.rb, config/**/*.rb, db/**/*.rb, lib/**/*.rb
 Rails/Output:
@@ -78,18 +145,47 @@ Rails/OutputSafety:
   Exclude:
     - 'app/helpers/foreman_tasks/foreman_tasks_helper.rb'
 
-# Offense count: 2
+# Offense count: 1
+# Cop supports --auto-correct.
+Rails/Pick:
+  Exclude:
+    - 'app/lib/actions/helpers/lifecycle_logging.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
 # Configuration parameters: Include.
 # Include: **/Rakefile, **/*.rake
 Rails/RakeEnvironment:
   Exclude:
-    - 'lib/capistrano/tasks/**/*.rake'
     - 'lib/foreman_tasks/tasks/dynflow.rake'
-    - 'lib/foreman_tasks/tasks/test.rake'
 
-# Offense count: 12
+# Offense count: 1
+# Cop supports --auto-correct.
+Rails/RedundantForeignKey:
+  Exclude:
+    - 'app/models/foreman_tasks/triggering.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: separated, grouped
+Style/AccessorGrouping:
+  Exclude:
+    - 'lib/foreman_tasks/task_error.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: prefer_alias, prefer_alias_method
+Style/Alias:
+  Exclude:
+    - 'app/models/foreman_tasks/concerns/action_triggering.rb'
+    - 'app/models/foreman_tasks/task.rb'
+    - 'app/models/foreman_tasks/task_groups/recurring_logic_task_group.rb'
+
+# Offense count: 10
 # Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, EnforcedStyle.
+# Configuration parameters: EnforcedStyle.
 # SupportedStyles: nested, compact
 Style/ClassAndModuleChildren:
   Exclude:
@@ -98,21 +194,117 @@ Style/ClassAndModuleChildren:
     - 'app/models/foreman_tasks/task/status_explicator.rb'
     - 'app/models/foreman_tasks/task/summarizer.rb'
     - 'app/models/foreman_tasks/task/task_cancelled_exception.rb'
-    - 'app/models/setting/foreman_tasks.rb'
     - 'lib/foreman_tasks/dynflow/configuration.rb'
     - 'lib/foreman_tasks/dynflow/console_authorizer.rb'
-    - 'lib/foreman_tasks/dynflow/persistence.rb'
     - 'test/controllers/api/recurring_logics_controller_test.rb'
     - 'test/controllers/api/tasks_controller_test.rb'
 
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoredMethods.
+# IgnoredMethods: ==, equal?, eql?
+Style/ClassEqualityComparison:
+  Exclude:
+    - 'app/lib/actions/proxy_action.rb'
+    - 'app/models/foreman_tasks/task/dynflow_task.rb'
+    - 'lib/foreman_tasks/test_extensions.rb'
+
 # Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Keywords, RequireColon.
+# Keywords: TODO, FIXME, OPTIMIZE, HACK, REVIEW, NOTE
+Style/CommentAnnotation:
+  Exclude:
+    - 'app/models/foreman_tasks/task.rb'
+
+# Offense count: 14
+# Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
-# SupportedStyles: allowed_in_returns, forbidden
-Style/DoubleNegation:
+# SupportedStyles: compact, expanded
+Style/EmptyMethod:
   Exclude:
-    - 'app/models/foreman_tasks/recurring_logic.rb'
+    - 'app/controllers/foreman_tasks/api/recurring_logics_controller.rb'
+    - 'app/controllers/foreman_tasks/api/tasks_controller.rb'
+    - 'app/controllers/foreman_tasks/recurring_logics_controller.rb'
+    - 'app/lib/actions/helpers/humanizer.rb'
+    - 'app/models/foreman_tasks/concerns/action_triggering.rb'
+    - 'test/lib/actions/middleware/keep_current_taxonomies_test.rb'
+    - 'test/lib/actions/middleware/keep_current_timezone_test.rb'
+    - 'test/lib/actions/middleware/keep_current_user_test.rb'
+    - 'test/unit/actions/action_with_sub_plans_test.rb'
 
-# Offense count: 35
+# Offense count: 6
+# Cop supports --auto-correct.
+Style/ExplicitBlockArgument:
+  Exclude:
+    - 'app/lib/actions/middleware/keep_current_request_id.rb'
+    - 'app/lib/actions/middleware/keep_current_taxonomies.rb'
+    - 'app/lib/actions/middleware/keep_current_timezone.rb'
+    - 'app/lib/actions/middleware/keep_current_user.rb'
+    - 'app/lib/actions/middleware/watch_delegated_proxy_sub_tasks.rb'
+    - 'lib/foreman_tasks.rb'
+
+# Offense count: 31
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
-  Enabled: false
+  Exclude:
+    - 'app/lib/actions/bulk_action.rb'
+    - 'app/lib/actions/entry_action.rb'
+    - 'app/lib/actions/helpers/humanizer.rb'
+    - 'app/lib/actions/helpers/with_delegated_action.rb'
+    - 'app/lib/actions/proxy_action.rb'
+    - 'app/models/foreman_tasks/concerns/action_triggering.rb'
+    - 'app/models/foreman_tasks/concerns/user_extensions.rb'
+    - 'app/models/foreman_tasks/task/dynflow_task.rb'
+    - 'app/models/foreman_tasks/triggering.rb'
+    - 'db/migrate/20161003091412_add_missing_indexes.rb'
+    - 'db/migrate/20180216092715_use_uuid.rb'
+    - 'lib/foreman_tasks/dynflow/console_authorizer.rb'
+    - 'lib/foreman_tasks/tasks/export_tasks.rake'
+    - 'lib/foreman_tasks/test_extensions.rb'
+    - 'test/controllers/api/tasks_controller_test.rb'
+
+# Offense count: 2
+# Configuration parameters: MinBranchesCount.
+Style/HashLikeCase:
+  Exclude:
+    - 'app/models/foreman_tasks/recurring_logic.rb'
+    - 'app/models/foreman_tasks/task.rb'
+
+# Offense count: 6
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'app/helpers/foreman_tasks/foreman_tasks_helper.rb'
+    - 'app/lib/actions/proxy_action.rb'
+    - 'app/models/foreman_tasks/task/dynflow_task.rb'
+    - 'lib/foreman_tasks/cleaner.rb'
+    - 'test/controllers/api/tasks_controller_test.rb'
+    - 'test/lib/actions/middleware/keep_current_request_id_test.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RedundantAssignment:
+  Exclude:
+    - 'bin/dynflow-executor'
+    - 'lib/foreman_tasks/cleaner.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RedundantBegin:
+  Exclude:
+    - 'app/models/foreman_tasks/task/dynflow_task.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/SlicingWithRange:
+  Exclude:
+    - 'test/unit/task_test.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowModifier.
+Style/SoleNestedConditional:
+  Exclude:
+    - 'app/lib/actions/task_synchronization.rb'

data/Gemfile

@@ -1,20 +1,5 @@
 source "https://rubygems.org"
 
-# Declare your gem's dependencies in tasks.gemspec.
-# Bundler will treat runtime dependencies like base dependencies, and
-# development dependencies will be added by default to the :development group.
+gemspec
 
-gemspec :name => 'foreman-tasks'
-
-# Declare any dependencies that are still in development here instead of in
-# your gemspec. These might include edge Rails or gems from your path or
-# Git. Remember to move these dependencies to your gemspec before releasing
-# your gem to rubygems.org.
-
-# To use debugger
-# gem 'debugger'
-
-gem 'rubocop', '~> 0.87'
-gem 'rubocop-minitest', '~> 0.9.0'
-gem 'rubocop-performance', '~> 1.5.2'
-gem 'rubocop-rails', '~> 2.5.2'
+gem 'theforeman-rubocop', '~> 0.1.0'

data/app/controllers/foreman_tasks/tasks_controller.rb

@@ -69,7 +69,7 @@ module ForemanTasks
 
     def unlock
       if @dynflow_task.paused?
-        unlock_task(@dynflow_task)
+        @dynflow_task.halt
         render json: { statusText: 'OK' }
       else
         render json: {}, status: :bad_request
@@ -77,8 +77,13 @@ module ForemanTasks
     end
 
     def force_unlock
-      unlock_task(@dynflow_task)
-      render json: { statusText: 'OK' }
+      if @dynflow_task.pending?
+        @dynflow_task.halt
+        render json: { statusText: 'OK' }
+      else
+        # Cannot halt an already stopped task
+        render json: {}, status: :bad_request
+      end
     end
 
     # we need do this to make the Foreman helpers working properly
@@ -92,12 +97,6 @@ module ForemanTasks
 
     private
 
-    def unlock_task(task)
-      task.state = :stopped
-      task.locks.destroy_all
-      task.save!
-    end
-
     def respond_with_tasks(scope)
       @tasks = filter(scope, paginate: false).with_duration
       csv_response(@tasks, [:id, :action, :state, :result, 'started_at.in_time_zone', 'ended_at.in_time_zone', :duration, :username], ['Id', 'Action', 'State', 'Result', 'Started At', 'Ended At', 'Duration', 'User'])

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

@@ -251,6 +251,10 @@ module ForemanTasks
       superclass.model_name
     end
 
+    def halt
+      ::ForemanTasks.dynflow.world.halt(external_id)
+    end
+
     private
 
     def string_to_time(zone, time)

data/foreman-tasks.gemspec

@@ -26,7 +26,7 @@ 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 "dynflow", '>= 1.8.0'
+  s.add_dependency "dynflow", '>= 1.9.0'
   s.add_dependency 'fugit', '~> 1.8'
   s.add_dependency "get_process_mem" # for memory polling
   s.add_dependency "sinatra" # for Dynflow web console

data/lib/foreman_tasks/tasks/export_tasks.rake

@@ -51,7 +51,7 @@ namespace :foreman_tasks do
       end
 
       def template(filename)
-        File.join(Gem::Specification.find_by_name('dynflow').gem_dir, 'web', 'views', "#{filename}.erb") # rubocop:disable Rails/DynamicFindBy
+        File.join(Gem::Specification.find_by_name('dynflow').gem_dir, 'web', 'views', "#{filename}.erb")
       end
 
       def erb(file, options = {})
@@ -216,7 +216,7 @@ namespace :foreman_tasks do
          'javascripts/application.js',
          'vendor/bootstrap/css/bootstrap.css',
          'stylesheets/application.css'].each do |file|
-          filename = File.join(Gem::Specification.find_by_name('dynflow').gem_dir, 'web', 'assets', file) # rubocop:disable Rails/DynamicFindBy
+          filename = File.join(Gem::Specification.find_by_name('dynflow').gem_dir, 'web', 'assets', file)
           FileUtils.copy_file(filename, File.join(tmp_dir, File.basename(file)))
         end
       end

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '9.1.1'.freeze
+  VERSION = '9.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 9.1.1
+  version: 9.2.0
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
+date: 2024-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dynflow
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.9.0
 - !ruby/object:Gem::Dependency
   name: fugit
   requirement: !ruby/object:Gem::Requirement