foreman-tasks 0.17.6 → 1.1.2

data/gemfile.d/foreman-tasks.rb

@@ -0,0 +1 @@
+gem 'sqlite3'

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
@@ -34,7 +34,7 @@ module ForemanTasks
 
     initializer 'foreman_tasks.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :"foreman-tasks" do
-        requires_foreman '>= 1.24.0'
+        requires_foreman '>= 2.0.0'
         divider :top_menu, :parent => :monitor_menu, :last => true, :caption => N_('Foreman Tasks')
         menu :top_menu, :tasks,
              :url_hash => { :controller => 'foreman_tasks/tasks', :action => :index },
@@ -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,17 @@ 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
+      ::Dynflow::Action::Polling.prepend ForemanTasks::Concerns::PollingActionExtensions
     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"')
@@ -14,7 +14,7 @@ namespace :foreman_tasks do
       If TASK_SEARCH is set then AFTER, STATES can be set and it's used for cleanup. If TASK_SEARCH is not set then
       the cleanup respects the configuration file and setting AFTER or STATES will throw exception.
     DESC
-    task :run => 'environment' do
+    task :run => ['environment', 'dynflow:client'] do
       options = {}
 
       options[:filter] = ENV['TASK_SEARCH'] if ENV['TASK_SEARCH']
@@ -38,7 +38,7 @@ namespace :foreman_tasks do
     end
 
     desc 'Show the current configuration for auto-cleanup'
-    task :config => 'environment' do
+    task :config => ['environment', 'dynflow:client'] do
       if ForemanTasks::Cleaner.cleanup_settings[:after]
         puts _('The tasks will be deleted after %{after}') % { :after => ForemanTasks::Cleaner.cleanup_settings[:after] }
       else

data/lib/foreman_tasks/tasks/dynflow.rake

@@ -0,0 +1,6 @@
+namespace :dynflow do
+  task :client do
+    ::ForemanTasks.dynflow.config.remote = true
+    ::ForemanTasks.dynflow.initialize!
+  end
+end

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"')
@@ -19,7 +19,7 @@ namespace :foreman_tasks do
     all unsuccessful tasks in the past 60 days. The default TASK_FORMAT is html
     which requires a tar.gz file extension.
   DESC
-  task :export_tasks => :environment do
+  task :export_tasks => [:environment, 'dynflow:client'] do
     deprecated_options = { :tasks => 'TASK_SEARCH',
                            :days => 'TASK_DAYS',
                            :export => 'TASK_FILE' }
@@ -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 = '0.17.6'.freeze
+  VERSION = '1.1.2'.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

