foreman-tasks 5.3.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f5ae3bb36274977790149d11f722477d6db0254b251ffa1dc79ec850a206183
-  data.tar.gz: bfd76d0fcc43a78e34c1831a392042e5770bd09276d95d126043f3a14db174b7
+  metadata.gz: a31c8423a352c5eeb6ff93b23ce8ed3d868ee4bdb16d456233f2c3df475342cd
+  data.tar.gz: c181fdc4c13d8c3cfb7e8d8469c9188a8972b97ca223e68cb50d9a901e23d552
 SHA512:
-  metadata.gz: b2bde1cb649304ba13019b544c8db8f7fa72b2e0539d47b2db07d6e945364d08b4e5fa0b100b701aa7f080e8be308ad7a6af404eaee2865e7b13fd423f9a9300
-  data.tar.gz: 00a77aaf192bbfc12a70dc034aa75bfd728c18956b1b9377bbef3d7fce7491c68cfa520d9fd04de4789c721fcc2d2b2b605b63a9165601092841e44184219dfc
+  metadata.gz: c7f2b880bb70b4fc2781ab9c5bff2c7bcd0434bc067669fae601f1815f6720e7dd771a170cdde8a4922565f1bd87c61d5b3dc1c0b10192bd895508d123aa84da
+  data.tar.gz: a4652958efa52fec83b6c0a8093914b1d22ad574bc4763cb66c3bc41e82bd67e5b1448be0fd79ae3ce64225cb44d6c25faeb324cd10a846dfbe77abee5d55b02

data/app/lib/actions/helpers/lifecycle_logging.rb

@@ -7,7 +7,7 @@ module Actions
 
       def log_task_state_change(execution_plan)
         return unless root_action?
-        logger = Rails.application.dynflow.world.action_logger
+        logger = ::Rails.application.dynflow.world.action_logger
         task_id = ForemanTasks::Task::DynflowTask.where(external_id: execution_plan.id).pluck(:id).first
 
         task_id_parts = []

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

@@ -10,13 +10,13 @@ module Actions
     # for more details.
     class RailsExecutorWrap < Dynflow::Middleware
       def run(*args)
-        Rails.application.executor.wrap do
+        ::Rails.application.executor.wrap do
           pass(*args)
         end
       end
 
       def finalize
-        Rails.application.executor.wrap do
+        ::Rails.application.executor.wrap do
           pass
         end
       end

data/app/lib/actions/proxy_action.rb

@@ -67,7 +67,7 @@ module Actions
     def trigger_proxy_task
       suspend do |_suspended_action|
         remote_task = prepare_remote_task
-        remote_task.trigger(proxy_action_name, proxy_input)
+        ForemanTasks::RemoteTask.batch_trigger(remote_task.operation, [remote_task])
         output[:proxy_task_id] = remote_task.remote_task_id
       end
     end

data/app/models/foreman_tasks/lock.rb

@@ -9,7 +9,7 @@ module ForemanTasks
         |
         | #{_('Conflicts with tasks:')}
         HEADER
-        url_helpers = Rails.application.routes.url_helpers
+        url_helpers = ::Rails.application.routes.url_helpers
         conflicting_tasks = conflicting_locks
                             .map(&:task)
                             .uniq

data/extra/foreman-tasks-cleanup.sh

@@ -21,6 +21,21 @@ function build_rake() {
     echo
 }
 
