cql-rb 1.0.6 → 1.1.0.pre0

data/spec/cql/protocol/cql_protocol_handler_spec.rb

@@ -0,0 +1,216 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+
+module Cql
+  module Protocol
+    describe CqlProtocolHandler do
+      let :protocol_handler do
+        described_class.new(connection)
+      end
+
+      let :connection do
+        stub(:connection)
+      end
+
+      let :request do
+        Protocol::OptionsRequest.new
+      end
+
+      let :buffer do
+        ByteBuffer.new
+      end
+
+      before do
+        connection.stub(:on_data) do |&h|
+          connection.stub(:data_listener).and_return(h)
+        end
+        connection.stub(:on_closed) do |&h|
+          connection.stub(:closed_listener).and_return(h)
+        end
+        connection.stub(:on_connected) do |&h|
+          connection.stub(:connected_listener).and_return(h)
+        end
+        protocol_handler
+      end
+
+      describe '#initialize' do
+        it 'registers as a data listener to the socket handler' do
+          connection.data_listener.should_not be_nil
+        end
+      end
+
+      describe '#send_request' do
+        before do
+          connection.stub(:write).and_yield(buffer)
+          connection.stub(:closed?).and_return(false)
+
+          connection.stub(:connected?).and_return(true)
+        end
+
+        it 'encodes a request frame and writes to the socket handler' do
+          protocol_handler.send_request(request)
+          buffer.to_s.should == [1, 0, 0, 5, 0].pack('C4N')
+        end
+
+        it 'encodes a frame with the next available stream ID' do
+          protocol_handler.send_request(request)
+          protocol_handler.send_request(request)
+          buffer.to_s.should == [1, 0, 0, 5, 0].pack('C4N') + [1, 0, 1, 5, 0].pack('C4N')
+        end
+
+        it 'returns a future' do
+          protocol_handler.send_request(request).should be_a(Future)
+        end
+
+        it 'completes the future when it receives a response frame with the corresponding stream ID' do
+          3.times { protocol_handler.send_request(request) }
+          future = protocol_handler.send_request(request)
+          connection.data_listener.call([0x81, 0, 3, 2, 0].pack('C4N'))
+          await(0.1) { future.complete? }
+        end
+
+        it 'handles multiple response frames in the same data packet' do
+          futures = Array.new(4) { protocol_handler.send_request(request) }
+          connection.data_listener.call([0x81, 0, 2, 2, 0].pack('C4N') + [0x81, 0, 3, 2, 0].pack('C4N'))
+          await(0.1) { futures[2].complete? && futures[3].complete? }
+        end
+
+        it 'queues the request when there are too many in flight, sending it as soon as a stream is available' do
+          connection.stub(:write)
+          futures = Array.new(130) { protocol_handler.send_request(request) }
+          128.times { |i| connection.data_listener.call([0x81, 0, i, 2, 0].pack('C4N')) }
+          futures[127].should be_complete
+          futures[128].should_not be_complete
+          2.times { |i| connection.data_listener.call([0x81, 0, i, 2, 0].pack('C4N')) }
+          futures[128].should be_complete
+        end
+
+        context 'when the protocol handler closes' do
+          it 'fails all requests waiting for a reply' do
+            futures = Array.new(5) { protocol_handler.send_request(request) }
+            connection.closed_listener.call(StandardError.new('Blurgh'))
+            futures.should be_all(&:failed?), 'expected all requests to have failed'
+          end
+
+          it 'fails all queued requests' do
+            futures = Array.new(200) { protocol_handler.send_request(request) }
+            connection.closed_listener.call(StandardError.new('Blurgh'))
+            futures.should be_all(&:failed?), 'expected all requests to have failed'
+          end
+
+          it 'fails all requests with ConnectionClosedError if there is no specific error' do
+            protocol_handler.send_request(request)
+            future = protocol_handler.send_request(request)
+            connection.data_listener.call([0x81, 0, 0, 2, 0].pack('C4N'))
+            connection.closed_listener.call(nil)
+            begin
+              future.get
+            rescue => e
+              e.should be_a(Cql::Io::ConnectionClosedError)
+            else
+              fail('No error was raised!')
+            end
+          end
+
+          it 'passes the error that caused the protocol handler to close to the failed requests' do
+            error = nil
+            future = protocol_handler.send_request(request)
+            future.on_failure { |e| error = e }
+            connection.closed_listener.call(StandardError.new('Blurgh'))
+            error.should == StandardError.new('Blurgh')
+          end
+        end
+
+        context 'when the protocol handler has closed' do
+          it 'fails all requests with NotConnectedError' do
+            connection.stub(:closed?).and_return(true)
+            f = protocol_handler.send_request(request)
+            expect { f.get }.to raise_error(NotConnectedError)
+          end
+        end
+      end
+
+      describe '#close' do
+        it 'closes the underlying protocol handler' do
+          connection.should_receive(:close)
+          protocol_handler.close
+        end
+
+        it 'returns a future which completes when the socket has closed' do
+          connection.stub(:close) do
+            connection.closed_listener.call(nil)
+          end
+          protocol_handler.close.get
+        end
+      end
+
+      describe '#keyspace' do
+        before do
+          connection.stub(:closed?).and_return(false)
+          connection.stub(:connected?).and_return(true)
+          connection.stub(:write)
+        end
+
+        it 'is not in a keyspace initially' do
+          protocol_handler.keyspace.should be_nil
+        end
+
+        it 'registers the keyspace it has changed to' do
+          f = protocol_handler.send_request(Protocol::QueryRequest.new('USE hello', :one))
+          connection.data_listener.call([0x81, 0, 0, 8, 4 + 2 + 5, 3, 5].pack('C4N2n') + 'hello')
+          f.get
+          protocol_handler.keyspace.should == 'hello'
+        end
+      end
+
+      [:connected?, :closed?].each do |message|
+        describe "##{message}" do
+          it 'reflects the underlying protocol handler\'s status' do
+            connection.stub(message).and_return(true)
+            protocol_handler.send(message).should be_true
+            connection.stub(message).and_return(false)
+            protocol_handler.send(message).should be_false
+          end
+        end
+      end
+
+      describe '#on_event' do
+        it 'calls the callback on events' do
+          event = nil
+          protocol_handler.on_event do |e|
+            event = e
+          end
+          connection.data_listener.call("\x81\x00\xFF\f\x00\x00\x00+\x00\rSCHEMA_CHANGE\x00\aDROPPED\x00\x0cthe_keyspace\x00\x09the_table")
+          event.should == Protocol::SchemaChangeEventResponse.new('DROPPED', 'the_keyspace', 'the_table')
+        end
+
+        it 'ignores errors raised by the listener' do
+          called = false
+          protocol_handler.on_event { |e| raise 'Blurgh' }
+          protocol_handler.on_event { |e| called = true }
+          connection.data_listener.call("\x81\x00\xFF\f\x00\x00\x00+\x00\rSCHEMA_CHANGE\x00\aDROPPED\x00\x0cthe_keyspace\x00\x09the_table")
+          called.should be_true, 'expected all event listeners to have been called'
+        end
+      end
+
+      describe '#on_closed' do
+        it 'calls the callback when the underlying protocol handler closes' do
+          called = false
+          protocol_handler.on_closed { called = true }
+          connection.closed_listener.call(StandardError.new('Blurgh'))
+          called.should be_true, 'expected the close listener to have been called'
+        end
+
+        it 'ignores errors raised by the listener' do
+          called = false
+          protocol_handler.on_closed { |e| raise 'Blurgh' }
+          protocol_handler.on_closed { |e| called = true }
+          connection.closed_listener.call(StandardError.new('Blurgh'))
+          called.should be_true, 'expected all event listeners to have been called'
+        end
+      end
+    end
+  end
+end

