foreman_remote_execution 1.5.0 → 1.5.1

data/app/views/job_invocations/show.html.erb

@@ -1,24 +1,30 @@
 <% title @job_invocation.description, trunc_with_tooltip(@job_invocation.description, 120) %>
 <% stylesheet 'foreman_remote_execution/job_invocations' %>
 <% javascript 'charts', 'foreman_remote_execution/template_invocation' %>
+<%= javascript_include_tag *webpack_asset_paths('remoteexecution', :extension => 'js'), "data-turbolinks-track" => true, 'defer' => 'defer' %>
 
 <% if @job_invocation.task %>
   <% title_actions(button_group(job_invocation_task_buttons(@job_invocation.task))) %>
 <% end %>
 
 <ul class="nav nav-tabs" data-tabs="tabs">
-  <li class="<%= job_invocation_active_tab(:overview, params) %>"><a href="#primary" data-toggle="tab"><%= _('Overview') %></a></li>
-  <li class="<%= job_invocation_active_tab(:hosts, params) %>"><a href="#hosts" data-toggle="tab"><%= _('Hosts') %></a></li>
-  <% unless @job_invocation.recurring_logic.nil? %><li><a href="#recurring_logic" data-toggle="tab"><%= _('Recurring logic') %></a></li><% end %>
+  <li class="active">
+    <a href="#primary" data-toggle="tab"><%= _('Overview') %></a>
+  </li>
+  <li>
+    <a href="#preview_templates" data-toggle="tab"><%= _('Preview templates') %></a>
+  </li>
+  <% if @job_invocation.recurring_logic.present? %>
+    <li><a href="#recurring_logic" data-toggle="tab"><%= _('Recurring logic') %></a></li>
+  <% end %>
 </ul>
 
 <div class="tab-content">
-  <div class="tab-pane <%= job_invocation_active_tab(:overview, params) %>" id="primary">
-    <%= render 'tab_overview', :job_invocation => @job_invocation %>
+  <div class="tab-pane active" id="primary">
+    <%= render 'tab_overview', :job_invocation => @job_invocation, :hosts => @hosts %>
   </div>
-
-  <div class="tab-pane <%= job_invocation_active_tab(:hosts, params) %>" id="hosts" data-refresh_required="<%= @job_invocation.resolved? ? '' : 'true' %>">
-    <%= render 'tab_hosts', :job_invocation => @job_invocation, :hosts => @hosts %>
+  <div class="tab-pane" id="preview_templates">
+    <%= render 'tab_preview_templates', :job_invocation => @job_invocation %>
   </div>
 
   <% unless @job_invocation.recurring_logic.nil? %>

data/app/views/job_invocations/show.js.erb

@@ -1,11 +1,8 @@
 $('div#title_action div.btn-group').html('<%= button_group(job_invocation_task_buttons(@job_invocation.task)).html_safe %>');
-$('div#status_chart').html('<%=j job_invocation_chart(@job_invocation) %>');
-$('div#status').flot_pie();
-
 <% if params[:hosts_needs_refresh] == 'true' && @job_invocation.resolved? %>
-  var hosts_tab = $('div#hosts');
-  hosts_tab.html('<%=j render('tab_hosts', :job_invocation => @job_invocation, :hosts => @hosts) %>');
-  hosts_tab.data('refresh_required', '');
+  var hosts_table = $('div#hosts');
+  hosts_table.html('<%=j render('tab_hosts', :job_invocation => @job_invocation, :hosts => @hosts) %>');
+  hosts_table.data('refresh_required', '');
 <% end %>
 
 <% ['name', 'status', 'actions', 'provider'].each do |attribute| %>

data/config/routes.rb

@@ -19,6 +19,7 @@ Rails.application.routes.draw do
   resources :job_invocations, :only => [:new, :create, :show, :index] do
     collection do
       post 'refresh'
+      get 'chart'
       get 'preview_hosts'
       get 'auto_complete_search'
     end

data/lib/foreman_remote_execution/engine.rb

@@ -31,7 +31,7 @@ module ForemanRemoteExecution
 
     initializer 'foreman_remote_execution.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_remote_execution do
-        requires_foreman '>= 1.17'
+        requires_foreman '>= 1.18'
 
         apipie_documented_controllers ["#{ForemanRemoteExecution::Engine.root}/app/controllers/api/v2/*.rb"]
 
@@ -54,7 +54,7 @@ module ForemanRemoteExecution
           permission :lock_job_templates, { :job_templates => [:lock, :unlock] }, :resource_type => 'JobTemplate'
           permission :create_job_invocations, { :job_invocations => [:new, :create, :refresh, :rerun, :preview_hosts],
                                                 'api/v2/job_invocations' => [:create, :rerun] }, :resource_type => 'JobInvocation'
