foreman_host_reports 0.0.3

data/webpack/src/Router/HostReports/ShowPage/Components/ReportLogsFilter/index.js

@@ -0,0 +1,109 @@
+import React, { useState, useEffect, useCallback } from 'react';
+import PropTypes from 'prop-types';
+
+import { sprintf, translate as __ } from 'foremanReact/common/I18n';
+
+import { ContextSelector, ContextSelectorItem } from '@patternfly/react-core';
+
+import ReportLogs from '../ReportLogs';
+
+const ReportLogsFilter = ({ format, reportedAt, meta }) => {
+  const reportedAtLocal = new Date(reportedAt);
+  const { logs } = meta;
+  const filterItems = [
+    { text: __('All messages'), accepts: [] },
+    {
+      text: __('Notices, warnings and errors'),
+      accepts: ['notice', 'warning', 'err'],
+    },
+    { text: __('Warnings and errors'), accepts: ['warning', 'err'] },
+    { text: __('Errors only'), accepts: ['err'] },
+  ];
+  const [currentItem, setCurrentItem] = useState(filterItems[0]);
+  const [currentFilterItems, setCurrentFilterItems] = useState(filterItems);
+  const [searchValue, setSearchValue] = useState('');
+  const [isOpen, setIsOpen] = useState(false);
+  const [filteredLogs, setFilteredLogs] = useState(logs);
+
+  /* eslint-disable react-hooks/exhaustive-deps */
+  const onSearchButtonClick = useCallback(() => {
+    const filtered =
+      searchValue === ''
+        ? filterItems
+        : filterItems.filter(item =>
+            item.text.toLowerCase().includes(searchValue.toLowerCase())
+          );
+    setCurrentFilterItems(filtered || []);
+  }, [searchValue]);
+  /* eslint-enable react-hooks/exhaustive-deps */
+
+  useEffect(() => {
+    onSearchButtonClick();
+  }, [searchValue, onSearchButtonClick]);
+
+  const onToggle = (event, newIsOpen) => {
+    setIsOpen(newIsOpen);
+  };
+  const onSelect = () => {
+    setIsOpen(!isOpen);
+  };
+  const onSearchInputChange = (value, event) => {
+    setSearchValue(event.target.value);
+  };
+  const filterLogs = (toFilter, accepts) => {
+    if (!accepts.length) return toFilter;
+
+    return toFilter.filter(log => accepts.includes(log[0] || log.level));
+  };
+
+  useEffect(() => {
+    setFilteredLogs(filterLogs(logs, currentItem.accepts));
+  }, [logs, currentItem]);
+
+  return (
+    <>
+      <span>{__('Show log messages:')}</span>
+      <br />
+      <ContextSelector
+        id="report-logs-filter"
+        toggleText={currentItem.text}
+        onSearchInputChange={onSearchInputChange}
+        isOpen={isOpen}
+        searchInputValue={searchValue}
+        onToggle={onToggle}
+        onSelect={onSelect}
+        onSearchButtonClick={onSearchButtonClick}
+        screenReaderLabel="Selected Messages:"
+      >
+        {currentFilterItems.map((item, i) => (
+          <ContextSelectorItem
+            key={i + 1}
+            id={`select_messages_${i}`}
+            onClick={() => {
+              setCurrentItem(item);
+            }}
+            isDisabled={item.text === currentItem.text}
+          >
+            {item.text}
+          </ContextSelectorItem>
+        ))}
+      </ContextSelector>
+      <p className="ra">
+        {sprintf(__('Reported at %s'), reportedAtLocal.toLocaleString())}
+      </p>
+      <ReportLogs format={format} logs={filteredLogs} meta={meta} />
+    </>
+  );
+};
+
+ReportLogsFilter.propTypes = {
+  format: PropTypes.string.isRequired,
+  reportedAt: PropTypes.string.isRequired,
+  meta: PropTypes.object,
+};
+
+ReportLogsFilter.defaultProps = {
+  meta: {},
+};
+
+export default ReportLogsFilter;

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

