prepor-protobuf 3.5.0

data/spec/lib/protobuf/optionable_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'protobuf/optionable'
+
+RSpec.describe 'Optionable' do
+
+  describe '.set_option' do
+    before(:all) do
+      OptionableSetOptionTest = ::Class.new do
+        include ::Protobuf::Optionable
+      end
+    end
+
+    it 'stores the given option and value' do
+      expect(OptionableSetOptionTest).to respond_to(:set_option)
+      expect(OptionableSetOptionTest.method(:set_option).arity).to eq(-2)
+      expect do
+        OptionableSetOptionTest.set_option(:foo, :bar)
+      end.to_not raise_error
+    end
+
+    it 'defaults the value to true' do
+      OptionableSetOptionTest.set_option(:baz_enabled)
+      expect(OptionableSetOptionTest.get_option(:baz_enabled)).to be true
+    end
+  end
+
+  describe '.get_option' do
+    before(:all) do
+      OptionableGetOptionTest = ::Class.new do
+        include ::Protobuf::Optionable
+        set_option :foo, :bar
+      end
+    end
+
+    it 'retrieves the option for the given name, if any' do
+      expect(OptionableGetOptionTest.get_option(:foo)).to eq(:bar)
+      expect(OptionableGetOptionTest.get_option(:baz)).to be_nil
+    end
+
+    it 'retrieves the option in the context of an instance' do
+      expect(OptionableGetOptionTest.new.get_option(:foo)).to eq(:bar)
+      expect(OptionableGetOptionTest.new.get_option(:baz)).to be_nil
+    end
+  end
+
+end

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

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require 'spec/support/test/resource_service'
+
+RSpec.describe Protobuf::Rpc::Client do
+  before(:each) do
+    load 'protobuf/socket.rb'
+  end
+
+  context 'when creating a client from a service' do
+    before { reset_service_location(Test::ResourceService) }
+
+    it 'should be able to get a client through the Service#client helper method' do
+      expect(::Test::ResourceService.client(:port => 9191)).to eq(Protobuf::Rpc::Client.new(:service => Test::ResourceService, :port => 9191))
+    end
+
+    it "should be able to override a service location's host and port" do
+      Test::ResourceService.located_at 'somewheregreat.com:12345'
+      clean_client = Test::ResourceService.client
+      expect(clean_client.options[:host]).to eq('somewheregreat.com')
+      expect(clean_client.options[:port]).to eq(12345)
+
+      updated_client = Test::ResourceService.client(:host => 'amazing.com', :port => 54321)
+      expect(updated_client.options[:host]).to eq('amazing.com')
+      expect(updated_client.options[:port]).to eq(54321)
+    end
+
+    it 'should be able to define which service to create itself for' do
+      client = Protobuf::Rpc::Client.new :service => Test::ResourceService
+      expect(client.options[:service]).to eq(Test::ResourceService)
+    end
+
+    it 'should have a hard default for host and port on a service that has not been configured' do
+      client = Test::ResourceService.client
+      expect(client.options[:host]).to eq(Protobuf::Rpc::Service::DEFAULT_HOST)
+      expect(client.options[:port]).to eq(Protobuf::Rpc::Service::DEFAULT_PORT)
+    end
+
+  end
+
+  context 'when calling methods on a service client' do
+
+    # NOTE: we are assuming the service methods are accurately
+    # defined inside spec/proto/test_service.rb,
+    # namely the :find method
+
+    it 'should respond to defined service methods' do
+      client = Test::ResourceService.client
+      expect(client).to receive(:send_request).and_return(nil)
+      expect { client.find(nil) }.to_not raise_error
+    end
+  end
+
+  context 'when receiving request objects' do
+
+    it 'should be able to create the correct request object if passed a hash' do
+      client = Test::ResourceService.client
+      expect(client).to receive(:send_request)
+      client.find(:name => 'Test Name', :active => false)
+      expect(client.options[:request]).to be_a(Test::ResourceFindRequest)
+      expect(client.options[:request].name).to eq('Test Name')
+      expect(client.options[:request].active).to eq(false)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'protobuf/socket'
+require 'protobuf/zmq'
+
+RSpec.describe ::Protobuf::Rpc::Connector do
+
+  describe '.connector_for_client(true)' do
+    subject { described_class.connector_for_client }
+
+    context 'Protobuf.connector_type is socket' do
+      before { ::Protobuf.connector_type = :socket }
+      specify { expect(subject).to eq ::Protobuf::Rpc::Connectors::Socket }
+    end
+
+    context 'Protobuf.connector_type is not a known value' do
+      before { allow(::Protobuf).to receive(:connector_type).and_return(:foo) }
+      specify { expect(subject).to eq(::Protobuf::Rpc::Connectors::Socket) }
+    end
+
+    context 'Protobuf.connector_type is zmq' do
+      before { ::Protobuf.connector_type = :zmq }
+      specify { expect(subject).to eq(::Protobuf::Rpc::Connectors::Zmq) }
+    end
+  end
+
+end

