foreman_puppet 11.0.0 → 11.2.0

data/webpack/src/Extends/Hosts/BulkActions/BulkChangePuppetEnvironment/BulkChangePuppetEnvironmentModal.js

@@ -0,0 +1,239 @@
+import React, { useEffect, useState } from 'react';
+import PropTypes from 'prop-types';
+import { FormattedMessage } from 'react-intl';
+import { useDispatch, useSelector } from 'react-redux';
+import {
+  Modal,
+  Button,
+  TextContent,
+  Text,
+  Select,
+  SelectOption,
+  SelectList,
+  MenuToggle,
+} 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 {
+  selectAPIStatus,
+  selectAPIResponse,
+} from 'foremanReact/redux/API/APISelectors';
+import { STATUS } from 'foremanReact/constants';
+import { bulkActionErrorToastParams } from '../toastHelpers';
+import {
+  fetchEnvironments,
+  bulkChangePuppetEnvironment,
+  PUPPET_ENVIRONMENTS_KEY,
+  BULK_CHANGE_PUPPET_ENVIRONMENT_KEY,
+  INHERIT_ENVIRONMENT,
+} from './actions';
+
+const BulkChangePuppetEnvironmentModal = ({
+  isOpen,
+  closeModal,
+  selectAllHostsMode,
+  selectedCount,
+  fetchBulkParams,
+  onSuccess: onSuccessCallback,
+}) => {
+  const dispatch = useDispatch();
+  const [environmentId, setEnvironmentId] = useState(null);
+  const [environmentSelectOpen, setEnvironmentSelectOpen] = useState(false);
+  const currentOrganization = useForemanOrganization();
+
+  useEffect(() => {
+    dispatch(fetchEnvironments(currentOrganization?.id));
+  }, [dispatch, currentOrganization?.id]);
+
+  const environments = useSelector(state =>
+    selectAPIResponse(state, PUPPET_ENVIRONMENTS_KEY)
+  );
+  const environmentsStatus = useSelector(state =>
+    selectAPIStatus(state, PUPPET_ENVIRONMENTS_KEY)
+  );
+
+  const onToggleClick = () => {
+    setEnvironmentSelectOpen(!environmentSelectOpen);
+  };
+
+  const handleEnvironmentSelect = (event, selection) => {
+    setEnvironmentId(selection);
+    setEnvironmentSelectOpen(false);
+  };
+
+  const getEnvironmentLabel = value => {
+    if (value === INHERIT_ENVIRONMENT) return __('*Inherit from host group*');
+
+    const selectedEnvironment = environments?.results?.find(
+      environment => `${environment.id}` === value
+    );
+    return selectedEnvironment?.name || __('Select an Environment');
+  };
+
+  const toggle = toggleRef => (
+    <MenuToggle
+      ouiaId="bulk-change-env-common-select-toggle"
+      ref={toggleRef}
+      onClick={onToggleClick}
+      isExpanded={environmentSelectOpen}
+      style={{ width: '500px' }}
+    >
+      {environmentId
+        ? getEnvironmentLabel(environmentId)
+        : __('Select an Environment')}
+    </MenuToggle>
+  );
+
+  const handleModalClose = () => {
+    setEnvironmentId(null);
+    closeModal();
+  };
+
+  const handleError = response => {
+    handleModalClose();
+    dispatch(
+      addToast(
+        bulkActionErrorToastParams(
+          response,
+          __('Failed to change 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: environmentId,
+      organization_id: currentOrganization?.id,
+    };
+
+    dispatch(
+      bulkChangePuppetEnvironment(requestBody, handleSuccess, handleError)
+    );
+  };
+
+  const modalActions = [
+    <Button
+      key="add"
+      ouiaId="bulk-change-environment-modal-add-button"
+      variant="primary"
+      onClick={handleConfirm}
+      isDisabled={environmentId === null}
+      isLoading={environmentsStatus === STATUS.PENDING}
+    >
+      {__('Change Puppet Environment')}
+    </Button>,
+    <Button
+      key="cancel"
+      ouiaId="bulk-change-environment-modal-cancel-button"
+      variant="link"
+      onClick={handleModalClose}
+    >
+      {__('Cancel')}
+    </Button>,
+  ];
+
+  return (
+    <Modal
+      isOpen={isOpen}
+      onClose={handleModalClose}
+      onEscapePress={handleModalClose}
+      title={__('Change Puppet Environment')}
+      width="50%"
+      position="top"
+      actions={modalActions}
+      id="bulk-change-puppet-environment"
+      key="bulk-change-puppet-environment"
+      ouiaId="bulk-change-puppet-environment"
+    >
+      <TextContent>
+        <Text ouiaId="bulk-change-puppet-environment-options">
+          {selectAllHostsMode ? (
+            <FormattedMessage
+              id="bulk-change-puppet-environment-warning-message-all"
+              defaultMessage={__(
+                'Changing the Puppet environment will affect {boldCount} selected hosts. Some hosts may already have been associated with the selected environment.'
+              )}
+              values={{
+                boldCount: <strong>{__('All')}</strong>,
+              }}
+            />
+          ) : (
+            <FormattedMessage
+              id="bulk-change-puppet-environment-warning-message"
+              defaultMessage={__(
+                'Changing the Puppet environment will affect {boldCount} selected {count, plural, one {host} other {hosts}}. Some hosts may already have been associated with the selected environment.'
+              )}
+              values={{
+                count: selectedCount,
+                boldCount: <strong>{selectedCount}</strong>,
+              }}
+            />
+          )}
+        </Text>
+      </TextContent>
+      {environmentsStatus === STATUS.RESOLVED && (
+        <Select
+          id="bulk-change-puppet-environment-select"
+          isOpen={environmentSelectOpen}
+          selected={environmentId}
+          onSelect={handleEnvironmentSelect}
+          onOpenChange={isSelectOpen => setEnvironmentSelectOpen(isSelectOpen)}
+          toggle={toggle}
+          shouldFocusToggleOnSelect
+          ouiaId="bulk-change-puppet-environment-select"
+        >
+          <SelectList>
+            <SelectOption value={INHERIT_ENVIRONMENT}>
+              {__('*Inherit from host group*')}
+            </SelectOption>
+            {environments?.results?.map(environment => (
+              <SelectOption
+                key={`${environment.id}`}
+                value={`${environment.id}`}
+              >
+                {environment.name}
+              </SelectOption>
+            ))}
+          </SelectList>
+        </Select>
+      )}
+    </Modal>
+  );
+};
+
+BulkChangePuppetEnvironmentModal.propTypes = {
+  isOpen: PropTypes.bool,
+  closeModal: PropTypes.func,
+  fetchBulkParams: PropTypes.func.isRequired,
+  onSuccess: PropTypes.func,
+  selectedCount: PropTypes.number.isRequired,
+  selectAllHostsMode: PropTypes.bool.isRequired,
+};
+
+BulkChangePuppetEnvironmentModal.defaultProps = {
+  isOpen: false,
+  closeModal: () => {},
+  onSuccess: undefined,
+};
+
+export default BulkChangePuppetEnvironmentModal;

data/webpack/src/Extends/Hosts/BulkActions/BulkChangePuppetEnvironment/__tests__/BulkChangePuppetEnvironmentModal.test.js

@@ -0,0 +1,155 @@
+import React from 'react';
+import { render, screen, fireEvent } from '@testing-library/react';
+import '@testing-library/jest-dom';
+import { IntlProvider } from 'react-intl';
+import { useDispatch, useSelector } from 'react-redux';
+
+import BulkChangePuppetEnvironmentModal from '../BulkChangePuppetEnvironmentModal';
+import { fetchEnvironments, bulkChangePuppetEnvironment } from '../actions';
+import {
+  selectAPIResponse,
+  selectAPIStatus,
+} from 'foremanReact/redux/API/APISelectors';
+
+jest.mock('@patternfly/react-core', () => {
+  const React = require('react');
+  const actual = jest.requireActual('@patternfly/react-core');
+
+  const MenuToggle = React.forwardRef(({ children, onClick }, ref) => (
+    <button type="button" ref={ref} onClick={onClick}>
+      {children}
+    </button>
+  ));
+
+  const SelectOption = ({ children, value, onSelect }) => (
+    <button type="button" onClick={event => onSelect(event, value)}>
+      {children}
+    </button>
+  );
+
+  const SelectList = ({ children, onSelect }) => (
+    <div>
+      {React.Children.map(children, child =>
+        React.isValidElement(child)
+          ? React.cloneElement(child, { onSelect })
+          : child
+      )}
+    </div>
+  );
+
+  const Select = ({ children, isOpen, toggle, onSelect }) => (
+    <div>
+      {toggle()}
+      {isOpen &&
+        React.Children.map(children, child =>
+          React.isValidElement(child)
+            ? React.cloneElement(child, { onSelect })
+            : child
+        )}
+    </div>
+  );
+
+  return {
+    ...actual,
+    MenuToggle,
+    Select,
+    SelectList,
+    SelectOption,
+  };
+});
+
+jest.mock('react-redux', () => ({
+  ...jest.requireActual('react-redux'),
+  useDispatch: jest.fn(),
+  useSelector: jest.fn(),
+}));
+
+jest.mock('foremanReact/Root/Context/ForemanContext', () => ({
+  useForemanOrganization: jest.fn(() => ({ id: 23 })),
+}));
+
+jest.mock('foremanReact/redux/API/APISelectors', () => ({
+  selectAPIResponse: jest.fn(),
+  selectAPIStatus: jest.fn(),
+}));
+
+jest.mock('../actions', () => ({
+  fetchEnvironments: jest.fn(() => ({ type: 'FETCH_ENVIRONMENTS' })),
+  bulkChangePuppetEnvironment: jest.fn(() => ({
+    type: 'BULK_CHANGE_PUPPET_ENVIRONMENT',
+  })),
+  PUPPET_ENVIRONMENTS_KEY: 'PUPPET_ENVIRONMENTS_KEY',
+  BULK_CHANGE_PUPPET_ENVIRONMENT_KEY: 'BULK_CHANGE_PUPPET_ENVIRONMENT',
+  INHERIT_ENVIRONMENT: 'inherit',
+}));
+
+describe('BulkChangePuppetEnvironmentModal', () => {
+  const dispatch = jest.fn();
+  const fetchBulkParams = jest.fn(
+    () => 'organization = "Default Organization"'
+  );
+  const environmentsResponse = {
+    results: [{ id: 1, name: 'production' }],
+  };
+
+  const renderComponent = () =>
+    render(
+      <IntlProvider locale="en">
+        <BulkChangePuppetEnvironmentModal
+          isOpen
+          closeModal={jest.fn()}
+          fetchBulkParams={fetchBulkParams}
+          selectedCount={2}
+          selectAllHostsMode={false}
+        />
+      </IntlProvider>
+    );
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    useDispatch.mockReturnValue(dispatch);
+    selectAPIResponse.mockReturnValue(environmentsResponse);
+    selectAPIStatus.mockReturnValue('RESOLVED');
+    useSelector.mockImplementation(selector => selector({}));
+  });
+
+  it('renders the environment options', () => {
+    renderComponent();
+
+    expect(fetchEnvironments).toHaveBeenCalledWith(23);
+    expect(
+      screen.getAllByText('Change Puppet Environment')[0]
+    ).toBeInTheDocument();
+    expect(
+      screen.getByRole('button', { name: 'Select an Environment' })
+    ).toBeInTheDocument();
+    expect(
+      screen.getByText(/Changing the Puppet environment will affect/)
+    ).toBeInTheDocument();
+  });
+
+  it('submits organization scope with the bulk change request', () => {
+    renderComponent();
+
+    fireEvent.click(
+      screen.getByRole('button', { name: 'Select an Environment' })
+    );
+    expect(screen.getByText('*Inherit from host group*')).toBeInTheDocument();
+    fireEvent.click(screen.getByText('production'));
+    fireEvent.click(
+      screen.getByRole('button', { name: 'Change Puppet Environment' })
+    );
+
+    expect(bulkChangePuppetEnvironment).toHaveBeenCalledWith(
+      {
+        included: {
+          search: 'organization = "Default Organization"',
+        },
+        environment_id: '1',
+        organization_id: 23,
+      },
+      expect.any(Function),
+      expect.any(Function)
+    );
+  });
+});

data/webpack/src/Extends/Hosts/BulkActions/BulkChangePuppetEnvironment/__tests__/actions.test.js

@@ -0,0 +1,49 @@
+import { APIActions } from 'foremanReact/redux/API';
+import {
+  fetchEnvironments,
+  PUPPET_ENVIRONMENTS_KEY,
+  bulkChangePuppetEnvironment,
+  BULK_CHANGE_PUPPET_ENVIRONMENT_KEY,
+} from '../actions';
+
+jest.mock('foremanReact/redux/API', () => ({
+  APIActions: {
+    get: jest.fn(),
+    put: jest.fn(),
+  },
+}));
+
+describe('BulkChangePuppetEnvironment actions', () => {
+  const environmentsUrl = '/foreman_puppet/api/v2/environments';
+  const bulkChangeUrl = '/api/v2/hosts/bulk/change_puppet_environment';
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('fetches environments', () => {
+    fetchEnvironments(23);
+
+    expect(APIActions.get).toHaveBeenCalledWith({
+      key: PUPPET_ENVIRONMENTS_KEY,
+      url: environmentsUrl,
+      params: { per_page: 'all', organization_id: 23 },
+    });
+  });
+
+  it('calls bulk change puppet environment endpoint', () => {
+    const params = { included: { ids: [1] }, environment_id: '1' };
+    const handleSuccess = jest.fn();
+    const handleError = jest.fn();
+
+    bulkChangePuppetEnvironment(params, handleSuccess, handleError);
+
+    expect(APIActions.put).toHaveBeenCalledWith({
+      key: BULK_CHANGE_PUPPET_ENVIRONMENT_KEY,
+      url: bulkChangeUrl,
+      handleSuccess,
+      handleError,
+      params,
+    });
+  });
+});

data/webpack/src/Extends/Hosts/BulkActions/BulkChangePuppetEnvironment/__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 BulkChangePuppetEnvironmentScene from '../index';
+import BulkChangePuppetEnvironmentModal from '../BulkChangePuppetEnvironmentModal';
+
+jest.mock('foremanReact/common/BulkModalStateHelper', () => ({
+  useBulkModalOpen: jest.fn(),
+}));
+
+jest.mock('../BulkChangePuppetEnvironmentModal', () => ({
+  __esModule: true,
+  default: jest.fn(() => null),
+}));
+
+describe('BulkChangePuppetEnvironmentScene', () => {
+  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}>
+          <BulkChangePuppetEnvironmentScene />
+        </ForemanActionsBarContext.Provider>
+      );
+    });
+
+    const componentType =
+      BulkChangePuppetEnvironmentModal.default ||
+      BulkChangePuppetEnvironmentModal;
+    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/BulkChangePuppetEnvironment/actions.js

