foreman_host_reports 0.0.3

data/test/test_plugin_helper.rb

@@ -0,0 +1,11 @@
+# This calls the main test_helper in Foreman-core
+require 'test_helper'
+
+# Add plugin to FactoryBot's paths
+FactoryBot.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+FactoryBot.reload
+
+def read_report(file)
+  json = File.expand_path(File.join('..', 'snapshots', file), __FILE__)
+  File.read(json)
+end

data/test/unit/foreman_host_reports_test.rb

@@ -0,0 +1,9 @@
+require 'test_plugin_helper'
+
+class ForemanHostReportsTest < ActiveSupport::TestCase
+  test 'should find host reports by keyword' do
+    report = FactoryBot.create(:host_report, :with_keyword)
+    result = HostReport.search_for("keyword= HasError").pluck(:id)
+    assert_include result, report.id
+  end
+end

data/webpack/global_index.js

@@ -0,0 +1,4 @@
+import { registerRoutes } from 'foremanReact/routes/RoutingService';
+import ForemanHostReportsRoutes from './src/Router/routes';
+
+registerRoutes('foreman_host_reports', ForemanHostReportsRoutes);

data/webpack/global_test_setup.js

@@ -0,0 +1,11 @@
+// runs before each test to make sure console.error output will
+// fail a test (i.e. default PropType missing). Check the error
+// output and traceback for actual error.
+global.console.error = (error, stack) => {
+  /* eslint-disable-next-line no-console */
+  if (stack) console.log(stack); // Prints out original stack trace
+  throw new Error(error);
+};
+
+// Increase jest timeout as some tests using multiple http mocks can time out on CI systems.
+jest.setTimeout(10000);

data/webpack/src/Router/HostReports/Components/HostReportDeleteModal.js

@@ -0,0 +1,50 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+
+import { sprintf, translate as __ } from 'foremanReact/common/I18n';
+import ForemanModal from 'foremanReact/components/ForemanModal';
+import { foremanUrl } from 'foremanReact/common/helpers';
+
+import { HOST_REPORT_DELETE_MODAL_ID } from '../constants';
+
+const HostReportDeleteModal = ({ toDelete, onSuccess }) => {
+  const { id, hostName } = toDelete;
+
+  return (
+    <ForemanModal
+      id={HOST_REPORT_DELETE_MODAL_ID}
+      title={__('Confirm report deletion')}
+      backdrop="static"
+      enforceFocus
+      submitProps={{
+        url: foremanUrl(`/api/v2/host_reports/${id}`),
+        message: sprintf(
+          __('Report for %s was successfully deleted'),
+          hostName
+        ),
+        onSuccess,
+        submitBtnProps: {
+          bsStyle: 'danger',
+          btnText: __('Delete'),
+        },
+      }}
+    >
+      {sprintf(
+        __('You are about to delete a report for %s. Are you sure?'),
+        hostName
+      )}
+      <ForemanModal.Footer />
+    </ForemanModal>
+  );
+};
+
+HostReportDeleteModal.propTypes = {
+  toDelete: PropTypes.object,
+  onSuccess: PropTypes.func.isRequired,
+};
+
+HostReportDeleteModal.defaultProps = {
+  toDelete: {},
+};
+
+export default HostReportDeleteModal;

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/FormatCell.js

@@ -0,0 +1,53 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { UnknownIcon } from '@patternfly/react-icons';
+
+import { sprintf, translate as __ } from 'foremanReact/common/I18n';
+
+import formats from './formatImages';
+
+import './FormatCell.scss';
+
+const FormatCell = ({ format }) => {
+  switch (format) {
+    case 'plain':
+      return (
+        <UnknownIcon
+          size="md"
+          title={__('Obsolete or custom report formats')}
+        />
+      );
+    case 'puppet':
+      return (
+        <img
+          className="format-img"
+          src={formats.puppet}
+          alt="Puppet"
+          title={sprintf(__('Reported by %s'), 'Puppet')}
+        />
+      );
+    case 'ansible':
+      return (
+        <img
+          className="format-img"
+          src={formats.ansible}
+          alt="Ansible"
+          title={sprintf(__('Reported by %s'), 'Ansible')}
+        />
+      );
+    default:
+      return (
+        <UnknownIcon size="md" title={sprintf(__('Reported by %s'), format)} />
+      );
+  }
+};
+
+FormatCell.propTypes = {
+  format: PropTypes.string,
+};
+
+FormatCell.defaultProps = {
+  format: 'plain',
+};
+
+export default FormatCell;

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/FormatCell.scss

@@ -0,0 +1,4 @@
+.format-img {
+  max-width: 21px;
+  max-height: 21px;
+}

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/Formatters/formatCellFormatter.js

