foreman_webhooks 0.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4c7f3b67cd40e7de9b5226bbee4a9bccc1b1132c1cdeb08bd2521135036c8ce
-  data.tar.gz: 9c47ea60965737999ef8ed63a036b1d58c0fe205d1f5d8df3a5a497c6816e5c0
+  metadata.gz: 7a3a4ed0dd48b24eff5ad505def967db53ce75d7fc2028931e1d2e3dd296bc82
+  data.tar.gz: 4967cc533c7643041e6c7a533a4b38f2897d605dc5327b79bc80c8fa13759399
 SHA512:
-  metadata.gz: bb768c45df8d5470eb8f5bb3add9d7b7bc81ed76d4148c2216a85d61a99b62b988d3c7fa9d2152c344f61716fed0ea9083e0928f965e5ef47486dc2909897a76
-  data.tar.gz: a313ab830d249d8585c9ff90001417fc95cf6925fc58e0b01e229631d378eae936c16a0f86043e483e8b209a28ff1887ea8101c3cd390eeba0aca13ef21e1e27
+  metadata.gz: c329d395342ed2d557f8d9d8e0229a1be906b502fd4314afb308ecb1b6a535db68f3b074515ea830bfb215a3d7e78bfb02271248b1129b00c768549ee6ad1b78
+  data.tar.gz: fdb4584f33e2e1de069b5c780372280bd0e8200e7d7c80f788d4c024f2bd0f14b7c3460b607a13a021dc13f8d833fb3bc54ca1e2264e64bab933f82de4b18507

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

@@ -28,7 +28,8 @@ module Api
           param :snippet, :bool, allow_nil: true
           param :audit_comment, String, allow_nil: true
           param :locked, :bool, desc: N_('Whether or not the template is locked for editing')
-          param :default, :bool, desc: N_('Whether or not the template is added automatically to new organizations and locations')
+          param :default, :bool,
+                desc: N_('Whether or not the template is added automatically to new organizations and locations')
           param_group :taxonomies, ::Api::V2::BaseController
         end
       end
@@ -90,11 +91,6 @@ module Api
 
       private
 
-      # Overload this method to avoid using search_for method
-      def resource_scope_for_index(options = {})
-        resource_scope(options).paginate(paginate_options)
-      end
-
       def action_permission
         case params[:action]
         when 'clone', 'import'

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

@@ -5,12 +5,12 @@ module Api
     class WebhooksController < V2::BaseController
       include Api::Version2
       include ForemanWebhooks::Controller::Parameters::Webhook
-      include Foreman::Controller::TemplateImport
 
-      before_action :find_resource, only: %i[show update destroy]
+      before_action :find_resource, only: %i[show destroy]
 
       api :GET, '/webhooks/', N_('List Webhooks')
       param_group :search_and_pagination, ::Api::V2::BaseController
+      add_scoped_search_description_for(Webhook)
       def index
         @webhooks = resource_scope_for_index
       end
@@ -25,7 +25,8 @@ module Api
           param :target_url, String, required: true
           param :http_method, Webhook::ALLOWED_HTTP_METHODS
           param :http_content_type, String
-          param :event, String, required: true
+          events = Webhook.available_events.sort.map { |e| e.delete_suffix(Webhook::EVENT_POSTFIX) }
+          param :event, events, required: true
           param :webhook_template_id, :identifier
           param :enabled, :boolean
           param :verify_ssl, :boolean
@@ -33,6 +34,7 @@ module Api
           param :user, String
           param :password, String
           param :http_headers, String
+          param :proxy_authorization, :boolean, N_('Authorize with Foreman client certificate and validate smart-proxy CA from Settings')
         end
       end
 
@@ -48,6 +50,7 @@ module Api
       param :id, :identifier, required: true
       param_group :webhook, as: :update
       def update
+        @webhook = Webhook.find(params[:id])
         process_response @webhook.update(webhook_params)
       end
 
@@ -56,6 +59,11 @@ module Api
       def destroy
         process_response @webhook.destroy
       end
+
+      api :GET, '/webhooks/events', N_('List available events for subscription')
+      def events
+        render json: Webhook.available_events.sort.map { |e| e.delete_suffix(Webhook::EVENT_POSTFIX) }.to_json
+      end
     end
   end
 end

data/app/controllers/concerns/foreman_webhooks/controller/parameters/webhook.rb

@@ -20,12 +20,14 @@ module ForemanWebhooks
                             :ssl_ca_certs,
                             :user,
                             :password,
-                            :http_headers
+                            :http_headers,
+                            :proxy_authorization
             end
           end
         end
 
         def webhook_params
