foreman_rh_cloud 14.7.0 → 15.0.0

data/webpack/ComplianceHostDetailsTab/__tests__/ComplianceHostDetailsTab.test.js

@@ -0,0 +1,159 @@
+import React from 'react';
+import { fireEvent, render } from '@testing-library/react';
+import { MemoryRouter } from 'react-router-dom';
+import ComplianceHostDetailsTabWrapper from '../ComplianceHostDetailsTab';
+import { OVERVIEW_TAB_PATH } from '../../ForemanRhCloudHelpers';
+
+const mockHistoryReplace = jest.fn();
+
+jest.mock('react-router-dom', () => ({
+  ...jest.requireActual('react-router-dom'),
+  useHistory: () => ({
+    replace: mockHistoryReplace,
+  }),
+}));
+
+jest.mock('foremanReact/Root/Context/ForemanContext', () => ({
+  useForemanContext: () => ({
+    metadata: {
+      permissions: new Set(['view_hosts']),
+    },
+  }),
+  useForemanPermissions: () => new Set(['view_hosts']),
+}));
+
+jest.mock('foremanReact/common/I18n', () => ({
+  translate: str => str,
+  sprintf: str => str,
+}));
+
+jest.mock('../../InsightsCompliance/complianceIframeHelpers', () => ({
+  getComplianceIframeSrc: () =>
+    'https://example.test/assets/apps/compliance/index.html',
+}));
+
+const mockPostChrome = jest.fn();
+jest.mock('../../common/IopIframe/postIopChromeToIframe', () => ({
+  postIopChromeToIframe: (...args) => mockPostChrome(...args),
+}));
+
+const defaultResponse = {
+  id: 1,
+  operatingsystem_name: 'Red Hat Enterprise Linux 8',
+  insights_attributes: { uuid: 'insights-1' },
+  subscription_facet_attributes: { uuid: '1-2-3' },
+};
+
+describe('ComplianceHostDetailsTabWrapper', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('renders compliance iframe for a valid host without redirecting', () => {
+    const { getByTestId, container } = render(
+      <MemoryRouter>
+        <ComplianceHostDetailsTabWrapper response={defaultResponse} />
+      </MemoryRouter>
+    );
+
+    expect(
+      container.querySelector(
+        '.rh-cloud-insights-compliance-host-details-component'
+      )
+    ).toBeTruthy();
+
+    const iframe = getByTestId('compliance-host-details-iframe');
+    expect(iframe.getAttribute('src')).toBe(
+      'https://example.test/assets/apps/compliance/index.html'
+    );
+    expect(mockHistoryReplace).not.toHaveBeenCalled();
+  });
+
+  it('posts systems/<uuid> appRoute for the host-tab iframe', () => {
+    const { getByTestId } = render(
+      <MemoryRouter>
+        <ComplianceHostDetailsTabWrapper response={defaultResponse} />
+      </MemoryRouter>
+    );
+
+    fireEvent.load(getByTestId('compliance-host-details-iframe'));
+
+    expect(mockPostChrome).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.objectContaining({
+        appRoute: 'systems/1-2-3',
+        embedded: 'host-tab',
+      })
+    );
+  });
+
+  it('posts updated appRoute when inventoryId changes', () => {
+    const responseHostA = {
+      ...defaultResponse,
+      subscription_facet_attributes: { uuid: 'uuid-host-A' },
+    };
+
+    const { rerender, getByTestId } = render(
+      <MemoryRouter>
+        <ComplianceHostDetailsTabWrapper response={responseHostA} />
+      </MemoryRouter>
+    );
+
+    expect(getByTestId('compliance-host-details-iframe')).toBeTruthy();
+
+    const responseHostB = {
+      ...defaultResponse,
+      subscription_facet_attributes: { uuid: 'uuid-host-B' },
+    };
+
+    rerender(
+      <MemoryRouter>
+        <ComplianceHostDetailsTabWrapper response={responseHostB} />
+      </MemoryRouter>
+    );
+
+    fireEvent.load(getByTestId('compliance-host-details-iframe'));
+
+    expect(mockPostChrome).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.objectContaining({
+        appRoute: 'systems/uuid-host-B',
+        embedded: 'host-tab',
+      })
+    );
+  });
+
+  it('redirects to Overview when tab should be hidden', () => {
+    const nonRhelResponse = {
+      id: 2,
+      operatingsystem_name: 'Ubuntu 20.04',
+      insights_attributes: { uuid: 'insights-1' },
+      subscription_facet_attributes: { uuid: '1-2-3' },
+    };
+
+    const { container } = render(
+      <MemoryRouter>
+        <ComplianceHostDetailsTabWrapper response={nonRhelResponse} />
+      </MemoryRouter>
+    );
+
+    expect(mockHistoryReplace).toHaveBeenCalledWith(OVERVIEW_TAB_PATH);
+    expect(
+      container.querySelector(
+        '.rh-cloud-insights-compliance-host-details-component'
+      )
+    ).toBeNull();
+  });
+
+  it('does not redirect when host data is not yet loaded', () => {
+    const emptyResponse = { subscription_facet_attributes: { uuid: '1-2-3' } };
+
+    render(
+      <MemoryRouter>
+        <ComplianceHostDetailsTabWrapper response={emptyResponse} />
+      </MemoryRouter>
+    );
+
+    expect(mockHistoryReplace).not.toHaveBeenCalled();
+  });
+});

