foreman_webhooks 0.0.1

data/app/models/webhook_template.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+class WebhookTemplate < Template
+  audited
+
+  include Authorizable
+  extend FriendlyId
+  friendly_id :name
+  include Parameterizable::ByIdName
+
+  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
+    def base_class
+      self
+    end
+  end
+  self.table_name = 'templates'
+
+  before_destroy EnsureNotUsedBy.new(:webhooks)
+  has_many :webhooks, foreign_key: :webhook_template_id
+
+  validates :name, uniqueness: true
+
+  include Taxonomix
+  scoped_search on: :name,    complete_value: true, default_order: true
+  scoped_search on: :locked,  complete_value: { true: true, false: false }
+  scoped_search on: :snippet, complete_value: { true: true, false: false }
+  scoped_search on: :template
+  scoped_search on: :default, only_explicit: true, complete_value: { true: true, false: false }
+
+  # with proc support, default_scope can no longer be chained
+  # include all default scoping here
+  default_scope lambda {
+    with_taxonomy_scope do
+      order("#{Template.table_name}.name")
+    end
+  }
+
+  def self.default_render_scope_class
+    ForemanWebhooks::Renderer::Scope::WebhookTemplate
+  end
+
+  def taxonomy_foreign_conditions
+    { webhook_template_id: id }
+  end
+
+  def self.acceptable_template_input_types
+    [:user]
+  end
+
+  def self.log_render_results?
+    true
+  end
+
+  def support_single_host_render?
+    false
+  end
+end

