foreman-tasks 0.15.1 → 0.15.2

data/test/unit/ui_notifications_test.rb

@@ -0,0 +1,86 @@
+require 'foreman_tasks_test_helper'
+
+module ForemanTasks
+  class UiNotificationsTest < ActiveSupport::TestCase
+    include ForemanTasks::TestHelpers::WithInThreadExecutor
+
+    let(:admin_user) { @admin_user }
+    let(:task_owner) { FactoryBot.create(:user) }
+
+    let :sample_troubleshooting_url do
+      'https://theforeman.org/manuals/%{version}/tasks_troubleshooting.html#%{label}'
+    end
+
+    before do
+      Setting::ForemanTasks.load_defaults
+      ::ForemanTasks::Task.delete_all
+      load File.join(ForemanTasks::Engine.root, 'db', 'seeds.d', '30-notification_blueprints.rb')
+      @admin_user = FactoryBot.create(:user, :admin)
+      Setting[:foreman_tasks_troubleshooting_url] = sample_troubleshooting_url
+    end
+
+    describe UINotifications::Tasks::TaskPausedAdmin do
+      it 'notifies all admins about current amount of paused tasks when some paused task occurs' do
+        trigger_task
+        notification = user_notifications(admin_user).first
+        notification.message.must_equal "There is 1 paused task in the system that need attention"
+        links = notification.actions['links']
+        links.must_include('href' => '/foreman_tasks/tasks?search=state%3Dpaused',
+                           'title' => 'List of tasks')
+        links.must_include('name' => 'troubleshooting',
+                           'title' => 'Troubleshooting Documentation',
+                           'description' => 'See %{link} for more details on how to resolve the issue',
+                           'href' => "https://theforeman.org/manuals/#{SETTINGS[:version].short}/tasks_troubleshooting.html#",
+                           'external' => true)
+      end
+
+      it 'aggregates the notification when multiple tasks get paused' do
+        trigger_task
+        recipient1 = NotificationRecipient.find_by(user_id: admin_user)
+        recipient1.notification.message.must_match(/1 paused task/)
+
+        new_admin_user = FactoryBot.create(:user, :admin)
+
+        trigger_task
+
+        NotificationRecipient.find_by(id: recipient1.id).must_be_nil
+        Notification.find_by(id: recipient1.notification.id).must_be_nil
+        recipient2 = NotificationRecipient.find_by(user_id: admin_user)
+        recipient2.notification.message.must_match(/2 paused tasks/)
+
+        new_recipient = NotificationRecipient.find_by(user_id: new_admin_user)
+        new_recipient.notification.must_equal recipient2.notification
+      end
+    end
+
+    describe UINotifications::Tasks::TaskPausedOwner do
+      it 'notifies the owner about the paused task' do
+        task = trigger_task
+        notifications = user_notifications(task_owner)
+        assert_equal 1, notifications.size, 'Only notification for the main action should be triggered'
+        notification = notifications.first
+        notification.message.must_equal "The task 'Dummy pause action' got paused"
+        links = notification.actions['links']
+        links.must_include("href" => "/foreman_tasks/tasks/#{task.id}",
+                           "title" => "Task Details")
+        links.must_include('name' => 'troubleshooting',
+                           'title' => 'Troubleshooting Documentation',
+                           'description' => 'See %{link} for more details on how to resolve the issue',
+                           'href' => "https://theforeman.org/manuals/#{SETTINGS[:version].short}/tasks_troubleshooting.html#Support::DummyPauseAction",
+                           'external' => true)
+      end
+    end
+
+    def trigger_task
+      as_user task_owner do
+        t = ForemanTasks.trigger(::Support::DummyPauseAction)
+        t.finished.wait
+        ForemanTasks::Task.find_by(external_id: t.execution_plan_id)
+      end
+    end
+
+    def user_notifications(user)
+      Notification.joins(:notification_recipients).where('notification_recipients.user_id' => user.id)
+    end
+  end
+end

data/webpack/ForemanTasks/Components/Chart/Chart.js

