Source

Carica Io / tests / ByteArrayTest.php

Full commit
  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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
<?php

namespace Carica\Io {

  include_once(__DIR__.'/Bootstrap.php');

  class ByteArrayTest extends \PHPUnit_Framework_TestCase {

    /**
     * @covers Carica\Io\ByteArray::__construct
     */
    public function testConstructor() {
      $bytes = new ByteArray(3);
      $this->assertAttributeSame(array(0,0,0), '_bytes', $bytes);
      $this->assertAttributeEquals(3, '_length', $bytes);
    }

    /**
     * @covers Carica\Io\ByteArray::__construct
     */
    public function testConstructorWithInvalidLengthExpectingException() {
      $this->setExpectedException(
        'OutOfRangeException', 'Zero or negative length is not possible'
      );
      new ByteArray(-3);
    }

    /**
     * @covers Carica\Io\ByteArray::setLength
     */
    public function testSetLengthIncreaseFrom3To6() {
      $bytes = new ByteArray(3);
      $bytes->setLength(6);
      $this->assertAttributeSame(array(0,0,0,0,0,0), '_bytes', $bytes);
      $this->assertAttributeEquals(6, '_length', $bytes);
    }

    /**
     * @covers Carica\Io\ByteArray::setLength
     */
    public function testSetLengthDecreaseFrom6To3() {
      $bytes = new ByteArray(6);
      $bytes->setLength(3);
      $this->assertAttributeSame(array(0,0,0), '_bytes', $bytes);
      $this->assertAttributeEquals(3, '_length', $bytes);
    }

    /**
     * @covers Carica\Io\ByteArray::setLength
     */
    public function testSetLengthWithInvalidLengthExpectingException() {
      $bytes = new ByteArray(6);
      $this->setExpectedException(
        'OutOfRangeException', 'Zero or negative length is not possible'
      );
      $bytes->setLength(-23);
    }

    /**
     * @covers Carica\Io\ByteArray::getLength
     */
    public function testGetLength() {
      $bytes = new ByteArray(6);
      $this->assertEquals(6, $bytes->getLength());
    }

    /**
     * @covers Carica\Io\ByteArray::__toString
     * @covers Carica\Io\ByteArray::fromString
     * @dataProvider provideBinarySamples
     */
    public function testStringInOut($binary) {
      $bytes = new ByteArray(strlen($binary));
      $bytes->fromString($binary);
      $this->assertSame($binary, (string)$bytes);
    }

    /**
     * @covers Carica\Io\ByteArray::fromString
     */
    public function testFromStringWithInvalidLengthExpectingException() {
      $bytes = new ByteArray(42);
      $this->setExpectedException('OutOfBoundsException');
      $bytes->fromString(pack('C*', 255, 255, 255));
    }

    /**
     * @covers Carica\Io\ByteArray::__toString
     * @covers Carica\Io\ByteArray::fromString
     */
    public function testFromStringWithAutomaticLengthIncrease() {
      $bytes = new ByteArray(1);
      $bytes->fromString($binary = pack('C*', 255, 128, 255), TRUE);
      $this->assertSame('11111111 10000000 11111111', $bytes->asBitString());
    }

    /**
     * @covers Carica\Io\ByteArray::__toString
     * @covers Carica\Io\ByteArray::fromString
     */
    public function testFromStringWithAutomaticLengthDecrease() {
      $bytes = new ByteArray(10);
      $bytes->fromString($binary = pack('C*', 255, 128, 255), TRUE);
      $this->assertSame('11111111 10000000 11111111', $bytes->asBitString());
    }

    /**
     * @covers Carica\Io\ByteArray::fromHexString
     * @covers Carica\Io\ByteArray::asHex
     * @dataProvider provideHexSamples
     */
    public function testHexStringInOut($string, $binaryString, $length) {
      $bytes = new ByteArray($length);
      $bytes->fromHexString($string);
      $this->assertSame($string, $bytes->asHex());
    }

    /**
     * @covers Carica\Io\ByteArray::fromHexString
     */
    public function testFromHexStringWithInvalidLengthExpectingException() {
      $bytes = new ByteArray(42);
      $this->setExpectedException('OutOfBoundsException');
      $bytes->fromHexString('FFF0FF', FALSE);
    }

