foreman_webhooks 4.0.2 → 5.0.0

data/webpack/ForemanWebhooks/Routes/Webhooks/Components/WebhookForm/Components/WebhookFormTabs.js

@@ -4,13 +4,12 @@ import { Tabs, Tab, TabTitleText } from '@patternfly/react-core';
 
 import { sprintf, translate as __ } from 'foremanReact/common/I18n';
 
-import ForemanFormikField from './ForemanFormikField';
-
 import './WebhookFormTabs.css';
+import FieldConstructor from './FieldConstructor';
 
 const WebhookFormTabs = ({
-  formProps,
-  disabled,
+  inputValues,
+  setInputValues,
   activeTab,
   handleTabClick,
   webhookTemplates,
@@ -19,160 +18,198 @@ const WebhookFormTabs = ({
   isTemplatesLoading,
   isEventsLoading,
   isPasswordDisabled,
-  setIsPasswordDisabled,
-}) => (
-  <Tabs
-    ouiaId="webhook-form-tabs"
-    activeKey={activeTab}
-    onSelect={handleTabClick}
-    isFilled
-  >
-    <Tab
-      ouiaId="webhook-form-tab-general"
-      className="webhook-form-tab"
-      eventKey={0}
-      title={<TabTitleText>{__('General')}</TabTitleText>}
+  urlValidated,
+}) => {
+  const updateFieldValue = (key, value) => {
+    setInputValues(prev => ({ ...prev, [key]: value }));
+  };
+
+  const URL_ERR_STRING = __('Enter valid URL');
+
+  return (
+    <Tabs
+      activeKey={activeTab}
+      onSelect={handleTabClick}
+      isFilled
+      ouiaId="webhook-form-tabs"
     >
-      <div className="webhook-form-tab-content">
-        <ForemanFormikField
-          name="event"
-          type="select"
-          label={__('Subscribe to')}
-          required
-          allowClear={false}
-          options={availableEvents}
-          isLoading={isEventsLoading}
-        />
-        <ForemanFormikField
-          name="name"
-          type="text"
-          required
-          label={__('Name')}
-        />
-        <ForemanFormikField
-          name="target_url"
-          type="text"
-          required
-          label={__('Target URL')}
-          labelHelp={
-            <>
-              <div>
-                {__(
-                  'Target URL that should be called by Foreman (ERB allowed).'
-                )}
-              </div>
+      <Tab
+        ouiaId="webhook-form-tab-general"
+        className="webhook-form-tab"
+        eventKey={0}
+        title={<TabTitleText>{__('General')}</TabTitleText>}
+      >
+        <div className="webhook-form-tab-content">
+          <FieldConstructor
+            name="event"
+            value={inputValues.event}
+            setValue={updateFieldValue}
+            type="select"
+            label={__('Subscribe to')}
+            required
+            allowClear={false}
+            options={availableEvents}
+            isLoading={isEventsLoading}
+            placeholder={__('Start typing to search...')}
+          />
+          <FieldConstructor
+            name="name"
+            value={inputValues.name}
+            setValue={updateFieldValue}
+            type="text"
+            required
+            label={__('Name')}
+          />
+          <FieldConstructor
+            name="target_url"
+            value={inputValues.target_url}
+            setValue={updateFieldValue}
+            validated={urlValidated()}
+            errMsg={urlValidated() === 'error' ? URL_ERR_STRING : null}
+            type="text"
+            required
+            label={__('Target URL')}
+            labelHelp={
               <div>
-                {sprintf(
-                  __('Example: %s'),
-                  'https://host.example.com/inventory/<%= @object.id %>'
-                )}
+                <div>
+                  {__(
+                    'Target URL that should be called by Foreman (ERB allowed).'
+                  )}
+                </div>
+                <div>
+                  {sprintf(
+                    __('Example: %s'),
+                    'https://host.example.com/inventory/<%= @object.id %>'
+                  )}
+                </div>
               </div>
-            </>
-          }
-        />
-        <ForemanFormikField
-          name="webhook_template_id"
-          type="select"
-          label={__('Template')}
-          required
-          allowClear={false}
-          options={webhookTemplates}
-          isLoading={isTemplatesLoading}
-        />
-        <ForemanFormikField
-          name="http_method"
-          type="select"
-          label={__('HTTP Method')}
-          required
-          allowClear={false}
-          options={httpMethods}
-        />
-        <ForemanFormikField
-          name="enabled"
-          type="checkbox"
-          label={__('Enabled')}
-          labelHelp={__('If unchecked, the webhook will be inactive')}
-        />
-      </div>
-    </Tab>
-    <Tab
-      ouiaId="webhook-form-tab-creds"
-      className="webhook-form-tab"
-      eventKey={1}
-      title={<TabTitleText>{__('Credentials')}</TabTitleText>}
-    >
-      <div className="webhook-form-tab-content">
-        <ForemanFormikField
-          name="user"
-          type="text"
-          label={__('User')}
-          labelHelp={__('Authentication credentials')}
-        />
-        <ForemanFormikField
-          name="password"
-          type="password"
-          label={__('Password')}
-          labelHelp={__('Authentication credentials')}
-          disabled={isPasswordDisabled}
-          setDisabled={setIsPasswordDisabled}
-        />
-        <ForemanFormikField
-          name="verify_ssl"
-          type="checkbox"
-          label={__('Verify SSL')}
-          labelHelp={__(
-            "Uncheck this option to disable validation of the receiver's SSL certificate"
-          )}
-        />
-        <ForemanFormikField
-          name="proxy_authorization"
-          type="checkbox"
-          label={__('Proxy Authorization')}
-          labelHelp={__(
-            'Authorize with Foreman client certificate and validate smart-proxy CA from Settings'
-          )}
-        />
-        <ForemanFormikField
-          name="ssl_ca_certs"
-          type="textarea"
-          label={__('X509 Certification Authorities')}
-          placeholder={__(
-            "Optional CAs in PEM format concatenated to verify the receiver's SSL certificate"
-          )}
-          inputSizeClass="col-md-8"
-          rows={8}
-        />
-      </div>
-    </Tab>
-    <Tab
-      ouiaId="webhook-form-tab-add"
-      className="webhook-form-tab"
-      eventKey={2}
-      title={<TabTitleText>{__('Additional')}</TabTitleText>}
-    >
-      <div className="webhook-form-tab-content">
-        <ForemanFormikField
-          name="http_content_type"
-          type="text"
-          label={__('HTTP Content Type')}
-        />
-        <ForemanFormikField
-          name="http_headers"
-          type="textarea"
-          label={__('HTTP Headers')}
-          labelHelp={__('Optional. Must be a JSON object (ERB allowed)')}
-          placeholder='{&#13;&#10;"X-Shellhook-Arg-1": "value",&#13;&#10;"X-Shellhook-Arg-2": "<%= @object.id %>"&#13;&#10;}'
-          inputSizeClass="col-md-8"
-          rows={8}
-        />
-      </div>
-    </Tab>
-  </Tabs>
-);
+            }
+          />
+          <FieldConstructor
+            name="webhook_template_id"
+            value={inputValues.webhook_template_id}
+            setValue={updateFieldValue}
+            type="select"
+            label={__('Template')}
+            required
+            allowClear={false}
+            options={webhookTemplates}
+            isLoading={isTemplatesLoading}
+            placeholder={__('Start typing to search...')}
+          />
+          <FieldConstructor
+            name="http_method"
+            value={inputValues.http_method}
+            setValue={updateFieldValue}
+            type="select"
+            label={__('HTTP Method')}
+            required
+            allowClear={false}
+            options={httpMethods}
+            placeholder={__('Start typing to search...')}
+          />
+          <FieldConstructor
+            name="enabled"
+            value={inputValues.enabled}
+            setValue={updateFieldValue}
+            type="checkbox"
+            label={__('Enabled')}
+            labelHelp={__('If unchecked, the webhook will be inactive')}
+          />
+        </div>
+      </Tab>
+      <Tab
+        ouiaId="webhook-form-tab-creds"
+        className="webhook-form-tab"
+        eventKey={1}
+        title={<TabTitleText>{__('Credentials')}</TabTitleText>}
+      >
+        <div className="webhook-form-tab-content">
+          <FieldConstructor
+            name="user"
+            value={inputValues.user}
+            type="text"
+            label={__('User')}
+            labelHelp={__('Authentication credentials')}
+            setValue={updateFieldValue}
+          />
+          <FieldConstructor
+            name="password"
+            type="password"
+            value={inputValues.password}
+            label={__('Password')}
+            labelHelp={__('Authentication credentials')}
+            disabled={isPasswordDisabled}
+            setValue={updateFieldValue}
+          />
+          <FieldConstructor
+            name="verify_ssl"
+            value={inputValues.verify_ssl}
+            type="checkbox"
+            label={__('Verify SSL')}
+            labelHelp={__(
+              "Uncheck this option to disable validation of the receiver's SSL certificate"
+            )}
+            setValue={updateFieldValue}
+          />
+          <FieldConstructor
+            name="proxy_authorization"
+            type="checkbox"
+            value={inputValues.proxy_authorization}
+            label={__('Proxy Authorization')}
+            labelHelp={__(
+              'Authorize with Foreman client certificate and validate smart-proxy CA from Settings'
+            )}
+            setValue={updateFieldValue}
+          />
+          <FieldConstructor
+            name="ssl_ca_certs"
+            value={inputValues.ssl_ca_certs}
+            type="textarea"
+            label={__('X509 Certificate Authorities')}
+            placeholder={__(
+              "Optional CAs in PEM format concatenated to verify the receiver's SSL certificate"
+            )}
+            inputSizeClass="col-md-8"
+            rows={8}
+            setValue={updateFieldValue}
+          />
+        </div>
+      </Tab>
+      <Tab
+        ouiaId="webhook-form-tab-add"
+        className="webhook-form-tab"
+        eventKey={2}
+        title={<TabTitleText>{__('Additional')}</TabTitleText>}
+      >
+        <div className="webhook-form-tab-content">
+          <FieldConstructor
+            value={inputValues.http_content_type}
+            name="http_content_type"
+            type="text"
+            label={__('HTTP Content Type')}
+            setValue={updateFieldValue}
+          />
+          <FieldConstructor
+            name="http_headers"
+            type="textarea"
+            value={inputValues.http_headers}
+            label={__('HTTP Headers')}
+            labelHelp={__('Optional. Must be a JSON object (ERB allowed)')}
+            placeholder='{&#13;&#10;"X-Shellhook-Arg-1": "value",&#13;&#10;"X-Shellhook-Arg-2": "<%= @object.id %>"&#13;&#10;}'
+            inputSizeClass="col-md-8"
+            rows={8}
+            setValue={updateFieldValue}
+          />
+        </div>
+      </Tab>
+    </Tabs>
+  );
+};
 
 WebhookFormTabs.propTypes = {
-  formProps: PropTypes.object,
-  disabled: PropTypes.bool,
+  inputValues: PropTypes.object.isRequired,
+  setInputValues: PropTypes.func.isRequired,
   activeTab: PropTypes.number.isRequired,
   handleTabClick: PropTypes.func.isRequired,
   webhookTemplates: PropTypes.array.isRequired,
@@ -181,14 +218,11 @@ WebhookFormTabs.propTypes = {
   isTemplatesLoading: PropTypes.bool.isRequired,
   isEventsLoading: PropTypes.bool.isRequired,
   isPasswordDisabled: PropTypes.bool,
-  setIsPasswordDisabled: PropTypes.func,
+  urlValidated: PropTypes.func.isRequired,
 };
 
 WebhookFormTabs.defaultProps = {
-  disabled: false,
-  formProps: {},
   isPasswordDisabled: false,
-  setIsPasswordDisabled: undefined,
 };
 
 export default WebhookFormTabs;

data/webpack/ForemanWebhooks/Routes/Webhooks/Components/WebhookForm/Components/__tests__/FieldConstructor.test.js

@@ -0,0 +1,216 @@
+import React from 'react';
+import { render, screen, fireEvent } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import '@testing-library/jest-dom';
+import FieldConstructor from '../FieldConstructor';
+
+const defaultProps = {
+  name: 'test-field',
+  setValue: jest.fn(),
+  label: 'Test Field',
+  value: '',
+  type: 'text',
+};
+
+describe('FieldConstructor RTL Tests', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  describe('Text Input Fields', () => {
+    test('renders text input field', () => {
+      render(<FieldConstructor {...defaultProps} type="text" />);
+
+      expect(screen.getByText('Test Field')).toBeInTheDocument();
+      expect(document.getElementById('id-test-field')).toHaveAttribute(
+        'type',
+        'text'
+      );
+    });
+
+    test('renders password input field', () => {
+      render(<FieldConstructor {...defaultProps} type="password" />);
+
+      expect(screen.getByText('Test Field')).toBeInTheDocument();
+      expect(document.getElementById('id-test-field')).toHaveAttribute(
+        'type',
+        'password'
+      );
+    });
+
+    test('calls setValue when text input changes', () => {
+      render(<FieldConstructor {...defaultProps} type="text" />);
+
+      const input = document.getElementById('id-test-field');
+      fireEvent.change(input, { target: { value: 'test value' } });
+
+      expect(defaultProps.setValue).toHaveBeenCalledWith(
+        'test-field',
+        'test value'
+      );
+    });
+
+    test('renders with initial value', () => {
+      render(
+        <FieldConstructor {...defaultProps} type="text" value="initial value" />
+      );
+
+      expect(document.getElementById('id-test-field')).toHaveValue(
+        'initial value'
+      );
+    });
+
+    test('renders as disabled when loading', () => {
+      render(<FieldConstructor {...defaultProps} type="text" isLoading />);
+
+      expect(document.getElementById('id-test-field')).toBeDisabled();
+    });
+  });
+
+  describe('Textarea Fields', () => {
+    test('renders textarea field', () => {
+      render(<FieldConstructor {...defaultProps} type="textarea" />);
+
+      expect(screen.getByText('Test Field')).toBeInTheDocument();
+      expect(document.getElementById('id-test-field').tagName).toBe('TEXTAREA');
+    });
+
+    test('calls setValue when textarea changes', () => {
+      render(<FieldConstructor {...defaultProps} type="textarea" />);
+
+      const textarea = document.getElementById('id-test-field');
+      fireEvent.change(textarea, { target: { value: 'textarea content' } });
+
+      expect(defaultProps.setValue).toHaveBeenCalledWith(
+        'test-field',
+        'textarea content'
+      );
+    });
+
+    test('renders with specified rows', () => {
+      render(<FieldConstructor {...defaultProps} type="textarea" rows={5} />);
+
+      expect(document.getElementsByTagName('textarea')).toHaveLength(1);
+    });
+  });
+
+  describe('Checkbox Fields', () => {
+    test('renders checkbox field', () => {
+      render(<FieldConstructor {...defaultProps} type="checkbox" />);
+
+      expect(screen.getByText('Test Field')).toBeInTheDocument();
+      expect(document.getElementById('id-test-field')).toHaveAttribute(
+        'type',
+        'checkbox'
+      );
+    });
+
+    test('renders unchecked checkbox', () => {
+      render(
+        <FieldConstructor {...defaultProps} type="checkbox" value={false} />
+      );
+
+      expect(document.getElementById('id-test-field')).not.toBeChecked();
+    });
+  });
+
+  describe('Autocomplete render  test', () => {
+    test('renders autocomplete', () => {
+      const props = {
+        ...defaultProps,
+        onChange: defaultProps.setValue,
+        options: [
+          { value: 'host_created.event.foreman', label: 'Host Created' },
+          { value: 'host_updated.event.foreman', label: 'Host Updated' },
+        ],
+      };
+      render(<FieldConstructor {...props} type="select" />);
+
+      expect(screen.getByRole('combobox')).toBeInTheDocument();
+    });
+  });
+
+  describe('Label Help', () => {
+    test('renders help icon when labelHelp is provided', () => {
+      render(
+        <FieldConstructor {...defaultProps} labelHelp="This is help text" />
+      );
+
+      expect(screen.getByRole('button')).toBeInTheDocument();
+    });
+
+    test('does not render help icon when labelHelp is not provided', () => {
+      render(<FieldConstructor {...defaultProps} />);
+
+      expect(screen.queryByRole('button')).not.toBeInTheDocument();
+    });
+
+    test('renders help icon with JSX content', async () => {
+      const helpContent = <div>JSX help content</div>;
+      render(<FieldConstructor {...defaultProps} labelHelp={helpContent} />);
+
+      const button = screen.getByRole('button');
+      expect(button).toBeInTheDocument();
+
+      userEvent.click(button);
+
+      expect(await screen.findByText('JSX help content')).toBeInTheDocument();
+    });
+  });
+
+  describe('Validation', () => {
+    test('renders error message when validated is error', async () => {
+      render(
+        <>
+          <FieldConstructor {...defaultProps} required type="text" />
+          <button>Dummy</button>
+        </>
+      );
+
+      const input = document.getElementById('id-test-field');
+      await userEvent.click(input);
+      expect(input).toHaveFocus();
+
+      await userEvent.tab();
+      expect(input).not.toHaveFocus();
+
+      expect(screen.getByText('Field is required')).toBeInTheDocument();
+    });
+
+    test('does not render error message when validated is not error', () => {
+      render(
+        <FieldConstructor {...defaultProps} type="text" validated="success" />
+      );
+
+      expect(screen.queryByText('Field is required')).not.toBeInTheDocument();
+    });
+  });
+
+  describe('Edge Cases', () => {
+    test('handles undefined value', () => {
+      render(
+        <FieldConstructor {...defaultProps} type="text" value={undefined} />
+      );
+
+      expect(document.getElementById('id-test-field')).toHaveValue('');
+    });
+
+    test('handles null value', () => {
+      render(<FieldConstructor {...defaultProps} type="text" value={null} />);
+
+      expect(document.getElementById('id-test-field')).toHaveValue('');
+    });
+
+    test('handles numeric value', () => {
+      render(<FieldConstructor {...defaultProps} type="text" value={123} />);
+
+      expect(document.getElementById('id-test-field')).toHaveValue('123');
+    });
+
+    test('handles boolean value for checkbox', () => {
+      render(<FieldConstructor {...defaultProps} type="checkbox" value />);
+
+      expect(document.getElementById('id-test-field')).toBeChecked();
+    });
+  });
+});