+          params['webhook']['event'] = params['event'] unless params['event'].blank?
           self.class.webhook_params_filter.filter_params(params, parameter_filter_context)
         end
       end

data/app/controllers/webhooks_controller.rb

@@ -4,30 +4,7 @@ class WebhooksController < ::ApplicationController
   include ForemanWebhooks::Controller::Parameters::Webhook
   include Foreman::Controller::AutoCompleteSearch
 
-  before_action :find_resource, only: %i[edit update destroy]
-
-  def new
-    @webhook = Webhook.new
-  end
-
-  def create
-    @webhook = Webhook.new(webhook_params)
-    if @webhook.save
-      process_success success_redirect: '/webhooks'
-    else
-      process_error
-    end
-  end
-
-  def edit; end
-
-  def update
-    if @webhook.update(webhook_params)
-      process_success success_redirect: '/webhooks'
-    else
-      process_error
-    end
-  end
+  before_action :find_resource, only: %i[destroy]
 
   def destroy
     if @webhook.destroy

data/app/lib/foreman_webhooks/renderer/scope/webhook_template.rb

@@ -24,7 +24,9 @@ module ForemanWebhooks
           required :hash, Hash, 'Key=value object with with data that should be present in payload'
           keyword :with_defaults, [true, false], 'If set to true, adds default entries to the payload', default: true
           returns String, 'JSON string with the final payload'
-          example 'payload({ id: @object.id, name: @object.name }) #=> "{ "id": 1, "name": "host.example.com", "context": { ... }, "event_name": "host_created.event.foreman" }"'
+          example 'payload({ id: @object.id, name: @object.name }) #=> ' \
+                  '"{ "id": 1, "name": "host.example.com", "context": { ... }, ' \
+                  '"event_name": "host_created.event.foreman" }"'
         end
         def payload(hash, with_defaults: true)
           hash.merge!(@defaults) if with_defaults

data/app/models/concerns/foreman_webhooks/taxonomy_extensions.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ForemanWebhooks
+  module TaxonomyExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :webhook_templates, -> { where(type: 'WebhookTemplate') }, through: :taxable_taxonomies, source: :taxable, source_type: 'WebhookTemplate'
+    end
+  end
+end

data/app/models/webhook.rb

@@ -11,15 +11,6 @@ class Webhook < ApplicationRecord
 
   EVENT_POSTFIX = ".#{Foreman::Observable::DEFAULT_NAMESPACE}"
 
-  EVENT_ALLOWLIST = %w[
-    host_created host_updated host_destroyed
-    hostgroup_created hostgroup_updated hostgroup_destroyed
-    user_created user_updated user_destroyed
-    domain_created domain_updated domain_destroyed
-    subnet_created subnet_updated subnet_destroyed
-    build_entered build_exited status_changed
-  ].map { |e| e + EVENT_POSTFIX }.freeze
-
   DEFAULT_PAYLOAD_TEMPLATE = 'Webhook Template - Payload Default'
 
   ALLOWED_HTTP_METHODS = %w[POST GET PUT DELETE PATCH].freeze
@@ -47,7 +38,7 @@ class Webhook < ApplicationRecord
   scoped_search on: :enabled, complete_value: { true: true, false: false }
 
   def self.available_events
-    ::Foreman::EventSubscribers.all_observable_events & EVENT_ALLOWLIST
+    ::Foreman::EventSubscribers.all_observable_events
   end
 
   def self.deliver(event_name:, payload:)

data/app/services/foreman_webhooks/webhook_service.rb

@@ -14,6 +14,22 @@ module ForemanWebhooks
       @rendered_url = url
     end
 
+    def foreman_ssl_auth_params
+      cert         = Setting[:ssl_certificate]
+      ca_cert      = Setting[:ssl_ca_file]
+      hostprivkey  = Setting[:ssl_priv_key]
+
+      {
+        cert: OpenSSL::X509::Certificate.new(File.read(cert)),
+        key: OpenSSL::PKey::RSA.new(File.read(hostprivkey)),
+        ca_file: ca_cert
+      }
+    rescue StandardError => e
+      msg = 'Unable to read SSL proxy CA, cert or key'
+      Foreman::Logging.exception(msg, e)
+      raise Foreman::WrappedException.new(e, msg)
+    end
+
     def execute
       logger.info("Performing '#{webhook.name}' webhook request for event '#{event_name}'")
       Foreman::Logging.blob("Payload for '#{event_name}'", payload)
@@ -25,15 +41,28 @@ module ForemanWebhooks
         logger.debug("Headers: #{rendered_headers}")
       end
 
