serf_handler 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d33048b27550b3dca5819f6169b83bae581b64be
-  data.tar.gz: 8b9b281100c01c077e04c3fc8babe5246e91c598
+  metadata.gz: 00eea1fb24bfec8dfead8736d7cb23440912bf85
+  data.tar.gz: 0782038b311bda6e41a695ef20fd03ac053dec9b
 SHA512:
-  metadata.gz: 7e65bf47996eadf228055a613601549c9fd61a2182f54c1e4e3e39168eef2a07e29b1bbf1d49a8e56fae7338d3100562d65c5d8ef518db9eb02580c444db09d5
-  data.tar.gz: 0682ee1ea57d4839e7fb94f46cb3be42d3cb9fb93071d25ecbca52d2e6018a7bdf1034b355603cbfe9ed603a5e596f09f68abe27e7ab90d18277be058a31a91c
+  metadata.gz: 54ce860d1c4a1c108d661b56708dab420912cad330707593b66404cb2fb01e0bb9a9960071ae7f9e426ed19560756e28a1f5cd67d1af9e77e2f12cc16708085c
+  data.tar.gz: c080b5a54e9cc28aded5a503015f0de1ed5658c753707deaa5a9e0382f413960effcfda3bb7f673b9278c51535760539c4e513f8df0907f428916f03eebd68e4

data/.gitignore

@@ -20,4 +20,4 @@ vendor
 *~
 .gitignore~
 *.zip
-
+build/

data/README.md

@@ -35,6 +35,19 @@ class MyEventHandler < SerfHandler
     log "start processing custom event"
     # write your code
   end
+  
+  # called by SerfHandlerProxy when you issue custom query
+  # ex. serf query your_query_name "PAYLOAD"
+  def your_query_name
+    # write your code
+    
+    reponse("query reponse message you want to return")
+    # if reponse message exceeds 1024 bytes limitation,
+    # SerfHandler returns "message exceeds limit of 1024 bytes." to serf query client.
+    # if you implement the methods for queries,
+    # you have to set logfile.
+    # serf query command returns output of stdout/stderr.
+  end
 end
 
 if __FILE__ == $0

data/example/README.md

@@ -0,0 +1,17 @@
+example
+=======
+You may control the service and system by using serf queries.
+For example,
+
+```
+serf query -tag role=web start iis
+```
+
+allows to start iis on the machine which has the role of web.
+
+```
+serf query -node your_host reboot
+```
+
+allow to reboot on your_host.
+

data/example/cmd.yml

@@ -0,0 +1,31 @@
+# service, system control commands
+service:
+    start:
+        iis: "iisreset.exe /start > nul"
+        mongo: "service mongod start > /dev/null 2>&1"
+        haproxy: "service haproxy start >/dev/null 2>&1"
+    stop:
+        iis: "iisreset.exe /stop > nul"
+        mongo: "service mongod stop > /dev/null 2>&1"
+        haproxy: "service haproxy stop >/dev/null 2>&1"
+    restart:
+        iis: "iisreset.exe /restart > nul"
+        mongo: "service mongod restart > /dev/null 2>&1"
+        haproxy: "service haproxy restart >/dev/null 2>&1"
+    reload:
+        iis: "iisreset.exe /restart > nul"
+        mongo: "service mongod restart > /dev/null 2>&1"
+        haproxy: "service haproxy reload >/dev/null 2>&1"
+    status:
+        iis: "iisreset.exe /status"
+        mongo: "service mongod status > /dev/null 2>&1"
+        haproxy: "service haproxy status"
+system:
+    shutdown:
+        lb: "shutdown -h 1 >/dev/null 2>&1"
+        mongo: "shutdown -h 1 >/dev/null 2>&1"
+        web: "shutdown /s /t 60 > nul"
+    reboot:
+        lb: "shutdown -r 1 >/dev/null 2>&1"
+        mongo: "shutdown -r 1 >/dev/null 2>&1"
+        web: "shutdown /r /t 60 > nul"

data/example/custom_query_handler.rb

