packetfu 1.1.10 → 1.1.11

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+
+$:.unshift File.join(File.expand_path(File.dirname(__FILE__)), "..", "lib")
+require 'packetfu'
+
+puts "rspec #{RSpec::Core::Version::STRING}"
+if RSpec::Core::Version::STRING[0] == '3'
+  require 'rspec/its'
+  RSpec.configure do |config|
+    #config.raise_errors_for_deprecations!
+    config.expect_with :rspec do |c|
+      c.syntax = [:expect, :should]
+    end
+  end
+end
+
+
+module FakePacket
+  def layer
+    7
+  end
+end
+
+class PacketFu::FooPacket < PacketFu::Packet
+  extend FakePacket
+end
+
+class PacketFu::BarPacket < PacketFu::Packet
+  extend FakePacket
+end
+
+class PacketBaz
+end
+
+def add_fake_packets
+  PacketFu.add_packet_class(PacketFu::FooPacket)
+  PacketFu.add_packet_class(PacketFu::BarPacket)
+end
+
+def remove_fake_packets
+  PacketFu.remove_packet_class(PacketFu::FooPacket)
+  PacketFu.remove_packet_class(PacketFu::BarPacket)
+end
+
+remove_fake_packets

data/spec/structfu_spec.rb

@@ -1,335 +1,334 @@
-$:.unshift File.join(File.expand_path(File.dirname(__FILE__)), "..", "lib")
-require 'packetfu'
+require 'spec_helper'
 
 describe StructFu, "mixin methods" do
 
-	before :each do
-		class StructClass
-			include StructFu
-		end
-		@sc = StructClass.new
-	end
-
-	it "should provide the basic StructFu methods" do
-		@sc.respond_to?(:sz).should be_true
-		@sc.respond_to?(:len).should be_true
-		@sc.respond_to?(:typecast).should be_true
-		@sc.respond_to?(:body=).should be_true
-	end
-end	
+  before :each do
+    class StructClass
+      include StructFu
+    end
+    @sc = StructClass.new
+  end
+
+  it "should provide the basic StructFu methods" do
+    @sc.respond_to?(:sz).should be true
+    @sc.respond_to?(:len).should be true
+    @sc.respond_to?(:typecast).should be true
+    @sc.respond_to?(:body=).should be true
+  end
+end
 
 describe StructFu::Int, "basic Int class" do
 
-	before :each do
-		@int = StructFu::Int.new(8)
-	end
-
-	it "should have an initial state" do
-		new_int = StructFu::Int.new
-		new_int.value.should be_nil
-		new_int.endian.should be_nil
-		new_int.width.should be_nil
-		new_int.default.should == 0
-	end
-
-	it "should raise when to_s'ed directly" do
-		expect { @int.to_s}.to raise_error
-	end
-
-	it "should have a value of 8" do
-		@int.value.should == 8
-		@int.to_i.should == 8
-		@int.to_f.to_s.should == "8.0"
-	end
-
-	it "should read an integer" do
-		@int.read(7)
-		@int.to_i.should == 7
-	end
+  before :each do
+    @int = StructFu::Int.new(8)
+  end
+
+  it "should have an initial state" do
+    new_int = StructFu::Int.new
+    new_int.value.should be_nil
+    new_int.endian.should be_nil
+    new_int.width.should be_nil
+    new_int.default.should == 0
+  end
+
+  it "should raise when to_s'ed directly" do
+    expect { @int.to_s}.to raise_error(StandardError, "StructFu::Int#to_s accessed, must be redefined.")
+  end
+
+  it "should have a value of 8" do
+    @int.value.should == 8
+    @int.to_i.should == 8
+    @int.to_f.to_s.should == "8.0"
+  end
+
+  it "should read an integer" do
+    @int.read(7)
+    @int.to_i.should == 7
+  end
 
 end
 
 describe StructFu::Int8, "one byte value" do
 
