foreman_hooks 0.3.9 → 0.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46c0a89abfd88c3504155a968576b0bda74eb5d1
-  data.tar.gz: 706af60156c35ae99e53b9c19a7326075d6b938e
+  metadata.gz: a89ac7b975601cb22c02b50fe94047bb880e6989
+  data.tar.gz: 7c631de38f23086fedbc7936acef69b5f365d15a
 SHA512:
-  metadata.gz: f613b965f1671fabebc64ea67ce1afbd883f3a17324f21e118c695ea5eb0bdc63398ee928fa2859f3d804c31b3f3a839264750d1fe949be33b5361bb6221c101
-  data.tar.gz: 01afb060d70cbec9d50170e40bcef5c8960502fb77ba3ebdfc8d48bb92d944066d0370d485927c2300f9df448ad21848c91b91620a4844b28dcc579a608a9057
+  metadata.gz: 6fb5a5d108bc7ada61a789127f7fab55aed8e8a5ee1b40b6a7c42f342f02bbd60db681fbcfe026a51252f7105a7be7a33b0106cb91ae8bd23047dc905a888ebf
+  data.tar.gz: efba9aa79b1355ad157613b249c7c84e35dfce71f2317b40edb9b9749deee2d1d9ecee7125d10ef3d94a6aa4fc5d34fab84e7ff9e4b235f4bd0a0c5bef14c0e7

data/README.md

@@ -24,7 +24,7 @@ RPM users can install the "ruby193-rubygem-foreman_hooks" or
 Hooks are stored in `/usr/share/foreman/config/hooks` (`~foreman/config/hooks`)
 with a subdirectory for the object, then a subdirectory for the event name.
 
-    ~foreman/config/hooks/$OBJECT/$EVENT/$HOOK_SCRIPT
+    ~foreman/config/hooks/[OBJECT]/[EVENT]/[HOOK_SCRIPT]
 
 Examples:
 
@@ -33,19 +33,6 @@ Examples:
     ~foreman/config/hooks/smart_proxy/after_create/01_email_operations.sh
     ~foreman/config/hooks/audited/adapters/active_record/audit/after_create/01_syslog.sh
 
-## SELinux notes
-
-When using official installation on Red Hat and Fedora system, note that
-SELinux is turned on by default and Foreman is running in confined mode. Make
-sure that hook scripts has the correct context (`foreman_hook_t` on
-RHEL7+/Fedora 19+ or `bin_t` on RHEL6):
-
-    restorecon -RvF /usr/share/foreman/config/hooks
-
-Also keep in mind that the script is running confined, therefore some actions
-might be denied by SELinux. Check audit.log and use audit2allow and other
-tools when writing scripts.
-
 ## Objects / Models
 
 Every object (or model in Rails terms) in Foreman can have hooks.  Check
@@ -53,13 +40,26 @@ Every object (or model in Rails terms) in Foreman can have hooks.  Check
 
 * `host/managed` (or `host` in Foreman 1.1)
 * `report`
+* `nic/managed`
+* `hostgroup`
+* `user`
+
+To generate a list of *all* possible models, issue the following command:
+
+    # foreman-rake hooks:objects
+
+and to get events for a listed object (e.g. `host/managed`):
+
+    # foreman-rake hooks:events[host/managed]
 
 ## Orchestration events
 
 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
-automatically trigger a rollback of the action.
+automatically trigger a rollback of the action. A rollback is performed as
+an opposite action (e.g. for DHCP record creation a rollback action is
+destroy).
 
 To add hooks to these, use these event names:
 
@@ -67,11 +67,15 @@ 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).
+
 ## Rails events
 
-For hooks on anything apart from hosts (which support orchestration, as above)
-then the standard Rails events will be needed.  These are the most interesting
-events provided:
+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:
 
 * `after_create`, `before_create`
 * `after_destroy`, `before_destroy`
@@ -100,7 +104,7 @@ representation of the object that was hooked, e.g. the hostname for a host.
 A JSON representation of the hook object will be passed in on stdin.  A utility
 to read this with jgrep is provided in `examples/hook_functions.sh` and
 sourcing this utility script will be enough for most users.  Otherwise, you
-may want to ensure stdin is closed.
+may want to ensure stdin is closed to prevent pipe buffer from filling.
 
     echo '{"host":{"name":"foo.example.com"}}' \
       | ~foreman/config/hooks/host/managed/create/50_register_system.sh \
@@ -122,6 +126,26 @@ to rollback its action - in this case the first argument will change as
 appropriate, so must be obeyed by the script (e.g. a "create" hook will be
 called with "destroy" if it has to be rolled back later).
 