data/spec/cql/protocol/decoding_spec.rb

@@ -62,21 +62,6 @@ module Cql
           Decoding.read_decimal!(buffer).should == BigDecimal.new('1042342234234.123423435647768234')
         end
 
-        it 'decodes a negative decimal' do
-          buffer = ByteBuffer.new("\x00\x00\x00\x12\xF2\xD8\x02\xB6R\x7F\x99\xEE\x98#\x99\xA9V")
-          Decoding.read_decimal!(buffer).should == BigDecimal.new('-1042342234234.123423435647768234')
-        end
-
-        it 'decodes a positive decimal with only fractions' do
-          buffer = ByteBuffer.new("\x00\x00\x00\x13*\xF8\xC4\xDF\xEB]o")
-          Decoding.read_decimal!(buffer).should == BigDecimal.new('0.0012095473475870063')
-        end
-
-        it 'decodes a negative decimal with only fractions' do
-          buffer = ByteBuffer.new("\x00\x00\x00\x13\xD5\a;\x20\x14\xA2\x91")
-          Decoding.read_decimal!(buffer).should == BigDecimal.new('-0.0012095473475870063')
-        end
-
         it 'consumes the bytes' do
           buffer << 'HELLO'
           Decoding.read_decimal!(buffer, buffer.length - 5)
