villein 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38c9a67c0adcd3eafe19bf994a262a9b08e979cf
-  data.tar.gz: a73173192b4a03fd78130a0368eaf00530b64646
+  metadata.gz: 5d9b9e6c34204126822c64c925e9a83ef3120b29
+  data.tar.gz: 548c1b7932f71f81db8df8fb23f70a9a3ae10879
 SHA512:
-  metadata.gz: b24d9254bf8db038f6434c36fd565e452b199bdd20d37968474e499c563ab5d402dc929935df97337f8571c2aa8c122968ced37ac275c139e26cb889ca7d8d70
-  data.tar.gz: 50eb72e17349da8b03c0ab18d81e56cd981d20be91728d190e4927c53350cb5d875877b6fd7f3ef9cfd16c2b2279488c6ebcc7b68cdc12032699497855ed4348
+  metadata.gz: 84d91183e28e93240f478ea4ecaeebaafdbe027c3c7506fb77f8bab97ce7fc1a1c4f4b4c45f3f8298992ea6310668d525cfc4054dc2fe0bef161316a33dee9da
+  data.tar.gz: f3632f50eded1238d24d645228871ff6edd3b99f2f637f0534bd0633d5bc6e147d18321ffc0f8348aaae2f62af6fac596d672697f3508ff4469781fa973937b6

data/.travis.yml

@@ -17,7 +17,7 @@ notifications:
     - travis-ci@sorah.jp
 before_script:
   - mkdir -p vendor/serf
-  - curl -L -o vendor/serf/serf.zip https://dl.bintray.com/mitchellh/serf/0.5.0_linux_amd64.zip
+  - curl -L -o vendor/serf/serf.zip https://dl.bintray.com/mitchellh/serf/0.6.0_linux_amd64.zip
   - unzip -d vendor/serf vendor/serf/serf.zip
   - export PATH=$PWD/vendor/serf:$PATH
 script: bundle exec rspec -fd ./spec

data/lib/villein/agent.rb

@@ -11,6 +11,7 @@ module Villein
   class Agent < Client
     class AlreadyStarted < Exception; end
     class NotRunning < Exception; end
+    class ResponderExists < Exception; end
 
     EVENT_HANDLER_SH = File.expand_path(File.join(__dir__, '..', '..', 'misc', 'villein-event-handler'))
 
@@ -33,7 +34,9 @@ module Villein
       @custom_event_handlers, @replay = event_handlers, replay
       @initial_tags, @tags_file = tags, tags_file
       @log_level, @log = log_level, log
+
       @hooks = {}
+      @responders = {}
 
       @pid, @exitstatus = nil, nil
       @pid_lock = Mutex.new
@@ -156,6 +159,18 @@ module Villein
       cmd.flatten.map(&:to_s)
     end
 
+    ##
+    # Respond to query events.
+    # Raises error when override is false and responder for given query name already exists.
+    def respond(name, override: false, &block)
+      name = name.to_s
+      if !override && @responders[name]
+        raise ResponderExists, "Responder for #{name} already exists. To force, pass `override: true`"
+      end
+
+      @responders[name] = block
+    end
+
     private
 
     def start_process
@@ -236,7 +251,7 @@ module Villein
               break if socks[0].eof?
             end
 
-            handle_event buf
+            handle_event buf, sock
           ensure
             sock.close unless sock.closed?
           end
@@ -244,7 +259,7 @@ module Villein
       end
     end
 
-    def handle_event(json)
+    def handle_event(json, sock)
       event_payload = JSON.parse(json)
       event = Event.new(event_payload['env'], payload: event_payload['input'])
 
@@ -252,8 +267,15 @@ module Villein
 
       call_hooks event.type.gsub(/-/, '_'), event
       call_hooks 'event', event
+
+      if event.type == 'query' && @responders[event.query_name]
+        sock.write(@responders[event.query_name].call(event))
+      end
     rescue JSON::ParserError
       # do nothing
+    rescue Exception => e
+      $stderr.puts "Exception during handling event: #{event.inspect}"
+      $stderr.puts e.backtrace.map { |_| _.prepend("\t") }
     end
 
     def hooks_for(name)

data/lib/villein/client.rb

@@ -6,7 +6,6 @@ module Villein
   # Villein::Client allows you to order existing serf agent.
   # You will need RPC address and agent name to command.
   class Client
