APUE Learning Example Source Code
guowenxue
2019-06-26 157be0b0d4c7d4809cfcafc76235cc18388378c8
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
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
#include <CUnit/CUnit.h>
#include <CUnit/Basic.h>
 
#include "packet_mosq.h"
 
static void byte_read_helper(
        uint8_t *payload,
        int remaining_length,
        int rc_expected,
        uint8_t value_expected)
{
    struct mosquitto__packet packet;
    uint8_t value = 0;
    int rc;
 
    memset(&packet, 0, sizeof(struct mosquitto__packet));
    packet.payload = payload;
    packet.remaining_length = remaining_length;
    rc = packet__read_byte(&packet, &value);
    CU_ASSERT_EQUAL(rc, rc_expected);
    CU_ASSERT_EQUAL(value, value_expected);
}
 
 
static void uint16_read_helper(
        uint8_t *payload,
        int remaining_length,
        int rc_expected,
        uint16_t value_expected)
{
    struct mosquitto__packet packet;
    uint16_t value = 0;
    int rc;
 
    memset(&packet, 0, sizeof(struct mosquitto__packet));
    packet.payload = payload;
    packet.remaining_length = remaining_length;
    rc = packet__read_uint16(&packet, &value);
    CU_ASSERT_EQUAL(rc, rc_expected);
    CU_ASSERT_EQUAL(value, value_expected);
}
 
 
static void uint32_read_helper(
        uint8_t *payload,
        int remaining_length,
        int rc_expected,
        uint32_t value_expected)
{
    struct mosquitto__packet packet;
    uint32_t value = 0;
    int rc;
 
    memset(&packet, 0, sizeof(struct mosquitto__packet));
    packet.payload = payload;
    packet.remaining_length = remaining_length;
    rc = packet__read_uint32(&packet, &value);
    CU_ASSERT_EQUAL(rc, rc_expected);
    CU_ASSERT_EQUAL(value, value_expected);
}
 
 
static void varint_read_helper(
        uint8_t *payload,
        int remaining_length,
        int rc_expected,
        int32_t value_expected,
        int8_t bytes_expected)
{
    struct mosquitto__packet packet;
    int32_t value = -1;
    int8_t bytes = -1;
    int rc;
 
    memset(&packet, 0, sizeof(struct mosquitto__packet));
    packet.payload = payload;
    packet.remaining_length = remaining_length;
    rc = packet__read_varint(&packet, &value, &bytes);
    CU_ASSERT_EQUAL(rc, rc_expected);
    CU_ASSERT_EQUAL(value, value_expected);
    CU_ASSERT_EQUAL(bytes, bytes_expected);
}
 
 
static void binary_read_helper(
        uint8_t *payload,
        int remaining_length,
        int rc_expected,
        const uint8_t *value_expected,
        int length_expected)
{
    struct mosquitto__packet packet;
    uint8_t *value = NULL;
    int length = -1;
    int rc;
 
    memset(&packet, 0, sizeof(struct mosquitto__packet));
    packet.payload = payload;
    packet.remaining_length = remaining_length;
    rc = packet__read_binary(&packet, (uint8_t **)&value, &length);
    CU_ASSERT_EQUAL(rc, rc_expected);
    if(value_expected){
        /* FIXME - this should be a memcmp */
        CU_ASSERT_NSTRING_EQUAL(value, value_expected, length_expected);
    }else{
        CU_ASSERT_EQUAL(value, NULL);
    }
    CU_ASSERT_EQUAL(length, length_expected);
    free(value);
}
 
 
static void string_read_helper(
        uint8_t *payload,
        int remaining_length,
        int rc_expected,
        const uint8_t *value_expected,
        int length_expected)
{
    struct mosquitto__packet packet;
    uint8_t *value = NULL;
    int length = -1;
    int rc;
 
    memset(&packet, 0, sizeof(struct mosquitto__packet));
    packet.payload = payload;
    packet.remaining_length = remaining_length;
    rc = packet__read_string(&packet, (char **)&value, &length);
    CU_ASSERT_EQUAL(rc, rc_expected);
    if(value_expected){
        if(value){
            CU_ASSERT_NSTRING_EQUAL(value, value_expected, length_expected);
        }
    }else{
        CU_ASSERT_PTR_NULL(value);
    }
    CU_ASSERT_EQUAL(length, length_expected);
    free(value);
}
 
 
static void bytes_read_helper(
        uint8_t *payload,
        int remaining_length,
        int rc_expected,
        const uint8_t *value_expected,
        int count)
{
    struct mosquitto__packet packet;
    uint8_t value[count];
    int rc;
    int i;
 
    memset(&packet, 0, sizeof(struct mosquitto__packet));
    packet.payload = payload;
    packet.remaining_length = remaining_length;
    rc = packet__read_bytes(&packet, value, count);
    CU_ASSERT_EQUAL(rc, rc_expected);
    if(rc == MOSQ_ERR_SUCCESS){
        CU_ASSERT_EQUAL(packet.pos, count);
    }
    if(value_expected){
        for(i=0; i<count; i++){
            CU_ASSERT_EQUAL(value[i], value_expected[i]);
        }
    }
}
 
 
/* ========================================================================
 * BYTE INTEGER TESTS
 * ======================================================================== */
 