@@ -0,0 +1,6 @@
+import React from 'react';
+import FormatCell from '../FormatCell';
+
+const formatCellFormatter = () => value => <FormatCell format={value} />;
+
+export default formatCellFormatter;

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/Formatters/hostReportsToShowFormatter.js

@@ -0,0 +1,13 @@
+import React from 'react';
+import HostReportsToShowCell from '../HostReportsToShowCell';
+
+const hostReportsToShowFormatter = () => (
+  value,
+  { rowData: { canEdit, hostId } }
+) => (
+  <HostReportsToShowCell active={canEdit} id={hostId}>
+    {value}
+  </HostReportsToShowCell>
+);
+
+export default hostReportsToShowFormatter;

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/Formatters/index.js

@@ -0,0 +1,4 @@
+export { default as formatCellFormatter } from './formatCellFormatter';
+export { default as reportToShowFormatter } from './reportToShowFormatter';
+export { default as hostReportsToShowFormatter } from './hostReportsToShowFormatter';
+export { default as statusFormatter } from './statusFormatter';

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/Formatters/reportToShowFormatter.js

@@ -0,0 +1,13 @@
+import React from 'react';
+
+import RelativeDateTime from 'foremanReact/components/common/dates/RelativeDateTime';
+
+import ReportToShowCell from '../ReportToShowCell';
+
+const reportToShowFormatter = () => (value, { rowData: { canEdit, id } }) => (
+  <ReportToShowCell active={canEdit} id={id}>
+    <RelativeDateTime date={value} />
+  </ReportToShowCell>
+);
+
+export default reportToShowFormatter;

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/Formatters/statusFormatter.js

@@ -0,0 +1,9 @@
+import React from 'react';
+
+import StatusCell from '../StatusCell';
+
+const statusFormatter = () => (value, { rowData: { format, status } }) => (
+  <StatusCell format={format} value={value} />
+);
+
+export default statusFormatter;

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/HostReportsToShowCell.js

@@ -0,0 +1,32 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Button } from '@patternfly/react-core';
+
+const HostReportsToShowCell = ({ active, id, children }) =>
+  active ? (
+    <Button
+      variant="link"
+      isInline
+      component="a"
+      href={`/hosts/${id}/host_reports`}
+    >
+      {children}
+    </Button>
+  ) : (
+    <Button variant="link" isInline isDisabled component="a">
+      {children}
+    </Button>
+  );
+
+HostReportsToShowCell.propTypes = {
+  active: PropTypes.bool,
+  id: PropTypes.number.isRequired,
+  children: PropTypes.node,
+};
+
+HostReportsToShowCell.defaultProps = {
+  active: false,
+  children: null,
+};
+
+export default HostReportsToShowCell;

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/ReportToShowCell.js

@@ -0,0 +1,27 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Button } from '@patternfly/react-core';
+
+const ReportToShowCell = ({ active, id, children }) =>
+  active ? (
+    <Button variant="link" isInline component="a" href={`/host_reports/${id}`}>
+      {children}
+    </Button>
+  ) : (
+    <Button variant="link" isInline isDisabled component="a">
+      {children}
+    </Button>
+  );
+
+ReportToShowCell.propTypes = {
+  active: PropTypes.bool,
+  id: PropTypes.number.isRequired,
+  children: PropTypes.node,
+};
+
+ReportToShowCell.defaultProps = {
+  active: false,
+  children: null,
+};
+
+export default ReportToShowCell;

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/StatusCell.js

@@ -0,0 +1,77 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { capitalize } from 'lodash';
+
+import './StatusCell.scss';
+
+const StatusCell = ({ format, value }) => {
+  switch (format) {
+    case 'puppet':
+      return (
+        <td>
+          <ul className="status-list">
+            {value.map(status => {
+              let style = '';
+              switch (status[0]) {
+                case 'failed':
+                  style = 'label-danger';
+                  break;
+                case 'failed_to_restart':
+                  style = 'label-warning';
+                  break;
+                default:
+                  style = 'label-info';
+              }
+              if (!status[2]) style = 'label-default';
+              return (
+                <li key={status[0]}>
+                  {`${status[1]}: `}
+                  <span className={`label ${style}`}>{status[2]}</span>
+                </li>
+              );
+            })}
+          </ul>
+        </td>
+      );
+    case 'ansible':
+      return (
+        <td>
+          <ul className="status-list">
+            {Object.keys(value).map(status => {
+              let style = '';
+              switch (status) {
+                case 'failed':
+                  style = 'label-danger';
+                  break;
+                case 'skipped':
+                  style = 'label-warning';
+                  break;
+                default:
+                  style = 'label-info';
+              }
+              if (!value[status]) style = 'label-default';
+              return (
+                <li key={status}>
+                  {`${capitalize(status)}: `}
+                  <span className={`label ${style}`}>{value[status]}</span>
+                </li>
+              );
+            })}
+          </ul>
+        </td>
+      );
+    default:
+      return <td>N/A</td>;
+  }
+};
+
+StatusCell.propTypes = {
+  format: PropTypes.string,
+  value: PropTypes.any.isRequired,
+};
+
+StatusCell.defaultProps = {
+  format: 'plain',
+};
+
+export default StatusCell;

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/StatusCell.scss