@@ -4,14 +4,14 @@
   "description": "Foreman Tasks =============",
   "main": "index.js",
   "scripts": {
-    "lint": "./node_modules/.bin/eslint -c .eslintrc webpack/",
-    "test": "node node_modules/.bin/jest --no-cache",
-    "test:watch": "node node_modules/.bin/jest --watchAll",
-    "test:current": "node node_modules/.bin/jest --watch",
-    "coveralls": "cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js",
-    "storybook": "start-storybook -p 6006",
-    "storybook:build": "node --max_old_space_size=2048 ./node_modules/.bin/build-storybook --config-dir .storybook --output-dir .storybook-dist",
-    "storybook:deploy": "surge --project .storybook-dist",
+    "lint": "tfm-lint --plugin -d /webpack",
+    "test": "tfm-test --plugin",
+    "test:watch": "tfm-test --plugin --watchAll",
+    "test:current": "tfm-test --plugin --watch",
+    "publish-coverage": "tfm-publish-coverage",
+    "stories": "tfm-stories --plugin",
+    "stories:build": "tfm-build-stories --plugin",
+    "stories:deploy": "surge --project .storybook-dist",
     "create-react-component": "yo react-domain"
   },
   "repository": {
@@ -21,88 +21,28 @@
   "bugs": {
     "url": "http://projects.theforeman.org/projects/foreman-tasks/issues"
   },
+  "peerDependencies": {
+    "@theforeman/vendor": ">= 4.0.2"
+  },
   "dependencies": {
-    "@theforeman/vendor": "^1.4.0",
     "c3": "^0.4.11",
     "humanize-duration": "^3.20.1",
     "react-html-parser": "^2.0.2",
     "react-intl": "^2.8.0"
   },
   "devDependencies": {
-    "@storybook/addon-actions": "^5.0.1",
-    "@storybook/addon-knobs": "^5.0.1",
-    "@storybook/react": "^5.0.1",
-    "@theforeman/vendor-dev": "^1.4.0",
-    "babel-cli": "^6.10.1",
-    "babel-core": "^6.26.3",
-    "babel-eslint": "^8.2.3",
-    "babel-jest": "^23.6.0",
-    "babel-loader": "^7.1.1",
-    "babel-plugin-dynamic-import-node": "^2.0.0",
-    "babel-plugin-module-resolver": "^3.2.0",
-    "babel-plugin-syntax-dynamic-import": "^6.18.0",
-    "babel-plugin-transform-class-properties": "^6.24.1",
-    "babel-plugin-transform-object-assign": "^6.8.0",
-    "babel-plugin-transform-object-rest-spread": "^6.8.0",
-    "babel-preset-env": "^1.7.0",
-    "babel-preset-react": "^6.5.0",
-    "coveralls": "^3.0.0",
-    "enzyme": "^3.4.0",
-    "enzyme-adapter-react-16": "^1.4.0",
-    "enzyme-to-json": "^3.2.1",
-    "eslint": "^4.10.0",
-    "eslint-import-resolver-babel-module": "^4.0.0",
-    "eslint-plugin-patternfly-react": "0.2.0",
-    "identity-obj-proxy": "^3.0.0",
+    "@babel/core": "^7.7.0",
+    "@theforeman/builder": "^4.0.2",
+    "@theforeman/eslint-plugin-foreman": "4.0.5",
+    "@theforeman/stories": "^4.0.2",
+    "@theforeman/test": "^4.0.2",
+    "@theforeman/vendor-dev": "^4.0.2",
+    "babel-eslint": "^10.0.3",
+    "eslint": "^6.7.2",
     "jed": "^1.1.1",
-    "jest-cli": "^23.6.0",
-    "jest-prop-type-error": "^1.1.0",
-    "node-sass": "^4.5.0",
-    "patternfly": "^3.58.0",
     "prettier": "^1.13.5",
-    "raf": "^3.4.0",
-    "react-redux-test-utils": "^0.1.1",
-    "react-remarkable": "^1.1.3",
-    "sass-loader": "^6.0.7",
     "stylelint": "^9.3.0",
     "stylelint-config-standard": "^18.0.0",
     "surge": "^0.20.3"
-  },
-  "jest": {
-    "verbose": true,
-    "testMatch": [
-      "**/*.test.js"
-    ],
-    "testURL": "http://localhost/",
-    "collectCoverage": true,
-    "collectCoverageFrom": [
-      "webpack/**/*.js",
-      "!webpack/index.js",
-      "!webpack/test_setup.js",
-      "!webpack/**/bundle*",
-      "!webpack/stories/**",
-      "!webpack/**/*stories.js"
-    ],
-    "coverageReporters": [
-      "lcov"
-    ],
-    "moduleNameMapper": {
-      "^.+\\.(png|gif|css|scss)$": "identity-obj-proxy"
-    },
-    "globals": {
-      "__testing__": true
-    },
-    "transform": {
-      "^.+\\.js$": "babel-jest"
-    },
-    "moduleDirectories": [
-      "node_modules",
-      "webpack"
-    ],
-    "setupFiles": [
-      "raf/polyfill",
-      "jest-prop-type-error",
-      "./webpack/test_setup.js"
-    ]
   }
 }

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/script/travis_run_js_tests.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 set -ev
-if [[ $( git diff --name-only HEAD~1..HEAD webpack/ .travis.yml .babelrc .eslintrc package.json | wc -l ) -ne 0 ]]; then
+if [[ $( git diff --name-only HEAD~1..HEAD webpack/ .travis.yml babel.config.js .eslintrc package.json | wc -l ) -ne 0 ]]; then
   npm run test;
-  npm run coveralls;
+  npm run publish-coverage;
   npm run lint;
 fi

data/test/controllers/api/tasks_controller_test.rb

@@ -27,6 +27,15 @@ module ForemanTasks
           _(data['results'].count).must_equal 5
         end
 
+        it 'renders task ids when searching by resource id' do
+          task = FactoryBot.create(:dynflow_task, :product_create_task)
+          ForemanTasks::Lock.create!(name: "create", resource_type: "Katello::Product", resource_id: 1, task_id: task.id)
+          get :index, params: { :search => "label = Actions::Katello::Product::Create and resource_id = 1" }
+          assert_response :success
+          data = JSON.parse(response.body)
+          _(data['results'].first["id"]).must_equal task.id
+        end
+
         it 'supports ordering by duration' do
           get :index, params: { :sort_by => 'duration' }
           assert_response :success

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/lib/concerns/polling_action_extensions_test.rb

@@ -0,0 +1,34 @@
+require 'foreman_tasks_test_helper'
+
+module ForemanTasks
+  module Concerns
+    class PollingActionExtensionsTest < ::ActiveSupport::TestCase
+      class Action < ::Dynflow::Action
+        include ::Dynflow::Action::Polling
+      end
+
+      describe 'polling interval tuning' do
+        let(:default_intervals) { [0.5, 1, 2, 4, 8, 16] }
+
+        it 'is extends the polling action module' do
+          _(::Dynflow::Action::Polling.ancestors.first).must_equal ForemanTasks::Concerns::PollingActionExtensions
+        end
+
+        it 'does not modify polling intervals by default' do
+          _(Action.allocate.poll_intervals).must_equal default_intervals
+        end
+
+        it 'cannot make intervals shorter than 0.5 seconds' do
+          Setting.expects(:[]).with(:foreman_tasks_polling_multiplier).returns 0
+          _(Action.allocate.poll_intervals).must_equal(default_intervals.map { 0.5 })
+        end
+
+        it 'can be used to make the intervals longer' do
+          value = 5
+          Setting.expects(:[]).with(:foreman_tasks_polling_multiplier).returns value
+          _(Action.allocate.poll_intervals).must_equal(default_intervals.map { |i| i * value })
+        end
+      end
+    end
+  end
+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)