foreman-tasks 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24da58e2837688da28a18832b72b154ac74868157f6176f942119b8b856987c8
-  data.tar.gz: 3031305c5f86f3b03aed95a4501670cbd2dbd595db38f638354ff046f416823a
+  metadata.gz: dc7a0cd7f208321abcb3a5360623c6a639cbe6ae7e4f00c89987db5c18de95cb
+  data.tar.gz: 7cc406baeb19a74bb7ac645349050d192ff1d3f62edb7895eada9744f1d39fd4
 SHA512:
-  metadata.gz: a6a21ff8c4b9336f63118c2cdf6a4f11bf25ff882fe1dbd1b17d05f9722705c9cebabb522792416758c3fede1a8507d720cac0317076d8e833bfbb95a83fa8a4
-  data.tar.gz: bef5dd6cac70ac43d53e83950668e930883649d42966b10ff6303e0d581431d3f11028ae24c7ecc9ed0e2875214f4a512cfbaa46f1da81fd912d6a6f25da2db2
+  metadata.gz: 04ec2f1a2096462df40eea233da31072e713dfa2d75314a0a7c271a7b48cca32a46f9785b831f684dda45ad1c5efcf65da1c2941aad8c6f39deee25bf324f54f
+  data.tar.gz: 5d8dbdeeff9b3bb1287707cc2abb13847fcece48f986e81240ec687b280811c2249200ea497901061ed789f9481a1ba8ec639918ab5010b0cf52ea341b5b34a5

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

@@ -221,7 +221,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 +287,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/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/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '3.0.0'.freeze
+  VERSION = '3.0.1'.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/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: {},

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

@@ -39,4 +39,18 @@
       }
     }
   }
+
+  .other-active {
+    text-decoration: underline;
+  }
+
+  .pficon {
+    margin-right: 5px;
+  }
+
+  .btn-link {
+    font-size: 14px;
+    padding-top: 0;
+    padding-bottom: 0;
+  }
 }

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

@@ -1,48 +1,15 @@
 import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
-import {
-  TASKS_DASHBOARD_AVAILABLE_TIMES,
-  TASKS_DASHBOARD_AVAILABLE_QUERY_STATES,
-  TASKS_DASHBOARD_AVAILABLE_QUERY_MODES,
-  TASKS_DASHBOARD_AVAILABLE_QUERY_RESULTS,
-} from '../../../../TasksDashboardConstants';
+import { TASKS_DASHBOARD_AVAILABLE_QUERY_STATES } from '../../../../TasksDashboardConstants';
 import StoppedTasksCard from './StoppedTasksCard';
 
 const { STOPPED } = TASKS_DASHBOARD_AVAILABLE_QUERY_STATES;
-const { LAST } = TASKS_DASHBOARD_AVAILABLE_QUERY_MODES;
-const { WEEK } = TASKS_DASHBOARD_AVAILABLE_TIMES;
 
 const fixtures = {
   'render with minimal props': {},
-  'render with props': {
-    data: {
-      error: { total: 9, last: 1 },
-      warning: { total: 8, last: 2 },
-      success: { total: 7, last: 3 },
-    },
-    time: WEEK,
-  },
   'render selected': {
     query: { state: STOPPED },
   },
 };
 
-Object.values(TASKS_DASHBOARD_AVAILABLE_QUERY_RESULTS).forEach(result => {
-  fixtures[`render ${result}-total selected`] = {
-    query: {
-      state: STOPPED,
-      result,
-    },
-  };
-  fixtures[`render ${result}-last selected`] = {
-    time: WEEK,
-    query: {
-      state: STOPPED,
-      result,
-      mode: LAST,
-      time: WEEK,
-    },
-  };
-});
-
 describe('StoppedTasksCard', () =>
   testComponentSnapshotsWithFixtures(StoppedTasksCard, fixtures));

data/webpack/ForemanTasks/Components/TasksDashboard/Components/TasksCardsGrid/Components/StoppedTasksCard/{StoppedTasksCardHelper.js → StoppedTasksCardTable.js}