@@ -0,0 +1,160 @@
+import React from 'react';
+import JSONTree from 'react-json-tree';
+import PropTypes from 'prop-types';
+import { Button, Grid, GridItem } from '@patternfly/react-core';
+
+import PageLayout from 'foremanReact/routes/common/PageLayout/PageLayout';
+import { translate as __ } from 'foremanReact/common/I18n';
+import { foremanUrl } from 'foremanReact/common/helpers';
+import { useForemanModal } from 'foremanReact/components/ForemanModal/ForemanModalHooks';
+
+import HostReportDeleteModal from '../Components/HostReportDeleteModal';
+import ReportLogsFilter from './Components/ReportLogsFilter';
+import HostReportMetrics from './Components/HostReportMetrics';
+
+import {
+  HOSTS_PATH,
+  HOST_REPORTS_PATH,
+  HOST_REPORT_DELETE_MODAL_ID,
+} from '../constants';
+
+const HostReportsShowPage = ({
+  id,
+  body,
+  format,
+  host,
+  reportedAt,
+  permissions,
+  isLoading,
+  fetchAndPush,
+}) => {
+  const {
+    setModalOpen: setDeleteModalOpen,
+    setModalClosed: setDeleteModalClosed,
+  } = useForemanModal({
+    id: HOST_REPORT_DELETE_MODAL_ID,
+  });
+
+  const buttons = [];
+
+  if (permissions.canDelete) {
+    buttons.push(
+      <Button
+        key={`host-report-delete-button-${id}`}
+        variant="danger"
+        isSmall
+        onClick={() => setDeleteModalOpen()}
+      >
+        {__('Delete')}
+      </Button>
+    );
+  }
+  buttons.push(
+    <Button
+      key={`host-report-host-button-${id}`}
+      variant="link"
+      component="a"
+      target="_blank"
+      href={foremanUrl(`${HOSTS_PATH}/${host.id}`)}
+      isSmall
+    >
+      {__('Host details')}
+    </Button>
+  );
+  buttons.push(
+    <Button
+      key={`host-report-other-button-${id}`}
+      variant="link"
+      component="a"
+      target="_blank"
+      href={foremanUrl(`${HOSTS_PATH}/${host.id}${HOST_REPORTS_PATH}`)}
+      isSmall
+    >
+      {__('Other reports for this host')}
+    </Button>
+  );
+
+  const meta = {};
+  switch (format) {
+    case 'puppet':
+      meta.environment = body.environment;
+      meta.logs = body.logs;
+      break;
+    case 'ansible':
+      meta.checkMode = body.checkMode;
+      meta.logs = body.results;
+      break;
+    default:
+      break;
+  }
+
+  const theme = {
+    scheme: 'foreman',
+    backgroundColor: 'rgba(0, 0, 0, 255)',
+    base00: 'rgba(0, 0, 0, 0)',
+  };
+
+  return (
+    <React.Fragment>
+      <HostReportDeleteModal
+        toDelete={{ id, hostName: host.name }}
+        onSuccess={() => {
+          setDeleteModalClosed();
+          fetchAndPush({ page: 1 });
+        }}
+      />
+      <PageLayout
+        header={host.name}
+        searchable={false}
+        isLoading={isLoading}
+        breadcrumbOptions={{
+          isSwitchable: false,
+          breadcrumbItems: [
+            { caption: __('Host Reports'), url: foremanUrl(HOST_REPORTS_PATH) },
+            {
+              caption: host.name,
+              url: foremanUrl(`${HOST_REPORTS_PATH}/${id}`),
+            },
+          ],
+        }}
+        toolbarButtons={buttons}
+      >
+        {format === 'plain' ? (
+          <JSONTree data={body} hideRoot theme={theme} />
+        ) : (
+          <Grid hasGutter>
+            <GridItem>
+              <ReportLogsFilter
+                format={format}
+                reportedAt={reportedAt}
+                meta={meta}
+              />
+            </GridItem>
+            {format === 'puppet' ? (
+              <GridItem>
+                <HostReportMetrics metrics={body.metrics} />
+              </GridItem>
+            ) : null}
+          </Grid>
+        )}
+      </PageLayout>
+    </React.Fragment>
+  );
+};
+
+HostReportsShowPage.propTypes = {
+  id: PropTypes.number.isRequired,
+  body: PropTypes.object.isRequired,
+  format: PropTypes.string.isRequired,
+  host: PropTypes.object.isRequired,
+  reportedAt: PropTypes.string.isRequired,
+  permissions: PropTypes.object.isRequired,
+  fetchAndPush: PropTypes.func.isRequired,
+  isLoading: PropTypes.bool,
+};
+
+HostReportsShowPage.defaultProps = {
+  isLoading: true,
+};
+
+export default HostReportsShowPage;

