SWAMPy

✎ CARVE FLESH

EDITING: struct_test.rb

#!/usr/bin/env ruby

require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))

describe BinData::Struct, "when initializing" do
  it "fails on non registered types" do
    params = {fields: [[:non_registered_type, :a]]}
    _ {
      BinData::Struct.new(params)
    }.must_raise BinData::UnRegisteredTypeError
  end

it "fails on duplicate names" do
    params = {fields: [[:int8, :a], [:int8, :b], [:int8, :a]]}
    _ {
      BinData::Struct.new(params)
    }.must_raise NameError
  end

it "fails on reserved names" do
    # note that #invert is from Hash.instance_methods
    params = {fields: [[:int8, :a], [:int8, :invert]]}
    _ {
      BinData::Struct.new(params)
    }.must_raise NameError
  end

it "fails when field name shadows an existing method" do
    params = {fields: [[:int8, :object_id]]}
    _ {
      BinData::Struct.new(params)
    }.must_raise NameError
  end

it "fails on unknown endian" do
    params = {endian: 'bad value', fields: []}
    _ {
      BinData::Struct.new(params)
    }.must_raise ArgumentError
  end
end

describe BinData::Struct, "with anonymous fields" do
  let(:obj) {
    params = { fields: [
                            [:int8, :a, {initial_value: 5}],
                            [:int8, nil],
                            [:int8, '', {value: :a}]
                          ] }
    BinData::Struct.new(params)
  }

it "only shows non anonymous fields" do
    _(obj.field_names).must_equal [:a]
  end

it "does not include anonymous fields in snapshot" do
    obj.a = 5
    _(obj.snapshot).must_equal({a: 5})
  end

it "writes anonymous fields" do
    obj.read("\001\002\003")
    obj.a.clear
    _(obj.to_binary_s).must_equal_binary "\005\002\005"
  end
end

describe BinData::Struct, "with hidden fields" do
  let(:obj) {
    params = { hide: [:b, :c],
               fields: [
                   [:int8, :a],
                   [:int8, 'b', {initial_value: 5}],
                   [:int8, :c],
                   [:int8, :d, {value: :b}]] }
    BinData::Struct.new(params)
  }

it "only shows fields that aren't hidden" do
    _(obj.field_names).must_equal [:a, :d]
  end

it "shows all fields when requested" do
    _(obj.field_names(true)).must_equal [:a, :b, :c, :d]
  end

it "accesses hidden fields directly" do
    _(obj.b).must_equal 5
    obj.c = 15
    _(obj.c).must_equal 15

_(obj).must_respond_to :b=
  end

it "does not include hidden fields in snapshot" do
    obj.b = 7
    _(obj.snapshot).must_equal({a: 0, d: 7})
  end

it "detects hidden fields with has_key?" do
    assert obj.has_key?("b")
  end
end

describe BinData::Struct, "with multiple fields" do
  let(:params) { { fields: [ [:int8, :a], [:int8, :b] ] } }
  let(:obj) { BinData::Struct.new({a: 1, b: 2}, params) }

specify { _(obj.field_names).must_equal [:a, :b] }
  specify { _(obj.to_binary_s).must_equal_binary "\x01\x02" }

it "returns num_bytes" do
    _(obj.a.num_bytes).must_equal 1
    _(obj.b.num_bytes).must_equal 1
    _(obj.num_bytes).must_equal   2
  end

it "identifies accepted parameters" do
    _(BinData::Struct.accepted_parameters.all).must_include :fields
    _(BinData::Struct.accepted_parameters.all).must_include :hide
    _(BinData::Struct.accepted_parameters.all).must_include :endian
  end

it "clears" do
    obj.a = 6
    obj.clear
    assert obj.clear?
  end

it "clears individual elements" do
    obj.a = 6
    obj.b = 7
    obj.a.clear
    assert obj.a.clear?
    refute obj.b.clear?
  end

it "reads elements dynamically" do
    _(obj[:a]).must_equal 1
  end