-
     ##
     # for serf command failures
     class SerfError < Exception; end
@@ -19,11 +18,21 @@ module Villein
     # Error for connection failures
     class SerfConnectionError < SerfError; end
 
+    ##
+    # Error when an called serf command is not found.
+    class SerfCommandNotFound < SerfError; end
+
+    ##
+    # Error when an operation is not supported by the current version.
+    class InsufficientVersionError < SerfError; end
+
     def initialize(rpc_addr, name: nil, serf: 'serf', silence: true)
       @rpc_addr = rpc_addr
       @name = name
       @serf = serf
       @silence = true
+
+      retrieve_name unless @name
     end
 
     def silence?() !!@silence; end
@@ -31,6 +40,15 @@ module Villein
 
     attr_reader :name, :rpc_addr, :serf
 
+    ##
+    # Returns a result of `serf info`.
+    # This may raise InsufficientVersionError when `serf info` is not supported.
+    def info
+      JSON.parse call_serf('info', '-format', 'json')
+    rescue SerfCommandNotFound
+      raise InsufficientVersionError, 'serf v0.6.0 or later is required to run `serf info`.'
+    end
+
     def event(name, payload, coalesce: true)
       options = []
 
@@ -41,6 +59,36 @@ module Villein
       call_serf 'event', *options, name, payload
     end
 
+    def query(name, payload, node: nil, tag: nil, timeout: nil, no_ack: false)
+      # TODO: version check
+      options = ['-format', 'json']
+
+      if node
+        node = [node] unless node.respond_to?(:each)
+        node.each do |n|
+          options << "-node=#{n}"
+        end
+      end
+
+      if tag
+        tag = [tag] unless tag.respond_to?(:each)
+        tag.each do |t|
+          options << "-tag=#{t}"
+        end
+      end
+
+      if timeout
+        options << "-timeout=#{timeout}"
+      end
+
+      if no_ack
+        options << "-no-ack"
+      end
+
+      out = call_serf('query', *options, name, payload)
+      JSON.parse(out)
+    end
+
     def join(addr, replay: false)
       options = []
 
@@ -106,6 +154,10 @@ module Villein
 
     private 
 
+    def retrieve_name
+      @name = self.info["agent"]["name"]
+    end
+
     def call_serf(cmd, *args)
       status, out = IO.popen([@serf, cmd, "-rpc-addr=#{rpc_addr}", *args, err: [:child, :out]], 'r') do |io|
         _, s = Process.waitpid2(io.pid)
@@ -118,6 +170,8 @@ module Villein
           raise SerfConnectionError, out.chomp
         when /exceeds limit of \d+ bytes$/
           raise LengthExceedsLimitError, out.chomp
+        when /^Available commands are:/
+          raise SerfCommandNotFound
         else
           raise SerfError, out.chomp
         end

data/lib/villein/version.rb

@@ -1,3 +1,3 @@
 module Villein
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/misc/villein-event-handler

@@ -1,2 +1,15 @@
-#!/bin/bash
-exec ruby -rsocket -rjson -e'TCPSocket.new(ARGV[0], ARGV[1].to_i).puts({env: Hash[ENV.select{|k,v|/SERF/ =~ k}], input: $stdin.read}.to_json)' -- $*
+#!/usr/bin/env ruby
+require 'json'
+require 'socket'
+
+sock = TCPSocket.new(ARGV[0], ARGV[1].to_i)
+
+serf_env = Hash[ENV.select{|k,v|/SERF/ =~ k}]
+input = $stdin.read
+
+sock.puts({env: serf_env, input: input}.to_json)
+sock.close_write
+
+if ENV["SERF_EVENT"] == "query"
+  $stdout.write sock.read
+end

data/spec/agent_spec.rb

@@ -76,6 +76,21 @@ describe Villein::Agent do
     expect(received2.type).to eq 'member-join'
   end
 
+  it "can respond to queries" do
+    agent.respond("hey") do |e|
+      expect(e).to be_a(Villein::Event)
+      "hello"
+    end
+
+    agent.start!
+    Thread.new { agent.wait_for_ready }.join(5)
+    response = agent.query("hey", '')
+    agent.stop!
+
+    expect(response["Responses"].values.first).to eq("hello")
+
+  end
+
   it "can handle unexpected stop" do
     received = nil
     agent.on_stop { |status| received = status }