+function incorrect_usage() {
+    echo "$1" >&2
+    echo
+    usage
+
+    exit 1
+}
+
+function validate_options!() {
+    if [ -z "$TASK_SEARCH" ]; then
+        [ -n "$AFTER" ] && incorrect_usage "Error: -a|--after cannot be used without -s|--search"
+        [ -n "$STATES" ] && incorrect_usage "Error: -S|--states cannot be used without -s|--search"
+    fi
+}
+
 function usage() {
         cat << EOF
 Usage: $PROGNAME [script_options...] [options...]
@@ -43,8 +58,8 @@ EOF
         echo Cleanup options:
         cat <<EOF | column -s\& -t
 -B|--batch-size BATCH_SIZE & process tasks in batches of BATCH_SIZE, 1000 by default
--S|--states STATES & operate on tasks in STATES, comma separated list of states, set to all to operate on tasks in any state
--a|--after AGE & operate on tasks older than AGE. Expected format is a number followed by the time unit (s,h,m,y), such as '10d' for 10 days
+-S|--states STATES & operate on tasks in STATES, comma separated list of states, set to all to operate on tasks in any state. Has to be used together with -s|--search
+-a|--after AGE & operate on tasks older than AGE. Expected format is a number followed by the time unit (s,h,m,y), such as '10d' for 10 days. Has to be used together with -s|--search
 -b|--backup & backup deleted tasks
 -n|--noop & do a dry run, print what would be done
 -s|--search QUERY & use QUERY in scoped search format to match tasks to delete
@@ -119,6 +134,8 @@ while true; do
     shift
 done
 
+validate_options!
+
 if [ "$EXECUTE" -eq 1 ]; then
     build_rake | sh
 else

data/lib/foreman_tasks/dynflow/configuration.rb

@@ -1,4 +1,4 @@
-require File.expand_path('lib/foreman/dynflow/configuration', Rails.root)
+require File.expand_path('lib/foreman/dynflow/configuration', ::Rails.root)
 
 module ForemanTasks
   # Import all Dynflow configuration from Foreman, and add our own for Tasks

data/lib/foreman_tasks/dynflow.rb

@@ -17,7 +17,7 @@ module ForemanTasks
         set(:custom_navigation) do
           { _('Back to tasks') => "/#{ForemanTasks::TasksController.controller_path}" }
         end
-        set(:world) { Rails.application.dynflow.world }
+        set(:world) { ::Rails.application.dynflow.world }
       end
     end
   end

data/lib/foreman_tasks/engine.rb

@@ -25,7 +25,7 @@ module ForemanTasks
 
     initializer 'foreman_tasks.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :"foreman-tasks" do
-        requires_foreman '>= 3.0.0'
+        requires_foreman '>= 3.2.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 },

data/lib/foreman_tasks/tasks/export_tasks.rake

@@ -300,7 +300,7 @@ namespace :foreman_tasks do
       end
     end
 
-    SKIP_ERRORS = ['true', '1', 'y', 'yes'].include? ENV['SKIP_FAILED'].downcase
+    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)}\" || " \

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '5.3.0'.freeze
+  VERSION = '6.0.0'.freeze
 end

data/test/controllers/api/tasks_controller_test.rb

@@ -192,14 +192,13 @@ module ForemanTasks
           _(task.state).must_equal 'running'
           _(task.result).must_equal 'pending'
 
-          callback = Support::DummyProxyAction.proxy.log[:trigger_task].first[1][:action_input][:callback]
+          callback = Support::DummyProxyAction.proxy.log[:trigger_task].first[1].first[1][:action_input][:callback]
           post :callback, params: { 'callback' => callback, 'data' => { 'result' => 'success' } }
           triggered.finished.wait(5)
 
           task.reload
           _(task.state).must_equal 'stopped'
           _(task.result).must_equal 'success'
-          _(task.main_action.output['proxy_task_id']).must_equal Support::DummyProxyAction.proxy.uuid
           _(task.main_action.output['proxy_output']).must_equal('result' => 'success')
         end
       end

data/test/support/dummy_proxy_action.rb

@@ -40,7 +40,7 @@ module Support
       def launch_tasks(operation, args = {})
         @log[:trigger_task] << [operation, args]
         @task_triggered.fulfill(true)
-        { 'task_id' => @uuid, 'result' => 'success' }
+        { 'task_id' => @uuid, 'result' => 'success', 'parent' => { 'task_id' => @uuid } }
       end
     end
 

data/test/unit/actions/proxy_action_test.rb

@@ -1,4 +1,5 @@
 require 'foreman_tasks_test_helper'
+require 'ostruct'
 
 module ForemanTasks
   class ProxyActionTest <  ActiveSupport::TestCase
@@ -22,24 +23,29 @@ module ForemanTasks
                                          'foo' => 'bar',
                                          'secrets' => secrets,
                                          'use_batch_triggering' => batch_triggering)
+        RemoteTask.any_instance.stubs(:action).returns(@action)
+        RemoteTask.any_instance.stubs(:task).returns(OpenStruct.new(:id => Support::DummyProxyAction.proxy.uuid))
+        @run_step_id = @action.run_step_id
+
         @action = run_action(@action)
       end
 
       describe 'first run' do
         it 'triggers the corresponding action on the proxy' do
           proxy_call = Support::DummyProxyAction.proxy.log[:trigger_task].first
