2 * This file is part of GNUnet
3 * Copyright (C) 2013 Christian Grothoff (and other contributing authors)
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).
135 * @param tc scheduler context
138 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
142 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Test FAILED.\n");
147 * Terminate the test case (success).
150 * @param tc scheduler context
153 end_normally (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
157 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Test PASSED.\n");
162 * Finish the test case (successfully).
167 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Ending tests.\n");
169 if (end_badly_task != NULL)
171 GNUNET_SCHEDULER_cancel (end_badly_task);
172 end_badly_task = NULL;
174 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MILLISECONDS,
175 &end_normally, NULL);
180 tmit_resume (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
182 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmission resumed.\n");
183 struct TransmitClosure *tmit = cls;
184 if (NULL != tmit->orig_tmit)
185 GNUNET_MULTICAST_origin_to_all_resume (tmit->orig_tmit);
187 GNUNET_MULTICAST_member_to_origin_resume (tmit->mem_tmit);
192 tmit_notify (void *cls, size_t *data_size, void *data)
194 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
195 "Test #%u: origin_tmit_notify()\n", test);
196 struct TransmitClosure *tmit = cls;
198 if (0 == tmit->data_count)
204 uint16_t size = strlen (tmit->data[tmit->n]);
205 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
206 "Transmit notify data: %u bytes available, "
207 "processing fragment %u/%u (size %u).\n",
208 *data_size, tmit->n + 1, tmit->data_count, 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 memcpy (data, tmit->data[tmit->n], size);
232 return ++tmit->n < tmit->data_count ? GNUNET_NO : GNUNET_YES;
237 origin_recv_membership_test (void *cls,
238 const struct GNUNET_CRYPTO_EcdsaPublicKey *member_key,
240 uint64_t group_generation,
241 struct GNUNET_MULTICAST_MembershipTestHandle *mth)
243 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
244 "Test #%u: origin_recv_membership_test()\n", test);
249 member_recv_membership_test (void *cls,
250 const struct GNUNET_CRYPTO_EcdsaPublicKey *member_key,
252 uint64_t group_generation,
253 struct GNUNET_MULTICAST_MembershipTestHandle *mth)
255 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
256 "Test #%u: member_recv_membership_test()\n", test);
261 member_recv_join_request (void *cls,
262 const struct GNUNET_CRYPTO_EcdsaPublicKey *member_key,
263 const struct GNUNET_MessageHeader *join_msg,
264 struct GNUNET_MULTICAST_JoinHandle *jh)
266 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
267 "Test #%u: member_recv_join_request()\n", test);
272 origin_stopped (void *cls)
274 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
275 "Test #%u: origin_stopped()\n", test);
281 schedule_origin_stop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
283 test = TEST_ORIGIN_STOP;
284 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
285 "Test #%u: origin_stop()\n", test);
286 GNUNET_MULTICAST_origin_stop (origin, origin_stopped, NULL);
292 member_parted (void *cls)
294 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
295 "Test #%u: member_parted()\n", test);
300 case TEST_MEMBER_JOIN_REFUSE:
301 member_join (TEST_MEMBER_JOIN_ADMIT);
304 case TEST_MEMBER_PART:
305 GNUNET_SCHEDULER_add_now (schedule_origin_stop, NULL);
309 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
310 "Invalid test #%d in member_recv_join_decision()\n", test);
317 schedule_member_part (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
319 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
320 "Test #%u: schedule_member_part()\n", test);
321 GNUNET_MULTICAST_member_part (member, member_parted, NULL);
328 test = TEST_MEMBER_PART;
329 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
330 "Test #%u: member_part()\n", test);
331 GNUNET_SCHEDULER_add_now (schedule_member_part, NULL);
338 test = TEST_MEMBER_REPLAY_OK;
339 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
340 "Test #%u: member_replay_ok()\n", test);
341 replay_fragment_id = 1;
342 replay_flags = 1 | 1<<11;
343 GNUNET_MULTICAST_member_replay_fragment (member, replay_fragment_id,
344 replay_flags, NULL, NULL);
349 member_replay_error ()
351 test = TEST_MEMBER_REPLAY_ERROR;
352 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
353 "Test #%u: member_replay_error()\n", test);
354 replay_fragment_id = 1234;
355 replay_flags = 11 | 1<<11;
356 GNUNET_MULTICAST_member_replay_fragment (member, replay_fragment_id,
357 replay_flags, NULL, NULL);
362 origin_recv_replay_msg (void *cls,
363 const struct GNUNET_CRYPTO_EcdsaPublicKey *member_key,
365 uint64_t fragment_offset,
367 struct GNUNET_MULTICAST_ReplayHandle *rh)
369 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
370 "Test #%u: origin_recv_replay_msg()\n", test);
376 member_recv_replay_msg (void *cls,
377 const struct GNUNET_CRYPTO_EcdsaPublicKey *member_key,
379 uint64_t fragment_offset,
381 struct GNUNET_MULTICAST_ReplayHandle *rh)
383 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
384 "Test #%u: member_recv_replay_msg()\n", test);
390 origin_recv_replay_frag (void *cls,
391 const struct GNUNET_CRYPTO_EcdsaPublicKey *member_key,
392 uint64_t fragment_id,
394 struct GNUNET_MULTICAST_ReplayHandle *rh)
396 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
397 "Test #%u: origin_recv_replay_frag()"
398 " - fragment_id=%" PRIu64 " flags=%" PRIu64 "\n",
399 test, fragment_id, flags);
400 GNUNET_assert (replay_fragment_id == fragment_id && replay_flags == flags);
403 case TEST_MEMBER_REPLAY_ERROR:
404 GNUNET_MULTICAST_replay_response (rh, NULL, GNUNET_SYSERR);
408 case TEST_MEMBER_REPLAY_OK:
410 struct GNUNET_MULTICAST_MessageHeader mmsg = {
412 .type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_MESSAGE),
413 .size = htons (sizeof (mmsg)),
415 .fragment_id = GNUNET_htonll (1),
416 .message_id = GNUNET_htonll (1),
417 .fragment_offset = 0,
418 .group_generation = GNUNET_htonll (1),
422 member_cls.msgs_expected = 1;
423 GNUNET_MULTICAST_replay_response (rh, &mmsg.header, GNUNET_MULTICAST_REC_OK);
424 GNUNET_MULTICAST_replay_response_end (rh);
429 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
430 "Invalid test #%d in origin_recv_replay_frag()\n", test);
437 member_recv_replay_frag (void *cls,
438 const struct GNUNET_CRYPTO_EcdsaPublicKey *member_key,
439 uint64_t fragment_id,
441 struct GNUNET_MULTICAST_ReplayHandle *rh)
443 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
444 "Test #%u: member_recv_replay_frag()\n", test);
450 origin_recv_request (void *cls,
451 const struct GNUNET_MULTICAST_RequestHeader *req)
453 struct OriginClosure *ocls = cls;
454 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
455 "Test #%u: origin_recv_request()\n", test);
456 if (++ocls->n != ocls->msgs_expected)
459 GNUNET_assert (0 == memcmp (&req->member_key,
460 &member_pub_key, sizeof (member_pub_key)));
463 // FIXME: check message content
465 member_replay_error ();
472 test = TEST_MEMBER_TO_ORIGIN;
473 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
474 "Test #%u: member_to_origin()\n", test);
476 struct TransmitClosure *tmit = &tmit_cls;
477 *tmit = (struct TransmitClosure) {};
478 tmit->data[0] = "abc def";
479 tmit->data[1] = "ghi jkl mno";
480 tmit->data_delay[1] = 1;
481 tmit->data[2] = "pqr stuw xyz";
482 tmit->data_count = 3;
485 origin_cls.msgs_expected = 1;
487 GNUNET_MULTICAST_member_to_origin (member, 1, tmit_notify, tmit);
492 member_recv_message (void *cls,
493 const struct GNUNET_MULTICAST_MessageHeader *msg)
495 struct MemberClosure *mcls = cls;
496 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
497 "Test #%u: member_recv_message() %u/%u\n",
498 test, mcls->n + 1, mcls->msgs_expected);
499 if (++mcls->n != mcls->msgs_expected)
502 // FIXME: check message content
506 case TEST_ORIGIN_TO_ALL_RECV:
510 case TEST_MEMBER_REPLAY_OK:
511 GNUNET_assert (replay_fragment_id == GNUNET_ntohll (msg->fragment_id));
516 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
517 "Invalid test #%d in origin_recv_message()\n", test);
524 origin_recv_message (void *cls,
525 const struct GNUNET_MULTICAST_MessageHeader *msg)
527 struct OriginClosure *ocls = cls;
528 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
529 "Test #%u: origin_recv_message() %u/%u\n",
530 test, ocls->n + 1, ocls->msgs_expected);
531 if (++ocls->n != ocls->msgs_expected)
534 // FIXME: check message content
538 case TEST_ORIGIN_TO_ALL:
539 test = TEST_ORIGIN_TO_ALL_RECV;
543 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
544 "Invalid test #%d in origin_recv_message()\n", test);
553 test = TEST_ORIGIN_TO_ALL;
554 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
555 "Test #%u: origin_to_all()\n", test);
557 struct TransmitClosure *tmit = &tmit_cls;
558 *tmit = (struct TransmitClosure) {};
559 tmit->data[0] = "ABC DEF";
560 tmit->data[1] = "GHI JKL MNO";
561 tmit->data_delay[1] = 1;
562 tmit->data[2] = "PQR STUW XYZ";
563 tmit->data_count = 3;
565 origin_cls.n = member_cls.n = 0;
566 origin_cls.msgs_expected = member_cls.msgs_expected = 1;
568 GNUNET_MULTICAST_origin_to_all (origin, 1, 1, tmit_notify, tmit);
573 member_recv_join_decision (void *cls,
575 const struct GNUNET_PeerIdentity *peer,
576 uint16_t relay_count,
577 const struct GNUNET_PeerIdentity *relays,
578 const struct GNUNET_MessageHeader *join_msg)
580 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
581 "Test #%u: member_recv_join_decision() - is_admitted: %d\n",
584 GNUNET_assert (join_msg->size == join_resp->size);
585 GNUNET_assert (join_msg->type == join_resp->type);
586 GNUNET_assert (0 == memcmp (join_msg, join_resp, ntohs (join_resp->size)));
590 case TEST_MEMBER_JOIN_REFUSE:
591 GNUNET_assert (0 == relay_count);
592 GNUNET_SCHEDULER_add_now (schedule_member_part, NULL);
595 case TEST_MEMBER_JOIN_ADMIT:
596 GNUNET_assert (1 == relay_count);
597 GNUNET_assert (0 == memcmp (relays, &this_peer, sizeof (this_peer)));
602 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
603 "Invalid test #%d in member_recv_join_decision()\n", test);
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_DEBUG,
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 memcpy (&join_resp[1], data, data_size);
632 case TEST_MEMBER_JOIN_REFUSE:
633 GNUNET_MULTICAST_join_decision (jh, GNUNET_NO, 0, NULL, join_resp);
636 case TEST_MEMBER_JOIN_ADMIT:
637 GNUNET_MULTICAST_join_decision (jh, GNUNET_YES, 1, &this_peer, join_resp);
641 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
642 "Invalid test #%d in origin_recv_join_request()\n", test);
653 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
654 "Test #%u: member_join()\n", test);
656 member_key = GNUNET_CRYPTO_ecdsa_key_create ();
657 GNUNET_CRYPTO_ecdsa_key_get_public (member_key, &member_pub_key);
659 if (NULL != join_req)
660 GNUNET_free (join_req);
662 char data[] = "let me in!";
663 uint8_t data_size = strlen (data) + 1;
664 join_req = GNUNET_malloc (sizeof (join_req) + data_size);
665 join_req->size = htons (sizeof (join_req) + data_size);
666 join_req->type = htons (123);
667 memcpy (&join_req[1], data, data_size);
669 member = GNUNET_MULTICAST_member_join (cfg, &group_pub_key, member_key,
670 &this_peer, 1, &this_peer, join_req,
671 member_recv_join_request,
672 member_recv_join_decision,
673 member_recv_membership_test,
674 member_recv_replay_frag,
675 member_recv_replay_msg,
684 test = TEST_ORIGIN_START;
685 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
686 "Test #%u: origin_start()\n", test);
688 group_key = GNUNET_CRYPTO_eddsa_key_create ();
689 GNUNET_CRYPTO_eddsa_key_get_public (group_key, &group_pub_key);
691 origin = GNUNET_MULTICAST_origin_start (cfg, group_key, 0,
692 origin_recv_join_request,
693 origin_recv_membership_test,
694 origin_recv_replay_frag,
695 origin_recv_replay_msg,
699 member_join (TEST_MEMBER_JOIN_REFUSE);
704 core_connected (void *cls, const struct GNUNET_PeerIdentity *my_identity)
706 this_peer = *my_identity;
712 * Main function of the test, run from scheduler.
715 * @param cfg configuration we use (also to connect to Multicast service)
716 * @param peer handle to access more of the peer (not used)
719 #if DEBUG_TEST_MULTICAST
720 run (void *cls, char *const *args, const char *cfgfile,
721 const struct GNUNET_CONFIGURATION_Handle *c)
724 const struct GNUNET_CONFIGURATION_Handle *c,
725 struct GNUNET_TESTING_Peer *peer)
729 end_badly_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
731 core = GNUNET_CORE_connect (cfg, NULL, &core_connected, NULL, NULL,
732 NULL, GNUNET_NO, NULL, GNUNET_NO, NULL);
737 main (int argc, char *argv[])
740 #if DEBUG_TEST_MULTICAST
741 const struct GNUNET_GETOPT_CommandLineOption opts[] = {
742 GNUNET_GETOPT_OPTION_END
744 if (GNUNET_OK != GNUNET_PROGRAM_run (argc, argv, "test-multicast",
745 "test-multicast [options]",
749 if (0 != GNUNET_TESTING_peer_run ("test-multicast", "test_multicast.conf", &run, NULL))
755 /* end of test_multicast.c */