RubyGems - foreman_resource_quota - Versions diffs - 0.3.0 → 0.4.0 - Mend

foreman_resource_quota 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (174) hide show

data/webpack/components/ResourceQuotaEmptyState/__test__/ResourceQuotaEmptyState.test.js ADDED Viewed

@@ -0,0 +1,35 @@
+import React from 'react';
+import '@testing-library/jest-dom';
+import { mount, testComponentSnapshotsWithFixtures } from '@theforeman/test';
+// Notice: (not) importing Modal affects the snapshot test since it fills
+// the components data dynamically in snapshots as soon as it can find the component.
+import { Modal } from '@patternfly/react-core';
+import { withMockedProvider, withRedux } from '../../../test_helper';
+import ResourceQuotaForm from '../../ResourceQuotaForm';
+import ResourceQuotaEmptyState from '../index';
+const TestComponent = withRedux(withMockedProvider(ResourceQuotaEmptyState));
+describe('ResourceQuotaEmptyState', () => {
+  testComponentSnapshotsWithFixtures(ResourceQuotaEmptyState, {
+    'should render': {}, // component has no props
+  });
+  test('opens the modal on clicking "Create resource quota" button', () => {
+    const wrapper = mount(<TestComponent />);
+    expect(wrapper.find(Modal).prop('isOpen')).toBe(false); // check we provide the correct input to Modal
+    expect(wrapper.find(ResourceQuotaForm).exists()).toBe(false);
+    wrapper
+      .find('button')
+      .filterWhere(button => button.text() === 'Create resource quota')
+      .simulate('click');
+    wrapper.update();
+    expect(wrapper.find(Modal).prop('isOpen')).toBe(true);
+    expect(wrapper.find(ResourceQuotaForm).exists()).toBe(true);
+  });
+});

data/webpack/components/ResourceQuotaEmptyState/__test__/__snapshots__/ResourceQuotaEmptyState.test.js.snap ADDED Viewed

@@ -0,0 +1,80 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+exports[`ResourceQuotaEmptyState should render 1`] = `
+<div>
+  <EmptyStatePattern
+    action={
+      <Button
+        id="foreman-resource-quota-welcome-create-modal-button"
+        onClick={[Function]}
+        variant="primary"
+      >
+        Create resource quota
+      </Button>
+    }
+    description={
+      <span>
+        Resource Quotas help admins to manage resources including CPUs, memory, and disk space among users or user groups.
+        <br />
+        Define a Resource Quota here and apply it to users to guarantee a fair share of your resources.
+        <br />
+      </span>
+    }
+    documentation={
+      Object {
+        "url": "/links/docs/Administering_Project?chapter=limiting-host-resources",
+      }
+    }
+    header="Resource Quotas"
+    icon="pficon pficon-cluster"
+    iconType="pf"
+    secondaryActions={Array []}
+  />
+  <Modal
+    actions={Array []}
+    appendTo={<body />}
+    aria-describedby=""
+    aria-label=""
+    aria-labelledby=""
+    className=""
+    hasNoBodyWrapper={false}
+    isOpen={false}
+    onClose={[Function]}
+    ouiaId="foreman-resource-quota-create-modal"
+    ouiaSafe={true}
+    showClose={true}
+    title="Create resource quota"
+    titleIconVariant={null}
+    titleLabel=""
+    variant="small"
+  >
+    <ResourceQuotaForm
+      initialProperties={
+        Object {
+          "cpu_cores": null,
+          "description": "",
+          "disk_gb": null,
+          "memory_mb": null,
+          "name": "",
+        }
+      }
+      initialStatus={
+        Object {
+          "missing_hosts": null,
+          "number_of_hosts": null,
+          "number_of_usergroups": null,
+          "number_of_users": null,
+          "utilization": Object {
+            "cpu_cores": null,
+            "disk_gb": null,
+            "memory_mb": null,
+          },
+        }
+      }
+      isNewQuota={true}
+      onSubmit={[Function]}
+      quotaChangesCallback={null}
+    />
+  </Modal>
+</div>
+`;

data/webpack/components/ResourceQuotaEmptyState/index.js CHANGED Viewed

@@ -2,6 +2,7 @@ import React, { useState } from 'react';
 import { Button, Modal, ModalVariant } from '@patternfly/react-core';
 import { translate as __ } from 'foremanReact/common/I18n';
