protobuffy 3.1.0

data/spec/lib/protobuf/rpc/servers/socket_server_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'spec/support/test/resource_service'
+require 'protobuf/rpc/servers/socket_runner'
+require 'protobuf/socket'
+
+describe Protobuf::Rpc::Socket::Server do
+  before(:each) do
+    load 'protobuf/socket.rb'
+  end
+
+  before(:all) do
+    load 'protobuf/socket.rb'
+    Thread.abort_on_exception = true
+    @options = OpenStruct.new(:host => "127.0.0.1", :port => 9399, :backlog => 100, :threshold => 100)
+    @runner = ::Protobuf::Rpc::SocketRunner.new(@options)
+    @server = @runner.instance_variable_get(:@server)
+    @server_thread = Thread.new(@runner) { |runner| runner.run }
+    Thread.pass until @server.running?
+  end
+
+  after(:all) do
+    @server.stop
+    @server_thread.join
+  end
+
+  it "Runner provides a stop method" do
+    @runner.should respond_to(:stop)
+  end
+
+  it "provides a stop method" do
+    @server.should respond_to(:stop)
+  end
+
+  it "signals the Server is running" do
+    @server.should be_running
+  end
+
+end

data/spec/lib/protobuf/rpc/servers/zmq/server_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'protobuf/rpc/servers/zmq/server'
+
+describe Protobuf::Rpc::Zmq::Server do
+  subject { described_class.new(options) }
+
+  let(:options) {{
+    :host => '127.0.0.1',
+    :port => 9399,
+    :worker_port => 9400,
+    :workers_only => true
+  }}
+
+  before do
+    load 'protobuf/zmq.rb'
+  end
+
+  after do
+    subject.teardown
+  end
+
+  describe '.running?' do
+    it 'returns true if running' do
+      subject.instance_variable_set(:@running, true)
+      subject.running?.should be_true
+    end
+
+    it 'returns false if not running' do
+      subject.instance_variable_set(:@running, false)
+      subject.running?.should be_false
+    end
+  end
+
+  describe '.stop' do
+    it 'sets running to false' do
+      subject.instance_variable_set(:@workers, [])
+      subject.stop
+      subject.instance_variable_get(:@running).should be_false
+    end
+  end
+end

data/spec/lib/protobuf/rpc/servers/zmq/util_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+class UtilTest
+  include ::Protobuf::Rpc::Zmq::Util
+end
+
+describe ::Protobuf::Rpc::Zmq::Util do
+  before(:each) do
+    load 'protobuf/zmq.rb'
+  end
+
+  subject { UtilTest.new }
+  describe '#zmq_error_check' do
+    it 'raises when the error code is less than 0' do
+      expect {
+        subject.zmq_error_check(-1, :test)
+      }.to raise_error(/test/)
+    end
+
+    it 'retrieves the error string from ZeroMQ' do
+      ZMQ::Util.stub(:error_string).and_return('an error from zmq')
+      expect {
+        subject.zmq_error_check(-1, :test)
+      }.to raise_error(RuntimeError, /an error from zmq/i)
+    end
+
+    it 'does nothing if the error code is > 0' do
+      expect {
+        subject.zmq_error_check(1, :test)
+      }.to_not raise_error
+    end
+
+    it 'does nothing if the error code is == 0' do
+      expect {
+        subject.zmq_error_check(0, :test)
+      }.to_not raise_error
+    end
+  end
+
+  describe '#log_signature' do
+    it 'returns the signature for the log' do
+      subject.log_signature.should include('server', 'UtilTest')
+    end
+  end
+
+  describe '.resolve_ip' do
+    it 'resolves ips' do
+      expect(subject.resolve_ip('127.0.0.1')).to eq('127.0.0.1')
+    end
+
+    it 'resolves non ips' do
+      expect(subject.resolve_ip('localhost')).to eq('127.0.0.1')
+    end
+  end
+end

data/spec/lib/protobuf/rpc/servers/zmq/worker_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe ::Protobuf::Rpc::Zmq::Worker do
+  before(:each) do 
+    load 'protobuf/zmq.rb'
+
+    fake_socket = double
+    fake_socket.should_receive(:connect).and_return(0)
+    fake_socket.should_receive(:send_string).and_return(0)
+
+    fake_context = double
+    fake_context.should_receive(:socket).and_return( fake_socket )
+    ::ZMQ::Context.should_receive(:new).and_return( fake_context )
+  end
+
+  subject do
+    described_class.new({ :host => '127.0.0.1', :port => 9400 })
+  end
+
+  describe '#run' do
+    # not tested via unit tests
+  end
+
+  describe '#handle_request' do
+    # not tested via unit tests
+  end
+
+  describe '#initialize_buffers' do
+    # not tested via unit tests
+  end
+
+  describe '#send_data' do
+    # not tested via unit tests
+  end
+end