data/spec/client_spec.rb

@@ -50,6 +50,71 @@ describe Villein::Client do
     end
   end
 
+  describe "#initialize" do
+    context "without name" do
+      subject(:client) { described_class.new('x.x.x.x:nnnn') }
+
+      it "retrieves name using #info" do
+        # we can't use allow(client) here because it calls #initialize!
+        allow_any_instance_of(described_class).to receive(:info).and_return(
+          "agent" => {"name" => "the-name"},
+        )
+
+        expect(client.name).to eq('the-name')
+      end
+    end
+  end
+
+  describe "#info" do
+    let(:json) { (<<-EOJ).gsub(/\n|\s+/,'') }
+    {
+      "agent": {
+        "name": "foo"
+      },
+      "runtime": {
+        "arch": "amd64",
+        "cpu_count": "8",
+        "goroutines": "22",
+        "max_procs": "1",
+        "os": "darwin",
+        "version": "go1.2"
+      },
+      "serf": {
+        "event_queue": "0",
+        "event_time": "1",
+        "failed": "0",
+        "intent_queue": "0",
+        "left": "0",
+        "member_time": "2",
+        "members": "2",
+        "query_queue": "0",
+        "query_time": "3"
+      },
+      "tags": {
+        "thisis": "tag"
+      }
+    }
+    EOJ
+
+    subject(:info) { client.info }
+
+    it "returns `serf info`" do
+      expect_serf('info', '-format', 'json', message: json)
+
+      expect(info).to eq(JSON.parse(json))
+    end
+
+    context "when not available" do
+      it "raises error" do
+        expect_serf('info', '-format', 'json', message: 'Available commands are:', success: false)
+
+        expect { info }.to raise_error(Villein::Client::InsufficientVersionError)
+      end
+    end
+
+    include_examples "failure cases"
+  end
+
   describe "#event" do
     subject { client.event('test', 'payload') }
 
@@ -84,7 +149,76 @@ describe Villein::Client do
           'Error sending event: user event exceeds limit of 256 bytes')
       end
     end
+  end
+
+  describe "#query" do
+    let(:json) { (<<-EOJ).gsub(/\n|\s+/,'') }
+      {"Acks":["foo","bar"], "Responses":{"foo":"response"}}
+    EOJ
 
+    subject(:query) { client.query('test', 'payload') }
+
+    it "sends query event" do
+      expect_serf('query', '-format', 'json', 'test', 'payload', message: json)
+
+      expect(query).to eq(JSON.parse(json))
+    end
+
+    context "with node filter" do
+      context "in String" do
+        subject(:query) { client.query('test', 'payload', node: 'foo') }
+
+        it "queries with -node" do
+          expect_serf('query', '-format', 'json', '-node=foo', 'test', 'payload', message: json)
+          query
+        end
+      end
+
+      context "in Array" do
+        subject(:query) { client.query('test', 'payload', node: %w(foo bar)) }
+
+        it "queries with -node" do
+          expect_serf('query', '-format', 'json', '-node=foo', '-node=bar', 'test', 'payload', message: json)
+          query
+        end
+      end
+    end
+
+    context "with tag filter" do
+      context "in String" do
+        subject(:query) { client.query('test', 'payload', tag: 'foo') }
+
+        it "queries with -tag" do
+          expect_serf('query', '-format', 'json', '-tag=foo', 'test', 'payload', message: json)
+          query
+        end
+      end
+
+      context "in Array" do
+        subject(:query) { client.query('test', 'payload', tag: %w(foo bar)) }
+
+        it "queries with -tag" do
+          expect_serf('query', '-format', 'json', '-tag=foo', '-tag=bar', 'test', 'payload', message: json)
+          query
+        end
+      end
+    end
+
+    include_examples "failure cases"
+
+    context "when length exceeds limit" do
+      it "raises error" do
+        expect_serf('query', '-format', 'json', 'test', 'payload',
+          success: false,
+          message: 'Error sending event: query exceeds limit of 1024 bytes')
+
+        expect {
+          subject
+        }.to raise_error(
+          Villein::Client::LengthExceedsLimitError,
+          'Error sending event: query exceeds limit of 1024 bytes')
+      end
+    end
   end
 
   describe "#join" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: villein
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Shota Fukumori (sora_h)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-30 00:00:00.000000000 Z
+date: 2014-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec