thrifter 0.1.0

data/test.thrift

@@ -0,0 +1,8 @@
+struct TestMessage  {
+  1: required string message
+}
+
+service TestService {
+  TestMessage echo(1: TestMessage message)
+  oneway void onewayEcho(1: TestMessage message)
+}

data/test/acceptance_test.rb

@@ -0,0 +1,221 @@
+require_relative 'test_helper'
+
+class AcceptanceTest < MiniTest::Unit::TestCase
+  SimulatedError = Class.new StandardError
+
+  class TestClient < TestService::Client
+    def echo(message)
+      message
+    end
+  end
+
+  class BrokenTestClient < TestService::Client
+    def echo(message)
+      fail SimulatedError
+    end
+  end
+
+  attr_reader :uri
+
+  def setup
+    super
+
+    @uri = URI('tcp://localhost:9090')
+  end
+
+  def test_defaults_to_framed_transport
+    client = Thrifter.build TestClient
+    assert_equal Thrift::FramedTransport, client.config.transport
+  end
+
+  def test_defaults_to_binary_protocol
+    client = Thrifter.build TestClient
+    assert_equal Thrift::BinaryProtocol, client.config.protocol
+  end
+
+  def test_defaults_to_12_connections
+    client = Thrifter.build TestClient
+    assert_equal 12, client.config.pool_size
+  end
+
+  def test_has_reasonable_default_pool_timeout
+    client = Thrifter.build TestClient
+    assert_equal 0.1, client.config.pool_timeout
+  end
+
+  def test_has_reasonable_default_rpc_timeout
+    client = Thrifter.build TestClient
+    assert_equal 0.3, client.config.rpc_timeout
+  end
+
+  def test_defaults_to_null_statd
+    client = Thrifter.build TestClient
+    assert_instance_of Thrifter::NullStatsd, client.config.statsd
+  end
+
+  def test_configuration_has_a_block_form
+    client = Thrifter.build TestClient
+
+    client.configure do |config|
+      config.transport = :via_block
+    end
+
+    assert :via_block == client.config.transport, 'Block form incorrect'
+  end
+
+  def test_fails_if_uri_not_configured
+    client = Thrifter.build TestClient do
+      config.uri = nil
+    end
+
+    error = assert_raises ArgumentError do
+      client.new
+    end
+
+    assert_match /uri/, error.message
+  end
+
+  def test_fails_if_uri_does_not_contain_port
+    client = Thrifter.build TestClient do
+      config.uri = 'tcp://localhost'
+    end
+
+    error = assert_raises ArgumentError do
+      client.new
+    end
+
+    assert_match /port/, error.message
+  end
+
+  def test_pool_options_are_forwarded
+    client = Thrifter.build TestClient do
+      config.uri = 'http://localhost:9090'
+      config.pool_size = 50
+      config.pool_timeout = 75
+    end
+
+    ConnectionPool.expects(:new).with(size: 50, timeout: 75)
+
+    client.new
+  end
+
+  def test_pool_options_work_as_string
+    client = Thrifter.build TestClient do
+      config.uri = 'http://localhost:9090'
+      config.pool_size = '50'
+      config.pool_timeout = '75.5'
+    end
+
+    ConnectionPool.expects(:new).with(size: 50, timeout: 75.5)
+
+    client.new
+  end
+
+  # NOTE: This test is quite unfortunate, but there does not seem to be a good
+  # way to simulate the 4 objects required to get a Thrift::Client instance
+  # off the ground. The monkey tests will ensure the final product can communicate
+  # to a server correctly. For now, just test the things are built in a sane way.
+  def test_builds_thrift_object_chain_correctly
+    test_message = TestMessage.new message: 'testing 123'
+
+    client = Thrifter.build TestClient
+    client.config.uri = uri
+
+    socket, transport, protocol = stub, stub(open: nil, close: nil), stub
+
+    Thrift::Socket.expects(:new).
+      with(uri.host, uri.port, client.config.rpc_timeout).
+      returns(socket)
+
+    client.config.transport.expects(:new).
+      with(socket).
+      returns(transport)
+
+    client.config.protocol.expects(:new).
+      with(transport).
+      returns(protocol)
+
+    thrift_client = stub
+    thrift_client.expects(:echo).
+      with(test_message).
+      returns(test_message)
+
+    TestClient.expects(:new).with(protocol).returns(thrift_client)
+
+    thrifter = client.new
+
+    # connection pool is built lazily, so an RPC must be made to
+    # trigger the build
+    thrifter.echo test_message
+  end
+
+  def test_rpc_timeout_may_be_provided_as_a_string
+    test_message = TestMessage.new message: 'testing 123'
+
+    client = Thrifter.build TestClient
+    client.config.transport = FakeTransport
+    client.config.rpc_timeout = '15.2'
+    client.config.uri = uri
+
+    Thrift::Socket.expects(:new).
+      with(uri.host, uri.port, 15.2)
+
+    thrifter = client.new
+
+    # connection pool is built lazily, so an RPC must be made to
+    # trigger the build
+    thrifter.echo test_message
+  end
+
+  def test_middleware_can_be_configured
+    test_message = TestMessage.new message: '123'
+
+    client = Thrifter.build TestClient
+    client.config.uri = uri
+    client.config.transport = FakeTransport
+
+    test_middleware = Class.new do
+      include Concord.new(:app, :salt)
+
+      def call(rpc)
+        rpc.args.first.message = salt + rpc.args.first.message
+        app.call rpc
+      end
+    end
+
+    client.use test_middleware, 'testing'
+
+    thrifter = client.new
+    result = thrifter.echo test_message
+    assert_match /testing/, result.message, 'Middleware not called'
+  end
+
+  def test_close_the_transport_on_successful_rpc
+    transport = mock
+    client = Thrifter.build TestClient
+    client.config.uri = uri
+    client.config.transport.stubs(:new).returns(transport)
+
+    transport.expects(:open)
+    transport.expects(:close)
+
+    thrifter = client.new
+    thrifter.echo message
+  end
+
+  def test_close_the_transport_if_client_fails
+    transport = mock
+    client = Thrifter.build BrokenTestClient
+    client.config.uri = uri
+    client.config.transport.stubs(:new).returns(transport)
+
+    transport.expects(:open)
+    transport.expects(:close)
+
+    thrifter = client.new
+
+    assert_raises SimulatedError do
+      thrifter.echo message
+    end
+  end
+end