@@ -0,0 +1,66 @@
+# -*- coding: utf-8 -*-
+# custome_event_handler.rb
+#
+# for maintenance
+#  Control services
+#   serf query -tag role=web status iis
+#  Control system shutdown or reboot
+#   serf event system_ctl 'shutdown lb'
+
+require 'yaml'
+require 'serf_handler'
+
+# extended class processing serf custom queries
+class CustomQueryHandler < SerfHandler
+  CMDFILE = '/etc/serf/cmd.yml'
+  LOGFILE = '/var/log/serf/query_handler.log'
+  SERVICE_METHOD_NAME = %w( start stop restart reload status )
+  SYSTEM_METHOD_NAME = %w( shutdown reboot )
+
+  def initialize
+    super(LOGFILE)
+    @cmds = YAML.load_file(CMDFILE)
+  end
+
+  # generate start, stop, restart, reload, status methods.
+  SERVICE_METHOD_NAME.each do |m|
+    define_method(m) do
+      info = {}
+      STDIN.each_line { |line| info[:target], _ = line.split(' ') }
+      execute_command @cmds['service']["#{m}"][info[:target]]
+    end
+  end
+
+  # generate shutdown, reboot methods.
+  SYSTEM_METHOD_NAME.each do |m|
+    define_method(m) { execute_command @cmds['system']["#{m}"][@role] }
+  end
+
+  def execute_command(command)
+    result = `#{command}`
+    log "execute #{command} => result: #{$CHILD_STATUS}"
+    result_response $CHILD_STATUS unless command.downcase.include?('status')
+    status_response result if command.downcase.include?('status')
+  end
+
+  def result_response(result)
+    if result.to_s.include?('exit 0')
+      response('success')
+    else
+      response('fail')
+    end
+  end
+
+  def status_response(result)
+    case result.encode('UTF-8')
+    when /実行中|running/ then response('running')
+    when /停止|stopped/   then response('stopped')
+    end
+  end
+end
+
+if __FILE__ == $PROGRAM_NAME
+  handler = SerfHandlerProxy.new
+  handler.register('default', CustomQueryHandler.new)
+  handler.run
+end

data/lib/serf_handler.rb

@@ -1,41 +1,39 @@
 # -*- coding: utf-8 -*-
 # @author katsuyuki
 #
-require "logger"
+require 'logger'
 
+# Base class for processing serf events
 class SerfHandler
-  attr :name, :role, :event
+  attr_reader :name, :role, :event
 
-  def initialize(log=nil)
-    if log
-      if log.kind_of?(String)
-        @logger = Logger.new(log)
-      else
-        @logger = log
-      end
-    else
-      @logger = Logger.new(STDOUT)
-      @logger.level = Logger::INFO
-    end
+  def initialize(log_file = nil)
+    @logger = create_logger(log_file)
+    @logger.level = Logger::INFO
     @name = ENV['SERF_SELF_NAME']
     @role = ENV['SERF_TAG_ROLE'] || ENV['SERF_SELF_ROLE']
     @event = case ENV['SERF_EVENT']
-             when 'user'
-               ENV['SERF_USER_EVENT']
-             when 'query'
-               ENV['SERF_QUERY_NAME']
-             else
-               ENV['SERF_EVENT'].gsub(/-/, '_')
+             when 'user'  then ENV['SERF_USER_EVENT']
+             when 'query' then ENV['SERF_QUERY_NAME']
+             else              ENV['SERF_EVENT'].gsub(/-/, '_')
              end
   end
 
+  def create_logger(log_file)
+    if log_file
+      log_file.is_a?(String) ? Logger.new(log_file) : log_file
+    else
+      Logger.new(STDOUT)
+    end
+  end
+
   def log(msg)
     @logger.info(msg)
   end
 
   def response(msg)
     if msg.bytesize > 1024
-      message = "message exceeds limit of 1024 bytes."
+      message = 'message exceeds limit of 1024 bytes.'
       log message
       puts message
     else
@@ -44,8 +42,9 @@ class SerfHandler
   end
 end
 
+# Proxy for handling serf event
 class SerfHandlerProxy < SerfHandler
-  def initialize(log_file=nil)
+  def initialize(log_file = nil)
     super(log_file)
     @handlers = {}
   end
@@ -54,25 +53,25 @@ class SerfHandlerProxy < SerfHandler
     @handlers[role] = handler
   end
 
-  def get_klass()
-    klass = false
+  def good_handler
+    handler = nil
     if @handlers.include?(@role)
-      klass = @handlers[@role]
+      handler = @handlers[@role]
     elsif @handlers.include?('default')
-      klass = @handlers['default']
+      handler = @handlers['default']
     end
-    klass
+    handler
   end
 
-  def run()
-    unless klass = get_klass
-      log "no handler for role"
-    else
+  def run
+    if (the_handler = good_handler)
       begin
-        klass.send @event
-      rescue NoMethodError => e
+        the_handler.send @event
+      rescue NoMethodError
         log "#{@event} event not implemented by class"
       end
+    else
+      log 'no handler for role'
     end
   end
 end

data/serf_handler.gemspec

@@ -5,7 +5,7 @@ require 'serf_handler'
 
 Gem::Specification.new do |gem|
   gem.name        = 'serf_handler'