@@ -0,0 +1,9 @@
+.status-list {
+  display: flex;
+  flex-wrap: wrap;
+  margin-bottom: 0px;
+
+  li {
+    margin-right: 0.5em;
+  }
+}

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/formatImages.js

@@ -0,0 +1,7 @@
+import puppet from './images/puppet.png';
+import ansible from './images/ansible.png';
+
+export default {
+  puppet,
+  ansible,
+};

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/HostReportsTable.js

@@ -0,0 +1,85 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+
+import { Table } from 'foremanReact/components/common/table';
+import Pagination from 'foremanReact/components/Pagination/PaginationWrapper';
+import DefaultEmptyState from 'foremanReact/components/common/EmptyState';
+import { translate as __ } from 'foremanReact/common/I18n';
+
+import HostReportDeleteModal from '../../../Components/HostReportDeleteModal';
+
+import createHostReportsTableSchema from './HostReportsTableSchema';
+
+const HostReportsTable = ({
+  fetchAndPush,
+  itemCount,
+  results,
+  sort,
+  pagination,
+  toDelete,
+  onDeleteClick,
+  reloadWithSearch,
+  hostId,
+}) => {
+  const onDeleteSuccess = () => {
+    const currentPage = pagination.page;
+    const maxPage = Math.ceil((itemCount - 1) / pagination.perPage);
+    fetchAndPush({ page: maxPage < currentPage ? maxPage : currentPage });
+  };
+
+  const body =
+    itemCount > 0 ? (
+      <Table
+        key="host-reports-table"
+        columns={createHostReportsTableSchema(
+          fetchAndPush,
+          sort.by,
+          sort.order,
+          onDeleteClick,
+          hostId
+        )}
+        rows={results}
+        id="host-reports-table"
+      />
+    ) : (
+      <DefaultEmptyState
+        icon="add-circle-o"
+        header={__('No Results')}
+        description=""
+        documentation={null}
+      />
+    );
+
+  return (
+    <React.Fragment>
+      <HostReportDeleteModal toDelete={toDelete} onSuccess={onDeleteSuccess} />
+      {body}
+      <Pagination
+        viewType="list"
+        itemCount={itemCount}
+        pagination={pagination}
+        onChange={fetchAndPush}
+        dropdownButtonId="host-reports-page-pagination-dropdown"
+      />
+    </React.Fragment>
+  );
+};
+
+HostReportsTable.propTypes = {
+  results: PropTypes.array.isRequired,
+  fetchAndPush: PropTypes.func.isRequired,
+  onDeleteClick: PropTypes.func.isRequired,
+  itemCount: PropTypes.number.isRequired,
+  sort: PropTypes.object,
+  pagination: PropTypes.object.isRequired,
+  toDelete: PropTypes.object.isRequired,
+  reloadWithSearch: PropTypes.func.isRequired,
+  hostId: PropTypes.string,
+};
+
+HostReportsTable.defaultProps = {
+  sort: { by: '', order: '' },
+  hostId: null,
+};
+
+export default HostReportsTable;

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/HostReportsTableSchema.js

@@ -0,0 +1,65 @@
+import { translate as __ } from 'foremanReact/common/I18n';
+import {
+  column,
+  sortableColumn,
+  headerFormatterWithProps,
+  deleteActionCellFormatter,
+  cellFormatter,
+} from 'foremanReact/components/common/table';
+
+import {
+  formatCellFormatter,
+  reportToShowFormatter,
+  hostReportsToShowFormatter,
+  statusFormatter,
+} from './Components/Formatters';
+
+const sortControllerFactory = (apiCall, sortBy, sortOrder) => ({
+  apply: (by, order) => {
+    apiCall({ sort: { by, order } });
+  },
+  property: sortBy,
+  order: sortOrder,
+});
+
+const createHostReportsTableSchema = (
+  apiCall,
+  by,
+  order,
+  onDeleteClick,
+  hostId
+) => {
+  const sortController = sortControllerFactory(apiCall, by, order);
+  const hostColumn = hostId
+    ? []
+    : [
+        sortableColumn('hostName', __('Host'), 3, sortController, [
+          hostReportsToShowFormatter(),
+        ]),
+      ];
+
+  return hostColumn.concat([
+    sortableColumn('reportedAt', __('Last report'), 1, sortController, [
+      reportToShowFormatter(),
+    ]),
+    sortableColumn('format', __('Format'), 1, sortController, [
+      formatCellFormatter(),
+    ]),
+    column(
+      'status',
+      __('Overall status'),
+      [headerFormatterWithProps],
+      [statusFormatter()],
+      { className: `col-lg-auto` }
+    ),
+    column(
+      'actions',
+      __('Actions'),
+      [headerFormatterWithProps],
+      [deleteActionCellFormatter(onDeleteClick), cellFormatter],
+      { className: `col-md-1` }
+    ),
+  ]);
+};
+
+export default createHostReportsTableSchema;

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/index.js