@@ -94,16 +79,11 @@ module Cql
       end
 
       describe '#read_long!' do
-        it 'decodes a positive long' do
+        it 'decodes a long' do
           buffer = ByteBuffer.new("\x00\x00\xca\xfe\xba\xbe\x00\x00")
           Decoding.read_long!(buffer).should == 0x0000cafebabe0000
         end
 
-        it 'decodes a negative long' do
-          buffer = ByteBuffer.new("\xff\xff\xff\xff\xff\xff\xff\xff")
-          Decoding.read_long!(buffer).should == -1
-        end
-
         it 'consumes the bytes' do
           buffer = ByteBuffer.new("\xca\xfe\xba\xbe\xca\xfe\xba\xbe\xca\xfe\xba\xbe")
           Decoding.read_long!(buffer)
@@ -157,15 +137,10 @@ module Cql
           ByteBuffer.new("\x00\xff\x00\xff")
         end
 
-        it 'decodes a positive int' do
+        it 'decodes an int' do
           Decoding.read_int!(buffer).should == 0x00ff00ff
         end
 
-        it 'decodes a negative int' do
-          buffer = ByteBuffer.new("\xff\xff\xff\xff")
-          Decoding.read_int!(buffer).should == -1
-        end
-
         it 'consumes the bytes' do
           buffer << "\xab\xcd"
           Decoding.read_int!(buffer)
@@ -260,10 +235,16 @@ module Cql
           ByteBuffer.new("\xA4\xA7\t\x00$\xE1\x11\xDF\x89$\x00\x1F\xF3Y\x17\x11")
         end
 
-        it 'decodes a UUID' do
+        it 'decodes a UUID as a Cql::Uuid' do
           Decoding.read_uuid!(buffer).should == Uuid.new('a4a70900-24e1-11df-8924-001ff3591711')
         end
         
+        it 'decodes a UUID as a Cql::TimeUuid' do
+          uuid = Decoding.read_uuid!(buffer, TimeUuid)
+          uuid.should == TimeUuid.new('a4a70900-24e1-11df-8924-001ff3591711')
+          uuid.should be_a(TimeUuid)
+        end
+
         it 'consumes the bytes' do
           Decoding.read_uuid!(buffer)
           buffer.should be_empty

data/spec/cql/protocol/encoding_spec.rb

@@ -121,11 +121,6 @@ module Cql
           buffer.should eql_bytes("\xA4\xA7\t\x00$\xE1\x11\xDF\x89$\x00\x1F\xF3Y\x17\x11")
         end
 
-        it 'encodes a UUID as 16 bytes' do
-          Encoding.write_uuid(buffer, Uuid.new('00000000-24e1-11df-8924-001ff3591711'))
-          buffer.size.should eql(16)
-        end
-
         it 'appends to the buffer' do
           buffer << 'FOO'
           Encoding.write_uuid(buffer, uuid)

data/spec/cql/protocol/request_spec.rb

@@ -24,6 +24,22 @@ module Cql
           encoded_frame.should equal(buffer)
         end
       end
+
+      describe '.change_stream_id' do
+        it 'changes the stream ID byte' do
+          buffer = ByteBuffer.new("\x01\x00\x03\x02\x00\x00\x00\x00")
+          described_class.change_stream_id(99, buffer)
+          buffer.discard(2)
+          buffer.read_byte.should == 99
+        end
+
+        it 'changes the stream ID byte of the frame starting at the specified offset' do
+          buffer = ByteBuffer.new("hello foo\x01\x00\x03\x02\x00\x00\x00\x00")
+          described_class.change_stream_id(99, buffer, 9)
+          buffer.discard(11)
+          buffer.read_byte.should == 99
+        end
+      end
     end
   end
 end

