prepor-protobuf 3.5.0

data/spec/functional/zmq_server_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+require 'spec/support/test/resource_service'
+require 'protobuf/rpc/service_directory'
+
+RSpec.describe 'Functional ZMQ Client' do
+  before(:all) do
+    load "protobuf/zmq.rb"
+    @runner = ::Protobuf::Rpc::ZmqRunner.new(
+      :host => "127.0.0.1",
+      :port => 9399,
+      :worker_port => 9408,
+      :backlog => 100,
+      :threshold => 100,
+      :threads => 5,
+    )
+    @server_thread = Thread.new(@runner) { |runner| runner.run }
+    Thread.pass until @runner.running?
+  end
+
+  after(:all) do
+    @runner.stop
+    @server_thread.join
+  end
+
+  it 'runs fine when required fields are set' do
+    expect do
+      client = ::Test::ResourceService.client
+
+      client.find(:name => 'Test Name', :active => true) do |c|
+        c.on_success do |succ|
+          expect(succ.name).to eq("Test Name")
+          expect(succ.status).to eq(::Test::StatusType::ENABLED)
+        end
+
+        c.on_failure do |err|
+          fail err.inspect
+        end
+      end
+    end.to_not raise_error
+  end
+
+  it 'runs under heavy load' do
+    10.times do
+      5.times.map do
+        Thread.new do
+          client = ::Test::ResourceService.client
+
+          client.find(:name => 'Test Name', :active => true) do |c|
+            c.on_success do |succ|
+              expect(succ.name).to eq("Test Name")
+              expect(succ.status).to eq(::Test::StatusType::ENABLED)
+            end
+
+            c.on_failure do |err|
+              fail err.inspect
+            end
+          end
+        end
+      end.each(&:join)
+    end
+  end
+
+  context 'when a message is malformed' do
+    it 'calls the on_failure callback' do
+      error = nil
+      request = ::Test::ResourceFindRequest.new(:active => true)
+      client = ::Test::ResourceService.client
+
+      client.find(request) do |c|
+        c.on_success { fail "shouldn't pass" }
+        c.on_failure { |e| error = e }
+      end
+      expect(error.message).to match(/Required field.*does not have a value/)
+    end
+  end
+
+  context 'when the request type is wrong' do
+    it 'calls the on_failure callback' do
+      error = nil
+      request = ::Test::Resource.new(:name => 'Test Name')
+      client = ::Test::ResourceService.client
+
+      client.find(request) do |c|
+        c.on_success { fail "shouldn't pass" }
+        c.on_failure { |e| error = e }
+      end
+      expect(error.message).to match(/expected request.*ResourceFindRequest.*Resource instead/i)
+    end
+  end
+
+  context 'when the server takes too long to respond' do
+    it 'responds with a timeout error' do
+      error = nil
+      client = ::Test::ResourceService.client(:timeout => 1)
+
+      client.find_with_sleep(:sleep => 2) do |c|
+        c.on_success { fail "shouldn't pass" }
+        c.on_failure { |e| error = e }
+      end
+      expect(error.message).to match(/The server repeatedly failed to respond/)
+    end
+  end
+
+end

data/spec/lib/protobuf/cli_spec.rb

@@ -0,0 +1,273 @@
+require 'spec_helper'
+require 'protobuf/cli'
+
+RSpec.describe ::Protobuf::CLI do
+
+  let(:app_file) do
+    File.expand_path('../../../support/test_app_file.rb', __FILE__)
+  end
+
+  let(:sock_runner) do
+    runner = double("SocketRunner", :register_signals => nil)
+    allow(runner).to receive(:run).and_return(::ActiveSupport::Notifications.publish("after_server_bind"))
+    runner
+  end
+
+  let(:zmq_runner) do
+    runner = double("ZmqRunner", :register_signals => nil)
+    allow(runner).to receive(:run).and_return(::ActiveSupport::Notifications.publish("after_server_bind"))
+    runner
+  end
+
+  around(:each) do |example|
+    logger = ::Protobuf::Logging.logger
+    example.run
+    ::Protobuf::Logging.logger = logger
+  end
+
+  before(:each) do
+    allow(::Protobuf::Rpc::SocketRunner).to receive(:new).and_return(sock_runner)
+    allow(::Protobuf::Rpc::ZmqRunner).to receive(:new).and_return(zmq_runner)
+  end
+
+  describe '#start' do
+    let(:base_args) { ['start', app_file] }
+    let(:test_args) { [] }
+    let(:args) { base_args + test_args }
+
+    context 'host option' do
+      let(:test_args) { ['--host=123.123.123.123'] }
+
+      it 'sends the host option to the runner' do
+        expect(::Protobuf::Rpc::SocketRunner).to receive(:new) do |options|
+          expect(options[:host]).to eq '123.123.123.123'
+        end.and_return(sock_runner)
+        described_class.start(args)
+      end
+    end
+
+    context 'port option' do
+      let(:test_args) { ['--port=12345'] }
+
+      it 'sends the port option to the runner' do
+        expect(::Protobuf::Rpc::SocketRunner).to receive(:new) do |options|
+          expect(options[:port]).to eq 12345
+        end.and_return(sock_runner)
+        described_class.start(args)
+      end
+    end
+
+    context 'threads option' do
+      let(:test_args) { ['--threads=500'] }
+
+      it 'sends the threads option to the runner' do
+        expect(::Protobuf::Rpc::SocketRunner).to receive(:new) do |options|
+          expect(options[:threads]).to eq 500
+        end.and_return(sock_runner)
+        described_class.start(args)
+      end
+    end
+
+    context 'backlog option' do
+      let(:test_args) { ['--backlog=500'] }
+
+      it 'sends the backlog option to the runner' do
+        expect(::Protobuf::Rpc::SocketRunner).to receive(:new) do |options|
+          expect(options[:backlog]).to eq 500
+        end.and_return(sock_runner)
+        described_class.start(args)
+      end
+    end
+
+    context 'threshold option' do
+      let(:test_args) { ['--threshold=500'] }
+
+      it 'sends the backlog option to the runner' do
+        expect(::Protobuf::Rpc::SocketRunner).to receive(:new) do |options|
+          expect(options[:threshold]).to eq 500
+        end.and_return(sock_runner)
+        described_class.start(args)
+      end
+    end
+
+    context 'log options' do
+      let(:test_args) { ['--log=mylog.log', '--level=0'] }
+
+      it 'sends the log file and level options to the runner' do
+        expect(::Protobuf::Logging).to receive(:initialize_logger) do |file, level|
+          expect(file).to eq 'mylog.log'
+          expect(level).to eq 0
+        end
+        described_class.start(args)
+      end
+    end
+
+    context 'gc options' do
+
+      context 'when gc options are not present' do
+        let(:test_args) { [] }
+
+        it 'sets both request and serialization pausing to false' do
+          described_class.start(args)
+          expect(::Protobuf).to_not be_gc_pause_server_request
+        end
+      end
+
+      unless defined?(JRUBY_VERSION)
+        context 'request pausing' do
+          let(:test_args) { ['--gc_pause_request'] }
+
+          it 'sets the configuration option to GC pause server request' do
+            described_class.start(args)
+            expect(::Protobuf).to be_gc_pause_server_request
+          end
+        end
+      end
+    end
+
+    context 'deprecation options' do
+      context 'when not given' do
+        let(:test_args) { [] }
+
+        context 'when no ENV is present and no command line option' do
+          before { ENV.delete("PB_IGNORE_DEPRECATIONS") }
+
+          it 'sets the deprecation warning flag to true' do
+            described_class.start(args)
+            expect(::Protobuf.print_deprecation_warnings?).to be true
+          end
+        end
+
+        context 'if ENV["PB_IGNORE_DEPRECATIONS"] is present' do
+          before { ENV["PB_IGNORE_DEPRECATIONS"] = "1" }
+          after { ENV.delete("PB_IGNORE_DEPRECATIONS") }
+
+          it 'sets the deprecation warning flag to false ' do
+            described_class.start(args)
+            expect(::Protobuf.print_deprecation_warnings?).to be false
+          end
+        end
+      end
+
+      context 'when enabled' do
+        let(:test_args) { ['--print_deprecation_warnings'] }
+
+        it 'sets the deprecation warning flag to true' do
+          described_class.start(args)
+          expect(::Protobuf.print_deprecation_warnings?).to be true
+        end
+      end
+
+      context 'when disabled' do
+        let(:test_args) { ['--no-print_deprecation_warnings'] }
+
+        it 'sets the deprecation warning flag to false' do
+          described_class.start(args)
+          expect(::Protobuf.print_deprecation_warnings?).to be false
+        end
+      end
+    end
+
+    context 'run modes' do
+
+      context 'socket' do
+        let(:test_args) { ['--socket'] }
+        let(:runner) { ::Protobuf::Rpc::SocketRunner }
+
+        before do
+          expect(::Protobuf::Rpc::ZmqRunner).not_to receive(:new)
+        end
+
+        it 'is activated by the --socket switch' do
+          expect(runner).to receive(:new)
+          described_class.start(args)
+        end
+
+        it 'is activated by PB_SERVER_TYPE=Socket ENV variable' do
+          ENV['PB_SERVER_TYPE'] = "Socket"
+          expect(runner).to receive(:new).and_return(sock_runner)
+          described_class.start(args)
+          ENV.delete('PB_SERVER_TYPE')
+        end
+
+        it 'configures the connector type to be socket' do
+          load "protobuf/socket.rb"
+          expect(::Protobuf.connector_type).to eq(:socket)
+        end
+      end
+
+      context 'zmq workers only' do
+        let(:test_args) { ['--workers_only', '--zmq'] }
+        let(:runner) { ::Protobuf::Rpc::ZmqRunner }
+
+        before do
+          expect(::Protobuf::Rpc::SocketRunner).not_to receive(:new)
+        end
+
+        it 'is activated by the --workers_only switch' do
+          expect(runner).to receive(:new) do |options|
+            expect(options[:workers_only]).to be true
+          end.and_return(zmq_runner)
+
+          described_class.start(args)
+        end
+
+        it 'is activated by PB_WORKERS_ONLY=1 ENV variable' do
+          ENV['PB_WORKERS_ONLY'] = "1"
+          expect(runner).to receive(:new) do |options|
+            expect(options[:workers_only]).to be true
+          end.and_return(zmq_runner)
+
+          described_class.start(args)
+          ENV.delete('PB_WORKERS_ONLY')
+        end
+      end
+
+      context 'zmq worker port' do
+        let(:test_args) { ['--worker_port=1234', '--zmq'] }
+        let(:runner) { ::Protobuf::Rpc::ZmqRunner }
+
+        before do
+          expect(::Protobuf::Rpc::SocketRunner).not_to receive(:new)
+        end
+
+        it 'is activated by the --worker_port switch' do
+          expect(runner).to receive(:new) do |options|
+            expect(options[:worker_port]).to eq(1234)
+          end.and_return(zmq_runner)
+
+          described_class.start(args)
+        end
+      end
+
+      context 'zmq' do
+        let(:test_args) { ['--zmq'] }
+        let(:runner) { ::Protobuf::Rpc::ZmqRunner }
+
+        before do
+          expect(::Protobuf::Rpc::SocketRunner).not_to receive(:new)
+        end
+
+        it 'is activated by the --zmq switch' do
+          expect(runner).to receive(:new)
+          described_class.start(args)
+        end
+
+        it 'is activated by PB_SERVER_TYPE=Zmq ENV variable' do
+          ENV['PB_SERVER_TYPE'] = "Zmq"
+          expect(runner).to receive(:new)
+          described_class.start(args)
+          ENV.delete('PB_SERVER_TYPE')
+        end
+
+        it 'configures the connector type to be zmq' do
+          load "protobuf/zmq.rb"
+          expect(::Protobuf.connector_type).to eq(:zmq)
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/protobuf/code_generator_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+require 'protobuf/code_generator'
+
+RSpec.describe ::Protobuf::CodeGenerator do
+
+  # Some constants to shorten things up
+  DESCRIPTOR = ::Google::Protobuf
+  COMPILER = ::Google::Protobuf::Compiler
+
+  describe '#response_bytes' do
+    let(:input_file1) { DESCRIPTOR::FileDescriptorProto.new(:name => 'test/foo.proto') }
+    let(:input_file2) { DESCRIPTOR::FileDescriptorProto.new(:name => 'test/bar.proto') }
+
+    let(:output_file1) { COMPILER::CodeGeneratorResponse::File.new(:name => 'test/foo.pb.rb') }
+    let(:output_file2) { COMPILER::CodeGeneratorResponse::File.new(:name => 'test/bar.pb.rb') }
+
+    let(:file_generator1) { double('file generator 1', :generate_output_file => output_file1) }
+    let(:file_generator2) { double('file generator 2', :generate_output_file => output_file2) }
+
+    let(:request_bytes) do
+      COMPILER::CodeGeneratorRequest.encode(:proto_file => [input_file1, input_file2])
+    end
+
+    let(:expected_response_bytes) do
+      COMPILER::CodeGeneratorResponse.encode(:file => [output_file1, output_file2])
+    end
+
+    before do
+      expect(::Protobuf::Generators::FileGenerator).to receive(:new).with(input_file1).and_return(file_generator1)
+      expect(::Protobuf::Generators::FileGenerator).to receive(:new).with(input_file2).and_return(file_generator2)
+    end
+
+    it 'returns the serialized CodeGeneratorResponse which contains the generated file contents' do
+      generator = described_class.new(request_bytes)
+      expect(generator.response_bytes).to eq expected_response_bytes
+    end
+  end
+
+  context 'class-level printing methods' do
+    describe '.fatal' do
+      it 'raises a CodeGeneratorFatalError error' do
+        expect do
+          described_class.fatal("something is wrong")
+        end.to raise_error(
+          ::Protobuf::CodeGenerator::CodeGeneratorFatalError,
+          "something is wrong",
+        )
+      end
+    end
+
+    describe '.warn' do
+      it 'prints a warning to stderr' do
+        expect(STDERR).to receive(:puts).with("[WARN] a warning")
+        described_class.warn("a warning")
+      end
+    end
+  end
+
+end

data/spec/lib/protobuf/enum_spec.rb

@@ -0,0 +1,265 @@
+require 'spec_helper'
+
+RSpec.describe Protobuf::Enum do
+
+  describe 'class dsl' do
+    let(:name) { :THREE }
+    let(:tag)  { 3 }
+
+    before(:all) do
+      Test::EnumTestType.define(:MINUS_ONE, -1)
+      Test::EnumTestType.define(:THREE, 3)
+    end
+
+    before(:all) do
+      EnumAliasTest = ::Class.new(::Protobuf::Enum) do
+        set_option :allow_alias
+        define :FOO, 1
+        define :BAR, 1
+        define :BAZ, 2
+      end
+    end
+
+    describe '.aliases_allowed?' do
+      it 'is nil when the option is not set' do
+        expect(Test::EnumTestType.aliases_allowed?).to be nil
+      end
+    end
+
+    describe '.define' do
+      it 'defines a constant enum on the parent class' do
+        expect(Test::EnumTestType.constants).to include(name)
+        expect(Test::EnumTestType::THREE).to be_a(Protobuf::Enum)
+      end
+
+      context 'when enum allows aliases' do
+        before(:all) do
+          DefineEnumAlias = ::Class.new(::Protobuf::Enum) do
+            set_option :allow_alias
+          end
+        end
+
+        it 'allows defining enums with the same tag number' do
+          expect do
+            DefineEnumAlias.define(:FOO, 1)
+            DefineEnumAlias.define(:BAR, 1)
+          end.not_to raise_error
+        end
+      end
+    end
+
+    describe '.enums' do
+      it 'provides an array of defined Enums' do
+        expect(Test::EnumTestType.enums).to eq(
+          [
+            Test::EnumTestType::ONE,
+            Test::EnumTestType::TWO,
+            Test::EnumTestType::MINUS_ONE,
+            Test::EnumTestType::THREE,
+          ],
+        )
+      end
+
+      context 'when enum allows aliases' do
+        it 'treats aliased enums as valid' do
+          expect(EnumAliasTest.enums).to eq(
+            [
+              EnumAliasTest::FOO,
+              EnumAliasTest::BAR,
+              EnumAliasTest::BAZ,
+            ],
+          )
+        end
+      end
+    end
+
+    describe '.enums_for_tag' do
+      it 'returns an array of Enums for the given tag, if any' do
+        expect(EnumAliasTest.enums_for_tag(1)).to eq([EnumAliasTest::FOO, EnumAliasTest::BAR])
+        expect(EnumAliasTest.enums_for_tag(2)).to eq([EnumAliasTest::BAZ])
+        expect(EnumAliasTest.enums_for_tag(3)).to eq([])
+      end
+    end
+
+    describe '.fetch' do
+      context 'when candidate is an Enum' do
+        it 'responds with the Enum' do
+          expect(Test::EnumTestType.fetch(Test::EnumTestType::THREE)).to eq(Test::EnumTestType::THREE)
+        end
+      end
+
+      context 'when candidate can be coerced to a symbol' do
+        it 'fetches based on the symbol name' do
+          expect(Test::EnumTestType.fetch("ONE")).to eq(Test::EnumTestType::ONE)
+          expect(Test::EnumTestType.fetch(:ONE)).to eq(Test::EnumTestType::ONE)
+        end
+      end
+
+      context 'when candidate can be coerced to an integer' do
+        it 'fetches based on the integer tag' do
+          expect(Test::EnumTestType.fetch(3.0)).to eq(Test::EnumTestType::THREE)
+          expect(Test::EnumTestType.fetch(3)).to eq(Test::EnumTestType::THREE)
+        end
+
+        context 'when enum allows aliases' do
+          it 'fetches the first defined Enum' do
+            expect(EnumAliasTest.fetch(1)).to eq(EnumAliasTest::FOO)
+          end
+        end
+      end
+
+      context 'when candidate is not an applicable type' do
+        it 'returns a nil' do
+          expect(Test::EnumTestType.fetch(EnumAliasTest::FOO)).to be_nil
+          expect(Test::EnumTestType.fetch(Test::Resource.new)).to be_nil
+          expect(Test::EnumTestType.fetch(nil)).to be_nil
+          expect(Test::EnumTestType.fetch(false)).to be_nil
+          expect(Test::EnumTestType.fetch(-10)).to be_nil
+        end
+      end
+    end
+
+    describe '.enum_for_tag' do
+      it 'gets the Enum corresponding to the given tag' do
+        expect(Test::EnumTestType.enum_for_tag(tag)).to eq(Test::EnumTestType.const_get(name))
+        expect(Test::EnumTestType.enum_for_tag(-5)).to be_nil
+      end
+    end
+
+    describe '.name_for_tag' do
+      it 'get the name of the enum given the enum' do
+        expect(Test::EnumTestType.name_for_tag(::Test::EnumTestType::THREE)).to eq(name)
+      end
+
+      it 'gets the name of the enum corresponding to the given tag' do
+        expect(Test::EnumTestType.name_for_tag(tag)).to eq(name)
+      end
+
+      it 'gets the name when the tag is coercable to an int' do
+        expect(Test::EnumTestType.name_for_tag("3")).to eq(name)
+      end
+
+      it 'returns nil when tag does not correspond to a name' do
+        expect(Test::EnumTestType.name_for_tag(12345)).to be_nil
+      end
+
+      context 'when given name is nil' do
+        it 'returns a nil' do
+          expect(Test::EnumTestType.name_for_tag(nil)).to be_nil
+        end
+      end
+
+      context 'when enum allows aliases' do
+        it 'returns the first defined name for the given tag' do
+          expect(EnumAliasTest.name_for_tag(1)).to eq(:FOO)
+        end
+      end
+    end
+
+    describe '.valid_tag?' do
+      context 'when tag is defined' do
+        specify { expect(Test::EnumTestType.valid_tag?(tag)).to be true }
+      end
+
+      context 'when tag is not defined' do
+        specify { expect(Test::EnumTestType.valid_tag?(300)).to be false }
+      end
+
+      context 'is true for aliased enums' do
+        specify { expect(EnumAliasTest.valid_tag?(1)).to be true }
+      end
+    end
+
+    describe '.enum_for_name' do
+      it 'gets the Enum corresponding to the given name' do
+        expect(Test::EnumTestType.enum_for_name(name)).to eq(Test::EnumTestType::THREE)
+      end
+    end
+
+    describe '.values' do
+      around do |example|
+        # this method is deprecated
+        ::Protobuf.deprecator.silence(&example)
+      end
+
+      it 'provides a hash of defined Enums' do
+        expect(Test::EnumTestType.values).to eq(
+          :MINUS_ONE => Test::EnumTestType::MINUS_ONE,
+          :ONE       => Test::EnumTestType::ONE,
+          :TWO       => Test::EnumTestType::TWO,
+          :THREE     => Test::EnumTestType::THREE,
+        )
+      end
+
+      it 'contains aliased Enums' do
+        expect(EnumAliasTest.values).to eq(
+          :FOO => EnumAliasTest::FOO,
+          :BAR => EnumAliasTest::BAR,
+          :BAZ => EnumAliasTest::BAZ,
+        )
+      end
+    end
+
+    describe '.all_tags' do
+      it 'provides a unique array of defined tags' do
+        expect(Test::EnumTestType.all_tags).to include(1, 2, -1, 3)
+        expect(EnumAliasTest.all_tags).to include(1, 2)
+      end
+    end
+  end
+
+  subject { Test::EnumTestType::ONE }
+  specify { expect(subject.class).to eq(Fixnum) }
+  specify { expect(subject.parent_class).to eq(Test::EnumTestType) }
+  specify { expect(subject.name).to eq(:ONE) }
+  specify { expect(subject.tag).to eq(1) }
+
+  context 'deprecated' do
+    around do |example|
+      # this method is deprecated
+      ::Protobuf.deprecator.silence(&example)
+    end
+
+    specify { expect(subject.value).to eq(1) }
+  end
+
+  specify { expect(subject.to_hash_value).to eq(1) }
+  specify { expect(subject.to_s).to eq("1") }
+  specify { expect(subject.inspect).to eq('#<Protobuf::Enum(Test::EnumTestType)::ONE=1>') }
+  specify { expect(subject.to_s(:tag)).to eq("1") }
+  specify { expect(subject.to_s(:name)).to eq("ONE") }
+
+  it "can be used as the index to an array" do
+    array = [0, 1, 2, 3]
+    expect(array[::Test::EnumTestType::ONE]).to eq(1)
+  end
+
+  describe '#try' do
+    specify { expect(subject.try(:parent_class)).to eq(subject.parent_class) }
+    specify { expect(subject.try(:class)).to eq(subject.class) }
+    specify { expect(subject.try(:name)).to eq(subject.name) }
+    specify { expect(subject.try(:tag)).to eq(subject.tag) }
+
+    context 'deprecated' do
+      around do |example|
+        # this method is deprecated
+        ::Protobuf.deprecator.silence(&example)
+      end
+
+      specify { expect(subject.try(:value)).to eq(subject.value) }
+    end
+
+    specify { expect(subject.try(:to_i)).to eq(subject.to_i) }
+    specify { expect(subject.try(:to_int)).to eq(subject.to_int) }
+    specify { subject.try { |yielded| expect(yielded).to eq(subject) } }
+  end
+
+  context 'when coercing from enum' do
+    subject { Test::StatusType::PENDING }
+    it { is_expected.to eq(0) }
+  end
+
+  context 'when coercing from integer' do
+    specify { expect(0).to eq(Test::StatusType::PENDING) }
+  end
+end