/* This tests reading a Byte from an incoming packet.
 *
 * It tests:
 *  * Empty packets
 */
static void TEST_byte_read_empty(void)
{
    /* Empty packet */
    byte_read_helper(NULL, 0, MOSQ_ERR_PROTOCOL, 0);
}
 
 
/* This tests reading a Byte from an incoming packet.
 *
 * It tests:
 *  * Success at boundaries
 */
static void TEST_byte_read_success(void)
{
    uint8_t payload[20];
 
    /* 0 value */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x00;
    byte_read_helper(payload, 1, MOSQ_ERR_SUCCESS, 0x00);
 
    /* Middle */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x1F;
    byte_read_helper(payload, 1, MOSQ_ERR_SUCCESS, 0x1F);
 
    /* 255 value */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0xFF;
    byte_read_helper(payload, 1, MOSQ_ERR_SUCCESS, 0xFF);
 
}
 
 
/* ========================================================================
 * TWO BYTE INTEGER TESTS
 * ======================================================================== */
 
/* This tests reading a Two Byte Integer from an incoming packet.
 *
 * It tests:
 *  * Empty packets
 */
static void TEST_uint16_read_empty(void)
{
    /* Empty packet */
    uint16_read_helper(NULL, 0, MOSQ_ERR_PROTOCOL, 0);
}
 
 
/* This tests reading a Two Byte Integer from an incoming packet.
 *
 * It tests:
 *  * Truncated packets
 */
static void TEST_uint16_read_truncated(void)
{
    uint8_t payload[20];
 
    /* 1 byte packet */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x38;
    uint16_read_helper(payload, 1, MOSQ_ERR_PROTOCOL, 0);
}
 
 
/* This tests reading a Two Byte Integer from an incoming packet.
 *
 * It tests:
 *  * Success at boundaries
 *  * Endianness
 */
static void TEST_uint16_read_success(void)
{
    uint8_t payload[20];
 
    /* 0 value */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x00;
    payload[1] = 0x00;
    uint16_read_helper(payload, 2, MOSQ_ERR_SUCCESS, 0x0000);
 
    /* Endian check */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x38;
    payload[1] = 0xF3;
    uint16_read_helper(payload, 2, MOSQ_ERR_SUCCESS, 0x38F3);
 
    /* 65,535 value */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0xFF;
    payload[1] = 0xFF;
    uint16_read_helper(payload, 2, MOSQ_ERR_SUCCESS, 0xFFFF);
 
}
 
 
/* ========================================================================
 * FOUR BYTE INTEGER TESTS
 * ======================================================================== */
 
/* This tests reading a Four Byte Integer from an incoming packet.
 *
 * It tests:
 *  * Empty packets
 */
static void TEST_uint32_read_empty(void)
{
    /* Empty packet */
    uint32_read_helper(NULL, 0, MOSQ_ERR_PROTOCOL, 0);
}
 
 
/* This tests reading a Four Byte Integer from an incoming packet.
 *
 * It tests:
 *  * Truncated packets
 */
