tests/decode_unittests/decode_unittests.c

   1 /* This includes the whole .c file to get access to static functions. */
   2 #define PB_ENABLE_MALLOC
   3 #include "pb_common.c"
   4 #include "pb_decode.c"
   5
   6 #include <stdio.h>
   7 #include <string.h>
   8 #include "unittests.h"
   9 #include "unittestproto.pb.h"
  10
  11 #define S(x) pb_istream_from_buffer((uint8_t*)x, sizeof(x) - 1)
  12
  13 bool stream_callback(pb_istream_t *stream, uint8_t *buf, size_t count)
  14 {
  15     if (stream->state != NULL)
  16         return false; /* Simulate error */
  17
  18     if (buf != NULL)
  19         memset(buf, 'x', count);
  20     return true;
  21 }
  22
  23 /* Verifies that the stream passed to callback matches the byte array pointed to by arg. */
  24 bool callback_check(pb_istream_t *stream, const pb_field_t *field, void **arg)
  25 {
  26     int i;
  27     uint8_t byte;
  28     pb_bytes_array_t *ref = (pb_bytes_array_t*) *arg;
  29
  30     for (i = 0; i < ref->size; i++)
  31     {
  32         if (!pb_read(stream, &byte, 1))
  33             return false;
  34
  35         if (byte != ref->bytes[i])
  36             return false;
  37     }
  38
  39     return true;
  40 }
  41
  42 int main()
  43 {
  44     int status = 0;
  45
  46     {
  47         uint8_t buffer1[] = "foobartest1234";
  48         uint8_t buffer2[sizeof(buffer1)];
  49         pb_istream_t stream = pb_istream_from_buffer(buffer1, sizeof(buffer1));
  50
  51         COMMENT("Test pb_read and pb_istream_t");
  52         TEST(pb_read(&stream, buffer2, 6))
  53         TEST(memcmp(buffer2, "foobar", 6) == 0)
  54         TEST(stream.bytes_left == sizeof(buffer1) - 6)
  55         TEST(pb_read(&stream, buffer2 + 6, stream.bytes_left))
  56         TEST(memcmp(buffer1, buffer2, sizeof(buffer1)) == 0)
  57         TEST(stream.bytes_left == 0)
  58         TEST(!pb_read(&stream, buffer2, 1))
  59     }
  60
  61     {
  62         uint8_t buffer[20];
  63         pb_istream_t stream = {&stream_callback, NULL, 20};
  64
  65         COMMENT("Test pb_read with custom callback");
  66         TEST(pb_read(&stream, buffer, 5))
  67         TEST(memcmp(buffer, "xxxxx", 5) == 0)
  68         TEST(!pb_read(&stream, buffer, 50))
  69         stream.state = (void*)1; /* Simulated error return from callback */
  70         TEST(!pb_read(&stream, buffer, 5))
  71         stream.state = NULL;
  72         TEST(pb_read(&stream, buffer, 15))
  73     }
  74
  75     {
  76         pb_istream_t s;
  77         uint64_t u;
  78         int64_t i;
  79
  80         COMMENT("Test pb_decode_varint");
  81         TEST((s = S("\x00"), pb_decode_varint(&s, &u) && u == 0));
  82         TEST((s = S("\x01"), pb_decode_varint(&s, &u) && u == 1));
  83         TEST((s = S("\xAC\x02"), pb_decode_varint(&s, &u) && u == 300));
  84         TEST((s = S("\xFF\xFF\xFF\xFF\x0F"), pb_decode_varint(&s, &u) && u == UINT32_MAX));
  85         TEST((s = S("\xFF\xFF\xFF\xFF\x0F"), pb_decode_varint(&s, (uint64_t*)&i) && i == UINT32_MAX));
  86         TEST((s = S("\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\x01"),
  87               pb_decode_varint(&s, (uint64_t*)&i) && i == -1));
  88         TEST((s = S("\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\x01"),
  89               pb_decode_varint(&s, &u) && u == UINT64_MAX));
  90     }
  91
  92     {
  93         pb_istream_t s;
  94         COMMENT("Test pb_skip_varint");
  95         TEST((s = S("\x00""foobar"), pb_skip_varint(&s) && s.bytes_left == 6))
  96         TEST((s = S("\xAC\x02""foobar"), pb_skip_varint(&s) && s.bytes_left == 6))
  97         TEST((s = S("\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\x01""foobar"),
  98               pb_skip_varint(&s) && s.bytes_left == 6))
  99         TEST((s = S("\xFF"), !pb_skip_varint(&s)))
 100     }
 101
 102     {
 103         pb_istream_t s;
 104         COMMENT("Test pb_skip_string")
 105         TEST((s = S("\x00""foobar"), pb_skip_string(&s) && s.bytes_left == 6))
 106         TEST((s = S("\x04""testfoobar"), pb_skip_string(&s) && s.bytes_left == 6))
 107         TEST((s = S("\x04"), !pb_skip_string(&s)))
 108         TEST((s = S("\xFF"), !pb_skip_string(&s)))
 109     }
 110
 111     {
 112         pb_istream_t s = S("\x01\xFF\xFF\x03");
 113         pb_field_t f = {1, PB_LTYPE_VARINT, 0, 0, 4, 0, 0};
 114         uint32_t d;
 115         COMMENT("Test pb_dec_varint using uint32_t")
 116         TEST(pb_dec_varint(&s, &f, &d) && d == 1)
 117
 118         /* Verify that no more than data_size is written. */
 119         d = 0;
 120         f.data_size = 1;
 121         TEST(pb_dec_varint(&s, &f, &d) && (d == 0xFF || d == 0xFF000000))
 122     }
 123
 124     {
 125         pb_istream_t s;
 126         pb_field_t f = {1, PB_LTYPE_SVARINT, 0, 0, 4, 0, 0};
 127         int32_t d;
 128
 129         COMMENT("Test pb_dec_svarint using int32_t")
 130         TEST((s = S("\x01"), pb_dec_svarint(&s, &f, &d) && d == -1))
 131         TEST((s = S("\x02"), pb_dec_svarint(&s, &f, &d) && d == 1))
 132         TEST((s = S("\xfe\xff\xff\xff\x0f"), pb_dec_svarint(&s, &f, &d) && d == INT32_MAX))
 133         TEST((s = S("\xff\xff\xff\xff\x0f"), pb_dec_svarint(&s, &f, &d) && d == INT32_MIN))
 134     }
 135
 136     {
 137         pb_istream_t s;
 138         pb_field_t f = {1, PB_LTYPE_SVARINT, 0, 0, 8, 0, 0};
 139         uint64_t d;
 140
 141         COMMENT("Test pb_dec_svarint using uint64_t")
 142         TEST((s = S("\x01"), pb_dec_svarint(&s, &f, &d) && d == -1))
 143         TEST((s = S("\x02"), pb_dec_svarint(&s, &f, &d) && d == 1))
 144         TEST((s = S("\xFE\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\x01"), pb_dec_svarint(&s, &f, &d) && d == INT64_MAX))
 145         TEST((s = S("\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\x01"), pb_dec_svarint(&s, &f, &d) && d == INT64_MIN))
 146     }
 147
 148     {
 149         pb_istream_t s;
 150         pb_field_t f = {1, PB_LTYPE_FIXED32, 0, 0, 4, 0, 0};
 151         float d;
 152
 153         COMMENT("Test pb_dec_fixed32 using float (failures here may be caused by imperfect rounding)")
 154         TEST((s = S("\x00\x00\x00\x00"), pb_dec_fixed32(&s, &f, &d) && d == 0.0f))
 155         TEST((s = S("\x00\x00\xc6\x42"), pb_dec_fixed32(&s, &f, &d) && d == 99.0f))
 156         TEST((s = S("\x4e\x61\x3c\xcb"), pb_dec_fixed32(&s, &f, &d) && d == -12345678.0f))
 157         TEST((s = S("\x00"), !pb_dec_fixed32(&s, &f, &d) && d == -12345678.0f))
 158     }
 159
 160     {
 161         pb_istream_t s;
 162         pb_field_t f = {1, PB_LTYPE_FIXED64, 0, 0, 8, 0, 0};
 163         double d;
 164
 165         COMMENT("Test pb_dec_fixed64 using double (failures here may be caused by imperfect rounding)")
 166         TEST((s = S("\x00\x00\x00\x00\x00\x00\x00\x00"), pb_dec_fixed64(&s, &f, &d) && d == 0.0))
 167         TEST((s = S("\x00\x00\x00\x00\x00\xc0\x58\x40"), pb_dec_fixed64(&s, &f, &d) && d == 99.0))
 168         TEST((s = S("\x00\x00\x00\xc0\x29\x8c\x67\xc1"), pb_dec_fixed64(&s, &f, &d) && d == -12345678.0f))
 169     }
 170
 171     {
 172         pb_istream_t s;
 173         struct { pb_size_t size; uint8_t bytes[5]; } d;
 174         pb_field_t f = {1, PB_LTYPE_BYTES, 0, 0, sizeof(d), 0, 0};
 175
 176         COMMENT("Test pb_dec_bytes")
 177         TEST((s = S("\x00"), pb_dec_bytes(&s, &f, &d) && d.size == 0))
 178         TEST((s = S("\x01\xFF"), pb_dec_bytes(&s, &f, &d) && d.size == 1 && d.bytes[0] == 0xFF))
 179         TEST((s = S("\x05xxxxx"), pb_dec_bytes(&s, &f, &d) && d.size == 5))
 180         TEST((s = S("\x05xxxx"), !pb_dec_bytes(&s, &f, &d)))
 181
 182         /* Note: the size limit on bytes-fields is not strictly obeyed, as
 183          * the compiler may add some padding to the struct. Using this padding
 184          * is not a very good thing to do, but it is difficult to avoid when
 185          * we use only a single uint8_t to store the size of the field.
 186          * Therefore this tests against a 10-byte string, while otherwise even
 187          * 6 bytes should error out.
 188          */
 189         TEST((s = S("\x10xxxxxxxxxx"), !pb_dec_bytes(&s, &f, &d)))
 190     }
 191
 192     {
 193         pb_istream_t s;
 194         pb_field_t f = {1, PB_LTYPE_STRING, 0, 0, 5, 0, 0};
 195         char d[5];
 196
 197         COMMENT("Test pb_dec_string")
 198         TEST((s = S("\x00"), pb_dec_string(&s, &f, &d) && d[0] == '\0'))
 199         TEST((s = S("\x04xyzz"), pb_dec_string(&s, &f, &d) && strcmp(d, "xyzz") == 0))
 200         TEST((s = S("\x05xyzzy"), !pb_dec_string(&s, &f, &d)))
 201     }
 202
 203     {
 204         pb_istream_t s;
 205         IntegerArray dest;
 206
 207         COMMENT("Testing pb_decode with repeated int32 field")
 208         TEST((s = S(""), pb_decode(&s, IntegerArray_fields, &dest) && dest.data_count == 0))
 209         TEST((s = S("\x08\x01\x08\x02"), pb_decode(&s, IntegerArray_fields, &dest)
 210              && dest.data_count == 2 && dest.data[0] == 1 && dest.data[1] == 2))
 211         s = S("\x08\x01\x08\x02\x08\x03\x08\x04\x08\x05\x08\x06\x08\x07\x08\x08\x08\x09\x08\x0A");
 212         TEST(pb_decode(&s, IntegerArray_fields, &dest) && dest.data_count == 10 && dest.data[9] == 10)
 213         s = S("\x08\x01\x08\x02\x08\x03\x08\x04\x08\x05\x08\x06\x08\x07\x08\x08\x08\x09\x08\x0A\x08\x0B");
 214         TEST(!pb_decode(&s, IntegerArray_fields, &dest))
 215     }
 216
 217     {
 218         pb_istream_t s;
 219         IntegerArray dest;
 220
 221         COMMENT("Testing pb_decode with packed int32 field")
 222         TEST((s = S("\x0A\x00"), pb_decode(&s, IntegerArray_fields, &dest)
 223             && dest.data_count == 0))
 224         TEST((s = S("\x0A\x01\x01"), pb_decode(&s, IntegerArray_fields, &dest)
 225             && dest.data_count == 1 && dest.data[0] == 1))
 226         TEST((s = S("\x0A\x0A\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A"), pb_decode(&s, IntegerArray_fields, &dest)
 227             && dest.data_count == 10 && dest.data[0] == 1 && dest.data[9] == 10))
 228         TEST((s = S("\x0A\x0B\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B"), !pb_decode(&s, IntegerArray_fields, &dest)))
 229
 230         /* Test invalid wire data */
 231         TEST((s = S("\x0A\xFF"), !pb_decode(&s, IntegerArray_fields, &dest)))
 232         TEST((s = S("\x0A\x01"), !pb_decode(&s, IntegerArray_fields, &dest)))
 233     }
 234
 235     {
 236         pb_istream_t s;
 237         IntegerArray dest;
 238
 239         COMMENT("Testing pb_decode with unknown fields")
 240         TEST((s = S("\x18\x0F\x08\x01"), pb_decode(&s, IntegerArray_fields, &dest)
 241             && dest.data_count == 1 && dest.data[0] == 1))
 242         TEST((s = S("\x19\x00\x00\x00\x00\x00\x00\x00\x00\x08\x01"), pb_decode(&s, IntegerArray_fields, &dest)
 243             && dest.data_count == 1 && dest.data[0] == 1))
 244         TEST((s = S("\x1A\x00\x08\x01"), pb_decode(&s, IntegerArray_fields, &dest)
 245             && dest.data_count == 1 && dest.data[0] == 1))
 246         TEST((s = S("\x1B\x08\x01"), !pb_decode(&s, IntegerArray_fields, &dest)))
 247         TEST((s = S("\x1D\x00\x00\x00\x00\x08\x01"), pb_decode(&s, IntegerArray_fields, &dest)
 248             && dest.data_count == 1 && dest.data[0] == 1))
 249     }
 250
 251     {
 252         pb_istream_t s;
 253         CallbackArray dest;
 254         struct { pb_size_t size; uint8_t bytes[10]; } ref;
 255         dest.data.funcs.decode = &callback_check;
 256         dest.data.arg = &ref;
 257
 258         COMMENT("Testing pb_decode with callbacks")
 259         /* Single varint */
 260         ref.size = 1; ref.bytes[0] = 0x55;
 261         TEST((s = S("\x08\x55"), pb_decode(&s, CallbackArray_fields, &dest)))
 262         /* Packed varint */
 263         ref.size = 3; ref.bytes[0] = ref.bytes[1] = ref.bytes[2] = 0x55;
 264         TEST((s = S("\x0A\x03\x55\x55\x55"), pb_decode(&s, CallbackArray_fields, &dest)))
 265         /* Packed varint with loop */
 266         ref.size = 1; ref.bytes[0] = 0x55;
 267         TEST((s = S("\x0A\x03\x55\x55\x55"), pb_decode(&s, CallbackArray_fields, &dest)))
 268         /* Single fixed32 */
 269         ref.size = 4; ref.bytes[0] = ref.bytes[1] = ref.bytes[2] = ref.bytes[3] = 0xAA;
 270         TEST((s = S("\x0D\xAA\xAA\xAA\xAA"), pb_decode(&s, CallbackArray_fields, &dest)))
 271         /* Single fixed64 */
 272         ref.size = 8; memset(ref.bytes, 0xAA, 8);
 273         TEST((s = S("\x09\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA"), pb_decode(&s, CallbackArray_fields, &dest)))
 274         /* Unsupported field type */
 275         TEST((s = S("\x0B\x00"), !pb_decode(&s, CallbackArray_fields, &dest)))
 276
 277         /* Just make sure that our test function works */
 278         ref.size = 1; ref.bytes[0] = 0x56;
 279         TEST((s = S("\x08\x55"), !pb_decode(&s, CallbackArray_fields, &dest)))
 280     }
 281
 282     {
 283         pb_istream_t s;
 284         IntegerArray dest;
 285
 286         COMMENT("Testing pb_decode message termination")
 287         TEST((s = S(""), pb_decode(&s, IntegerArray_fields, &dest)))
 288         TEST((s = S("\x00"), pb_decode(&s, IntegerArray_fields, &dest)))
 289         TEST((s = S("\x08\x01"), pb_decode(&s, IntegerArray_fields, &dest)))
 290         TEST((s = S("\x08\x01\x00"), pb_decode(&s, IntegerArray_fields, &dest)))
 291         TEST((s = S("\x08"), !pb_decode(&s, IntegerArray_fields, &dest)))
 292     }
 293
 294     {
 295         pb_istream_t s;
 296         IntegerContainer dest = {{0}};
 297
 298         COMMENT("Testing pb_decode_delimited")
 299         TEST((s = S("\x09\x0A\x07\x0A\x05\x01\x02\x03\x04\x05"),
 300               pb_decode_delimited(&s, IntegerContainer_fields, &dest)) &&
 301               dest.submsg.data_count == 5)
 302     }
 303
 304     {
 305         pb_istream_t s = {0};
 306         void *data = NULL;
 307
 308         COMMENT("Testing allocate_field")
 309         TEST(allocate_field(&s, &data, 10, 10) && data != NULL);
 310         TEST(allocate_field(&s, &data, 10, 20) && data != NULL);
 311
 312         {
 313             void *oldvalue = data;
 314             size_t very_big = (size_t)-1;
 315             size_t somewhat_big = very_big / 2 + 1;
 316             size_t not_so_big = (size_t)1 << (4 * sizeof(size_t));
 317
 318             TEST(!allocate_field(&s, &data, very_big, 2) && data == oldvalue);
 319             TEST(!allocate_field(&s, &data, somewhat_big, 2) && data == oldvalue);
 320             TEST(!allocate_field(&s, &data, not_so_big, not_so_big) && data == oldvalue);
 321         }
 322
 323         pb_free(data);
 324     }
 325
 326     if (status != 0)
 327         fprintf(stdout, "\n\nSome tests FAILED!\n");
 328
 329     return status;
 330 }