foreman-tasks 3.0.0 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24da58e2837688da28a18832b72b154ac74868157f6176f942119b8b856987c8
-  data.tar.gz: 3031305c5f86f3b03aed95a4501670cbd2dbd595db38f638354ff046f416823a
+  metadata.gz: 8e389326a8086026cc0359932b9d3a3c0c13621f9f0cb60e682d785ecbacddcc
+  data.tar.gz: '0880da8a4cd833615fe5aa9b79aab13a5dcf1df0f84aea891a2490c6f7a342ba'
 SHA512:
-  metadata.gz: a6a21ff8c4b9336f63118c2cdf6a4f11bf25ff882fe1dbd1b17d05f9722705c9cebabb522792416758c3fede1a8507d720cac0317076d8e833bfbb95a83fa8a4
-  data.tar.gz: bef5dd6cac70ac43d53e83950668e930883649d42966b10ff6303e0d581431d3f11028ae24c7ecc9ed0e2875214f4a512cfbaa46f1da81fd912d6a6f25da2db2
+  metadata.gz: 15589c91365b2f7f0f14b38d000575048c2c9e316430eb1564357fd7aee02b9af275155e7021cc69bffc55e8eb46d83445554a46f615d703d6e5da52912a4a94
+  data.tar.gz: b5083cad3c0268b6c461574f7f9c86887bb395a85ec6cd41dd15d2816c07961bee099fc5e4d926029c1e57802c41852a4768c5c68674d26a8822e900ef879b59

data/.github/workflows/js_tests.yml

@@ -18,10 +18,14 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v1
         with:
-          node-version:  ${{ matrix.node-version }}
+          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 }}

data/app/controllers/foreman_tasks/api/tasks_controller.rb

@@ -75,11 +75,16 @@ module ForemanTasks
       end
 
       api :POST, '/tasks/bulk_resume', N_('Resume all paused error tasks')
+      desc <<~DOC
+        Resumes all selected resumable tasks. If neither a search query nor an
+        explicit list of task IDs is provided, it tries to resume all tasks in
+        paused state with result error.
+      DOC
       param :search, String, :desc => N_('Resume tasks matching search string')
       param :task_ids, Array, :desc => N_('Resume specific tasks by ID')
       def bulk_resume
         if params[:search].nil? && params[:task_ids].nil?
-          raise BadRequest, _('Please provide at least one of search or task_ids parameters in the request')
+          params[:search] = 'state = paused and result = error'
         end
         resumed = []
         failed = []
@@ -109,9 +114,14 @@ module ForemanTasks
         }
       end
 
-      api :POST, '/tasks/bulk_cancel', N_('Cancel all cancellable tasks')
+      api :POST, '/tasks/bulk_cancel', N_('Cancel selected cancellable tasks')
+      desc <<~DOC
+        Cancels all selected cancellable tasks. Requires a search query or an
+        explicit list of task IDs to be provided.
+      DOC
       param :search, String, :desc => N_('Cancel tasks matching search string')
       param :task_ids, Array, :desc => N_('Cancel specific tasks by ID')
+      error :bad_request, 'Returned if neither search nor task_ids parameter is provided.'
       def bulk_cancel
         if params[:search].nil? && params[:task_ids].nil?
           raise BadRequest, _('Please provide at least one of search or task_ids parameters in the request')
@@ -130,9 +140,14 @@ module ForemanTasks
         }
       end
 
-      api :POST, '/tasks/bulk_stop', N_('Stop all stoppable tasks')
+      api :POST, '/tasks/bulk_stop', N_('Stop selected stoppable tasks')
+      desc <<~DOC
+        Stops all selected tasks which are not already stopped. Requires a
+        search query or an explicit list of task IDs to be provided.
+      DOC
       param :search, String, :desc => N_('Stop tasks matching search string')
       param :task_ids, Array, :desc => N_('Stop specific tasks by ID')
+      error :bad_request, 'Returned if neither search nor task_ids parameter is provided.'
       def bulk_stop
         if params[:search].nil? && params[:task_ids].nil?
           raise BadRequest, _('Please provide at least one of search or task_ids parameters in the request')
