foreman_puppet 10.1.3 → 11.1.0

data/webpack/src/Extends/Hosts/BulkActions/BulkRemovePuppetEnvironment/BulkRemovePuppetEnvironmentModal.js

@@ -0,0 +1,148 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { FormattedMessage } from 'react-intl';
+import { useDispatch } from 'react-redux';
+import { Modal, Button, TextContent, Text } from '@patternfly/react-core';
+import { translate as __ } from 'foremanReact/common/I18n';
+import { addToast } from 'foremanReact/components/ToastsList/slice';
+import { useForemanOrganization } from 'foremanReact/Root/Context/ForemanContext';
+import { bulkActionErrorToastParams } from '../toastHelpers';
+import {
+  bulkChangePuppetEnvironment,
+  BULK_CHANGE_PUPPET_ENVIRONMENT_KEY,
+} from '../BulkChangePuppetEnvironment/actions';
+
+const BulkRemovePuppetEnvironmentModal = ({
+  isOpen,
+  closeModal,
+  selectAllHostsMode,
+  selectedCount,
+  fetchBulkParams,
+  onSuccess: onSuccessCallback,
+}) => {
+  const dispatch = useDispatch();
+  const currentOrganization = useForemanOrganization();
+
+  const handleModalClose = () => {
+    closeModal();
+  };
+
+  const handleError = response => {
+    handleModalClose();
+    dispatch(
+      addToast(
+        bulkActionErrorToastParams(
+          response,
+          __('Failed to remove Puppet Environment'),
+          BULK_CHANGE_PUPPET_ENVIRONMENT_KEY
+        )
+      )
+    );
+  };
+
+  const handleSuccess = response => {
+    dispatch(
+      addToast({
+        type: 'success',
+        message: response.data.message,
+      })
+    );
+    try {
+      if (onSuccessCallback) onSuccessCallback();
+    } finally {
+      handleModalClose();
+    }
+  };
+
+  const handleConfirm = () => {
+    const requestBody = {
+      included: {
+        search: fetchBulkParams(),
+      },
+      environment_id: null,
+      organization_id: currentOrganization?.id,
+    };
+
+    dispatch(
+      bulkChangePuppetEnvironment(requestBody, handleSuccess, handleError)
+    );
+  };
+
+  const modalActions = [
+    <Button
+      key="remove"
+      ouiaId="bulk-remove-puppet-environment-modal-remove-button"
+      variant="primary"
+      onClick={handleConfirm}
+    >
+      {__('Remove Puppet Environment')}
+    </Button>,
+    <Button
+      key="cancel"
+      ouiaId="bulk-remove-puppet-environment-modal-cancel-button"
+      variant="link"
+      onClick={handleModalClose}
+    >
+      {__('Cancel')}
+    </Button>,
+  ];
+
+  return (
+    <Modal
+      isOpen={isOpen}
+      onClose={handleModalClose}
+      onEscapePress={handleModalClose}
+      title={__('Remove Puppet Environment')}
+      width="50%"
+      position="top"
+      actions={modalActions}
+      id="bulk-remove-puppet-environment"
+      key="bulk-remove-puppet-environment"
+      ouiaId="bulk-remove-puppet-environment"
+    >
+      <TextContent>
+        <Text ouiaId="bulk-remove-puppet-environment-options">
+          {selectAllHostsMode ? (
+            <FormattedMessage
+              id="bulk-remove-puppet-environment-warning-message-all"
+              defaultMessage={__(
+                'Removing the Puppet environment will affect {boldCount} selected hosts.'
+              )}
+              values={{
+                boldCount: <strong>{__('All')}</strong>,
+              }}
+            />
+          ) : (
+            <FormattedMessage
+              id="bulk-remove-puppet-environment-warning-message"
+              defaultMessage={__(
+                'Removing the Puppet environment will affect {boldCount} selected {count, plural, one {host} other {hosts}}.'
+              )}
+              values={{
+                count: selectedCount,
+                boldCount: <strong>{selectedCount}</strong>,
+              }}
+            />
+          )}
+        </Text>
+      </TextContent>
+    </Modal>
+  );
+};
+
+BulkRemovePuppetEnvironmentModal.propTypes = {
+  isOpen: PropTypes.bool,
+  closeModal: PropTypes.func,
+  fetchBulkParams: PropTypes.func.isRequired,
+  onSuccess: PropTypes.func,
+  selectedCount: PropTypes.number.isRequired,
+  selectAllHostsMode: PropTypes.bool.isRequired,
+};
+
+BulkRemovePuppetEnvironmentModal.defaultProps = {
+  isOpen: false,
+  closeModal: () => {},
+  onSuccess: undefined,
+};
+
+export default BulkRemovePuppetEnvironmentModal;