    /**
     * @covers Carica\Io\ByteArray::asHex
     * @covers Carica\Io\ByteArray::fromHexString
     */
    public function testFromHexStringWithAutomaticLengthIncrease() {
      $bytes = new ByteArray(1);
      $bytes->fromHexString('FF F0 FF', TRUE);
      $this->assertSame('11111111 11110000 11111111', $bytes->asBitString());
    }

    /**
     * @covers Carica\Io\ByteArray::asHex
     * @covers Carica\Io\ByteArray::fromHexString
     */
    public function testFromHexStringWithAutomaticLengthDecrease() {
      $bytes = new ByteArray(10);
      $bytes->fromHexString('FF F0 FF', TRUE);
      $this->assertSame('11111111 11110000 11111111', $bytes->asBitString());
    }

    /**
     * @covers Carica\Io\ByteArray::fromArray
     */
    public function testFromArray() {
      $bytes = new ByteArray(2);
      $bytes->fromArray([0x00, 0xFF]);
      $this->assertEquals('00ff', $bytes->asHex());
    }

    /**
     * @covers Carica\Io\ByteArray::fromArray
     */
    public function testFromArrayWithInvalidLengthExpectingException() {
      $bytes = new ByteArray(42);
      $this->setExpectedException('OutOfBoundsException');
      $bytes->fromArray([0xFF, 0xF0, 0xFF], FALSE);
    }

    /**
     * @covers Carica\Io\ByteArray::fromArray
     */
    public function testFromArrayWithAutomaticLengthIncrease() {
      $bytes = new ByteArray(1);
      $bytes->fromArray([0xFF, 0xF0, 0xFF], TRUE);
      $this->assertSame('11111111 11110000 11111111', $bytes->asBitString());
    }

    /**
     * @covers Carica\Io\ByteArray::fromArray
     */
    public function testFromArrayWithAutomaticLengthDecrease() {
      $bytes = new ByteArray(10);
      $bytes->fromArray([0xFF, 0xF0, 0xFF], TRUE);
      $this->assertSame('11111111 11110000 11111111', $bytes->asBitString());
    }

    /**
     * @covers Carica\Io\ByteArray::asHex
     * @dataProvider provideHexSamples
     */
    public function testAsHex($expected, $binaryString, $length) {
      $bytes = new ByteArray($length);
      $bytes->fromString($binaryString);
      $this->assertSame($expected, $bytes->asHex());
    }

    /**
     * @covers Carica\Io\ByteArray::asBitString
     * @dataProvider provideBitStringSamples
     */
    public function testAsBitString($expected, $binaryString, $length) {
      $bytes = new ByteArray($length);
      $bytes->fromString($binaryString);
      $this->assertSame($expected, $bytes->asBitString());
    }

    /**
     * @covers Carica\Io\ByteArray::asArray
     */
    public function testAsArray() {
      $bytes = new ByteArray();
      $bytes->fromString('Foo', TRUE);
      $this->assertEquals([70, 111, 111], $bytes->asArray());
    }

    /**
     * @covers Carica\Io\ByteArray::offsetExists
     * @covers Carica\Io\ByteArray::validateOffset
     * @covers Carica\Io\ByteArray::validateBitOffset
     */
    public function testBitExistsExpectingTrue() {
      $bytes = new ByteArray(3);
      $this->assertTrue(isset($bytes[[2, 4]]));
    }

    /**
     * @covers Carica\Io\ByteArray::offsetExists
     * @covers Carica\Io\ByteArray::validateOffset
     * @covers Carica\Io\ByteArray::validateBitOffset
     */
    public function testBitExistsExpectingFalse() {
      $bytes = new ByteArray(3);
      $this->assertFalse(isset($bytes[[2, 42]]));
    }