data/test/error_wrapping_middleware_test.rb

@@ -0,0 +1,73 @@
+require_relative './test_helper'
+
+class ErrorWrappingMiddlewareTest < MiniTest::Unit::TestCase
+  TestError = Class.new StandardError
+
+  attr_reader :rpc
+
+  def known_errors
+    Thrifter::ErrorWrappingMiddleware.wrapped
+  end
+
+  def setup
+    super
+
+    @rpc = Thrifter::RPC.new(:foo, :args)
+  end
+
+  def test_wraps_known_exceptions
+    app = stub
+    app.stubs(:call).with(rpc).raises(known_errors.first)
+
+    middleware = Thrifter::ErrorWrappingMiddleware.new app
+
+    assert_raises Thrifter::ClientError do
+      middleware.call rpc
+    end
+  end
+
+  def test_can_provid_extras_errors_to_wrap
+    app = stub
+    app.stubs(:call).with(rpc).raises(TestError)
+
+    middleware = Thrifter::ErrorWrappingMiddleware.new app, [ TestError ]
+
+    assert_raises Thrifter::ClientError do
+      middleware.call rpc
+    end
+  end
+
+  def test_includes_the_cause_and_message_in_wrapped_message
+    app = stub
+    app.stubs(:call).with(rpc).raises(TestError.new('testing 123'))
+
+    middleware = Thrifter::ErrorWrappingMiddleware.new app, [ TestError ]
+
+    error = assert_raises Thrifter::ClientError do
+      middleware.call rpc
+    end
+
+    assert_match /TestError/, error.message, 'Error class missing'
+    assert_match /testing 123/, error.message, 'Message missing'
+  end
+
+  def test_wraps_protocol_exception
+    assert_includes known_errors, Thrift::ProtocolException
+  end
+
+  def test_wraps_transport_exception
+    assert_includes known_errors, Thrift::TransportException
+  end
+
+  def test_wraps_application_exception
+    assert_includes known_errors, Thrift::ApplicationException
+  end
+
+  def test_wraps_timeout_error
+    assert_includes known_errors, TimeoutError
+  end
+
+  def test_wraps_system_call_error
+    assert_includes known_errors, SystemCallError
+  end
+end

data/test/ping_test.rb

@@ -0,0 +1,31 @@
+require_relative './test_helper'
+
+class PingTest < MiniTest::Unit::TestCase
+  def test_returns_false_if_anything_goes_wrong
+    down_class = Class.new do
+      include Thrifter::Ping
+
+      def ping
+        raise StandardError
+      end
+    end
+
+    client = down_class.new
+
+    refute client.up?
+  end
+
+  def test_returns_true_if_nothing_goes_wrong
+    down_class = Class.new do
+      include Thrifter::Ping
+
+      def ping
+        true
+      end
+    end
+
+    client = down_class.new
+
+    assert client.up?
+  end
+end

data/test/queuing_test.rb