@@ -0,0 +1,128 @@
+/*
+  Copied from react-c3js: https://github.com/bcbcarl/react-c3js/blob/master/src/index.js
+  Added missing features:
+    * onChartCreate
+    * onChartUpdate
+
+  TODO: update react-c3js or move to patternfly-react
+ */
+
+/* eslint-disable global-require,
+                  import/no-extraneous-dependencies,
+                  react/no-find-dom-node,
+                  react/no-unused-prop-types,
+                  react/require-default-props
+*/
+import React from 'react';
+import PropTypes from 'prop-types';
+import { findDOMNode } from 'react-dom';
+
+let c3;
+
+class C3Chart extends React.Component {
+  componentDidMount() {
+    c3 = require('c3');
+    this.updateChart(this.props);
+  }
+
+  componentWillReceiveProps(newProps) {
+    this.updateChart(newProps);
+    if (newProps.onPropsChanged) {
+      newProps.onPropsChanged(this.props, newProps, this.chart);
+    }
+  }
+
+  componentWillUnmount() {
+    this.destroyChart();
+  }
+
+  destroyChart() {
+    try {
+      this.chart = this.chart.destroy();
+    } catch (err) {
+      throw new Error('Internal C3 error', err);
+    }
+  }
+
+  generateChart(config) {
+    const newConfig = Object.assign({ bindto: findDOMNode(this) }, config);
+    return c3.generate(newConfig);
+  }
+
+  loadNewData(data) {
+    this.chart.load(data);
+  }
+
+  unloadData() {
+    this.chart.unload();
+  }
+
+  createChart(config) {
+    const { onChartCreate } = this.props;
+    this.chart = this.generateChart(config);
+
+    if (onChartCreate) onChartCreate(this.chart, config);
+  }
+
+  updateChart(config) {
+    const { onChartUpdate } = this.props;
+
+    if (!this.chart) {
+      this.createChart(config);
+    }
+
+    if (config.unloadBeforeLoad) {
+      this.unloadData();
+    }
+
+    this.loadNewData(config.data);
+
+    if (onChartUpdate) onChartUpdate(this.chart, config);
+  }
+
+  render() {
+    const className = this.props.className ? ` ${this.props.className}` : '';
+    const style = this.props.style ? this.props.style : {};
+    return <div className={className} style={style} />;
+  }
+}
+
+C3Chart.displayName = 'C3Chart';
+
+C3Chart.propTypes = {
+  data: PropTypes.object.isRequired,
+  title: PropTypes.object,
+  size: PropTypes.object,
+  padding: PropTypes.object,
+  color: PropTypes.object,
+  interaction: PropTypes.object,
+  transition: PropTypes.object,
+  oninit: PropTypes.func,
+  onrendered: PropTypes.func,
+  onmouseover: PropTypes.func,
+  onmouseout: PropTypes.func,
+  onresize: PropTypes.func,
+  onresized: PropTypes.func,
+  axis: PropTypes.object,
+  grid: PropTypes.object,
+  regions: PropTypes.array,
+  legend: PropTypes.object,
+  tooltip: PropTypes.object,
+  subchart: PropTypes.object,
+  zoom: PropTypes.object,
+  point: PropTypes.object,
+  line: PropTypes.object,
+  area: PropTypes.object,
+  bar: PropTypes.object,
+  pie: PropTypes.object,
+  donut: PropTypes.object,
+  gauge: PropTypes.object,
+  className: PropTypes.string,
+  style: PropTypes.object,
+  unloadBeforeLoad: PropTypes.bool,
+  onPropsChanged: PropTypes.func,
+  onChartCreate: PropTypes.func,
+  onChartUpdate: PropTypes.func,
+};
+
+export default C3Chart;

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

@@ -0,0 +1,20 @@
+import React from 'react';
+import { translate as __ } from 'foremanReact/common/I18n';
+
+import TasksDonutCard from '../TasksDonutCard/TasksDonutCard';
+
+const PausedTasksCard = ({ ...props }) => (
+  <TasksDonutCard title={__('Paused')} wantedQueryState="paused" {...props} />
+);
+
+const filterUnwantedFields = obj => {
+  const { title, wantedQueryState, ...newObj } = obj;
+  return newObj;
+};
+
+PausedTasksCard.propTypes = filterUnwantedFields(TasksDonutCard.propTypes);
+PausedTasksCard.defaultProps = filterUnwantedFields(
+  TasksDonutCard.defaultProps
+);
+
+export default PausedTasksCard;

data/webpack/ForemanTasks/Components/TasksDashboard/Components/TasksCardsGrid/Components/PausedTasksCard/PausedTasksCard.stories.js

@@ -0,0 +1,51 @@
+import React from 'react';
+import { storiesOf } from '@storybook/react';
+import { withKnobs, number, select } from '@storybook/addon-knobs';
+import { action } from '@storybook/addon-actions';
+import { withCardsDecorator } from '../../../../../../../stories/decorators';
+
+import {
+  TASKS_DASHBOARD_AVAILABLE_QUERY_MODES,
+  TASKS_DASHBOARD_AVAILABLE_TIMES,
+  TASKS_DASHBOARD_AVAILABLE_QUERY_STATES,
+} from '../../../../TasksDashboardConstants';
+import PausedTasksCard from './PausedTasksCard';
+
+storiesOf('TasksDashboard/TasksCardsGrid', module)
+  .addDecorator(withKnobs)
+  .addDecorator(withCardsDecorator)
+  .add('PausedTasksCard', () => {
+    const selectTime = select(
+      'time',
+      TASKS_DASHBOARD_AVAILABLE_TIMES,
+      PausedTasksCard.defaultProps.time
+    );
+
+    const selectMode = select(
+      'mode',
+      { ...TASKS_DASHBOARD_AVAILABLE_QUERY_MODES, NONE: 'none', TOTAL: null },
+      'none'
+    );
+    return (
+      <PausedTasksCard
+        data={{
+          last: number('data.last', 3),
+          older: number('data.older', 5),
+        }}
+        time={selectTime}
+        query={{
+          state: select(
+            'query.state',
+            {
+              ...TASKS_DASHBOARD_AVAILABLE_QUERY_STATES,
+              NONE: null,
+            },
+            TASKS_DASHBOARD_AVAILABLE_QUERY_STATES.PAUSED
+          ),
+          mode: selectMode,
+          time: selectTime,
+        }}
+        updateQuery={action('updateQuery')}
+      />
+    );
+  });

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

@@ -0,0 +1,11 @@
+import { testComponentSnapshotsWithFixtures } from 'react-redux-test-utils';
+
+import PausedTasksCard from './PausedTasksCard';
+
+const fixtures = {
+  'render with minimal props': {},
+  'render with some props': { some: 'prop' },
+};
+
+describe('PausedTasksCard', () =>
+  testComponentSnapshotsWithFixtures(PausedTasksCard, fixtures));

data/webpack/ForemanTasks/Components/TasksDashboard/Components/TasksCardsGrid/Components/PausedTasksCard/__snapshots__/PausedTasksCard.test.js.snap

@@ -0,0 +1,36 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`PausedTasksCard render with minimal props 1`] = `
+<TasksDonutCard
+  className=""
+  data={
+    Object {
+      "last": 0,
+      "older": 0,
+    }
+  }
+  query={Object {}}
+  time="H24"
+  title="Paused"
+  updateQuery={[Function]}
+  wantedQueryState="paused"
+/>
+`;
+
+exports[`PausedTasksCard render with some props 1`] = `
+<TasksDonutCard
+  className=""
+  data={
+    Object {
+      "last": 0,
+      "older": 0,
+    }
+  }
+  query={Object {}}
+  some="prop"
+  time="H24"
+  title="Paused"
+  updateQuery={[Function]}
+  wantedQueryState="paused"
+/>
+`;

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

@@ -0,0 +1,20 @@
+import React from 'react';
+import { translate as __ } from 'foremanReact/common/I18n';
+
+import TasksDonutCard from '../TasksDonutCard/TasksDonutCard';
+
+const RunningTasksCard = ({ ...props }) => (
+  <TasksDonutCard title={__('Running')} wantedQueryState="running" {...props} />
+);
+
+const filterUnwantedFields = obj => {
+  const { title, wantedQueryState, ...newObj } = obj;
+  return newObj;
+};
+
+RunningTasksCard.propTypes = filterUnwantedFields(TasksDonutCard.propTypes);
+RunningTasksCard.defaultProps = filterUnwantedFields(
+  TasksDonutCard.defaultProps
+);
+
+export default RunningTasksCard;

data/webpack/ForemanTasks/Components/TasksDashboard/Components/TasksCardsGrid/Components/RunningTasksCard/RunningTasksCard.stories.js

@@ -0,0 +1,51 @@
+import React from 'react';
+import { storiesOf } from '@storybook/react';
+import { withKnobs, number, select } from '@storybook/addon-knobs';
+import { action } from '@storybook/addon-actions';
+import { withCardsDecorator } from '../../../../../../../stories/decorators';
+
+import {
+  TASKS_DASHBOARD_AVAILABLE_QUERY_MODES,
+  TASKS_DASHBOARD_AVAILABLE_TIMES,
+  TASKS_DASHBOARD_AVAILABLE_QUERY_STATES,
+} from '../../../../TasksDashboardConstants';
+import RunningTasksCard from './RunningTasksCard';
+
+storiesOf('TasksDashboard/TasksCardsGrid', module)
+  .addDecorator(withKnobs)
+  .addDecorator(withCardsDecorator)
+  .add('RunningTasksCard', () => {
+    const selectTime = select(
+      'time',
+      TASKS_DASHBOARD_AVAILABLE_TIMES,
+      RunningTasksCard.defaultProps.time
+    );
+
+    const selectMode = select(
+      'mode',
+      { ...TASKS_DASHBOARD_AVAILABLE_QUERY_MODES, NONE: 'none', TOTAL: null },
+      'none'
+    );
+    return (
+      <RunningTasksCard
+        data={{
+          last: number('data.last', 3),
+          older: number('data.older', 5),
+        }}
+        time={selectTime}
+        query={{
+          state: select(
+            'query.state',
+            {
+              ...TASKS_DASHBOARD_AVAILABLE_QUERY_STATES,
+              NONE: null,
+            },
+            TASKS_DASHBOARD_AVAILABLE_QUERY_STATES.RUNNING
+          ),
+          mode: selectMode,
+          time: selectTime,
+        }}
+        updateQuery={action('updateQuery')}
+      />
+    );
+  });

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

@@ -0,0 +1,11 @@
+import { testComponentSnapshotsWithFixtures } from 'react-redux-test-utils';
+
+import RunningTasksCard from './RunningTasksCard';
+
+const fixtures = {
+  'render with minimal props': {},
+  'render with some props': { some: 'prop' },
+};
+
+describe('RunningTasksCard', () =>
+  testComponentSnapshotsWithFixtures(RunningTasksCard, fixtures));

data/webpack/ForemanTasks/Components/TasksDashboard/Components/TasksCardsGrid/Components/RunningTasksCard/__snapshots__/RunningTasksCard.test.js.snap

@@ -0,0 +1,36 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`RunningTasksCard render with minimal props 1`] = `
+<TasksDonutCard
+  className=""
+  data={
+    Object {
+      "last": 0,
+      "older": 0,
+    }
+  }
+  query={Object {}}
+  time="H24"
+  title="Running"
+  updateQuery={[Function]}
+  wantedQueryState="running"
+/>
+`;
+
+exports[`RunningTasksCard render with some props 1`] = `
+<TasksDonutCard
+  className=""
+  data={
+    Object {
+      "last": 0,
+      "older": 0,
+    }
+  }
+  query={Object {}}
+  some="prop"
+  time="H24"
+  title="Running"
+  updateQuery={[Function]}
+  wantedQueryState="running"
+/>
+`;