-  gem.version     = '0.2.0'
+  gem.version     = '0.2.1'
   gem.authors     = ['KONNO Katsuyuki']
   gem.email       = 'konno.katsuyuki@nifty.com'
   gem.description = 'Serf event handler for ruby'
@@ -23,5 +23,5 @@ Gem::Specification.new do |gem|
     'README.md'
   ]
 
-  gem.add_runtime_dependency('logger', ['>= 1.2.8'])
-end
+  gem.add_runtime_dependency('logger')
+end

data/spec/serf_handler_spec.rb

@@ -1,30 +1,31 @@
 require 'spec_helper'
+require 'logger'
 
-describe "SerfHandler" do
-  context "Check initialize process" do
+describe 'SerfHandler' do
+  context 'Check initialize process' do
     before do
       ENV['SERF_SELF_NAME'] = 'local'
       ENV['SERF_SELF_ROLE'] = 'web'
       ENV['SERF_EVENT'] = 'member-join'
     end
 
-    it "has handler name as 'local'" do
+    it 'has handler name as local' do
       handler = SerfHandler.new
       expect(handler.name).to eq('local')
     end
 
-    it "has handler role as 'web'" do
+    it 'has handler role as web' do
       handler = SerfHandler.new
       expect(handler.role).to eq('web')
     end
 
-    it "is set the event: 'member-join'" do
+    it 'is set the event: member-join' do
       handler = SerfHandler.new
       expect(handler.event).to eq('member_join')
     end
   end
 
-  context "Check user event processing" do
+  context 'Check user event processing' do
     before do
       ENV['SERF_SELF_NAME'] = 'local'
       ENV['SERF_SELF_ROLE'] = 'web'
@@ -32,28 +33,28 @@ describe "SerfHandler" do
       ENV['SERF_USER_EVENT'] = 'deploy'
     end
 
-    it "has custome event: user" do
+    it 'has custome event: user' do
       handler = SerfHandler.new
       expect(handler.event).to eq('deploy')
     end
   end
 end
 
-describe "SerfHandlerProxy" do
-  context "Check Processing Tags" do
+describe 'SerfHandlerProxy' do
+  context 'Check Processing Tags' do
     before do
       ENV['SERF_SELF_NAME'] = nil
       ENV['SERF_TAG_ROLE'] = 'bob'
       ENV['SERF_EVENT'] = 'member-join'
     end
 
-    it "has the role as bob" do
+    it 'has the role as bob' do
       handler = SerfHandlerProxy.new
       expect(handler.role).to eq('bob')
     end
   end
 
-  context "Test negative cases" do
+  context 'Test negative cases' do
     before do
       ENV['SERF_TAG_ROLE'] = nil
       ENV['SERF_SELF_NAME'] = nil
@@ -61,23 +62,25 @@ describe "SerfHandlerProxy" do
       ENV['SERF_EVENT'] = 'member-join'
     end
 
-    it "has no role" do
+    it 'has no role' do
       logger = double('Logger')
-      expect(logger).to receive(:info).with("no handler for role").and_return(true)
+      expect(logger).to receive(:level=).with(Logger::INFO)
+      expect(logger).to receive(:info).with('no handler for role').and_return(true)
       handler = SerfHandlerProxy.new(logger)
       expect(handler.run).to be true
     end
 
-    it "has no method implemented" do
+    it 'has no method implemented' do
       logger = double('Logger')
-      expect(logger).to receive(:info).with("member_join event not implemented by class").and_return(true)
+      expect(logger).to receive(:level=).with(Logger::INFO)
+      expect(logger).to receive(:info).with('member_join event not implemented by class').and_return(true)
       handler = SerfHandlerProxy.new(logger)
       handler.register('default', SerfHandler.new)
       expect(handler.run).to be true
     end
   end
 
-  context "Test custom event" do
+  context 'Test custom event' do
     before do
       ENV['SERF_SELF_NAME'] = nil
       ENV['SERF_SELF_ROLE'] = nil
@@ -85,7 +88,7 @@ describe "SerfHandlerProxy" do
       ENV['SERF_USER_EVENT'] = 'implemented'
     end
 
-    it "has method to process custom event" do
+    it 'has method to process custom event' do
       handler = SerfHandlerProxy.new
       sample = double('SerfHandler')
       expect(sample).to receive(:implemented).and_return(true)
@@ -94,7 +97,7 @@ describe "SerfHandlerProxy" do
     end
   end
 
-  context "Test custom query" do
+  context 'Test custom query' do
     before do
       ENV['SERF_SELF_NAME'] = nil
       ENV['SERF_SELF_ROLE'] = nil