-          expected_call = ['single',
-                           { :action_class => 'Proxy::DummyAction',
-                             :action_input =>
-                             { 'foo' => 'bar',
-                               'secrets' => secrets,
-                               'connection_options' =>
-                               { 'retry_interval' => 15, 'retry_count' => 4,
-                                 'proxy_batch_triggering' => batch_triggering },
-                               'use_batch_triggering' => batch_triggering,
-                               'proxy_url' => 'proxy.example.com',
-                               'proxy_action_name' => 'Proxy::DummyAction',
-                               'callback' => { 'task_id' => Support::DummyProxyAction.proxy.uuid, 'step_id' => @action.run_step_id } } }]
+          action_input =
+            { :action_class => 'Proxy::DummyAction',
+              :action_input =>
+                { 'foo' => 'bar',
+                  'secrets' => secrets,
+                  'connection_options' =>
+                    { 'retry_interval' => 15, 'retry_count' => 4,
+                      'proxy_batch_triggering' => batch_triggering },
+                  'use_batch_triggering' => batch_triggering,
+                  'proxy_url' => 'proxy.example.com',
+                  'proxy_action_name' => 'Proxy::DummyAction',
+                  'callback' => { 'task_id' => Support::DummyProxyAction.proxy.uuid, 'step_id' => @run_step_id } } }
+          expected_call = ['support', { @action.execution_plan_id => action_input }]
           _(proxy_call).must_equal(expected_call)
         end
 
@@ -73,7 +79,7 @@ module ForemanTasks
       describe 'cancel' do
         it 'sends the cancel event to the proxy when the cancel event is sent for the first time' do
           action = run_action(@action, ::Dynflow::Action::Cancellable::Cancel)
-          _(Support::DummyProxyAction.proxy.log[:cancel_task].first).must_equal [Support::DummyProxyAction.proxy.uuid]
+          _(Support::DummyProxyAction.proxy.log[:cancel_task].first).must_equal [action.execution_plan_id]
           _(action.state).must_equal :suspended
         end
 

data/webpack/ForemanTasks/Components/TasksTable/TasksTable.js

@@ -4,7 +4,7 @@ import { Table } from 'foremanReact/components/common/table';
 import { STATUS } from 'foremanReact/constants';
 import MessageBox from 'foremanReact/components/common/MessageBox';
 import { translate as __ } from 'foremanReact/common/I18n';
-import Pagination from 'foremanReact/components/Pagination/PaginationWrapper';
+import Pagination from 'foremanReact/components/Pagination';
 import { getURIQuery } from 'foremanReact/common/helpers';
 import createTasksTableSchema from './TasksTableSchema';
 import { updateURlQuery } from './TasksTableHelpers';
