2 * This file is part of GNUnet
3 * Copyright (C) 2013 GNUnet e.V.
5 * GNUnet is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published
7 * by the Free Software Foundation; either version 3, or (at your
8 * option) any later version.
10 * GNUnet is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with GNUnet; see the file COPYING. If not, write to the
17 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 * Boston, MA 02110-1301, USA.
22 * @file multicast/test_multicast.c
23 * @brief Tests for the Multicast API.
24 * @author Gabor X Toth
30 #include "gnunet_crypto_lib.h"
31 #include "gnunet_common.h"
32 #include "gnunet_util_lib.h"
33 #include "gnunet_testing_lib.h"
34 #include "gnunet_core_service.h"
35 #include "gnunet_multicast_service.h"
37 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
40 * Return value from 'main'.
45 * Handle for task for timeout termination.
47 static struct GNUNET_SCHEDULER_Task * end_badly_task;
49 static const struct GNUNET_CONFIGURATION_Handle *cfg;
51 struct GNUNET_CORE_Handle *core;
52 struct GNUNET_PeerIdentity this_peer;
54 struct GNUNET_MULTICAST_Origin *origin;
55 struct GNUNET_MULTICAST_Member *member;
57 struct GNUNET_CRYPTO_EddsaPrivateKey *group_key;
58 struct GNUNET_CRYPTO_EddsaPublicKey group_pub_key;
60 struct GNUNET_CRYPTO_EcdsaPrivateKey *member_key;
61 struct GNUNET_CRYPTO_EcdsaPublicKey member_pub_key;
63 struct TransmitClosure {
64 struct GNUNET_MULTICAST_OriginTransmitHandle *orig_tmit;
65 struct GNUNET_MULTICAST_MemberTransmitHandle *mem_tmit;
67 uint8_t data_delay[16];
73 struct OriginClosure {
74 uint8_t msgs_expected;
78 struct MemberClosure {
79 uint8_t msgs_expected;
83 struct GNUNET_MessageHeader *join_req, *join_resp;
88 TEST_ORIGIN_START = 1,
89 TEST_MEMBER_JOIN_REFUSE = 2,
90 TEST_MEMBER_JOIN_ADMIT = 3,
91 TEST_ORIGIN_TO_ALL = 4,
92 TEST_ORIGIN_TO_ALL_RECV = 5,
93 TEST_MEMBER_TO_ORIGIN = 6,
94 TEST_MEMBER_REPLAY_ERROR = 7,
95 TEST_MEMBER_REPLAY_OK = 8,
97 TEST_ORIGIN_STOP = 10,
100 uint64_t replay_fragment_id;
101 uint64_t replay_flags;
108 * Clean up all resources used.
115 GNUNET_CORE_disconnecT (core);
120 GNUNET_MULTICAST_member_part (member, NULL, NULL);
125 GNUNET_MULTICAST_origin_stop (origin, NULL, NULL);
132 * Terminate the test case (failure).
137 end_badly (void *cls)
141 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Test FAILED.\n");
146 * Terminate the test case (success).
151 end_normally (void *cls)
155 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Test PASSED.\n");
160 * Finish the test case (successfully).
165 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Ending tests.\n");
167 if (end_badly_task != NULL)
169 GNUNET_SCHEDULER_cancel (end_badly_task);
170 end_badly_task = NULL;
172 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MILLISECONDS,
173 &end_normally, NULL);
178 tmit_resume (void *cls)
180 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmission resumed.\n");
181 struct TransmitClosure *tmit = cls;
182 if (NULL != tmit->orig_tmit)
183 GNUNET_MULTICAST_origin_to_all_resume (tmit->orig_tmit);
184 else if (NULL != tmit->mem_tmit)
185 GNUNET_MULTICAST_member_to_origin_resume (tmit->mem_tmit);
190 tmit_notify (void *cls, size_t *data_size, void *data)
192 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
193 "Test #%u: origin_tmit_notify()\n", test);
194 struct TransmitClosure *tmit = cls;
196 if (0 == tmit->data_count)
202 uint16_t size = strlen (tmit->data[tmit->n]);
203 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
204 "Transmit notify data: %u bytes available, processing fragment %u/%u (size %u).\n",
205 (unsigned int) *data_size,
209 if (*data_size < size)
213 return GNUNET_SYSERR;
216 if (GNUNET_YES != tmit->paused && 0 < tmit->data_delay[tmit->n])
218 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmission paused.\n");
219 tmit->paused = GNUNET_YES;
220 GNUNET_SCHEDULER_add_delayed (
221 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
222 tmit->data_delay[tmit->n]),
227 tmit->paused = GNUNET_NO;
230 GNUNET_memcpy (data, tmit->data[tmit->n], size);
232 return ++tmit->n < tmit->data_count ? GNUNET_NO : GNUNET_YES;
237 member_recv_join_request (void *cls,
238 const struct GNUNET_CRYPTO_EcdsaPublicKey *member_key,
239 const struct GNUNET_MessageHeader *join_msg,
240 struct GNUNET_MULTICAST_JoinHandle *jh)
242 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
243 "Test #%u: member_recv_join_request()\n", test);
248 origin_stopped (void *cls)
250 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
251 "Test #%u: origin_stopped()\n", test);
257 schedule_origin_stop (void *cls)
259 test = TEST_ORIGIN_STOP;
260 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
261 "Test #%u: origin_stop()\n", test);
262 GNUNET_MULTICAST_origin_stop (origin, origin_stopped, NULL);
268 member_parted (void *cls)
270 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
271 "Test #%u: member_parted()\n", test);
276 case TEST_MEMBER_JOIN_REFUSE:
277 // Test 3 starts here
278 member_join (TEST_MEMBER_JOIN_ADMIT);
281 case TEST_MEMBER_PART:
282 GNUNET_SCHEDULER_add_now (&schedule_origin_stop, NULL);
286 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
287 "Invalid test #%d in member_parted()\n", test);
294 schedule_member_part (void *cls)
296 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
297 "Test #%u: schedule_member_part()\n", test);
298 GNUNET_MULTICAST_member_part (member, member_parted, NULL);
305 test = TEST_MEMBER_PART;
306 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
307 "Test #%u: member_part()\n", test);
308 // Test 10 starts here
309 GNUNET_SCHEDULER_add_now (&schedule_member_part, NULL);
316 // Execution of test 8 here
317 test = TEST_MEMBER_REPLAY_OK;
318 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
319 "Test #%u: member_replay_ok()\n", test);
320 replay_fragment_id = 1;
321 replay_flags = 1 | 1<<11;
322 GNUNET_MULTICAST_member_replay_fragment (member, replay_fragment_id,
328 member_replay_error ()
330 test = TEST_MEMBER_REPLAY_ERROR;
331 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
332 "Test #%u: member_replay_error()\n", test);
333 replay_fragment_id = 1234;
334 replay_flags = 11 | 1<<11;
335 GNUNET_MULTICAST_member_replay_fragment (member, replay_fragment_id,
341 origin_recv_replay_msg (void *cls,
342 const struct GNUNET_CRYPTO_EcdsaPublicKey *member_key,
344 uint64_t fragment_offset,
346 struct GNUNET_MULTICAST_ReplayHandle *rh)
348 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
349 "Test #%u: origin_recv_replay_msg()\n", test);
355 member_recv_replay_msg (void *cls,
356 const struct GNUNET_CRYPTO_EcdsaPublicKey *member_key,
358 uint64_t fragment_offset,
360 struct GNUNET_MULTICAST_ReplayHandle *rh)
362 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
363 "Test #%u: member_recv_replay_msg()\n", test);
369 origin_recv_replay_frag (void *cls,
370 const struct GNUNET_CRYPTO_EcdsaPublicKey *member_key,
371 uint64_t fragment_id,
373 struct GNUNET_MULTICAST_ReplayHandle *rh)
375 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
376 "Test #%u: origin_recv_replay_frag()"
377 " - fragment_id=%" PRIu64 " flags=%" PRIu64 "\n",
378 test, fragment_id, flags);
379 GNUNET_assert (replay_fragment_id == fragment_id && replay_flags == flags);
382 case TEST_MEMBER_REPLAY_ERROR:
383 // Test 8 starts here
384 GNUNET_MULTICAST_replay_response (rh, NULL, GNUNET_SYSERR);
388 case TEST_MEMBER_REPLAY_OK:
390 struct GNUNET_MULTICAST_MessageHeader mmsg = {
392 .type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_MESSAGE),
393 .size = htons (sizeof (mmsg)),
395 .fragment_id = GNUNET_htonll (1),
396 .message_id = GNUNET_htonll (1),
397 .fragment_offset = 0,
398 .group_generation = GNUNET_htonll (1),
402 member_cls.msgs_expected = 1;
403 GNUNET_MULTICAST_replay_response (rh, &mmsg.header, GNUNET_MULTICAST_REC_OK);
404 GNUNET_MULTICAST_replay_response_end (rh);
409 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
410 "Invalid test #%d in origin_recv_replay_frag()\n", test);
417 member_recv_replay_frag (void *cls,
418 const struct GNUNET_CRYPTO_EcdsaPublicKey *member_key,
419 uint64_t fragment_id,
421 struct GNUNET_MULTICAST_ReplayHandle *rh)
423 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
424 "Test #%u: member_recv_replay_frag()\n", test);
430 origin_recv_request (void *cls,
431 const struct GNUNET_MULTICAST_RequestHeader *req)
433 struct OriginClosure *ocls = cls;
434 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
435 "Test #%u: origin_recv_request()\n", test);
436 if (++ocls->n != ocls->msgs_expected)
439 GNUNET_assert (0 == memcmp (&req->member_pub_key,
440 &member_pub_key, sizeof (member_pub_key)));
442 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
443 "Test #%u: verify message content, take first 3 bytes: %.3s\n",
444 test, (char *)&req[1]);
445 GNUNET_assert (0 == memcmp (&req[1], "abc", 3));
447 // Test 7 starts here
448 member_replay_error ();
455 test = TEST_MEMBER_TO_ORIGIN;
456 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
457 "Test #%u: member_to_origin()\n", test);
459 struct TransmitClosure *tmit = &tmit_cls;
460 *tmit = (struct TransmitClosure) {};
461 tmit->data[0] = "abc def";
462 tmit->data[1] = "ghi jkl mno";
463 tmit->data_delay[1] = 2;
464 tmit->data[2] = "pqr stuw xyz";
465 tmit->data_count = 3;
468 origin_cls.msgs_expected = 1;
470 tmit->mem_tmit = GNUNET_MULTICAST_member_to_origin (member, 1,
476 member_recv_message (void *cls,
477 const struct GNUNET_MULTICAST_MessageHeader *msg)
479 struct MemberClosure *mcls = cls;
481 // Test 5 starts here after message has been received from origin
482 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
483 "Test #%u: member_recv_message() %u/%u\n",
485 (unsigned int) (mcls->n + 1),
486 mcls->msgs_expected);
487 if (++mcls->n != mcls->msgs_expected)
490 // FIXME: check message content
494 case TEST_ORIGIN_TO_ALL_RECV:
495 // Test 6 starts here
499 case TEST_MEMBER_REPLAY_OK:
500 // Test 9 starts here
501 GNUNET_assert (replay_fragment_id == GNUNET_ntohll (msg->fragment_id));
506 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
507 "Invalid test #%d in origin_recv_message()\n", test);
514 origin_recv_message (void *cls,
515 const struct GNUNET_MULTICAST_MessageHeader *msg)
517 struct OriginClosure *ocls = cls;
518 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
519 "Test #%u: origin_recv_message() %u/%u\n",
520 test, ocls->n + 1, ocls->msgs_expected);
521 if (++ocls->n != ocls->msgs_expected)
524 // FIXME: check message content
528 case TEST_ORIGIN_TO_ALL:
529 // Prepare to execute test 5
530 test = TEST_ORIGIN_TO_ALL_RECV;
534 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
535 "Invalid test #%d in origin_recv_message()\n", test);
544 test = TEST_ORIGIN_TO_ALL;
545 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
546 "Test #%u: origin_to_all()\n", test);
548 struct TransmitClosure *tmit = &tmit_cls;
549 *tmit = (struct TransmitClosure) {};
550 tmit->data[0] = "ABC DEF";
551 tmit->data[1] = GNUNET_malloc (GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD + 1);
553 for (i = 0; i < GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD; i++)
554 tmit->data[1][i] = (0 == i % 10000) ? '0' + i / 10000 : '_';
555 tmit->data[2] = "GHI JKL MNO";
556 tmit->data_delay[2] = 2;
557 tmit->data[3] = "PQR STUW XYZ";
558 tmit->data_count = 4;
560 origin_cls.n = member_cls.n = 0;
561 origin_cls.msgs_expected = member_cls.msgs_expected = tmit->data_count;
563 tmit->orig_tmit = GNUNET_MULTICAST_origin_to_all (origin, 1, 1,
569 member_recv_join_decision (void *cls,
571 const struct GNUNET_PeerIdentity *peer,
572 uint16_t relay_count,
573 const struct GNUNET_PeerIdentity *relays,
574 const struct GNUNET_MessageHeader *join_msg)
576 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
577 "Test #%u: member_recv_join_decision() - is_admitted: %d\n",
580 GNUNET_assert (join_msg->size == join_resp->size);
581 GNUNET_assert (join_msg->type == join_resp->type);
582 GNUNET_assert (0 == memcmp (join_msg, join_resp, ntohs (join_resp->size)));
586 case TEST_MEMBER_JOIN_REFUSE:
587 GNUNET_assert (0 == relay_count);
588 // Test 3 starts here
589 GNUNET_SCHEDULER_add_now (&schedule_member_part, NULL);
592 case TEST_MEMBER_JOIN_ADMIT:
593 GNUNET_assert (1 == relay_count);
594 GNUNET_assert (0 == memcmp (relays, &this_peer, sizeof (this_peer)));
595 // Test 4 starts here
600 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
601 "Invalid test #%d in member_recv_join_decision()\n", test);
607 * Test: origin receives join request
610 origin_recv_join_request (void *cls,
611 const struct GNUNET_CRYPTO_EcdsaPublicKey *mem_key,
612 const struct GNUNET_MessageHeader *join_msg,
613 struct GNUNET_MULTICAST_JoinHandle *jh)
615 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
616 "Test #%u: origin_recv_join_request()\n", test);
618 GNUNET_assert (0 == memcmp (mem_key, &member_pub_key, sizeof (member_pub_key)));
619 GNUNET_assert (join_msg->size == join_req->size);
620 GNUNET_assert (join_msg->type == join_req->type);
621 GNUNET_assert (0 == memcmp (join_msg, join_req, ntohs (join_req->size)));
623 char data[] = "here's the decision";
624 uint8_t data_size = strlen (data) + 1;
625 join_resp = GNUNET_malloc (sizeof (join_resp) + data_size);
626 join_resp->size = htons (sizeof (join_resp) + data_size);
627 join_resp->type = htons (456);
628 GNUNET_memcpy (&join_resp[1], data, data_size);
632 case TEST_MEMBER_JOIN_REFUSE:
633 // Test 3 starts here
634 GNUNET_MULTICAST_join_decision (jh, GNUNET_NO, 0, NULL, join_resp);
637 case TEST_MEMBER_JOIN_ADMIT:
639 GNUNET_MULTICAST_join_decision (jh, GNUNET_YES, 1, &this_peer, join_resp);
643 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
644 "Invalid test #%d in origin_recv_join_request()\n", test);
651 * Test: member joins multicast group
657 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
658 "Test #%u: member_join()\n", test);
660 member_key = GNUNET_CRYPTO_ecdsa_key_create ();
661 GNUNET_CRYPTO_ecdsa_key_get_public (member_key, &member_pub_key);
663 if (NULL != join_req)
664 GNUNET_free (join_req);
666 char data[] = "let me in!";
667 uint8_t data_size = strlen (data) + 1;
668 join_req = GNUNET_malloc (sizeof (join_req) + data_size);
669 join_req->size = htons (sizeof (join_req) + data_size);
670 join_req->type = htons (123);
671 GNUNET_memcpy (&join_req[1], data, data_size);
673 member = GNUNET_MULTICAST_member_join (cfg, &group_pub_key, member_key,
674 &this_peer, 1, &this_peer, join_req,
675 member_recv_join_request,
676 member_recv_join_decision,
677 member_recv_replay_frag,
678 member_recv_replay_msg,
684 * Test: Start a multicast group as origin
689 test = TEST_ORIGIN_START;
690 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
691 "Test #%u: origin_start()\n", test);
693 group_key = GNUNET_CRYPTO_eddsa_key_create ();
694 GNUNET_CRYPTO_eddsa_key_get_public (group_key, &group_pub_key);
696 origin = GNUNET_MULTICAST_origin_start (cfg, group_key, 0,
697 origin_recv_join_request,
698 origin_recv_replay_frag,
699 origin_recv_replay_msg,
703 // Test 2 starts here
704 member_join (TEST_MEMBER_JOIN_REFUSE);
709 core_connected (void *cls, const struct GNUNET_PeerIdentity *my_identity)
711 this_peer = *my_identity;
713 // Test 1 starts here
719 * Main function of the test, run from scheduler.
722 * @param cfg configuration we use (also to connect to Multicast service)
723 * @param peer handle to access more of the peer (not used)
726 #if DEBUG_TEST_MULTICAST
730 const struct GNUNET_CONFIGURATION_Handle *c)
733 const struct GNUNET_CONFIGURATION_Handle *c,
734 struct GNUNET_TESTING_Peer *peer)
738 end_badly_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT,
740 core = GNUNET_CORE_connecT (cfg, NULL,
741 &core_connected, NULL, NULL, NULL);
746 main (int argc, char *argv[])
749 #if DEBUG_TEST_MULTICAST
750 const struct GNUNET_GETOPT_CommandLineOption opts[] = {
751 GNUNET_GETOPT_OPTION_END
753 if (GNUNET_OK != GNUNET_PROGRAM_run (argc, argv, "test-multicast",
754 "test-multicast [options]",
758 if (0 != GNUNET_TESTING_peer_run ("test-multicast", "test_multicast.conf", &run, NULL))
764 /* end of test_multicast.c */