data/webpack/src/Router/HostReports/ShowPage/ShowPageSelectors.js

@@ -0,0 +1,51 @@
+import { STATUS } from 'foremanReact/constants';
+import { deepPropsToCamelCase } from 'foremanReact/common/helpers';
+import {
+  selectAPIStatus,
+  selectAPIResponse,
+  selectAPIErrorMessage,
+} from 'foremanReact/redux/API/APISelectors';
+
+import { HOST_REPORT_REQUEST_KEY } from '../constants';
+
+const selectHostReportResponse = state => {
+  const response = deepPropsToCamelCase(
+    selectAPIResponse(state, HOST_REPORT_REQUEST_KEY)
+  );
+  return response;
+};
+
+export const selectIsLoading = state => {
+  const status = selectHostReportPageStatus(state);
+  return !status || status === STATUS.PENDING;
+};
+
+const selectHostReportPageStatus = state =>
+  selectAPIStatus(state, HOST_REPORT_REQUEST_KEY);
+
+export const selectHasError = state =>
+  selectHostReportPageStatus(state) === STATUS.ERROR;
+
+export const selectHostReport = state => {
+  if (selectHasError(state)) {
+    return [];
+  }
+  return selectHostReportResponse(state).hostReport;
+};
+
+export const selectSearch = state => selectHostReportResponse(state).search;
+
+export const selectPermissions = state =>
+  selectHostReportResponse(state).permissions || {};
+
+export const selectErrorMessage = state => {
+  if (!selectHasError(state)) return { message: '', details: '' };
+  const error = selectHostReportResponse(state).response?.data?.error;
+
+  if (error) return error;
+
+  return {
+    message: selectAPIErrorMessage(state, HOST_REPORT_REQUEST_KEY),
+    details: '',
+  };
+};

data/webpack/src/Router/HostReports/ShowPage/index.js

