foreman_webhooks 3.2.0 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15d1cac404f1ebab4f288c3b5e59fa76ae093b45cb28450da0402ffbf17664b9
-  data.tar.gz: f9712a714395e9e4d4cad854eacf4fc28c2690411178d7af2465f140478facb3
+  metadata.gz: 457b89d953e3410524cd3ad5aee4d63ca47192037523ee2c606e69d291e0e8e2
+  data.tar.gz: 9e43a93a35c44a7e8d0d3fdcecef2f4196120645ffe9b0517fba5a3ded221620
 SHA512:
-  metadata.gz: b35bc2e5483d29e9ddecaaba94b64c82472c767b0f52aefa0cd8a87e85c717248ce84828cd567d33292c47923f464a799f1aac009d67b63905d73ac815eb48b9
-  data.tar.gz: 12c8971769812a7adbb70863ac7fe2b2e47c129fd42efda9949c82d5e08aaad7cf3a00bcfa66776f93d1f653ddfffae038a878ea10a48e798b60c2cd4c884d8b
+  metadata.gz: 7dca14e67eb8d98c5677ecdbb0e11a1a580fa9d6499f4c164aa263668a7709cee10441cd552fb4f0d2b9a74965520d0e4f29f7c311020817e70d4de3af96ca71
+  data.tar.gz: 939a492793d040c4555e73eedf6dc8a66cc4c72121addfdc3ac659ba5642599ad6960c1a3182299e0e98321d7dec52e524b52450d11d0eb5766e546e612a387c

data/app/jobs/foreman_webhooks/deliver_webhook_job.rb

@@ -6,13 +6,25 @@ module ForemanWebhooks
 
     def perform(options)
       webhook = Webhook.unscoped.find_by(id: options[:webhook_id])