data/webpack/src/Extends/Hosts/BulkActions/BulkRemovePuppetEnvironment/__tests__/BulkRemovePuppetEnvironmentModal.test.js

@@ -0,0 +1,80 @@
+import React from 'react';
+import { render, screen, fireEvent } from '@testing-library/react';
+import '@testing-library/jest-dom';
+import { IntlProvider } from 'react-intl';
+import { useDispatch } from 'react-redux';
+
+import BulkRemovePuppetEnvironmentModal from '../BulkRemovePuppetEnvironmentModal';
+import { bulkChangePuppetEnvironment } from '../../BulkChangePuppetEnvironment/actions';
+
+jest.mock('react-redux', () => ({
+  ...jest.requireActual('react-redux'),
+  useDispatch: jest.fn(),
+}));
+
+jest.mock('foremanReact/Root/Context/ForemanContext', () => ({
+  useForemanOrganization: jest.fn(() => ({ id: 23 })),
+}));
+
+jest.mock('../../BulkChangePuppetEnvironment/actions', () => ({
+  bulkChangePuppetEnvironment: jest.fn(() => ({
+    type: 'BULK_CHANGE_PUPPET_ENVIRONMENT',
+  })),
+  BULK_CHANGE_PUPPET_ENVIRONMENT_KEY: 'BULK_CHANGE_PUPPET_ENVIRONMENT',
+}));
+
+describe('BulkRemovePuppetEnvironmentModal', () => {
+  const dispatch = jest.fn();
+
+  const renderComponent = (fetchBulkParams = jest.fn()) =>
+    render(
+      <IntlProvider locale="en">
+        <BulkRemovePuppetEnvironmentModal
+          isOpen
+          closeModal={jest.fn()}
+          fetchBulkParams={fetchBulkParams}
+          selectedCount={2}
+          selectAllHostsMode={false}
+        />
+      </IntlProvider>
+    );
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    useDispatch.mockReturnValue(dispatch);
+  });
+
+  it('renders the removal warning', () => {
+    renderComponent();
+
+    expect(
+      screen.getAllByText('Remove Puppet Environment')[0]
+    ).toBeInTheDocument();
+    expect(
+      screen.getByText(/Removing the Puppet environment will affect/)
+    ).toBeInTheDocument();
+  });
+
+  it('submits organization scope with the bulk remove request', () => {
+    const fetchBulkParams = jest.fn(
+      () => 'organization = "Default Organization"'
+    );
+    renderComponent(fetchBulkParams);
+
+    fireEvent.click(
+      screen.getByRole('button', { name: 'Remove Puppet Environment' })
+    );
+
+    expect(bulkChangePuppetEnvironment).toHaveBeenCalledWith(
+      {
+        included: {
+          search: 'organization = "Default Organization"',
+        },
+        environment_id: null,
+        organization_id: 23,
+      },
+      expect.any(Function),
+      expect.any(Function)
+    );
+  });
+});

data/webpack/src/Extends/Hosts/BulkActions/BulkRemovePuppetEnvironment/__tests__/index.test.js

@@ -0,0 +1,66 @@
+import React from 'react';
+import renderer, { act } from 'react-test-renderer';
+
+import { useBulkModalOpen } from 'foremanReact/common/BulkModalStateHelper';
+import { ForemanActionsBarContext } from 'foremanReact/components/HostDetails/ActionsBar';
+
+import BulkRemovePuppetEnvironmentScene from '../index';
+import BulkRemovePuppetEnvironmentModal from '../BulkRemovePuppetEnvironmentModal';
+
+jest.mock('foremanReact/common/BulkModalStateHelper', () => ({
+  useBulkModalOpen: jest.fn(),
+}));
+
+jest.mock('../BulkRemovePuppetEnvironmentModal', () => ({
+  __esModule: true,
+  default: jest.fn(() => null),
+}));
+
+describe('BulkRemovePuppetEnvironmentScene', () => {
+  const fetchBulkParams = jest.fn();
+  const refreshTableData = jest.fn();
+  const contextValue = {
+    selectAllHostsMode: false,
+    selectedCount: 2,
+    selectedResults: [1, 2],
+    fetchBulkParams,
+    refreshTableData,
+  };
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    useBulkModalOpen.mockReturnValue({
+      isOpen: true,
+      close: jest.fn(),
+    });
+  });
+
+  it('opens with bulk modal state and passes expected props', () => {
+    let component;
+    act(() => {
+      component = renderer.create(
+        <ForemanActionsBarContext.Provider value={contextValue}>
+          <BulkRemovePuppetEnvironmentScene />
+        </ForemanActionsBarContext.Provider>
+      );
+    });
+
+    const componentType =
+      BulkRemovePuppetEnvironmentModal.default ||
+      BulkRemovePuppetEnvironmentModal;
+    const { props } = component.root.findByType(componentType);
+
+    expect(props).toEqual(
+      expect.objectContaining({
+        fetchBulkParams,
+        selectedCount: 2,
+        selectAllHostsMode: false,
+        isOpen: true,
+        closeModal: expect.any(Function),
+        onSuccess: refreshTableData,
+      })
+    );
+
+    component.unmount();
+  });
+});