data/spec/lib/protobuf/rpc/connectors/base_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+RSpec.describe Protobuf::Rpc::Connectors::Base do
+
+  let(:options) do
+    { :timeout => 60 }
+  end
+
+  subject { Protobuf::Rpc::Connectors::Base.new(options) }
+
+  describe "#send_request" do
+    it "raising an error when 'send_request' is not overridden" do
+      expect { subject.send_request }.to raise_error(RuntimeError, /inherit a Connector/)
+    end
+
+    it "does not raise error when 'send_request' is overridden" do
+      new_sub = Class.new(subject.class) { def send_request; end }.new(options)
+      expect { new_sub.send_request }.to_not raise_error
+    end
+  end
+
+  describe '.new' do
+    it 'assigns passed options and initializes success/failure callbacks' do
+      expect(subject.options).to eq(Protobuf::Rpc::Connectors::DEFAULT_OPTIONS.merge(options))
+      expect(subject.success_cb).to be_nil
+      expect(subject.failure_cb).to be_nil
+    end
+  end
+
+  describe '#success_cb' do
+    it 'allows setting the success callback and calling it' do
+      expect(subject.success_cb).to be_nil
+      cb = proc { |res| fail res }
+      subject.success_cb = cb
+      expect(subject.success_cb).to eq(cb)
+      expect { subject.success_cb.call('an error from cb') }.to raise_error 'an error from cb'
+    end
+  end
+
+  describe '#failure_cb' do
+    it 'allows setting the failure callback and calling it' do
+      expect(subject.failure_cb).to be_nil
+      cb = proc { |res| fail res }
+      subject.failure_cb = cb
+      expect(subject.failure_cb).to eq(cb)
+      expect { subject.failure_cb.call('an error from cb') }.to raise_error 'an error from cb'
+    end
+  end
+
+end

data/spec/lib/protobuf/rpc/connectors/common_spec.rb