    /**
     * @covers Carica\Io\ByteArray::offsetExists
     * @covers Carica\Io\ByteArray::validateOffset
     * @covers Carica\Io\ByteArray::validateBitOffset
     */
    public function testBitExistsWithInvalidOffsetExpectingException() {
      $bytes = new ByteArray(3);
      $this->setExpectedException('OutOfBoundsException');
      $dummy = $bytes[[23, 23, 23]];
    }

    /**
     * @covers Carica\Io\ByteArray::offsetExists
     * @covers Carica\Io\ByteArray::validateOffset
     */
    public function testByteExistsExpectingTrue() {
      $bytes = new ByteArray(3);
      $this->assertTrue(isset($bytes[2]));
    }

    /**
     * @covers Carica\Io\ByteArray::offsetExists
     * @covers Carica\Io\ByteArray::validateOffset
     */
    public function testByteExistsExpectingFalse() {
      $bytes = new ByteArray(3);
      $this->assertFalse(isset($bytes[23]));
    }

    /**
     * @covers Carica\Io\ByteArray::offsetSet
     */
    public function testSetLowestBit() {
      $bytes = new ByteArray(1);
      $bytes[[0, 0]] = TRUE;
      $this->assertSame('00000001', $bytes->asBitString());
    }

    /**
     * @covers Carica\Io\ByteArray::offsetSet
     */
    public function testDisableLowestBit() {
      $bytes = new ByteArray(1);
      $bytes->fromString(pack('C*', 1));
      $bytes[[0, 0]] = FALSE;
      $this->assertSame('00000000', $bytes->asBitString());
    }

    /**
     * @covers Carica\Io\ByteArray::offsetSet
     */
    public function testSetHighestBit() {
      $bytes = new ByteArray(1);
      $bytes[[0, 7]] = TRUE;
      $this->assertSame('10000000', $bytes->asBitString());
    }

    /**
     * @covers Carica\Io\ByteArray::offsetSet
     */
    public function testDisableHighestBit() {
      $bytes = new ByteArray(1);
      $bytes->fromString(pack('C*', 255));
      $bytes[[0, 7]] = FALSE;
      $this->assertSame('01111111', $bytes->asBitString());
    }

    /**
     * @covers Carica\Io\ByteArray::offsetUnset
     */
    public function testUnsetLowestBit() {
      $bytes = new ByteArray(1);
      $bytes->fromString(pack('C*', 255));
      unset($bytes[[0, 0]]);
      $this->assertSame('11111110', $bytes->asBitString());
    }

    /**
     * @covers Carica\Io\ByteArray::offsetSet
     * @covers Carica\Io\ByteArray::offsetGet
     * @dataProvider provideBitOffsetSamples
     */
    public function testBitGetAfterSet($expected, $byte, $bit, $status) {
      $bytes = new ByteArray(2);
      $bytes->fromString(pack('C*', 0, 255));
      $bytes[[$byte, $bit]] = $status;
      $this->assertSame($status, $bytes[[$byte, $bit]]);
      $this->assertSame($expected, $bytes->asBitString());
    }

    /**
     * @covers Carica\Io\ByteArray::offsetSet
     * @covers Carica\Io\ByteArray::offsetGet
     * @covers Carica\Io\ByteArray::validateValue
     * @dataProvider provideByteOffsetSamples
     */
    public function testByteGetAfterSet($expected, $byte, $value) {
      $bytes = new ByteArray(2);
      $bytes->fromString(pack('C*', 0, 255));
      $bytes[$byte] = $value;
      $this->assertSame($value, $bytes[$byte]);
      $this->assertSame($expected, $bytes->asBitString());
    }

    /**
     * @covers Carica\Io\ByteArray::validateOffset
     * @covers Carica\Io\ByteArray::validateBitOffset
     * @dataProvider provideInvalidOffsets
     */
    public function testValidateIndexExpectingException($position) {
      $bytes = new ByteArray(2);
      $this->setExpectedException('OutOfBoundsException');
      $bytes[$position] = 1;
    }

    /**
     * @covers Carica\Io\ByteArray::validateValue
     * @dataProvider provideInvalidValues
     */
    public function testValidateValueExpectingException($value) {
      $bytes = new ByteArray(1);
      $this->setExpectedException('OutOfRangeException');
      $bytes[0] = $value;
    }