-      response = self.class.request(url: webhook.target_url,
+      verify = webhook.verify_ssl?
+      ca_string = webhook.ca_certs_store
+      if webhook.proxy_authorization
+        foreman_ssl = foreman_ssl_auth_params
+        verify = true
+        ca_file = foreman_ssl[:ca_file]
+        cert = foreman_ssl[:cert]
+        key = foreman_ssl[:key]
+      end
+
+      response = self.class.request(url: rendered_url,
                                     payload: payload,
                                     http_method: webhook.http_method,
                                     user: webhook.user,
                                     password: webhook.password,
                                     content_type: webhook.http_content_type,
                                     headers: headers,
-                                    ca_verify: webhook.verify_ssl?,
-                                    ca_string: webhook.ca_certs_store,
+                                    ca_verify: verify,
+                                    ca_string: ca_string,
+                                    ca_file: ca_file,
+                                    cert: cert,
+                                    key: key,
                                     follow_redirects: true)
 
       status = case response.code.to_i
@@ -50,7 +79,8 @@ module ForemanWebhooks
         message: response.message,
         http_status: response.code.to_i
       }
-    rescue SocketError, OpenSSL::SSL::SSLError, Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::EHOSTUNREACH, Net::OpenTimeout, Net::ReadTimeout => e
+    rescue SocketError, OpenSSL::SSL::SSLError, Errno::ECONNREFUSED, Errno::ECONNRESET,
+           Errno::EHOSTUNREACH, Net::OpenTimeout, Net::ReadTimeout => e
       Foreman::Logging.exception("Failed to execute the webhook #{webhook.name} -> #{event_name}", e)
       {
         status: :error,
@@ -58,16 +88,19 @@ module ForemanWebhooks
       }
     end
 
-    def self.request(url:, payload: '', http_method: :GET, user: nil, password: nil, content_type: 'application/json', headers: {}, ca_string: nil, ca_verify: false, follow_redirects: true, redirect_limit: 3)
+    def self.request(url:, payload: '', http_method: :GET, user: nil, password: nil,
+                     content_type: 'application/json', headers: {}, ca_string: nil,
+                     ca_file: nil, cert: nil, key: nil,
+                     ca_verify: false, follow_redirects: true, redirect_limit: 3)
       uri = URI.parse(url)
 
       request = Object.const_get("Net::HTTP::#{http_method.to_s.capitalize}").new(uri.request_uri)
-      request.basic_auth(user, password) if user && password
+      request.basic_auth(user, password) if !user.blank? && !password.blank?
       request['Content-Type'] = content_type
       request['X-Request-Id'] = ::Logging.mdc['request'] || SecureRandom.uuid
       request['X-Session-Id'] = ::Logging.mdc['session'] || SecureRandom.uuid
-      headers.each_pair do |key, value|
-        request[key.to_s] = value.to_s
+      headers.each_pair do |hkey, value|
+        request[hkey.to_s] = value.to_s
       end
       request.body = payload
 
@@ -83,14 +116,19 @@ module ForemanWebhooks
         http.use_ssl = true
         http.verify_mode = ca_verify ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
         http.cert_store = ca_string if ca_string
+        http.ca_file = ca_file if ca_file
+        http.cert = cert if cert
+        http.key = key if key
       end
       http.request(request) do |response|
         case response
-        when Net::HTTPRedirection then
+        when Net::HTTPRedirection
           new_location = response['location']
           Rails.logger.debug "Redirected to #{new_location} (redirects left: #{redirect_limit})"
