File: structfu_spec.rb

package info (click to toggle)
ruby-packetfu 2.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,520 kB
  • sloc: ruby: 8,344; makefile: 2
file content (338 lines) | stat: -rw-r--r-- 8,736 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
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
    expect(@sc).to respond_to(:sz)
    expect(@sc).to respond_to(:len)
    expect(@sc).to respond_to(:typecast)
    expect(@sc).to respond_to(:body=)
  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
    expect(new_int.value).to be_nil
    expect(new_int.endian).to be_nil
    expect(new_int.width).to be_nil
    expect(new_int.default).to eql(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
    expect(@int.value).to eql(8)
    expect(@int.to_i).to eql(8)
    expect(@int.to_f.to_s).to eql("8.0")
  end

  it "should read an integer" do
    @int.read(7)
    expect(@int.to_i).to eql(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
    expect(new_int.value).to be_nil
    expect(new_int.endian).to be_nil
    expect(new_int.width).to eql(1)
    expect(new_int.default).to eql(0)
  end

  it "should print a one character packed string" do
    expect(@int.to_s).to eql("\x0b")
  end

  it "should have a value of 11" do
    expect(@int.value).to eql(11)
    expect(@int.to_i).to eql(11)
    expect(@int.to_f.to_s).to eql("11.0")
  end

  it "should reset with a new integer" do
    @int.read(2)
    expect(@int.to_i).to eql(2)
    expect(@int.to_s).to eql("\x02")

    @int.read(254)
    expect(@int.to_i).to eql(254)
    expect(@int.to_s).to eql("\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
    expect(new_int.value).to be_nil
    expect(new_int.endian).to eql(:big)
    expect(new_int.width).to eql(2)
    expect(new_int.default).to eql(0)
  end

  it "should print a two character packed string" do
    expect(@int.to_s).to eql("\x00\x0b".force_encoding("binary"))
  end

  it "should have a value of 11" do
    expect(@int.value).to eql(11)
    expect(@int.to_i).to eql(11)
    expect(@int.to_f.to_s).to eql("11.0")
  end

  it "should reset with a new integer" do
    @int.read(2)
    expect(@int.to_i).to eql(2)
    expect(@int.to_s).to eql("\x00\x02")

    @int.read(254)
    expect(@int.to_i).to eql(254)
    expect(@int.to_s).to eql("\x00\xfe".force_encoding("binary"))
  end

  it "should be able to set endianness" do
    int_be = StructFu::Int16.new(11,:big)
    expect(int_be.to_s).to eql("\x00\x0b")

    int_le = StructFu::Int16.new(11,:little)
    expect(int_le.to_s).to eql("\x0b\x00")
  end

  it "should be able to switch endianness" do
    @int.endian.should == :big
    expect(@int.to_s).to eql("\x00\x0b")

    @int.endian = :little
    expect(@int.endian).to eql(:little)

    @int.read(11)
    expect(@int.to_s).to eql("\x0b\x00")
  end
end

describe StructFu::Int16le, "2 byte little-endian value" do

  before :each do
    @int = StructFu::Int16le.new(11)
  end

  it "should behave pretty much like any other 16 bit int" do
    expect(@int.to_s).to eql("\x0b\x00")
  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

  it "should behave pretty much like any other 16 bit int" do
    expect(@int.to_s).to eql("\x00\x0b")
  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
    expect(new_int.value).to be_nil
    expect(new_int.endian).to eql(:big)
    expect(new_int.width).to eql(4)
    expect(new_int.default).to eql(0)
  end

  it "should print a four character packed string" do
    expect(@int.to_s).to eql("\x00\x00\x00\x0b")
  end

  it "should have a value of 11" do
    expect(@int.value).to eql(11)
    expect(@int.to_i).to eql(11)
    expect(@int.to_f.to_s).to eql("11.0")
  end

  it "should reset with a new integer" do
    @int.read(2)
    expect(@int.to_i).to eql(2)
    expect(@int.to_s).to eql("\x00\x00\x00\x02")

    @int.read(254)
    expect(@int.to_i).to eql(254)
    expect(@int.to_s).to eql("\x00\x00\x00\xfe".force_encoding("binary"))
  end

  it "should be able to set endianness" do
    int_be = StructFu::Int32.new(11,:big)
    expect(int_be.to_s).to eql("\x00\x00\x00\x0b")
    
    int_le = StructFu::Int32.new(11,:little)
    expect(int_le.to_s).to eql("\x0b\x00\x00\x00")
  end

  it "should be able to switch endianness" do
    @int.endian.should == :big
    expect(@int.to_s).to eql("\x00\x00\x00\x0b")

    @int.endian = :little
    expect(@int.endian).to eql(:little)
    
    @int.read(11)
    expect(@int.to_s).to eql("\x0b\x00\x00\x00")
  end

end

describe StructFu::Int32le, "4 byte little-endian value" do

  before :each do
    @int = StructFu::Int32le.new(11)
  end

  it "should behave pretty much like any other 32 bit int" do
    expect(@int.to_s).to eql("\x0b\x00\x00\x00")
  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

  it "should behave pretty much like any other 32 bit int" do
    expect(@int.to_s).to eql("\x00\x00\x00\x0b")
  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

  it "should behave pretty much like a string" do
    expect(@str).to be_kind_of(String)
  end

  it "should have a read method" do
    expect(@str).to respond_to(:read)
  end

  it "should read data like other StructFu things" do
    @str.read("hello")
    expect(@str).to eql("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!")
    expect(istr.to_s).to eql("\x06Avast!")
  end

  it "should have a 16-bit length and a value" do
    istr = StructFu::IntString.new("Avast!",StructFu::Int16)
    expect(istr.to_s).to eql("\x00\x06Avast!")
  end

  it "should have a 32-bit length and a value" do
    istr = StructFu::IntString.new("Avast!",StructFu::Int32)
    expect(istr.to_s).to eql("\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
    expect(@istr.to_s).to eql("\x00\x00\x00\x06Avast!")

    @istr.string = "Ahoy!"
    expect(@istr.to_s).to eql("\x00\x00\x00\x05Ahoy!")
  end

  it "should report the correct length with a new string" do
    @istr.string = "Ahoy!"
    expect(@istr.to_s).to eql("\x00\x00\x00\x05Ahoy!")
  end

  it "should keep the old length with a new string" do
    @istr[:string] = "Ahoy!"
    expect(@istr.to_s).to eql("\x00\x00\x00\x06Ahoy!")
  end

  it "should allow for adjusting the length manually" do
    @istr.len = 16
    expect(@istr.to_s).to eql("\x00\x00\x00\x10Avast!")
  end

  it "should read in an expected string" do
    data = "\x00\x00\x00\x09Yo ho ho!"
    @istr.read(data)
    expect(@istr.to_s).to eql(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