foreman_webhooks 4.0.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51b84ad832dc00ee4ef55877801f6d9b5dd8761e8555464a0342b007a534a11a
-  data.tar.gz: e60a3dd891be4547d6d11436ea27d6189e693344785e7c53a54ffad05cf28849
+  metadata.gz: eb9a972c704d74ff30075493b920ff61d79582800a99ddb918b4217dd465288c
+  data.tar.gz: 9342868fdd9895fb61fcfe034021efcada6eb56cb71aebad003cb2d8a7fd6e9f
 SHA512:
-  metadata.gz: 9a4c9300644b35b21f465079fc723c30f249a30111a685e1fb7c58fe7967331d57f8b43a503e5de8db82133e2b65e2a076f3fdf8ac13b421fd5c6ae5fd92a79d
-  data.tar.gz: c3aa90eab09a3fdc3044a38409a03dc8a0596bc477d06838f6ccc739a421a0c9ad23413e2172c7ae0b112b8217c70ceb8c758ddad020c16d07de4c95374153e4
+  metadata.gz: 6e448c9f8a2816e9378eb5ba17217c173e12db0472b15b3198e078dd07f416765d4f05e6695a7aa2f7b9cb5fc10850a1e6ce12f8a97880f95a6abdd4dfb3375a
+  data.tar.gz: 96738b273f3ed94440359682714747a504fdfa92f36f3c49bfe82f1931a583bd68c1bf9edb413ff8079864a084c200b90d8e400aa7ad697858cd597f80a609dc

data/lib/foreman_webhooks/engine.rb

@@ -14,7 +14,7 @@ module ForemanWebhooks
     initializer 'foreman_webhooks.register_plugin', before: :finisher_hook do |app|
       app.reloader.to_prepare do
         Foreman::Plugin.register :foreman_webhooks do
-          requires_foreman '>= 3.13'
+          requires_foreman '>= 3.18'
           register_gettext
 
           apipie_documented_controllers ["#{ForemanWebhooks::Engine.root}/app/controllers/api/v2/*.rb"]

data/lib/foreman_webhooks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanWebhooks
-  VERSION = "4.0.2"
+  VERSION = "5.0.0"
 end

data/test/integration/webhooks_test.rb