-      WebhookService.new(
+      result = WebhookService.new(
         webhook: webhook,
         headers: options[:headers],
         url: options[:url],
         event_name: options[:event_name],
         payload: options[:payload]
       ).execute
+
+      return unless result[:status] == :error
+
+      raise [result[:http_status], result[:message]].compact.join(': ')
+    end
+
+    rescue_from(StandardError) do |error|
+      Foreman::Logging.logger('background').error(
+        'DeliverWebhook: '\
+        "Error while delivering - #{error.message}"
+      )
+      raise error # propagate the error to the tasking system to properly report it there
     end
 
     def webhook_id

data/app/models/webhook.rb

@@ -82,8 +82,8 @@ class Webhook < ApplicationRecord
   def test(payload: nil)
     ForemanWebhooks::WebhookService.new(
       webhook: self,
-      headers: rendered_headers(event, {}),
-      url: rendered_targed_url(event, {}),
+      headers: http_headers,
+      url: target_url,
       event_name: event,
       payload: test_payload(payload || '')
     ).execute

data/app/views/foreman_webhooks/webhook_templates/katello_-_content_view.erb

@@ -1,6 +1,6 @@
 <%#
 name: Katello Content View
-description: Example payload for content_view_*.event.foreman
+description: Example payload for actions.katello.content_view_*.event.foreman
 snippet: false
 model: WebhookTemplate
 -%>

data/app/views/foreman_webhooks/webhook_templates/katello_-_promote.erb

@@ -1,6 +1,6 @@
 <%#
 name: Katello Promote
-description: Example payload for actions.katello.content_view.promote_suceeded
+description: Example payload for actions.katello.content_view.promote_suceeded.event.foreman
 snippet: false
 model: WebhookTemplate
 -%>
@@ -20,4 +20,3 @@ model: WebhookTemplate
 # Task ended at <%= @object.task.ended_at %>
 # Task resulted with <%= @object.task.result %>
 # Task state <%= @object.task.state %>
-# Task action output <%= @object.task.action_continuous_output %>

data/app/views/foreman_webhooks/webhook_templates/katello_-_publish.erb

@@ -1,6 +1,6 @@
 <%#
 name: Katello Publish
-description: Example payload for actions.katello.content_view.publish_suceeded
+description: Example payload for actions.katello.content_view.publish_suceeded.event.foreman
 snippet: false
 model: WebhookTemplate
 -%>
@@ -21,4 +21,3 @@ model: WebhookTemplate
 # Task ended at <%= @object.task.ended_at %>
 # Task resulted with <%= @object.task.result %>
 # Task state <%= @object.task.state %>
-# Task action output <%= @object.task.action_continuous_output %>

data/app/views/foreman_webhooks/webhook_templates/katello_-_repo_sync.erb

@@ -1,6 +1,6 @@
 <%#
 name: Katello Sync
-description: Example payload for actions.katello.repository.sync_succeeded
+description: Example payload for actions.katello.repository.sync_succeeded.event.foreman
 snippet: false
 model: WebhookTemplate
 -%>
@@ -24,4 +24,3 @@ model: WebhookTemplate
 # Task ended at <%= @object.task.ended_at %>
 # Task resulted with <%= @object.task.result %>
 # Task state <%= @object.task.state %>
-# Task action output <%= @object.task.action_continuous_output %>

data/app/views/foreman_webhooks/webhook_templates/remote_execution_-_host_job.erb

@@ -1,6 +1,6 @@
 <%#
 name: Remote Execution Host Job
-description: Example payload for actions.remote_execution.run_host_job_succeeded
+description: Example payload for actions.remote_execution.run_host_job_succeeded.event.foreman
 snippet: false
 model: WebhookTemplate
 -%>
@@ -18,3 +18,4 @@ model: WebhookTemplate
 # Task ended at <%= @object.task.ended_at %>
 # Task resulted with <%= @object.task.result %>
 # Task state <%= @object.task.state %>
+# Task action output <%= @object.task.action_continuous_output %>

data/lib/foreman_webhooks/version.rb

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

data/test/jobs/foreman_webhooks/deliver_webhook_job_test.rb

@@ -10,7 +10,8 @@ module ForemanWebhooks
     end
 
     it 'executes the webhook service' do
-      ::ForemanWebhooks::WebhookService.any_instance.expects(:execute).once
+      result = { status: :success }
+      ::ForemanWebhooks::WebhookService.any_instance.expects(:execute).once.returns(result)
       job.perform_now
     end
   end

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

@@ -58,18 +58,16 @@ const WebhookTestModal = ({ toTest }) => {
       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>
+      {`${sprintf(__('You are about to test %s webhook.'), name)} `}
+      {`${__(
+        'Please, note that this will not contain actual information or render the attached template.'
+      )} `}
+      {`${__(
+        'In case you are using dynamic URL (ERB template), this will not be rendered correctly due to the absence of a real object.'
+      )} `}
+      {__('You can specify below a custom payload to test the webhook with.')}
+      <br />
+      <br />
       <ForemanForm
         onSubmit={handleSubmit}
         initialValues={initialTestValues}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_webhooks
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.2
 platform: ruby
 authors:
 - Timo Goebel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2023-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -245,7 +245,7 @@ licenses:
 - GPL-3.0
 metadata:
   is_foreman_plugin: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -260,8 +260,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Configure webhooks for Foreman.
 test_files:
@@ -269,14 +269,14 @@ test_files:
 - test/controllers/api/v2/webhooks_controller_test.rb
 - test/factories/webhook.rb
 - test/factories/webhook_template.rb
-- test/jobs/foreman_webhooks/deliver_webhook_job_test.rb
-- test/models/webhook_test.rb
-- test/test_plugin_helper.rb
-- test/unit/foreman_webhooks/webhook_service_test.rb
 - test/graphql/foreman_webhooks/queries/webhook_query_test.rb
 - test/graphql/foreman_webhooks/queries/webhook_template_query_test.rb
 - test/graphql/foreman_webhooks/queries/webhook_templates_query_test.rb
 - test/graphql/foreman_webhooks/queries/webhooks_query_test.rb
+- test/jobs/foreman_webhooks/deliver_webhook_job_test.rb
+- test/models/webhook_test.rb
+- test/test_plugin_helper.rb
+- test/unit/foreman_webhooks/webhook_service_test.rb
 - webpack/ForemanWebhooks/Routes/Webhooks/Components/WebhookForm/__tests__/WebhookForm.test.js
 - webpack/ForemanWebhooks/Routes/Webhooks/WebhooksIndexPage/Components/WebhooksTable/Components/Formatters/__tests__/enabledCellFormatter.test.js
 - webpack/ForemanWebhooks/Routes/Webhooks/WebhooksIndexPage/Components/WebhooksTable/Components/__tests__/EnabledCell.test.js