-	before :each do
-		@int = StructFu::Int8.new(11)
-	end
-
-	it "should have an initial state" do
-		new_int = StructFu::Int8.new
-		new_int.value.should be_nil
-		new_int.endian.should be_nil
-		new_int.width.should == 1
-		new_int.default.should == 0
-	end
-
-	it "should print a one character packed string" do
-		@int.to_s.should == "\x0b"
-	end
-
-	it "should have a value of 11" do
-		@int.value.should == 11
-		@int.to_i.should == 11
-		@int.to_f.to_s.should == "11.0"
-	end
-
-	it "should reset with a new integer" do
-		@int.read(2)
-		@int.to_i.should == 2
-		@int.to_s.should == "\x02"
-		@int.read(254)
-		@int.to_i.should == 254
-		@int.to_s.should == "\xfe"
-	end
+  before :each do
+    @int = StructFu::Int8.new(11)
+  end
+
+  it "should have an initial state" do
+    new_int = StructFu::Int8.new
+    new_int.value.should be_nil
+    new_int.endian.should be_nil
+    new_int.width.should == 1
+    new_int.default.should == 0
+  end
+
+  it "should print a one character packed string" do
+    @int.to_s.should == "\x0b"
+  end
+
+  it "should have a value of 11" do
+    @int.value.should == 11
+    @int.to_i.should == 11
+    @int.to_f.to_s.should == "11.0"
+  end
+
+  it "should reset with a new integer" do
+    @int.read(2)
+    @int.to_i.should == 2
+    @int.to_s.should == "\x02"
+    @int.read(254)
+    @int.to_i.should == 254
+    @int.to_s.should == "\xfe".force_encoding("binary")
+  end
 
 end
 
 describe StructFu::Int16, "two byte value" do
 
-	before :each do
-		@int = StructFu::Int16.new(11)
-	end
-
-	it "should have an initial state" do
-		new_int = StructFu::Int16.new
-		new_int.value.should be_nil
-		new_int.endian.should == :big
-		new_int.width.should == 2
-		new_int.default.should == 0
-	end
-
-	it "should print a two character packed string" do
-		@int.to_s.should == "\x00\x0b"
-	end
-
-	it "should have a value of 11" do
-		@int.value.should == 11
-		@int.to_i.should == 11
-		@int.to_f.to_s.should == "11.0"
-	end
-
-	it "should reset with a new integer" do
-		@int.read(2)
-		@int.to_i.should == 2
-		@int.to_s.should == "\x00\x02"
-		@int.read(254)
-		@int.to_i.should == 254
-		@int.to_s.should == "\x00\xfe"
-	end
-
-	it "should be able to set endianness" do
-		int_be = StructFu::Int16.new(11,:big)
-		int_be.to_s.should == "\x00\x0b"
-		int_le = StructFu::Int16.new(11,:little)
-		int_le.to_s.should == "\x0b\x00"
-	end
-
-	it "should be able to switch endianness" do
-		@int.endian.should == :big
-		@int.to_s.should == "\x00\x0b"
-		@int.endian = :little
-		@int.endian.should == :little
-		@int.read(11)
-		@int.to_s.should == "\x0b\x00"
-	end
+  before :each do
+    @int = StructFu::Int16.new(11)
+  end
+
+  it "should have an initial state" do
+    new_int = StructFu::Int16.new
+    new_int.value.should be_nil
+    new_int.endian.should == :big
+    new_int.width.should == 2
+    new_int.default.should == 0
+  end
+
+  it "should print a two character packed string" do
+    @int.to_s.should == "\x00\x0b".force_encoding("binary")
+  end
+
+  it "should have a value of 11" do
+    @int.value.should == 11
+    @int.to_i.should == 11
+    @int.to_f.to_s.should == "11.0"
+  end
+
+  it "should reset with a new integer" do
+    @int.read(2)
+    @int.to_i.should == 2
+    @int.to_s.should == "\x00\x02"
+    @int.read(254)
+    @int.to_i.should == 254
+    @int.to_s.should == "\x00\xfe".force_encoding("binary")
+  end
+
+  it "should be able to set endianness" do
+    int_be = StructFu::Int16.new(11,:big)
+    int_be.to_s.should == "\x00\x0b"
+    int_le = StructFu::Int16.new(11,:little)
+    int_le.to_s.should == "\x0b\x00"
+  end
+
+  it "should be able to switch endianness" do
+    @int.endian.should == :big
+    @int.to_s.should == "\x00\x0b"
+    @int.endian = :little
+    @int.endian.should == :little
+    @int.read(11)
+    @int.to_s.should == "\x0b\x00"
+  end
 
 end
 
 describe StructFu::Int16le, "2 byte little-endian value" do
 