data/spec/cql/protocol/response_frame_spec.rb

@@ -520,8 +520,8 @@ module Cql
             frame.body.rows.first['varint_column'].should == 1231312312331283012830129382342342412123
           end
 
-          it 'decodes TIMEUUID as a Uuid' do
-            frame.body.rows.first['timeuuid_column'].should == Uuid.new('a4a70900-24e1-11df-8924-001ff3591711')
+          it 'decodes TIMEUUID as a TimeUuid' do
+            frame.body.rows.first['timeuuid_column'].should == TimeUuid.new('a4a70900-24e1-11df-8924-001ff3591711')
           end
 
           it 'decodes INET as a IPAddr' do

data/spec/cql/protocol/responses/schema_change_result_response_spec.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+
+module Cql
+  module Protocol
+    describe SchemaChangeResultResponse do
+      describe '#eql?' do
+        it 'is equal to another response with the same change, keyspace and table names' do
+          response1 = described_class.new('DROPPED', 'some_keyspace', 'a_table')
+          response2 = described_class.new('DROPPED', 'some_keyspace', 'a_table')
+          response1.should eql(response2)
+        end
+
+        it 'is not equal to another response with another change' do
+          response1 = described_class.new('DROPPED', 'some_keyspace', 'a_table')
+          response2 = described_class.new('CREATED', 'some_keyspace', 'a_table')
+          response1.should_not eql(response2)
+        end
+
+        it 'is not equal to another response with another keyspace name' do
+          response1 = described_class.new('DROPPED', 'some_keyspace', 'a_table')
+          response2 = described_class.new('DROPPED', 'another_keyspace', 'a_table')
+          response1.should_not eql(response2)
+        end
+
+        it 'is not equal to another response with another table name' do
+          response1 = described_class.new('DROPPED', 'some_keyspace', 'a_table')
+          response2 = described_class.new('DROPPED', 'some_keyspace', 'another_table')
+          response1.should_not eql(response2)
+        end
+
+        it 'is aliased as ==' do
+          response1 = described_class.new('DROPPED', 'some_keyspace', 'a_table')
+          response2 = described_class.new('DROPPED', 'some_keyspace', 'a_table')
+          response3 = described_class.new('DROPPED', 'some_keyspace', 'another_table')
+          response1.should == response2
+          response2.should_not == response3
+        end
+      end
+
+      describe '#hash' do
+        it 'is the same when the change, keyspace and table names are the same' do
+          response1 = described_class.new('DROPPED', 'some_keyspace', 'a_table')
+          response2 = described_class.new('DROPPED', 'some_keyspace', 'a_table')
+          response1.hash.should == response2.hash
+        end
+
+        it 'is not the same when the change is different' do
+          response1 = described_class.new('DROPPED', 'some_keyspace', 'a_table')
+          response2 = described_class.new('CREATED', 'some_keyspace', 'a_table')
+          response1.hash.should_not == response2.hash
+        end
+
+        it 'is not the same when the keyspace name is different' do
+          response1 = described_class.new('DROPPED', 'some_keyspace', 'a_table')
+          response2 = described_class.new('DROPPED', 'another_keyspace', 'a_table')
+          response1.hash.should_not == response2.hash
+        end
+
+        it 'is not the same when the table name is different' do
+          response1 = described_class.new('DROPPED', 'some_keyspace', 'a_table')
+          response2 = described_class.new('DROPPED', 'some_keyspace', 'another_table')
+          response1.hash.should_not == response2.hash
+        end
+      end
+    end
+  end
+end

data/spec/cql/time_uuid_spec.rb

