blender-serf 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a360de1c7367a78e1ae4cb4a5a1bb2095f11e3d
-  data.tar.gz: 61df6de3ba420247a8e0169005212c1f74baef39
+  metadata.gz: 89f1bece5fe6e866cb89265426ac0f96c3dafcf8
+  data.tar.gz: def82f90d757304d58be03f0480e16a125bfbdd6
 SHA512:
-  metadata.gz: 43bef41ba273f03c8ebe522e8de7820b215a2fd2606f587cb8916544b2d4d30819e55f8f552d4fbfd1b0a4655aa4ea7183e057aaee58c1503d3769abba33ccac
-  data.tar.gz: 4870e0f7baf6977b6ec519d3a997317b9df659cb723eb457be3f1311b4fa68a261d51841b50fb9338185f7cf4a527d2ee2b7f680ccc91cdac246c51b65a2df39
+  metadata.gz: 89d621fcca8551eef4f2218ba3e56fa98e01815a21a528bd70d2b3464b9ad22c7391b5d95b914bf235b4c290b793e1bacc67a395703a8b5362b646ae7e9d5350
+  data.tar.gz: 276b2d52e496c88a29d5c2ef64b9264f76f97cd344d62cf15d38f4cade269604588b2ab0a7f63319a674fb60362c2118011f9cd916c8a7affc186a9f34209874

data/.travis.yml

@@ -1,9 +1,9 @@
 before_install:
   - bundle install --path .bundle
 rvm:
-  - 1.9.3
   - 2.1.0
   - 2.1.2
+  - 2.2.3
 branches:
   only:
     - master

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+CHANGELOG for blender-serf
+==========================
+## 0.2 (December 10, 2015)
+- Async task support

data/README.md

