foreman_webhooks 3.1.1 → 3.2.0

data/app/controllers/api/v2/webhooks_controller.rb

@@ -6,7 +6,7 @@ module Api
       include Api::Version2
       include ForemanWebhooks::Controller::Parameters::Webhook
 
-      before_action :find_resource, only: %i[show destroy]
+      before_action :find_resource, only: %i[show destroy test]
 
       api :GET, '/webhooks/', N_('List Webhooks')
       param_group :search_and_pagination, ::Api::V2::BaseController
@@ -70,6 +70,29 @@ module Api
       def events
         render json: Webhook.available_events.sort.map { |e| e.delete_suffix(Webhook::EVENT_POSTFIX) }.to_json
       end
+
+      api :POST, '/webhooks/:id/test', N_('Test a Webhook')
+      param :id, :identifier, required: true
+      param :payload, String, N_('Test payload will be sent as is. Cant be a JSON object')
+      def test
+        result = @webhook.test(payload: params[:payload])
+        if result[:status] == :success
+          respond_with @webhook, responder: ApiResponder, status: :ok
+        else
+          render_error('custom_error', status: :unprocessable_entity, locals: { message: result[:message] })
+        end
+      end
+
+      private
+
+      def action_permission
+        case params[:action]
+        when 'test'
+          'edit'
+        else
+          super
+        end
+      end
     end
   end
 end

data/app/graphql/foreman_webhooks/types/webhook.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ForemanWebhooks
+  module Types
+    class Webhook < ::Types::BaseObject
+      model_class ::Webhook
+
+      description 'A Webhook'
+
+      global_id_field :id
+      timestamps
+      field :name, String
+      field :events, [String]
+      field :target_url, String
+      field :http_method, String
+      field :http_content_type, String
+      field :enabled, Boolean
+      field :verify_ssl, Boolean
+      field :ssl_ca_certs, String
+      field :user, String
+
+      belongs_to :webhook_template, Types::WebhookTemplate
+    end
+  end
+end

data/app/graphql/foreman_webhooks/types/webhook_template.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ForemanWebhooks
+  module Types
+    class WebhookTemplate < ::Types::BaseObject
+      model_class ::WebhookTemplate
+
+      description 'A Webhook Template'
+
+      global_id_field :id
+      timestamps
+      field :name, String
+      field :template, String
+      field :vendor, String
+      field :type, String
+      field :os_family, String
+      field :description, String
+      field :snippet, Boolean
+      field :locked, Boolean
+      field :default, Boolean
+
+      has_many :webhooks, Types::Webhook
+    end
+  end
+end

data/app/models/webhook.rb

@@ -9,6 +9,8 @@ class Webhook < ApplicationRecord
   friendly_id :name
   include Parameterizable::ByIdName
 
+  graphql_type 'ForemanWebhooks::Types::Webhook'
+
   EVENT_POSTFIX = ".#{Foreman::Observable::DEFAULT_NAMESPACE}"
 
   DEFAULT_PAYLOAD_TEMPLATE = 'Webhook Template - Payload Default'
@@ -77,6 +79,16 @@ class Webhook < ApplicationRecord
     )
   end
 
+  def test(payload: nil)
+    ForemanWebhooks::WebhookService.new(
+      webhook: self,
+      headers: rendered_headers(event, {}),
+      url: rendered_targed_url(event, {}),
+      event_name: event,
+      payload: test_payload(payload || '')
+    ).execute
+  end
+
   def ca_certs_store
     store = OpenSSL::X509::Store.new
     if ssl_ca_certs.blank?
@@ -132,4 +144,10 @@ class Webhook < ApplicationRecord
     source = Foreman::Renderer::Source::String.new(name: 'HTTP target URL template', content: target_url)
     render_source(source, event_name, payload)
   end
+
+  def test_payload(payload)
+    return payload if payload.is_a?(String)
+
+    payload.to_json
+  end
 end

data/app/models/webhook_template.rb

@@ -8,6 +8,8 @@ class WebhookTemplate < Template
   friendly_id :name
   include Parameterizable::ByIdName
 
+  graphql_type 'ForemanWebhooks::Types::WebhookTemplate'
+
   class << self
     # we have to override the base_class because polymorphic associations does not detect it correctly, more details at
     # http://apidock.com/rails/ActiveRecord/Associations/ClassMethods/has_many#1010-Polymorphic-has-many-within-inherited-class-gotcha

data/app/services/foreman_webhooks/webhook_service.rb

@@ -21,7 +21,7 @@ module ForemanWebhooks
 
       {
         cert: OpenSSL::X509::Certificate.new(File.read(cert)),
-        key: OpenSSL::PKey::RSA.new(File.read(hostprivkey)),
+        key: OpenSSL::PKey.read(File.read(hostprivkey)),
         ca_file: ca_cert
       }
     rescue StandardError => e

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

@@ -20,3 +20,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/app/views/foreman_webhooks/webhook_templates/katello_-_publish.erb

@@ -21,3 +21,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/app/views/foreman_webhooks/webhook_templates/katello_-_repo_sync.erb

@@ -24,3 +24,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/app/views/foreman_webhooks/webhook_templates/remote_execution_-_host_job.erb