-          raise(::Foreman::Exception, N_(format('Too many HTTP redirects when calling %{uri}', uri: uri, code: response.code))) if redirect_limit <= 0
-
+          if redirect_limit <= 0
+            raise(::Foreman::Exception,
+                  N_(format('Too many HTTP redirects when calling %{uri}', uri: uri, code: response.code)))
+          end
           self.request(url: new_location,
                        payload: payload,
                        http_method: http_method,

data/app/views/api/v2/webhooks/show.json.rabl

@@ -10,7 +10,9 @@ attributes :target_url,
            :http_content_type,
            :enabled,
            :verify_ssl,
-           :http_headers
+           :http_headers,
+           :ssl_ca_certs,
+           :user
 
 child :webhook_template do
   extends 'api/v2/webhook_templates/base'

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

@@ -0,0 +1,16 @@
+<%#
+name: Katello Content View
+description: Example payload for content_view_*.event.foreman
+snippet: false
+model: WebhookTemplate
+-%>
+#
+# Example webhook template, @object carries Action instance.
+# For more information about available helpers visit /templates_doc
+#
+# Content view id <%= @object.id %>
+# Content view name <%= @object.name %>
+# Content view label <%= @object.label %>
+# Organization id <%= @object.organization.id %>
+# Organization name <%= @object.organization.name %>
+# Organization label <%= @object.organization.label %>

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

@@ -0,0 +1,23 @@
+<%#
+name: Katello Promote
+description: Example payload for actions.katello.content_view.promote_suceeded
+snippet: false
+model: WebhookTemplate
+-%>
+#
+# Example webhook template, @object carries Action instance.
+# For more information about available helpers visit /templates_doc
+#
+# Environments <%= @object.environments %>
+# Content view ID <%= @object.content_view_id %>
+# Content view name <%= @object.content_view_name %>
+# Content view label <%= @object.content_view_label %>
+# Organization id <%= @object.organization_id %>
+# Organization name <%= @object.organization_name %>
+# Organization label <%= @object.organization_label %>
+# Task label <%= @object.task.label %>
+# Task started at <%= @object.task.started_at %>
+# Task ended at <%= @object.task.ended_at %>
+# Task resulted with <%= @object.task.result %>
+# Task state <%= @object.task.state %>
+# Task action output <%= @object.task.action_output %>

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

@@ -0,0 +1,24 @@
+<%#
+name: Katello Publish
+description: Example payload for actions.katello.content_view.publish_suceeded
+snippet: false
+model: WebhookTemplate
+-%>
+#
+# Example webhook template, @object carries Action instance.
+# For more information about available helpers visit /templates_doc
+#
+# Content view version id <%= @object.content_view_version_id %>
+# Content view version name <%= @object.content_view_version_name %>
+# Content view id <%= @object.content_view_id %>
+# Content view name <%= @object.content_view_name %>
+# Content view label <%= @object.content_view_label %>
+# Organization id <%= @object.organization_id %>
+# Organization name <%= @object.organization_name %>
+# Organization label <%= @object.organization_label %>
+# Task label <%= @object.task.label %>
+# Task started at <%= @object.task.started_at %>
+# Task ended at <%= @object.task.ended_at %>
+# Task resulted with <%= @object.task.result %>
+# Task state <%= @object.task.state %>
+# Task action output <%= @object.task.action_output %>

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

@@ -0,0 +1,27 @@
+<%#
+name: Katello Sync
+description: Example payload for actions.katello.repository.sync_succeeded
+snippet: false
+model: WebhookTemplate
+-%>
+#
+# Example webhook template, @object carries Action instance.
+# For more information about available helpers visit /templates_doc
+#
+# Repository id <%= @object.repository_id %>
+# Repository name <%= @object.repository_name %>
+# Repository label <%= @object.repository_label %>
+# Repository contents_changed <%= @object.contents_changed %>
+# Repository sync_result <%= @object.sync_result %>
+# Product id <%= @object.product_id %>
+# Product name <%= @object.product_name %>
+# Product label <%= @object.product_label %>
+# Organization id <%= @object.organization_id %>
+# Organization name <%= @object.organization_name %>
+# Organization label <%= @object.organization_label %>
+# Task label <%= @object.task.label %>
+# Task started at <%= @object.task.started_at %>
+# Task ended at <%= @object.task.ended_at %>
+# Task resulted with <%= @object.task.result %>
+# Task state <%= @object.task.state %>
+# Task action output <%= @object.task.action_output %>

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

@@ -0,0 +1,20 @@
+<%#
+name: Remote Execution Host Job
+description: Example payload for actions.remote_execution.run_host_job_succeeded
+snippet: false
+model: WebhookTemplate
+-%>
+#
+# Example webhook template, @object carries Action instance.
+# For more information about available helpers visit /templates_doc
+#
+# Run job host name <%= @object.host_name %>
+# Run job host id <%= @object.host_id %>
+# Run job full host object <%= @object.host %>
+# Run job job_invocation_id <%= @object.job_invocation_id %>
+# Run job job_invocation <%= @object.job_invocation %>
+# Task label <%= @object.task.label %>
+# Task started at <%= @object.task.started_at %>
+# Task ended at <%= @object.task.ended_at %>
+# Task resulted with <%= @object.task.result %>
+# Task state <%= @object.task.state %>

data/config/routes.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 Rails.application.routes.draw do
-  resources :webhooks, except: %i[index show] do
+  resources :webhooks, except: %i[index show new edit update] do
     collection do
       get 'auto_complete_search'
     end
@@ -14,7 +14,11 @@ Rails.application.routes.draw do
           defaults: { apiv: 'v2' },
           apiv: /v1|v2/,
           constraints: ApiConstraints.new(version: 2, default: true) do
-      resources :webhooks, only: %i[index show create update destroy]
+      resources :webhooks, only: %i[index show create update destroy] do
+        collection do
+          get :events
+        end
+      end
       resources :webhook_templates, except: %i[new edit] do
         member do
           post :clone