@@ -221,7 +236,7 @@ module ForemanTasks
       end
 
       def search_tasks(search_params)
-        scope = resource_scope_for_index.select('DISTINCT foreman_tasks_tasks.*')
+        scope = resource_scope_for_index
         scope = ordering_scope(scope, search_params)
         scope = search_scope(scope, search_params)
         scope = active_scope(scope, search_params)
@@ -287,7 +302,6 @@ module ForemanTasks
         sort_by = ordering_params[:sort_by] || 'started_at'
         sort_by = 'foreman_tasks_tasks.' + sort_by if sort_by == 'started_at'
         sort_order = ordering_params[:sort_order] || 'DESC'
-        scope = scope.select("foreman_tasks_tasks.*, coalesce(ended_at, current_timestamp) - coalesce(coalesce(started_at, ended_at), current_timestamp) as duration")
         scope.order("#{sort_by} #{sort_order}")
       end
 

data/app/models/foreman_tasks/recurring_logic.rb

@@ -31,12 +31,12 @@ module ForemanTasks
         if value
           task.update!(:start_at => next_occurrence_time) if task.start_at < Time.zone.now
           update(:state => 'active')
-        else
-          update(:state => 'disabled')
         end
-      else
+      elsif value
         raise RecurringLogicCancelledException
       end
+
+      update(:state => 'disabled') unless value
     end
 
     def enabled?

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

@@ -20,7 +20,8 @@ module ForemanTasks
             foreman_tasks_locks_taxonomy#{uniq_suffix}.resource_type = '#{resource_type}')
         SQL
         # Select only those tasks which either have the correct taxonomy or are not related to any
-        sql = "foreman_tasks_locks_taxonomy#{uniq_suffix}.resource_id #{operator} ? OR foreman_tasks_locks_taxonomy#{uniq_suffix}.resource_id IS NULL"
+        sql = "foreman_tasks_locks_taxonomy#{uniq_suffix}.resource_id #{operator} (?) OR foreman_tasks_locks_taxonomy#{uniq_suffix}.resource_id IS NULL"
+        value = value.split(',') if operator.index(/IN/i)
         { :conditions => sanitize_sql_for_conditions([sql, value]), :joins => joins }
       end
 

data/app/models/setting/foreman_tasks.rb