+## Transactions
+
+Most hooks are triggered during database transaction. This can cause
+conflicting updates when hook scripts emits database updates via Foreman CLI
+or API. It is recommended to avoid this behavior and write a Foreman plugin
+instead.
+
+## SELinux notes
+
+When using official installation on Red Hat and Fedora system, note that
+SELinux is turned on by default and Foreman is running in confined mode. Make
+sure that hook scripts has the correct context (`foreman_hook_t` on
+RHEL7+/Fedora 19+ or `bin_t` on RHEL6):
+
+    restorecon -RvF /usr/share/foreman/config/hooks
+
+Also keep in mind that the script is running confined, therefore some actions
+might be denied by SELinux. Check audit.log and use audit2allow and other
+tools when writing scripts.
+
 # More resources
 
 * [Extending Foreman quickly with hook scripts](http://m0dlx.com/blog/Extending_Foreman_quickly_with_hook_scripts.html)

data/lib/foreman_hooks.rb

@@ -1,5 +1,5 @@
 module ForemanHooks
-  require 'foreman_hooks/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  require 'foreman_hooks/engine'
   require 'foreman_hooks/util'
   require 'foreman_hooks/callback_hooks'
   require 'foreman_hooks/orchestration_hook'
@@ -39,7 +39,7 @@ module ForemanHooks
         @hooks = discover_hooks
         @hooks.each do |klass,events|
           events.each do |event,hooks|
-            logger.info "Finished registering #{hooks.size} hooks for #{klass}##{event}"
+            logger.info "Finished discovering #{hooks.size} hooks for #{klass}##{event}"
             hooks.sort!
           end
         end
@@ -68,9 +68,16 @@ module ForemanHooks
 
     def attach_hook(klass, events)
       if events.keys.detect { |event| ['create', 'update', 'destroy'].include? event }
-        klass.send(:include, ForemanHooks::OrchestrationHook) unless klass.ancestors.include?(ForemanHooks::OrchestrationHook)
+        unless klass.ancestors.include?(ForemanHooks::OrchestrationHook)
+          logger.debug "Extending #{klass} with foreman_hooks orchestration hooking support"
+          klass.send(:include, ForemanHooks::OrchestrationHook)
+        end
+      end
+
+      unless klass.ancestors.include?(ForemanHooks::CallbackHooks)
+        logger.debug "Extending #{klass} with foreman_hooks Rails hooking support"
+        klass.send(:include, ForemanHooks::CallbackHooks)
       end
-      klass.send(:include, ForemanHooks::CallbackHooks) unless klass.ancestors.include?(ForemanHooks::CallbackHooks)
     end
 
     def logger; Rails.logger; end

data/lib/foreman_hooks/callback_hooks.rb

@@ -9,6 +9,7 @@ module ForemanHooks::CallbackHooks
       filter, name = event.to_s.split('_', 2)
       next unless name
 
+      Rails.logger.debug("Created hook method #{event} on #{self}")
       set_callback name.to_sym, filter.to_sym, "#{event}_hooks".to_sym
       define_method("#{event}_hooks") do
         Rails.logger.debug "Observed #{event} hook on #{self}"

data/lib/foreman_hooks/engine.rb

@@ -8,7 +8,7 @@ module ForemanHooks
 
     initializer 'foreman_hooks.register_plugin', :after=> :finisher_hook do |app|
       Foreman::Plugin.register :foreman_hooks do
-      end if defined? Foreman::Plugin
+      end
     end
   end
 end

data/lib/foreman_hooks/util.rb

@@ -9,6 +9,8 @@ module ForemanHooks::Util
         'host'
       when "Host::Discovered"
         'discovered_host'
+      when "Audited::Adapters::ActiveRecord::Audit"
+        'audit'
       else
         self.class.name.downcase
     end
@@ -17,7 +19,8 @@ module ForemanHooks::Util
   def render_hook_json
     # APIv2 has some pretty good templates.  We could extend them later in special cases.
     # Wrap them in a root node for pre-1.4 compatibility
-    json = Rabl.render(self, "api/v2/#{render_hook_type.tableize}/show", :view_path => 'app/views', :format => :json)
+    view_path = Rails.root.join('app', 'views')
+    json = Rabl.render(self, "api/v2/#{render_hook_type.tableize}/show", :view_path => view_path, :format => :json)
     %Q|{"#{render_hook_type}":#{json}}|
   rescue => e
     logger.warn "Unable to render #{self} (#{self.class}) using RABL: #{e.message}"
@@ -43,8 +46,12 @@ module ForemanHooks::Util
       Open3.capture2e(*args.push(:stdin_data => stdin_data))
     else  # 1.8
       Open3.popen3(*args) do |stdin,stdout,stderr|
-        stdin.write(stdin_data)
-        stdin.close
+        begin
+          stdin.write(stdin_data)
+          stdin.close
+        rescue Errno::EPIPE
+          logger.debug "Foreman hook input data skipped, closed pipe"
+        end
         # we could still deadlock here, it'd ideally select() on stdout+err
         output = stderr.read
       end

data/lib/tasks/hooks.rake

@@ -0,0 +1,19 @@
+namespace :hooks do
+  desc 'Print a list of object names that can be hooked'
+  task :objects => :environment do
+    puts ActiveRecord::Base.descendants.collect(&:name).collect(&:underscore).sort
+  end
+
+  desc 'Print a list of event names for a given object, e.g. hooks:events[host/managed]'
+  task :events, [:object] => :environment do |t,args|
+    model = begin
+              args[:object].camelize.constantize
+            rescue NameError => e
+              fail("Unknown model #{args[:object]}, run hooks:objects to get a list (#{e.message})")
+            end
+
+    events = ActiveRecord::Callbacks::CALLBACKS.map(&:to_s).reject { |e| e.start_with?('around_') }
+    events.concat(['create', 'destroy', 'update']) if model.included_modules.include?(Orchestration)
+    puts events.sort
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_hooks
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.3.10
 platform: ruby
 authors:
 - Dominic Cleal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-16 00:00:00.000000000 Z
+date: 2016-05-16 00:00:00.000000000 Z
 dependencies: []
 description: Plugin engine for Foreman that enables running custom hook scripts on
   Foreman events
@@ -31,6 +31,7 @@ files:
 - lib/foreman_hooks/engine.rb
 - lib/foreman_hooks/orchestration_hook.rb
 - lib/foreman_hooks/util.rb
+- lib/tasks/hooks.rake
 - test/test_helper.rb
 - test/unit/host_observer_test.rb
 homepage: http://github.com/theforeman/foreman_hooks