it "handles not existing elements" do
    _(obj[:does_not_exist]).must_be_nil
  end

it "writes elements dynamically" do
    obj[:a] = 2
    _(obj.a).must_equal 2
  end

it "implements has_key?" do
    assert obj.has_key?("a")
  end

it "reads ordered" do
    obj.read("\x03\x04")

_(obj.a).must_equal 3
    _(obj.b).must_equal 4
  end

it "returns a snapshot" do
    snap = obj.snapshot
    assert snap.respond_to?(:a)
    _(snap.a).must_equal 1
    _(snap.b).must_equal 2
    _(snap).must_equal({ a: 1, b: 2 })
  end

it "assigns from partial hash" do
    obj.assign(a: 3)
    _(obj.a).must_equal 3
    _(obj.b).must_equal 0
  end

it "assigns from hash" do
    obj.assign(a: 3, b: 4)
    _(obj.a).must_equal 3
    _(obj.b).must_equal 4
  end

it "assigns from nil" do
    obj.assign(nil)
    assert obj.clear?
  end

it "assigns from Struct" do
    src = BinData::Struct.new(params)
    src.a = 3
    src.b = 4

obj.assign(src)
    _(obj.a).must_equal 3
    _(obj.b).must_equal 4
  end

it "assigns from snapshot" do
    src = BinData::Struct.new(params)
    src.a = 3
    src.b = 4

obj.assign(src.snapshot)
    _(obj.a).must_equal 3
    _(obj.b).must_equal 4
  end

it "fails on unknown method call" do
    _ { obj.does_not_exist }.must_raise NoMethodError
  end

describe "#snapshot" do
    it "has ordered #keys" do
      _(obj.snapshot.keys).must_equal [:a, :b]
    end

it "has ordered #each" do
      keys = []
      obj.snapshot.each { |el| keys << el[0] }
      _(keys).must_equal [:a, :b]
    end

it "has ordered #each_pair" do
      keys = []
      obj.snapshot.each_pair { |k, v| keys << k }
      _(keys).must_equal [:a, :b]
    end
  end
end

describe BinData::Struct, "with nested structs" do
  let(:obj) {
    inner1 = [ [:int8, :w, {initial_value: 3}],
               [:int8, :x, {value: :the_val}] ]

inner2 = [ [:int8, :y, {value: -> { parent.b.w }}],
               [:int8, :z] ]

params = { fields: [
                 [:int8, :a, {initial_value: 6}],
                 [:struct, :b, {fields: inner1, the_val: :a}],
                 [:struct, :c, {fields: inner2}]] }
    BinData::Struct.new(params)
  }

specify { _(obj.field_names).must_equal [:a, :b, :c] }

it "returns num_bytes" do
    _(obj.b.num_bytes).must_equal 2
    _(obj.c.num_bytes).must_equal 2
    _(obj.num_bytes).must_equal 5
  end

it "accesses nested fields" do
    _(obj.a).must_equal   6
    _(obj.b.w).must_equal 3
    _(obj.b.x).must_equal 6
    _(obj.c.y).must_equal 3
    _(obj.c.z).must_equal 0
  end

it "returns correct abs_offset" do
    _(obj.b.abs_offset).must_equal 1
    _(obj.b.w.abs_offset).must_equal 1
    _(obj.c.abs_offset).must_equal 3
    _(obj.c.z.abs_offset).must_equal 4
  end
end

describe BinData::Struct, "with an endian defined" do
  let(:obj) {
    BinData::Struct.new(endian: :little,
                        fields: [
                                  [:uint16, :a],
                                  [:float, :b],
                                  [:array, :c,
                                    {type: :int8, initial_length: 2}],
                                  [:choice, :d,
                                    {choices: [[:uint16], [:uint32]],
                                     selection: 1}],
                                  [:struct, :e,
                                    {fields: [[:uint16, :f],
                                                 [:uint32be, :g]]}],
                                  [:struct, :h,
                                    {fields: [
                                      [:struct, :i,
                                        {fields: [[:uint16, :j]]}]]}]
                                ])
  }

