ralphrodkey-kafka-rb 0.0.15

data/spec/consumer_spec.rb

@@ -0,0 +1,146 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+# 
+#    http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Consumer do
+
+  before(:each) do
+    @mocked_socket = mock(TCPSocket)
+    TCPSocket.stub!(:new).and_return(@mocked_socket) # don't use a real socket
+    @consumer = Consumer.new(:offset => 0)
+  end
+
+  describe "Kafka Consumer" do
+
+    it "should have a Kafka::RequestType::FETCH" do
+      Kafka::RequestType::FETCH.should eql(1)
+      @consumer.should respond_to(:request_type)
+    end
+
+    it "should have a topic and a partition" do
+      @consumer.should respond_to(:topic)
+      @consumer.should respond_to(:partition)
+    end
+
+    it "should have a polling option, and a default value" do
+      Consumer::DEFAULT_POLLING_INTERVAL.should eql(2)
+      @consumer.should respond_to(:polling)
+      @consumer.polling.should eql(2)
+    end
+
+    it "should set a topic and partition on initialize" do
+      @consumer = Consumer.new({ :host => "localhost", :port => 9092, :topic => "testing" })
+      @consumer.topic.should eql("testing")
+      @consumer.partition.should eql(0)
+      @consumer = Consumer.new({ :topic => "testing", :partition => 3 })
+      @consumer.partition.should eql(3)
+    end
+
+    it "should set default host and port if none is specified" do
+      @consumer = Consumer.new
+      @consumer.host.should eql("localhost")
+      @consumer.port.should eql(9092)
+    end
+
+    it "should not have a default offset but be able to set it" do
+      @consumer = Consumer.new
+      @consumer.offset.should be_nil
+      @consumer = Consumer.new({ :offset => 1111 })
+      @consumer.offset.should eql(1111)
+    end
+
+    it "should have a max size" do
+      Consumer::MAX_SIZE.should eql(1048576)
+      @consumer.max_size.should eql(1048576)
+    end
+
+    it "should return the size of the request" do
+      @consumer.topic = "someothertopicname"
+      @consumer.encoded_request_size.should eql([38].pack("N"))
+    end
+
+    it "should encode a request to consume" do
+      bytes = [Kafka::RequestType::FETCH].pack("n") + ["test".length].pack("n") + "test" + [0].pack("N") + [0].pack("q").reverse + [Kafka::Consumer::MAX_SIZE].pack("N")
+      @consumer.encode_request(Kafka::RequestType::FETCH, "test", 0, 0, Kafka::Consumer::MAX_SIZE).should eql(bytes)
+    end
+
+    it "should read the response data" do
+      bytes = [0].pack("n") + [1120192889].pack("N") + "ale"
+      @mocked_socket.should_receive(:read).and_return([9].pack("N"))
+      @mocked_socket.should_receive(:read).with(9).and_return(bytes)
+      @consumer.read_data_response.should eql(bytes[2,7])
+    end
+
+    it "should send a consumer request" do
+      @consumer.stub!(:encoded_request_size).and_return(666)
+      @consumer.stub!(:encode_request).and_return("someencodedrequest")
+      @consumer.should_receive(:write).with("someencodedrequest").exactly(:once).and_return(true)
+      @consumer.should_receive(:write).with(666).exactly(:once).and_return(true)
+      @consumer.send_consume_request.should eql(true)
+    end
+
+    it "should consume messages" do
+      @consumer.should_receive(:send_consume_request).and_return(true)
+      @consumer.should_receive(:read_data_response).and_return("")
+      @consumer.consume.should eql([])
+    end
+
+    it "should loop and execute a block with the consumed messages" do
+      @consumer.stub!(:consume).and_return([mock(Kafka::Message)])
+      messages = []
+      messages.should_receive(:<<).exactly(:once).and_return([])
+      @consumer.loop do |message|
+        messages << message
+        break # we don't wanna loop forever on the test
+      end
+    end
+
+    it "should loop (every N seconds, configurable on polling attribute), and execute a block with the consumed messages" do
+      @consumer = Consumer.new({ :polling => 1 })
+      @consumer.stub!(:consume).and_return([mock(Kafka::Message)])
+      messages = []
+      messages.should_receive(:<<).exactly(:twice).and_return([])
+      executed_times = 0
+      @consumer.loop do |message|
+        messages << message
+        executed_times += 1
+        break if executed_times >= 2 # we don't wanna loop forever on the test, only 2 seconds
+      end
+
+      executed_times.should eql(2)
+    end
+
+    it "should fetch initial offset if no offset is given" do
+      @consumer = Consumer.new
+      @consumer.should_receive(:fetch_latest_offset).exactly(:once).and_return(1000)
+      @consumer.should_receive(:send_consume_request).and_return(true)
+      @consumer.should_receive(:read_data_response).and_return("")
+      @consumer.consume
+      @consumer.offset.should eql(1000)
+    end
+
+    it "should encode an offset request" do
+      bytes = [Kafka::RequestType::OFFSETS].pack("n") + ["test".length].pack("n") + "test" + [0].pack("N") + [-1].pack("q").reverse + [Kafka::Consumer::MAX_OFFSETS].pack("N")
+      @consumer.encode_request(Kafka::RequestType::OFFSETS, "test", 0, -1, Kafka::Consumer::MAX_OFFSETS).should eql(bytes)
+    end
+
+    it "should parse an offsets response" do
+      bytes = [0].pack("n") + [1].pack('N') + [21346].pack('q').reverse
+      @mocked_socket.should_receive(:read).and_return([14].pack("N"))
+      @mocked_socket.should_receive(:read).and_return(bytes)
+      @consumer.read_offsets_response.should eql(21346)
+    end
+  end
+end