-	before :each do
-		@int = StructFu::Int16le.new(11)
-	end
+  before :each do
+    @int = StructFu::Int16le.new(11)
+  end
 
-	it "should behave pretty much like any other 16 bit int" do
-		@int.to_s.should == "\x0b\x00"
-	end
+  it "should behave pretty much like any other 16 bit int" do
+    @int.to_s.should == "\x0b\x00"
+  end
 
-	it "should raise when you try to change endianness" do
-		expect { @int.endian = :big }.to raise_error
-		expect { @int.endian = :little }.to raise_error
-	end
+  it "should raise when you try to change endianness" do
+    expect { @int.endian = :big }.to raise_error(NoMethodError, /undefined method `endian='/)
+    expect { @int.endian = :little }.to raise_error(NoMethodError, /undefined method `endian='/)
+  end
 
 end
 
 describe StructFu::Int16be, "2 byte big-endian value" do
 
-	before :each do
-		@int = StructFu::Int16be.new(11)
-	end
+  before :each do
+    @int = StructFu::Int16be.new(11)
+  end
 
-	it "should behave pretty much like any other 16 bit int" do
-		@int.to_s.should == "\x00\x0b"
-	end
+  it "should behave pretty much like any other 16 bit int" do
+    @int.to_s.should == "\x00\x0b"
+  end
 
-	it "should raise when you try to change endianness" do
-		expect { @int.endian = :big }.to raise_error
-		expect { @int.endian = :little }.to raise_error
-	end
+  it "should raise when you try to change endianness" do
+    expect { @int.endian = :big }.to raise_error(NoMethodError, /undefined method `endian='/)
+    expect { @int.endian = :little }.to raise_error(NoMethodError, /undefined method `endian='/)
+  end
 
 end
 
 describe StructFu::Int32, "four byte value" do
 
-	before :each do
-		@int = StructFu::Int32.new(11)
-	end
-
-	it "should have an initial state" do
-		new_int = StructFu::Int32.new
-		new_int.value.should be_nil
-		new_int.endian.should == :big
-		new_int.width.should == 4
-		new_int.default.should == 0
-	end
-
-	it "should print a four character packed string" do
-		@int.to_s.should == "\x00\x00\x00\x0b"
-	end
-
-	it "should have a value of 11" do
-		@int.value.should == 11
-		@int.to_i.should == 11
-		@int.to_f.to_s.should == "11.0"
-	end
-
-	it "should reset with a new integer" do
-		@int.read(2)
-		@int.to_i.should == 2
-		@int.to_s.should == "\x00\x00\x00\x02"
-		@int.read(254)
-		@int.to_i.should == 254
-		@int.to_s.should == "\x00\x00\x00\xfe"
-	end
-
-	it "should be able to set endianness" do
-		int_be = StructFu::Int32.new(11,:big)
-		int_be.to_s.should == "\x00\x00\x00\x0b"
-		int_le = StructFu::Int32.new(11,:little)
-		int_le.to_s.should == "\x0b\x00\x00\x00"
-	end
-
-	it "should be able to switch endianness" do
-		@int.endian.should == :big
-		@int.to_s.should == "\x00\x00\x00\x0b"
-		@int.endian = :little
-		@int.endian.should == :little
-		@int.read(11)
-		@int.to_s.should == "\x0b\x00\x00\x00"
-	end
+  before :each do
+    @int = StructFu::Int32.new(11)
+  end
+
+  it "should have an initial state" do
+    new_int = StructFu::Int32.new
+    new_int.value.should be_nil
+    new_int.endian.should == :big
+    new_int.width.should == 4
+    new_int.default.should == 0
+  end
+
+  it "should print a four character packed string" do
+    @int.to_s.should == "\x00\x00\x00\x0b"
+  end
+
+  it "should have a value of 11" do
+    @int.value.should == 11
+    @int.to_i.should == 11
+    @int.to_f.to_s.should == "11.0"
+  end
+
+  it "should reset with a new integer" do
+    @int.read(2)
+    @int.to_i.should == 2
+    @int.to_s.should == "\x00\x00\x00\x02"
+    @int.read(254)
+    @int.to_i.should == 254
+    @int.to_s.should == "\x00\x00\x00\xfe".force_encoding("binary")
+  end
+
+  it "should be able to set endianness" do
+    int_be = StructFu::Int32.new(11,:big)
+    int_be.to_s.should == "\x00\x00\x00\x0b"
+    int_le = StructFu::Int32.new(11,:little)
+    int_le.to_s.should == "\x0b\x00\x00\x00"
+  end
+
+  it "should be able to switch endianness" do
+    @int.endian.should == :big
+    @int.to_s.should == "\x00\x00\x00\x0b"
+    @int.endian = :little
+    @int.endian.should == :little
+    @int.read(11)
+    @int.to_s.should == "\x0b\x00\x00\x00"
+  end
 
 end
 
 describe StructFu::Int32le, "4 byte little-endian value" do
 
-	before :each do
-		@int = StructFu::Int32le.new(11)
-	end
+  before :each do
+    @int = StructFu::Int32le.new(11)
+  end
 
-	it "should behave pretty much like any other 32 bit int" do
-		@int.to_s.should == "\x0b\x00\x00\x00"
-	end
+  it "should behave pretty much like any other 32 bit int" do
+    @int.to_s.should == "\x0b\x00\x00\x00"
+  end
 
-	it "should raise when you try to change endianness" do
-		expect { @int.endian = :big }.to raise_error
-		expect { @int.endian = :little }.to raise_error
-	end
+  it "should raise when you try to change endianness" do
+    expect { @int.endian = :big }.to raise_error(NoMethodError, /undefined method `endian='/)
+    expect { @int.endian = :little }.to raise_error(NoMethodError, /undefined method `endian='/)
+  end
 
 end
 
 describe StructFu::Int32be, "4 byte big-endian value" do
 
-	before :each do
-		@int = StructFu::Int32be.new(11)
-	end
+  before :each do
+    @int = StructFu::Int32be.new(11)
+  end
 
-	it "should behave pretty much like any other 32 bit int" do
-		@int.to_s.should == "\x00\x00\x00\x0b"
-	end
+  it "should behave pretty much like any other 32 bit int" do
+    @int.to_s.should == "\x00\x00\x00\x0b"
+  end
 
-	it "should raise when you try to change endianness" do
-		expect { @int.endian = :big }.to raise_error
-		expect { @int.endian = :little }.to raise_error
-	end
+  it "should raise when you try to change endianness" do
+    expect { @int.endian = :big }.to raise_error(NoMethodError, /undefined method `endian='/)
+    expect { @int.endian = :little }.to raise_error(NoMethodError, /undefined method `endian='/)
+  end
 
 end
 
 describe StructFu::String, "a sligtly more special String" do
 
-	before :each do
-		@str = StructFu::String.new("Oi, a string")
-	end
+  before :each do
+    @str = StructFu::String.new("Oi, a string")
+  end
 
-	it "should behave pretty much like a string" do
-		@str.should be_kind_of(String)
-	end
+  it "should behave pretty much like a string" do
+    @str.should be_kind_of(String)
+  end
 
-	it "should have a read method" do
-		@str.should respond_to(:read)
-	end
+  it "should have a read method" do
+    @str.should respond_to(:read)
+  end
 
-	it "should read data like other StructFu things" do
-		@str.read("hello")
-		@str.should == "hello"
-	end
+  it "should read data like other StructFu things" do
+    @str.read("hello")
+    @str.should == "hello"
+  end
 
 end
 
 describe StructFu::IntString do
 
-	it "should be" do
-		StructFu::IntString.should be
-	end
-
-	it "should have a length and value" do
-		istr = StructFu::IntString.new("Avast!")
-		istr.to_s.should == "\x06Avast!"
-	end
-
-	it "should have a 16-bit length and a value" do
-		istr = StructFu::IntString.new("Avast!",StructFu::Int16)
-		istr.to_s.should == "\x00\x06Avast!"
-	end
-
-	it "should have a 32-bit length and a value" do
-		istr = StructFu::IntString.new("Avast!",StructFu::Int32)
-		istr.to_s.should == "\x00\x00\x00\x06Avast!"
-	end
-
-	before :each do
-		@istr = StructFu::IntString.new("Avast!",StructFu::Int32)
-	end
-
-	it "should report the correct length with a new string" do
-		@istr.to_s.should == "\x00\x00\x00\x06Avast!"
-		@istr.string = "Ahoy!"
-		@istr.to_s.should == "\x00\x00\x00\x05Ahoy!"
-	end
-
-	it "should report the correct length with a new string" do
-		@istr.string = "Ahoy!"
-		@istr.to_s.should == "\x00\x00\x00\x05Ahoy!"
-	end
-
-	it "should keep the old length with a new string" do
-		@istr[:string] = "Ahoy!"
-		@istr.to_s.should == "\x00\x00\x00\x06Ahoy!"
-	end
-
-	it "should allow for adjusting the length manually" do
-		@istr.len = 16
-		@istr.to_s.should == "\x00\x00\x00\x10Avast!"
-	end
-
-	it "should read in an expected string" do
-		data = "\x00\x00\x00\x09Yo ho ho!"
-		@istr.read(data)
-		@istr.to_s.should == data
-	end
-
-	it "should raise when a string is too short" do
-		data = "\x01A"
-		expect { @istr.read(data) }.to raise_error
-	end
+  it "should be" do
+    StructFu::IntString.should be
+  end
+
+  it "should have a length and value" do
+    istr = StructFu::IntString.new("Avast!")
+    istr.to_s.should == "\x06Avast!"
+  end
+
+  it "should have a 16-bit length and a value" do
+    istr = StructFu::IntString.new("Avast!",StructFu::Int16)
+    istr.to_s.should == "\x00\x06Avast!"
+  end
+
+  it "should have a 32-bit length and a value" do
+    istr = StructFu::IntString.new("Avast!",StructFu::Int32)
+    istr.to_s.should == "\x00\x00\x00\x06Avast!"
+  end
+
+  before :each do
+    @istr = StructFu::IntString.new("Avast!",StructFu::Int32)
+  end
+
+  it "should report the correct length with a new string" do
+    @istr.to_s.should == "\x00\x00\x00\x06Avast!"
+    @istr.string = "Ahoy!"
+    @istr.to_s.should == "\x00\x00\x00\x05Ahoy!"
+  end
+
+  it "should report the correct length with a new string" do
+    @istr.string = "Ahoy!"
+    @istr.to_s.should == "\x00\x00\x00\x05Ahoy!"
+  end
+
+  it "should keep the old length with a new string" do
+    @istr[:string] = "Ahoy!"
+    @istr.to_s.should == "\x00\x00\x00\x06Ahoy!"
+  end
+
+  it "should allow for adjusting the length manually" do
+    @istr.len = 16
+    @istr.to_s.should == "\x00\x00\x00\x10Avast!"
+  end
+
+  it "should read in an expected string" do
+    data = "\x00\x00\x00\x09Yo ho ho!"
+    @istr.read(data)
+    @istr.to_s.should == data
+  end
+
+  it "should raise when a string is too short" do
+    data = "\x01A"
+    expect { @istr.read(data) }.to raise_error(StandardError, "String is too short for type StructFu::Int32")
+  end
 
 end