@@ -0,0 +1,28 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+
+import { useForemanModal } from 'foremanReact/components/ForemanModal/ForemanModalHooks';
+
+import HostReportsTable from './HostReportsTable';
+import { HOST_REPORT_DELETE_MODAL_ID } from '../../constants';
+
+const WrappedHostReportsTable = props => {
+  const { setModalOpen: setDeleteModalOpen } = useForemanModal({
+    id: HOST_REPORT_DELETE_MODAL_ID,
+  });
+
+  const { setToDelete, ...rest } = props;
+
+  const onDeleteClick = rowData => {
+    setToDelete(rowData);
+    setDeleteModalOpen();
+  };
+
+  return <HostReportsTable onDeleteClick={onDeleteClick} {...rest} />;
+};
+
+WrappedHostReportsTable.propTypes = {
+  setToDelete: PropTypes.func.isRequired,
+};
+
+export default WrappedHostReportsTable;

data/webpack/src/Router/HostReports/IndexPage/IndexPage.js

@@ -0,0 +1,88 @@
+import React, { useState } from 'react';
+import PropTypes from 'prop-types';
+
+import PageLayout from 'foremanReact/routes/common/PageLayout/PageLayout';
+import ExportButton from 'foremanReact/routes/common/PageLayout/components/ExportButton/ExportButton';
+import { translate as __ } from 'foremanReact/common/I18n';
+import { getURIQuery } from 'foremanReact/common/helpers';
+
+import {
+  HOST_REPORTS_SEARCH_PROPS,
+  HOST_REPORTS_API_PLAIN_PATH,
+} from './constants';
+
+import HostReportsTable from './Components/HostReportsTable';
+
+import { getExportUrl } from './IndexPageHelpers';
+
+const HostReportsIndexPage = ({
+  fetchAndPush,
+  search,
+  isLoading,
+  hasData,
+  reports,
+  page,
+  perPage,
+  sort,
+  itemCount,
+  reloadWithSearch,
+  history,
+  hostId,
+}) => {
+  const [toDelete, setToDelete] = useState({});
+
+  const url = HOST_REPORTS_API_PLAIN_PATH + history.location.search;
+  const uriQuery = getURIQuery(url);
+  const exportBtn = (
+    <ExportButton url={getExportUrl(url, uriQuery)} title={__('Export')} />
+  );
+
+  return (
+    <PageLayout
+      header={__('Host Reports')}
+      searchable={!isLoading}
+      searchProps={HOST_REPORTS_SEARCH_PROPS}
+      searchQuery={search}
+      isLoading={isLoading && hasData}
+      onSearch={reloadWithSearch}
+      onBookmarkClick={reloadWithSearch}
+      toolbarButtons={exportBtn}
+    >
+      <HostReportsTable
+        results={reports}
+        fetchAndPush={fetchAndPush}
+        pagination={{ page, perPage }}
+        itemCount={itemCount}
+        sort={sort}
+        toDelete={toDelete}
+        setToDelete={setToDelete}
+        reloadWithSearch={reloadWithSearch}
+        hostId={hostId}
+      />
+    </PageLayout>
+  );
+};
+
+HostReportsIndexPage.propTypes = {
+  fetchAndPush: PropTypes.func.isRequired,
+  search: PropTypes.string,
+  isLoading: PropTypes.bool.isRequired,
+  hasData: PropTypes.bool.isRequired,
+  reports: PropTypes.array.isRequired,
+  page: PropTypes.number,
+  perPage: PropTypes.number,
+  sort: PropTypes.object.isRequired,
+  itemCount: PropTypes.number.isRequired,
+  reloadWithSearch: PropTypes.func.isRequired,
+  history: PropTypes.object.isRequired,
+  hostId: PropTypes.string,
+};
+
+HostReportsIndexPage.defaultProps = {
+  page: null,
+  perPage: null,
+  search: '',
+  hostId: null,
+};
+
+export default HostReportsIndexPage;