+import { getDocsURL } from 'foremanReact/common/helpers';
 import EmptyStatePattern from 'foremanReact/components/common/EmptyState/EmptyStatePattern';
 import ResourceQuotaForm from '../ResourceQuotaForm';
@@ -28,16 +29,32 @@ const ResourceQuotaEmptyState = () => {
       {__('Create resource quota')}
     </Button>
   );
+  const description = (
+    <span>
+      {__(
+        'Resource Quotas help admins to manage resources including CPUs, memory, and disk space among users or user groups.'
+      )}
+      <br />
+      {__(
+        'Define a Resource Quota here and apply it to users to guarantee a fair share of your resources.'
+      )}
+      <br />
+    </span>
+  );
+  const documentation = {
+    url: getDocsURL('Administering_Project', 'limiting-host-resources'),
+  };
   return (
     <div>
       <EmptyStatePattern
         icon="pficon pficon-cluster"
         iconType="pf"
         header={__('Resource Quotas')}
-        description={__(
-          'Resource Quotas help admins to manage hardware resources (like CPUs, RAM, and disk space) among users or usergroups. \n\rDefine a Resource Quota here and apply it to users in order to guarantee a free share of your resources.'
-        )}
+        description={description}
         action={ActionButton}
+        documentation={documentation}
       />
       <Modal
         ouiaId={MODAL_ID_CREATE_RESOURCE_QUOTA}

data/webpack/components/ResourceQuotaForm/ResourceQuotaFormConstants.js CHANGED Viewed

@@ -19,14 +19,14 @@ export const RESOURCE_NAME_DISK = 'Disk space';
 /* Resource units (order the units with increasing factor!) */
 export const RESOURCE_UNIT_CPU = [{ symbol: 'cores', factor: 1 }];
 export const RESOURCE_UNIT_MEMORY = [
-  { symbol: 'MB', factor: 1 },
-  { symbol: 'GB', factor: 1024 },
-  { symbol: 'TB', factor: 1024 * 1024 },
+  { symbol: 'MiB', factor: 1 },
+  { symbol: 'GiB', factor: 1024 },
+  { symbol: 'TiB', factor: 1024 * 1024 },
 ];
 export const RESOURCE_UNIT_DISK = [
-  { symbol: 'GB', factor: 1 },
-  { symbol: 'TB', factor: 1024 },
-  { symbol: 'PB', factor: 1024 * 1024 },
+  { symbol: 'GiB', factor: 1 },
+  { symbol: 'TiB', factor: 1024 },
+  { symbol: 'PiB', factor: 1024 * 1024 },
 ];
 /* Resource value bounds */

data/webpack/components/ResourceQuotaForm/components/Properties/TextInputField.js CHANGED Viewed

@@ -40,7 +40,7 @@ const TextInputField = ({
       dispatchAPICallbackToast(
         success,
         response,
-        `Sucessfully applied ${label}.`,
+        `Successfully applied ${label}.`,
         `An error occurred appyling ${label}.`
       )
     );

data/webpack/components/ResourceQuotaForm/components/Properties/index.js CHANGED Viewed

@@ -64,7 +64,7 @@ const Properties = ({
       dispatchAPICallbackToast(
         success,
         response,
-        `Sucessfully fetched latest data.`,
+        `Successfully fetched latest data.`,
         `An error occurred fetching quota information.`
       )
     );

data/webpack/components/ResourceQuotaForm/components/Resource/UnitInputField.js CHANGED Viewed

@@ -2,6 +2,7 @@ import React, { useState, useEffect, useCallback } from 'react';
 import PropTypes from 'prop-types';
 import {
   FormGroup,
+  FormHelperText,
   TextInput,
   InputGroup,
   InputGroupText,
@@ -60,17 +61,19 @@ const UnitInputField = ({
   }, [minValue, maxValue, selectedUnit]);
   /* text for float errors */
-  const errorTextNatural = useCallback(
-    () => __('Value must be a natural number.'),
-    []
-  );
+  const errorTextNatural = useCallback(() => __('Value must be a number.'), []);
-  /* text for float errors */
-  const errorTextFloating = useCallback(
-    () => __(`No floating point for smallest unit (${units[0].symbol}).`),
+  /* text for float inputs (rounding) */
+  const warningTextRounded = useCallback(
+    roundedValue => __(`Rounding to: ${roundedValue} (${units[0].symbol}).`),
     [units]
   );
+  /* warning text displayed beneath value input field (built-in is used for errors) */
+  const helperTextWarning = (text, isHidden) => (
+    <FormHelperText isHidden={isHidden}>{text}</FormHelperText>
+  );
   /* applies the selected unit and checks the bounds */
   const isValid = useCallback(
     val => {
@@ -83,20 +86,9 @@ const UnitInputField = ({
         setErrorText(errorTextBounds());
         return false;
       }
-      if (baseValue !== Math.floor(baseValue)) {
-        setErrorText(errorTextFloating());
-        return false;
-      }
       return true;
     },
-    [
-      minValue,
-      maxValue,
-      valueToBaseUnit,
-      errorTextNatural,
-      errorTextBounds,
-      errorTextFloating,
-    ]
+    [minValue, maxValue, valueToBaseUnit, errorTextNatural, errorTextBounds]
   );
   /* applies the selected unit and returns the base-unit value */
@@ -116,9 +108,17 @@ const UnitInputField = ({
       setValidated('default');
     } else if (isValid(inputValue)) {
       const baseValue = valueToBaseUnit(inputValue);
-      onChange(baseValue);
+      let validatedValue = baseValue;
+      if (baseValue !== Math.floor(baseValue)) {
+        validatedValue = Math.floor(baseValue);
+        setErrorText(warningTextRounded(validatedValue));
+        setValidated('warning');
+      } else {
+        // Keep baseValue as validatedValue
+        setValidated('default');
+      }
+      onChange(validatedValue);
       handleInputValidation(true);
-      setValidated('default');
     } else {
       handleInputValidation(false);
       setValidated('error');
@@ -131,6 +131,7 @@ const UnitInputField = ({
     onChange,
     isValid,
     valueToBaseUnit,
+    warningTextRounded,
   ]);
   /* set the selected unit */
@@ -181,6 +182,7 @@ const UnitInputField = ({
       label={__('Quota Limit')}
       validated={validated}
       helperTextInvalid={errorText}
+      helperText={helperTextWarning(errorText, validated !== 'warning')}
       fieldId="quota-limit-resource-quota-form-group"
       labelIcon={labelIcon || {}}
     >

data/webpack/components/ResourceQuotaForm/components/Resource/__test__/UnitInputField.test.js ADDED Viewed

@@ -0,0 +1,108 @@
+import React from 'react';
+import '@testing-library/jest-dom';
+import { render, screen, fireEvent } from '@testing-library/react';
+import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
+import LabelIcon from 'foremanReact/components/common/LabelIcon';
+import UnitInputField from '../UnitInputField';
+const getDefaultProps = () => ({
+  initialValue: 0,
+  onChange: jest.fn(),
+  isDisabled: false,
+  handleInputValidation: jest.fn(),
+  units: [
+    { symbol: 'MiB', factor: 1 },
+    { symbol: 'GiB', factor: 1024 },
+  ],
+  labelIcon: <LabelIcon text="Descriptive title." />,
+  minValue: 0,
+  maxValue: 5,
+});
+const fixtureDefault = {
+  'should render default': {
+    ...getDefaultProps(),
+  },
+};
+const fixtureSingleUnit = {
+  'should render without dropdown (single unit)': {
+    ...getDefaultProps(),
+    units: [{ symbol: 'cores', factor: 1 }],
+  },
+};
+const fixtureDisabled = {
+  'should render as disabled field': {
+    ...getDefaultProps(),
+    isDisabled: true,
+  },
+};
+describe('UnitInputField', () => {
+  testComponentSnapshotsWithFixtures(UnitInputField, fixtureDefault);
+  testComponentSnapshotsWithFixtures(UnitInputField, fixtureSingleUnit);
+  testComponentSnapshotsWithFixtures(UnitInputField, fixtureDisabled);
+  it('triggers handleInputValidation on unit change', async () => {
+    const props = getDefaultProps();
+    render(<UnitInputField {...props} />);
+    const input = screen.getByRole('textbox');
+    fireEvent.change(input, { target: { value: 3 } });
+    // gets called (1.) with initialValue and (2.) the simulated change
+    expect(props.onChange).toHaveBeenCalledTimes(2);
+    expect(props.onChange).toHaveBeenCalledWith(props.initialValue);
+    expect(props.onChange).toHaveBeenLastCalledWith(3);
+    expect(props.handleInputValidation).toHaveBeenCalledTimes(2);
+    expect(props.handleInputValidation).toHaveBeenCalledWith(true);
+  });
+  test('triggers onChange with rounded value', () => {
+    const props = getDefaultProps();
+    render(<UnitInputField {...props} />);
+    const input = screen.getByRole('textbox');
+    fireEvent.change(input, { target: { value: 3.5 } });
+    // gets called (1.) with initialValue and (2.) the simulated change
+    expect(props.onChange).toHaveBeenCalledTimes(2);
+    expect(props.onChange).toHaveBeenCalledWith(props.initialValue);
+    expect(props.onChange).toHaveBeenLastCalledWith(3);
+    expect(props.handleInputValidation).toHaveBeenCalledTimes(2);
+    expect(props.handleInputValidation).toHaveBeenCalledWith(true);
+  });
+  test('does not trigger onChange when value out of bounds', () => {
+    const props = getDefaultProps();
+    render(<UnitInputField {...props} />);
+    const input = screen.getByRole('textbox');
+    fireEvent.change(input, { target: { value: props.maxValue + 1 } });
+    // onChange only called for initialValue
+    expect(props.onChange).toHaveBeenCalledTimes(1);
+    expect(props.onChange).toHaveBeenCalledWith(props.initialValue);
+    // handleInputValidation called with false => invalid
+    expect(props.handleInputValidation).toHaveBeenCalledTimes(2);
+    expect(props.handleInputValidation).toHaveBeenLastCalledWith(false);
+  });
+  test('does not trigger onChange when value is not a number', () => {
+    const props = getDefaultProps();
+    render(<UnitInputField {...props} />);
+    const input = screen.getByRole('textbox');
+    fireEvent.change(input, { target: { value: 'no number' } });
+    // onChange only called for initialValue
+    expect(props.onChange).toHaveBeenCalledTimes(1);
+    expect(props.onChange).toHaveBeenCalledWith(props.initialValue);
+    // handleInputValidation called with false => invalid
+    expect(props.handleInputValidation).toHaveBeenCalledTimes(2);
+    expect(props.handleInputValidation).toHaveBeenLastCalledWith(false);
+  });
+});

data/webpack/components/ResourceQuotaForm/components/Resource/__test__/__snapshots__/UnitInputField.test.js.snap ADDED Viewed

@@ -0,0 +1,155 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+exports[`UnitInputField should render as disabled field 1`] = `
+<FormGroup
+  fieldId="quota-limit-resource-quota-form-group"
+  helperText={
+    <FormHelperText
+      isHidden={true}
+    >
+    </FormHelperText>
+  }
+  helperTextInvalid=""
+  label="Quota Limit"
+  labelIcon={
+    <LabelIcon
+      text="Descriptive title."
+    />
+  }
+  validated="default"
+>
+  <InputGroup>
+    <TextInput
+      id="reg_token_life_time_input"
+      isDisabled={true}
+      max={5}
+      min={0}
+      onChange={[Function]}
+      validated="default"
+      value={0}
+    />
+    <Dropdown
+      dropdownItems={
+        Array [
+          <DropdownItem
+            id="unit-dropdownitem-mib"
+          >
+            MiB
+          </DropdownItem>,
+          <DropdownItem
+            id="unit-dropdownitem-gib"
+          >
+            GiB
+          </DropdownItem>,
+        ]
+      }
+      isOpen={false}
+      onSelect={[Function]}
+      toggle={
+        <DropdownToggle
+          isDisabled={true}
+          onToggle={[Function]}
+        >
+          MiB
+        </DropdownToggle>
+      }
+    />
+  </InputGroup>
+</FormGroup>
+`;
+exports[`UnitInputField should render default 1`] = `
+<FormGroup
+  fieldId="quota-limit-resource-quota-form-group"
+  helperText={
+    <FormHelperText
+      isHidden={true}
+    >
+    </FormHelperText>
+  }
+  helperTextInvalid=""
+  label="Quota Limit"
+  labelIcon={
+    <LabelIcon
+      text="Descriptive title."
+    />
+  }
+  validated="default"
+>
+  <InputGroup>
+    <TextInput
+      id="reg_token_life_time_input"
+      isDisabled={false}
+      max={5}
+      min={0}
+      onChange={[Function]}
+      validated="default"
+      value={0}
+    />
+    <Dropdown
+      dropdownItems={
+        Array [
+          <DropdownItem
+            id="unit-dropdownitem-mib"
+          >
+            MiB
+          </DropdownItem>,
+          <DropdownItem
+            id="unit-dropdownitem-gib"
+          >
+            GiB
+          </DropdownItem>,
+        ]
+      }
+      isOpen={false}
+      onSelect={[Function]}
+      toggle={
+        <DropdownToggle
+          isDisabled={false}
+          onToggle={[Function]}
+        >
+          MiB
+        </DropdownToggle>
+      }
+    />
+  </InputGroup>
+</FormGroup>
+`;
+exports[`UnitInputField should render without dropdown (single unit) 1`] = `
+<FormGroup
+  fieldId="quota-limit-resource-quota-form-group"
+  helperText={
+    <FormHelperText
+      isHidden={true}
+    >
+    </FormHelperText>
+  }
+  helperTextInvalid=""
+  label="Quota Limit"
+  labelIcon={
+    <LabelIcon
+      text="Descriptive title."
+    />
+  }
+  validated="default"
+>
+  <InputGroup>
+    <TextInput
+      id="reg_token_life_time_input"
+      isDisabled={false}
+      max={5}
+      min={0}
+      onChange={[Function]}
+      validated="default"
+      value={0}
+    />
+    <InputGroupText>
+      cores
+    </InputGroupText>
+  </InputGroup>
+</FormGroup>
+`;

data/webpack/components/ResourceQuotaForm/components/Resource/index.js CHANGED Viewed

@@ -74,7 +74,7 @@ const Resource = ({
       dispatchAPICallbackToast(
         success,
         response,
-        `Sucessfully applied ${resourceTitle}.`,
+        `Successfully applied ${resourceTitle}.`,
         `An error occurred appyling ${resourceTitle}.`
       )
     );

data/webpack/components/ResourceQuotaForm/components/Submit.js CHANGED Viewed

@@ -31,7 +31,7 @@ const Submit = ({ isValid, onCreate, onSubmit }) => {
       dispatchAPICallbackToast(
         success,
         response,
-        `Sucessfully created new Resource Quota`,
+        `Successfully created new Resource Quota`,
         `An error occurred while creating new Resource Quota.`
       )
     );

data/webpack/test_helper.js ADDED Viewed

@@ -0,0 +1,49 @@
+/* Credits: https://github.com/theforeman/foreman_ansible/blob/master/webpack/testHelper.js */
+import React, { useState } from 'react';
+import { applyMiddleware, createStore, compose, combineReducers } from 'redux';
+import { reducers as apiReducer, APIMiddleware } from 'foremanReact/redux/API';
+import { Provider } from 'react-redux';
+import { MockedProvider } from '@apollo/react-testing';
+import thunk from 'redux-thunk';
+import ConfirmModal, {
+  reducers as confirmModalReducers,
+} from 'foremanReact/components/ConfirmModal';
+import { getForemanContext } from 'foremanReact/Root/Context/ForemanContext';
+const reducers = combineReducers({ ...apiReducer, ...confirmModalReducers });
+export const generateStore = () =>
+  createStore(reducers, compose(applyMiddleware(thunk, APIMiddleware)));
+// use to resolve async mock requests for apollo MockedProvider
+export const tick = () => new Promise(resolve => setTimeout(resolve, 0));
+export const withRedux = Component => props => (
+  <Provider store={generateStore()}>
+    <Component {...props} />
+    <ConfirmModal />
+  </Provider>
+);
+export const withMockedProvider = Component => props => {
+  const [context, setContext] = useState({
+    metadata: {
+      UISettings: {
+        perPage: 20,
+      },
+    },
+  });
+  const contextData = { context, setContext };
+  const ForemanContext = getForemanContext(contextData);
+  // eslint-disable-next-line react/prop-types
+  const { mocks, ...rest } = props;
+  return (
+    <ForemanContext.Provider value={contextData}>
+      <MockedProvider mocks={mocks}>
+        <Component {...rest} />
+      </MockedProvider>
+    </ForemanContext.Provider>
+  );
+};