data/app/services/foreman_webhooks/webhook_service.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module ForemanWebhooks
+  class WebhookService
+    attr_accessor :webhook, :event_name, :payload, :rendered_headers, :rendered_url
+
+    delegate :logger, to: Rails
+
+    def initialize(webhook:, event_name:, payload:, headers:, url:)
+      @webhook = webhook
+      @event_name = event_name
+      @payload = payload
+      @rendered_headers = headers
+      @rendered_url = url
+    end
+
+    def execute
+      logger.info("Performing '#{webhook.name}' webhook request for event '#{event_name}'")
+      Foreman::Logging.blob("Payload for '#{event_name}'", payload)
+      headers = {}
+      begin
+        headers = JSON.parse(rendered_headers)
+      rescue StandardError => e
+        logger.warn("Could not parse HTTP headers JSON, ignoring: #{e}")
+        logger.debug("Headers: #{rendered_headers}")
+      end
+
+      response = self.class.request(url: webhook.target_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,
+                                    follow_redirects: true)
+
+      status = case response.code.to_i
+               when 400..599
+                 logger.error("#{webhook.http_method.to_s.upcase} response was #{response.code}")
+                 :error
+               else
+                 logger.info("#{webhook.http_method.to_s.upcase} response was #{response.code}")
+                 :success
+               end
+
+      {
+        status: status,
+        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
+      Foreman::Logging.exception("Failed to execute the webhook #{webhook.name} -> #{event_name}", e)
+      {
+        status: :error,
+        message: e.to_s
+      }
+    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)
+      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['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
+      end
+      request.body = payload
+
+      Rails.logger.debug("Webhook #{http_method.to_s.upcase} request: #{uri}")
+      Rails.logger.debug("Headers: #{request.to_hash.inspect}")
+      Rails.logger.debug("Body: #{request.body.inspect}")
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.open_timeout = Setting[:proxy_request_timeout]
+      http.read_timeout = Setting[:proxy_request_timeout]
+      http.ssl_timeout = Setting[:proxy_request_timeout]
+      if uri.scheme == 'https'
+        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
+      end
+      http.request(request) do |response|
+        case response
+        when Net::HTTPRedirection then
+          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
+
+          self.request(url: new_location,
+                       payload: payload,
+                       http_method: http_method,
+                       user: user,
+                       password: password,
+                       content_type: content_type,
+                       ca_string: ca_string,
+                       ca_verify: ca_verify,
+                       headers: headers,
+                       follow_redirects: follow_redirects,
+                       redirect_limit: redirect_limit - 1)
+        else
+          response
+        end
+      end
+    end
+  end
+end

data/app/subscribers/foreman_webhooks/event_subscriber.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ForemanWebhooks
+  class EventSubscriber < ::Foreman::BaseSubscriber
+    def call(event)
+      ::Webhook.deliver(event_name: event.name, payload: event.payload)
+    end
+  end
+end

data/app/views/api/v2/webhook_templates/base.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @webhook_template
+
+attributes :name, :id

data/app/views/api/v2/webhook_templates/create.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @webhook_template
+
+extends 'api/v2/webhook_templates/show'

data/app/views/api/v2/webhook_templates/index.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+collection @webhook_templates
+
+extends 'api/v2/webhook_templates/main'

data/app/views/api/v2/webhook_templates/main.json.rabl

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+object @webhook_template
+
+extends 'api/v2/webhook_templates/base'
+
+attributes :description, :created_at, :updated_at

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+object @webhook_template
+
+extends 'api/v2/webhook_templates/main'
+
+attributes :template, :default, :snippet, :locked
+
+node do |webhook_template|
+  partial('api/v2/taxonomies/children_nodes', object: webhook_template)
+end

data/app/views/api/v2/webhook_templates/update.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @webhook_template
+
+extends 'api/v2/webhook_templates/show'

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @webhook
+
+attributes :id, :name

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @webhook
+
+extends 'api/v2/webhooks/show'

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+collection @webhooks
+
+extends 'api/v2/webhooks/main'

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+object @webhook
+
+extends 'api/v2/webhooks/base'
+extends 'api/v2/layouts/permissions'
+
+attributes :target_url, :enabled, :created_at, :updated_at

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+object @webhook
+
+extends 'api/v2/webhooks/main'
+
+attributes :target_url,
+           :event,
+           :http_method,
+           :http_content_type,
+           :enabled,
+           :verify_ssl,
+           :http_headers
+
+child :webhook_template do
+  extends 'api/v2/webhook_templates/base'
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @webhook
+
+extends 'api/v2/webhooks/show'

data/app/views/foreman_webhooks/webhook_templates/ansible_tower_-_host_in_inventory.erb

@@ -0,0 +1,20 @@
+<%#
+name: Ansible Tower - Host in Inventory
+description: Create/update a host with associated inventory in Ansible Tower.
+snippet: false
+model: WebhookTemplate
+-%>
+<%#
+  Create URL: https://tower/api/v2/hosts
+  Update/Delete URL: https://tower/api/v2/hosts/$HOST_ID
+-%>
+<%=
+  payload({
+    "name": @object.name,
+    "description": "Created via Foreman Webhook",
+    "inventory": @object.host_param('ansible_tower_inventory_id') || 1,
+    "enabled": true,
+    "instance_id": "",
+    "variables": ""
+  }, with_defaults: false)
+-%>

data/app/views/foreman_webhooks/webhook_templates/empty_payload.erb

@@ -0,0 +1,6 @@
+<%#
+name: Empty Payload
+description: Useful for Shellhooks which only takes arguments via HTTP parameters.
+snippet: false
+model: WebhookTemplate
+-%>

data/app/views/foreman_webhooks/webhook_templates/webhook_template_-_payload_default.erb

@@ -0,0 +1,11 @@
+<%#
+name: Webhook Template - Payload Default
+description: This template is used to define default content of payload for a webhook.
+snippet: false
+model: WebhookTemplate
+-%>
+<%=
+payload({
+  id: @object.id
+})
+-%>

data/app/views/webhook_templates/_alerts.html.erb

@@ -0,0 +1,3 @@
+<% if @template.locked? -%>
+  <%= locked_warning(::Template.find(params[:id])) %>
+<% end -%>

data/app/views/webhook_templates/_custom_tab_headers.html.erb

@@ -0,0 +1 @@
+<li><a href='#template_type' data-toggle='tab'><%= _('Type') %></a></li>

data/app/views/webhook_templates/_custom_tabs.html.erb

@@ -0,0 +1,5 @@
+<div class='tab-pane' id='template_type'>
+  <%= checkbox_f f, :snippet, onchange: 'tfm.templateInputs.snippetChanged(this)',
+                              label: _('Snippet'),
+                              disabled: @template.locked? %>
+</div>

data/app/views/webhook_templates/edit.html.erb

@@ -0,0 +1,3 @@
+<% title _("Edit %s") % @template.to_s %>
+<%= breadcrumbs(switcher_item_url: edit_webhook_template_path(':id')) %>
+<%= render partial: 'form' %>

data/app/views/webhook_templates/index.html.erb

@@ -0,0 +1,29 @@
+<% title _('Webhook Templates') %>
+
+<% title_actions new_link(_('Create Template')) %>
+
+<table class="<%= table_css_classes 'table-fixed' %>">
+  <thead>
+    <tr>
+      <th class="col-md-3"><%= sort :name, as: s_('WebhookTemplate|Name') %></th>
+      <th class="col-md-1"><%= sort :snippet, as: s_('WebhookTemplate|Snippet') %></th>
+      <th class="col-md-1"><%= sort :locked, as: s_('WebhookTemplate|Locked'), default: 'DESC' %></th>
+      <th class="col-md-1"><%= _('Actions') %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% for webhook_template in @templates %>
+    <tr>
+        <td class="ellipsis"><%= link_to_if_authorized webhook_template,
+                                   hash_for_edit_webhook_template_path(id: webhook_template.to_param).
+                                     merge(auth_object: webhook_template, authorizer: authorizer, permission: 'edit_webhook_templates') %>
+        </td>
+        <td align='center'><%= checked_icon webhook_template.snippet %></td>
+        <td align='center'><%= locked_icon webhook_template.locked?, _('This template is locked for editing.') %>
+        </td>
+        <td><%= action_buttons(*permitted_actions(webhook_template)) %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+<%= will_paginate_with_info @templates %>

data/app/views/webhook_templates/new.html.erb

@@ -0,0 +1,3 @@
+<% title _('Create Template') %>
+
+<%= render partial: 'form' %>

data/app/views/webhooks/_form.html.erb

@@ -0,0 +1,37 @@
+<%= form_for @webhook, url: (@webhook.new_record? ? webhooks_path : webhook_path(id: @webhook)) do |f| %>
+  <%= base_errors_for @webhook %>
+  <%= text_f f, :name %>
+  <%= text_f f, :target_url, help_inline: _('Target URL that should be called by Foreman') %>
+
+  <%= text_f f, :user, help_block: _('Authentication credentials') %>
+  <%= password_f f, :password, keep_value: true %>
+
+  <%= selectable_f f, :http_method, Webhook::ALLOWED_HTTP_METHODS,
+                   { include_blank: false,
+                     selected: @webhook.http_method },
+                   { label: _('HTTP Method'),
+                     label_help: _(f.object.try(:description)),
+                     required: true } %>
+  <%= text_f f, :http_content_type %>
+
+  <%= render('templates', f: f) %>
+
+  <%= selectable_f f, :event, Webhook.available_events.sort.map { |e| e.delete_suffix(Webhook::EVENT_POSTFIX) },
+                   { include_blank: false,
+                     selected: @webhook.event&.delete_suffix(Webhook::EVENT_POSTFIX) },
+                   { label: _('Subscribe to'),
+                     label_help: _(f.object.try(:description)),
+                     required: true } %>
+
+  <%= checkbox_f f, :enabled, help_inline: _('If unchecked, the webhook will be inactive') %>
+  <%= checkbox_f f, :verify_ssl, help_inline: _("Uncheck this option to disable validation of the receiver's SSL certificate") %>
+  <%= textarea_f f, :ssl_ca_certs, label: _('X509 Certification Authorities'),
+    size: 'col-md-8', rows: 10,
+    placeholder: _("Optional CAs in PEM format concatenated to verify the receiver's SSL certificate.") %>
+
+  <%= textarea_f f, :http_headers, label: _('Optional HTTP headers as JSON (ERB allowed)'),
+    size: 'col-md-8', rows: 6,
+    placeholder: "{\n\"X-Shellhook-Arg-1\": \"value\"\n}" %>
+
+  <%= submit_or_cancel(f, false, { react_cancel_button: true, cancel_path: '/webhooks' }) %>
+<% end %>

data/app/views/webhooks/_templates.html.erb

@@ -0,0 +1,5 @@
+<%= selectable_f f, :webhook_template_id, WebhookTemplate.where(snippet: false).collect { |t| [t.name, t.id] },
+                                          { include_blank: false },
+                                          { label: _('Webhook Template'),
+                                            label_help: _(f.object.try(:description)),
+                                            required: true } %>

data/app/views/webhooks/edit.html.erb

@@ -0,0 +1,3 @@
+<% title _("Edit %s") % @webhook.to_s %>
+
+<%= render partial: 'form' %>

data/app/views/webhooks/new.html.erb

@@ -0,0 +1,3 @@
+<% title _('Create Webhook') %>
+
+<%= render partial: 'form' %>

data/config/routes.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  resources :webhooks, except: %i[index show] do
+    collection do
+      get 'auto_complete_search'
+    end
+  end
+  match '/webhooks' => 'react#index', via: :get
+
+  namespace :api, defaults: { format: 'json' } do
+    scope '(:apiv)',
+          module: :v2,
+          defaults: { apiv: 'v2' },
+          apiv: /v1|v2/,
+          constraints: ApiConstraints.new(version: 2, default: true) do
+      resources :webhooks, only: %i[index show create update destroy]
+      resources :webhook_templates, except: %i[new edit] do
+        member do
+          post :clone
+          get :export
+        end
+        collection do
+          post :import
+        end
+      end
+    end
+  end
+
+  scope 'templates' do
+    resources :webhook_templates, except: :show do
+      member do
+        get 'clone_template'
+        get 'lock'
+        get 'unlock'
+        get 'export'
+        post 'preview'
+      end
+      collection do
+        post 'preview'
+        get 'auto_complete_search'
+      end
+    end
+  end
+end