1 /* -*- mode: C; c-file-style: "gnu" -*- */
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 * @todo this is static for now because there's no corresponding
44 * iter_append_args() and I'm not sure we need this function to be
45 * public since dbus_message_get_args() is what you usually want
47 * @param iter the message iterator
48 * @param error error to be filled in on failure
49 * @param first_arg_type the first argument type
50 * @param ... location for first argument value, then list of type-location pairs
51 * @returns #FALSE if the error was set
54 dbus_message_iter_get_args (DBusMessageIter *iter,
62 _dbus_return_val_if_fail (iter != NULL, FALSE);
63 _dbus_return_val_if_error_is_set (error, FALSE);
65 va_start (var_args, first_arg_type);
66 retval = _dbus_message_iter_get_args_valist (iter, error, first_arg_type, var_args);
71 #endif /* DBUS_BUILD_TESTS */
75 #ifdef DBUS_BUILD_TESTS
76 #include "dbus-test.h"
77 #include "dbus-message-factory.h"
81 static int validities_seen[DBUS_VALIDITY_LAST + _DBUS_NEGATIVE_VALIDITY_COUNT];
84 reset_validities_seen (void)
88 while (i < _DBUS_N_ELEMENTS (validities_seen))
90 validities_seen[i] = 0;
96 record_validity_seen (DBusValidity validity)
98 validities_seen[validity + _DBUS_NEGATIVE_VALIDITY_COUNT] += 1;
102 print_validities_seen (dbus_bool_t not_seen)
106 while (i < _DBUS_N_ELEMENTS (validities_seen))
108 if ((i - _DBUS_NEGATIVE_VALIDITY_COUNT) == DBUS_VALIDITY_UNKNOWN ||
109 (i - _DBUS_NEGATIVE_VALIDITY_COUNT) == DBUS_INVALID_FOR_UNKNOWN_REASON)
111 else if ((not_seen && validities_seen[i] == 0) ||
112 (!not_seen && validities_seen[i] > 0))
113 printf ("validity %3d seen %d times\n",
114 i - _DBUS_NEGATIVE_VALIDITY_COUNT,
121 check_memleaks (void)
125 if (_dbus_get_malloc_blocks_outstanding () != 0)
127 _dbus_warn ("%d dbus_malloc blocks were not freed in %s\n",
128 _dbus_get_malloc_blocks_outstanding (), __FILE__);
129 _dbus_assert_not_reached ("memleaks");
134 check_have_valid_message (DBusMessageLoader *loader)
136 DBusMessage *message;
142 if (_dbus_message_loader_get_is_corrupted (loader))
144 _dbus_warn ("loader corrupted on message that was expected to be valid; invalid reason %d\n",
145 loader->corruption_reason);
149 message = _dbus_message_loader_pop_message (loader);
152 _dbus_warn ("didn't load message that was expected to be valid (message not popped)\n");
156 if (_dbus_string_get_length (&loader->data) > 0)
158 _dbus_warn ("had leftover bytes from expected-to-be-valid single message\n");
164 /* Verify that we're able to properly deal with the message.
165 * For example, this would detect improper handling of messages
166 * in nonstandard byte order.
168 if (!check_message_handling (message))
172 record_validity_seen (DBUS_VALID);
178 dbus_message_unref (message);
184 check_invalid_message (DBusMessageLoader *loader,
185 DBusValidity expected_validity)
191 if (!_dbus_message_loader_get_is_corrupted (loader))
193 _dbus_warn ("loader not corrupted on message that was expected to be invalid\n");
197 record_validity_seen (loader->corruption_reason);
199 if (expected_validity != DBUS_INVALID_FOR_UNKNOWN_REASON &&
200 loader->corruption_reason != expected_validity)
202 _dbus_warn ("expected message to be corrupted for reason %d and was corrupted for %d instead\n",
203 expected_validity, loader->corruption_reason);
214 check_incomplete_message (DBusMessageLoader *loader)
216 DBusMessage *message;
222 if (_dbus_message_loader_get_is_corrupted (loader))
224 _dbus_warn ("loader corrupted on message that was expected to be valid (but incomplete), corruption reason %d\n",
225 loader->corruption_reason);
229 message = _dbus_message_loader_pop_message (loader);
232 _dbus_warn ("loaded message that was expected to be incomplete\n");
236 record_validity_seen (DBUS_VALID_BUT_INCOMPLETE);
241 dbus_message_unref (message);
246 check_loader_results (DBusMessageLoader *loader,
247 DBusValidity expected_validity)
249 if (!_dbus_message_loader_queue_messages (loader))
250 _dbus_assert_not_reached ("no memory to queue messages");
252 if (expected_validity == DBUS_VALID)
253 return check_have_valid_message (loader);
254 else if (expected_validity == DBUS_VALID_BUT_INCOMPLETE)
255 return check_incomplete_message (loader);
256 else if (expected_validity == DBUS_VALIDITY_UNKNOWN)
258 /* here we just know we didn't segfault and that was the
259 * only test. Also, we record that we got coverage
260 * for the validity reason.
262 if (_dbus_message_loader_get_is_corrupted (loader))
263 record_validity_seen (loader->corruption_reason);
268 return check_invalid_message (loader, expected_validity);
272 * Loads the message in the given message file.
274 * @param filename filename to load
275 * @param data string to load message into
276 * @returns #TRUE if the message was loaded
279 dbus_internal_do_not_use_load_message_file (const DBusString *filename,
287 _dbus_verbose ("Loading raw %s\n", _dbus_string_get_const_data (filename));
288 dbus_error_init (&error);
289 if (!_dbus_file_get_contents (data, filename, &error))
291 _dbus_warn ("Could not load message file %s: %s\n",
292 _dbus_string_get_const_data (filename),
294 dbus_error_free (&error);
306 * Tries loading the message in the given message file
307 * and verifies that DBusMessageLoader can handle it.
309 * @param filename filename to load
310 * @param expected_validity what the message has to be like to return #TRUE
311 * @returns #TRUE if the message has the expected validity
314 dbus_internal_do_not_use_try_message_file (const DBusString *filename,
315 DBusValidity expected_validity)
322 if (!_dbus_string_init (&data))
323 _dbus_assert_not_reached ("could not allocate string\n");
325 if (!dbus_internal_do_not_use_load_message_file (filename, &data))
328 retval = dbus_internal_do_not_use_try_message_data (&data, expected_validity);
334 if (_dbus_string_get_length (&data) > 0)
335 _dbus_verbose_bytes_of_string (&data, 0,
336 _dbus_string_get_length (&data));
338 _dbus_warn ("Failed message loader test on %s\n",
339 _dbus_string_get_const_data (filename));
342 _dbus_string_free (&data);
348 * Tries loading the given message data.
351 * @param data the message data
352 * @param expected_validity what the message has to be like to return #TRUE
353 * @returns #TRUE if the message has the expected validity
356 dbus_internal_do_not_use_try_message_data (const DBusString *data,
357 DBusValidity expected_validity)
359 DBusMessageLoader *loader;
367 /* Write the data one byte at a time */
369 loader = _dbus_message_loader_new ();
371 /* check some trivial loader functions */
372 _dbus_message_loader_ref (loader);
373 _dbus_message_loader_unref (loader);
374 _dbus_message_loader_get_max_message_size (loader);
376 len = _dbus_string_get_length (data);
377 for (i = 0; i < len; i++)
381 _dbus_message_loader_get_buffer (loader, &buffer);
382 _dbus_string_append_byte (buffer,
383 _dbus_string_get_byte (data, i));
384 _dbus_message_loader_return_buffer (loader, buffer, 1);
387 if (!check_loader_results (loader, expected_validity))
390 _dbus_message_loader_unref (loader);
393 /* Write the data all at once */
395 loader = _dbus_message_loader_new ();
400 _dbus_message_loader_get_buffer (loader, &buffer);
401 _dbus_string_copy (data, 0, buffer,
402 _dbus_string_get_length (buffer));
403 _dbus_message_loader_return_buffer (loader, buffer, 1);
406 if (!check_loader_results (loader, expected_validity))
409 _dbus_message_loader_unref (loader);
412 /* Write the data 2 bytes at a time */
414 loader = _dbus_message_loader_new ();
416 len = _dbus_string_get_length (data);
417 for (i = 0; i < len; i += 2)
421 _dbus_message_loader_get_buffer (loader, &buffer);
422 _dbus_string_append_byte (buffer,
423 _dbus_string_get_byte (data, i));
425 _dbus_string_append_byte (buffer,
426 _dbus_string_get_byte (data, i+1));
427 _dbus_message_loader_return_buffer (loader, buffer, 1);
430 if (!check_loader_results (loader, expected_validity))
433 _dbus_message_loader_unref (loader);
441 _dbus_message_loader_unref (loader);
447 process_test_subdir (const DBusString *test_base_dir,
449 DBusValidity expected_validity,
450 DBusForeachMessageFileFunc function,
453 DBusString test_directory;
462 if (!_dbus_string_init (&test_directory))
463 _dbus_assert_not_reached ("didn't allocate test_directory\n");
465 _dbus_string_init_const (&filename, subdir);
467 if (!_dbus_string_copy (test_base_dir, 0,
469 _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
471 if (!_dbus_concat_dir_and_file (&test_directory, &filename))
472 _dbus_assert_not_reached ("couldn't allocate full path");
474 _dbus_string_free (&filename);
475 if (!_dbus_string_init (&filename))
476 _dbus_assert_not_reached ("didn't allocate filename string\n");
478 dbus_error_init (&error);
479 dir = _dbus_directory_open (&test_directory, &error);
482 _dbus_warn ("Could not open %s: %s\n",
483 _dbus_string_get_const_data (&test_directory),
485 dbus_error_free (&error);
489 printf ("Testing %s:\n", subdir);
492 while (_dbus_directory_get_next_file (dir, &filename, &error))
494 DBusString full_path;
496 if (!_dbus_string_init (&full_path))
497 _dbus_assert_not_reached ("couldn't init string");
499 if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
500 _dbus_assert_not_reached ("couldn't copy dir to full_path");
502 if (!_dbus_concat_dir_and_file (&full_path, &filename))
503 _dbus_assert_not_reached ("couldn't concat file to dir");
505 if (_dbus_string_ends_with_c_str (&filename, ".message-raw"))
509 if (_dbus_string_ends_with_c_str (&filename, ".message"))
511 _dbus_warn ("Could not load %s, message builder language no longer supported\n",
512 _dbus_string_get_const_data (&filename));
515 _dbus_verbose ("Skipping non-.message file %s\n",
516 _dbus_string_get_const_data (&filename));
517 _dbus_string_free (&full_path);
522 _dbus_string_get_const_data (&filename));
524 if (! (*function) (&full_path,
525 expected_validity, user_data))
527 _dbus_string_free (&full_path);
531 _dbus_string_free (&full_path);
534 if (dbus_error_is_set (&error))
536 _dbus_warn ("Could not get next file in %s: %s\n",
537 _dbus_string_get_const_data (&test_directory),
539 dbus_error_free (&error);
548 _dbus_directory_close (dir);
549 _dbus_string_free (&test_directory);
550 _dbus_string_free (&filename);
556 * Runs the given function on every message file in the test suite.
557 * The function should return #FALSE on test failure or fatal error.
559 * @param test_data_dir root dir of the test suite data files (top_srcdir/test/data)
560 * @param func the function to run
561 * @param user_data data for function
562 * @returns #FALSE if there's a failure
565 dbus_internal_do_not_use_foreach_message_file (const char *test_data_dir,
566 DBusForeachMessageFileFunc func,
569 DBusString test_directory;
574 _dbus_string_init_const (&test_directory, test_data_dir);
576 if (!process_test_subdir (&test_directory, "valid-messages",
577 DBUS_VALID, func, user_data))
582 if (!process_test_subdir (&test_directory, "invalid-messages",
583 DBUS_INVALID_FOR_UNKNOWN_REASON, func, user_data))
588 if (!process_test_subdir (&test_directory, "incomplete-messages",
589 DBUS_VALID_BUT_INCOMPLETE, func, user_data))
598 _dbus_string_free (&test_directory);
604 #define GET_AND_CHECK(iter, typename, literal) \
606 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_##typename) \
607 _dbus_assert_not_reached ("got wrong argument type from message iter"); \
608 dbus_message_iter_get_basic (&iter, &v_##typename); \
609 if (v_##typename != literal) \
610 _dbus_assert_not_reached ("got wrong value from message iter"); \
613 #define GET_AND_CHECK_STRCMP(iter, typename, literal) \
615 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_##typename) \
616 _dbus_assert_not_reached ("got wrong argument type from message iter"); \
617 dbus_message_iter_get_basic (&iter, &v_##typename); \
618 if (strcmp (v_##typename, literal) != 0) \
619 _dbus_assert_not_reached ("got wrong value from message iter"); \
622 #define GET_AND_CHECK_AND_NEXT(iter, typename, literal) \
624 GET_AND_CHECK(iter, typename, literal); \
625 if (!dbus_message_iter_next (&iter)) \
626 _dbus_assert_not_reached ("failed to move iter to next"); \
629 #define GET_AND_CHECK_STRCMP_AND_NEXT(iter, typename, literal) \
631 GET_AND_CHECK_STRCMP(iter, typename, literal); \
632 if (!dbus_message_iter_next (&iter)) \
633 _dbus_assert_not_reached ("failed to move iter to next"); \
637 message_iter_test (DBusMessage *message)
639 DBusMessageIter iter, array, array2;
640 const char *v_STRING;
642 dbus_int16_t v_INT16;
643 dbus_uint16_t v_UINT16;
644 dbus_int32_t v_INT32;
645 dbus_uint32_t v_UINT32;
646 #ifdef DBUS_HAVE_INT64
647 dbus_int64_t v_INT64;
648 dbus_uint64_t v_UINT64;
650 unsigned char v_BYTE;
651 dbus_bool_t v_BOOLEAN;
653 const dbus_int32_t *our_int_array;
656 dbus_message_iter_init (message, &iter);
658 GET_AND_CHECK_STRCMP_AND_NEXT (iter, STRING, "Test string");
659 GET_AND_CHECK_AND_NEXT (iter, INT32, -0x12345678);
660 GET_AND_CHECK_AND_NEXT (iter, UINT32, 0xedd1e);
661 GET_AND_CHECK_AND_NEXT (iter, DOUBLE, 3.14159);
663 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_ARRAY)
664 _dbus_assert_not_reached ("Argument type not an array");
666 if (dbus_message_iter_get_element_type (&iter) != DBUS_TYPE_DOUBLE)
667 _dbus_assert_not_reached ("Array type not double");
669 dbus_message_iter_recurse (&iter, &array);
671 GET_AND_CHECK_AND_NEXT (array, DOUBLE, 1.5);
672 GET_AND_CHECK (array, DOUBLE, 2.5);
674 if (dbus_message_iter_next (&array))
675 _dbus_assert_not_reached ("Didn't reach end of array");
677 if (!dbus_message_iter_next (&iter))
678 _dbus_assert_not_reached ("Reached end of arguments");
680 GET_AND_CHECK_AND_NEXT (iter, BYTE, 0xF0);
682 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_ARRAY)
683 _dbus_assert_not_reached ("no array");
685 if (dbus_message_iter_get_element_type (&iter) != DBUS_TYPE_INT32)
686 _dbus_assert_not_reached ("Array type not int32");
689 dbus_message_iter_recurse (&iter, &array);
691 if (dbus_message_iter_next (&array))
692 _dbus_assert_not_reached ("Didn't reach end of array");
694 if (!dbus_message_iter_next (&iter))
695 _dbus_assert_not_reached ("Reached end of arguments");
697 GET_AND_CHECK (iter, BYTE, 0xF0);
699 if (dbus_message_iter_next (&iter))
700 _dbus_assert_not_reached ("Didn't reach end of arguments");
705 verify_test_message (DBusMessage *message)
707 DBusMessageIter iter;
709 dbus_int16_t our_int16;
710 dbus_uint16_t our_uint16;
711 dbus_int32_t our_int;
712 dbus_uint32_t our_uint;
716 dbus_bool_t our_bool;
717 unsigned char our_byte_1, our_byte_2;
718 const dbus_uint32_t *our_uint32_array = (void*)0xdeadbeef;
719 int our_uint32_array_len;
720 dbus_int32_t *our_int32_array = (void*)0xdeadbeef;
721 int our_int32_array_len;
722 #ifdef DBUS_HAVE_INT64
723 dbus_int64_t our_int64;
724 dbus_uint64_t our_uint64;
725 dbus_int64_t *our_uint64_array = (void*)0xdeadbeef;
726 int our_uint64_array_len;
727 const dbus_int64_t *our_int64_array = (void*)0xdeadbeef;
728 int our_int64_array_len;
730 const double *our_double_array = (void*)0xdeadbeef;
731 int our_double_array_len;
732 const unsigned char *our_byte_array = (void*)0xdeadbeef;
733 int our_byte_array_len;
734 const dbus_bool_t *our_boolean_array = (void*)0xdeadbeef;
735 int our_boolean_array_len;
736 char **our_string_array;
737 int our_string_array_len;
739 dbus_message_iter_init (message, &iter);
741 dbus_error_init (&error);
742 if (!dbus_message_iter_get_args (&iter, &error,
743 DBUS_TYPE_INT16, &our_int16,
744 DBUS_TYPE_UINT16, &our_uint16,
745 DBUS_TYPE_INT32, &our_int,
746 DBUS_TYPE_UINT32, &our_uint,
747 #ifdef DBUS_HAVE_INT64
748 DBUS_TYPE_INT64, &our_int64,
749 DBUS_TYPE_UINT64, &our_uint64,
751 DBUS_TYPE_STRING, &our_str,
752 DBUS_TYPE_DOUBLE, &our_double,
753 DBUS_TYPE_BOOLEAN, &our_bool,
754 DBUS_TYPE_BYTE, &our_byte_1,
755 DBUS_TYPE_BYTE, &our_byte_2,
756 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32,
757 &our_uint32_array, &our_uint32_array_len,
758 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32,
759 &our_int32_array, &our_int32_array_len,
760 #ifdef DBUS_HAVE_INT64
761 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64,
762 &our_uint64_array, &our_uint64_array_len,
763 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64,
764 &our_int64_array, &our_int64_array_len,
766 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE,
767 &our_double_array, &our_double_array_len,
768 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE,
769 &our_byte_array, &our_byte_array_len,
770 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN,
771 &our_boolean_array, &our_boolean_array_len,
772 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING,
773 &our_string_array, &our_string_array_len,
776 _dbus_warn ("error: %s - %s\n", error.name,
777 (error.message != NULL) ? error.message : "no message");
778 _dbus_assert_not_reached ("Could not get arguments");
781 if (our_int16 != -0x123)
782 _dbus_assert_not_reached ("16-bit integers differ!");
784 if (our_uint16 != 0x123)
785 _dbus_assert_not_reached ("16-bit uints differ!");
787 if (our_int != -0x12345678)
788 _dbus_assert_not_reached ("integers differ!");
790 if (our_uint != 0x12300042)
791 _dbus_assert_not_reached ("uints differ!");
793 #ifdef DBUS_HAVE_INT64
794 if (our_int64 != DBUS_INT64_CONSTANT (-0x123456789abcd))
795 _dbus_assert_not_reached ("64-bit integers differ!");
796 if (our_uint64 != DBUS_UINT64_CONSTANT (0x123456789abcd))
797 _dbus_assert_not_reached ("64-bit unsigned integers differ!");
801 if (! _DBUS_DOUBLES_BITWISE_EQUAL (our_double, v_DOUBLE))
802 _dbus_assert_not_reached ("doubles differ!");
804 if (strcmp (our_str, "Test string") != 0)
805 _dbus_assert_not_reached ("strings differ!");
808 _dbus_assert_not_reached ("booleans differ");
810 if (our_byte_1 != 42)
811 _dbus_assert_not_reached ("bytes differ!");
813 if (our_byte_2 != 24)
814 _dbus_assert_not_reached ("bytes differ!");
816 if (our_uint32_array_len != 4 ||
817 our_uint32_array[0] != 0x12345678 ||
818 our_uint32_array[1] != 0x23456781 ||
819 our_uint32_array[2] != 0x34567812 ||
820 our_uint32_array[3] != 0x45678123)
821 _dbus_assert_not_reached ("uint array differs");
823 if (our_int32_array_len != 4 ||
824 our_int32_array[0] != 0x12345678 ||
825 our_int32_array[1] != -0x23456781 ||
826 our_int32_array[2] != 0x34567812 ||
827 our_int32_array[3] != -0x45678123)
828 _dbus_assert_not_reached ("int array differs");
830 #ifdef DBUS_HAVE_INT64
831 if (our_uint64_array_len != 4 ||
832 our_uint64_array[0] != 0x12345678 ||
833 our_uint64_array[1] != 0x23456781 ||
834 our_uint64_array[2] != 0x34567812 ||
835 our_uint64_array[3] != 0x45678123)
836 _dbus_assert_not_reached ("uint64 array differs");
838 if (our_int64_array_len != 4 ||
839 our_int64_array[0] != 0x12345678 ||
840 our_int64_array[1] != -0x23456781 ||
841 our_int64_array[2] != 0x34567812 ||
842 our_int64_array[3] != -0x45678123)
843 _dbus_assert_not_reached ("int64 array differs");
844 #endif /* DBUS_HAVE_INT64 */
846 if (our_double_array_len != 3)
847 _dbus_assert_not_reached ("double array had wrong length");
849 /* On all IEEE machines (i.e. everything sane) exact equality
850 * should be preserved over the wire
853 if (! _DBUS_DOUBLES_BITWISE_EQUAL (our_double_array[0], v_DOUBLE))
854 _dbus_assert_not_reached ("double array had wrong values");
855 v_DOUBLE = 9876.54321;
856 if (! _DBUS_DOUBLES_BITWISE_EQUAL (our_double_array[1], v_DOUBLE))
857 _dbus_assert_not_reached ("double array had wrong values");
859 if (! _DBUS_DOUBLES_BITWISE_EQUAL (our_double_array[2], v_DOUBLE))
860 _dbus_assert_not_reached ("double array had wrong values");
862 if (our_byte_array_len != 4)
863 _dbus_assert_not_reached ("byte array had wrong length");
865 if (our_byte_array[0] != 'a' ||
866 our_byte_array[1] != 'b' ||
867 our_byte_array[2] != 'c' ||
868 our_byte_array[3] != 234)
869 _dbus_assert_not_reached ("byte array had wrong values");
871 if (our_boolean_array_len != 5)
872 _dbus_assert_not_reached ("bool array had wrong length");
874 if (our_boolean_array[0] != TRUE ||
875 our_boolean_array[1] != FALSE ||
876 our_boolean_array[2] != TRUE ||
877 our_boolean_array[3] != TRUE ||
878 our_boolean_array[4] != FALSE)
879 _dbus_assert_not_reached ("bool array had wrong values");
881 if (our_string_array_len != 4)
882 _dbus_assert_not_reached ("string array was wrong length");
884 if (strcmp (our_string_array[0], "Foo") != 0 ||
885 strcmp (our_string_array[1], "bar") != 0 ||
886 strcmp (our_string_array[2], "") != 0 ||
887 strcmp (our_string_array[3], "woo woo woo woo") != 0)
888 _dbus_assert_not_reached ("string array had wrong values");
890 dbus_free_string_array (our_string_array);
892 if (dbus_message_iter_next (&iter))
893 _dbus_assert_not_reached ("Didn't reach end of arguments");
897 * @ingroup DBusMessageInternals
898 * Unit test for DBusMessage.
900 * @returns #TRUE on success.
903 _dbus_message_test (const char *test_data_dir)
905 DBusMessage *message;
906 DBusMessageLoader *loader;
912 const dbus_uint32_t our_uint32_array[] =
913 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
914 const dbus_int32_t our_int32_array[] =
915 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
916 const dbus_uint32_t *v_ARRAY_UINT32 = our_uint32_array;
917 const dbus_int32_t *v_ARRAY_INT32 = our_int32_array;
918 #ifdef DBUS_HAVE_INT64
919 const dbus_uint64_t our_uint64_array[] =
920 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
921 const dbus_int64_t our_int64_array[] =
922 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
923 const dbus_uint64_t *v_ARRAY_UINT64 = our_uint64_array;
924 const dbus_int64_t *v_ARRAY_INT64 = our_int64_array;
926 const char *our_string_array[] = { "Foo", "bar", "", "woo woo woo woo" };
927 const char **v_ARRAY_STRING = our_string_array;
928 const double our_double_array[] = { 0.1234, 9876.54321, -300.0 };
929 const double *v_ARRAY_DOUBLE = our_double_array;
930 const unsigned char our_byte_array[] = { 'a', 'b', 'c', 234 };
931 const unsigned char *v_ARRAY_BYTE = our_byte_array;
932 const dbus_bool_t our_boolean_array[] = { TRUE, FALSE, TRUE, TRUE, FALSE };
933 const dbus_bool_t *v_ARRAY_BOOLEAN = our_boolean_array;
936 const char *v_STRING;
938 dbus_int16_t v_INT16;
939 dbus_uint16_t v_UINT16;
940 dbus_int32_t v_INT32;
941 dbus_uint32_t v_UINT32;
942 #ifdef DBUS_HAVE_INT64
943 dbus_int64_t v_INT64;
944 dbus_uint64_t v_UINT64;
946 unsigned char v_BYTE;
947 unsigned char v2_BYTE;
948 dbus_bool_t v_BOOLEAN;
950 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
951 "/org/freedesktop/TestPath",
954 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.TestService"));
955 _dbus_assert (dbus_message_is_method_call (message, "Foo.TestInterface",
957 _dbus_assert (strcmp (dbus_message_get_path (message),
958 "/org/freedesktop/TestPath") == 0);
959 _dbus_message_set_serial (message, 1234);
961 /* string length including nul byte not a multiple of 4 */
962 if (!dbus_message_set_sender (message, "org.foo.bar1"))
963 _dbus_assert_not_reached ("out of memory");
965 _dbus_assert (dbus_message_has_sender (message, "org.foo.bar1"));
966 dbus_message_set_reply_serial (message, 5678);
968 _dbus_verbose_bytes_of_string (&message->header.data, 0,
969 _dbus_string_get_length (&message->header.data));
970 _dbus_verbose_bytes_of_string (&message->body, 0,
971 _dbus_string_get_length (&message->body));
973 if (!dbus_message_set_sender (message, NULL))
974 _dbus_assert_not_reached ("out of memory");
977 _dbus_verbose_bytes_of_string (&message->header.data, 0,
978 _dbus_string_get_length (&message->header.data));
979 _dbus_verbose_bytes_of_string (&message->body, 0,
980 _dbus_string_get_length (&message->body));
983 _dbus_assert (!dbus_message_has_sender (message, "org.foo.bar1"));
984 _dbus_assert (dbus_message_get_serial (message) == 1234);
985 _dbus_assert (dbus_message_get_reply_serial (message) == 5678);
986 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.TestService"));
988 _dbus_assert (dbus_message_get_no_reply (message) == FALSE);
989 dbus_message_set_no_reply (message, TRUE);
990 _dbus_assert (dbus_message_get_no_reply (message) == TRUE);
991 dbus_message_set_no_reply (message, FALSE);
992 _dbus_assert (dbus_message_get_no_reply (message) == FALSE);
994 /* Set/get some header fields */
996 if (!dbus_message_set_path (message, "/foo"))
997 _dbus_assert_not_reached ("out of memory");
998 _dbus_assert (strcmp (dbus_message_get_path (message),
1001 if (!dbus_message_set_interface (message, "org.Foo"))
1002 _dbus_assert_not_reached ("out of memory");
1003 _dbus_assert (strcmp (dbus_message_get_interface (message),
1006 if (!dbus_message_set_member (message, "Bar"))
1007 _dbus_assert_not_reached ("out of memory");
1008 _dbus_assert (strcmp (dbus_message_get_member (message),
1011 /* Set/get them with longer values */
1012 if (!dbus_message_set_path (message, "/foo/bar"))
1013 _dbus_assert_not_reached ("out of memory");
1014 _dbus_assert (strcmp (dbus_message_get_path (message),
1017 if (!dbus_message_set_interface (message, "org.Foo.Bar"))
1018 _dbus_assert_not_reached ("out of memory");
1019 _dbus_assert (strcmp (dbus_message_get_interface (message),
1020 "org.Foo.Bar") == 0);
1022 if (!dbus_message_set_member (message, "BarFoo"))
1023 _dbus_assert_not_reached ("out of memory");
1024 _dbus_assert (strcmp (dbus_message_get_member (message),
1027 /* Realloc shorter again */
1029 if (!dbus_message_set_path (message, "/foo"))
1030 _dbus_assert_not_reached ("out of memory");
1031 _dbus_assert (strcmp (dbus_message_get_path (message),
1034 if (!dbus_message_set_interface (message, "org.Foo"))
1035 _dbus_assert_not_reached ("out of memory");
1036 _dbus_assert (strcmp (dbus_message_get_interface (message),
1039 if (!dbus_message_set_member (message, "Bar"))
1040 _dbus_assert_not_reached ("out of memory");
1041 _dbus_assert (strcmp (dbus_message_get_member (message),
1044 dbus_message_unref (message);
1046 /* Test the vararg functions */
1047 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
1048 "/org/freedesktop/TestPath",
1049 "Foo.TestInterface",
1051 _dbus_message_set_serial (message, 1);
1052 dbus_message_set_reply_serial (message, 5678);
1056 v_INT32 = -0x12345678;
1057 v_UINT32 = 0x12300042;
1058 #ifdef DBUS_HAVE_INT64
1059 v_INT64 = DBUS_INT64_CONSTANT (-0x123456789abcd);
1060 v_UINT64 = DBUS_UINT64_CONSTANT (0x123456789abcd);
1062 v_STRING = "Test string";
1068 dbus_message_append_args (message,
1069 DBUS_TYPE_INT16, &v_INT16,
1070 DBUS_TYPE_UINT16, &v_UINT16,
1071 DBUS_TYPE_INT32, &v_INT32,
1072 DBUS_TYPE_UINT32, &v_UINT32,
1073 #ifdef DBUS_HAVE_INT64
1074 DBUS_TYPE_INT64, &v_INT64,
1075 DBUS_TYPE_UINT64, &v_UINT64,
1077 DBUS_TYPE_STRING, &v_STRING,
1078 DBUS_TYPE_DOUBLE, &v_DOUBLE,
1079 DBUS_TYPE_BOOLEAN, &v_BOOLEAN,
1080 DBUS_TYPE_BYTE, &v_BYTE,
1081 DBUS_TYPE_BYTE, &v2_BYTE,
1082 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32, &v_ARRAY_UINT32,
1083 _DBUS_N_ELEMENTS (our_uint32_array),
1084 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32, &v_ARRAY_INT32,
1085 _DBUS_N_ELEMENTS (our_int32_array),
1086 #ifdef DBUS_HAVE_INT64
1087 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64, &v_ARRAY_UINT64,
1088 _DBUS_N_ELEMENTS (our_uint64_array),
1089 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64, &v_ARRAY_INT64,
1090 _DBUS_N_ELEMENTS (our_int64_array),
1092 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE, &v_ARRAY_DOUBLE,
1093 _DBUS_N_ELEMENTS (our_double_array),
1094 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE, &v_ARRAY_BYTE,
1095 _DBUS_N_ELEMENTS (our_byte_array),
1096 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN, &v_ARRAY_BOOLEAN,
1097 _DBUS_N_ELEMENTS (our_boolean_array),
1098 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING, &v_ARRAY_STRING,
1099 _DBUS_N_ELEMENTS (our_string_array),
1103 sig[i++] = DBUS_TYPE_INT16;
1104 sig[i++] = DBUS_TYPE_UINT16;
1105 sig[i++] = DBUS_TYPE_INT32;
1106 sig[i++] = DBUS_TYPE_UINT32;
1107 #ifdef DBUS_HAVE_INT64
1108 sig[i++] = DBUS_TYPE_INT64;
1109 sig[i++] = DBUS_TYPE_UINT64;
1111 sig[i++] = DBUS_TYPE_STRING;
1112 sig[i++] = DBUS_TYPE_DOUBLE;
1113 sig[i++] = DBUS_TYPE_BOOLEAN;
1114 sig[i++] = DBUS_TYPE_BYTE;
1115 sig[i++] = DBUS_TYPE_BYTE;
1116 sig[i++] = DBUS_TYPE_ARRAY;
1117 sig[i++] = DBUS_TYPE_UINT32;
1118 sig[i++] = DBUS_TYPE_ARRAY;
1119 sig[i++] = DBUS_TYPE_INT32;
1120 #ifdef DBUS_HAVE_INT64
1121 sig[i++] = DBUS_TYPE_ARRAY;
1122 sig[i++] = DBUS_TYPE_UINT64;
1123 sig[i++] = DBUS_TYPE_ARRAY;
1124 sig[i++] = DBUS_TYPE_INT64;
1126 sig[i++] = DBUS_TYPE_ARRAY;
1127 sig[i++] = DBUS_TYPE_DOUBLE;
1128 sig[i++] = DBUS_TYPE_ARRAY;
1129 sig[i++] = DBUS_TYPE_BYTE;
1130 sig[i++] = DBUS_TYPE_ARRAY;
1131 sig[i++] = DBUS_TYPE_BOOLEAN;
1132 sig[i++] = DBUS_TYPE_ARRAY;
1133 sig[i++] = DBUS_TYPE_STRING;
1134 sig[i++] = DBUS_TYPE_INVALID;
1136 _dbus_assert (i < (int) _DBUS_N_ELEMENTS (sig));
1138 _dbus_verbose ("HEADER\n");
1139 _dbus_verbose_bytes_of_string (&message->header.data, 0,
1140 _dbus_string_get_length (&message->header.data));
1141 _dbus_verbose ("BODY\n");
1142 _dbus_verbose_bytes_of_string (&message->body, 0,
1143 _dbus_string_get_length (&message->body));
1145 _dbus_verbose ("Signature expected \"%s\" actual \"%s\"\n",
1146 sig, dbus_message_get_signature (message));
1148 s = dbus_message_get_signature (message);
1150 _dbus_assert (dbus_message_has_signature (message, sig));
1151 _dbus_assert (strcmp (s, sig) == 0);
1153 verify_test_message (message);
1155 copy = dbus_message_copy (message);
1157 _dbus_assert (dbus_message_get_reply_serial (message) ==
1158 dbus_message_get_reply_serial (copy));
1159 _dbus_assert (message->header.padding == copy->header.padding);
1161 _dbus_assert (_dbus_string_get_length (&message->header.data) ==
1162 _dbus_string_get_length (©->header.data));
1164 _dbus_assert (_dbus_string_get_length (&message->body) ==
1165 _dbus_string_get_length (©->body));
1167 verify_test_message (copy);
1169 name1 = dbus_message_get_interface (message);
1170 name2 = dbus_message_get_interface (copy);
1172 _dbus_assert (strcmp (name1, name2) == 0);
1174 name1 = dbus_message_get_member (message);
1175 name2 = dbus_message_get_member (copy);
1177 _dbus_assert (strcmp (name1, name2) == 0);
1179 dbus_message_unref (copy);
1181 /* Message loader test */
1182 _dbus_message_lock (message);
1183 loader = _dbus_message_loader_new ();
1185 /* check ref/unref */
1186 _dbus_message_loader_ref (loader);
1187 _dbus_message_loader_unref (loader);
1189 /* Write the header data one byte at a time */
1190 data = _dbus_string_get_const_data (&message->header.data);
1191 for (i = 0; i < _dbus_string_get_length (&message->header.data); i++)
1195 _dbus_message_loader_get_buffer (loader, &buffer);
1196 _dbus_string_append_byte (buffer, data[i]);
1197 _dbus_message_loader_return_buffer (loader, buffer, 1);
1200 /* Write the body data one byte at a time */
1201 data = _dbus_string_get_const_data (&message->body);
1202 for (i = 0; i < _dbus_string_get_length (&message->body); i++)
1206 _dbus_message_loader_get_buffer (loader, &buffer);
1207 _dbus_string_append_byte (buffer, data[i]);
1208 _dbus_message_loader_return_buffer (loader, buffer, 1);
1211 dbus_message_unref (message);
1213 /* Now pop back the message */
1214 if (!_dbus_message_loader_queue_messages (loader))
1215 _dbus_assert_not_reached ("no memory to queue messages");
1217 if (_dbus_message_loader_get_is_corrupted (loader))
1218 _dbus_assert_not_reached ("message loader corrupted");
1220 message = _dbus_message_loader_pop_message (loader);
1222 _dbus_assert_not_reached ("received a NULL message");
1224 if (dbus_message_get_reply_serial (message) != 5678)
1225 _dbus_assert_not_reached ("reply serial fields differ");
1227 verify_test_message (message);
1229 dbus_message_unref (message);
1230 _dbus_message_loader_unref (loader);
1234 /* Load all the sample messages from the message factory */
1236 DBusMessageDataIter diter;
1237 DBusMessageData mdata;
1240 reset_validities_seen ();
1243 _dbus_message_data_iter_init (&diter);
1245 while (_dbus_message_data_iter_get_and_next (&diter,
1248 if (!dbus_internal_do_not_use_try_message_data (&mdata.data,
1249 mdata.expected_validity))
1251 _dbus_warn ("expected validity %d and did not get it\n",
1252 mdata.expected_validity);
1253 _dbus_assert_not_reached ("message data failed");
1256 _dbus_message_data_free (&mdata);
1261 printf ("%d sample messages tested\n", count);
1263 print_validities_seen (FALSE);
1264 print_validities_seen (TRUE);
1269 /* Now load every message in test_data_dir if we have one */
1270 if (test_data_dir == NULL)
1273 return dbus_internal_do_not_use_foreach_message_file (test_data_dir,
1274 (DBusForeachMessageFileFunc)
1275 dbus_internal_do_not_use_try_message_file,
1279 #endif /* DBUS_BUILD_TESTS */