data/webpack/src/Extends/Hosts/BulkActions/BulkRemovePuppetEnvironment/index.js

@@ -0,0 +1,30 @@
+import React, { useContext } from 'react';
+import { ForemanActionsBarContext } from 'foremanReact/components/HostDetails/ActionsBar';
+import { useBulkModalOpen } from 'foremanReact/common/BulkModalStateHelper';
+import BulkRemovePuppetEnvironmentModal from './BulkRemovePuppetEnvironmentModal';
+
+const BulkRemovePuppetEnvironmentScene = () => {
+  const {
+    selectAllHostsMode,
+    selectedCount,
+    fetchBulkParams,
+    refreshTableData,
+  } = useContext(ForemanActionsBarContext);
+  const { isOpen, close: closeModal } = useBulkModalOpen(
+    'bulk-remove-puppet-environment'
+  );
+
+  return (
+    <BulkRemovePuppetEnvironmentModal
+      fetchBulkParams={fetchBulkParams}
+      selectedCount={selectedCount}
+      selectAllHostsMode={selectAllHostsMode}
+      isOpen={isOpen}
+      closeModal={closeModal}
+      onSuccess={refreshTableData}
+    />
+  );
+};
+
+export { BulkRemovePuppetEnvironmentModal };
+export default BulkRemovePuppetEnvironmentScene;

data/webpack/src/Extends/Hosts/BulkActions/BulkRemovePuppetProxy/__tests__/index.test.js

@@ -1,61 +1,153 @@
 import React from 'react';
-import { mount } from '@theforeman/test';
+import { screen, act } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import '@testing-library/jest-dom';
 
 import { openBulkModal } from 'foremanReact/common/BulkModalStateHelper';
 import { ForemanActionsBarContext } from 'foremanReact/components/HostDetails/ActionsBar';
+import { rtlHelpers } from 'foremanReact/common/rtlTestHelpers';
+import { APIActions } from 'foremanReact/redux/API';
+import { foremanUrl } from 'foremanReact/common/helpers';
 
 import BulkRemovePuppetProxyScene from '../index';
-import BulkRemoveProxyCommon from '../../BulkRemoveProxyCommon';
+import { BULK_REMOVE_PUPPET_PROXY_KEY } from '../../BulkRemoveProxyCommon/actions';
 
-jest.mock('foremanReact/components/HostDetails/ActionsBar', () => ({
-  ForemanActionsBarContext: jest.requireActual('react').createContext(),
-}));
+jest.mock(
+  'foremanReact/components/HostDetails/ActionsBar',
+  () => ({
+    ForemanActionsBarContext: jest.requireActual('react').createContext(),
+  }),
+  { virtual: true }
+);
 