@@ -0,0 +1,75 @@
+import React, { useEffect } from 'react';
+import PropTypes from 'prop-types';
+import { useSelector, useDispatch } from 'react-redux';
+
+import { get } from 'foremanReact/redux/API';
+import { foremanUrl } from 'foremanReact/common/helpers';
+
+import Loading from 'foremanReact/components/Loading';
+import DefaultEmptyState from 'foremanReact/components/common/EmptyState';
+
+import HostReportsShowPage from './ShowPage';
+
+import { HOST_REPORT_REQUEST_KEY, HOST_REPORTS_PATH } from '../constants';
+import {
+  selectHostReport,
+  selectIsLoading,
+  selectHasError,
+  selectErrorMessage,
+  selectPermissions,
+} from './ShowPageSelectors';
+
+import { fetchAndPush } from '../IndexPage/IndexPageActions';
+
+const ConnectedHostReportsShowPage = ({ match }) => {
+  const dispatch = useDispatch();
+
+  const report = useSelector(selectHostReport);
+  const isLoading = useSelector(selectIsLoading);
+  const hasError = useSelector(selectHasError);
+  const error = useSelector(selectErrorMessage);
+  const permissions = useSelector(selectPermissions);
+
+  const { id } = match.params;
+
+  useEffect(() => {
+    dispatch(
+      get({
+        key: HOST_REPORT_REQUEST_KEY,
+        url: foremanUrl(`${HOST_REPORTS_PATH}/${id}`),
+      })
+    );
+  }, [dispatch, id]);
+
+  if (isLoading && !hasError) return <Loading />;
+
+  if (!isLoading && hasError) {
+    return (
+      <DefaultEmptyState
+        icon="error-circle-o"
+        header={error.message}
+        description={error.details || ''}
+        documentation={null}
+      />
+    );
+  }
+
+  return (
+    <HostReportsShowPage
+      id={report.id}
+      body={report.body}
+      format={report.format}
+      host={report.host}
+      reportedAt={report.reportedAt}
+      permissions={permissions}
+      isLoading={isLoading}
+      fetchAndPush={params => dispatch(fetchAndPush(params))}
+    />
+  );
+};
+
+ConnectedHostReportsShowPage.propTypes = {
+  match: PropTypes.object.isRequired,
+};
+
+export default ConnectedHostReportsShowPage;

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

@@ -0,0 +1,15 @@
+import { getControllerSearchProps } from 'foremanReact/constants';
+
+export const HOST_REPORTS_SEARCH_PROPS = getControllerSearchProps(
+  'host_reports'
+);
+export const HOSTS_PATH = '/hosts';
+export const HOST_REPORTS_PATH = '/host_reports';
+export const HOST_REPORTS_API_PATH =
+  '/api/v2/host_reports?include_permissions=true';
+export const HOST_REPORTS_API_PLAIN_PATH = '/api/v2/host_reports';
+
+export const HOST_REPORT_REQUEST_KEY = 'HOST_REPORT';
+export const HOST_REPORTS_API_REQUEST_KEY = 'HOST_REPORTS_API';
+
+export const HOST_REPORT_DELETE_MODAL_ID = 'hostReportDeleteModal';

data/webpack/src/Router/routes.js

@@ -0,0 +1,23 @@
+import React from 'react';
+import ConnectedHostReportsIndexPage from './HostReports/IndexPage';
+import ConnectedHostReportsShowPage from './HostReports/ShowPage';
+
+const ForemanHostReportsRoutes = [
+  {
+    path: '/host_reports',
+    exact: true,
+    render: props => <ConnectedHostReportsIndexPage {...props} />,
+  },
+  {
+    path: '/host_reports/:id([0-9]+)',
+    exact: true,
+    render: props => <ConnectedHostReportsShowPage {...props} />,
+  },
+  {
+    path: '/hosts/:hostId([0-9]+)/host_reports',
+    exact: true,
+    render: props => <ConnectedHostReportsIndexPage {...props} />,
+  },
+];
+
+export default ForemanHostReportsRoutes;

data/webpack/test_setup.js

