1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-message-util.c Would be in dbus-message.c, but only used by bus/tests
4 * Copyright (C) 2002, 2003, 2004, 2005 Red Hat Inc.
5 * Copyright (C) 2002, 2003 CodeFactory AB
7 * Licensed under the Academic Free License version 2.1
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include "dbus-internals.h"
26 #include "dbus-test.h"
27 #include "dbus-message-private.h"
28 #include "dbus-marshal-recursive.h"
29 #include "dbus-string.h"
32 * @addtogroup DBusMessage
36 #ifdef DBUS_BUILD_TESTS
38 * Reads arguments from a message iterator given a variable argument
39 * list. Only arguments of basic type and arrays of fixed-length
40 * basic type may be read with this function. See
41 * dbus_message_get_args() for more details.
43 * @param iter the message iterator
44 * @param error error to be filled in on failure
45 * @param first_arg_type the first argument type
46 * @param ... location for first argument value, then list of type-location pairs
47 * @returns #FALSE if the error was set
50 dbus_message_iter_get_args (DBusMessageIter *iter,
58 _dbus_return_val_if_fail (iter != NULL, FALSE);
59 _dbus_return_val_if_error_is_set (error, FALSE);
61 va_start (var_args, first_arg_type);
62 retval = _dbus_message_iter_get_args_valist (iter, error, first_arg_type, var_args);
67 #endif /* DBUS_BUILD_TESTS */
71 #ifdef DBUS_BUILD_TESTS
72 #include "dbus-test.h"
73 #include "dbus-message-factory.h"
77 static int validities_seen[DBUS_VALIDITY_LAST + _DBUS_NEGATIVE_VALIDITY_COUNT];
80 reset_validities_seen (void)
84 while (i < _DBUS_N_ELEMENTS (validities_seen))
86 validities_seen[i] = 0;
92 record_validity_seen (DBusValidity validity)
94 validities_seen[validity + _DBUS_NEGATIVE_VALIDITY_COUNT] += 1;
98 print_validities_seen (dbus_bool_t not_seen)
102 while (i < _DBUS_N_ELEMENTS (validities_seen))
104 if ((i - _DBUS_NEGATIVE_VALIDITY_COUNT) == DBUS_VALIDITY_UNKNOWN ||
105 (i - _DBUS_NEGATIVE_VALIDITY_COUNT) == DBUS_INVALID_FOR_UNKNOWN_REASON)
107 else if ((not_seen && validities_seen[i] == 0) ||
108 (!not_seen && validities_seen[i] > 0))
109 printf ("validity %3d seen %d times\n",
110 i - _DBUS_NEGATIVE_VALIDITY_COUNT,
117 check_memleaks (void)
121 if (_dbus_get_malloc_blocks_outstanding () != 0)
123 _dbus_warn ("%d dbus_malloc blocks were not freed in %s\n",
124 _dbus_get_malloc_blocks_outstanding (), __FILE__);
125 _dbus_assert_not_reached ("memleaks");
130 check_have_valid_message (DBusMessageLoader *loader)
132 DBusMessage *message;
138 if (_dbus_message_loader_get_is_corrupted (loader))
140 _dbus_warn ("loader corrupted on message that was expected to be valid; invalid reason %d\n",
141 loader->corruption_reason);
145 message = _dbus_message_loader_pop_message (loader);
148 _dbus_warn ("didn't load message that was expected to be valid (message not popped)\n");
152 if (_dbus_string_get_length (&loader->data) > 0)
154 _dbus_warn ("had leftover bytes from expected-to-be-valid single message\n");
160 /* Verify that we're able to properly deal with the message.
161 * For example, this would detect improper handling of messages
162 * in nonstandard byte order.
164 if (!check_message_handling (message))
168 record_validity_seen (DBUS_VALID);
174 dbus_message_unref (message);
180 check_invalid_message (DBusMessageLoader *loader,
181 DBusValidity expected_validity)
187 if (!_dbus_message_loader_get_is_corrupted (loader))
189 _dbus_warn ("loader not corrupted on message that was expected to be invalid\n");
193 record_validity_seen (loader->corruption_reason);
195 if (expected_validity != DBUS_INVALID_FOR_UNKNOWN_REASON &&
196 loader->corruption_reason != expected_validity)
198 _dbus_warn ("expected message to be corrupted for reason %d and was corrupted for %d instead\n",
199 expected_validity, loader->corruption_reason);
210 check_incomplete_message (DBusMessageLoader *loader)
212 DBusMessage *message;
218 if (_dbus_message_loader_get_is_corrupted (loader))
220 _dbus_warn ("loader corrupted on message that was expected to be valid (but incomplete), corruption reason %d\n",
221 loader->corruption_reason);
225 message = _dbus_message_loader_pop_message (loader);
228 _dbus_warn ("loaded message that was expected to be incomplete\n");
232 record_validity_seen (DBUS_VALID_BUT_INCOMPLETE);
237 dbus_message_unref (message);
242 check_loader_results (DBusMessageLoader *loader,
243 DBusValidity expected_validity)
245 if (!_dbus_message_loader_queue_messages (loader))
246 _dbus_assert_not_reached ("no memory to queue messages");
248 if (expected_validity == DBUS_VALID)
249 return check_have_valid_message (loader);
250 else if (expected_validity == DBUS_VALID_BUT_INCOMPLETE)
251 return check_incomplete_message (loader);
252 else if (expected_validity == DBUS_VALIDITY_UNKNOWN)
254 /* here we just know we didn't segfault and that was the
255 * only test. Also, we record that we got coverage
256 * for the validity reason.
258 if (_dbus_message_loader_get_is_corrupted (loader))
259 record_validity_seen (loader->corruption_reason);
264 return check_invalid_message (loader, expected_validity);
268 * Loads the message in the given message file.
270 * @param filename filename to load
271 * @param data string to load message into
272 * @returns #TRUE if the message was loaded
275 dbus_internal_do_not_use_load_message_file (const DBusString *filename,
279 DBusError error = DBUS_ERROR_INIT;
283 _dbus_verbose ("Loading raw %s\n", _dbus_string_get_const_data (filename));
284 if (!_dbus_file_get_contents (data, filename, &error))
286 _dbus_warn ("Could not load message file %s: %s\n",
287 _dbus_string_get_const_data (filename),
289 dbus_error_free (&error);
301 * Tries loading the message in the given message file
302 * and verifies that DBusMessageLoader can handle it.
304 * @param filename filename to load
305 * @param expected_validity what the message has to be like to return #TRUE
306 * @returns #TRUE if the message has the expected validity
309 dbus_internal_do_not_use_try_message_file (const DBusString *filename,
310 DBusValidity expected_validity)
317 if (!_dbus_string_init (&data))
318 _dbus_assert_not_reached ("could not allocate string\n");
320 if (!dbus_internal_do_not_use_load_message_file (filename, &data))
323 retval = dbus_internal_do_not_use_try_message_data (&data, expected_validity);
329 if (_dbus_string_get_length (&data) > 0)
330 _dbus_verbose_bytes_of_string (&data, 0,
331 _dbus_string_get_length (&data));
333 _dbus_warn ("Failed message loader test on %s\n",
334 _dbus_string_get_const_data (filename));
337 _dbus_string_free (&data);
343 * Tries loading the given message data.
346 * @param data the message data
347 * @param expected_validity what the message has to be like to return #TRUE
348 * @returns #TRUE if the message has the expected validity
351 dbus_internal_do_not_use_try_message_data (const DBusString *data,
352 DBusValidity expected_validity)
354 DBusMessageLoader *loader;
362 /* Write the data one byte at a time */
364 loader = _dbus_message_loader_new ();
366 /* check some trivial loader functions */
367 _dbus_message_loader_ref (loader);
368 _dbus_message_loader_unref (loader);
369 _dbus_message_loader_get_max_message_size (loader);
371 len = _dbus_string_get_length (data);
372 for (i = 0; i < len; i++)
376 _dbus_message_loader_get_buffer (loader, &buffer);
377 _dbus_string_append_byte (buffer,
378 _dbus_string_get_byte (data, i));
379 _dbus_message_loader_return_buffer (loader, buffer, 1);
382 if (!check_loader_results (loader, expected_validity))
385 _dbus_message_loader_unref (loader);
388 /* Write the data all at once */
390 loader = _dbus_message_loader_new ();
395 _dbus_message_loader_get_buffer (loader, &buffer);
396 _dbus_string_copy (data, 0, buffer,
397 _dbus_string_get_length (buffer));
398 _dbus_message_loader_return_buffer (loader, buffer, 1);
401 if (!check_loader_results (loader, expected_validity))
404 _dbus_message_loader_unref (loader);
407 /* Write the data 2 bytes at a time */
409 loader = _dbus_message_loader_new ();
411 len = _dbus_string_get_length (data);
412 for (i = 0; i < len; i += 2)
416 _dbus_message_loader_get_buffer (loader, &buffer);
417 _dbus_string_append_byte (buffer,
418 _dbus_string_get_byte (data, i));
420 _dbus_string_append_byte (buffer,
421 _dbus_string_get_byte (data, i+1));
422 _dbus_message_loader_return_buffer (loader, buffer, 1);
425 if (!check_loader_results (loader, expected_validity))
428 _dbus_message_loader_unref (loader);
436 _dbus_message_loader_unref (loader);
442 process_test_subdir (const DBusString *test_base_dir,
444 DBusValidity expected_validity,
445 DBusForeachMessageFileFunc function,
448 DBusString test_directory;
452 DBusError error = DBUS_ERROR_INIT;
457 if (!_dbus_string_init (&test_directory))
458 _dbus_assert_not_reached ("didn't allocate test_directory\n");
460 _dbus_string_init_const (&filename, subdir);
462 if (!_dbus_string_copy (test_base_dir, 0,
464 _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
466 if (!_dbus_concat_dir_and_file (&test_directory, &filename))
467 _dbus_assert_not_reached ("couldn't allocate full path");
469 _dbus_string_free (&filename);
470 if (!_dbus_string_init (&filename))
471 _dbus_assert_not_reached ("didn't allocate filename string\n");
473 dir = _dbus_directory_open (&test_directory, &error);
476 _dbus_warn ("Could not open %s: %s\n",
477 _dbus_string_get_const_data (&test_directory),
479 dbus_error_free (&error);
483 printf ("Testing %s:\n", subdir);
486 while (_dbus_directory_get_next_file (dir, &filename, &error))
488 DBusString full_path;
490 if (!_dbus_string_init (&full_path))
491 _dbus_assert_not_reached ("couldn't init string");
493 if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
494 _dbus_assert_not_reached ("couldn't copy dir to full_path");
496 if (!_dbus_concat_dir_and_file (&full_path, &filename))
497 _dbus_assert_not_reached ("couldn't concat file to dir");
499 if (_dbus_string_ends_with_c_str (&filename, ".message-raw"))
503 if (_dbus_string_ends_with_c_str (&filename, ".message"))
505 _dbus_warn ("Could not load %s, message builder language no longer supported\n",
506 _dbus_string_get_const_data (&filename));
509 _dbus_verbose ("Skipping non-.message file %s\n",
510 _dbus_string_get_const_data (&filename));
511 _dbus_string_free (&full_path);
516 _dbus_string_get_const_data (&filename));
518 if (! (*function) (&full_path,
519 expected_validity, user_data))
521 _dbus_string_free (&full_path);
525 _dbus_string_free (&full_path);
528 if (dbus_error_is_set (&error))
530 _dbus_warn ("Could not get next file in %s: %s\n",
531 _dbus_string_get_const_data (&test_directory),
533 dbus_error_free (&error);
542 _dbus_directory_close (dir);
543 _dbus_string_free (&test_directory);
544 _dbus_string_free (&filename);
550 * Runs the given function on every message file in the test suite.
551 * The function should return #FALSE on test failure or fatal error.
553 * @param test_data_dir root dir of the test suite data files (top_srcdir/test/data)
554 * @param func the function to run
555 * @param user_data data for function
556 * @returns #FALSE if there's a failure
559 dbus_internal_do_not_use_foreach_message_file (const char *test_data_dir,
560 DBusForeachMessageFileFunc func,
563 DBusString test_directory;
568 _dbus_string_init_const (&test_directory, test_data_dir);
570 if (!process_test_subdir (&test_directory, "valid-messages",
571 DBUS_VALID, func, user_data))
576 if (!process_test_subdir (&test_directory, "invalid-messages",
577 DBUS_INVALID_FOR_UNKNOWN_REASON, func, user_data))
582 if (!process_test_subdir (&test_directory, "incomplete-messages",
583 DBUS_VALID_BUT_INCOMPLETE, func, user_data))
592 _dbus_string_free (&test_directory);
598 #define GET_AND_CHECK(iter, typename, literal) \
600 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_##typename) \
601 _dbus_assert_not_reached ("got wrong argument type from message iter"); \
602 dbus_message_iter_get_basic (&iter, &v_##typename); \
603 if (v_##typename != literal) \
604 _dbus_assert_not_reached ("got wrong value from message iter"); \
607 #define GET_AND_CHECK_STRCMP(iter, typename, literal) \
609 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_##typename) \
610 _dbus_assert_not_reached ("got wrong argument type from message iter"); \
611 dbus_message_iter_get_basic (&iter, &v_##typename); \
612 if (strcmp (v_##typename, literal) != 0) \
613 _dbus_assert_not_reached ("got wrong value from message iter"); \
616 #define GET_AND_CHECK_AND_NEXT(iter, typename, literal) \
618 GET_AND_CHECK(iter, typename, literal); \
619 if (!dbus_message_iter_next (&iter)) \
620 _dbus_assert_not_reached ("failed to move iter to next"); \
623 #define GET_AND_CHECK_STRCMP_AND_NEXT(iter, typename, literal) \
625 GET_AND_CHECK_STRCMP(iter, typename, literal); \
626 if (!dbus_message_iter_next (&iter)) \
627 _dbus_assert_not_reached ("failed to move iter to next"); \
631 message_iter_test (DBusMessage *message)
633 DBusMessageIter iter, array, array2;
634 const char *v_STRING;
636 dbus_int16_t v_INT16;
637 dbus_uint16_t v_UINT16;
638 dbus_int32_t v_INT32;
639 dbus_uint32_t v_UINT32;
640 #ifdef DBUS_HAVE_INT64
641 dbus_int64_t v_INT64;
642 dbus_uint64_t v_UINT64;
644 unsigned char v_BYTE;
645 dbus_bool_t v_BOOLEAN;
647 const dbus_int32_t *our_int_array;
650 dbus_message_iter_init (message, &iter);
652 GET_AND_CHECK_STRCMP_AND_NEXT (iter, STRING, "Test string");
653 GET_AND_CHECK_AND_NEXT (iter, INT32, -0x12345678);
654 GET_AND_CHECK_AND_NEXT (iter, UINT32, 0xedd1e);
655 GET_AND_CHECK_AND_NEXT (iter, DOUBLE, 3.14159);
657 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_ARRAY)
658 _dbus_assert_not_reached ("Argument type not an array");
660 if (dbus_message_iter_get_element_type (&iter) != DBUS_TYPE_DOUBLE)
661 _dbus_assert_not_reached ("Array type not double");
663 dbus_message_iter_recurse (&iter, &array);
665 GET_AND_CHECK_AND_NEXT (array, DOUBLE, 1.5);
666 GET_AND_CHECK (array, DOUBLE, 2.5);
668 if (dbus_message_iter_next (&array))
669 _dbus_assert_not_reached ("Didn't reach end of array");
671 if (!dbus_message_iter_next (&iter))
672 _dbus_assert_not_reached ("Reached end of arguments");
674 GET_AND_CHECK_AND_NEXT (iter, BYTE, 0xF0);
676 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_ARRAY)
677 _dbus_assert_not_reached ("no array");
679 if (dbus_message_iter_get_element_type (&iter) != DBUS_TYPE_INT32)
680 _dbus_assert_not_reached ("Array type not int32");
683 dbus_message_iter_recurse (&iter, &array);
685 if (dbus_message_iter_next (&array))
686 _dbus_assert_not_reached ("Didn't reach end of array");
688 if (!dbus_message_iter_next (&iter))
689 _dbus_assert_not_reached ("Reached end of arguments");
691 GET_AND_CHECK (iter, BYTE, 0xF0);
693 if (dbus_message_iter_next (&iter))
694 _dbus_assert_not_reached ("Didn't reach end of arguments");
699 verify_test_message (DBusMessage *message)
701 DBusMessageIter iter;
702 DBusError error = DBUS_ERROR_INIT;
703 dbus_int16_t our_int16;
704 dbus_uint16_t our_uint16;
705 dbus_int32_t our_int;
706 dbus_uint32_t our_uint;
710 dbus_bool_t our_bool;
711 unsigned char our_byte_1, our_byte_2;
712 const dbus_uint32_t *our_uint32_array = (void*)0xdeadbeef;
713 int our_uint32_array_len;
714 dbus_int32_t *our_int32_array = (void*)0xdeadbeef;
715 int our_int32_array_len;
716 #ifdef DBUS_HAVE_INT64
717 dbus_int64_t our_int64;
718 dbus_uint64_t our_uint64;
719 dbus_int64_t *our_uint64_array = (void*)0xdeadbeef;
720 int our_uint64_array_len;
721 const dbus_int64_t *our_int64_array = (void*)0xdeadbeef;
722 int our_int64_array_len;
724 const double *our_double_array = (void*)0xdeadbeef;
725 int our_double_array_len;
726 const unsigned char *our_byte_array = (void*)0xdeadbeef;
727 int our_byte_array_len;
728 const dbus_bool_t *our_boolean_array = (void*)0xdeadbeef;
729 int our_boolean_array_len;
730 char **our_string_array;
731 int our_string_array_len;
733 dbus_message_iter_init (message, &iter);
735 if (!dbus_message_iter_get_args (&iter, &error,
736 DBUS_TYPE_INT16, &our_int16,
737 DBUS_TYPE_UINT16, &our_uint16,
738 DBUS_TYPE_INT32, &our_int,
739 DBUS_TYPE_UINT32, &our_uint,
740 #ifdef DBUS_HAVE_INT64
741 DBUS_TYPE_INT64, &our_int64,
742 DBUS_TYPE_UINT64, &our_uint64,
744 DBUS_TYPE_STRING, &our_str,
745 DBUS_TYPE_DOUBLE, &our_double,
746 DBUS_TYPE_BOOLEAN, &our_bool,
747 DBUS_TYPE_BYTE, &our_byte_1,
748 DBUS_TYPE_BYTE, &our_byte_2,
749 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32,
750 &our_uint32_array, &our_uint32_array_len,
751 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32,
752 &our_int32_array, &our_int32_array_len,
753 #ifdef DBUS_HAVE_INT64
754 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64,
755 &our_uint64_array, &our_uint64_array_len,
756 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64,
757 &our_int64_array, &our_int64_array_len,
759 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE,
760 &our_double_array, &our_double_array_len,
761 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE,
762 &our_byte_array, &our_byte_array_len,
763 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN,
764 &our_boolean_array, &our_boolean_array_len,
765 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING,
766 &our_string_array, &our_string_array_len,
769 _dbus_warn ("error: %s - %s\n", error.name,
770 (error.message != NULL) ? error.message : "no message");
771 _dbus_assert_not_reached ("Could not get arguments");
774 if (our_int16 != -0x123)
775 _dbus_assert_not_reached ("16-bit integers differ!");
777 if (our_uint16 != 0x123)
778 _dbus_assert_not_reached ("16-bit uints differ!");
780 if (our_int != -0x12345678)
781 _dbus_assert_not_reached ("integers differ!");
783 if (our_uint != 0x12300042)
784 _dbus_assert_not_reached ("uints differ!");
786 #ifdef DBUS_HAVE_INT64
787 if (our_int64 != DBUS_INT64_CONSTANT (-0x123456789abcd))
788 _dbus_assert_not_reached ("64-bit integers differ!");
789 if (our_uint64 != DBUS_UINT64_CONSTANT (0x123456789abcd))
790 _dbus_assert_not_reached ("64-bit unsigned integers differ!");
794 if (! _DBUS_DOUBLES_BITWISE_EQUAL (our_double, v_DOUBLE))
795 _dbus_assert_not_reached ("doubles differ!");
797 if (strcmp (our_str, "Test string") != 0)
798 _dbus_assert_not_reached ("strings differ!");
801 _dbus_assert_not_reached ("booleans differ");
803 if (our_byte_1 != 42)
804 _dbus_assert_not_reached ("bytes differ!");
806 if (our_byte_2 != 24)
807 _dbus_assert_not_reached ("bytes differ!");
809 if (our_uint32_array_len != 4 ||
810 our_uint32_array[0] != 0x12345678 ||
811 our_uint32_array[1] != 0x23456781 ||
812 our_uint32_array[2] != 0x34567812 ||
813 our_uint32_array[3] != 0x45678123)
814 _dbus_assert_not_reached ("uint array differs");
816 if (our_int32_array_len != 4 ||
817 our_int32_array[0] != 0x12345678 ||
818 our_int32_array[1] != -0x23456781 ||
819 our_int32_array[2] != 0x34567812 ||
820 our_int32_array[3] != -0x45678123)
821 _dbus_assert_not_reached ("int array differs");
823 #ifdef DBUS_HAVE_INT64
824 if (our_uint64_array_len != 4 ||
825 our_uint64_array[0] != 0x12345678 ||
826 our_uint64_array[1] != 0x23456781 ||
827 our_uint64_array[2] != 0x34567812 ||
828 our_uint64_array[3] != 0x45678123)
829 _dbus_assert_not_reached ("uint64 array differs");
831 if (our_int64_array_len != 4 ||
832 our_int64_array[0] != 0x12345678 ||
833 our_int64_array[1] != -0x23456781 ||
834 our_int64_array[2] != 0x34567812 ||
835 our_int64_array[3] != -0x45678123)
836 _dbus_assert_not_reached ("int64 array differs");
837 #endif /* DBUS_HAVE_INT64 */
839 if (our_double_array_len != 3)
840 _dbus_assert_not_reached ("double array had wrong length");
842 /* On all IEEE machines (i.e. everything sane) exact equality
843 * should be preserved over the wire
846 if (! _DBUS_DOUBLES_BITWISE_EQUAL (our_double_array[0], v_DOUBLE))
847 _dbus_assert_not_reached ("double array had wrong values");
848 v_DOUBLE = 9876.54321;
849 if (! _DBUS_DOUBLES_BITWISE_EQUAL (our_double_array[1], v_DOUBLE))
850 _dbus_assert_not_reached ("double array had wrong values");
852 if (! _DBUS_DOUBLES_BITWISE_EQUAL (our_double_array[2], v_DOUBLE))
853 _dbus_assert_not_reached ("double array had wrong values");
855 if (our_byte_array_len != 4)
856 _dbus_assert_not_reached ("byte array had wrong length");
858 if (our_byte_array[0] != 'a' ||
859 our_byte_array[1] != 'b' ||
860 our_byte_array[2] != 'c' ||
861 our_byte_array[3] != 234)
862 _dbus_assert_not_reached ("byte array had wrong values");
864 if (our_boolean_array_len != 5)
865 _dbus_assert_not_reached ("bool array had wrong length");
867 if (our_boolean_array[0] != TRUE ||
868 our_boolean_array[1] != FALSE ||
869 our_boolean_array[2] != TRUE ||
870 our_boolean_array[3] != TRUE ||
871 our_boolean_array[4] != FALSE)
872 _dbus_assert_not_reached ("bool array had wrong values");
874 if (our_string_array_len != 4)
875 _dbus_assert_not_reached ("string array was wrong length");
877 if (strcmp (our_string_array[0], "Foo") != 0 ||
878 strcmp (our_string_array[1], "bar") != 0 ||
879 strcmp (our_string_array[2], "") != 0 ||
880 strcmp (our_string_array[3], "woo woo woo woo") != 0)
881 _dbus_assert_not_reached ("string array had wrong values");
883 dbus_free_string_array (our_string_array);
885 if (dbus_message_iter_next (&iter))
886 _dbus_assert_not_reached ("Didn't reach end of arguments");
890 * @ingroup DBusMessageInternals
891 * Unit test for DBusMessage.
893 * @returns #TRUE on success.
896 _dbus_message_test (const char *test_data_dir)
898 DBusMessage *message;
899 DBusMessageLoader *loader;
905 const dbus_uint32_t our_uint32_array[] =
906 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
907 const dbus_int32_t our_int32_array[] =
908 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
909 const dbus_uint32_t *v_ARRAY_UINT32 = our_uint32_array;
910 const dbus_int32_t *v_ARRAY_INT32 = our_int32_array;
911 #ifdef DBUS_HAVE_INT64
912 const dbus_uint64_t our_uint64_array[] =
913 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
914 const dbus_int64_t our_int64_array[] =
915 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
916 const dbus_uint64_t *v_ARRAY_UINT64 = our_uint64_array;
917 const dbus_int64_t *v_ARRAY_INT64 = our_int64_array;
919 const char *our_string_array[] = { "Foo", "bar", "", "woo woo woo woo" };
920 const char **v_ARRAY_STRING = our_string_array;
921 const double our_double_array[] = { 0.1234, 9876.54321, -300.0 };
922 const double *v_ARRAY_DOUBLE = our_double_array;
923 const unsigned char our_byte_array[] = { 'a', 'b', 'c', 234 };
924 const unsigned char *v_ARRAY_BYTE = our_byte_array;
925 const dbus_bool_t our_boolean_array[] = { TRUE, FALSE, TRUE, TRUE, FALSE };
926 const dbus_bool_t *v_ARRAY_BOOLEAN = our_boolean_array;
929 const char *v_STRING;
931 dbus_int16_t v_INT16;
932 dbus_uint16_t v_UINT16;
933 dbus_int32_t v_INT32;
934 dbus_uint32_t v_UINT32;
935 #ifdef DBUS_HAVE_INT64
936 dbus_int64_t v_INT64;
937 dbus_uint64_t v_UINT64;
939 unsigned char v_BYTE;
940 unsigned char v2_BYTE;
941 dbus_bool_t v_BOOLEAN;
942 DBusMessageIter iter, array_iter, struct_iter;
944 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
945 "/org/freedesktop/TestPath",
948 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.TestService"));
949 _dbus_assert (dbus_message_is_method_call (message, "Foo.TestInterface",
951 _dbus_assert (strcmp (dbus_message_get_path (message),
952 "/org/freedesktop/TestPath") == 0);
953 dbus_message_set_serial (message, 1234);
955 /* string length including nul byte not a multiple of 4 */
956 if (!dbus_message_set_sender (message, "org.foo.bar1"))
957 _dbus_assert_not_reached ("out of memory");
959 _dbus_assert (dbus_message_has_sender (message, "org.foo.bar1"));
960 dbus_message_set_reply_serial (message, 5678);
962 _dbus_verbose_bytes_of_string (&message->header.data, 0,
963 _dbus_string_get_length (&message->header.data));
964 _dbus_verbose_bytes_of_string (&message->body, 0,
965 _dbus_string_get_length (&message->body));
967 if (!dbus_message_set_sender (message, NULL))
968 _dbus_assert_not_reached ("out of memory");
971 _dbus_verbose_bytes_of_string (&message->header.data, 0,
972 _dbus_string_get_length (&message->header.data));
973 _dbus_verbose_bytes_of_string (&message->body, 0,
974 _dbus_string_get_length (&message->body));
977 _dbus_assert (!dbus_message_has_sender (message, "org.foo.bar1"));
978 _dbus_assert (dbus_message_get_serial (message) == 1234);
979 _dbus_assert (dbus_message_get_reply_serial (message) == 5678);
980 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.TestService"));
982 _dbus_assert (dbus_message_get_no_reply (message) == FALSE);
983 dbus_message_set_no_reply (message, TRUE);
984 _dbus_assert (dbus_message_get_no_reply (message) == TRUE);
985 dbus_message_set_no_reply (message, FALSE);
986 _dbus_assert (dbus_message_get_no_reply (message) == FALSE);
988 /* Set/get some header fields */
990 if (!dbus_message_set_path (message, "/foo"))
991 _dbus_assert_not_reached ("out of memory");
992 _dbus_assert (strcmp (dbus_message_get_path (message),
995 if (!dbus_message_set_interface (message, "org.Foo"))
996 _dbus_assert_not_reached ("out of memory");
997 _dbus_assert (strcmp (dbus_message_get_interface (message),
1000 if (!dbus_message_set_member (message, "Bar"))
1001 _dbus_assert_not_reached ("out of memory");
1002 _dbus_assert (strcmp (dbus_message_get_member (message),
1005 /* Set/get them with longer values */
1006 if (!dbus_message_set_path (message, "/foo/bar"))
1007 _dbus_assert_not_reached ("out of memory");
1008 _dbus_assert (strcmp (dbus_message_get_path (message),
1011 if (!dbus_message_set_interface (message, "org.Foo.Bar"))
1012 _dbus_assert_not_reached ("out of memory");
1013 _dbus_assert (strcmp (dbus_message_get_interface (message),
1014 "org.Foo.Bar") == 0);
1016 if (!dbus_message_set_member (message, "BarFoo"))
1017 _dbus_assert_not_reached ("out of memory");
1018 _dbus_assert (strcmp (dbus_message_get_member (message),
1021 /* Realloc shorter again */
1023 if (!dbus_message_set_path (message, "/foo"))
1024 _dbus_assert_not_reached ("out of memory");
1025 _dbus_assert (strcmp (dbus_message_get_path (message),
1028 if (!dbus_message_set_interface (message, "org.Foo"))
1029 _dbus_assert_not_reached ("out of memory");
1030 _dbus_assert (strcmp (dbus_message_get_interface (message),
1033 if (!dbus_message_set_member (message, "Bar"))
1034 _dbus_assert_not_reached ("out of memory");
1035 _dbus_assert (strcmp (dbus_message_get_member (message),
1038 dbus_message_unref (message);
1040 /* Test the vararg functions */
1041 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
1042 "/org/freedesktop/TestPath",
1043 "Foo.TestInterface",
1045 dbus_message_set_serial (message, 1);
1046 dbus_message_set_reply_serial (message, 5678);
1050 v_INT32 = -0x12345678;
1051 v_UINT32 = 0x12300042;
1052 #ifdef DBUS_HAVE_INT64
1053 v_INT64 = DBUS_INT64_CONSTANT (-0x123456789abcd);
1054 v_UINT64 = DBUS_UINT64_CONSTANT (0x123456789abcd);
1056 v_STRING = "Test string";
1062 dbus_message_append_args (message,
1063 DBUS_TYPE_INT16, &v_INT16,
1064 DBUS_TYPE_UINT16, &v_UINT16,
1065 DBUS_TYPE_INT32, &v_INT32,
1066 DBUS_TYPE_UINT32, &v_UINT32,
1067 #ifdef DBUS_HAVE_INT64
1068 DBUS_TYPE_INT64, &v_INT64,
1069 DBUS_TYPE_UINT64, &v_UINT64,
1071 DBUS_TYPE_STRING, &v_STRING,
1072 DBUS_TYPE_DOUBLE, &v_DOUBLE,
1073 DBUS_TYPE_BOOLEAN, &v_BOOLEAN,
1074 DBUS_TYPE_BYTE, &v_BYTE,
1075 DBUS_TYPE_BYTE, &v2_BYTE,
1076 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32, &v_ARRAY_UINT32,
1077 _DBUS_N_ELEMENTS (our_uint32_array),
1078 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32, &v_ARRAY_INT32,
1079 _DBUS_N_ELEMENTS (our_int32_array),
1080 #ifdef DBUS_HAVE_INT64
1081 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64, &v_ARRAY_UINT64,
1082 _DBUS_N_ELEMENTS (our_uint64_array),
1083 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64, &v_ARRAY_INT64,
1084 _DBUS_N_ELEMENTS (our_int64_array),
1086 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE, &v_ARRAY_DOUBLE,
1087 _DBUS_N_ELEMENTS (our_double_array),
1088 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE, &v_ARRAY_BYTE,
1089 _DBUS_N_ELEMENTS (our_byte_array),
1090 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN, &v_ARRAY_BOOLEAN,
1091 _DBUS_N_ELEMENTS (our_boolean_array),
1092 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING, &v_ARRAY_STRING,
1093 _DBUS_N_ELEMENTS (our_string_array),
1097 sig[i++] = DBUS_TYPE_INT16;
1098 sig[i++] = DBUS_TYPE_UINT16;
1099 sig[i++] = DBUS_TYPE_INT32;
1100 sig[i++] = DBUS_TYPE_UINT32;
1101 #ifdef DBUS_HAVE_INT64
1102 sig[i++] = DBUS_TYPE_INT64;
1103 sig[i++] = DBUS_TYPE_UINT64;
1105 sig[i++] = DBUS_TYPE_STRING;
1106 sig[i++] = DBUS_TYPE_DOUBLE;
1107 sig[i++] = DBUS_TYPE_BOOLEAN;
1108 sig[i++] = DBUS_TYPE_BYTE;
1109 sig[i++] = DBUS_TYPE_BYTE;
1110 sig[i++] = DBUS_TYPE_ARRAY;
1111 sig[i++] = DBUS_TYPE_UINT32;
1112 sig[i++] = DBUS_TYPE_ARRAY;
1113 sig[i++] = DBUS_TYPE_INT32;
1114 #ifdef DBUS_HAVE_INT64
1115 sig[i++] = DBUS_TYPE_ARRAY;
1116 sig[i++] = DBUS_TYPE_UINT64;
1117 sig[i++] = DBUS_TYPE_ARRAY;
1118 sig[i++] = DBUS_TYPE_INT64;
1120 sig[i++] = DBUS_TYPE_ARRAY;
1121 sig[i++] = DBUS_TYPE_DOUBLE;
1122 sig[i++] = DBUS_TYPE_ARRAY;
1123 sig[i++] = DBUS_TYPE_BYTE;
1124 sig[i++] = DBUS_TYPE_ARRAY;
1125 sig[i++] = DBUS_TYPE_BOOLEAN;
1126 sig[i++] = DBUS_TYPE_ARRAY;
1127 sig[i++] = DBUS_TYPE_STRING;
1128 sig[i++] = DBUS_TYPE_INVALID;
1130 _dbus_assert (i < (int) _DBUS_N_ELEMENTS (sig));
1132 _dbus_verbose ("HEADER\n");
1133 _dbus_verbose_bytes_of_string (&message->header.data, 0,
1134 _dbus_string_get_length (&message->header.data));
1135 _dbus_verbose ("BODY\n");
1136 _dbus_verbose_bytes_of_string (&message->body, 0,
1137 _dbus_string_get_length (&message->body));
1139 _dbus_verbose ("Signature expected \"%s\" actual \"%s\"\n",
1140 sig, dbus_message_get_signature (message));
1142 s = dbus_message_get_signature (message);
1144 _dbus_assert (dbus_message_has_signature (message, sig));
1145 _dbus_assert (strcmp (s, sig) == 0);
1147 verify_test_message (message);
1149 copy = dbus_message_copy (message);
1151 _dbus_assert (dbus_message_get_reply_serial (message) ==
1152 dbus_message_get_reply_serial (copy));
1153 _dbus_assert (message->header.padding == copy->header.padding);
1155 _dbus_assert (_dbus_string_get_length (&message->header.data) ==
1156 _dbus_string_get_length (©->header.data));
1158 _dbus_assert (_dbus_string_get_length (&message->body) ==
1159 _dbus_string_get_length (©->body));
1161 verify_test_message (copy);
1163 name1 = dbus_message_get_interface (message);
1164 name2 = dbus_message_get_interface (copy);
1166 _dbus_assert (strcmp (name1, name2) == 0);
1168 name1 = dbus_message_get_member (message);
1169 name2 = dbus_message_get_member (copy);
1171 _dbus_assert (strcmp (name1, name2) == 0);
1173 dbus_message_unref (copy);
1175 /* Message loader test */
1176 dbus_message_lock (message);
1177 loader = _dbus_message_loader_new ();
1179 /* check ref/unref */
1180 _dbus_message_loader_ref (loader);
1181 _dbus_message_loader_unref (loader);
1183 /* Write the header data one byte at a time */
1184 data = _dbus_string_get_const_data (&message->header.data);
1185 for (i = 0; i < _dbus_string_get_length (&message->header.data); i++)
1189 _dbus_message_loader_get_buffer (loader, &buffer);
1190 _dbus_string_append_byte (buffer, data[i]);
1191 _dbus_message_loader_return_buffer (loader, buffer, 1);
1194 /* Write the body data one byte at a time */
1195 data = _dbus_string_get_const_data (&message->body);
1196 for (i = 0; i < _dbus_string_get_length (&message->body); i++)
1200 _dbus_message_loader_get_buffer (loader, &buffer);
1201 _dbus_string_append_byte (buffer, data[i]);
1202 _dbus_message_loader_return_buffer (loader, buffer, 1);
1205 dbus_message_unref (message);
1207 /* Now pop back the message */
1208 if (!_dbus_message_loader_queue_messages (loader))
1209 _dbus_assert_not_reached ("no memory to queue messages");
1211 if (_dbus_message_loader_get_is_corrupted (loader))
1212 _dbus_assert_not_reached ("message loader corrupted");
1214 message = _dbus_message_loader_pop_message (loader);
1216 _dbus_assert_not_reached ("received a NULL message");
1218 if (dbus_message_get_reply_serial (message) != 5678)
1219 _dbus_assert_not_reached ("reply serial fields differ");
1221 verify_test_message (message);
1224 /* Marshal and demarshal the message. */
1226 DBusMessage *message2;
1227 DBusError error = DBUS_ERROR_INIT;
1228 char *marshalled = NULL;
1230 char garbage_header[DBUS_MINIMUM_HEADER_SIZE] = "xxx";
1232 if (!dbus_message_marshal (message, &marshalled, &len))
1233 _dbus_assert_not_reached ("failed to marshal message");
1235 _dbus_assert (len != 0);
1236 _dbus_assert (marshalled != NULL);
1238 _dbus_assert (dbus_message_demarshal_bytes_needed (marshalled, len) == len);
1239 message2 = dbus_message_demarshal (marshalled, len, &error);
1241 _dbus_assert (message2 != NULL);
1242 _dbus_assert (!dbus_error_is_set (&error));
1243 verify_test_message (message2);
1245 dbus_message_unref (message2);
1246 dbus_free (marshalled);
1248 /* Demarshal invalid message. */
1250 message2 = dbus_message_demarshal ("invalid", 7, &error);
1251 _dbus_assert (message2 == NULL);
1252 _dbus_assert (dbus_error_is_set (&error));
1253 dbus_error_free (&error);
1255 /* Demarshal invalid (empty) message. */
1257 message2 = dbus_message_demarshal ("", 0, &error);
1258 _dbus_assert (message2 == NULL);
1259 _dbus_assert (dbus_error_is_set (&error));
1260 dbus_error_free (&error);
1262 /* Bytes needed to demarshal empty message: 0 (more) */
1264 _dbus_assert (dbus_message_demarshal_bytes_needed ("", 0) == 0);
1266 /* Bytes needed to demarshal invalid message: -1 (error). */
1268 _dbus_assert (dbus_message_demarshal_bytes_needed (garbage_header, DBUS_MINIMUM_HEADER_SIZE) == -1);
1271 dbus_message_unref (message);
1272 _dbus_message_loader_unref (loader);
1276 /* Check that we can abandon a container */
1277 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
1278 "/org/freedesktop/TestPath",
1279 "Foo.TestInterface",
1282 dbus_message_iter_init_append (message, &iter);
1284 _dbus_assert (dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
1285 (DBUS_STRUCT_BEGIN_CHAR_AS_STRING
1286 DBUS_TYPE_STRING_AS_STRING
1287 DBUS_TYPE_STRING_AS_STRING
1288 DBUS_STRUCT_END_CHAR_AS_STRING),
1290 _dbus_assert (dbus_message_iter_open_container (&array_iter, DBUS_TYPE_STRUCT,
1291 NULL, &struct_iter));
1294 _dbus_assert (dbus_message_iter_append_basic (&struct_iter, DBUS_TYPE_STRING,
1297 /* uh-oh, error, try and unwind */
1299 _dbus_assert (dbus_message_iter_close_container (&array_iter, &struct_iter));
1300 _dbus_assert (dbus_message_iter_close_container (&array_iter, &iter));
1302 dbus_message_unref (message);
1304 /* Load all the sample messages from the message factory */
1306 DBusMessageDataIter diter;
1307 DBusMessageData mdata;
1310 reset_validities_seen ();
1313 _dbus_message_data_iter_init (&diter);
1315 while (_dbus_message_data_iter_get_and_next (&diter,
1318 if (!dbus_internal_do_not_use_try_message_data (&mdata.data,
1319 mdata.expected_validity))
1321 _dbus_warn ("expected validity %d and did not get it\n",
1322 mdata.expected_validity);
1323 _dbus_assert_not_reached ("message data failed");
1326 _dbus_message_data_free (&mdata);
1331 printf ("%d sample messages tested\n", count);
1333 print_validities_seen (FALSE);
1334 print_validities_seen (TRUE);
1339 /* Now load every message in test_data_dir if we have one */
1340 if (test_data_dir == NULL)
1343 return dbus_internal_do_not_use_foreach_message_file (test_data_dir,
1344 (DBusForeachMessageFileFunc)
1345 dbus_internal_do_not_use_try_message_file,
1349 #endif /* DBUS_BUILD_TESTS */