static void TEST_uint32_read_truncated(void)
{
    uint8_t payload[20];
 
    /* 1 byte packet */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x38;
    uint32_read_helper(payload, 1, MOSQ_ERR_PROTOCOL, 0);
 
    /* 2 byte packet */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x38;
    payload[1] = 0x38;
    uint32_read_helper(payload, 2, MOSQ_ERR_PROTOCOL, 0);
 
    /* 3 byte packet */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x38;
    payload[1] = 0x38;
    payload[2] = 0x38;
    uint32_read_helper(payload, 3, MOSQ_ERR_PROTOCOL, 0);
}
 
 
/* This tests reading a Four Byte Integer from an incoming packet.
 *
 * It tests:
 *  * Success at boundaries
 *  * Endianness
 */
static void TEST_uint32_read_success(void)
{
    uint8_t payload[20];
 
    /* 0 value */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x00;
    payload[1] = 0x00;
    payload[2] = 0x00;
    payload[3] = 0x00;
    uint32_read_helper(payload, 4, MOSQ_ERR_SUCCESS, 0x00000000);
 
    /* Endian check */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x12;
    payload[1] = 0x34;
    payload[2] = 0x56;
    payload[3] = 0x78;
    uint32_read_helper(payload, 4, MOSQ_ERR_SUCCESS, 0x12345678);
 
    /* Biggest value */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0xFF;
    payload[1] = 0xFF;
    payload[2] = 0xFF;
    payload[3] = 0xFF;
    uint32_read_helper(payload, 4, MOSQ_ERR_SUCCESS, 0xFFFFFFFF);
 
}
 
 
/* ========================================================================
 * VARIABLE BYTE INTEGER TESTS
 * ======================================================================== */
 
/* This tests reading a Variable Byte Integer from an incoming packet.
 *
 * It tests:
 *  * Empty packet
 */
static void TEST_varint_read_empty(void)
{
    /* Empty packet */
    varint_read_helper(NULL, 0, MOSQ_ERR_PROTOCOL, -1, -1);
}
 
 
/* This tests reading a Variable Byte Integer from an incoming packet.
 *
 * It tests:
 *  * Truncated packets (varint encoding is longer than data)
 */
static void TEST_varint_read_truncated(void)
{
    uint8_t payload[20];
 
    /* Varint bigger than packet */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x80;
    varint_read_helper(payload, 1, MOSQ_ERR_PROTOCOL, -1, -1);
 
    /* Varint bigger than packet */
    memset(payload, 1, sizeof(payload));
    payload[0] = 0x80;
    payload[1] = 0x80;
    varint_read_helper(payload, 2, MOSQ_ERR_PROTOCOL, -1, -1);
 
    /* Varint bigger than packet */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x80;
    payload[1] = 0x80;
    payload[2] = 0x80;
    varint_read_helper(payload, 3, MOSQ_ERR_PROTOCOL, -1, -1);
 
    /* Varint bigger than packet */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x80;
    payload[1] = 0x80;
    payload[2] = 0x80;
    payload[3] = 0x80;
    varint_read_helper(payload, 4, MOSQ_ERR_PROTOCOL, -1, -1);
}
 
 
/* This tests reading a Variable Byte Integer from an incoming packet.
 *
 * It tests:
 *  * Correct values on boundaries of 1, 2, 3, 4 byte encodings
 */
static void TEST_varint_read_boundaries(void)
{
    uint8_t payload[20];
 
    /* Value = 0 */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x00;
    varint_read_helper(payload, 1, MOSQ_ERR_SUCCESS, 0, 1);
 
    /* Value = 127 (just beneath the crossover to two bytes */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x7F;
    varint_read_helper(payload, 1, MOSQ_ERR_SUCCESS, 127, 1);
 
    /* Value = 128 (just after the crossover to two bytes */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x80;
    payload[1] = 0x01;
    varint_read_helper(payload, 2, MOSQ_ERR_SUCCESS, 128, 2);
 
    /* Value = 16383 (just before the crossover to three bytes */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0xFF;
    payload[1] = 0x7F;
    varint_read_helper(payload, 2, MOSQ_ERR_SUCCESS, 16383, 2);
 
    /* Value = 16384 (just after the crossover to three bytes */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x80;
    payload[1] = 0x80;
    payload[2] = 0x01;
    varint_read_helper(payload, 3, MOSQ_ERR_SUCCESS, 16384, 3);
 
    /* Value = 2,097,151 (just before the crossover to four bytes */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0xFF;
    payload[1] = 0xFF;
    payload[2] = 0x7F;
    varint_read_helper(payload, 3, MOSQ_ERR_SUCCESS, 2097151, 3);
 
    /* Value = 2,097,152 (just after the crossover to four bytes */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x80;
    payload[1] = 0x80;
    payload[2] = 0x80;
    payload[3] = 0x01;
    varint_read_helper(payload, 4, MOSQ_ERR_SUCCESS, 2097152, 4);
 
    /* Value = 268,435,455 (highest value allowed) */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0xFF;
    payload[1] = 0xFF;
    payload[2] = 0xFF;
    payload[3] = 0x7F;
    varint_read_helper(payload, 4, MOSQ_ERR_SUCCESS, 268435455, 4);
}
 
