foreman_webhooks 3.1.0 → 3.2.0

data/locale/zh_TW/foreman_webhooks.po

@@ -0,0 +1,239 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the foreman_webhooks package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+# Translators:
+# Bryan Kearney <bryan.kearney@gmail.com>, 2023
+# 0868a4d1af5275b3f70b0a6dac4c99a4, 2023
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: foreman_webhooks 3.2.0\n"
+"Report-Msgid-Bugs-To: \n"
+"PO-Revision-Date: 2023-06-05 12:44+0000\n"
+"Last-Translator: 0868a4d1af5275b3f70b0a6dac4c99a4, 2023\n"
+"Language-Team: Chinese (Taiwan) (https://app.transifex.com/foreman/teams/114/z"
+"h_TW/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: zh_TW\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+
+msgid "Actions"
+msgstr "動作"
+
+msgid "Additional"
+msgstr ""
+
+msgid "Authentication credentials"
+msgstr ""
+
+msgid "Authorize with Foreman client certificate and validate smart-proxy CA from Settings"
+msgstr ""
+
+msgid "Change the password"
+msgstr ""
+
+msgid "Clone a template"
+msgstr ""
+
+msgid "Confirm Webhook Deletion"
+msgstr ""
+
+msgid "Create Template"
+msgstr ""
+
+msgid "Create Webhook"
+msgstr ""
+
+msgid "Create a Webhook"
+msgstr ""
+
+msgid "Create a webhook template"
+msgstr ""
+
+msgid "Credentials"
+msgstr ""
+
+msgid "Delete"
+msgstr "刪除"
+
+msgid "Delete a Webhook"
+msgstr ""
+
+msgid "Delete a webhook template"
+msgstr ""
+
+msgid "Deliver webhook"
+msgstr ""
+
+msgid "Deliver webhook %s"
+msgstr ""
+
+msgid "Edit"
+msgstr "編輯"
+
+msgid "Edit %s"
+msgstr ""
+
+msgid "Enabled"
+msgstr ""
+
+msgid "Error"
+msgstr ""
+
+msgid "Example: %s"
+msgstr ""
+
+msgid "Export a webhook template to ERB"
+msgstr ""
+
+msgid "General"
+msgstr "一般"
+
+msgid "HTTP Content Type"
+msgstr ""
+
+msgid "HTTP Headers"
+msgstr ""
+
+msgid "HTTP Method"
+msgstr ""
+
+msgid "If unchecked, the webhook will be inactive"
+msgstr ""
+
+msgid "Import a webhook template"
+msgstr ""
+
+msgid "List Webhooks"
+msgstr ""
+
+msgid "List available events for subscription"
+msgstr ""
+
+msgid "List webhook templates"
+msgstr ""
+
+msgid "Name"
+msgstr "名稱"
+
+msgid "No Results"
+msgstr ""
+
+msgid "Optional CAs in PEM format concatenated to verify the receiver's SSL certificate"
+msgstr ""
+
+msgid "Optional. Must be a JSON object (ERB allowed)"
+msgstr ""
+
+msgid "Password"
+msgstr ""
+
+msgid "Proxy Authorization"
+msgstr ""
+
+msgid "Show Webhook details"
+msgstr ""
+
+msgid "Show webhook template details"
+msgstr ""
+
+msgid "Snippet"
+msgstr ""
+
+msgid "Start typing to search"
+msgstr ""
+
+msgid "Subscribe to"
+msgstr ""
+
+msgid "Target URL"
+msgstr ""
+
+msgid "Target URL that should be called by Foreman (ERB allowed)."
+msgstr ""
+
+msgid "Template"
+msgstr ""
+
+msgid "Template contents including metadata"
+msgstr ""
+
+msgid "Template name"
+msgstr ""
+
+msgid "This template is locked for editing."
+msgstr ""
+
+msgid "Try to create a new webhook"
+msgstr ""
+
+msgid "Type"
+msgstr "類型"
+
+msgid "URL must be valid and schema must be one of: %s"
+msgstr ""
+
+msgid "Uncheck this option to disable validation of the receiver's SSL certificate"
+msgstr ""
+
+msgid "Update a Webhook"
+msgstr ""
+
+msgid "Update a webhook template"
+msgstr ""
+
+msgid "User"
+msgstr "使用者"
+
+msgid "Verify SSL"
+msgstr "驗證 SSL"
+
+msgid "Webhook"
+msgstr ""
+
+msgid "Webhook %s was successfully deleted"
+msgstr ""
+
+msgid "Webhook Templates"
+msgstr ""
+
+msgid "Webhook was successfully created."
+msgstr ""
+
+msgid "Webhook was successfully updated."
+msgstr ""
+
+msgid "WebhookTemplate|Locked"
+msgstr ""
+
+msgid "WebhookTemplate|Name"
+msgstr ""
+
+msgid "WebhookTemplate|Snippet"
+msgstr ""
+
+msgid "Webhooks"
+msgstr ""
+
+msgid "Whether or not the template is added automatically to new organizations and locations"
+msgstr ""
+
+msgid "Whether or not the template is locked for editing"
+msgstr ""
+
+msgid "X509 Certification Authorities"
+msgstr ""
+
+msgid "X509 Certification Authorities concatenated in PEM format"
+msgstr ""
+
+msgid "You are about to delete %s. Are you sure?"
+msgstr ""
+
+msgid "is required"
+msgstr ""