@@ -0,0 +1,234 @@
+# frozen_string_literal: true
+
+require_relative '../test_plugin_helper'
+require 'integration_test_helper'
+
+class WebhooksIntegrationTest < IntegrationTestWithJavascript
+  let(:webhook_template) { FactoryBot.create(:webhook_template, name: 'Test Template') }
+  let(:second_template) { FactoryBot.create(:webhook_template, name: 'Second Template') }
+
+  setup do
+    webhook_template
+    second_template
+  end
+
+  test 'create webhook and verify via UI' do
+    hook_name = "TestWebhook"
+    subscribe_to = 'Host Created'
+    target_url = 'http://example.com/webhook'
+    http_method = 'GET'
+    username = 'testuser'
+    password = 'testpass123'
+
+    visit '/webhooks'
+    assert_selector 'h1', text: 'Webhooks'
+
+    click_button 'Create new'
+    assert_selector '.pf-v5-c-modal-box'
+
+    fill_in_typeahead('id-event', subscribe_to)
+    fill_in 'id-name', with: hook_name
+    fill_in 'id-target_url', with: target_url
+    fill_in_typeahead('id-webhook_template_id', webhook_template.name)
+    fill_in_typeahead('id-http_method', http_method)
+    uncheck_checkbox('id-enabled')
+
+    click_tab('Credentials')
+    fill_in 'id-user', with: username
+    fill_in 'id-password', with: password
+    check_checkbox('id-proxy_authorization')
+    uncheck_checkbox('id-verify_ssl')
+
+    click_submit_button
+    wait_for_success_toast
+
+    visit '/webhooks'
+    wait_for_ajax
+    click_webhook_name(hook_name)
+    assert_selector '.pf-v5-c-modal-box'
+
+    assert_field_value('id-name', hook_name)
+    assert_typeahead_value('id-event', subscribe_to)
+    assert_field_value('id-target_url', target_url)
+    assert_typeahead_value('id-webhook_template_id', webhook_template.name)
+    assert_typeahead_value('id-http_method', http_method)
+    assert_checkbox_unchecked('id-enabled')
+
+    click_tab('Credentials')
+    assert_field_value('id-user', username)
+    assert_checkbox_checked('id-proxy_authorization')
+    assert_checkbox_unchecked('id-verify_ssl')
+
+    click_cancel_button
+    assert_no_selector '.pf-v5-c-modal-box'
+
+    webhook = Webhook.find_by(name: hook_name)
+    assert webhook, "Webhook '#{hook_name}' was not created"
+    assert webhook.password.present?, 'Password was not saved to database'
+  end
+
+  test 'update webhook and verify via UI' do
+    webhook = FactoryBot.create(:webhook,
+      name: 'ExistingWebhook',
+      target_url: 'http://old.example.com/webhook',
+      http_method: 'POST',
+      webhook_template: webhook_template,
+      user: 'olduser',
+      password: 'oldpass123',
+      enabled: false)
+
+    new_hook_name = "UpdatedWebhook"
+    new_subscribe_to = 'Host Destroyed'
+    new_target_url = 'http://newexample.com/webhook'
+    new_http_method = 'PUT'
+
+    visit '/webhooks'
+    wait_for_ajax
+    click_webhook_name(webhook.name)
+    assert_selector '.pf-v5-c-modal-box'
+
+    fill_in_typeahead('id-event', new_subscribe_to)
+    fill_in 'id-name', with: '', fill_options: { clear: :backspace }
+    fill_in 'id-name', with: new_hook_name
+    fill_in 'id-target_url', with: '', fill_options: { clear: :backspace }
+    fill_in 'id-target_url', with: new_target_url
+    fill_in_typeahead('id-webhook_template_id', second_template.name)
+    fill_in_typeahead('id-http_method', new_http_method)
+    check_checkbox('id-enabled')
+
+    click_submit_button
+    wait_for_success_toast
+
+    visit '/webhooks'
+    wait_for_ajax
+    click_webhook_name(new_hook_name)
+    assert_selector '.pf-v5-c-modal-box'
+
+    assert_field_value('id-name', new_hook_name)
+    assert_typeahead_value('id-event', new_subscribe_to)
+    assert_field_value('id-target_url', new_target_url)
+    assert_typeahead_value('id-webhook_template_id', second_template.name)
+    assert_typeahead_value('id-http_method', new_http_method)
+    assert_checkbox_checked('id-enabled')
+
+    click_cancel_button
+    assert_no_selector '.pf-v5-c-modal-box'
+
+    webhook.reload
+    assert webhook.password.present?, 'Password was cleared after update'
+  end
+
+  test 'delete webhook via UI' do
+    webhook = FactoryBot.create(:webhook,
+      name: 'WebhookToDelete',
+      target_url: 'http://example.com/webhook',
+      http_method: 'POST',
+      webhook_template: webhook_template)
+
+    visit '/webhooks'
+    wait_for_ajax
+    click_webhook_delete_button(webhook.name)
+    assert_selector '#webhookDeleteModal'
+    click_delete_confirm_button
+    wait_for_success_toast
+    assert_no_selector '#webhookDeleteModal'
+
+    assert_no_selector :xpath, "//tr[contains(., '#{webhook.name}')]"
+    assert_nil Webhook.find_by(name: webhook.name), "Webhook should be deleted"
+  end
+
+  private
+
+  def click_tab(tab_name)
+    tab_id = case tab_name
+             when 'General' then 'webhook-form-tab-general'
+             when 'Credentials' then 'webhook-form-tab-creds'
+             when 'Additional' then 'webhook-form-tab-add'
+             else raise "Unknown tab: #{tab_name}"
+             end
+    tab_button = find(:ouia_component_id, tab_id)
+    page.execute_script('arguments[0].click()', tab_button.native)
+  end
+
+  def fill_in_typeahead(field_id, value)
+    input = find("##{field_id}")
+    input.click
+    input.send_keys([:control, 'a'])
+    input.send_keys(:backspace)
+    input.send_keys(value)
+    # Wait for dropdown to appear with matching option
+    assert_selector '[role="option"]', text: value
+    find('[role="option"]', text: value, match: :prefer_exact).click
+    # Wait for dropdown to close
+    assert_no_selector '[role="listbox"]'
+  end
+
+  def check_checkbox(field_id)
+    checkbox = find("##{field_id}", visible: :all)
+    return if checkbox.checked?
+    page.execute_script("document.getElementById('#{field_id}').click()")
+  end
+
+  def uncheck_checkbox(field_id)
+    checkbox = find("##{field_id}", visible: :all)
+    return unless checkbox.checked?
+    page.execute_script("document.getElementById('#{field_id}').click()")
+  end
+
+  def click_submit_button
+    modal = find('.pf-v5-c-modal-box', wait: 10)
+    button = modal.find(:ouia_component_id, 'submit-webhook-form', wait: 10, visible: :all)
+    wait_for { !button.disabled? }
+    page.execute_script('arguments[0].scrollIntoView({block: "center"})', button.native)
+    page.execute_script('arguments[0].click()', button.native)
+  end
+
+  def click_cancel_button
+    modal = find('.pf-v5-c-modal-box', wait: 10)
+    button = modal.find('button', text: 'Cancel', match: :first, wait: 10, visible: :all)
+    page.execute_script('arguments[0].scrollIntoView({block: "center"})', button.native)
+    page.execute_script('arguments[0].click()', button.native)
+  end
+
+  def click_webhook_name(name)
+    row = find(:xpath, "//tbody//tr[contains(., '#{name}')]", wait: 15, match: :first)
+    within(row) do
+      button = find(:ouia_component_id, 'name-edit-active-button', wait: 10)
+      page.execute_script('arguments[0].click()', button.native)
+    end
+  end
+
+  def click_webhook_delete_button(name)
+    row = find(:xpath, "//tbody//tr[contains(., '#{name}')]", wait: 15, match: :first)
+    within(row) do
+      find('button', text: 'Delete', match: :first).click
+    end
+  end
+
+  def click_delete_confirm_button
+    within('#webhookDeleteModal') do
+      find('button', text: 'Delete', match: :first).click
+    end
+  end
+
+  def assert_field_value(field_id, expected_value)
+    assert page.has_field?(field_id, with: expected_value),
+      "Field #{field_id} expected '#{expected_value}'"
+  end
+
+  def assert_typeahead_value(field_id, expected_value)
+    field = find("##{field_id}")
+    assert_includes field.value, expected_value,
+      "Typeahead #{field_id} expected to contain '#{expected_value}' but was '#{field.value}'"
+  end
+
+  def assert_checkbox_checked(field_id)
+    assert page.has_checked_field?(field_id, visible: :all),
+      "Checkbox #{field_id} expected to be checked"
+  end
+
+  def assert_checkbox_unchecked(field_id)
+    assert page.has_unchecked_field?(field_id, visible: :all),
+      "Checkbox #{field_id} expected to be unchecked"
+  end
+end

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