/* This tests reading a Variable Byte Integer from an incoming packet.
 *
 * It tests:
 *  * Too long encoding (5 bytes)
 */
static void TEST_varint_read_5_bytes(void)
{
    uint8_t payload[20];
 
    /* Value = 268,435,456 (one higher than highest value allowed) */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x80;
    payload[1] = 0x80;
    payload[2] = 0x80;
    payload[3] = 0x80;
    payload[4] = 0x01;
    varint_read_helper(payload, 5, MOSQ_ERR_PROTOCOL, -1, -1);
}
 
 
/* This tests reading a Variable Byte Integer from an incoming packet.
 *
 * It tests:
 *  * Overlong encodings (e.g. 2 bytes to encode "1")
 */
static void TEST_varint_read_overlong_encoding(void)
{
    uint8_t payload[20];
 
    /* Overlong encoding of 0 (1 byte value encoded as 2 bytes) */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x80;
    payload[1] = 0x00;
    varint_read_helper(payload, 2, MOSQ_ERR_PROTOCOL, -1, -1);
 
    /* Overlong encoding of 127 (1 byte value encoded as 2 bytes) */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0xFF;
    payload[1] = 0x00;
    varint_read_helper(payload, 2, MOSQ_ERR_PROTOCOL, -1, -1);
 
    /* Overlong encoding of 128 (2 byte value encoded as 3 bytes) */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x80;
    payload[1] = 0x81;
    payload[2] = 0x00;
    varint_read_helper(payload, 3, MOSQ_ERR_PROTOCOL, -1, -1);
 
    /* Overlong encoding of 16,383 (2 byte value encoded as 3 bytes) */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0xFF;
    payload[1] = 0xFF;
    payload[2] = 0x00;
    varint_read_helper(payload, 3, MOSQ_ERR_PROTOCOL, -1, -1);
 
    /* Overlong encoding of 16,384 (3 byte value encoded as 4 bytes) */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x80;
    payload[1] = 0x80;
    payload[2] = 0x81;
    payload[3] = 0x00;
    varint_read_helper(payload, 4, MOSQ_ERR_PROTOCOL, -1, -1);
 
    /* Overlong encoding of 2,097,151 (3 byte value encoded as 4 bytes) */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0xFF;
    payload[1] = 0xFF;
    payload[2] = 0xFF;
    payload[3] = 0x00;
    varint_read_helper(payload, 4, MOSQ_ERR_PROTOCOL, -1, -1);
}
 
 
/* ========================================================================
 * UTF-8 STRING TESTS
 * ======================================================================== */
 
/* This tests reading a UTF-8 Encoded String from an incoming packet.
 *
 * It tests:
 *  * Empty packet
 */
static void TEST_string_read_empty(void)
{
    string_read_helper(NULL, 0, MOSQ_ERR_PROTOCOL, NULL, -1);
}
 
/* This tests reading a UTF-8 Encoded String from an incoming packet.
 *
 * It tests:
 *  * Truncated packets
 */
static void TEST_string_read_truncated(void)
{
    uint8_t payload[20];
 
    /* 1 byte packet */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x02;
    string_read_helper(payload, 1, MOSQ_ERR_PROTOCOL, NULL, -1);
 
    /* 2 byte packet */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x02;
    payload[1] = 0x02;
    string_read_helper(payload, 2, MOSQ_ERR_PROTOCOL, NULL, -1);
 
    /* 3 byte packet */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x00;
    payload[1] = 0x02;
    payload[2] = 'a';
    string_read_helper(payload, 3, MOSQ_ERR_PROTOCOL, NULL, -1);
 
    /* 3 byte packet */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x00;
    payload[1] = 0x03;
    payload[2] = 'a';
    payload[3] = 'b';
    string_read_helper(payload, 4, MOSQ_ERR_PROTOCOL, NULL, -1);
}
 
 
/* This tests reading a UTF-8 Encoded String from an incoming packet.
 *
 * It tests:
 *  * Empty string
 */