@@ -1,11 +1,18 @@
 import React from 'react';
+import PropTypes from 'prop-types';
 import { capitalize } from 'lodash';
 import classNames from 'classnames';
 import { Icon, Button } from 'patternfly-react';
+import { translate as __ } from 'foremanReact/common/I18n';
 import {
   TASKS_DASHBOARD_AVAILABLE_QUERY_STATES,
   TASKS_DASHBOARD_AVAILABLE_QUERY_MODES,
 } from '../../../../TasksDashboardConstants';
+import { getQueryValueText } from '../../../../TasksDashboardHelper';
+import {
+  timePropType,
+  queryPropType,
+} from '../../../../TasksDashboardPropTypes';
 
 const resultIcons = {
   error: <Icon type="pf" name="error-circle-o" />,
@@ -13,7 +20,7 @@ const resultIcons = {
   success: <Icon type="pf" name="ok" />,
 };
 
-export const StoppedTable = (data, query, time, updateQuery) =>
+const StoppedTableCells = (data, query, time, updateQuery) =>
   Object.entries(data).map(([result, { total, last }]) => {
     const { STOPPED } = TASKS_DASHBOARD_AVAILABLE_QUERY_STATES;
     const { LAST } = TASKS_DASHBOARD_AVAILABLE_QUERY_MODES;
@@ -61,3 +68,23 @@ export const StoppedTable = (data, query, time, updateQuery) =>
       </tr>
     );
   });
+
+export const StoppedTable = ({ data, query, time, updateQuery }) => (
+  <table className="table table-bordered table-striped stopped-table">
+    <thead>
+      <tr>
+        <th />
+        <th>{__('Total')}</th>
+        <th>{getQueryValueText(time)}</th>
+      </tr>
+    </thead>
+    <tbody>{StoppedTableCells(data, query, time, updateQuery)}</tbody>
+  </table>
+);
+
+StoppedTable.propTypes = {
+  data: PropTypes.object.isRequired,
+  query: queryPropType.isRequired,
+  time: timePropType.isRequired,
+  updateQuery: PropTypes.func.isRequired,
+};

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

@@ -0,0 +1,54 @@
+import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
+
+import { StoppedTable } from './StoppedTasksCardTable';
+import {
+  TASKS_DASHBOARD_AVAILABLE_TIMES,
+  TASKS_DASHBOARD_AVAILABLE_QUERY_STATES,
+  TASKS_DASHBOARD_AVAILABLE_QUERY_MODES,
+  TASKS_DASHBOARD_AVAILABLE_QUERY_RESULTS,
+} from '../../../../TasksDashboardConstants';
+
+const { STOPPED } = TASKS_DASHBOARD_AVAILABLE_QUERY_STATES;
+const { LAST } = TASKS_DASHBOARD_AVAILABLE_QUERY_MODES;
+const { WEEK } = TASKS_DASHBOARD_AVAILABLE_TIMES;
+const data = {
+  error: { total: 9, last: 1 },
+  warning: { total: 8, last: 2 },
+  success: { total: 7, last: 3 },
+};
+const fixtures = {
+  'render with props': {
+    data,
+    time: WEEK,
+    query: {},
+    updateQuery: jest.fn(),
+  },
+};
+
+Object.values(TASKS_DASHBOARD_AVAILABLE_QUERY_RESULTS)
+  .filter(result => result !== TASKS_DASHBOARD_AVAILABLE_QUERY_RESULTS.OTHER)
+  .forEach(result => {
+    fixtures[`render ${result}-total selected`] = {
+      query: {
+        state: STOPPED,
+        result,
+      },
+      updateQuery: jest.fn(),
+      data,
+      time: WEEK,
+    };
+    fixtures[`render ${result}-last selected`] = {
+      time: WEEK,
+      query: {
+        state: STOPPED,
+        result,
+        mode: LAST,
+        time: WEEK,
+      },
+      updateQuery: jest.fn(),
+      data,
+    };
+  });
+
+describe('StoppedTable', () =>
+  testComponentSnapshotsWithFixtures(StoppedTable, fixtures));