@@ -0,0 +1,17 @@
+import 'core-js/shim';
+import 'regenerator-runtime/runtime';
+import MutationObserver from '@sheerun/mutationobserver-shim';
+
+import { configure } from 'enzyme';
+import Adapter from 'enzyme-adapter-react-16';
+
+configure({ adapter: new Adapter() });
+
+// Mocking translation function
+global.__ = text => text; // eslint-disable-line
+
+// Mocking locales to prevent unnecessary fallback messages
+window.locales = { en: { domain: 'app', locale_data: { app: { '': {} } } } };
+
+// see https://github.com/testing-library/dom-testing-library/releases/tag/v7.0.0
+window.MutationObserver = MutationObserver;

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: foreman_host_reports
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Lukas Zapletal
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fast and efficient reporting capabilities
+email:
+- lukas-x@zapletalovi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- app/controllers/api/v2/host_reports_controller.rb
+- app/controllers/concerns/foreman_host_reports/controller/parameters/host_report.rb
+- app/controllers/host_reports_controller.rb
+- app/models/concerns/foreman_host_reports/host_extensions.rb
+- app/models/concerns/foreman_host_reports/smart_proxy_extensions.rb
+- app/models/host_report.rb
+- app/models/report_keyword.rb
+- app/views/api/v2/host_reports/base.json.rabl
+- app/views/api/v2/host_reports/create.json.rabl
+- app/views/api/v2/host_reports/index.json.rabl
+- app/views/api/v2/host_reports/main.json.rabl
+- app/views/api/v2/host_reports/show.json.rabl
+- config/routes.rb
+- db/migrate/20210112183526_add_host_reports.rb
+- db/migrate/20210616133601_create_report_keywords.rb
+- lib/foreman_host_reports.rb
+- lib/foreman_host_reports/engine.rb
+- lib/foreman_host_reports/version.rb
+- lib/tasks/foreman_host_reports_tasks.rake
+- locale/Makefile
+- locale/en/foreman_host_reports.po
+- locale/foreman_host_reports.pot
+- locale/gemspec.rb
+- package.json
+- test/controllers/api/v2/host_reports_controller_test.rb
+- test/factories/foreman_host_reports_factories.rb
+- test/snapshots/foreman-web.json
+- test/test_plugin_helper.rb
+- test/unit/foreman_host_reports_test.rb
+- webpack/global_index.js
+- webpack/global_test_setup.js
+- webpack/index.js
+- webpack/src/Router/HostReports/Components/HostReportDeleteModal.js
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/FormatCell.js
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/FormatCell.scss
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/Formatters/formatCellFormatter.js
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/Formatters/hostReportsToShowFormatter.js
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/Formatters/index.js
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/Formatters/reportToShowFormatter.js
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/Formatters/statusFormatter.js
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/HostReportsToShowCell.js
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/ReportToShowCell.js
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/StatusCell.js
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/StatusCell.scss
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/formatImages.js
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/images/ansible.png
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/images/puppet.png
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/HostReportsTable.js
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/HostReportsTableSchema.js
+- webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/index.js
+- webpack/src/Router/HostReports/IndexPage/IndexPage.js
+- webpack/src/Router/HostReports/IndexPage/IndexPageActions.js
+- webpack/src/Router/HostReports/IndexPage/IndexPageHelpers.js
+- webpack/src/Router/HostReports/IndexPage/IndexPageSelectors.js
+- webpack/src/Router/HostReports/IndexPage/constants.js
+- webpack/src/Router/HostReports/IndexPage/index.js
+- webpack/src/Router/HostReports/ShowPage/Components/HostReportMetrics/HostReportMetrics.scss
+- webpack/src/Router/HostReports/ShowPage/Components/HostReportMetrics/index.js
+- webpack/src/Router/HostReports/ShowPage/Components/ReportLogs/Ansible.js
+- webpack/src/Router/HostReports/ShowPage/Components/ReportLogs/Puppet.js
+- webpack/src/Router/HostReports/ShowPage/Components/ReportLogs/helpers.js
+- webpack/src/Router/HostReports/ShowPage/Components/ReportLogs/index.js
+- webpack/src/Router/HostReports/ShowPage/Components/ReportLogsFilter/index.js
+- webpack/src/Router/HostReports/ShowPage/ShowPage.js
+- webpack/src/Router/HostReports/ShowPage/ShowPageSelectors.js
+- webpack/src/Router/HostReports/ShowPage/index.js
+- webpack/src/Router/HostReports/constants.js
+- webpack/src/Router/routes.js
+- webpack/test_setup.js
+homepage: https://github.com/theforeman/foreman_host_reports
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Foreman reporting engine
+test_files:
+- test/factories/foreman_host_reports_factories.rb
+- test/unit/foreman_host_reports_test.rb
+- test/controllers/api/v2/host_reports_controller_test.rb
+- test/snapshots/foreman-web.json
+- test/test_plugin_helper.rb