gio/tests/data-input-stream.c

   1 /* GLib testing framework examples and tests
   2  * Copyright (C) 2008 Red Hat, Inc.
   3  * Authors: Tomas Bzatek <tbzatek@redhat.com>
   4  *
   5  * This work is provided "as is"; redistribution and modification
   6  * in whole or in part, in any medium, physical or electronic is
   7  * permitted without restriction.
   8  *
   9  * This work is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12  *
  13  * In no event shall the authors or contributors be liable for any
  14  * direct, indirect, incidental, special, exemplary, or consequential
  15  * damages (including, but not limited to, procurement of substitute
  16  * goods or services; loss of use, data, or profits; or business
  17  * interruption) however caused and on any theory of liability, whether
  18  * in contract, strict liability, or tort (including negligence or
  19  * otherwise) arising in any way out of the use of this software, even
  20  * if advised of the possibility of such damage.
  21  */
  22
  23 #include <glib/glib.h>
  24 #include <gio/gio.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27
  28 #define MAX_LINES       0xFFF
  29 #define MAX_BYTES       0x10000
  30
  31 static void
  32 test_basic (void)
  33 {
  34   GInputStream *stream;
  35   GInputStream *base_stream;
  36   gint val;
  37
  38   base_stream = g_memory_input_stream_new ();
  39   stream = G_INPUT_STREAM (g_data_input_stream_new (base_stream));
  40
  41   g_object_get (stream, "byte-order", &val, NULL);
  42   g_assert_cmpint (val, ==, G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN);
  43   g_object_set (stream, "byte-order", G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN, NULL);
  44   g_assert_cmpint (g_data_input_stream_get_byte_order (G_DATA_INPUT_STREAM (stream)), ==, G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN);
  45
  46   g_object_get (stream, "newline-type", &val, NULL);
  47   g_assert_cmpint (val, ==, G_DATA_STREAM_NEWLINE_TYPE_LF);
  48   g_object_set (stream, "newline-type", G_DATA_STREAM_NEWLINE_TYPE_CR_LF, NULL);
  49   g_assert_cmpint (g_data_input_stream_get_newline_type (G_DATA_INPUT_STREAM (stream)), ==, G_DATA_STREAM_NEWLINE_TYPE_CR_LF);
  50
  51   g_object_unref (stream);
  52   g_object_unref (base_stream);
  53 }
  54
  55 static void
  56 test_seek_to_start (GInputStream *stream)
  57 {
  58   GError *error = NULL;
  59   gboolean res = g_seekable_seek (G_SEEKABLE (stream), 0, G_SEEK_SET, NULL, &error);
  60   g_assert_cmpint (res, ==, TRUE);
  61   g_assert_no_error (error);
  62 }
  63
  64 static void
  65 test_read_lines (GDataStreamNewlineType newline_type)
  66 {
  67   GInputStream *stream;
  68   GInputStream *base_stream;
  69   GError *error = NULL;
  70   char *data;
  71   int line;
  72   const char* lines[MAX_LINES];
  73   const char* endl[4] = {"\n", "\r", "\r\n", "\n"};
  74
  75   /*  prepare data */
  76   int i;
  77   for (i = 0; i < MAX_LINES; i++)
  78     lines[i] = "some_text";
  79
  80   base_stream = g_memory_input_stream_new ();
  81   g_assert (base_stream != NULL);
  82   stream = G_INPUT_STREAM (g_data_input_stream_new (base_stream));
  83   g_assert(stream != NULL);
  84
  85   /*  Byte order testing */
  86   g_data_input_stream_set_byte_order (G_DATA_INPUT_STREAM (stream), G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN);
  87   g_assert_cmpint (g_data_input_stream_get_byte_order (G_DATA_INPUT_STREAM (stream)), ==, G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN);
  88   g_data_input_stream_set_byte_order (G_DATA_INPUT_STREAM (stream), G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN);
  89   g_assert_cmpint (g_data_input_stream_get_byte_order (G_DATA_INPUT_STREAM (stream)), ==, G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN);
  90
  91   /*  Line ends testing */
  92   g_data_input_stream_set_newline_type (G_DATA_INPUT_STREAM (stream), newline_type);
  93   g_assert_cmpint (g_data_input_stream_get_newline_type (G_DATA_INPUT_STREAM (stream)), ==, newline_type);
  94
  95
  96   /*  Add sample data */
  97   for (i = 0; i < MAX_LINES; i++)
  98     g_memory_input_stream_add_data (G_MEMORY_INPUT_STREAM (base_stream),
  99                                     g_strconcat (lines[i], endl[newline_type], NULL), -1, g_free);
 100
 101   /*  Seek to the start */
 102   test_seek_to_start (base_stream);
 103
 104   /*  Test read line */
 105   error = NULL;
 106   data = (char*)1;
 107   line = 0;
 108   while (data)
 109     {
 110       gsize length = -1;
 111       data = g_data_input_stream_read_line (G_DATA_INPUT_STREAM (stream), &length, NULL, &error);
 112       if (data)
 113         {
 114           g_assert_cmpstr (data, ==, lines[line]);
 115           g_free (data);
 116           g_assert_no_error (error);
 117           line++;
 118         }
 119       if (error)
 120         g_error_free (error);
 121     }
 122   g_assert_cmpint (line, ==, MAX_LINES);
 123
 124
 125   g_object_unref (base_stream);
 126   g_object_unref (stream);
 127 }
 128
 129 static void
 130 test_read_lines_LF (void)
 131 {
 132   test_read_lines (G_DATA_STREAM_NEWLINE_TYPE_LF);
 133 }
 134
 135 static void
 136 test_read_lines_CR (void)
 137 {
 138   test_read_lines (G_DATA_STREAM_NEWLINE_TYPE_CR);
 139 }
 140
 141 static void
 142 test_read_lines_CR_LF (void)
 143 {
 144   test_read_lines (G_DATA_STREAM_NEWLINE_TYPE_CR_LF);
 145 }
 146
 147 static void
 148 test_read_lines_any (void)
 149 {
 150   test_read_lines (G_DATA_STREAM_NEWLINE_TYPE_ANY);
 151 }
 152
 153 static void
 154 test_read_lines_LF_valid_utf8 (void)
 155 {
 156   GInputStream *stream;
 157   GInputStream *base_stream;
 158   GError *error = NULL;
 159   char *line;
 160   guint n_lines = 0;
 161
 162   base_stream = g_memory_input_stream_new ();
 163   stream = G_INPUT_STREAM (g_data_input_stream_new (base_stream));
 164
 165   g_memory_input_stream_add_data (G_MEMORY_INPUT_STREAM (base_stream),
 166                                   "foo\nthis is valid UTF-8 ☺!\nbar\n", -1, NULL);
 167
 168   /*  Test read line */
 169   error = NULL;
 170   while (TRUE)
 171     {
 172       gsize length = -1;
 173       line = g_data_input_stream_read_line_utf8 (G_DATA_INPUT_STREAM (stream), &length, NULL, &error);
 174       g_assert_no_error (error);
 175       if (line == NULL)
 176         break;
 177       n_lines++;
 178       g_free (line);
 179     }
 180   g_assert_cmpint (n_lines, ==, 3);
 181
 182   g_object_unref (base_stream);
 183   g_object_unref (stream);
 184 }
 185
 186 static void
 187 test_read_lines_LF_invalid_utf8 (void)
 188 {
 189   GInputStream *stream;
 190   GInputStream *base_stream;
 191   GError *error = NULL;
 192   char *line;
 193   guint n_lines = 0;
 194
 195   base_stream = g_memory_input_stream_new ();
 196   stream = G_INPUT_STREAM (g_data_input_stream_new (base_stream));
 197
 198   g_memory_input_stream_add_data (G_MEMORY_INPUT_STREAM (base_stream),
 199                                   "foo\nthis is not valid UTF-8 \xE5 =(\nbar\n", -1, NULL);
 200
 201   /*  Test read line */
 202   error = NULL;
 203   while (TRUE)
 204     {
 205       gsize length = -1;
 206       line = g_data_input_stream_read_line_utf8 (G_DATA_INPUT_STREAM (stream), &length, NULL, &error);
 207       if (n_lines == 0)
 208         g_assert_no_error (error);
 209       else
 210         {
 211           g_assert (error != NULL);
 212           g_clear_error (&error);
 213           g_free (line);
 214           break;
 215         }
 216       n_lines++;
 217       g_free (line);
 218     }
 219   g_assert_cmpint (n_lines, ==, 1);
 220
 221   g_object_unref (base_stream);
 222   g_object_unref (stream);
 223 }
 224
 225 static void
 226 test_read_until (void)
 227 {
 228   GInputStream *stream;
 229   GInputStream *base_stream;
 230   GError *error = NULL;
 231   char *data;
 232   int line;
 233   int i;
 234
 235 #define REPEATS                 10   /* number of rounds */
 236 #define DATA_STRING             " part1 # part2 $ part3 % part4 ^"
 237 #define DATA_PART_LEN           7    /* number of characters between separators */
 238 #define DATA_SEP                "#$%^"
 239 #define DATA_SEP_LEN            4
 240   const int DATA_PARTS_NUM = DATA_SEP_LEN * REPEATS;
 241
 242   base_stream = g_memory_input_stream_new ();
 243   stream = G_INPUT_STREAM (g_data_input_stream_new (base_stream));
 244
 245   for (i = 0; i < REPEATS; i++)
 246     g_memory_input_stream_add_data (G_MEMORY_INPUT_STREAM (base_stream), DATA_STRING, -1, NULL);
 247
 248   /*  Test stop characters */
 249   error = NULL;
 250   data = (char*)1;
 251   line = 0;
 252   while (data)
 253     {
 254       gsize length = -1;
 255       data = g_data_input_stream_read_until (G_DATA_INPUT_STREAM (stream), DATA_SEP, &length, NULL, &error);
 256       if (data)
 257         {
 258           g_assert_cmpint (strlen (data), ==, DATA_PART_LEN);
 259           g_free (data);
 260           g_assert_no_error (error);
 261           line++;
 262         }
 263     }
 264   g_assert_no_error (error);
 265   g_assert_cmpint (line, ==, DATA_PARTS_NUM);
 266
 267   g_object_unref (base_stream);
 268   g_object_unref (stream);
 269 }
 270
 271 static void
 272 test_read_upto (void)
 273 {
 274   GInputStream *stream;
 275   GInputStream *base_stream;
 276   GError *error = NULL;
 277   char *data;
 278   int line;
 279   int i;
 280   guchar stop_char;
 281
 282 #undef REPEATS
 283 #undef DATA_STRING
 284 #undef DATA_PART_LEN
 285 #undef DATA_SEP
 286 #undef DATA_SEP_LEN
 287 #define REPEATS                 10   /* number of rounds */
 288 #define DATA_STRING             " part1 # part2 $ part3 \0 part4 ^"
 289 #define DATA_PART_LEN           7    /* number of characters between separators */
 290 #define DATA_SEP                "#$\0^"
 291 #define DATA_SEP_LEN            4
 292   const int DATA_PARTS_NUM = DATA_SEP_LEN * REPEATS;
 293
 294   base_stream = g_memory_input_stream_new ();
 295   stream = G_INPUT_STREAM (g_data_input_stream_new (base_stream));
 296
 297   for (i = 0; i < REPEATS; i++)
 298     g_memory_input_stream_add_data (G_MEMORY_INPUT_STREAM (base_stream), DATA_STRING, 32, NULL);
 299
 300   /*  Test stop characters */
 301   error = NULL;
 302   data = (char*)1;
 303   line = 0;
 304   while (data)
 305     {
 306       gsize length = -1;
 307       data = g_data_input_stream_read_upto (G_DATA_INPUT_STREAM (stream), DATA_SEP, DATA_SEP_LEN, &length, NULL, &error);
 308       if (data)
 309         {
 310           g_assert_cmpint (strlen (data), ==, DATA_PART_LEN);
 311           g_assert_no_error (error);
 312           line++;
 313
 314           stop_char = g_data_input_stream_read_byte (G_DATA_INPUT_STREAM (stream), NULL, &error);
 315           g_assert (memchr (DATA_SEP, stop_char, DATA_SEP_LEN) != NULL);
 316           g_assert_no_error (error);
 317         }
 318       g_free (data);
 319     }
 320   g_assert_no_error (error);
 321   g_assert_cmpint (line, ==, DATA_PARTS_NUM);
 322
 323   g_object_unref (base_stream);
 324   g_object_unref (stream);
 325 }
 326 enum TestDataType {
 327   TEST_DATA_BYTE = 0,
 328   TEST_DATA_INT16,
 329   TEST_DATA_UINT16,
 330   TEST_DATA_INT32,
 331   TEST_DATA_UINT32,
 332   TEST_DATA_INT64,
 333   TEST_DATA_UINT64
 334 };
 335
 336 #define TEST_DATA_RETYPE_BUFF(a, t, v)  \
 337          (a == TEST_DATA_BYTE   ? (t) *(guchar*)v : \
 338          (a == TEST_DATA_INT16  ? (t) *(gint16*)v :      \
 339          (a == TEST_DATA_UINT16 ? (t) *(guint16*)v : \
 340          (a == TEST_DATA_INT32  ? (t) *(gint32*)v :      \
 341          (a == TEST_DATA_UINT32 ? (t) *(guint32*)v : \
 342          (a == TEST_DATA_INT64  ? (t) *(gint64*)v :      \
 343          (t) *(guint64*)v ))))))
 344
 345
 346 static void
 347 test_data_array (GInputStream *stream, GInputStream *base_stream,
 348                  gpointer buffer, int len,
 349                  enum TestDataType data_type, GDataStreamByteOrder byte_order)
 350 {
 351   GError *error = NULL;
 352   int pos = 0;
 353   int data_size = 1;
 354   gint64 data;
 355   GDataStreamByteOrder native;
 356   gboolean swap;
 357
 358   /*  Seek to start */
 359   test_seek_to_start (base_stream);
 360
 361   /*  Set correct data size */
 362   switch (data_type)
 363     {
 364     case TEST_DATA_BYTE:
 365       data_size = 1;
 366       break;
 367     case TEST_DATA_INT16:
 368     case TEST_DATA_UINT16:
 369       data_size = 2;
 370       break;
 371     case TEST_DATA_INT32:
 372     case TEST_DATA_UINT32:
 373       data_size = 4;
 374       break;
 375     case TEST_DATA_INT64:
 376     case TEST_DATA_UINT64:
 377       data_size = 8;
 378       break;
 379     default:
 380       g_assert_not_reached ();
 381       break;
 382     }
 383
 384   /*  Set flag to swap bytes if needed */
 385   native = (G_BYTE_ORDER == G_BIG_ENDIAN) ? G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN : G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
 386   swap = (byte_order != G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN) && (byte_order != native);
 387
 388   data = 1;
 389   while (data != 0)
 390     {
 391       switch (data_type)
 392         {
 393         case TEST_DATA_BYTE:
 394           data = g_data_input_stream_read_byte (G_DATA_INPUT_STREAM (stream), NULL, &error);
 395           break;
 396         case TEST_DATA_INT16:
 397           data = g_data_input_stream_read_int16 (G_DATA_INPUT_STREAM (stream), NULL, &error);
 398           if (swap)
 399             data = (gint16)GUINT16_SWAP_LE_BE((gint16)data);
 400           break;
 401         case TEST_DATA_UINT16:
 402           data = g_data_input_stream_read_uint16 (G_DATA_INPUT_STREAM (stream), NULL, &error);
 403           if (swap)
 404             data = (guint16)GUINT16_SWAP_LE_BE((guint16)data);
 405           break;
 406         case TEST_DATA_INT32:
 407           data = g_data_input_stream_read_int32 (G_DATA_INPUT_STREAM (stream), NULL, &error);
 408           if (swap)
 409             data = (gint32)GUINT32_SWAP_LE_BE((gint32)data);
 410           break;
 411         case TEST_DATA_UINT32:
 412           data = g_data_input_stream_read_uint32 (G_DATA_INPUT_STREAM (stream), NULL, &error);
 413           if (swap)
 414             data = (guint32)GUINT32_SWAP_LE_BE((guint32)data);
 415           break;
 416         case TEST_DATA_INT64:
 417           data = g_data_input_stream_read_int64 (G_DATA_INPUT_STREAM (stream), NULL, &error);
 418           if (swap)
 419             data = (gint64)GUINT64_SWAP_LE_BE((gint64)data);
 420           break;
 421         case TEST_DATA_UINT64:
 422           data = g_data_input_stream_read_uint64 (G_DATA_INPUT_STREAM (stream), NULL, &error);
 423           if (swap)
 424             data = (guint64)GUINT64_SWAP_LE_BE((guint64)data);
 425           break;
 426         default:
 427           g_assert_not_reached ();
 428           break;
 429         }
 430       if (!error)
 431         g_assert_cmpint (data, ==, TEST_DATA_RETYPE_BUFF(data_type, gint64, ((guchar*)buffer + pos)));
 432
 433       pos += data_size;
 434     }
 435   if (pos < len + 1)
 436     g_assert_no_error (error);
 437   if (error)
 438     g_error_free (error);
 439   g_assert_cmpint (pos - data_size, ==, len);
 440 }
 441
 442 static void
 443 test_read_int (void)
 444 {
 445   GInputStream *stream;
 446   GInputStream *base_stream;
 447   GRand *randomizer;
 448   int i;
 449   gpointer buffer;
 450
 451   randomizer = g_rand_new ();
 452   buffer = g_malloc0 (MAX_BYTES);
 453
 454   /*  Fill in some random data */
 455   for (i = 0; i < MAX_BYTES; i++)
 456     {
 457       guchar x = 0;
 458       while (! x)
 459         x = (guchar)g_rand_int (randomizer);
 460       *(guchar*)((guchar*)buffer + sizeof(guchar) * i) = x;
 461     }
 462
 463   base_stream = g_memory_input_stream_new ();
 464   stream = G_INPUT_STREAM (g_data_input_stream_new (base_stream));
 465   g_memory_input_stream_add_data (G_MEMORY_INPUT_STREAM (base_stream), buffer, MAX_BYTES, NULL);
 466
 467
 468   for (i = 0; i < 3; i++)
 469     {
 470       int j;
 471       g_data_input_stream_set_byte_order (G_DATA_INPUT_STREAM (stream), i);
 472
 473       for (j = 0; j <= TEST_DATA_UINT64; j++)
 474         test_data_array (stream, base_stream, buffer, MAX_BYTES, j, i);
 475     }
 476
 477   g_object_unref (base_stream);
 478   g_object_unref (stream);
 479   g_rand_free (randomizer);
 480   g_free (buffer);
 481 }
 482
 483
 484 int
 485 main (int   argc,
 486       char *argv[])
 487 {
 488   g_test_init (&argc, &argv, NULL);
 489
 490   g_test_add_func ("/data-input-stream/basic", test_basic);
 491   g_test_add_func ("/data-input-stream/read-lines-LF", test_read_lines_LF);
 492   g_test_add_func ("/data-input-stream/read-lines-LF-valid-utf8", test_read_lines_LF_valid_utf8);
 493   g_test_add_func ("/data-input-stream/read-lines-LF-invalid-utf8", test_read_lines_LF_invalid_utf8);
 494   g_test_add_func ("/data-input-stream/read-lines-CR", test_read_lines_CR);
 495   g_test_add_func ("/data-input-stream/read-lines-CR-LF", test_read_lines_CR_LF);
 496   g_test_add_func ("/data-input-stream/read-lines-any", test_read_lines_any);
 497   g_test_add_func ("/data-input-stream/read-until", test_read_until);
 498   g_test_add_func ("/data-input-stream/read-upto", test_read_upto);
 499   g_test_add_func ("/data-input-stream/read-int", test_read_int);
 500
 501   return g_test_run();
 502 }