static void TEST_string_read_empty_string(void)
{
    uint8_t payload[20];
 
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x00;
    payload[1] = 0x00;
    string_read_helper(payload, 2, MOSQ_ERR_SUCCESS, (const uint8_t *)"", 0);
}
 
/* This tests reading a UTF-8 Encoded String from an incoming packet.
 *
 * It tests:
 *  * Valid string
 */
static void TEST_string_read_valid_string(void)
{
    uint8_t payload[20];
 
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x00;
    payload[1] = 0x0b;
    payload[2] = 't';
    payload[3] = 'e';
    payload[4] = 's';
    payload[5] = 't';
    payload[6] = ' ';
    payload[7] = 's';
    payload[8] = 't';
    payload[9] = 'r';
    payload[10] = 'i';
    payload[11] = 'n';
    payload[12] = 'g';
    string_read_helper(payload, 13, MOSQ_ERR_SUCCESS, (const uint8_t *)"test string", 11);
}
 
 
/* This tests reading a UTF-8 Encoded String from an incoming packet.
 *
 * It tests:
 *  * Malformed UTF-8 (note, comprehensive UTF-8 tests are elsewhere)
 */
static void TEST_string_read_malformed_string(void)
{
    uint8_t payload[20];
 
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x00;
    payload[1] = 0x07;
    payload[2] = 't';
    payload[3] = 'e';
    payload[4] = 's';
    payload[5] = 't';
    payload[6] = 0xED; /* U+D800 - single UTF-16 surrogate */
    payload[7] = 0xA0;
    payload[8] = 0x80;
    string_read_helper(payload, 9, MOSQ_ERR_MALFORMED_UTF8, NULL, -1);
}
 
 
/* This tests reading a UTF-8 Encoded String from an incoming packet.
 *
 * It tests:
 *  * MQTT-1.5.4-3 - Is 0xEF 0xBB 0xBF treated correctly.
 */
static void TEST_string_read_mqtt_1_5_4_3(void)
{
    uint8_t payload[20];
 
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x00;
    payload[1] = 0x0b;
    payload[2] = 't';
    payload[3] = 'e';
    payload[4] = 's';
    payload[5] = 't';
    payload[6] = 0xEF; /* U+FEFF - zero with no-break space */
    payload[7] = 0xBB;
    payload[8] = 0xBF;
    payload[9] = 't';
    payload[10] = 'e';
    payload[11] = 's';
    payload[12] = 't';
    string_read_helper(payload, 13, MOSQ_ERR_SUCCESS, &payload[2], 11);
}
 
 
/* ========================================================================
 * BINARY DATA TESTS
 * ======================================================================== */
 
/* This tests reading Binary Data from an incoming packet.
 *
 * It tests:
 *  * Empty packet
 */
static void TEST_binary_data_read_empty(void)
{
    binary_read_helper(NULL, 0, MOSQ_ERR_PROTOCOL, NULL, -1);
}
 
 
/* This tests reading Binary Data from an incoming packet.
 *
 * It tests:
 *  * Truncated packets
 */
static void TEST_binary_data_read_truncated(void)
{
    uint8_t payload[20];
 
    /* 1 byte packet */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x02;
    binary_read_helper(payload, 1, MOSQ_ERR_PROTOCOL, NULL, -1);
 
    /* 2 byte packet */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x02;
    payload[1] = 0x02;
    binary_read_helper(payload, 2, MOSQ_ERR_PROTOCOL, NULL, -1);
 
    /* 3 byte packet */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x00;
    payload[1] = 0x02;
    payload[2] = 'a';
    binary_read_helper(payload, 3, MOSQ_ERR_PROTOCOL, NULL, -1);
 
    /* 3 byte packet */
    memset(payload, 0, sizeof(payload));
    payload[0] = 0x00;
    payload[1] = 0x03;
    payload[2] = 'a';
    payload[3] = 'b';
    binary_read_helper(payload, 4, MOSQ_ERR_PROTOCOL, NULL, -1);
}
 
 
/* ========================================================================
 * MULTIPLE BYTE TESTS
 * ======================================================================== */
 