data/spec/lib/protobuf/rpc/service_directory_spec.rb

@@ -0,0 +1,295 @@
+require 'spec_helper'
+
+require 'protobuf/rpc/service_directory'
+
+describe ::Protobuf::Rpc::ServiceDirectory do
+  subject { described_class.instance }
+
+  let(:echo_server) {
+    ::Protobuf::Rpc::DynamicDiscovery::Server.new(
+      :uuid => 'echo',
+      :address => '127.0.0.1',
+      :port => '1111',
+      :ttl => 10,
+      :services => %w[EchoService]
+    )
+  }
+
+  let(:hello_server) {
+    ::Protobuf::Rpc::DynamicDiscovery::Server.new(
+      :uuid => "hello",
+      :address => '127.0.0.1',
+      :port => "1112",
+      :ttl => 10,
+      :services => %w[HelloService]
+    )
+  }
+
+  let(:hello_server_with_short_ttl) {
+    ::Protobuf::Rpc::DynamicDiscovery::Server.new(
+      :uuid => "hello_server_with_short_ttl",
+      :address => '127.0.0.1',
+      :port => '1113',
+      :ttl => 1,
+      :services => %w[HelloService]
+    )
+  }
+
+  let(:combo_server) {
+    ::Protobuf::Rpc::DynamicDiscovery::Server.new(
+      :uuid => "combo",
+      :address => '127.0.0.1',
+      :port => '1114',
+      :ttl => 10,
+      :services => %w[HelloService EchoService]
+    )
+  }
+
+  before(:all) do
+    @address = "127.0.0.1"
+    @port = 33333
+    @socket = UDPSocket.new
+    EchoService = Class.new
+
+    described_class.address = @address
+    described_class.port = @port
+  end
+
+  def expect_event_trigger(event)
+    ::ActiveSupport::Notifications
+      .should_receive(:instrument)
+      .with(event, hash_including(:listing => an_instance_of(::Protobuf::Rpc::ServiceDirectory::Listing)))
+      .once
+  end
+
+  def send_beacon(type, server)
+    type = type.to_s.upcase
+    beacon = ::Protobuf::Rpc::DynamicDiscovery::Beacon.new(
+      :server => server,
+      :beacon_type => ::Protobuf::Rpc::DynamicDiscovery::BeaconType.fetch(type)
+    )
+
+    @socket.send(beacon.encode, 0, @address, @port)
+    sleep 0.01 # give the service directory time to process the beacon
+  end
+
+  it "should be a singleton" do
+    subject.should be_a_kind_of(Singleton)
+  end
+
+  it "should be configured to listen to address 127.0.0.1" do
+    described_class.address.should eq '127.0.0.1'
+  end
+
+  it "should be configured to listen to port 33333" do
+    described_class.port.should eq 33333
+  end
+
+  it "should defer .start to the instance#start" do
+    described_class.instance.should_receive(:start)
+    described_class.start
+  end
+
+  it "should yeild itself to blocks passed to .start" do
+    described_class.instance.stub(:start)
+    expect { |b| described_class.start(&b) }.to yield_with_args(described_class)
+  end
+
+  it "should defer .stop to the instance#stop" do
+    described_class.instance.should_receive(:stop)
+    described_class.stop
+  end
+
+  context "stopped" do
+    before { subject.stop }
+
+    describe "#lookup" do
+      it "should return nil" do
+        send_beacon(:heartbeat, echo_server)
+        subject.lookup("EchoService").should be_nil
+      end
+    end
+
+    describe "#restart" do
+      it "should start the service" do
+        subject.restart
+        subject.should be_running
+      end
+    end
+
+    describe "#running" do
+      it "should be false" do
+        subject.should_not be_running
+      end
+    end
+
+    describe "#stop" do
+      it "has no effect" do
+        subject.stop
+      end
+    end
+  end
+
+  context "started" do
+    before { subject.start }
+    after { subject.stop }
+
+    it { should be_running }
+
+    it "should trigger added events" do
+      expect_event_trigger("directory.listing.added")
+      send_beacon(:heartbeat, echo_server)
+    end
+
+    it "should trigger updated events" do
+      send_beacon(:heartbeat, echo_server)
+      expect_event_trigger("directory.listing.updated")
+      send_beacon(:heartbeat, echo_server)
+    end
+
+    it "should trigger removed events" do
+      send_beacon(:heartbeat, echo_server)
+      expect_event_trigger("directory.listing.removed")
+      send_beacon(:flatline, echo_server)
+    end
+
+    describe "#all_listings_for" do
+      context "when listings are present" do
+        it "returns all listings for a given service" do
+          send_beacon(:heartbeat, hello_server)
+          send_beacon(:heartbeat, combo_server)
+
+          subject.all_listings_for("HelloService").size.should eq(2)
+        end
+      end
+
+      context "when no listings are present" do
+        it "returns and empty array" do
+          subject.all_listings_for("HelloService").size.should eq(0)
+        end
+      end
+    end
+
+    describe "#each_listing" do
+      it "should yield to a block for each listing" do
+        send_beacon(:heartbeat, hello_server)
+        send_beacon(:heartbeat, echo_server)
+        send_beacon(:heartbeat, combo_server)
+
+        expect { |block|
+          subject.each_listing(&block)
+        }.to yield_control.exactly(3).times
+      end
+    end
+
+    describe "#lookup" do
+      it "should provide listings by service" do
+        send_beacon(:heartbeat, hello_server)
+        subject.lookup("HelloService").to_hash.should eq hello_server.to_hash
+      end
+
+      it "should return random listings" do
+        send_beacon(:heartbeat, hello_server)
+        send_beacon(:heartbeat, combo_server)
+
+        uuids = 100.times.map { subject.lookup("HelloService").uuid }
+        uuids.count("hello").should be_within(25).of(50)
+        uuids.count("combo").should be_within(25).of(50)
+      end
+
+      it "should not return expired listings" do
+        send_beacon(:heartbeat, hello_server_with_short_ttl)
+        sleep 1
+        subject.lookup("HelloService").should be_nil
+      end
+
+      it "should not return flatlined servers" do
+        send_beacon(:heartbeat, echo_server)
+        send_beacon(:heartbeat, combo_server)
+        send_beacon(:flatline, echo_server)
+
+        uuids = 100.times.map { subject.lookup("EchoService").uuid }
+        uuids.count("combo").should eq 100
+      end
+
+      it "should return up-to-date listings" do
+        send_beacon(:heartbeat, echo_server)
+        echo_server.port = "7777"
+        send_beacon(:heartbeat, echo_server)
+
+        subject.lookup("EchoService").port.should eq "7777"
+      end
+
+      context 'when given service identifier is a class name' do
+        it 'returns the listing corresponding to the class name' do
+          send_beacon(:heartbeat, echo_server)
+          subject.lookup(EchoService).uuid.should eq echo_server.uuid
+        end
+      end
+    end
+
+    describe "#restart" do
+      it "should clear all listings" do
+        send_beacon(:heartbeat, echo_server)
+        send_beacon(:heartbeat, combo_server)
+        subject.restart
+        subject.lookup("EchoService").should be_nil
+      end
+    end
+
+    describe "#running" do
+      it "should be true" do
+        subject.should be_running
+      end
+    end
+
+    describe "#stop" do
+      it "should clear all listings" do
+        send_beacon(:heartbeat, echo_server)
+        send_beacon(:heartbeat, combo_server)
+        subject.stop
+        subject.lookup("EchoService").should be_nil
+      end
+
+      it "should stop the server" do
+        subject.stop
+        subject.should_not be_running
+      end
+    end
+  end
+
+  if ENV.key?("BENCH")
+    context "performance" do
+      let(:servers) {
+        100.times.collect do |x|
+          ::Protobuf::Rpc::DynamicDiscovery::Server.new(
+            :uuid => "performance_server#{x + 1}",
+            :address => '127.0.0.1',
+            :port => (5555 + x).to_s,
+            :ttl => rand(1..5),
+            :services => 10.times.collect { |y| "PerformanceService#{y}" }
+          )
+        end
+      }
+
+      before do
+        require 'benchmark'
+        subject.start
+        servers.each { |server| send_beacon(:heartbeat, server) }
+      end
+
+      after do
+        subject.stop
+      end
+
+      it "should perform lookups in constant time" do
+        print "\n\n"
+        Benchmark.bm(17) do |x|
+          x.report("  1_000 lookups:") {   1_000.times { subject.lookup("PerformanceService#{rand(0..9)}") } }
+          x.report(" 10_000 lookups:") {  10_000.times { subject.lookup("PerformanceService#{rand(0..9)}") } }
+          x.report("100_000 lookups:") { 100_000.times { subject.lookup("PerformanceService#{rand(0..9)}") } }
+        end
+      end
+    end
+  end
+end