lib/rb/spec/base_protocol_spec.rb

#
# 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 'spec_helper'

describe 'BaseProtocol' do

  before(:each) do
    @trans = mock("MockTransport")
    @prot = Thrift::BaseProtocol.new(@trans)
  end

  describe Thrift::BaseProtocol do
    # most of the methods are stubs, so we can ignore them

    it "should provide a reasonable to_s" do
      @trans.should_receive(:to_s).once.and_return("trans")
      @prot.to_s.should == "trans"
    end

    it "should make trans accessible" do
      @prot.trans.should eql(@trans)
    end

    it 'should write out a field nicely (deprecated write_field signature)' do
      @prot.should_receive(:write_field_begin).with('field', 'type', 'fid').ordered
      @prot.should_receive(:write_type).with({:name => 'field', :type => 'type'}, 'value').ordered
      @prot.should_receive(:write_field_end).ordered
      @prot.write_field('field', 'type', 'fid', 'value')
    end

    it 'should write out a field nicely' do
      @prot.should_receive(:write_field_begin).with('field', 'type', 'fid').ordered
      @prot.should_receive(:write_type).with({:name => 'field', :type => 'type', :binary => false}, 'value').ordered
      @prot.should_receive(:write_field_end).ordered
      @prot.write_field({:name => 'field', :type => 'type', :binary => false}, 'fid', 'value')
    end

    it 'should write out the different types (deprecated write_type signature)' do
      @prot.should_receive(:write_bool).with('bool').ordered
      @prot.should_receive(:write_byte).with('byte').ordered
      @prot.should_receive(:write_double).with('double').ordered
      @prot.should_receive(:write_i16).with('i16').ordered
      @prot.should_receive(:write_i32).with('i32').ordered
      @prot.should_receive(:write_i64).with('i64').ordered
      @prot.should_receive(:write_string).with('string').ordered
      struct = mock('Struct')
      struct.should_receive(:write).with(@prot).ordered
      @prot.write_type(Thrift::Types::BOOL, 'bool')
      @prot.write_type(Thrift::Types::BYTE, 'byte')
      @prot.write_type(Thrift::Types::DOUBLE, 'double')
      @prot.write_type(Thrift::Types::I16, 'i16')
      @prot.write_type(Thrift::Types::I32, 'i32')
      @prot.write_type(Thrift::Types::I64, 'i64')
      @prot.write_type(Thrift::Types::STRING, 'string')
      @prot.write_type(Thrift::Types::STRUCT, struct)
      # all other types are not implemented
      [Thrift::Types::STOP, Thrift::Types::VOID, Thrift::Types::MAP, Thrift::Types::SET, Thrift::Types::LIST].each do |type|
        expect { @prot.write_type(type, type.to_s) }.to raise_error(NotImplementedError)
      end
    end

    it 'should write out the different types' do
      @prot.should_receive(:write_bool).with('bool').ordered
      @prot.should_receive(:write_byte).with('byte').ordered
      @prot.should_receive(:write_double).with('double').ordered
      @prot.should_receive(:write_i16).with('i16').ordered
      @prot.should_receive(:write_i32).with('i32').ordered
      @prot.should_receive(:write_i64).with('i64').ordered
      @prot.should_receive(:write_string).with('string').ordered
      @prot.should_receive(:write_binary).with('binary').ordered
      struct = mock('Struct')
      struct.should_receive(:write).with(@prot).ordered
      @prot.write_type({:type => Thrift::Types::BOOL}, 'bool')
      @prot.write_type({:type => Thrift::Types::BYTE}, 'byte')
      @prot.write_type({:type => Thrift::Types::DOUBLE}, 'double')
      @prot.write_type({:type => Thrift::Types::I16}, 'i16')
      @prot.write_type({:type => Thrift::Types::I32}, 'i32')
      @prot.write_type({:type => Thrift::Types::I64}, 'i64')
      @prot.write_type({:type => Thrift::Types::STRING}, 'string')
      @prot.write_type({:type => Thrift::Types::STRING, :binary => true}, 'binary')
      @prot.write_type({:type => Thrift::Types::STRUCT}, struct)
      # all other types are not implemented
      [Thrift::Types::STOP, Thrift::Types::VOID, Thrift::Types::MAP, Thrift::Types::SET, Thrift::Types::LIST].each do |type|
        expect { @prot.write_type({:type => type}, type.to_s) }.to raise_error(NotImplementedError)
      end
    end

    it 'should read the different types (deprecated read_type signature)' do
      @prot.should_receive(:read_bool).ordered
      @prot.should_receive(:read_byte).ordered
      @prot.should_receive(:read_i16).ordered
      @prot.should_receive(:read_i32).ordered
      @prot.should_receive(:read_i64).ordered
      @prot.should_receive(:read_double).ordered
      @prot.should_receive(:read_string).ordered
      @prot.read_type(Thrift::Types::BOOL)
      @prot.read_type(Thrift::Types::BYTE)
      @prot.read_type(Thrift::Types::I16)
      @prot.read_type(Thrift::Types::I32)
      @prot.read_type(Thrift::Types::I64)
      @prot.read_type(Thrift::Types::DOUBLE)
      @prot.read_type(Thrift::Types::STRING)
      # all other types are not implemented
      [Thrift::Types::STOP, Thrift::Types::VOID, Thrift::Types::MAP,
       Thrift::Types::SET, Thrift::Types::LIST, Thrift::Types::STRUCT].each do |type|
        expect { @prot.read_type(type) }.to raise_error(NotImplementedError)
      end
    end

    it 'should read the different types' do
      @prot.should_receive(:read_bool).ordered
      @prot.should_receive(:read_byte).ordered
      @prot.should_receive(:read_i16).ordered
      @prot.should_receive(:read_i32).ordered
      @prot.should_receive(:read_i64).ordered
      @prot.should_receive(:read_double).ordered
      @prot.should_receive(:read_string).ordered
      @prot.should_receive(:read_binary).ordered
      @prot.read_type({:type => Thrift::Types::BOOL})
      @prot.read_type({:type => Thrift::Types::BYTE})
      @prot.read_type({:type => Thrift::Types::I16})
      @prot.read_type({:type => Thrift::Types::I32})
      @prot.read_type({:type => Thrift::Types::I64})
      @prot.read_type({:type => Thrift::Types::DOUBLE})
      @prot.read_type({:type => Thrift::Types::STRING})
      @prot.read_type({:type => Thrift::Types::STRING, :binary => true})
      # all other types are not implemented
      [Thrift::Types::STOP, Thrift::Types::VOID, Thrift::Types::MAP,
       Thrift::Types::SET, Thrift::Types::LIST, Thrift::Types::STRUCT].each do |type|
        expect { @prot.read_type({:type => type}) }.to raise_error(NotImplementedError)
      end
    end

    it "should skip the basic types" do
      @prot.should_receive(:read_bool).ordered
      @prot.should_receive(:read_byte).ordered
      @prot.should_receive(:read_i16).ordered
      @prot.should_receive(:read_i32).ordered
      @prot.should_receive(:read_i64).ordered
      @prot.should_receive(:read_double).ordered
      @prot.should_receive(:read_string).ordered
      @prot.skip(Thrift::Types::BOOL)
      @prot.skip(Thrift::Types::BYTE)
      @prot.skip(Thrift::Types::I16)
      @prot.skip(Thrift::Types::I32)
      @prot.skip(Thrift::Types::I64)
      @prot.skip(Thrift::Types::DOUBLE)
      @prot.skip(Thrift::Types::STRING)
      @prot.skip(Thrift::Types::STOP) # should do absolutely nothing
    end

    it "should skip structs" do
      real_skip = @prot.method(:skip)
      @prot.should_receive(:read_struct_begin).ordered
      @prot.should_receive(:read_field_begin).exactly(4).times.and_return(
        ['field 1', Thrift::Types::STRING, 1],
        ['field 2', Thrift::Types::I32, 2],
        ['field 3', Thrift::Types::MAP, 3],
        [nil, Thrift::Types::STOP, 0]
      )
      @prot.should_receive(:read_field_end).exactly(3).times
      @prot.should_receive(:read_string).exactly(3).times
      @prot.should_receive(:read_i32).ordered
      @prot.should_receive(:read_map_begin).ordered.and_return([Thrift::Types::STRING, Thrift::Types::STRING, 1])
      # @prot.should_receive(:read_string).exactly(2).times
      @prot.should_receive(:read_map_end).ordered
      @prot.should_receive(:read_struct_end).ordered
      real_skip.call(Thrift::Types::STRUCT)
    end

    it "should skip maps" do
      real_skip = @prot.method(:skip)
      @prot.should_receive(:read_map_begin).ordered.and_return([Thrift::Types::STRING, Thrift::Types::STRUCT, 1])
      @prot.should_receive(:read_string).ordered
      @prot.should_receive(:read_struct_begin).ordered.and_return(["some_struct"])
      @prot.should_receive(:read_field_begin).ordered.and_return([nil, Thrift::Types::STOP, nil]);
      @prot.should_receive(:read_struct_end).ordered
      @prot.should_receive(:read_map_end).ordered
      real_skip.call(Thrift::Types::MAP)
    end

    it "should skip sets" do
      real_skip = @prot.method(:skip)
      @prot.should_receive(:read_set_begin).ordered.and_return([Thrift::Types::I64, 9])
      @prot.should_receive(:read_i64).ordered.exactly(9).times
      @prot.should_receive(:read_set_end)
      real_skip.call(Thrift::Types::SET)
    end

    it "should skip lists" do
      real_skip = @prot.method(:skip)
      @prot.should_receive(:read_list_begin).ordered.and_return([Thrift::Types::DOUBLE, 11])
      @prot.should_receive(:read_double).ordered.exactly(11).times
      @prot.should_receive(:read_list_end)
      real_skip.call(Thrift::Types::LIST)
    end
  end

  describe Thrift::BaseProtocolFactory do
    it "should raise NotImplementedError" do
      # returning nil since Protocol is just an abstract class
      lambda {Thrift::BaseProtocolFactory.new.get_protocol(mock("MockTransport"))}.should raise_error(NotImplementedError)
    end

    it "should provide a reasonable to_s" do
      Thrift::BaseProtocolFactory.new.to_s.should == "base"
    end
  end
end