    /**
     * @covers Carica\Io\ByteArray::getIterator
     */
    public function testGetIteratorOnEmptyByteArrayWithDefinedLength() {
      $bytes = new ByteArray(3);
      $this->assertEquals(
        array(0x00, 0x00, 0x00),
        iterator_to_array($bytes)
      );
    }

    /**
     * @covers Carica\Io\ByteArray::getIterator
     */
    public function testGetIteratorOnLoadedBytes() {
      $bytes = new ByteArray();
      $bytes->fromHexString('FFF00F', TRUE);
      $this->assertEquals(
        array(0xFF, 0x0F0, 0x0F),
        iterator_to_array($bytes)
      );
    }

    /**
     * @covers Carica\Io\ByteArray::count
     */
    public function testCountOnEmptyByteArrayWithDefinedLength() {
      $bytes = new ByteArray(42);
      $this->assertCount(
        42, $bytes
      );
    }

    /**
     * @covers Carica\Io\ByteArray::count
     */
    public function testCountLoadedBytes() {
      $bytes = new ByteArray();
      $bytes->fromHexString('FFF00F', TRUE);
      $this->assertCount(
        3, $bytes
      );
    }

    /**
     * @covers Carica\Io\ByteArray::createFromHex
     */
    public function testCreateFromHexString() {
      $bytes = ByteArray::createFromHex('FFF0F1');
      $this->assertEquals(
        "\xFF\xF0\xF1", (string)$bytes
      );
    }

    /**
     * @covers Carica\Io\ByteArray::createFromArray
     */
    public function testCreateFromArray() {
      $bytes = ByteArray::createFromArray([0x00, 0xF0, 0xFF]);
      $this->assertEquals(
        "\x00\xF0\xFF", (string)$bytes
      );
    }

    /**************************
     * Data Provider
     *************************/

    public static function provideBinarySamples() {
      return array(
        array(pack('C*', 0)),
        array(pack('C*', 1)),
        array(pack('C*', 0, 1, 0)),
        array(pack('C*', 255, 255, 255)),
      );
    }

    public static function provideHexSamples() {
      return array(
        array('00', pack('C*', 0), 1),
        array('0000', pack('C*', 0, 0), 2),
        array('000100', pack('C*', 0, 1, 0), 3),
        array('01', pack('C*', 1), 1),
        array('010203', pack('C*', 1, 2, 3), 3),
        array('ffffff', pack('C*', 255, 255, 255), 3)
      );
    }

    public static function provideBitStringSamples() {
      return array(
        array('00000000', pack('C*', 0), 1),
        array('00000001 00000010 00000011', pack('C*', 1, 2, 3), 3)
      );
    }

    public static function provideBitOffsetSamples() {
      return array(
        array('00000001 11111111', 0, 0, TRUE),
        array('00000000 11111111', 1, 0, TRUE),
        array('00000000 11111111', 0, 0, FALSE),
        array('00000000 11111110', 1, 0, FALSE),
        array('00010000 11111111', 0, 4, TRUE),
        array('00000000 11111111', 1, 4, TRUE),
        array('00000000 11111111', 0, 4, FALSE),
        array('00000000 11101111', 1, 4, FALSE),
        array('10000000 11111111', 0, 7, TRUE),
        array('00000000 11111111', 1, 7, TRUE),
        array('00000000 11111111', 0, 7, FALSE),
        array('00000000 01111111', 1, 7, FALSE)
      );
    }

    public static function provideByteOffsetSamples() {
      return array(
        array('00000000 11111111', 0, 0),
        array('00000000 00000000', 1, 0),
        array('10000000 11111111', 0, 128),
        array('00000000 10000000', 1, 128),
        array('11111111 11111111', 0, 255),
        array('00000000 11111111', 1, 255)
      );
    }

    public static function provideInvalidOffsets() {
      return array(
        array(-1),
        array(3),
        array(array(-1, 0)),
        array(array(2, -1)),
        array(array(2, 8)),
      );
    }

    public static function provideInvalidValues() {
      return array(
        array(-1),
        array(256)
      );
    }
  }
}