@@ -1,18 +1,18 @@
 class Setting::ForemanTasks < Setting
   def self.default_settings
     [
-      set('foreman_tasks_sync_task_timeout', N_('Number of seconds to wait for synchronous task to finish.'), 120),
-      set('dynflow_enable_console', N_('Enable the dynflow console (/foreman_tasks/dynflow) for debugging'), true),
-      set('dynflow_console_require_auth', N_('Require user to be authenticated as user with admin rights when accessing dynflow console'), true),
-      set('foreman_tasks_proxy_action_retry_count', N_('Number of attempts to start a task on the smart proxy before failing'), 4),
-      set('foreman_tasks_proxy_action_retry_interval', N_('Time in seconds between retries'), 15),
-      set('foreman_tasks_proxy_batch_trigger', N_('Allow triggering tasks on the smart proxy in batches'), true),
-      set('foreman_tasks_proxy_batch_size', N_('Number of tasks which should be sent to the smart proxy in one request, if foreman_tasks_proxy_batch_trigger is enabled'), 100),
+      set('foreman_tasks_sync_task_timeout', N_('Number of seconds to wait for synchronous task to finish.'), 120, N_('Sync task timeout')),
+      set('dynflow_enable_console', N_('Enable the dynflow console (/foreman_tasks/dynflow) for debugging'), true, N_('Enable dynflow console')),
+      set('dynflow_console_require_auth', N_('Require user to be authenticated as user with admin rights when accessing dynflow console'), true, N_('Require auth for dynflow console')),
+      set('foreman_tasks_proxy_action_retry_count', N_('Number of attempts to start a task on the smart proxy before failing'), 4, N_('Proxy action retry count')),
+      set('foreman_tasks_proxy_action_retry_interval', N_('Time in seconds between retries'), 15, N_('Proxy action retry interval')),
+      set('foreman_tasks_proxy_batch_trigger', N_('Allow triggering tasks on the smart proxy in batches'), true, N_('Allow proxy batch tasks')),
+      set('foreman_tasks_proxy_batch_size', N_('Number of tasks which should be sent to the smart proxy in one request, if foreman_tasks_proxy_batch_trigger is enabled'), 100, N_('Proxy tasks batch size')),
       set('foreman_tasks_troubleshooting_url',
           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.'),
-          nil),
+          nil, N_('Tasks troubleshooting URL')),
       set('foreman_tasks_polling_multiplier',
           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.'),

data/app/services/foreman_tasks/dashboard_table_filter.rb

@@ -24,7 +24,11 @@ module ForemanTasks
     private
 
     def scope_by(field)
-      @new_scope = @new_scope.where(field => @params[field]) if @params[field].present?
+      if (field == :result) && (@params[field] == 'other')
+        @new_scope = @new_scope.where(:result => ['cancelled', 'pending'])
+      elsif @params[field].present?
+        @new_scope = @new_scope.where(field => @params[field])
+      end
     end
 
     def scope_by_time

data/app/views/foreman_tasks/layouts/react.html.erb

@@ -9,7 +9,6 @@
   <%= notifications %>
   <div id="organization-id" data-id="<%= Organization.current.id if Organization.current %>" ></div>
   <div id="user-id" data-id="<%= User.current.id if User.current %>" ></div>
-  <div id="foremanTasksReactRoot"></div>
+  <%= react_component('ForemanTasks') %>
 <% end %>
 <%= render file: "layouts/base" %>
-<%= mount_react_component('ForemanTasks', '#foremanTasksReactRoot') %>

data/app/views/foreman_tasks/tasks/dashboard/_latest_tasks_in_error_warning.html.erb

@@ -11,7 +11,7 @@
       <td class="ellipsis"><%= link_to task.humanized[:action], defined?(main_app) ? main_app.foreman_tasks_task_path(task.id) : foreman_tasks_task_path(task.id) %></td>
       <td><%= task.state %></td>
       <td><%= task.result %></td>
-      <td><%= task.started_at ? (_(date_time_relative(task.started_at))) : _('N/A') %></td>
+      <td><%= task.started_at ? date_time_relative(task.started_at) : _('N/A') %></td>
     </tr>
   <% end %>
 </table>

data/app/views/foreman_tasks/tasks/dashboard/_tasks_status.html.erb

@@ -11,7 +11,7 @@
       <td><%= result.state %></td>
       <td><%= result.result %></td>
       <td><%= link_to result.count, main_app.foreman_tasks_tasks_path(:search => "state=#{result.state}&result=#{result.result}") %></td>
-      <td><%= result.started_at ? (_(date_time_relative(result.started_at))) : _('N/A') %></td>
+      <td><%= result.started_at ? date_time_relative(result.started_at) : _('N/A') %></td>
     </tr>
   <% end %>
 </table>

data/app/views/foreman_tasks/tasks/show.html.erb

@@ -15,9 +15,4 @@
   switcher_item_url: foreman_tasks_task_path(:id => ':id')
 ) %>
 
-
-<div class="task-details" id="foremanTaskDetails">
-</div>
-
-
-<%= mount_react_component('TaskDetails', '#foremanTaskDetails')  %>
+<%= react_component('TaskDetails')  %>

data/foreman-tasks.gemspec

@@ -7,6 +7,7 @@ require "foreman_tasks/version"
 Gem::Specification.new do |s|
   s.name        = "foreman-tasks"
   s.version     = ForemanTasks::VERSION
+  s.license     = 'GPL-3.0'
   s.authors     = ["Ivan Nečas"]
   s.email       = ["inecas@redhat.com"]
   s.homepage    = "https://github.com/theforeman/foreman-tasks"

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '3.0.0'.freeze
+  VERSION = '3.0.5'.freeze
 end

data/test/controllers/api/tasks_controller_test.rb

@@ -45,6 +45,16 @@ module ForemanTasks
         end
       end
 
