foreman_hooks 0.3.12 → 0.3.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e36bbbb7ffec26b6250bc5b073bea7b8237539b1
-  data.tar.gz: 31d5746a12a9d454044e11d32c52350f616b2dd4
+  metadata.gz: 40ce82d00a918185af3f0e75063311cdca9c7ecb
+  data.tar.gz: ba63e860d91d252f31fc231a6ca16ca9f63129ca
 SHA512:
-  metadata.gz: 96726288631740a784979242e476053d5fa9b3e2007af35e428b7a12c6fa52bae7b40c98b556c1ebd22c3dcbc9af58d611ea151d86fc28debdb10f5038e28db4
-  data.tar.gz: a7d8dda6643da1d5e38d5fcb750410bc24ad0e775d0a1f86f677fc2b8f0699cadf4b00fe91752807a51568c8ac004d75cf58caee2d6545f209e498cb79b9f25a
+  metadata.gz: 6740120f31efa77b71e218bade83661697dc9aba205444f2bc04f48864d13f0b159fe74f77c76cb44c5c46228bb890f0db4997bb49969a75d9dc983c60dded52
+  data.tar.gz: 2a94de8cf7102c8a20c4b6ec79734a4856736ada300160dcf6793254a399cc56c9dd435a50d0256c0e39c2627e3d08a993274617c37b130c5123938ea106f0cd

data/README.md

@@ -54,6 +54,11 @@ and to get events for a listed object (e.g. `host/managed`):
 
 ## Orchestration events
 
+_Only supported on these objects:_
+
+* _host/managed_
+* _nic/\*_
+
 Foreman supports orchestration tasks for hosts and NICs (each network
 interface) which happen when the object is created, updated and destroyed.
 These tasks are shown to the user in the UI and if they fail, will
@@ -67,12 +72,22 @@ To add hooks to these, use these event names:
 * `update`
 * `destroy`
 
-Orchestration hooks can be given a priority (see below), therefore it is
-possible to order them before or after built-in orchestration steps (before
-DNS record is created for example).
+Orchestration hooks can be given a priority by prefixing the filename with the
+priority number, therefore it is possible to order them before or after
+built-in orchestration steps (before DNS records are created for example).
+Existing common priority levels are:
+
+* _2_: Set up compute instance (create VM)
+* _10_: Create DNS record
+* _10_: Create DHCP reservation
+* _20_: Deploy TFTP configs
+* _50_: Create realm entry
+* _1000_: Power up compute instance
 
 ## Rails events
 
+_Supported on all object types._
+
 For hooks on anything apart from hosts or NICs (which support orchestration,
 as above) then the standard Rails events will be needed. These are the most
 interesting events provided:

data/extra/foreman-debug.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+# This file provides additional debug information for foreman-debug tool and is
+# symlinked as /usr/share/foreman/script/foreman-debug.d/50-foreman_hooks
+
+add_cmd "find /usr/share/foreman/config/hooks/ -type f -executable" "foreman_hooks_list"

data/lib/foreman_hooks/engine.rb

@@ -3,7 +3,15 @@ require 'foreman_hooks'
 module ForemanHooks
   class Engine < ::Rails::Engine
     config.to_prepare do
-      ForemanHooks.hooks.each { |klass,events| ForemanHooks.attach_hook(klass.constantize, events) }
+      ForemanHooks.hooks.each do |klass,events|
+        begin
+          klass_const = klass.constantize
+        rescue NameError => e
+          ForemanHooks.logger.error "foreman_hooks: unknown hook object #{klass}, check against `foreman-rake hooks:objects`"
+          next
+        end
+        ForemanHooks.attach_hook(klass_const, events)
+      end
     end
 
     initializer 'foreman_hooks.register_plugin', :before => :finisher_hook do |app|

data/lib/foreman_hooks/orchestration_hook.rb

@@ -22,7 +22,8 @@ module ForemanHooks::OrchestrationHook
   def queue_hooks(event)
     logger.debug "Observed #{event} hook on #{self}"
     unless is_a? Orchestration
-      logger.warn "#{self.class.to_s} doesn't support orchestration, can't run orchestration hooks: use Rails events instead"
+      logger.error "#{self.class.to_s} doesn't support orchestration, can't run orchestration hooks: use Rails events instead"
+      return
     end
 
     return unless hooks = ForemanHooks.find_hooks(self.class, event)

data/lib/foreman_hooks/util.rb

@@ -9,7 +9,7 @@ module ForemanHooks::Util
         'host'
       when "Host::Discovered"
         'discovered_host'
-      when "Audited::Adapters::ActiveRecord::Audit"
+      when "Audited::Adapters::ActiveRecord::Audit", "Audited::Audit"
         'audit'
       else
         self.class.name.downcase

data/lib/tasks/hooks.rake

@@ -1,6 +1,7 @@
 namespace :hooks do
   desc 'Print a list of object names that can be hooked'
   task :objects => :environment do
+    Rails.application.config.eager_load_namespaces.each(&:eager_load!)
     puts ActiveRecord::Base.descendants.collect(&:name).collect(&:underscore).sort
   end
 
@@ -12,8 +13,18 @@ namespace :hooks do
               fail("Unknown model #{args[:object]}, run hooks:objects to get a list (#{e.message})")
             end
 
+    # 1. List default ActiveRecord callbacks
     events = ActiveRecord::Callbacks::CALLBACKS.map(&:to_s).reject { |e| e.start_with?('around_') }
+
+    # 2. List Foreman orchestration callbacks
     events.concat(['create', 'destroy', 'update']) if model.included_modules.include?(Orchestration)
+
+    # 3. List custom define_callbacks/define_model_callbacks
+    callbacks = model.methods.map { |m| $1 if m =~ /\A_([a-z]\w+)_callbacks\z/ }.compact
+    # ignore callbacks that are in the AR default list
+    callbacks.delete_if { |c| events.any? { |e| e.end_with?("_#{c}") } }
+    callbacks.each { |c| events.push("before_#{c}", "after_#{c}") }
+
     puts events.sort
   end
 end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: foreman_hooks
 version: !ruby/object:Gem::Version
-  version: 0.3.12
+  version: 0.3.13
 platform: ruby
 authors:
 - Dominic Cleal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-05 00:00:00.000000000 Z
+date: 2017-02-16 00:00:00.000000000 Z
 dependencies: []
 description: Plugin engine for Foreman that enables running custom hook scripts on
   Foreman events
-email: dcleal@redhat.com
+email: dominic@cleal.org
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -26,6 +26,7 @@ files:
 - TODO
 - examples/hook_functions.sh
 - examples/log.sh
+- extra/foreman-debug.sh
 - lib/foreman_hooks.rb
 - lib/foreman_hooks/callback_hooks.rb
 - lib/foreman_hooks/engine.rb
@@ -36,7 +37,7 @@ files:
 - test/unit/host_observer_test.rb
 homepage: http://github.com/theforeman/foreman_hooks
 licenses:
-- GPL-3
+- GPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -44,17 +45,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Run custom hook scripts on Foreman events