@@ -0,0 +1,170 @@
+require 'spec_helper'
+require 'protobuf/rpc/service'
+
+RSpec.describe Protobuf::Rpc::Connectors::Common do
+  let(:common_class) do
+    Class.new(Protobuf::Rpc::Connectors::Base) do
+      include Protobuf::Rpc::Connectors::Common
+      attr_accessor :options
+      attr_accessor :stats
+    end
+  end
+
+  let(:subject_options) { {} }
+
+  subject { @subject ||= common_class.new(subject_options) }
+
+  context "API" do
+    specify { expect(subject.respond_to?(:any_callbacks?)).to be true }
+    specify { expect(subject.respond_to?(:request_caller)).to be true }
+    specify { expect(subject.respond_to?(:data_callback)).to be true }
+    specify { expect(subject.respond_to?(:error)).to be true }
+    specify { expect(subject.respond_to?(:failure)).to be true }
+    specify { expect(subject.respond_to?(:complete)).to be true }
+    specify { expect(subject.respond_to?(:parse_response)).to be true }
+    specify { expect(subject.respond_to?(:verify_options!)).to be true }
+    specify { expect(subject.respond_to?(:verify_callbacks)).to be true }
+  end
+
+  describe "#any_callbacks?" do
+
+    [:@complete_cb, :@success_cb, :@failure_cb].each do |cb|
+      it "returns true if #{cb} is provided" do
+        subject.instance_variable_set(cb, "something")
+        expect(subject.any_callbacks?).to be true
+      end
+    end
+
+    it "returns false when all callbacks are not provided" do
+      subject.instance_variable_set(:@complete_cb, nil)
+      subject.instance_variable_set(:@success_cb, nil)
+      subject.instance_variable_set(:@failure_cb, nil)
+
+      expect(subject.any_callbacks?).to be false
+    end
+
+  end
+
+  describe '#request_caller' do
+    specify { expect(subject.request_caller).to eq ::Protobuf.client_host }
+
+    context 'when "client_host" option is given to initializer' do
+      let(:hostname) { 'myhost.myserver.com' }
+      let(:subject_options) { { :client_host => hostname } }
+
+      specify { expect(subject.request_caller).to_not eq ::Protobuf.client_host }
+      specify { expect(subject.request_caller).to eq hostname }
+    end
+  end
+
+  describe "#data_callback" do
+    it "changes state to use the data callback" do
+      subject.data_callback("data")
+      expect(subject.instance_variable_get(:@used_data_callback)).to be true
+    end
+
+    it "sets the data var when using the data_callback" do
+      subject.data_callback("data")
+      expect(subject.instance_variable_get(:@data)).to eq("data")
+    end
+  end
+
+  describe '#request_bytes' do
+    let(:service) { Test::ResourceService }
+    let(:method) { :find }
+    let(:request) { '' }
+    let(:client_host) { 'myhost.myservice.com' }
+    let(:subject_options) do
+      {
+        :service => service,
+        :method => method,
+        :request => request,
+        :client_host => client_host,
+      }
+    end
+
+    let(:expected) do
+      ::Protobuf::Socketrpc::Request.new(
+        :service_name => service.name,
+        :method_name => 'find',
+        :request_proto => '',
+        :caller => client_host,
+      )
+    end
+
+    before { allow(subject).to receive(:validate_request_type!).and_return(true) }
+    before { expect(subject).not_to receive(:failure) }
+
+    specify { expect(subject.request_bytes).to eq expected.encode }
+  end
+
+  describe "#verify_callbacks" do
+
+    it "sets @failure_cb to #data_callback when no callbacks are defined" do
+      subject.verify_callbacks
+      expect(subject.instance_variable_get(:@failure_cb)).to eq(subject.method(:data_callback))
+    end
+
+    it "sets @success_cb to #data_callback when no callbacks are defined" do
+      subject.verify_callbacks
+      expect(subject.instance_variable_get(:@success_cb)).to eq(subject.method(:data_callback))
+    end
+
+    it "doesn't set @failure_cb when already defined" do
+      set_cb = -> { true }
+      subject.instance_variable_set(:@failure_cb, set_cb)
+      subject.verify_callbacks
+      expect(subject.instance_variable_get(:@failure_cb)).to eq(set_cb)
+      expect(subject.instance_variable_get(:@failure_cb)).to_not eq(subject.method(:data_callback))
+    end
+
+    it "doesn't set @success_cb when already defined" do
+      set_cb = -> { true }
+      subject.instance_variable_set(:@success_cb, set_cb)
+      subject.verify_callbacks
+      expect(subject.instance_variable_get(:@success_cb)).to eq(set_cb)
+      expect(subject.instance_variable_get(:@success_cb)).to_not eq(subject.method(:data_callback))
+    end
+
+  end
+
+  shared_examples "a ConnectorDisposition" do |meth, cb, *args|
+
+    it "calls #complete before exit" do
+      subject.stats = double("Object", :stop => true)
+
+      expect(subject).to receive(:complete)
+      subject.method(meth).call(*args)
+    end
+
+    it "calls the #{cb} callback when provided" do
+      stats = double("Object")
+      allow(stats).to receive(:stop).and_return(true)
+      subject.stats = stats
+      some_cb = double("Object")
+
+      subject.instance_variable_set("@#{cb}", some_cb)
+      expect(some_cb).to receive(:call).and_return(true)
+      subject.method(meth).call(*args)
+    end
+
+    it "calls the complete callback when provided" do
+      stats = double("Object")
+      allow(stats).to receive(:stop).and_return(true)
+      subject.stats = stats
+      comp_cb = double("Object")
+
+      subject.instance_variable_set(:@complete_cb, comp_cb)
+      expect(comp_cb).to receive(:call).and_return(true)
+      subject.method(meth).call(*args)
+    end
+
+  end
+
+  it_behaves_like("a ConnectorDisposition", :failure, "failure_cb", "code", "message")
+  it_behaves_like("a ConnectorDisposition", :failure, "complete_cb", "code", "message")
+  it_behaves_like("a ConnectorDisposition", :succeed, "complete_cb", "response")
+  it_behaves_like("a ConnectorDisposition", :succeed, "success_cb", "response")
+  it_behaves_like("a ConnectorDisposition", :complete, "complete_cb")
+
+end

data/spec/lib/protobuf/rpc/connectors/socket_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'protobuf/socket'
+
+RSpec.shared_examples "a Protobuf Connector" do
+  subject { described_class.new({}) }
+
+  context "API" do
+    # Check the API
+    specify { expect(subject.respond_to?(:send_request, true)).to be true }
+    specify { expect(subject.respond_to?(:post_init, true)).to be true }
+    specify { expect(subject.respond_to?(:close_connection, true)).to be true }
+    specify { expect(subject.respond_to?(:error?, true)).to be true }
+  end
+end
+
+RSpec.describe Protobuf::Rpc::Connectors::Socket do
+  subject { described_class.new({}) }
+
+  it_behaves_like "a Protobuf Connector"
+
+  specify { expect(described_class.include?(Protobuf::Rpc::Connectors::Common)).to be true }
+
+  context "#read_response" do
+    let(:data) { "New data" }
+
+    it "fills the buffer with data from the socket" do
+      socket = StringIO.new("#{data.bytesize}-#{data}")
+      subject.instance_variable_set(:@socket, socket)
+      subject.instance_variable_set(:@stats, OpenStruct.new)
+      expect(subject).to receive(:parse_response).and_return(true)
+
+      subject.__send__(:read_response)
+      expect(subject.instance_variable_get(:@response_data)).to eq(data)
+    end
+  end
+end