+      describe 'POST /api/tasks/bulk_search' do
+        it 'searching for a task' do
+          task = FactoryBot.create(:dynflow_task, :user_create_task)
+          post :bulk_search, params: { :searches => [{ :type => "task", :task_id => task.id, :search_id => "1" }] }
+          assert_response :success
+          data = JSON.parse(response.body)
+          _(data[0]['results'][0]['id']).must_equal task.id
+        end
+      end
+
       describe 'GET /api/tasks/show' do
         it 'searches for task' do
           task = FactoryBot.create(:dynflow_task, :user_create_task)

data/test/unit/recurring_logic_test.rb

@@ -148,6 +148,12 @@ class RecurringLogicsTest < ActiveSupport::TestCase
         assert ForemanTasks.dynflow.world.persistence.load_delayed_plan(task.execution_plan.id).frozen
       end
 
+      it 'handles if the task has been deleted' do
+        logic.tasks.find_by(:state => 'scheduled').destroy
+        logic.update!(:enabled => false)
+        assert_equal 'disabled', logic.state
+      end
+
       it 'properly re-enables on disable' do
         logic.update!(:enabled => false)
         logic.update!(:enabled => true)

data/test/unit/task_test.rb

@@ -129,6 +129,16 @@ class TasksTest < ActiveSupport::TestCase
         _ { proc { ForemanTasks::Task.search_for('duration = "25 potatoes"') } }.must_raise ScopedSearch::QueryNotSupported
       end
     end
+
+    context 'by taxonomies' do
+      test 'can search by taxonomies using IN' do
+        assert_nothing_raised(PG::SyntaxError) { ForemanTasks::Task.search_for('location_id ^ (1)').first }
+        assert_nothing_raised(PG::SyntaxError) { ForemanTasks::Task.search_for('organization_id ^ (1)').first }
+        assert_nothing_raised(PG::SyntaxError) { ForemanTasks::Task.search_for('location_id ^ (1,2)').first }
+        assert_nothing_raised(PG::SyntaxError) { ForemanTasks::Task.search_for('organization_id ^ (1,2)').first }
+        assert_nothing_raised(PG::SyntaxError) { ForemanTasks::Task.search_for('organization_id = 1').first }
+      end
+    end
   end
 
   describe 'users' do

data/webpack/ForemanTasks/Components/TaskDetails/TaskDetails.scss

@@ -49,4 +49,14 @@
   .dynflow-button > span {
     pointer-events: auto;
   }
+
+  pre {
+    white-space: pre;
+    word-break: normal;
+  }
+
+  .param-name {
+    display: inline-block;
+    width: 10em;
+  }
 }

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