@@ -18,7 +18,6 @@ const TasksTable = ({
   results,
   history,
   itemCount,
-  pagination,
   selectedRows,
   selectPage,
   unselectAllRows,
@@ -82,16 +81,6 @@ const TasksTable = ({
     return <span>{__('No Tasks')}</span>;
   }
 
-  const changeTablePage = ({ page, perPage }) => {
-    updateURlQuery(
-      {
-        page,
-        per_page: perPage,
-      },
-      history
-    );
-  };
-
   const setSortHistory = (by, order) => {
     updateURlQuery({ sort_by: by, sort_order: order }, history);
   };
@@ -133,14 +122,7 @@ const TasksTable = ({
         )}
         rows={results}
       />
-      <Pagination
-        className="tasks-pagination"
-        viewType="table"
-        itemCount={itemCount}
-        pagination={pagination}
-        onChange={changeTablePage}
-        dropdownButtonId="tasks-table-dropdown"
-      />
+      <Pagination itemCount={itemCount} />
     </div>
   );
 };
@@ -151,10 +133,6 @@ TasksTable.propTypes = {
   status: PropTypes.oneOf(Object.keys(STATUS)),
   error: PropTypes.instanceOf(Error),
   itemCount: PropTypes.number.isRequired,
-  pagination: PropTypes.shape({
-    page: PropTypes.number,
-    perPage: PropTypes.number,
-  }),
   history: PropTypes.object.isRequired,
   openClickedModal: PropTypes.func.isRequired,
   selectedRows: PropTypes.array,
@@ -172,10 +150,6 @@ TasksTable.propTypes = {
 TasksTable.defaultProps = {
   status: STATUS.PENDING,
   error: null,
-  pagination: {
-    page: 1,
-    perPage: 20,
-  },
   selectedRows: [],
   allRowsSelected: false,
   permissions: {

data/webpack/ForemanTasks/Components/TasksTable/TasksTablePage.js

@@ -99,10 +99,10 @@ const TasksTablePage = ({
         <React.Fragment>
           {props.permissions.edit &&
             showSelectAll &&
-            props.itemCount >= props.pagination.perPage && (
+            props.itemCount >= props.perPage && (
               <SelectAllAlert
                 itemCount={props.itemCount}
-                perPage={props.pagination.perPage}
+                perPage={props.perPage}
                 selectAllRows={selectAllRows}
                 unselectAllRows={props.unselectAllRows}
                 allRowsSelected={props.allRowsSelected}
@@ -118,9 +118,8 @@ const TasksTablePage = ({
 TasksTablePage.propTypes = {
   allRowsSelected: PropTypes.bool,
   itemCount: PropTypes.number.isRequired,
-  pagination: PropTypes.shape({
-    perPage: PropTypes.number,
-  }),
+  perPage: PropTypes.number,
+
   selectAllRows: PropTypes.func.isRequired,
   results: PropTypes.array.isRequired,
   getTableItems: PropTypes.func.isRequired,
@@ -142,10 +141,7 @@ TasksTablePage.propTypes = {
 };
 
 TasksTablePage.defaultProps = {
-  pagination: {
-    page: 1,
-    perPage: 20,
-  },
+  perPage: 20,
   allRowsSelected: false,
   actionName: '',
   status: STATUS.PENDING,

data/webpack/ForemanTasks/Components/TasksTable/TasksTableReducer.js

@@ -21,7 +21,6 @@ export const TasksTableQueryReducer = (state = initialState, action) => {
   const { type, payload, response } = action;
   const {
     subtotal,
-    page,
     per_page: perPageString,
     action_name: actionName,
     can_edit: canEdit,
@@ -34,10 +33,7 @@ export const TasksTableQueryReducer = (state = initialState, action) => {
       return Immutable.merge(state, {
         itemCount: subtotal,
         actionName,
-        pagination: {
-          page: Number(page),
-          perPage: Number(perPageString),
-        },
+        perPage: Number(perPageString),
         selectedRows: [],
         permissions: {
           edit: canEdit,

data/webpack/ForemanTasks/Components/TasksTable/TasksTableSelectors.js

@@ -12,8 +12,8 @@ export const selectTasksTableContent = state =>
 export const selectTasksTableQuery = state =>
   selectTasksTable(state).tasksTableQuery || {};
 
-export const selectPagitation = state =>
-  selectTasksTableQuery(state).pagination || {};
+export const selectPerPage = state =>
+  selectTasksTableQuery(state).perPage || 20;
 
 export const selectItemCount = state =>
   selectTasksTableQuery(state).itemCount || 0;

data/webpack/ForemanTasks/Components/TasksTable/__tests__/TasksTable.fixtures.js

@@ -11,10 +11,7 @@ export const minProps = {
   unselectRow: jest.fn(),
   reloadPage: jest.fn(),
   selectedRows: [],
-  pagination: {
-    page: 1,
-    perPage: 10,
-  },
+  perPage: 10,
   history: { location: { search: '' } },
   results: ['a', 'b'],
   sort: {

data/webpack/ForemanTasks/Components/TasksTable/__tests__/__snapshots__/SubTasksPage.test.js.snap

@@ -23,13 +23,8 @@ exports[`SubTasksPage rendering render with minimal props 1`] = `
   openClickedModal={[MockFunction]}
   openModal={[MockFunction]}
   openModalAction={[MockFunction]}
-  pagination={
-    Object {
-      "page": 1,
-      "perPage": 10,
-    }
-  }
   parentTaskID="some-id"
+  perPage={10}
   reloadPage={[MockFunction]}
   results={
     Array [

data/webpack/ForemanTasks/Components/TasksTable/__tests__/__snapshots__/TasksIndexPage.test.js.snap

@@ -15,12 +15,7 @@ exports[`TasksIndexPage rendering render with minimal props 1`] = `
   openClickedModal={[MockFunction]}
   openModal={[MockFunction]}
   openModalAction={[MockFunction]}
-  pagination={
-    Object {
-      "page": 1,
-      "perPage": 10,
-    }
-  }
+  perPage={10}
   reloadPage={[MockFunction]}
   results={
     Array [

data/webpack/ForemanTasks/Components/TasksTable/__tests__/__snapshots__/TasksTable.test.js.snap

@@ -20,18 +20,8 @@ exports[`TasksTable rendering render with loading Props 1`] = `
       ]
     }
   />
-  <PaginationWrapper
-    className="tasks-pagination"
-    dropdownButtonId="tasks-table-dropdown"
+  <Pagination
     itemCount={2}
-    onChange={[Function]}
-    pagination={
-      Object {
-        "page": 1,
-        "perPage": 10,
-      }
-    }
-    viewType="table"
   />
 </div>
 `;
@@ -49,18 +39,8 @@ exports[`TasksTable rendering render with minimal Props 1`] = `
       ]
     }
   />
-  <PaginationWrapper
-    className="tasks-pagination"
-    dropdownButtonId="tasks-table-dropdown"
+  <Pagination
     itemCount={2}
-    onChange={[Function]}
-    pagination={
-      Object {
-        "page": 1,
-        "perPage": 10,
-      }
-    }
-    viewType="table"
   />
 </div>
 `;

data/webpack/ForemanTasks/Components/TasksTable/__tests__/__snapshots__/TasksTablePage.test.js.snap

@@ -119,13 +119,8 @@ exports[`TasksTablePage rendering render with Breadcrubs and edit permissions 1`
       itemCount={2}
       openClickedModal={[MockFunction]}
       openModal={[Function]}
-      pagination={
-        Object {
-          "page": 1,
-          "perPage": 10,
-        }
-      }
       parentTaskID={null}
+      perPage={10}
       permissions={
         Object {
           "edit": false,
@@ -259,13 +254,8 @@ exports[`TasksTablePage rendering render with minimal props 1`] = `
       itemCount={2}
       openClickedModal={[MockFunction]}
       openModal={[Function]}
-      pagination={
-        Object {
-          "page": 1,
-          "perPage": 10,
-        }
-      }
       parentTaskID={null}
+      perPage={10}
       permissions={
         Object {
           "edit": false,

data/webpack/ForemanTasks/Components/TasksTable/__tests__/__snapshots__/TasksTableReducer.test.js.snap

@@ -55,10 +55,7 @@ Object {
   "tasksTableQuery": Object {
     "actionName": undefined,
     "itemCount": 120,
-    "pagination": Object {
-      "page": 3,
-      "perPage": 12,
-    },
+    "perPage": 12,
     "permissions": Object {
       "edit": undefined,
     },

data/webpack/ForemanTasks/Components/TasksTable/index.js

@@ -8,7 +8,7 @@ import {
   selectStatus,
   selectError,
   selectResults,
-  selectPagitation,
+  selectPerPage,
   selectItemCount,
   selectSort,
   selectActionName,
@@ -24,7 +24,7 @@ const mapStateToProps = state => ({
   error: selectError(state),
   sort: selectSort(state),
   results: selectResults(state),
-  pagination: selectPagitation(state),
+  perPage: selectPerPage(state),
   itemCount: selectItemCount(state),
   actionName: selectActionName(state),
   selectedRows: selectSelectedRows(state),

data/webpack/__mocks__/foremanReact/components/Pagination/index.js

@@ -0,0 +1,2 @@
+const Pagination = () => jest.fn();
+export default Pagination;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-14 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dynflow
@@ -572,7 +572,7 @@ files:
 - webpack/__mocks__/foremanReact/components/ForemanModal/ForemanModalHooks.js
 - webpack/__mocks__/foremanReact/components/ForemanModal/index.js
 - webpack/__mocks__/foremanReact/components/Layout/LayoutActions.js
-- webpack/__mocks__/foremanReact/components/Pagination/PaginationWrapper.js
+- webpack/__mocks__/foremanReact/components/Pagination/index.js
 - webpack/__mocks__/foremanReact/components/ToastsList/index.js
 - webpack/__mocks__/foremanReact/components/common/ActionButtons/ActionButtons.js
 - webpack/__mocks__/foremanReact/components/common/MessageBox.js

data/webpack/__mocks__/foremanReact/components/Pagination/PaginationWrapper.js

@@ -1,2 +0,0 @@
-const PaginationWrapper = () => jest.fn();
-export default PaginationWrapper;