data/webpack/ComplianceHostDetailsTab/index.js

@@ -0,0 +1,3 @@
+import ComplianceHostDetailsTabWrapper from './ComplianceHostDetailsTab';
+
+export default ComplianceHostDetailsTabWrapper;

data/webpack/ForemanRhCloudFills.js

@@ -10,6 +10,7 @@ import {
   hasNoInsightsFacet,
 } from './ForemanRhCloudHelpers';
 import CVEsHostDetailsTabWrapper from './CVEsHostDetailsTab/CVEsHostDetailsTab';
+import ComplianceHostDetailsTabWrapper from './ComplianceHostDetailsTab/ComplianceHostDetailsTab';
 import InsightsVulnerabilityActionsBar from './InsightsVulnerabilityActionsBar';
 
 const fills = [
@@ -51,6 +52,16 @@ const fills = [
       title: __('Vulnerabilities'),
     },
   },
+  {
+    slot: 'host-details-page-tabs',
+    name: 'Compliance',
+    component: props => <ComplianceHostDetailsTabWrapper {...props} />,
+    weight: 350,
+    metadata: {
+      hideTab: props => isNotRhelHost(props) || hasNoInsightsFacet(props),
+      title: __('Compliance'),
+    },
+  },
 ];
 
 export const registerFills = () => {

data/webpack/ForemanRhCloudPages.js

@@ -8,6 +8,7 @@ import IopRecommendationDetails from './IopRecommendationDetails/IopRecommendati
 import IopPathwayDetails from './IopPathwayDetails/IopPathwayDetails';
 import InsightsHostDetailsTab from './InsightsHostDetailsTab';
 import CveDetailsPage from './CveDetailsPage';
+import InsightsCompliancePage from './InsightsCompliance/InsightsCompliancePage';
 import './common/styles.scss';
 
 const pages = [
@@ -20,6 +21,7 @@ const pages = [
     type: InsightsVulnerabilityListPage,
   },
   { name: 'CveDetailsPage', type: CveDetailsPage },
+  { name: 'InsightsCompliancePage', type: InsightsCompliancePage },
 ];
 
 export const registerPages = () => {
@@ -57,6 +59,11 @@ export const routes = [
     exact: true,
     render: props => <CveDetailsPage {...props} />,
   },
+  {
+    path: '/foreman_rh_cloud/insights_compliance',
+    exact: false,
+    render: props => <InsightsCompliancePage {...props} />,
+  },
 ];
 
 export const registerRoutes = () => {

data/webpack/InsightsCompliance/ComplianceIframe.js

@@ -0,0 +1,34 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import IopAppIframe from '../common/IopIframe/IopAppIframe';
+import {
+  getComplianceAppRoute,
+  getComplianceForemanPath,
+  getComplianceIframeSrc,
+} from './complianceIframeHelpers';
+import {
+  IOP_COMPLIANCE_NAVIGATE,
+  IOP_COMPLIANCE_READY,
+} from './complianceIframeConstants';
+
+import './ComplianceIframe.scss';
+
+const ComplianceIframe = ({ appName }) => (
+  <IopAppIframe
+    appName={appName}
+    iframeSrc={getComplianceIframeSrc()}
+    getAppRoute={getComplianceAppRoute}
+    getForemanPath={getComplianceForemanPath}
+    defaultAppRoute="reports"
+    readyMessageType={IOP_COMPLIANCE_READY}
+    navigateMessageType={IOP_COMPLIANCE_NAVIGATE}
+    className="rh-cloud-insights-compliance-iframe"
+    testId="compliance-iframe"
+  />
+);
+
+ComplianceIframe.propTypes = {
+  appName: PropTypes.string.isRequired,
+};
+
+export default ComplianceIframe;

data/webpack/InsightsCompliance/ComplianceIframe.scss

@@ -0,0 +1,12 @@
+.rh-cloud-insights-compliance-page {
+  display: flex;
+  flex-direction: column;
+  min-height: calc(100vh - var(--pf-v5-global--spacer--2xl, 3rem));
+}
+
+.rh-cloud-insights-compliance-iframe {
+  border: 0;
+  flex: 1 1 auto;
+  min-height: 70vh;
+  width: 100%;
+}

data/webpack/InsightsCompliance/InsightsCompliancePage.js

@@ -0,0 +1,11 @@
+import React from 'react';
+
+import ComplianceIframe from './ComplianceIframe';
+
+const InsightsCompliancePage = () => (
+  <div className="rh-cloud-insights-compliance-page compliance">
+    <ComplianceIframe appName="Compliance" />
+  </div>
+);
+
+export default InsightsCompliancePage;

data/webpack/InsightsCompliance/InsightsCompliancePage.test.js

@@ -0,0 +1,35 @@
+import React from 'react';
+import { render, screen } from '@testing-library/react';
+import '@testing-library/jest-dom';
+import { MemoryRouter } from 'react-router-dom';
+
+import InsightsCompliancePage from './InsightsCompliancePage';
+
+jest.mock('foremanReact/Root/Context/ForemanContext', () => ({
+  useForemanContext: () => ({
+    metadata: {
+      permissions: new Set(['view_compliance']),
+    },
+  }),
+  useForemanPermissions: () => new Set(['view_compliance']),
+}));
+
+describe('InsightsCompliancePage', () => {
+  it('renders the compliance iframe container', () => {
+    render(
+      <MemoryRouter
+        initialEntries={['/foreman_rh_cloud/insights_compliance/reports']}
+      >
+        <InsightsCompliancePage />
+      </MemoryRouter>
+    );
+
+    expect(
+      document.querySelector('.rh-cloud-insights-compliance-page')
+    ).toBeTruthy();
+    expect(screen.getByTestId('compliance-iframe')).toHaveAttribute(
+      'src',
+      `${window.location.origin}/assets/apps/compliance/index.html`
+    );
+  });
+});

data/webpack/InsightsCompliance/complianceIframeConstants.js

@@ -0,0 +1,7 @@
+export const COMPLIANCE_STATIC_APP_PATH = '/assets/apps/compliance/index.html';
+
+export const IOP_COMPLIANCE_READY = 'IOP_COMPLIANCE_READY';
+
+export const IOP_COMPLIANCE_NAVIGATE = 'IOP_COMPLIANCE_NAVIGATE';
+
+export const COMPLIANCE_ROUTE_PREFIX = '/foreman_rh_cloud/insights_compliance';

data/webpack/InsightsCompliance/complianceIframeHelpers.js

@@ -0,0 +1,23 @@
+import {
+  COMPLIANCE_ROUTE_PREFIX,
+  COMPLIANCE_STATIC_APP_PATH,
+} from './complianceIframeConstants';
+import {
+  getIopAppRoute,
+  getIopForemanPath,
+  getIopIframeSrc,
+} from '../common/IopIframe/iopIframeHelpers';
+
+const COMPLIANCE_IOP_PATH = {
+  routePrefix: COMPLIANCE_ROUTE_PREFIX,
+  fallbackRoute: 'reports',
+};
+
+export const getComplianceForemanPath = (appRoute = 'reports') =>
+  getIopForemanPath(appRoute, COMPLIANCE_IOP_PATH);
+
+export const getComplianceAppRoute = (pathname = '') =>
+  getIopAppRoute(pathname, COMPLIANCE_IOP_PATH);
+
+export const getComplianceIframeSrc = () =>
+  getIopIframeSrc(COMPLIANCE_STATIC_APP_PATH);

data/webpack/InsightsCompliance/complianceIframeHelpers.test.js

@@ -0,0 +1,50 @@
+import {
+  getComplianceAppRoute,
+  getComplianceForemanPath,
+  getComplianceIframeSrc,
+} from './complianceIframeHelpers';
+
+describe('complianceIframeHelpers', () => {
+  describe('getComplianceAppRoute', () => {
+    it('maps foreman compliance paths to app routes', () => {
+      expect(
+        getComplianceAppRoute('/foreman_rh_cloud/insights_compliance/reports')
+      ).toBe('reports');
+      expect(
+        getComplianceAppRoute(
+          '/foreman_rh_cloud/insights_compliance/reports/report-1'
+        )
+      ).toBe('reports/report-1');
+      expect(
+        getComplianceAppRoute(
+          '/foreman_rh_cloud/insights_compliance/scappolicies/new'
+        )
+      ).toBe('scappolicies/new');
+    });
+
+    it('defaults to reports for unknown paths', () => {
+      expect(getComplianceAppRoute('/foreman_rh_cloud/insights_cloud')).toBe(
+        'reports'
+      );
+    });
+  });
+
+  describe('getComplianceForemanPath', () => {
+    it('maps app routes to foreman compliance paths', () => {
+      expect(getComplianceForemanPath('reports')).toBe(
+        '/foreman_rh_cloud/insights_compliance/reports'
+      );
+      expect(getComplianceForemanPath('scappolicies/new')).toBe(
+        '/foreman_rh_cloud/insights_compliance/scappolicies/new'
+      );
+    });
+  });
+
+  describe('getComplianceIframeSrc', () => {
+    it('returns the static compliance app entry', () => {
+      expect(getComplianceIframeSrc()).toBe(
+        `${window.location.origin}/assets/apps/compliance/index.html`
+      );
+    });
+  });
+});

data/webpack/common/Hooks/PermissionsHooks.js

@@ -25,6 +25,16 @@ const PERMISSION_MAPPING = {
   ],
   view_advisor: ['advisor:recommendation-results:read', 'advisor:exports:read'],
   edit_advisor: ['advisor:disable-recommendations:write'],
+  view_compliance: [
+    'inventory:hosts:read',
+    'compliance:report:read',
+    'compliance:policy:read',
+  ],
+  edit_compliance: [
+    'compliance:policy:write',
+    'compliance:policy:create',
+    'compliance:policy:delete',
+  ],
 };
 
 /**

data/webpack/common/IopIframe/IopAppIframe.js

@@ -0,0 +1,74 @@
+import React, { useRef } from 'react';
+import PropTypes from 'prop-types';
+import { useHistory, useLocation } from 'react-router-dom';
+import { useInsightsPermissions } from '../Hooks/PermissionsHooks';
+import { useIopIframeChrome } from './useIopIframeChrome';
+import { useIopIframeNavigate } from './useIopIframeNavigate';
+
+/**
+ * Full-page IoP app iframe: chrome sync + Foreman URL updates from NAVIGATE.
+ * App shells supply src, route mappers, and message types.
+ */
+const IopAppIframe = ({
+  appName,
+  iframeSrc,
+  getAppRoute,
+  getForemanPath,
+  defaultAppRoute,
+  readyMessageType,
+  navigateMessageType,
+  className = '',
+  testId = 'iop-app-iframe',
+}) => {
+  const iframeRef = useRef(null);
+  const history = useHistory();
+  const { pathname } = useLocation();
+  const permissions = useInsightsPermissions();
+  const appRoute = getAppRoute(pathname);
+
+  const sendChromeContext = useIopIframeChrome({
+    iframeRef,
+    permissions,
+    appRoute,
+    pathname,
+    readyMessageType,
+  });
+
+  useIopIframeNavigate({
+    history,
+    navigateMessageType,
+    getForemanPath,
+    defaultAppRoute,
+  });
+
+  return (
+    // eslint-disable-next-line jsx-a11y/iframe-has-title
+    <iframe
+      ref={iframeRef}
+      className={className}
+      data-testid={testId}
+      src={iframeSrc}
+      aria-label={appName}
+      onLoad={sendChromeContext}
+    />
+  );
+};
+
+IopAppIframe.propTypes = {
+  appName: PropTypes.string.isRequired,
+  iframeSrc: PropTypes.string.isRequired,
+  getAppRoute: PropTypes.func.isRequired,
+  getForemanPath: PropTypes.func.isRequired,
+  defaultAppRoute: PropTypes.string.isRequired,
+  readyMessageType: PropTypes.string.isRequired,
+  navigateMessageType: PropTypes.string.isRequired,
+  className: PropTypes.string,
+  testId: PropTypes.string,
+};
+
+IopAppIframe.defaultProps = {
+  className: '',
+  testId: 'iop-app-iframe',
+};
+
+export default IopAppIframe;

data/webpack/common/IopIframe/IopHostDetailsIframe.js

@@ -0,0 +1,66 @@
+import React, { useRef } from 'react';
+import PropTypes from 'prop-types';
+import { useInsightsPermissions } from '../Hooks/PermissionsHooks';
+import { useIopIframeChrome } from './useIopIframeChrome';
+import { useIopIframeHeight } from './useIopIframeHeight';
+import './IopHostDetailsIframe.scss';
+
+/**
+ * Host-details tab iframe for an IoP app (chrome post + READY re-sync).
+ * App-specific wrappers supply src, appRoute, title, and styles.
+ */
+const IopHostDetailsIframe = ({
+  inventoryId,
+  iframeSrc,
+  appRoute,
+  title,
+  readyMessageType,
+  className = '',
+  iframeClassName = 'rh-cloud-iop-host-details-iframe',
+  testId = 'iop-host-details-iframe',
+}) => {
+  const iframeRef = useRef(null);
+  const permissions = useInsightsPermissions();
+  const sendChromeContext = useIopIframeChrome({
+    iframeRef,
+    permissions,
+    appRoute,
+    embedded: 'host-tab',
+    readyMessageType,
+  });
+  useIopIframeHeight({ iframeRef });
+
+  return (
+    <div className={className}>
+      <iframe
+        key={inventoryId}
+        ref={iframeRef}
+        className={iframeClassName}
+        data-testid={testId}
+        src={iframeSrc}
+        title={title}
+        aria-label={title}
+        onLoad={sendChromeContext}
+      />
+    </div>
+  );
+};
+
+IopHostDetailsIframe.propTypes = {
+  inventoryId: PropTypes.string.isRequired,
+  iframeSrc: PropTypes.string.isRequired,
+  appRoute: PropTypes.string.isRequired,
+  title: PropTypes.string.isRequired,
+  readyMessageType: PropTypes.string.isRequired,
+  className: PropTypes.string,
+  iframeClassName: PropTypes.string,
+  testId: PropTypes.string,
+};
+
+IopHostDetailsIframe.defaultProps = {
+  className: '',
+  iframeClassName: 'rh-cloud-iop-host-details-iframe',
+  testId: 'iop-host-details-iframe',
+};
+
+export default IopHostDetailsIframe;

data/webpack/common/IopIframe/IopHostDetailsIframe.scss

@@ -0,0 +1,6 @@
+.rh-cloud-iop-host-details-iframe {
+  border: 0;
+  display: block;
+  width: 100%;
+  min-height: 70vh;
+}

data/webpack/common/IopIframe/IopHostDetailsIframeTab.js

@@ -0,0 +1,81 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import {
+  isNotRhelHost,
+  hasNoInsightsFacet,
+  useTabRedirect,
+} from '../../ForemanRhCloudHelpers';
+import IopHostDetailsIframe from './IopHostDetailsIframe';
+
+/**
+ * Host-details fill wrapper: hide/redirect for non-RHEL / no Insights facet,
+ * then render an IoP app iframe for the subscription UUID.
+ */
+const IopHostDetailsIframeTab = ({
+  response = {},
+  iframeSrc,
+  buildAppRoute,
+  title,
+  readyMessageType,
+  className = '',
+  iframeClassName = 'rh-cloud-iop-host-details-iframe',
+  testId = 'iop-host-details-iframe',
+}) => {
+  const isHostDataLoaded = Boolean(response?.id);
+  const shouldHideTab = useTabRedirect(
+    isHostDataLoaded &&
+      (isNotRhelHost({ hostDetails: response }) ||
+        hasNoInsightsFacet({ response, hostDetails: response }))
+  );
+
+  if (shouldHideTab) {
+    return null;
+  }
+
+  // eslint-disable-next-line camelcase
+  const inventoryId = response?.subscription_facet_attributes?.uuid;
+
+  if (!inventoryId) {
+    return null;
+  }
+
+  return (
+    <IopHostDetailsIframe
+      inventoryId={inventoryId}
+      iframeSrc={iframeSrc}
+      appRoute={buildAppRoute(inventoryId)}
+      title={title}
+      readyMessageType={readyMessageType}
+      className={className}
+      iframeClassName={iframeClassName}
+      testId={testId}
+    />
+  );
+};
+
+IopHostDetailsIframeTab.propTypes = {
+  response: PropTypes.shape({
+    id: PropTypes.number,
+    operatingsystem_name: PropTypes.string,
+    insights_attributes: PropTypes.object,
+    subscription_facet_attributes: PropTypes.shape({
+      uuid: PropTypes.string,
+    }),
+  }),
+  iframeSrc: PropTypes.string.isRequired,
+  buildAppRoute: PropTypes.func.isRequired,
+  title: PropTypes.string.isRequired,
+  readyMessageType: PropTypes.string.isRequired,
+  className: PropTypes.string,
+  iframeClassName: PropTypes.string,
+  testId: PropTypes.string,
+};
+
+IopHostDetailsIframeTab.defaultProps = {
+  response: {},
+  className: '',
+  iframeClassName: 'rh-cloud-iop-host-details-iframe',
+  testId: 'iop-host-details-iframe',
+};
+
+export default IopHostDetailsIframeTab;