@@ -0,0 +1,37 @@
+import { APIActions } from 'foremanReact/redux/API';
+import { foremanUrl } from 'foremanReact/common/helpers';
+
+export const PUPPET_ENVIRONMENTS_KEY = 'PUPPET_ENVIRONMENTS_KEY';
+export const BULK_CHANGE_PUPPET_ENVIRONMENT_KEY =
+  'BULK_CHANGE_PUPPET_ENVIRONMENT';
+
+export const INHERIT_ENVIRONMENT = 'inherit';
+
+export const fetchEnvironments = organizationId => {
+  const url = foremanUrl('/foreman_puppet/api/v2/environments');
+  return APIActions.get({
+    key: PUPPET_ENVIRONMENTS_KEY,
+    url,
+    params: {
+      per_page: 'all',
+      ...(organizationId ? { organization_id: organizationId } : {}),
+    },
+  });
+};
+
+export const bulkChangePuppetEnvironment = (
+  params,
+  handleSuccess,
+  handleError
+) => {
+  const url = foremanUrl('/api/v2/hosts/bulk/change_puppet_environment');
+  return APIActions.put({
+    key: BULK_CHANGE_PUPPET_ENVIRONMENT_KEY,
+    url,
+    handleSuccess,
+    handleError,
+    params,
+  });
+};
+
+export default fetchEnvironments;

data/webpack/src/Extends/Hosts/BulkActions/BulkChangePuppetEnvironment/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 BulkChangePuppetEnvironmentModal from './BulkChangePuppetEnvironmentModal';
+
+const BulkChangePuppetEnvironmentScene = () => {
+  const {
+    selectAllHostsMode,
+    selectedCount,
+    fetchBulkParams,
+    refreshTableData,
+  } = useContext(ForemanActionsBarContext);
+  const { isOpen, close: closeModal } = useBulkModalOpen(
+    'bulk-change-puppet-environment'
+  );
+
+  return (
+    <BulkChangePuppetEnvironmentModal
+      fetchBulkParams={fetchBulkParams}
+      selectedCount={selectedCount}
+      selectAllHostsMode={selectAllHostsMode}
+      isOpen={isOpen}
+      closeModal={closeModal}
+      onSuccess={refreshTableData}
+    />
+  );
+};
+
+export { BulkChangePuppetEnvironmentModal };
+export default BulkChangePuppetEnvironmentScene;