data/package.json

@@ -9,8 +9,6 @@
     "test:watch": "tfm-test --plugin --watchAll",
     "test:current": "tfm-test --plugin --watch",
     "publish-coverage": "tfm-publish-coverage",
-    "stories": "tfm-stories --plugin",
-    "stories:build": "tfm-build-stories --plugin",
     "create-react-component": "yo react-domain"
   },
   "repository": {
@@ -26,7 +24,6 @@
   "devDependencies": {
     "@babel/core": "^7.7.0",
     "@theforeman/builder": ">= 0",
-    "@theforeman/stories": ">= 0",
     "@theforeman/test": ">= 0",
     "@theforeman/vendor-dev": ">= 0",
     "@theforeman/eslint-plugin-foreman": ">= 0",

data/test/factories/webhook_template.rb

@@ -12,5 +12,15 @@ FactoryBot.define do
     trait :locked do
       locked { true }
     end
+
+    trait :with_webhooks do
+      transient do
+        webhooks_count { 2 }
+      end
+
+      after(:create) do |webhook_template, evaluator|
+        create_list(:webhook, evaluator.webhooks_count, webhook_template: webhook_template)
+      end
+    end
   end
 end

data/test/graphql/foreman_webhooks/queries/webhook_query_test.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+module ForemanWebhooks
+  module Queries
+    class WebhookQueryTest < GraphQLQueryTestCase
+      let(:query) do
+        <<-GRAPHQL
+        query (
+          $id: String!
+        ) {
+          webhook(id: $id) {
+            id
+            createdAt
+            updatedAt
+            name
+            targetUrl
+            events
+            httpMethod
+            httpContentType
+            enabled
+            verifySsl
+            sslCaCerts
+            user
+            webhookTemplate {
+              id
+            }
+          }
+        }
+        GRAPHQL
+      end
+
+      let(:webhook) { FactoryBot.create(:webhook) }
+      let(:global_id) { Foreman::GlobalId.for(webhook) }
+      let(:variables) { { id: global_id } }
+      let(:data) { result['data']['webhook'] }
+
+      test 'fetching webhook attributes' do
+        assert_empty result['errors']
+
+        assert_equal global_id, data['id']
+        assert_equal webhook.created_at.utc.iso8601, data['createdAt']
+        assert_equal webhook.updated_at.utc.iso8601, data['updatedAt']
+        assert_equal webhook.name, data['name']
+        assert_equal webhook.target_url, data['targetUrl']
+        assert_equal webhook.events, data['events']
+        assert_equal webhook.http_method, data['httpMethod']
+        assert_equal webhook.http_content_type, data['httpContentType']
+        assert_equal webhook.enabled, data['enabled']
+        assert_equal webhook.verify_ssl, data['verifySsl']
+        assert_equal webhook.ssl_ca_certs, data['sslCaCerts']
+        assert_equal webhook.user, data['user']
+
+        assert_record webhook.webhook_template, data['webhookTemplate']
+      end
+    end
+  end
+end

data/test/graphql/foreman_webhooks/queries/webhook_template_query_test.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+module ForemanWebhooks
+  module Queries
+    class WebhookTemplateQueryTest < GraphQLQueryTestCase
+      let(:query) do
+        <<-GRAPHQL
+        query (
+          $id: String!
+        ) {
+          webhookTemplate(id: $id) {
+            id
+            createdAt
+            updatedAt
+            name
+            template
+            vendor
+            type
+            osFamily
+            description
+            snippet
+            locked
+            default
+            webhooks {
+              totalCount
+              edges {
+                node {
+                  id
+                }
+              }
+            }
+          }
+        }
+        GRAPHQL
+      end
+
+      let(:webhook_template) { FactoryBot.create(:webhook_template, :with_webhooks) }
+      let(:global_id) { Foreman::GlobalId.for(webhook_template) }
+      let(:variables) { { id: global_id } }
+      let(:data) { result['data']['webhookTemplate'] }
+
+      test 'fetching webhook template attributes' do
+        assert_empty result['errors']
+
+        assert_equal global_id, data['id']
+        assert_equal webhook_template.created_at.utc.iso8601, data['createdAt']
+        assert_equal webhook_template.updated_at.utc.iso8601, data['updatedAt']
+        assert_equal webhook_template.name, data['name']
+        assert_equal webhook_template.template, data['template']
+        assert_equal webhook_template.vendor, data['vendor']
+        assert_equal webhook_template.type, data['type']
+        assert_equal webhook_template.os_family, data['osFamily']
+        assert_equal webhook_template.description, data['description']
+        assert_equal webhook_template.snippet, data['snippet']
+        assert_equal webhook_template.locked, data['locked']
+        assert_equal webhook_template.default, data['default']
+
+        assert_collection webhook_template.webhooks, data['webhooks']
+      end
+    end
+  end
+end

data/test/graphql/foreman_webhooks/queries/webhook_templates_query_test.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+module ForemanWebhooks
+  module Queries
+    class WebhookTemplatesQueryTest < GraphQLQueryTestCase
+      let(:query) do
+        <<-GRAPHQL
+        query {
+          webhookTemplates {
+            totalCount
+            pageInfo {
+              startCursor
+              endCursor
+              hasNextPage
+              hasPreviousPage
+            }
+            edges {
+              cursor
+              node {
+                id
+              }
+            }
+          }
+        }
+        GRAPHQL
+      end
+
+      let(:data) { result['data']['webhookTemplates'] }
+
+      setup do
+        FactoryBot.create(:webhook_template)
+      end
+
+      test 'fetching webhook templates attributes' do
+        assert_empty result['errors']
+
+        expected_count = ::WebhookTemplate.count
+
+        assert_not_equal 0, expected_count
+        assert_equal expected_count, data['totalCount']
+        assert_equal expected_count, data['edges'].count
+      end
+    end
+  end
+end

data/test/graphql/foreman_webhooks/queries/webhooks_query_test.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+module ForemanWebhooks
+  module Queries
+    class WebhooksQueryTest < GraphQLQueryTestCase
+      let(:query) do
+        <<-GRAPHQL
+        query {
+          webhooks {
+            totalCount
+            pageInfo {
+              startCursor
+              endCursor
+              hasNextPage
+              hasPreviousPage
+            }
+            edges {
+              cursor
+              node {
+                id
+              }
+            }
+          }
+        }
+        GRAPHQL
+      end
+
+      let(:data) { result['data']['webhooks'] }
+
+      setup do
+        FactoryBot.create(:webhook)
+      end
+
+      test 'fetching webhooks attributes' do
+        assert_empty result['errors']
+
+        expected_count = ::Webhook.count
+
+        assert_not_equal 0, expected_count
+        assert_equal expected_count, data['totalCount']
+        assert_equal expected_count, data['edges'].count
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import { Tabs, Tab, TabTitleText } from '@patternfly/react-core';
 
-import { translate as __ } from 'foremanReact/common/I18n';
+import { sprintf, translate as __ } from 'foremanReact/common/I18n';
 
 import ForemanFormikField from './ForemanFormikField';
 
@@ -48,7 +48,21 @@ const WebhookFormTabs = ({
           type="text"
           required
           label={__('Target URL')}
-          labelHelp={__('Target URL that should be called by Foreman')}
+          labelHelp={
+            <>
+              <div>
+                {__(
+                  'Target URL that should be called by Foreman (ERB allowed).'
+                )}
+              </div>
+              <div>
+                {sprintf(
+                  __('Example: %s'),
+                  'https://host.example.com/inventory/<%= @object.id %>'
+                )}
+              </div>
+            </>
+          }
         />
         <ForemanFormikField
           name="webhook_template_id"
@@ -137,8 +151,9 @@ const WebhookFormTabs = ({
         <ForemanFormikField
           name="http_headers"
           type="textarea"
-          label={__('Optional HTTP headers as JSON (ERB allowed)')}
-          placeholder='{\n"X-Shellhook-Arg-1": "value"\n}'
+          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}
         />

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

@@ -1,3 +1,4 @@
+import Immutable from 'seamless-immutable';
 import { STATUS } from 'foremanReact/constants';
 import { deepPropsToCamelCase } from 'foremanReact/common/helpers';
 import {
@@ -31,14 +32,12 @@ export const selectWebhookTemplates = state => {
   if (selectTemplatesHasError(state) || selectTemplatesIsLoading(state))
     return [];
 
-  return selectWebhookFormTemplatesResponse(state).results;
+  return Immutable.asMutable(selectWebhookFormTemplatesResponse(state).results);
 };
 
 // Webhook events selectors
 const selectWebhookFormEventsResponse = state =>
-  deepPropsToCamelCase(
-    selectAPIResponse(state, WEBHOOK_EVENTS_API_REQUEST_KEY)
-  );
+  selectAPIResponse(state, WEBHOOK_EVENTS_API_REQUEST_KEY);
 
 const selectWebhookFormEventsStatus = state =>
   selectAPIStatus(state, WEBHOOK_EVENTS_API_REQUEST_KEY);
@@ -54,5 +53,5 @@ export const selectEventsIsLoading = state => {
 export const selectWebhookEvents = state => {
   if (selectEventsHasError(state) || selectEventsIsLoading(state)) return [];
 
-  return selectWebhookFormEventsResponse(state);
+  return Immutable.asMutable(selectWebhookFormEventsResponse(state));
 };

data/webpack/ForemanWebhooks/Routes/Webhooks/WebhooksIndexPage/Components/WebhookTestModal.js

@@ -0,0 +1,100 @@
+import React from 'react';
+import { useDispatch } from 'react-redux';
+import PropTypes from 'prop-types';
+
+import { sprintf, translate as __ } from 'foremanReact/common/I18n';
+import ForemanModal from 'foremanReact/components/ForemanModal';
+import ForemanForm from 'foremanReact/components/common/forms/ForemanForm';
+import { foremanUrl } from 'foremanReact/common/helpers';
+import { submitForm } from 'foremanReact/redux/actions/common/forms';
+import { useForemanModal } from 'foremanReact/components/ForemanModal/ForemanModalHooks';
+
+import ForemanFormikField from '../../../Webhooks/Components/WebhookForm/Components/ForemanFormikField';
+
+import {
+  WEBHOOK_TEST_MODAL_ID,
+  WEBHOOKS_API_PLAIN_PATH,
+} from '../../constants';
+
+import './WebhookModal.scss';
+
+const WebhookTestModal = ({ toTest }) => {
+  const dispatch = useDispatch();
+
+  const { id, name } = toTest;
+  const { setModalClosed: setTestModalClosed } = useForemanModal({
+    id: WEBHOOK_TEST_MODAL_ID,
+  });
+  const initialTestValues = {
+    payload: '',
+  };
+  const errorToast = error =>
+    sprintf(
+      __('Webhook test failed: %s'),
+      error?.response?.data?.error?.message
+    );
+
+  const handleSubmit = (values, actions) => {
+    dispatch(
+      submitForm({
+        url: foremanUrl(`${WEBHOOKS_API_PLAIN_PATH}/${id}/test`),
+        values: { ...values, controller: 'webhooks' },
+        item: 'WebhookTest',
+        message: sprintf(__('Webhook %s test was successful'), name),
+        method: 'post',
+        successCallback: () => actions.setSubmitting(false),
+        actions,
+        errorToast,
+        handleError: () => actions.setSubmitting(false),
+      })
+    );
+  };
+
+  return (
+    <ForemanModal
+      id={WEBHOOK_TEST_MODAL_ID}
+      title={`${__('Test')} ${name}`}
+      backdrop="static"
+      enforceFocus
+      className="webhooks-modal"
+    >
+      <p>
+        {sprintf(
+          __(
+            'You are about to test %s webhook.' +
+              '\n' +
+              'Please, note that this will not contain actual information or render the attached template.' +
+              '\n' +
+              'You can specify below a custom payload to test the webhook with.'
+          ),
+          name
+        )}
+      </p>
+      <ForemanForm
+        onSubmit={handleSubmit}
+        initialValues={initialTestValues}
+        onCancel={setTestModalClosed}
+      >
+        <ForemanFormikField
+          name="payload"
+          type="textarea"
+          label={__('Payload')}
+          labelHelp={__('Will be sent as is')}
+          placeholder="{&#13;&#10;id: 1,&#13;&#10;name: test&#13;&#10;}"
+          inputSizeClass="col-md-8"
+          rows={8}
+        />
+      </ForemanForm>
+    </ForemanModal>
+  );
+};
+
+WebhookTestModal.propTypes = {
+  toTest: PropTypes.object,
+};
+
+WebhookTestModal.defaultProps = {
+  toTest: {},
+};
+
+export default WebhookTestModal;

data/webpack/ForemanWebhooks/Routes/Webhooks/WebhooksIndexPage/Components/WebhooksTable/Components/ActionButtons/ActionButton.js

@@ -0,0 +1,40 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { translate as __ } from 'foremanReact/common/I18n';
+import { ActionButtons } from 'foremanReact/components/common/ActionButtons/ActionButtons';
+
+export const ActionButton = ({ id, name, canDelete, webhookActions }) => {
+  const buttons = [];
+  if (canDelete) {
+    buttons.push({
+      title: __('Delete'),
+      action: {
+        onClick: () => webhookActions.deleteWebhook(id, name),
+        id: `webhook-delete-button-${id}`,
+      },
+    });
+  }
+  buttons.push({
+    title: __('Test webhook'),
+    action: {
+      onClick: () => webhookActions.testWebhook(id, name),
+      id: `webhook-test-button-${id}`,
+    },
+  });
+
+  return <ActionButtons buttons={buttons} />;
+};
+
+ActionButton.propTypes = {
+  id: PropTypes.oneOfType([PropTypes.string, PropTypes.number]).isRequired,
+  name: PropTypes.string.isRequired,
+  canDelete: PropTypes.bool,
+  webhookActions: PropTypes.shape({
+    deleteWebhook: PropTypes.func,
+    testWebhook: PropTypes.func,
+  }).isRequired,
+};
+
+ActionButton.defaultProps = {
+  canDelete: false,
+};