@@ -0,0 +1,73 @@
+require_relative 'test_helper'
+
+class QueuingTest < MiniTest::Unit::TestCase
+  class TestClient < TestService::Client
+    def echo(message)
+      message
+    end
+  end
+
+  # Must have a constant name to work with sidekiq
+  class QueuedClient < Thrifter.build(TestClient)
+    include Thrifter::Queueing
+
+    self.config.uri = 'tcp://localhost:9090'
+  end
+
+  def queue
+    Thrifter::Queueing::Job
+  end
+
+  def jobs
+    queue.jobs
+  end
+
+  def setup
+    queue.clear
+  end
+
+  def test_sends_rpcs_with_sidekiq
+    client = QueuedClient.new
+
+    message = TestMessage.new message: 'echo'
+
+    client.queued.echo(message)
+
+    refute jobs.empty?, 'Nothing enqueued'
+
+    # Now mock out an instance of QueuedClient that should be
+    # instantiated and used to make the RPC in the job
+    mock_client = mock
+    mock_client.expects(:echo).with do |rpc|
+      # NOTE: Thrift structs do not implement equality on attributes, only
+      # on object identity. This is why the expectation tests the
+      # message is sent all the way through.
+      rpc.message == message.message
+    end
+
+    QueuedClient.stubs(:new).returns(mock_client)
+
+    queue.drain
+  end
+
+  def test_works_with_block_form
+    client = QueuedClient.new
+
+    message = TestMessage.new message: 'echo'
+
+    client.queued do |queue|
+      queue.echo message
+    end
+
+    refute jobs.empty?, 'Nothing enqueued'
+  end
+
+  def test_fails_if_given_rpc_name
+    client = QueuedClient.new
+    message = TestMessage.new message: 'echo'
+
+    assert_raises NoMethodError do
+      client.queued.foo
+    end
+  end
+end

data/test/retry_test.rb

@@ -0,0 +1,116 @@
+require_relative 'test_helper'
+
+class RetryTest < MiniTest::Unit::TestCase
+  JunkError = Class.new StandardError
+
+  class RetryClient < Thrifter.build(TestService::Client)
+    include Thrifter::Retry
+
+    config.uri = 'tcp://localhost:9090'
+
+    # This is enough to get around thrift's networking objects and focus
+    # on stubbing the actual thrift client.
+    config.transport = FakeTransport
+  end
+
+  def known_errors
+    Thrifter::Retry::RETRIABLE_ERRORS
+  end
+
+  def test_does_not_retry_on_unexpected_errors
+    thrift_client = mock
+    thrift_client.expects(:echo).with(:request).raises(JunkError)
+    TestService::Client.stubs(:new).returns(thrift_client)
+
+    client = RetryClient.new
+
+    assert_raises JunkError do
+      client.with_retry({ tries: 2, interval: 0.01 }).echo(:request)
+    end
+  end
+
+  def test_retries_on_known_exceptions
+    thrift_client = mock
+    retries = sequence(:retries)
+    thrift_client.expects(:echo).with(:request).in_sequence(retries).raises(known_errors.sample)
+    thrift_client.expects(:echo).with(:request).in_sequence(retries).returns(:response)
+    TestService::Client.stubs(:new).returns(thrift_client)
+
+    client = RetryClient.new
+
+    result = client.with_retry({ tries: 2, interval: 0.01 }).echo(:request)
+
+    assert :response == result, 'return value incorrect'
+  end
+
+  def test_fails_if_does_not_respond_successfully
+    thrift_client = mock
+    thrift_client.expects(:echo).with(:request).raises(known_errors.sample).times(5)
+    TestService::Client.stubs(:new).returns(thrift_client)
+
+    client = RetryClient.new
+
+    error = assert_raises Thrifter::RetryError do
+      client.with_retry({ tries: 5, interval: 0.01 }).echo(:request)
+    end
+
+    assert_match /5/, error.message, 'Error not descriptive'
+    assert_match /echo/, error.message, 'Error not descriptive'
+  end
+
+  def test_retries_on_application_exception
+    assert_includes known_errors, Thrift::ApplicationException
+  end
+
+  def test_retries_on_protocol_exception
+    assert_includes known_errors, Thrift::ProtocolException
+  end
+
+  def test_retries_on_transport_exception
+    assert_includes known_errors, Thrift::TransportException
+  end
+
+  def test_retries_on_timeout_error
+    assert_includes known_errors, Timeout::Error
+  end
+
+  def test_retries_on_econrefused
+    assert_includes known_errors, Errno::ECONNREFUSED
+  end
+
+  def test_retries_on_eaddrnotavail
+    assert_includes known_errors, Errno::EADDRNOTAVAIL
+  end
+
+  def test_retries_on_ehostdown
+    assert_includes known_errors, Errno::EHOSTDOWN
+  end
+
+  def test_retries_on_ehostunreach
+    assert_includes known_errors, Errno::EHOSTUNREACH
+  end
+
+  def test_retries_on_etimedout
+    assert_includes known_errors, Errno::ETIMEDOUT
+  end
+
+  def test_works_with_block_form
+    thrift_client = mock
+    thrift_client.expects(:echo).with(:request).returns(:response)
+    TestService::Client.stubs(:new).returns(thrift_client)
+
+    client = RetryClient.new
+
+    client.with_retry do |with_retry|
+      with_retry.echo :request
+    end
+  end
+
+  def test_fails_if_given_rpc_name
+    client = RetryClient.new
+
+    assert_raises NoMethodError do
+      client.with_retry.foo
+    end
+  end
+end