villein 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df2731fb88973b484824361021f7e95383f6642c
-  data.tar.gz: 9b68ffc3464ee705d645446fdf017819da130340
+  metadata.gz: 7f55592c52186b2368ce3cdee25bc3726321ab5b
+  data.tar.gz: 6f20e0f243da17e2c400d1207069fe796a2022f0
 SHA512:
-  metadata.gz: a375d7bc0d40dc65b5fe94bc5b80ed0074a1efd53c48b5ced070d7bb4ed8cab085ecad3cea4994c3a79bf7512338995db5b65b9e7f093f3dcd46fcd8596d056a
-  data.tar.gz: 4eadcdd42d2619e7d77c5ee1ece33029fb5218f437ed9c4b10a80a0b06a1edcc278f357ac1c195475120f14e3516090f025b2cfe7cbbcf41b56ef80123c37980
+  metadata.gz: 202eda9a335d1239cb69f025c9239d715ca566cc710e8e2a0239bf42e1b2542b90cfea5948b65b08442770fe373b5abb2c32dbd459ca4018f8a0428f916e4f42
+  data.tar.gz: 320efc986bf0c185db5ce68dcecb296a5e5a4a9b97204927a61ba42c7b90f02d283150e2af9776d16555493de324dea15bc5b61c28e30f703bcc030ed8c2a5f8

data/lib/villein/client.rb

@@ -6,6 +6,19 @@ 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
+
+    ##
+    # Error for the given argument exceeds the limit of serf when setting tags and sending events.
+    class LengthExceedsLimitError < SerfError; end
+
+    ##
+    # Error for connection failures
+    class SerfConnectionError < SerfError; end
+
     def initialize(rpc_addr, name: nil, serf: 'serf', silence: true)
       @rpc_addr = rpc_addr
       @name = name
@@ -56,7 +69,7 @@ module Villein
         options.push('-tag', "#{tag}=#{val}")
       end
 
-      json = IO.popen(['serf', 'members', "-rpc-addr=#{rpc_addr}", *options], 'r', &:read)
+      json = call_serf('members', *options)
       response = JSON.parse(json)
 
       response["members"]
@@ -94,14 +107,23 @@ module Villein
     private 
 
     def call_serf(cmd, *args)
-      options = {}
+      status, out = IO.popen([@serf, cmd, "-rpc-addr=#{rpc_addr}", *args, err: [:child, :out]], 'r') do |io|
+        _, s = Process.waitpid2(io.pid)
+        [s, io.read]
+      end
 
-      if silence?
-        options[:out] = File::NULL
-        options[:err] = File::NULL
+      unless status.success?
+        case out
+        when /^Error connecting to Serf agent:/
+          raise SerfConnectionError, out.chomp
+        when /exceeds limit of \d+ bytes$/
+          raise LengthExceedsLimitError, out.chomp
+        else
+          raise SerfError, out.chomp
+        end
       end
 
-      system @serf, cmd, "-rpc-addr=#{rpc_addr}", *args, options
+      out
     end
   end
 end

data/lib/villein/version.rb

@@ -1,3 +1,3 @@
 module Villein
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/client_spec.rb

@@ -5,58 +5,132 @@ describe Villein::Client do
   let(:name) { 'the-node' }
   subject(:client) { described_class.new('x.x.x.x:nnnn', name: name) }
 
-  def expect_serf(cmd, *args, retval: true, out: File::NULL)
-    expect(subject).to receive(:system) \
-      .with('serf', cmd, '-rpc-addr=x.x.x.x:nnnn', *args, out: out, err: out) \
-      .and_return(retval)
+  def expect_serf(cmd, *args, success: true, message: '')
+    if [cmd, *args].compact.empty?
+      expect(IO).to receive(:popen) \
+        .with(any_args)
+        .and_yield(double('io', read: message, pid: 727272))
+
+    else
+      expect(IO).to receive(:popen) \
+        .with(['serf', cmd, '-rpc-addr=x.x.x.x:nnnn', *args,
+               err: [:child, :out]],
+              'r') \
+        .and_yield(double('io', read: message, pid: 727272))
+    end
+
+    status = double('proc-status', pid: 727272, success?: success)
+
+    allow(Process).to receive(:waitpid2).with(727272).and_return([727272, status])
+  end
+
+  shared_examples "failure cases" do
+    context "when command failed" do
+      it "raises error" do
+        expect_serf(nil, success: false, message: 'err')
+
+        expect {
+          subject
+        }.to raise_error(Villein::Client::SerfError, 'err')
+      end
+    end
+
+    context "when connection failed" do
+      it "raises error" do
+        expect_serf(nil,
+          success: false,
+          message: 'Error connecting to Serf agent: dial tcp x.x.x.x:nnnn: connection refused')
+
+        expect {
+          subject
+        }.to raise_error(
+          Villein::Client::SerfConnectionError,
+          'Error connecting to Serf agent: dial tcp x.x.x.x:nnnn: connection refused')
+      end
+    end
   end
 
   describe "#event" do
+    subject { client.event('test', 'payload') }
+
     it "sends user event" do
       expect_serf('event', 'test', 'payload')
 
-      client.event('test', 'payload')
+      subject
     end
 
     context "with coalesce=false" do
+      subject { client.event('test', 'payload', coalesce: false) }
+
       it "sends user event with the option" do
         expect_serf('event', '-coalesce=false', 'test', 'payload')
 