it "uses correct endian" do
    obj.a = 1
    obj.b = 2.0
    obj.c[0] = 3
    obj.c[1] = 4
    obj.d = 5
    obj.e.f = 6
    obj.e.g = 7
    obj.h.i.j = 8

expected = [1, 2.0, 3, 4, 5, 6, 7, 8].pack('veCCVvNv')

_(obj.to_binary_s).must_equal_binary expected
  end
end

describe BinData::Struct, "with bit fields" do
  let(:obj) {
    params = { fields: [ [:bit1le, :a], [:bit2le, :b], [:uint8, :c], [:bit1le, :d] ] }
    BinData::Struct.new({a: 1, b: 2, c: 3, d: 1}, params)
  }

specify { _(obj.num_bytes).must_equal 3 }
  specify { _(obj.to_binary_s).must_equal_binary [0b0000_0101, 3, 1].pack("C*") }

it "reads" do
    str = [0b0000_0110, 5, 0].pack("C*")
    obj.read(str)
    _(obj.a).must_equal 0
    _(obj.b).must_equal 3
    _(obj.c).must_equal 5
    _(obj.d).must_equal 0
  end

it "has correct offsets" do
    _(obj.a.rel_offset).must_equal 0
    _(obj.b.rel_offset).must_equal 0
    _(obj.c.rel_offset).must_equal 1
    _(obj.d.rel_offset).must_equal 2
  end
end

describe BinData::Struct, "with nested endian" do
  it "uses correct endian" do
    nested_params = { endian: :little,
                      fields: [[:int16, :b], [:int16, :c]] }
    params = { endian: :big, 
               fields: [[:int16, :a],
                        [:struct, :s, nested_params],
                        [:int16, :d]] }
    obj = BinData::Struct.new(params)
    obj.read("\x00\x01\x02\x00\x03\x00\x00\x04")

_(obj.a).must_equal   1
    _(obj.s.b).must_equal 2
    _(obj.s.c).must_equal 3
    _(obj.d).must_equal   4
  end
end

describe BinData::Struct, "with a search_prefix" do
  class AShort < BinData::Uint8; end
  class BShort < BinData::Uint8; end

it "searches symbol prefixes" do
    obj = BinData::Struct.new(search_prefix: :a,
                              fields: [ [:short, :f] ])
    _(obj.f.class.name).must_equal "AShort"
  end

it "searches string prefixes" do
    obj = BinData::Struct.new(search_prefix: "a",
                              fields: [ [:short, :f] ])
    _(obj.f.class.name).must_equal "AShort"
  end

it "searches string prefixes with optional underscore" do
    obj = BinData::Struct.new(search_prefix: "a_",
                              fields: [ [:short, :f] ])
    _(obj.f.class.name).must_equal "AShort"
  end

it "searches multiple prefixes" do
    obj = BinData::Struct.new(search_prefix: [:x, :a],
                              fields: [ [:short, :f] ])
    _(obj.f.class.name).must_equal "AShort"
  end

it "uses parent search_prefix" do
    nested_params = { fields: [[:short, :f]] }
    obj = BinData::Struct.new(search_prefix: :a,
                              fields: [[:struct, :s, nested_params]])
    _(obj.s.f.class.name).must_equal "AShort"
  end

it "searches parent search_prefix" do
    nested_params = { search_prefix: :x, fields: [[:short, :f]] }
    obj = BinData::Struct.new(search_prefix: :a,
                              fields: [[:struct, :s, nested_params]])
    _(obj.s.f.class.name).must_equal "AShort"
  end

it "prioritises nested search_prefix" do
    nested_params = { search_prefix: :a, fields: [[:short, :f]] }
    obj = BinData::Struct.new(search_prefix: :b,
                              fields: [[:struct, :s, nested_params]])
    _(obj.s.f.class.name).must_equal "AShort"
  end
end