@@ -18,4 +18,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/config/routes.rb

@@ -18,6 +18,9 @@ Rails.application.routes.draw do
         collection do
           get :events
         end
+        member do
+          post :test
+        end
       end
       resources :webhook_templates, except: %i[new edit] do
         member do

data/lib/foreman_webhooks/engine.rb

@@ -15,7 +15,8 @@ module ForemanWebhooks
 
     initializer 'foreman_webhooks.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_webhooks do
-        requires_foreman '>= 3.3'
+        requires_foreman '>= 3.7'
+        register_gettext
 
         apipie_documented_controllers ["#{ForemanWebhooks::Engine.root}/app/controllers/api/v2/*.rb"]
         ApipieDSL.configuration.sections += ['webhooks']
@@ -32,7 +33,7 @@ module ForemanWebhooks
           permission :create_webhooks,  { webhooks: %i[new create],
                                           'api/v2/webhooks': [:create] }, resource_type: 'Webhook'
           permission :edit_webhooks,    { webhooks: %i[edit update],
-                                          'api/v2/webhooks': [:update] }, resource_type: 'Webhook'
+                                          'api/v2/webhooks': %i[update test] }, resource_type: 'Webhook'
           permission :destroy_webhooks, { webhooks: [:destroy],
                                           'api/v2/webhooks': [:destroy] }, resource_type: 'Webhook'
           permission :view_webhook_templates, { webhook_templates: %i[index show auto_complete_search preview export],
@@ -76,6 +77,12 @@ module ForemanWebhooks
 
         # subscribe to all events
         subscribe(/.event.foreman$/, ::ForemanWebhooks::EventSubscriber)
+
+        register_graphql_query_field :webhook, 'ForemanWebhooks::Types::Webhook', :record_field
+        register_graphql_query_field :webhooks, 'ForemanWebhooks::Types::Webhook', :collection_field
+
+        register_graphql_query_field :webhook_template, 'ForemanWebhooks::Types::WebhookTemplate', :record_field
+        register_graphql_query_field :webhook_templates, 'ForemanWebhooks::Types::WebhookTemplate', :collection_field
       end
     end
 

data/lib/foreman_webhooks/version.rb

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

data/locale/ca/foreman_webhooks.po

@@ -0,0 +1,237 @@
+# 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:
+# Robert Antoni Buj i Gelonch <rbuj@fedoraproject.org>, 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: Robert Antoni Buj i Gelonch <rbuj@fedoraproject.org>, 2023\n"
+"Language-Team: Catalan (https://app.transifex.com/foreman/teams/114/ca/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: ca\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+msgid "Actions"
+msgstr "Accions"
+
+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 "Suprimeix"
+
+msgid "Delete a Webhook"
+msgstr ""
+
+msgid "Delete a webhook template"
+msgstr ""
+
+msgid "Deliver webhook"
+msgstr ""
+
+msgid "Deliver webhook %s"
+msgstr ""
+
+msgid "Edit"
+msgstr "Edita"
+
+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 "General"
+
+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 "Nom"
+
+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 "Tipus"
+
+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 "Usuari"
+
+msgid "Verify SSL"
+msgstr ""
+
+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/locale/cs_CZ/foreman_webhooks.po

@@ -0,0 +1,240 @@
+# 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:
+# mhulan <mhulan@redhat.com>, 2023
+# Pavel Borecki <pavel.borecki@gmail.com>, 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: Pavel Borecki <pavel.borecki@gmail.com>, 2023\n"
+"Language-Team: Czech (Czech Republic) (https://app.transifex.com/foreman/teams"
+"/114/cs_CZ/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: cs_CZ\n"
+"Plural-Forms: nplurals=4; plural=(n == 1 && n % 1 == 0) ? 0 : (n >= 2 && n <= "
+"4 && n % 1 == 0) ? 1: (n % 1 != 0 ) ? 2 : 3;\n"
+
+msgid "Actions"
+msgstr "Akce"
+
+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 "Přihlašovací údaje"
+
+msgid "Delete"
+msgstr "Smazat"
+
+msgid "Delete a Webhook"
+msgstr ""
+
+msgid "Delete a webhook template"
+msgstr ""
+
+msgid "Deliver webhook"
+msgstr ""
+
+msgid "Deliver webhook %s"
+msgstr ""
+
+msgid "Edit"
+msgstr "Upravit"
+
+msgid "Edit %s"
+msgstr ""
+
+msgid "Enabled"
+msgstr "Zapnuto"
+
+msgid "Error"
+msgstr "Chyba"
+
+msgid "Example: %s"
+msgstr ""
+
+msgid "Export a webhook template to ERB"
+msgstr ""
+
+msgid "General"
+msgstr "Obecné"
+
+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 "Název"
+
+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 "Typ"
+
+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 "Uživatel"
+
+msgid "Verify SSL"
+msgstr "Ověřit 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 "X509 certifikační autority"
+
+msgid "X509 Certification Authorities concatenated in PEM format"
+msgstr ""
+
+msgid "You are about to delete %s. Are you sure?"
+msgstr ""
+
+msgid "is required"
+msgstr ""