@@ -115,6 +115,102 @@ end
 run
 
 ```
+
+### Async task DSL:
+
+Since serf event handler execution happens synchronously (i.e. normal serf
+events wont be processed when an event handler is running). Hence, it is
+desirable that the actual event handler returns promptly. This imposes certain
+design challenges in orchestrating long running commands via serf.
+
+blender-serf integration provides a simpler solution to this problem.
+It recommends using the serf event handler only to fork off the long running command, and maintain
+a state file locally that can be used to decide whether the original task is running or finished.
+Most of these gears are offered by Serfx::Utils::AsynJob module. On blender side `serf_async_task` method
+is used to manage this long running job, using three separate serf events (one to start
+the command, another one to poll and check if its finished or not, and the last one
+to reap the finished command).
+
+Following is an example handler that runs apt update. It exposes the task management as 4
+distinct events, start, check, kill, reap.
+
+```ruby
+require 'serfx/utils/async_job'
+require 'serfx/utils/handler'
+require 'json'
+
+include Serfx::Utils::Handler
+
+job = Serfx::Utils::AsyncJob.new( name: 'update', command: 'sudo apt-get update -y', state: '/opt/serf/states/chef')
+
+on :query, 'apt-update' do |event|
+  case event.payload
+  when 'start'
+    status = job.start
+    code = (status == 'success') ? 0 : -1
+    puts JSON.dump(code: code, result: { status: status })
+  when 'kill'
+    status = job.kill
+    code = (status == 'success') ? 0 : -1
+    puts JSON.dump(code: code, result: { status: status })
+  when 'reap'
+    status = job.reap
+    code = (status == 'success') ? 0 : -1
+    puts JSON.dump(code: code, result: { status: status })
+  when 'check'
+    state = job.stateinfo
+    puts JSON.dump(code: 0, result: state)
+  else
+    puts JSON.dump(code: -1, result: { status: 'failed' })
+  end
+end
+
+run
+```
+
+This long running command can be orchestrated using the `serf_async_task` like this:
+
+```ruby
+serf_async_task 'run apt-get update' do
+
+  start do
+    query 'apt-update'
+    payload 'start'
+  end
+
+  check do
+    query 'apt-update'
+    payload 'check'
+    process do |responses|
+      responses.all? do |resp|
+        status = JSON.parse(resp['Payload'])['result']['status']
+        fail 'Apt-get update is running' if status == 'running'
+      end
+    end
+  end
+
+  reap do
+    query 'apt-update'
+    payload 'reap'
+  end
+end
+```
+Which can also be reduced to this, as job named are default query names and `serf_async_task`
+defaults to `start`, `check` and `reap` as payload for managing the life cycle of the command.
+
+```ruby
+serf_async_task 'apt-update' do
+  check do
+    process do |responses|
+      responses.all? do |resp|
+        status = JSON.parse(resp['Payload'])['result']['status']
+        fail ChefRunning if status == 'running'
+      end
+    end
+  end
+end
+```
+
 ## Supported ruby versions
 
 Blender-serf currently support the following MRI versions:

data/blender-serf.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'blender-serf'
-  spec.version       = '0.1.0'
+  spec.version       = '0.2.0'
   spec.authors       = ['Ranjib Dey']
   spec.email         = ['ranjib@pagerduty.com']
   spec.summary       = %q{Serf backend for blender}

data/lib/blender/drivers/serf_async.rb

@@ -47,7 +47,7 @@ module Blender
                 raise ExecutionFailed, cmd.stderr
               end
             end
-            cmd = @driver.run_command(task.stop_query.command, nodes)
+            cmd = @driver.run_command(task.reap_query.command, nodes)
             if cmd.exitstatus != 0 and !task.metadata[:ignore_failure]
               raise ExecutionFailed, cmd.stderr
             end

data/lib/blender/tasks/serf_async.rb

@@ -19,7 +19,7 @@ require 'blender/tasks/serf'
 module Blender
   module Task
     class SerfAsync < Blender::Task::Base
-      attr_reader :start_query, :stop_query, :check_query
+      attr_reader :start_query, :reap_query, :check_query
 
       def initialize(name, options = {})
         super
@@ -29,11 +29,11 @@ module Blender
         @start_query.no_ack(metadata[:no_ack])
         @start_query.process(&metadata[:process])
 
-        @stop_query = Blender::Task::Serf.new(name)
-        @stop_query.payload(metadata[:stop])
-        @stop_query.timeout(metadata[:timeout])
-        @stop_query.no_ack(metadata[:no_ack])
-        @stop_query.process(&metadata[:process])
+        @reap_query = Blender::Task::Serf.new(name)
+        @reap_query.payload(metadata[:reap])
+        @reap_query.timeout(metadata[:timeout])
+        @reap_query.no_ack(metadata[:no_ack])
+        @reap_query.process(&metadata[:process])
 
         @check_query = Blender::Task::Serf.new(name)
         @check_query.payload(metadata[:check])
@@ -42,12 +42,18 @@ module Blender
         @check_query.process(&metadata[:process])
       end
 
+      def query(event)
+        @start_query.query(event)
+        @reap_query.query(event)
+        @check_query.query(event)
+      end
+
       def start(&block)
         @start_query.instance_eval(&block)
       end
 
-      def stop(&block)
-        @stop_query.instance_eval(&block)
+      def reap(&block)
+        @reap_query.instance_eval(&block)
       end
 
       def check(&block)
@@ -61,19 +67,19 @@ module Blender
       end
 
       def retry_options(options = {})
-        @metadata[:retry_options].merge!(options)
+        @metadata[:retry_options] = options
       end
 
       def default_metadata
         {
           ignore_failure: false,
           start: 'start',
-          stop: 'stop',
+          reap: 'reap',
           check: 'check',
           timeout: 5,
           no_ack: false,
           process: nil,
-          retry_options: { max_elapsed_time: 180 }
+          retry_options: { intervals: Array.new(5, 30) }
         }
       end
     end

data/spec/blender/drivers/serf_spec.rb

@@ -61,7 +61,7 @@ describe Blender::Driver::Serf do
       conn = double('serf connection')
       ev = double('serf event')
       allow(ev).to receive(:body).and_return({'success' => true})
-      %w{start stop check}.each do |payload|
+      %w{start reap check}.each do |payload|
         allow(conn).to receive(:query).with('chef', payload , Timeout: 5000000000, FilterNodes: ['node1']).and_yield(ev)
       end
       allow(Serfx).to receive(:connect).with(authkey: 'asyncexample').and_yield(conn)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blender-serf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ranjib Dey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pd-blender
@@ -159,6 +159,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -195,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Serf backend for blender