-jest.mock('../../BulkRemoveProxyCommon', () => ({
-  __esModule: true,
-  default: jest.fn(() => null),
+jest.mock('foremanReact/redux/API', () => ({
+  APIActions: {
+    put: jest.fn(payload => ({ type: 'MOCK_API_PUT', payload })),
+  },
 }));
 
+const { renderWithStoreAndI18n } = rtlHelpers;
+
 describe('BulkRemovePuppetProxyScene', () => {
-  const fetchBulkParams = jest.fn();
+  const fetchBulkParams = jest.fn(() => 'name = host1');
+  const refreshTableData = jest.fn();
   const contextValue = {
     selectAllHostsMode: false,
     selectedCount: 2,
     selectedResults: [1, 2],
     fetchBulkParams,
+    refreshTableData,
+  };
+
+  const renderScene = (context = contextValue) =>
+    renderWithStoreAndI18n(
+      <ForemanActionsBarContext.Provider value={context}>
+        <BulkRemovePuppetProxyScene />
+      </ForemanActionsBarContext.Provider>
+    );
+
+  const openSceneModal = async () => {
+    openBulkModal('bulk-remove-puppet-proxy', true);
+
+    return screen.findByRole('dialog', { name: 'Remove Puppet Proxy' });
   };
 
   beforeEach(() => {
-    jest.clearAllMocks();
     openBulkModal('bulk-remove-puppet-proxy', false);
   });
 
-  it('opens with bulk modal state and passes expected props', () => {
-    openBulkModal('bulk-remove-puppet-proxy', true);
-    const wrapper = mount(
-      <ForemanActionsBarContext.Provider value={contextValue}>
-        <BulkRemovePuppetProxyScene />
-      </ForemanActionsBarContext.Provider>
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('does not show the modal when bulk modal state is closed', () => {
+    renderScene();
+
+    expect(
+      screen.queryByRole('dialog', { name: 'Remove Puppet Proxy' })
+    ).not.toBeInTheDocument();
+  });
+
+  it('shows the modal with a warning for the selected hosts when opened', async () => {
+    renderScene();
+    await openSceneModal();
+
+    expect(
+      screen.getByText(/Removing the Puppet proxy will affect/)
+    ).toBeInTheDocument();
+    expect(screen.getByText('2', { selector: 'strong' })).toBeInTheDocument();
+    expect(screen.getByText(/selected hosts/)).toBeInTheDocument();
+    expect(
+      screen.getByRole('button', { name: 'Remove Puppet Proxy' })
+    ).toBeInTheDocument();
+    expect(screen.getByRole('button', { name: 'Cancel' })).toBeInTheDocument();
+  });
+
+  it('shows the all hosts warning when select all hosts mode is enabled', async () => {
+    renderScene({
+      ...contextValue,
+      selectAllHostsMode: true,
+    });
+    await openSceneModal();
+
+    expect(
+      screen.getByText(/Removing the Puppet proxy will affect/)
+    ).toBeInTheDocument();
+    expect(screen.getByText('All', { selector: 'strong' })).toBeInTheDocument();
+    expect(screen.getByText(/selected hosts/)).toBeInTheDocument();
+  });
+
+  it('closes the modal when Cancel is clicked', async () => {
+    renderScene();
+    await openSceneModal();
+
+    await userEvent.click(screen.getByRole('button', { name: 'Cancel' }));
+
+    expect(
+      screen.queryByRole('dialog', { name: 'Remove Puppet Proxy' })
+    ).not.toBeInTheDocument();
+  });
+
+  it('dispatches the bulk remove puppet proxy action when confirmed', async () => {
+    renderScene();
+    await openSceneModal();
+
+    await userEvent.click(
+      screen.getByRole('button', { name: 'Remove Puppet Proxy' })
     );
 
-    const componentType =
-      BulkRemoveProxyCommon.default || BulkRemoveProxyCommon;
-    const props = wrapper.find(componentType).props();
-
-    expect(props).toEqual(
-      expect.objectContaining({
-        isCAProxy: false,
-        selectAllHostsMode: false,
-        selectedCount: 2,
-        selectedResults: [1, 2],
-        fetchBulkParams,
-        isOpen: true,
-        closeModal: expect.any(Function),
-        handleErrorMessage: 'Failed to remove Puppet Proxy',
-        removeMessage: 'Remove Puppet Proxy',
-      })
+    expect(fetchBulkParams).toHaveBeenCalledTimes(1);
+    expect(APIActions.put).toHaveBeenCalledWith({
+      key: BULK_REMOVE_PUPPET_PROXY_KEY,
+      url: foremanUrl('/api/v2/hosts/bulk/remove_puppet_proxy'),
+      handleSuccess: expect.any(Function),
+      handleError: expect.any(Function),
+      params: {
+        included: {
+          search: 'name = host1',
+        },
+        ca_proxy: false,
+      },
+    });
+  });
+
+  it('refreshes table data after a successful bulk remove', async () => {
+    renderScene();
+    await openSceneModal();
+
+    await userEvent.click(
+      screen.getByRole('button', { name: 'Remove Puppet Proxy' })
     );
 
-    wrapper.unmount();
+    const { handleSuccess } = APIActions.put.mock.calls[0][0];
+
+    act(() => {
+      handleSuccess({ data: { message: 'Puppet proxy removed' } });
+    });
+
+    expect(refreshTableData).toHaveBeenCalledTimes(1);
+    expect(
+      screen.queryByRole('dialog', { name: 'Remove Puppet Proxy' })
+    ).not.toBeInTheDocument();
   });
 });

data/webpack/src/Extends/Hosts/BulkActions/BulkRemovePuppetProxy/index.js

@@ -10,6 +10,7 @@ const BulkRemovePuppetProxyScene = () => {
     selectedCount,
     selectedResults,
     fetchBulkParams,
+    refreshTableData,
   } = useContext(ForemanActionsBarContext);
   const { isOpen, close: closeModal } = useBulkModalOpen(
     'bulk-remove-puppet-proxy'
@@ -24,6 +25,7 @@ const BulkRemovePuppetProxyScene = () => {
       fetchBulkParams={fetchBulkParams}
       isOpen={isOpen}
       closeModal={closeModal}
+      onSuccess={refreshTableData}
       handleErrorMessage={__('Failed to remove Puppet Proxy')}
       allHostsMessage={__(
         'Removing the Puppet proxy will affect {boldCount} selected hosts.'

data/webpack/src/Router/routes.fixtures.js

@@ -0,0 +1,13 @@
+import React from 'react';
+
+export const ExampleRoutePage = () => (
+  <h1>Foreman Puppet example route</h1>
+);
+
+export const exampleRoutes = {
+  example: {
+    path: '/foreman_puppet_example',
+    exact: true,
+    component: ExampleRoutePage,
+  },
+};

data/webpack/src/Router/routes.test.js

@@ -1,16 +1,76 @@
 import React from 'react';
-import { shallow } from '@theforeman/test';
+import { createMemoryHistory } from 'history';
+import { Router, Route, Switch } from 'react-router-dom';
+import { screen } from '@testing-library/react';
+import '@testing-library/jest-dom';
 
-import Routes from './routes';
+import routes from './routes';
+import ForemanPuppetRouter from './index';
+import { exampleRoutes } from './routes.fixtures';
+import { rtlHelpers } from 'foremanReact/common/rtlTestHelpers';
+
+const { renderWithStore } = rtlHelpers;
+
+const renderForemanPuppetRouterAtPath = path => {
+  const history = createMemoryHistory({ initialEntries: [path] });
+
+  return renderWithStore(
+    <Router history={history}>
+      <ForemanPuppetRouter />
+    </Router>
+  );
+};
+
+const renderRoutesAtPath = (routeMap, path) => {
+  const history = createMemoryHistory({ initialEntries: [path] });
+
+  return renderWithStore(
+    <Router history={history}>
+      <Switch>
+        {Object.entries(routeMap).map(([key, props]) => (
+          <Route key={key} {...props} />
+        ))}
+      </Switch>
+    </Router>
+  );
+};
 
 describe('ForemanPuppetRoutes', () => {
-  it('should create routes', () => {
-    Object.entries(Routes).forEach(([key, Route]) => {
-      const Component = Route.component;
-      const component = shallow(<Component history={{}} some="props" />);
-      Route.renderResult = component;
+  it('exports an empty routes configuration object', () => {
+    expect(routes).toEqual({});
+    expect(routes).not.toBeNull();
+    expect(Array.isArray(routes)).toBe(false);
+  });
+
+  describe('fixture routes', () => {
+    it('defines valid route entries', () => {
+      Object.entries(exampleRoutes).forEach(([routeKey, route]) => {
+        expect(routeKey).toBeTruthy();
+        expect(route).toEqual(
+          expect.objectContaining({
+            path: expect.any(String),
+            component: expect.any(Function),
+          })
+        );
+      });
     });
 
-    expect(Routes).toMatchSnapshot();
+    it('renders a fixture route at its path', () => {
+      const { path } = exampleRoutes.example;
+
+      renderRoutesAtPath(exampleRoutes, path);
+
+      expect(
+        screen.getByRole('heading', { name: 'Foreman Puppet example route' })
+      ).toBeInTheDocument();
+    });
+  });
+
+  describe('ForemanPuppetRouter', () => {
+    it('renders without content when no routes are configured', () => {
+      const { container } = renderForemanPuppetRouterAtPath('/');
+
+      expect(container).toBeEmptyDOMElement();
+    });
   });
 });

data/webpack/src/foreman_puppet_host_form.test.js

@@ -4,6 +4,8 @@ import $ from 'jquery';
 
 import { checkForUnavailablePuppetclasses } from './foreman_puppet_host_form';
 
+const WARNING_RENDER_TIMEOUT = 100;
+
 jest.unmock('jquery');
 jest.unmock('./foreman_puppet_host_form');
 
@@ -59,6 +61,6 @@ describe('checkForUnavailablePuppetclasses', () => {
     checkForUnavailablePuppetclasses();
     setTimeout(() => {
       expect($('a .pficon')).toHaveLength(1);
-    }, 100);
+    }, WARNING_RENDER_TIMEOUT);
   });
 });

data/webpack/test_setup.js

@@ -0,0 +1 @@
+import 'foremanJSTestSetup';