data/spec/lib/protobuf/rpc/connectors/zmq_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+require 'protobuf/zmq'
+
+RSpec.describe ::Protobuf::Rpc::Connectors::Zmq do
+  subject { described_class.new(options) }
+
+  let(:options) do
+    {
+      :service => "Test::Service",
+      :method => "find",
+      :timeout => 3,
+      :host => "127.0.0.1",
+      :port => "9400",
+    }
+  end
+
+  let(:socket_double) { double(::ZMQ::Socket, :connect => 0) }
+  let(:zmq_context_double) { double(::ZMQ::Context, :socket => socket_double) }
+
+  before do
+    allow(::ZMQ::Context).to receive(:new).and_return(zmq_context_double)
+    allow(socket_double).to receive(:setsockopt)
+  end
+
+  before(:all) do
+    @ping_port_before = ENV['PB_RPC_PING_PORT']
+  end
+
+  after(:all) do
+    ENV['PB_RPC_PING_PORT'] = @ping_port_before
+  end
+
+  describe "#lookup_server_uri" do
+    let(:service_directory) { double('ServiceDirectory', :running? => running?) }
+    let(:listing) { double('Listing', :address => '127.0.0.2', :port => 9399) }
+    let(:listings) { [listing] }
+    let(:running?) { true }
+
+    before { allow(subject).to receive(:service_directory).and_return(service_directory) }
+
+    context "when the service directory is running" do
+      it "searches the service directory" do
+        allow(service_directory).to receive(:all_listings_for).and_return(listings)
+        expect(subject.send(:lookup_server_uri)).to eq "tcp://127.0.0.2:9399"
+      end
+
+      it "defaults to the options" do
+        allow(service_directory).to receive(:all_listings_for).and_return([])
+        expect(subject.send(:lookup_server_uri)).to eq "tcp://127.0.0.1:9400"
+      end
+    end
+
+    context "when the service directory is not running" do
+      let(:running?) { false }
+
+      it "defaults to the options" do
+        allow(service_directory).to receive(:all_listings_for).and_return([])
+        expect(subject.send(:lookup_server_uri)).to eq "tcp://127.0.0.1:9400"
+      end
+    end
+
+    it "checks if the server is alive" do
+      allow(service_directory).to receive(:all_listings_for).and_return([])
+      expect(subject).to receive(:host_alive?).with("127.0.0.1") { true }
+      expect(subject.send(:lookup_server_uri)).to eq "tcp://127.0.0.1:9400"
+    end
+
+    context "when no host is alive" do
+      it "raises an error" do
+        allow(service_directory).to receive(:all_listings_for).and_return(listings)
+        allow(subject).to receive(:host_alive?).and_return(false)
+        expect { subject.send(:lookup_server_uri) }.to raise_error
+      end
+    end
+
+  end
+
+  describe "#host_alive?" do
+    context "when the PB_RPC_PING_PORT is not set" do
+      before do
+        ENV.delete("PB_RPC_PING_PORT")
+      end
+
+      it "returns true" do
+        expect(subject.send(:host_alive?, "yip.yip")).to be true
+      end
+
+      it "does not attempt a connection" do
+        expect(TCPSocket).not_to receive(:new)
+        subject.send(:host_alive?, "blargh.com")
+      end
+    end
+
+    context "when the PB_RPC_PING_PORT is set" do
+      before do
+        ENV["PB_RPC_PING_PORT"] = "3307"
+      end
+
+      it "returns true when the connection succeeds" do
+        expect(TCPSocket).to receive(:new).with("huzzah.com", 3307).and_return(double(:close => nil, :setsockopt => nil))
+        expect(subject.send(:host_alive?, "huzzah.com")).to be true
+      end
+
+      it "returns false when the connection fails" do
+        expect(TCPSocket).to receive(:new).with("hayoob.com", 3307).and_raise(Errno::ECONNREFUSED)
+        expect(subject.send(:host_alive?, "hayoob.com")).to be false
+      end
+
+      it "closes the socket" do
+        socket = double("TCPSocket", :setsockopt => nil)
+        expect(socket).to receive(:close)
+        expect(TCPSocket).to receive(:new).with("absorbalof.com", 3307).and_return(socket)
+        expect(subject.send(:host_alive?, "absorbalof.com")).to be true
+      end
+    end
+  end
+end