/* This tests reading multiple bytes (payload) from an incoming packet.
 *
 * It tests:
 *  * Empty packets
 */
static void TEST_bytes_read_empty(void)
{
    /* Empty packet */
    bytes_read_helper(NULL, 0, MOSQ_ERR_SUCCESS, NULL, 0);
}
 
/* This tests reading multiple bytes (payload) from an incoming packet.
 *
 * It tests:
 *  * Truncated packets
 */
static void TEST_bytes_read_truncated(void)
{
    bytes_read_helper(NULL, 0, MOSQ_ERR_PROTOCOL, NULL, 1);
}
 
/* This tests reading multiple bytes from an incoming packet.
 *
 * It tests:
 *  * Success
 */
static void TEST_bytes_read_success(void)
{
    uint8_t payload[20];
    int i;
 
    for(i=0; i<20; i++){
        payload[i] = i*2;
    }
    bytes_read_helper(payload, 20, MOSQ_ERR_SUCCESS, payload, 20);
}
 
 
/* ========================================================================
 * TEST SUITE SETUP
 * ======================================================================== */
 
int init_datatype_read_tests(void)
{
    CU_pSuite test_suite = NULL;
 
    test_suite = CU_add_suite("Datatype read", NULL, NULL);
    if(!test_suite){
        printf("Error adding CUnit test suite.\n");
        return 1;
    }
 
    if(0
            || !CU_add_test(test_suite, "Byte read (empty packet)", TEST_byte_read_empty)
            || !CU_add_test(test_suite, "Byte read (success values)", TEST_byte_read_success)
            || !CU_add_test(test_suite, "Two Byte Integer read (empty packet)", TEST_uint16_read_empty)
            || !CU_add_test(test_suite, "Two Byte Integer read (truncated packet)", TEST_uint16_read_truncated)
            || !CU_add_test(test_suite, "Two Byte Integer read (success values)", TEST_uint16_read_success)
            || !CU_add_test(test_suite, "Four Byte Integer read (empty packet)", TEST_uint32_read_empty)
            || !CU_add_test(test_suite, "Four Byte Integer read (truncated packet)", TEST_uint32_read_truncated)
            || !CU_add_test(test_suite, "Four Byte Integer read (success values)", TEST_uint32_read_success)
            || !CU_add_test(test_suite, "Variable Byte Integer read (empty packet)", TEST_varint_read_empty)
            || !CU_add_test(test_suite, "Variable Byte Integer read (truncated packets)", TEST_varint_read_truncated)
            || !CU_add_test(test_suite, "Variable Byte Integer read (encoding boundaries)", TEST_varint_read_boundaries)
            || !CU_add_test(test_suite, "Variable Byte Integer read (five byte encoding)", TEST_varint_read_5_bytes)
            || !CU_add_test(test_suite, "Variable Byte Integer read (overlong encodings)", TEST_varint_read_overlong_encoding)
            || !CU_add_test(test_suite, "UTF-8 string read (empty packet)", TEST_string_read_empty)
            || !CU_add_test(test_suite, "UTF-8 string read (truncated packet)", TEST_string_read_truncated)
            || !CU_add_test(test_suite, "UTF-8 string read (empty string)", TEST_string_read_empty_string)
            || !CU_add_test(test_suite, "UTF-8 string read (valid string)", TEST_string_read_valid_string)
            || !CU_add_test(test_suite, "UTF-8 string read (malformed string)", TEST_string_read_malformed_string)
            || !CU_add_test(test_suite, "UTF-8 string read (MQTT-1.5.4-3)", TEST_string_read_mqtt_1_5_4_3)
            || !CU_add_test(test_suite, "Binary Data read (empty packet)", TEST_binary_data_read_empty)
            || !CU_add_test(test_suite, "Binary Data read (truncated packet)", TEST_binary_data_read_truncated)
            || !CU_add_test(test_suite, "Bytes read (empty packet)", TEST_bytes_read_empty)
            || !CU_add_test(test_suite, "Bytes read (truncated packet)", TEST_bytes_read_truncated)
            || !CU_add_test(test_suite, "Bytes read (success)", TEST_bytes_read_success)
            ){
 
        printf("Error adding Datatype read CUnit tests.\n");
        return 1;
    }
 
    return 0;
}