@@ -0,0 +1,321 @@
+/* eslint-disable max-lines */
+import React, { useEffect, useState } from 'react';
+import PropTypes from 'prop-types';
+import AutocompleteInput from 'foremanReact/components/common/AutocompleteInput/AutocompleteInput';
+import { translate as __ } from 'foremanReact/common/I18n';
+import {
+  ExclamationCircleIcon,
+  HelpIcon,
+  PencilAltIcon,
+} from '@patternfly/react-icons';
+import {
+  TextInput,
+  Checkbox,
+  Button,
+  FormHelperText,
+  HelperText,
+  HelperTextItem,
+  Icon,
+  TextArea,
+  FormGroup,
+  Popover,
+  Grid,
+  GridItem,
+} from '@patternfly/react-core';
+
+const FormField = ({
+  name,
+  type,
+  required,
+  options,
+  isLoading,
+  validated,
+  value,
+  disabled,
+  setValue,
+  placeholder,
+  errMsg,
+  fieldId,
+  ...props
+}) => {
+  const [fieldValidated, setFieldValidated] = useState('default');
+  const [firstLoad, setFirstLoad] = useState(true);
+  const [isDisabled, setIsDisabled] = useState(disabled);
+
+  const requiredValidate = () => {
+    if (firstLoad || !required) return;
+    if (!value || value === '' || validated === 'error')
+      setFieldValidated('error');
+    else setFieldValidated('success');
+  };
+
+  const localHandler = (_event, newValue) => {
+    setValue(name, newValue);
+  };
+
+  useEffect(() => {
+    setFirstLoad(false);
+  }, []);
+
+  useEffect(() => {
+    setIsDisabled(disabled);
+  }, [disabled]);
+
+  useEffect(() => {
+    requiredValidate();
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [value]);
+
+  if (type === 'checkbox') {
+    return (
+      <>
+        <Checkbox
+          ouiaId={name}
+          id={fieldId ?? `id-${name}`}
+          isChecked={value || false}
+          onChange={(_, newValue) => {
+            setValue(name, newValue);
+          }}
+          isDisabled={isLoading || isDisabled}
+          isRequired={required}
+          type={type}
+          validated={fieldValidated}
+        />
+        <ValidationComponent localValidated={fieldValidated} errMsg={errMsg} />
+      </>
+    );
+  } else if (type === 'textarea') {
+    return (
+      <>
+        <TextArea
+          rows={6}
+          name={name}
+          id={fieldId ?? `id-${name}`}
+          value={value ?? ''}
+          onChange={(_, newValue) => setValue(name, newValue)}
+          isRequired={required}
+          isDisabled={isLoading || isDisabled}
+          type={type}
+          validated={fieldValidated}
+          placeholder={placeholder}
+        />
+        <ValidationComponent localValidated={fieldValidated} errMsg={errMsg} />
+      </>
+    );
+  } else if (options.length !== 0) {
+    return (
+      <>
+        <AutocompleteInput
+          options={options}
+          selected={value ?? ''}
+          onSelect={newValue => setValue(name, newValue)}
+          onChange={() => requiredValidate()}
+          name={name}
+          placeholder={placeholder}
+          validationStatus={fieldValidated}
+          validationMsg={errMsg}
+          fieldId={fieldId}
+        />
+      </>
+    );
+  }
+  return (
+    <>
+      {name === 'password' && (isDisabled || disabled) ? (
+        <Grid hasGutter={false}>
+          <GridItem span={11}>
+            <TextInput
+              name={name}
+              value={value ?? ''}
+              id={fieldId ?? `id-${name}`}
+              onChange={localHandler}
+              isDisabled={isLoading || isDisabled}
+              isRequired={required}
+              type={type}
+              validated={fieldValidated}
+              placeholder={placeholder}
+              onBlur={requiredValidate}
+              autoComplete="off"
+            />
+          </GridItem>
+          <GridItem span={1}>
+            <Button
+              ouiaId={`reset-${name}`}
+              onClick={() => setIsDisabled(false)}
+              variant="control"
+              icon={<PencilAltIcon />}
+            />
+          </GridItem>
+        </Grid>
+      ) : (
+        <TextInput
+          name={name}
+          value={value ?? ''}
+          id={fieldId ?? `id-${name}`}
+          onChange={localHandler}
+          isDisabled={isLoading || isDisabled}
+          isRequired={required}
+          type={type}
+          validated={fieldValidated}
+          placeholder={placeholder}
+          onBlur={requiredValidate}
+          autoComplete={type === 'password' ? 'new-password' : null}
+        />
+      )}
+
+      <ValidationComponent localValidated={fieldValidated} errMsg={errMsg} />
+    </>
+  );
+};
+
+const ValidationComponent = ({ localValidated, errMsg }) => (
+  <>
+    {localValidated === 'error' && (
+      <FormHelperText>
+        <HelperText>
+          <HelperTextItem
+            icon={
+              <Icon>
+                <ExclamationCircleIcon />
+              </Icon>
+            }
+            variant={localValidated}
+          >
+            {errMsg ?? __('Field is required')}
+          </HelperTextItem>
+        </HelperText>
+      </FormHelperText>
+    )}
+  </>
+);
+
+const FieldConstructor = ({
+  label,
+  value,
+  required,
+  labelHelp,
+  fieldId,
+  name,
+  ...props
+}) => (
+  <FormGroup
+    isInline
+    fieldId={fieldId ?? `id-${name}`}
+    label={label}
+    isRequired={required}
+    labelIcon={
+      labelHelp ? (
+        <Popover
+          bodyContent={
+            typeof labelHelp === 'string' ? (
+              <div dangerouslySetInnerHTML={{ __html: labelHelp }} />
+            ) : (
+              labelHelp
+            )
+          }
+        >
+          <Button
+            ouiaId={`label-${label}`}
+            type="button"
+            variant="plain"
+            onClick={e => e.preventDefault()}
+          >
+            <Icon>
+              <HelpIcon />
+            </Icon>
+          </Button>
+        </Popover>
+      ) : (
+        ''
+      )
+    }
+  >
+    <FormField
+      value={value}
+      required={required}
+      name={name}
+      {...props}
+      fieldId={fieldId}
+    />
+  </FormGroup>
+);
+
+FieldConstructor.propTypes = {
+  label: PropTypes.string.isRequired,
+  required: PropTypes.bool,
+  labelHelp: PropTypes.oneOfType([
+    PropTypes.string,
+    PropTypes.object,
+    PropTypes.node,
+  ]),
+  setValue: PropTypes.func.isRequired,
+  name: PropTypes.string.isRequired,
+  disabled: PropTypes.bool,
+  value: PropTypes.oneOfType([
+    PropTypes.string,
+    PropTypes.object,
+    PropTypes.bool,
+    PropTypes.number,
+  ]),
+  fieldId: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+};
+
+FieldConstructor.defaultProps = {
+  labelHelp: undefined,
+  required: false,
+  disabled: false,
+  value: '',
+  fieldId: undefined,
+};
+
+FormField.propTypes = {
+  disabled: PropTypes.bool,
+  setValue: PropTypes.func.isRequired,
+  name: PropTypes.string.isRequired,
+  type: PropTypes.string.isRequired,
+  label: PropTypes.string,
+  required: PropTypes.bool,
+  allowClear: PropTypes.bool,
+  options: PropTypes.arrayOf(
+    PropTypes.shape({
+      value: PropTypes.oneOfType([PropTypes.string, PropTypes.number])
+        .isRequired,
+      label: PropTypes.string.isRequired,
+    })
+  ),
+  isLoading: PropTypes.bool,
+  validated: PropTypes.string,
+  placeholder: PropTypes.string,
+  errMsg: PropTypes.string,
+  value: PropTypes.oneOfType([
+    PropTypes.bool,
+    PropTypes.string,
+    PropTypes.number,
+  ]),
+  fieldId: PropTypes.string,
+};
+
+FormField.defaultProps = {
+  label: '',
+  errMsg: null,
+  placeholder: '',
+  validated: 'default',
+  required: false,
+  allowClear: false,
+  options: [],
+  isLoading: false,
+  disabled: false,
+  value: '',
+  fieldId: undefined,
+};
+
+ValidationComponent.propTypes = {
+  localValidated: PropTypes.string.isRequired,
+  errMsg: PropTypes.string,
+};
+
+ValidationComponent.defaultProps = {
+  errMsg: null,
+};
+
+export default FieldConstructor;

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

@@ -1,7 +1,26 @@
-.webhook-form-tab-content {
-  padding-top: 3em;
-}
-
 .webhook-form-tab:focus {
   outline: none;
 }
+
+.pf-v5-c-form.pf-m-horizontal .webhook-form-tab {
+    .webhook-form-tab-content .pf-v5-c-form__group{
+        margin-top: var(--pf-v5-c-form--GridGap);
+        grid-template-columns: calc(var(--pf-v5-c-form--m-horizontal__group-label--md--GridColumnWidth) + 3rem) var(--pf-v5-c-form--m-horizontal__group-control--md--GridColumnWidth);
+    }
+
+    .autocomplete-input-wrapper {
+        width: 100%;
+    }
+
+    .pf-v5-c-form__group-control {
+        align-content: space-evenly;
+    }
+
+    .pf-v5-c-form__group-label {
+        text-wrap: nowrap;
+    }
+}
+#select-typeahead-listbox {
+  max-height: 400px;
+  overflow: auto;
+}