-        client.event('test', 'payload', coalesce: false)
+        subject
+      end
+    end
+
+    include_examples "failure cases"
+
+    context "when length exceeds limit" do
+      it "raises error" do
+        expect_serf('event', 'test', 'payload',
+          success: false,
+          message: 'Error sending event: user event exceeds limit of 256 bytes')
+
+        expect {
+          subject
+        }.to raise_error(
+          Villein::Client::LengthExceedsLimitError,
+          'Error sending event: user event exceeds limit of 256 bytes')
       end
     end
+
   end
 
   describe "#join" do
+    subject { client.join('y.y.y.y:nnnn') }
+
     it "attempts to join another node" do
       expect_serf('join', 'y.y.y.y:nnnn')
 
-      client.join('y.y.y.y:nnnn')
+      subject
     end
 
     context "with replay=true" do
+      subject { client.join('y.y.y.y:nnnn', replay: true) }
+
       it "attempts to join another node with replaying" do
         expect_serf('join', '-replay', 'y.y.y.y:nnnn')
 
-        client.join('y.y.y.y:nnnn', replay: true)
+        subject
       end
     end
+
+    include_examples "failure cases"
   end
 
   describe "#leave" do
+    subject { client.leave }
+
     it "attempts to leave from cluster" do
       expect_serf('leave')
 
-      client.leave
+      subject
     end
+
+    include_examples "failure cases"
   end
 
   describe "#force_leave" do
+    subject { client.force_leave('the-node') }
+
     it "attempts to remove member forcely" do
       expect_serf('force-leave', 'the-node')
 
-      client.force_leave('the-node')
+      subject
     end
+
+    include_examples "failure cases"
   end
 
   describe "#members" do
@@ -65,18 +139,18 @@ describe Villein::Client do
     "tags":{"key":"val"},"status":"alive","protocol":{"max":4,"min":2,"version":4}}]}
     EOJ
 
+    subject(:members) { client.members }
+
     it "returns member list" do
-      allow(IO).to receive(:popen).with(%w(serf members -rpc-addr=x.x.x.x:nnnn -format json), 'r') \
-        .and_yield(double('io', read: json))
+      expect_serf('members', '-format', 'json', message: json)
 
-      expect(client.members).to be_a_kind_of(Array)
-      expect(client.members[0]["name"]).to eq "the-node"
+      expect(members).to be_a_kind_of(Array)
+      expect(members[0]["name"]).to eq "the-node"
     end
 
     context "with status filter" do
       it "returns member list" do
-        allow(IO).to receive(:popen).with(%w(serf members -rpc-addr=x.x.x.x:nnnn -format json -status alive), 'r') \
-          .and_yield(double('io', read: json))
+        expect_serf('members', '-format', 'json', '-status', 'alive', message: json)
 
         client.members(status: :alive)
       end
@@ -84,8 +158,7 @@ describe Villein::Client do
 
     context "with name filter" do
       it "returns member list" do
-        allow(IO).to receive(:popen).with(%w(serf members -rpc-addr=x.x.x.x:nnnn -format json -name node), 'r') \
-          .and_yield(double('io', read: json))
+        expect_serf('members', '-format', 'json', '-name', 'node', message: json)
 
         client.members(name: 'node')
       end
@@ -93,12 +166,13 @@ describe Villein::Client do
 
     context "with tag filter" do
       it "returns member list" do
-        allow(IO).to receive(:popen).with(%w(serf members -rpc-addr=x.x.x.x:nnnn -format json -tag a=1 -tag b=2), 'r') \
-          .and_yield(double('io', read: json))
+        expect_serf('members', *%w(-format json -tag a=1 -tag b=2), message: json)
 
         client.members(tags: {a: '1', b: '2'})
       end
     end
+
+    include_examples "failure cases"
   end
 
   describe "#tags" do
@@ -117,19 +191,41 @@ describe Villein::Client do
   end
 
   describe "#set_tag" do
+    subject { client.set_tag('newkey', 'newval') }
+
     it "sets tag" do
       expect_serf('tags', '-set', 'newkey=newval')
 
-      client.set_tag('newkey', 'newval')
+      subject
+    end
+
+    include_examples "failure cases"
+
+    context "when length exceeds limit" do
+      it "raises error" do
+        expect_serf('tags', '-set', 'newkey=newval',
+          success: false,
+          message: 'Error setting tags: Encoded length of tags exceeds limit of 512 bytes')
+
+        expect {
+          client.set_tag('newkey', 'newval')
+        }.to raise_error(
+          Villein::Client::LengthExceedsLimitError,
+          'Error setting tags: Encoded length of tags exceeds limit of 512 bytes')
+      end
     end
   end
 
   describe "#delete_tag" do
+    subject { client.delete_tag('newkey') }
+
     it "deletes tag" do
       expect_serf('tags', '-delete', 'newkey')
 
-      client.delete_tag('newkey')
+      subject
     end
+
+    include_examples "failure cases"
   end
 
   describe "#get_tags" do
@@ -141,8 +237,7 @@ describe Villein::Client do
         "tags":{"key":"val"},"status":"alive","protocol":{"max":4,"min":2,"version":4}}]}
       EOJ
 
-      allow(IO).to receive(:popen).with(%w(serf members -rpc-addr=x.x.x.x:nnnn -format json -name the-node), 'r') \
-        .and_yield(double('io', read: json))
+      expect_serf('members', *%w(-format json -name the-node), message: json)
 
       expect(tags).to be_a_kind_of(Hash)
       expect(tags['key']).to eq 'val'
@@ -155,6 +250,8 @@ describe Villein::Client do
         expect { tags }.to raise_error
       end
     end
+
+    include_examples "failure cases"
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: villein
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Shota Fukumori (sora_h)