-          permission :view_job_invocations, { :job_invocations => [:index, :show, :auto_complete_search], :template_invocations => [:show],
+          permission :view_job_invocations, { :job_invocations => [:index, :chart, :show, :auto_complete_search], :template_invocations => [:show],
                                               'api/v2/job_invocations' => [:index, :show, :output] }, :resource_type => 'JobInvocation'
           permission :create_template_invocations, {}, :resource_type => 'TemplateInvocation'
           permission :cancel_job_invocations, { :job_invocations => [:cancel], 'api/v2/job_invocations' => [:cancel] }, :resource_type => 'JobInvocation'

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '1.5.0'.freeze
+  VERSION = '1.5.1'.freeze
 end

data/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "foreman_remote_execution",
+  "version": "1.0.0",
+  "license": "GPL-3.0",
+  "scripts": {
+    "lint": "./node_modules/.bin/eslint -c .eslintrc webpack/ script/ || exit 0",
+    "test": "node node_modules/.bin/jest webpack",
+    "test:watch": "node node_modules/.bin/jest webpack --watchAll",
+    "test:current": "node node_modules/.bin/jest webpack --watch"
+  },
+  "jest": {
+    "verbose": true,
+    "moduleDirectories": [
+      "node_modules",
+      "webpack"
+    ],
+    "setupFiles": [
+      "raf/polyfill",
+      "./webpack/test_setup.js"
+    ],
+    "testPathIgnorePatterns": [
+      "/node_modules/",
+      "<rootDir>/foreman/"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/foreman_remote_execution/foreman_remote_execution.git"
+  },
+  "bugs": {
+    "url": "http://projects.theforeman.org/projects/foreman_remote_execution/issues"
+  },
+  "devDependencies": {
+    "babel-eslint": "^8.2.1",
+    "babel-preset-env": "^1.6.0",
+    "babel-preset-react": "^6.24.1",
+    "babel-plugin-lodash": "^3.3.2",
+    "babel-plugin-transform-object-assign": "^6.22.0",
+    "babel-plugin-transform-class-properties": "^6.24.1",
+    "babel-plugin-transform-object-rest-spread": "^6.26.0",
+    "enzyme": "^3.2.0",
+    "enzyme-adapter-react-16": "^1.1.0",
+    "enzyme-to-json": "^3.1.2",
+    "eslint": "^4.10.0",
+    "eslint-config-airbnb": "^16.0.0",
+    "eslint-plugin-import": "^2.8.0",
+    "eslint-plugin-jest": "^21.2.0",
+    "eslint-plugin-jsx-a11y": "^6.0.2",
+    "eslint-plugin-react": "^7.4.0",
+    "jest": "^21.2.1"
+  },
+  "dependencies": {
+    "babel-polyfill": "^6.26.0",
+    "prop-types": "^15.6.0",
+    "react": "^16.2.0",
+    "react-dom": "^16.2.0",
+    "react-redux": "^5.0.6",
+    "redux": "^3.7.2",
+    "seamless-immutable": "^7.1.3",
+    "urijs": "^1.19.0"
+  }
+}

data/test/unit/job_invocation_test.rb

@@ -173,4 +173,19 @@ class JobInvocationTest < ActiveSupport::TestCase
     end
   end
 
+  describe '#finished?' do
+    let(:task) { ForemanTasks::Task.new }
+    before { job_invocation.task = task }
+
+    it 'returns false if task state is pending' do
+      job_invocation.task.expects(:pending?).returns(true)
+      refute job_invocation.finished?
+    end
+
+    it 'returns true if task is not pending' do
+      job_invocation.task.expects(:pending?).returns(false)
+      assert job_invocation.finished?
+    end
+  end
+
 end

data/webpack/index.js

@@ -0,0 +1,29 @@
+import URI from 'urijs';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { mount, registerReducer } from 'foremanReact/common/MountingService';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import componentRegistry from 'foremanReact/components/componentRegistry';
+import JobInvocationContainer from './react_app/components/jobInvocations';
+import rootReducer from './react_app/redux/reducers';
+
+componentRegistry.register({
+  name: 'JobInvocationContainer',
+  type: JobInvocationContainer,
+});
+
+registerReducer('foremanRemoteExecutionReducers', rootReducer);
+
+if (window.location.href.match(/job_invocations/)) {
+  const jobInvocationId = parseInt(
+    new URI(window.location.href).filename(),
+    10,
+  );
+
+  const mountJobInvocationContainer = () => {
+    mount('JobInvocationContainer', '#status_chart', {
+      url: `/job_invocations/chart?id=${jobInvocationId}`,
+    });
+  };
+
+  document.addEventListener('page:change', mountJobInvocationContainer);
+}

data/webpack/react_app/components/jobInvocations/AggregateStatus/index.js

@@ -0,0 +1,34 @@
+import React from 'react';
+
+const AggregateStatus = ({ statuses }) => (
+  <div id="aggregate_statuses">
+    <p className="card-pf-aggregate-status-notifications">
+      <span className="card-pf-aggregate-status-notification">
+        <span id="success_count">
+          <span className="pficon pficon-ok" />
+          {statuses.success}
+        </span>
+      </span>
+      <span className="card-pf-aggregate-status-notification">
+        <span id="failed_count">
+          <span className="pficon pficon-error-circle-o" />
+          {statuses.failed}
+        </span>
+      </span>
+      <span className="card-pf-aggregate-status-notification">
+        <span id="pending_count">
+          <span className="pficon pficon-running" />
+          {statuses.pending}
+        </span>
+      </span>
+      <span className="card-pf-aggregate-status-notification">
+        <span id="cancelled_count">
+          <span className="pficon pficon-close" />
+          {statuses.cancelled}
+        </span>
+      </span>
+    </p>
+  </div>
+);
+
+export default AggregateStatus;

data/webpack/react_app/components/jobInvocations/AggregateStatus/index.test.js

@@ -0,0 +1,36 @@
+import React from 'react';
+import { shallow } from 'enzyme';
+import AggregateStatus from './index.js';
+
+jest.unmock('./index.js');
+
+describe('AggregateStatus', () => {
+  describe('has no data', () => {
+    it('renders cards with no data', () => {
+      const chartNumbers = shallow(<AggregateStatus statuses={{}} />);
+      const success = chartNumbers.find('#success_count').text();
+      const failed = chartNumbers.find('#failed_count').text();
+      const pending = chartNumbers.find('#pending_count').text();
+      const cancelled = chartNumbers.find('#cancelled_count').text();
+      expect(success).toBe('');
+      expect(failed).toBe('');
+      expect(cancelled).toBe('');
+      expect(pending).toBe('');
+    });
+
+    it('renders cards with props passed', () => {
+      const statuses = {
+        success: 19, failed: 20, cancelled: 31, pending: 3,
+      };
+      const chartNumbers = shallow(<AggregateStatus statuses={statuses} />);
+      const success = chartNumbers.find('#success_count').text();
+      const failed = chartNumbers.find('#failed_count').text();
+      const pending = chartNumbers.find('#pending_count').text();
+      const cancelled = chartNumbers.find('#cancelled_count').text();
+      expect(success).toBe(statuses.success.toString());
+      expect(failed).toBe(statuses.failed.toString());
+      expect(cancelled).toBe(statuses.cancelled.toString());
+      expect(pending).toBe(statuses.pending.toString());
+    });
+  });
+});

data/webpack/react_app/components/jobInvocations/index.js

@@ -0,0 +1,58 @@
+import { connect } from 'react-redux';
+import React from 'react';
+import Immutable from 'seamless-immutable';
+import PropTypes from 'prop-types';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import DonutChart from 'foremanReact/components/common/charts/DonutChart';
+import AggregateStatus from './AggregateStatus/index.js';
+import * as JobInvocationActions from '../../redux/actions/jobInvocations';
+
+class JobInvocationContainer extends React.Component {
+  componentDidMount() {
+    const { startJobInvocationsPolling, data: { url } } = this.props;
+
+    startJobInvocationsPolling(url);
+  }
+
+  render() {
+    const { jobInvocations, statuses } = this.props;
+
+    return (
+      <div id="job_invocations_chart_container">
+        <DonutChart data={Immutable.asMutable(jobInvocations)} />
+        <AggregateStatus statuses={statuses} />
+      </div>
+    );
+  }
+}
+
+const mapStateToProps = (state) => {
+  const {
+    jobInvocations,
+    statuses,
+  } = state.foremanRemoteExecutionReducers.jobInvocations;
+
+  return {
+    jobInvocations,
+    statuses,
+  };
+};
+
+JobInvocationContainer.propTypes = {
+  startJobInvocationsPolling: PropTypes.func,
+  data: PropTypes.string,
+  jobInvocations: PropTypes.arrayOf(PropTypes.arrayOf(
+    PropTypes.string,
+    PropTypes.number,
+    PropTypes.string,
+  )),
+  statuses: PropTypes.shape({}),
+};
+
+JobInvocationContainer.defaultProps = {
+  startJobInvocationsPolling: JobInvocationActions.startJobInvocationsPolling,
+  data: '',
+  jobInvocations: [['property', 3, 'color']],
+  statuses: {},
+};
+export default connect(mapStateToProps, JobInvocationActions)(JobInvocationContainer);

data/webpack/react_app/redux/actions/jobInvocations/index.js

@@ -0,0 +1,74 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import API from 'foremanReact/API';
+
+import {
+  JOB_INVOCATIONS_GET_JOB_INVOCATIONS,
+  JOB_INVOCATIONS_POLLING_STARTED,
+  JOB_INVOCATIONS_JOB_FINISHED,
+} from '../../consts';
+
+const defaultJobInvocationsPollingInterval = 1000;
+const jobInvocationsInterval = process.env.JOB_INVOCATIONS_POLLING ||
+  defaultJobInvocationsPollingInterval;
+
+const getJobInvocations = url => (dispatch, getState) => {
+  function onGetJobInvocationsSuccess({ data }) {
+    // If the job has finished, stop polling
+    if (data.finished) {
+      dispatch({
+        type: JOB_INVOCATIONS_JOB_FINISHED,
+        payload: {
+          jobInvocations: data,
+        },
+      });
+    } else {
+      dispatch({
+        type: JOB_INVOCATIONS_GET_JOB_INVOCATIONS,
+        payload: {
+          jobInvocations: data,
+        },
+      });
+    }
+  }
+
+  function onGetJobInvocationsFailed(error) {
+    if (error.response.status === 401) {
+      window.location.replace('/users/login');
+    }
+  }
+
+  function triggerPolling() {
+    if (jobInvocationsInterval) {
+      setTimeout(
+        () => dispatch(getJobInvocations(url)),
+        jobInvocationsInterval,
+      );
+    }
+  }
+
+  const isDocumentVisible =
+    document.visibilityState === 'visible' ||
+    document.visibilityState === 'prerender';
+
+  if (getState().foremanRemoteExecutionReducers.jobInvocations.isPolling) {
+    if (isDocumentVisible) {
+      API.get(url)
+        .then(onGetJobInvocationsSuccess)
+        .catch(onGetJobInvocationsFailed)
+        .then(triggerPolling);
+    } else {
+      // document is not visible, keep polling without api call
+      triggerPolling();
+    }
+  }
+};
+
+export const startJobInvocationsPolling = url => (dispatch, getState) => {
+  if (getState().foremanRemoteExecutionReducers.jobInvocations.isPolling) {
+    return;
+  }
+  dispatch({
+    type: JOB_INVOCATIONS_POLLING_STARTED,
+  });
+  dispatch(getJobInvocations(url));
+};

data/webpack/react_app/redux/consts.js

@@ -0,0 +1,6 @@
+export const JOB_INVOCATIONS_POLLING_STARTED =
+  'JOB_INVOCATIONS_POLLING_STARTED';
+export const JOB_INVOCATIONS_GET_JOB_INVOCATIONS =
+  'JOB_INVOCATIONS_GET_JOB_INVOCATIONS';
+export const JOB_INVOCATIONS_JOB_FINISHED =
+  'JOB_INVOCATIONS_JOB_FINISHED';

data/webpack/react_app/redux/reducers/index.js

@@ -0,0 +1,6 @@
+import { combineReducers } from 'redux';
+import jobInvocations from './jobInvocations/';
+
+export default combineReducers({
+  jobInvocations,
+});

data/webpack/react_app/redux/reducers/jobInvocations/index.fixtures.js

@@ -0,0 +1,78 @@
+import Immutable from 'seamless-immutable';
+
+export const initialState = Immutable({
+  isPolling: false,
+  jobInvocations: [],
+  statuses: [],
+});
+
+export const pollingStarted = Immutable({
+  isPolling: true,
+  jobInvocations: [],
+  statuses: [],
+});
+
+export const jobInvocationsPayload = Immutable({
+  jobInvocations: {
+    job_invocations: [
+      [
+        'Success',
+        100,
+        '#B7312D',
+      ],
+      [
+        'Failed',
+        20,
+        '#B7312D',
+      ],
+      [
+        'Pending',
+        40,
+        '#B7312D',
+      ],
+      [
+        'Cancelled',
+        0,
+        '#B7312D',
+      ],
+    ],
+    statuses: {
+      cancelled: 0,
+      failed: 0,
+      pending: 0,
+      success: 1,
+    },
+  },
+});
+
+export const jobInvocationsReceived = Immutable({
+  isPolling: true,
+  jobInvocations: [
+    [
+      'Success',
+      100,
+      '#B7312D',
+    ],
+    [
+      'Failed',
+      20,
+      '#B7312D',
+    ],
+    [
+      'Pending',
+      40,
+      '#B7312D',
+    ],
+    [
+      'Cancelled',
+      0,
+      '#B7312D',
+    ],
+  ],
+  statuses: {
+    cancelled: 0,
+    failed: 0,
+    pending: 0,
+    success: 1,
+  },
+});