foreman_hooks 0.3.15 → 0.3.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 87442c737ac9a7e0a5dfa830a53ebbce69121da6
-  data.tar.gz: 9b455bf7f174ade8aa225cc961068f0e4fde84a8
+SHA256:
+  metadata.gz: 4dc282696356d27aa5a60add59c36a5cad8b56efff3b2d596a2d5046e9802f84
+  data.tar.gz: b596f8a8701a4f5bc3ced2c26ffd156cf38b113040f04db031efecf726fe3a1b
 SHA512:
-  metadata.gz: 27d082d0c28f8406a081b5b6be1be72aad4b5f74d7790735c2a12d2a32984da91a438f6face9676cd472a720eef639755f35fe7fd7c13a1a955c0da96f18f851
-  data.tar.gz: 7f861b52fb1dc7ae207fc4d3218afee8c6d01c5e423d9a2ad36a1ea1a93dde521963faace55cb494adbc52b4138ef7c5d305becb7ad38216ddd35a9337340098
+  metadata.gz: db3174053c929c862debecf523943cb3f7c87dd902407579a9295f12de9f17e0d90998ad7e0d828a13303db05a9deed65181703fc4bcb40063647741561b8e51
+  data.tar.gz: ab116e0a5052dae4a9e0f219bedf10eb217b481a7e2f00a070eca1c736dcf196ca15cd4712f814f0bbe06bd7fa4f04ce6c03d9d1aae00ee9fc3c9dd6575823a7

data/README.md

@@ -71,12 +71,22 @@ 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:
+The following hooks are executed during `around_save` Rails callback:
 
 * `create`
 * `update`
+
+The following hooks are executed during `on_destroy` Rails callback:
+
 * `destroy`
 
+The following hooks are executed during `after_commit` Rails callback:
+
+* `postcreate`
+* `postupdate`
+
+The major difference between `create` and `postcreate` (or update respectively) is how late the hook is called during save operation. In the former case when a hook fails it starts rollback and operation can be still cancelled. In the latter case object was already saved and there is no way of cancelling the operation, but all referenced data should be properly loaded. The advice is to use the latter hooks as they will likely contain all the required data (e.g. nested parameters).
+
 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).
@@ -133,7 +143,7 @@ may want to ensure stdin is closed to prevent pipe buffer from filling.
 
 Some arguments are available as environment variables:
 
-Variable | Description 
+Variable | Description
 -------- | -----------
 FOREMAN_HOOKS_USER | Username of Foreman user
 

data/lib/foreman_hooks.rb

@@ -68,7 +68,7 @@ module ForemanHooks
     end
 
     def attach_hook(klass, events)
-      if events.keys.detect { |event| ['create', 'update', 'destroy'].include? event }
+      if events.keys.detect { |event| ['create', 'update', 'destroy', 'postcreate', 'postupdate'].include? event }
         unless klass.ancestors.include?(ForemanHooks::OrchestrationHook)
           logger.debug "Extending #{klass} with foreman_hooks orchestration hooking support"
           klass.send(:include, ForemanHooks::OrchestrationHook)

data/lib/foreman_hooks/orchestration_hook.rb

@@ -12,6 +12,7 @@ module ForemanHooks::OrchestrationHook
   def queue_hooks_validate
     return unless errors.empty?
     queue_hooks(new_record? ? 'create' : 'update')
+    queue_hooks(new_record? ? 'postcreate' : 'postupdate')
   end
 
   def queue_hooks_destroy
@@ -33,10 +34,10 @@ module ForemanHooks::OrchestrationHook
     hooks.each do |filename|
       basename = File.basename(filename)
       priority = basename =~ /^(\d+)/ ? $1 : 10000 + (counter += 1)
-      logger.debug "Queuing hook #{basename} for #{self.class.to_s}##{event} at priority #{priority}"
-      queue.create(:name   => "Hook: #{basename}", :priority => priority.to_i,
-                   :action => [HookRunner.new(filename, self, event.to_s),
-                               event.to_s == 'destroy' ? :hook_execute_del : :hook_execute_set])
+      logger.debug "Queuing hook #{filename} for #{self.class.to_s}##{event} at priority #{priority}"
+      queue_to_use = (event =~ /^post/) ? post_queue : queue
+      queue_to_use.create(:name => "Hook: #{filename}", :priority => priority.to_i,
+        :action => [HookRunner.new(filename, self, event.to_s), event.to_s == 'destroy' ? :hook_execute_del : :hook_execute_set])
     end
   end
 
@@ -54,7 +55,7 @@ module ForemanHooks::OrchestrationHook
     end
 
     def hook_execute_set
-      @obj.exec_hook(@filename, @event == 'destroy' ? 'create' : @event, *args)
+      @obj.exec_hook(@filename, @event, *args)
     end
 
     def hook_execute_del

data/lib/tasks/hooks.rake

@@ -24,7 +24,7 @@ namespace :hooks do
     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)
+    events.concat(['create', 'destroy', 'update', 'postcreate', 'postupdate']) 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_hooks
 version: !ruby/object:Gem::Version
-  version: 0.3.15
+  version: 0.3.16
 platform: ruby
 authors:
 - Dominic Cleal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-18 00:00:00.000000000 Z
+date: 2019-12-17 00:00:00.000000000 Z
 dependencies: []
 description: Plugin engine for Foreman that enables running custom hook scripts on
   Foreman events
@@ -57,8 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Run custom hook scripts on Foreman events