describe BinData::Struct, "with byte_align" do
  let(:obj) {
    params = { fields: [[:int8, :a],
                        [:int8, :b, byte_align: 5],
                        [:bit2, :c],
                        [:int8, :d, byte_align: 3]] }
    BinData::Struct.new(params)
  }

it "has #num_bytes" do
    _(obj.num_bytes).must_equal 10
  end

it "reads" do
    obj.read("\x01\x00\x00\x00\x00\x02\xc0\x00\x00\x04")
    _(obj.snapshot).must_equal({ a: 1, b: 2, c: 3, d: 4 })
  end

it "writes" do
    obj.assign(a: 1, b: 2, c: 3, d: 4)
    _(obj.to_binary_s).must_equal_binary "\x01\x00\x00\x00\x00\x02\xc0\x00\x00\x04"
  end

it "has correct offsets" do
    _(obj.a.rel_offset).must_equal 0
    _(obj.b.rel_offset).must_equal 5
    _(obj.c.rel_offset).must_equal 6
    _(obj.d.rel_offset).must_equal 9
  end
end

describe BinData::Struct, "with dynamically named types" do
  it "instantiates" do
    _ = BinData::Struct.new(name: :my_struct, fields: [[:int8, :a, {initial_value: 3}]])

obj = BinData::Struct.new(fields: [[:my_struct, :v]])

_(obj.v.a).must_equal 3
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 alignment_test.rb	RB	1.4 KB	2023-09-24 03:47	EDIT
📄 array_test.rb	RB	9.8 KB	2023-09-24 03:47	EDIT
📄 base_primitive_test.rb	RB	6.8 KB	2023-09-24 03:47	EDIT
📄 base_test.rb	RB	4.5 KB	2023-09-24 03:47	EDIT
📄 bits_test.rb	RB	4.4 KB	2023-09-24 03:47	EDIT
📄 buffer_test.rb	RB	3.6 KB	2023-09-24 03:47	EDIT
📄 choice_test.rb	RB	5.5 KB	2023-09-24 03:47	EDIT
📄 count_bytes_remaining_test.rb	RB	924 B	2023-09-24 03:47	EDIT
📄 delayed_io_test.rb	RB	6.7 KB	2023-09-24 03:47	EDIT
📄 float_test.rb	RB	1.3 KB	2023-09-24 03:47	EDIT
📄 int_test.rb	RB	4.3 KB	2023-09-24 03:47	EDIT
📄 io_test.rb	RB	13.8 KB	2023-09-24 03:47	EDIT
📄 lazy_test.rb	RB	5.6 KB	2023-09-24 03:47	EDIT
📄 offset_test.rb	RB	2.4 KB	2023-09-24 03:47	EDIT
📄 params_test.rb	RB	3.6 KB	2023-09-24 03:47	EDIT
📄 primitive_test.rb	RB	5 KB	2023-09-24 03:47	EDIT
📄 record_test.rb	RB	15.8 KB	2023-09-24 03:47	EDIT
📄 registry_test.rb	RB	5 KB	2023-09-24 03:47	EDIT
📄 rest_test.rb	RB	647 B	2023-09-24 03:47	EDIT
📄 skip_test.rb	RB	3.6 KB	2023-09-24 03:47	EDIT
📄 string_test.rb	RB	7.8 KB	2023-09-24 03:47	EDIT
📄 stringz_test.rb	RB	2.8 KB	2023-09-24 03:47	EDIT
📄 struct_test.rb	RB	11.4 KB	2023-09-24 03:47	EDIT
📄 system_test.rb	RB	9.5 KB	2023-09-24 03:47	EDIT
📄 test_helper.rb	RB	1.4 KB	2023-09-24 03:47	EDIT
📄 uint8_array_test.rb	RB	1.2 KB	2023-09-24 03:47	EDIT
📄 virtual_test.rb	RB	1 KB	2023-09-24 03:47	EDIT
📄 warnings_test.rb	RB	689 B	2023-09-24 03:47	EDIT