@@ -102,7 +105,7 @@ describe "SerfHandlerProxy" do
       ENV['SERF_QUERY_NAME'] = 'query_command'
     end
 
-    it "has method to process custom event" do
+    it 'has method to process custom event' do
       handler = SerfHandlerProxy.new
       sample = double('SerfHandler')
       expect(sample).to receive(:query_command).and_return(true)
@@ -110,9 +113,9 @@ describe "SerfHandlerProxy" do
       expect(handler.run).to be true
     end
 
-    it "exceeds limitation" do
+    it 'exceeds limitation' do
       handler = SerfHandler.new
-      message = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed at purus sapien. Fusce vitae odio tristique, 
+      message = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed at purus sapien. Fusce vitae odio tristique, 
                  lacinia purus sed, dictum risus. Nullam rhoncus auctor sapien, nec interdum diam interdum sed. Nulla quis 
                  posuere justo. Donec porta, odio eget mollis laoreet, elit leo sollicitudin nisl, luctus vehicula velit 
                  erat eu est. Fusce ligula urna, blandit a iaculis nec, suscipit ut purus. Donec sed magna ac mi cursus 
@@ -123,18 +126,18 @@ describe "SerfHandlerProxy" do
                  Donec nec hendrerit dolor. Phasellus ac augue lobortis, vestibulum lacus at, ornare enim. Donec condimentum 
                  quis tellus vulputate auctor. Fusce eu tortor vel velit gravida eleifend id a lorem. Maecenas porta est vel 
                  sollicitudin ornare. Morbi et commodo diam, non congue nisi. Pellentesque mattis enim lobortis, hendrerit 
-                 nulla eget, tempus diam. Donec orci aliquam."
+                 nulla eget, tempus diam. Donec orci aliquam.'
       expect{ handler.response(message) }.to output("message exceeds limit of 1024 bytes.\n").to_stdout
     end
   end
 
-  context "Test standard event when role is default" do
+  context 'Test standard event when role is default' do
     before do
       ENV['SERF_SELF_NAME'] = nil
       ENV['SERF_EVENT'] = 'member-join'
     end
 
-    it "has method to process member_join event" do
+    it 'has method to process member_join event' do
       handler = SerfHandlerProxy.new
       sample = double('SerfHandler')
       expect(sample).to receive(:member_join).and_return(true)
@@ -143,14 +146,14 @@ describe "SerfHandlerProxy" do
     end
   end
 
-  context "Test standard event when role is web" do
+  context 'Test standard event when role is web' do
     before do
       ENV['SERF_SELF_NAME'] = nil
       ENV['SERF_SELF_ROLE'] = 'web'
       ENV['SERF_EVENT'] = 'member-join'
     end
 
-    it "has method to process member_join event" do
+    it 'has method to process member_join event' do
       handler = SerfHandlerProxy.new
       sample = double('SerfHandler')
       expect(sample).to receive(:member_join).and_return(true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serf_handler
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - KONNO Katsuyuki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-04 00:00:00.000000000 Z
+date: 2014-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.2.8
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.2.8
+        version: '0'
 description: Serf event handler for ruby
 email: konno.katsuyuki@nifty.com
 executables: []
@@ -38,14 +38,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- build/.gitignore
-- build/Gemfile
-- build/LICENSE.txt
-- build/README.md
-- build/Rakefile
-- build/build.gemspec
-- build/lib/build.rb
-- build/lib/build/version.rb
+- example/README.md
+- example/cmd.yml
+- example/custom_query_handler.rb
 - lib/serf_handler.rb
 - serf_handler.gemspec
 - spec/serf_handler_spec.rb

data/build/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/build/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in build.gemspec
-gemspec

data/build/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 konchan
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/build/README.md

@@ -1,31 +0,0 @@
-# Build
-
-TODO: Write a gem description
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'build'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install build
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/build/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request

data/build/Rakefile

@@ -1,2 +0,0 @@
-require "bundler/gem_tasks"
-

data/build/build.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'build/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "build"
-  spec.version       = Build::VERSION
-  spec.authors       = ["konchan"]
-  spec.email         = ["konno.katsuyuki@nifty.com"]
-  spec.summary       = %q{TODO: Write a short summary. Required.}
-  spec.description   = %q{TODO: Write a longer description. Optional.}
-  spec.homepage      = ""
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
-end

data/build/lib/build.rb

@@ -1,5 +0,0 @@
-require "build/version"
-
-module Build
-  # Your code goes here...
-end

data/build/lib/build/version.rb

@@ -1,3 +0,0 @@
-module Build
-  VERSION = "0.0.1"
-end