@@ -0,0 +1,136 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+
+module Cql
+  describe TimeUuid do
+    let :time do
+      Time.utc(2013, 6, 7, 8, 9, 10)
+    end
+
+    describe '#to_time' do
+      it 'returns a Time' do
+        x = TimeUuid.new('00b69180-d0e1-11e2-8b8b-0800200c9a66')
+        x.to_time.should be > Time.utc(2013, 6, 9, 8, 45, 57)
+        x.to_time.should be < Time.utc(2013, 6, 9, 8, 45, 58)
+      end
+    end
+  end
+
+  describe TimeUuid::Generator do
+    let :generator do
+      described_class.new(nil, nil, stub(now: clock))
+    end
+
+    let :clock do
+      stub(:clock, to_i: 1370771820, usec: 329394)
+    end
+
+    describe '#next' do
+      it 'returns a UUID generated from the current time' do
+        x = generator.next
+        x.to_time.to_i.should == 1370771820
+        x.to_time.usec.should == 329394
+      end
+
+      it 'returns unique IDs even when called within a time shorter than the clock resolution' do
+        x1 = generator.next
+        x2 = generator.next
+        clock.stub(:usec).and_return(329394 + 1)
+        x3 = generator.next
+        x1.should_not == x2
+        x2.should_not == x3
+      end
+
+      it 'creates a pseudo random clock ID' do
+        str = generator.next.to_s.split('-')[3]
+        str.should_not === '0000'
+      end
+
+      it 'uses the clock ID for all generated UUIDs' do
+        str1 = generator.next.to_s.split('-')[3]
+        str2 = generator.next.to_s.split('-')[3]
+        str3 = generator.next.to_s.split('-')[3]
+        str1.should == str2
+        str2.should == str3
+      end
+
+      it 'creates a new clock ID when the clock has moved backwards' do
+        str1 = generator.next.to_s.split('-')[3]
+        clock.stub(:to_i).and_return(1370771820 - 5)
+        str2 = generator.next.to_s.split('-')[3]
+        str1.should_not == str2
+      end
+
+      it 'creates a pseudo random node ID' do
+        str = generator.next.to_s.split('-')[4]
+        str.should_not == '000000000000'
+      end
+
+      it 'uses the node ID for all generated UUIDs' do
+        str1 = generator.next.to_s.split('-')[4]
+        str2 = generator.next.to_s.split('-')[4]
+        str3 = generator.next.to_s.split('-')[4]
+        str1.should == str2
+        str2.should == str3
+      end
+
+      it 'sets the multicast bit of the node ID (so that it does not conflict with valid MAC addresses)' do
+        x = generator.next.value & 0x010000000000
+        x.should == 0x010000000000
+      end
+
+      it 'generates a version 1, variant 1 UUID' do
+        x = generator.from_time(clock)
+        (x.value & 0x10008000000000000000).should == 0x10008000000000000000
+      end
+    end
+
+    describe '#from_time' do
+      it 'returns a UUID for the specified time with a bit of random jitter' do
+        x = generator.from_time(clock)
+        x.to_time.to_i.should == 1370771820
+        x.to_time.usec.should be > 329394
+      end
+
+      it 'returns a UUID for the specified time with an offset' do
+        x = generator.from_time(clock, 8)
+        x.to_time.to_i.should == 1370771820
+        x.to_time.usec.should == 329394 + 8
+      end
+    end
+
+    context 'when specifying a custom clock ID' do
+      it 'uses the lower 14 bits of the specified clock ID' do
+        g = described_class.new(nil, 0x2bad, stub(now: clock))
+        (g.next.value >> 48 & 0x3fff).should == 0x2bad
+      end
+
+      it 'ensures that the high bit of the clock ID is 1 (the variant)' do
+        g = described_class.new(nil, 0x2bad, stub(now: clock))
+        (g.next.value >> 60 & 0b1000).should == 0b1000
+      end
+
+      it 'generates a new random clock ID if time has moved backwards' do
+        g = described_class.new(nil, 0x2bad, stub(now: clock))
+        str1 = g.next.to_s.split('-')[3]
+        clock.stub(:to_i).and_return(1370771820 - 2)
+        str2 = g.next.to_s.split('-')[3]
+        str1.should_not == str2
+      end
+    end
+
+    context 'when specifying a custom node ID' do
+      it 'uses the lower 48 bits of the specified node ID' do
+        g = described_class.new(0xd00b1ed00b1ed00b, 0x0000, stub(now: clock))
+        g.next.to_s.should end_with('00-1ed00b1ed00b')
+      end
+
+      it 'does not modify the multicast bit' do
+        g = described_class.new(0x000000000000, 0x0000, stub(now: clock))
+        g.next.to_s.should end_with('00-000000000000')
+      end
+    end
+  end
+end