foreman_webhooks 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4c7f3b67cd40e7de9b5226bbee4a9bccc1b1132c1cdeb08bd2521135036c8ce
-  data.tar.gz: 9c47ea60965737999ef8ed63a036b1d58c0fe205d1f5d8df3a5a497c6816e5c0
+  metadata.gz: a9463b5bd544237c5746c80546263831614867cd514146ec019332759618e2b8
+  data.tar.gz: ee3c69e62926cd35b9ed665b5dc09199052fb7d72556040851d571cdbd0a01de
 SHA512:
-  metadata.gz: bb768c45df8d5470eb8f5bb3add9d7b7bc81ed76d4148c2216a85d61a99b62b988d3c7fa9d2152c344f61716fed0ea9083e0928f965e5ef47486dc2909897a76
-  data.tar.gz: a313ab830d249d8585c9ff90001417fc95cf6925fc58e0b01e229631d378eae936c16a0f86043e483e8b209a28ff1887ea8101c3cd390eeba0aca13ef21e1e27
+  metadata.gz: 8b3580cd4a8987e5ad9e3410bf87be6b9c84c299f0e38bcc68db14dfe97c7458f4976621f19d614d39b56380be8a7ba8cefbf7a42d358bbe91a417b05603d153
+  data.tar.gz: ef59e908b1f0c9cad872b73bd86922064f01552a8f8287b720d040f0a9b4f44fbf066d752492637aff633752db5453b35e07cf376f7e86838d756cb4d8fd1dcb

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]
 
       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

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/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

@@ -25,7 +25,7 @@ module ForemanWebhooks
         logger.debug("Headers: #{rendered_headers}")
       end
 
-      response = self.class.request(url: webhook.target_url,
+      response = self.class.request(url: rendered_url,
                                     payload: payload,
                                     http_method: webhook.http_method,
                                     user: webhook.user,
@@ -50,7 +50,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,7 +59,9 @@ 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_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)
@@ -86,11 +89,13 @@ module ForemanWebhooks
       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/remote_execution_-_host_job.erb

@@ -0,0 +1,21 @@
+<%#
+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 %>
+# Task action output <%= @object.task.action_output %>

data/db/seeds.d/62_shellhooks_proxy_feature.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+proxy_feature = Feature.where(name: 'Shellhooks').first_or_create
+return unless proxy_feature.nil? || proxy_feature.errors.any?
+
+raise "Unable to create proxy feature: #{format_errors proxy_feature}"

data/lib/foreman_webhooks/engine.rb

@@ -35,8 +35,8 @@ module ForemanWebhooks
                                           'api/v2/webhooks': [:update] }, 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],
-                                                    'api/v2/webhook_templates': %i[index show export] },
+          permission :view_webhook_templates, { webhook_templates: %i[index show auto_complete_search preview export],
+                                                'api/v2/webhook_templates': %i[index show export] },
                      resource_type: 'WebhookTemplate'
           permission :create_webhook_templates,   { webhook_templates: %i[new create clone_template],
                                                     'api/v2/webhook_templates': %i[create clone import] },
@@ -52,6 +52,15 @@ module ForemanWebhooks
                      resource_type: 'WebhookTemplate'
         end
 
+        role 'Webhooks Reader',
+             %i[view_webhooks view_webhook_templates]
+
+        role 'Webhooks Manager',
+             %i[view_webhooks create_webhooks edit_webhooks destroy_webhooks
+                view_webhook_templates create_webhook_templates
+                edit_webhook_templates destroy_webhook_templates
+                lock_webhook_templates]
+
         # add menu entry
         divider :admin_menu, caption: N_('Webhook'), parent: :administer_menu
         menu :admin_menu, :webhooks, url: '/webhooks',

data/lib/foreman_webhooks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanWebhooks
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/tasks/foreman_webhooks_tasks.rake

@@ -44,4 +44,6 @@ end
 Rake::Task[:test].enhance ['test:foreman_webhooks']
 
 load 'tasks/jenkins.rake'
-Rake::Task['jenkins:unit'].enhance ['test:foreman_webhooks', 'foreman_webhooks:rubocop'] if Rake::Task.task_defined?(:'jenkins:unit')
+if Rake::Task.task_defined?(:'jenkins:unit')
+  Rake::Task['jenkins:unit'].enhance ['test:foreman_webhooks', 'foreman_webhooks:rubocop']
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_webhooks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Timo Goebel
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2021-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -28,14 +28,14 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.71.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.71.0
 description: Plugin for Foreman that allows to configure Webhooks.
@@ -74,6 +74,7 @@ files:
 - app/views/api/v2/webhooks/update.json.rabl
 - app/views/foreman_webhooks/webhook_templates/ansible_tower_-_host_in_inventory.erb
 - app/views/foreman_webhooks/webhook_templates/empty_payload.erb
+- app/views/foreman_webhooks/webhook_templates/remote_execution_-_host_job.erb
 - app/views/foreman_webhooks/webhook_templates/webhook_template_-_payload_default.erb
 - app/views/webhook_templates/_alerts.html.erb
 - app/views/webhook_templates/_custom_tab_headers.html.erb
@@ -93,6 +94,7 @@ files:
 - db/migrate/20200908004234_add_columns_to_webhooks.rb
 - db/migrate/20201014115147_rename_ca_file_column.rb
 - db/migrate/20201109135301_add_http_headers.rb
+- db/seeds.d/62_shellhooks_proxy_feature.rb
 - db/seeds.d/95_webhook_templates.rb
 - lib/foreman_webhooks.rb
 - lib/foreman_webhooks/engine.rb
@@ -165,27 +167,27 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Configure webhooks for Foreman.
 test_files:
-- test/jobs/foreman_webhooks/deliver_webhook_job_test.rb
-- test/test_plugin_helper.rb
-- test/unit/foreman_webhooks/webhook_service_test.rb
+- test/controllers/api/v2/webhook_templates_controller_test.rb
+- test/controllers/api/v2/webhooks_controller_test.rb
 - test/factories/webhook.rb
 - test/factories/webhook_target.rb
 - test/factories/webhook_template.rb
-- test/controllers/api/v2/webhook_templates_controller_test.rb
-- test/controllers/api/v2/webhooks_controller_test.rb
+- test/jobs/foreman_webhooks/deliver_webhook_job_test.rb
 - test/models/webhook_test.rb
+- test/unit/foreman_webhooks/webhook_service_test.rb
+- test/test_plugin_helper.rb
 - 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
 - webpack/ForemanWebhooks/Routes/Webhooks/WebhooksIndexPage/Components/WebhooksTable/__tests__/WebhooksTable.test.js