data/spec/encoder_spec.rb

@@ -0,0 +1,251 @@
+# encoding: utf-8
+
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Encoder do
+  def check_message(bytes, message)
+    encoded = [message.magic].pack("C") + [message.calculate_checksum].pack("N") + message.payload
+    encoded = [encoded.length].pack("N") + encoded
+    bytes.should == encoded
+  end
+
+  describe "Message Encoding" do
+    it "should encode a message" do
+      message = Kafka::Message.new("alejandro")
+      check_message(described_class.message(message), message)
+    end
+
+    it "should encode an empty message" do
+      message = Kafka::Message.new
+      check_message(described_class.message(message), message)
+    end
+
+    it "should encode strings containing non-ASCII characters" do
+      message = Kafka::Message.new("ümlaut")
+      encoded = described_class.message(message)
+      message = Kafka::Message.parse_from(encoded).messages.first
+      if RUBY_VERSION[0,3] == "1.8" # Use old iconv on Ruby 1.8 for encoding
+        #ic = Iconv.new('UTF-8//IGNORE', 'UTF-8')
+        #ic.iconv(message.payload).should eql("ümlaut")
+        message.payload.should eql("ümlaut")
+      else
+        message.payload.force_encoding(Encoding::UTF_8).should eql("ümlaut")
+      end
+    end
+
+    it "should encode strings containing non-ASCII characters" do
+      message = Kafka::Message.new("\214")
+      encoded = described_class.message(message)
+      message = Kafka::Message.parse_from(encoded).messages.first
+      if RUBY_VERSION[0,3] == "1.8"
+        message.payload.should eql("\214")
+      else
+        message.payload.force_encoding(Encoding::UTF_8).should eql("\214")
+      end
+    end
+  end
+
+  describe :compression do
+    before do
+      @message = Kafka::Message.new "foo"
+    end
+
+    it "should default to no compression" do
+      msg = "foo"
+      checksum = Zlib.crc32 msg
+      magic = 0
+      msg_size = 5 + msg.size
+      raw = [msg_size, magic, checksum, msg].pack "NCNa#{msg.size}"
+
+      Encoder.message(@message).should == raw
+    end
+
+    it "should support GZip compression" do
+      buffer = StringIO.new
+      gz = Zlib::GzipWriter.new buffer, nil, nil
+      gz.write "foo"
+      gz.close
+      buffer.rewind
+      msg = buffer.string
+      checksum = Zlib.crc32 msg
+      magic = 1
+      attrs = 1
+      msg_size = 6 + msg.size
+      raw = [msg_size, magic, attrs, checksum, msg].pack "NCCNa#{msg.size}"
+      Encoder.message(@message, 1).should == raw
+    end
+
+    if Object.const_defined? "Snappy"
+      it "should support Snappy compression" do
+        buffer = StringIO.new
+        Snappy::Writer.new buffer do |w|
+          w << "foo"
+        end
+        buffer.rewind
+        msg = buffer.string
+        checksum = Zlib.crc32 msg
+        magic = 1
+        attrs = 2
+        msg_size = 6 + msg.size
+        raw = [msg_size, magic, attrs, checksum, msg].pack "NCCNa#{msg.size}"
+
+        Encoder.message(@message, 2).should == raw
+      end
+    end
+  end
+
+  describe "produce" do
+    it "should binary encode an empty request" do
+      bytes = described_class.produce("test", 0, [])
+      bytes.length.should eql(20)
+      bytes.should eql("\000\000\000\020\000\000\000\004test\000\000\000\000\000\000\000\000")
+    end
+
+    it "should binary encode a request with a message, using a specific wire format" do
+      message = Kafka::Message.new("ale")
+      bytes = described_class.produce("test", 3, message)
+      data_size  = bytes[0, 4].unpack("N").shift
+      request_id = bytes[4, 2].unpack("n").shift
+      topic_length = bytes[6, 2].unpack("n").shift
+      topic = bytes[8, 4]
+      partition = bytes[12, 4].unpack("N").shift
+      messages_length = bytes[16, 4].unpack("N").shift
+      messages = bytes[20, messages_length]
+
+      bytes.length.should eql(32)
+      data_size.should eql(28)
+      request_id.should eql(0)
+      topic_length.should eql(4)
+      topic.should eql("test")
+      partition.should eql(3)
+      messages_length.should eql(12)
+    end
+  end
+
+  describe "message_set" do
+    it "should compress messages into a message set" do
+      message_one = Kafka::Message.new "foo"
+      message_two = Kafka::Message.new "bar"
+      bytes = described_class.message_set [message_one, message_two], Kafka::Message::GZIP_COMPRESSION
+
+      messages = Kafka::Message.parse_from bytes
+      messages.should be_a Kafka::Message::MessageSet
+      messages.messages.size.should == 2
+
+      messages.messages[0].should be_a Kafka::Message
+      messages.messages[0].payload.should == "foo"
+      messages.messages[1].should be_a Kafka::Message
+      messages.messages[1].payload.should == "bar"
+    end
+  end
+
+  describe "multiproduce" do
+    it "encodes an empty request" do
+      bytes = described_class.multiproduce([])
+      bytes.length.should == 8
+      bytes.should == "\x00\x00\x00\x04\x00\x03\x00\x00"
+    end
+
+    it "encodes a request with a single topic/partition" do
+      message = Kafka::Message.new("ale")
+      bytes = described_class.multiproduce(Kafka::ProducerRequest.new("test", message))
+
+      req_length = bytes[0, 4].unpack("N").shift
+      req_type = bytes[4, 2].unpack("n").shift
+      tp_count = bytes[6, 2].unpack("n").shift
+
+      req_type.should == Kafka::RequestType::MULTIPRODUCE
+      tp_count.should == 1
+
+      topic_length = bytes[8, 2].unpack("n").shift
+      topic = bytes[10, 4]
+      partition = bytes[14, 4].unpack("N").shift
+      messages_length = bytes[18, 4].unpack("N").shift
+      messages_data = bytes[22, messages_length]
+
+      topic_length.should == 4
+      topic.should == "test"
+      partition.should == 0
+      messages_length.should == 12
+      check_message(messages_data, message)
+    end
+
+    it "encodes a request with a single topic/partition but multiple messages" do
+      messages = [Kafka::Message.new("ale"), Kafka::Message.new("beer")]
+      bytes = described_class.multiproduce(Kafka::ProducerRequest.new("test", messages))
+
+      req_length = bytes[0, 4].unpack("N").shift
+      req_type = bytes[4, 2].unpack("n").shift
+      tp_count = bytes[6, 2].unpack("n").shift
+
+      req_type.should == Kafka::RequestType::MULTIPRODUCE
+      tp_count.should == 1
+
+      topic_length = bytes[8, 2].unpack("n").shift
+      topic = bytes[10, 4]
+      partition = bytes[14, 4].unpack("N").shift
+      messages_length = bytes[18, 4].unpack("N").shift
+      messages_data = bytes[22, messages_length]
+
+      topic_length.should == 4
+      topic.should == "test"
+      partition.should == 0
+      messages_length.should == 25
+      check_message(messages_data[0, 12], messages[0])
+      check_message(messages_data[12, 13], messages[1])
+    end
+
+    it "encodes a request with multiple topic/partitions" do
+      messages = [Kafka::Message.new("ale"), Kafka::Message.new("beer")]
+      bytes = described_class.multiproduce([
+          Kafka::ProducerRequest.new("test", messages[0]),
+          Kafka::ProducerRequest.new("topic", messages[1], :partition => 1),
+        ])
+
+      req_length = bytes[0, 4].unpack("N").shift
+      req_type = bytes[4, 2].unpack("n").shift
+      tp_count = bytes[6, 2].unpack("n").shift
+
+      req_type.should == Kafka::RequestType::MULTIPRODUCE
+      tp_count.should == 2
+
+      topic_length = bytes[8, 2].unpack("n").shift
+      topic = bytes[10, 4]
+      partition = bytes[14, 4].unpack("N").shift
+      messages_length = bytes[18, 4].unpack("N").shift
+      messages_data = bytes[22, 12]
+
+      topic_length.should == 4
+      topic.should == "test"
+      partition.should == 0
+      messages_length.should == 12
+      check_message(messages_data[0, 12], messages[0])
+
+      topic_length = bytes[34, 2].unpack("n").shift
+      topic = bytes[36, 5]
+      partition = bytes[41, 4].unpack("N").shift
+      messages_length = bytes[45, 4].unpack("N").shift
+      messages_data = bytes[49, 13]
+
+      topic_length.should == 5
+      topic.should == "topic"
+      partition.should == 1
+      messages_length.should == 13
+      check_message(messages_data[0, 13], messages[1])
+    end
+  end
+end