@@ -1,15 +1,19 @@
 .scheduled-tasks-card {
   text-align: center;
+
   .scheduled-data {
+    margin-top: 30px;
     padding-right: 15px;
     cursor: pointer;
     font-size: 40px;
     font-weight: 300;
     transition: font-weight 50ms ease-in;
+
     p {
       font-size: 20px;
       margin: 0;
     }
+
     * {
       margin: 10px;
     }

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

@@ -0,0 +1,53 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import classNames from 'classnames';
+
+import { Icon, Button, OverlayTrigger, Tooltip } from 'patternfly-react';
+import { translate as __ } from 'foremanReact/common/I18n';
+import {
+  TASKS_DASHBOARD_AVAILABLE_QUERY_STATES,
+  TASKS_DASHBOARD_AVAILABLE_QUERY_RESULTS,
+} from '../../../../TasksDashboardConstants';
+import { queryPropType } from '../../../../TasksDashboardPropTypes';
+
+const tooltip = (
+  <Tooltip id="stopped-tooltip">
+    {__('Other includes all stopped tasks that are cancelled or pending')}
+  </Tooltip>
+);
+
+export const OtherInfo = ({ updateQuery, otherCount, query }) => {
+  const { OTHER } = TASKS_DASHBOARD_AVAILABLE_QUERY_RESULTS;
+  const { STOPPED } = TASKS_DASHBOARD_AVAILABLE_QUERY_STATES;
+  const active = query.state === STOPPED && query.result === OTHER;
+  return (
+    <span className={classNames(active && 'other-active')}>
+      <OverlayTrigger
+        overlay={tooltip}
+        trigger={['hover', 'focus']}
+        placement="bottom"
+      >
+        <span>
+          <Icon type="pf" name="info" />
+          <span>{__('Other:')} </span>
+        </span>
+      </OverlayTrigger>
+      <Button
+        bsStyle="link"
+        onClick={() =>
+          updateQuery({
+            state: STOPPED,
+            result: OTHER,
+          })
+        }
+      >
+        {otherCount}
+      </Button>
+    </span>
+  );
+};
+OtherInfo.propTypes = {
+  updateQuery: PropTypes.func.isRequired,
+  otherCount: PropTypes.number.isRequired,
+  query: queryPropType.isRequired,
+};

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

@@ -0,0 +1,14 @@
+import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
+
+import { OtherInfo } from './OtherInfo';
+
+const fixtures = {
+  render: {
+    updateQuery: jest.fn,
+    otherCount: 7,
+    query: { state: 'STOPPED', result: 'OTHER' },
+  },
+};
+
+describe('OtherInfo', () =>
+  testComponentSnapshotsWithFixtures(OtherInfo, fixtures));

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

@@ -4,8 +4,8 @@ import { Card } from 'patternfly-react';
 import classNames from 'classnames';
 import { noop } from 'foremanReact/common/helpers';
 import { translate as __ } from 'foremanReact/common/I18n';
-
-import { StoppedTable } from './StoppedTasksCardHelper';
+import { OtherInfo } from './OtherInfo';
+import { StoppedTable } from './StoppedTasksCardTable';
 import {
   timePropType,
   queryPropType,
@@ -14,7 +14,6 @@ import {
   TASKS_DASHBOARD_AVAILABLE_TIMES,
   TASKS_DASHBOARD_AVAILABLE_QUERY_STATES,
 } from '../../../../TasksDashboardConstants';
-import { getQueryValueText } from '../../../../TasksDashboardHelper';
 import './StoppedTasksCard.scss';
 
 const StoppedTasksCard = ({
@@ -44,16 +43,19 @@ const StoppedTasksCard = ({
         {__('Stopped')}
       </Card.Title>
       <Card.Body>
-        <table className="table table-bordered table-striped stopped-table">
-          <thead>
-            <tr>
-              <th />
-              <th>{__('Total')}</th>
-              <th>{getQueryValueText(time)}</th>
-            </tr>
-          </thead>
-          <tbody>{StoppedTable(data, query, time, updateQuery)}</tbody>
-        </table>
+        <React.Fragment>
+          <StoppedTable
+            data={data.results}
+            query={query}
+            time={time}
+            updateQuery={updateQuery}
+          />
+          <OtherInfo
+            updateQuery={updateQuery}
+            otherCount={data.other}
+            query={query}
+          />
+        </React.Fragment>
       </Card.Body>
     </Card>
   );
@@ -66,9 +68,12 @@ const resultPropType = PropTypes.shape({
 
 StoppedTasksCard.propTypes = {
   data: PropTypes.shape({
-    error: resultPropType.isRequired,
-    warning: resultPropType.isRequired,
-    success: resultPropType.isRequired,
+    results: PropTypes.shape({
+      error: resultPropType.isRequired,
+      warning: resultPropType.isRequired,
+      success: resultPropType.isRequired,
+    }),
+    other: PropTypes.number,
   }),
   time: timePropType,
   query: queryPropType,
@@ -78,9 +83,12 @@ StoppedTasksCard.propTypes = {
 
 StoppedTasksCard.defaultProps = {
   data: {
-    error: { total: 0, last: 0 },
-    warning: { total: 0, last: 0 },
-    success: { total: 0, last: 0 },
+    results: {
+      error: { total: 0, last: 0 },
+      warning: { total: 0, last: 0 },
+      success: { total: 0, last: 0 },
+    },
+    other: 0,
   },
   time: TASKS_DASHBOARD_AVAILABLE_TIMES.H24,
   query: {},