data/spec/io_spec.rb

@@ -0,0 +1,88 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+# 
+#    http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+require File.dirname(__FILE__) + '/spec_helper'
+
+class IOTest
+  include Kafka::IO
+end
+
+describe IO do
+
+  before(:each) do
+    @mocked_socket = mock(TCPSocket)
+    TCPSocket.stub!(:new).and_return(@mocked_socket) # don't use a real socket
+    @io = IOTest.new
+    @io.connect("somehost", 9093)
+  end
+
+  describe "default methods" do
+    it "has a socket, a host and a port" do
+      [:socket, :host, :port].each do |m|
+        @io.should respond_to(m.to_sym)
+      end
+    end
+
+    it "raises an exception if no host and port is specified" do
+      lambda {
+        io = IOTest.new
+        io.connect
+      }.should raise_error(ArgumentError)
+    end
+    
+    it "should remember the port and host on connect" do
+      @io.connect("somehost", 9093)
+      @io.host.should eql("somehost")
+      @io.port.should eql(9093)
+    end
+
+    it "should write to a socket" do
+      data = "some data"
+      @mocked_socket.should_receive(:write).with(data).and_return(9)
+      @io.write(data).should eql(9)
+    end
+
+    it "should read from a socket" do
+      length = 200
+      @mocked_socket.should_receive(:read).with(length).and_return("foo")
+      @io.read(length)
+    end
+
+    it "should disconnect on a timeout when reading from a socket (to aviod protocol desync state)" do
+      length = 200
+      @mocked_socket.should_receive(:read).with(length).and_raise(Errno::EAGAIN)
+      @io.should_receive(:disconnect)
+      lambda { @io.read(length) }.should raise_error(Kafka::SocketError)
+    end
+
+    it "should disconnect" do
+      @io.should respond_to(:disconnect)
+      @mocked_socket.should_receive(:close).and_return(nil)
+      @io.disconnect
+    end
+
+    it "should reconnect" do
+      TCPSocket.should_receive(:new)
+      @io.reconnect
+    end
+
+    it "should disconnect on a broken pipe error" do
+      [Errno::ECONNABORTED, Errno::EPIPE, Errno::ECONNRESET].each do |error|
+        @mocked_socket.should_receive(:write).exactly(:once).and_raise(error)
+        @mocked_socket.should_receive(:close).exactly(:once).and_return(nil)
+        lambda { @io.write("some data to send") }.should raise_error(Kafka::SocketError)
+      end
+    end
+  end
+end