2 This file is part of GNUnet.
3 (C) 2009 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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
21 * @file testing/test_testing_topology_blacklist.c
22 * @brief base testcase for testing transport level blacklisting
25 #include "gnunet_testing_lib.h"
26 #include "gnunet_core_service.h"
28 #define VERBOSE GNUNET_EXTRA_LOGGING
31 * How long until we fail the whole testcase?
33 #define TEST_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 600)
36 * How long until we give up on starting the peers? (Must be longer than the connect timeout!)
38 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 300)
40 #define DEFAULT_NUM_PEERS 4
42 #define MAX_OUTSTANDING_CONNECTIONS 300
46 struct GNUNET_TIME_Relative connect_timeout;
48 static unsigned long long connect_attempts;
50 static unsigned long long num_peers;
52 static unsigned int total_connections;
54 static unsigned int failed_connections;
56 static unsigned int expected_connections;
58 static unsigned int expected_failed_connections;
60 static unsigned long long peers_left;
62 static struct GNUNET_TESTING_PeerGroup *pg;
64 const struct GNUNET_CONFIGURATION_Handle *main_cfg;
66 GNUNET_SCHEDULER_TaskIdentifier die_task;
68 static char *dotOutFileName;
70 static FILE *dotOutFile;
72 static char *blacklist_transports;
74 static enum GNUNET_TESTING_Topology topology = GNUNET_TESTING_TOPOLOGY_CLIQUE; /* Overlay should allow all connections */
76 static enum GNUNET_TESTING_Topology blacklist_topology = GNUNET_TESTING_TOPOLOGY_RING; /* Blacklist underlay into a ring */
78 static enum GNUNET_TESTING_Topology connection_topology = GNUNET_TESTING_TOPOLOGY_NONE; /* NONE actually means connect all allowed peers */
80 static enum GNUNET_TESTING_TopologyOption connect_topology_option = GNUNET_TESTING_TOPOLOGY_OPTION_ALL; /* Try to connect all possible OVERLAY connections */
82 static double connect_topology_option_modifier = 0.0;
84 static char *test_directory;
88 struct GNUNET_TestMessage
91 * Header of the message
93 struct GNUNET_MessageHeader header;
96 * Unique identifier for this message.
103 * Check whether peers successfully shut down.
106 shutdown_callback (void *cls, const char *emsg)
111 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutdown of peers failed!\n");
119 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "All peers successfully shut down!\n");
127 GNUNET_assert (pg != NULL);
130 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
131 "Called finish testing, stopping daemons.\n");
135 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Calling daemons_stop\n");
137 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
139 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "daemons_stop finished\n");
141 if (dotOutFile != NULL)
143 fprintf (dotOutFile, "}");
151 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
155 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
156 "End badly was called (%s)... stopping daemons.\n", msg);
160 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
161 ok = 7331; /* Opposite of leet */
164 ok = 401; /* Never got peers started */
166 if (dotOutFile != NULL)
168 fprintf (dotOutFile, "}");
176 topology_callback (void *cls, const struct GNUNET_PeerIdentity *first,
177 const struct GNUNET_PeerIdentity *second, uint32_t distance,
178 const struct GNUNET_CONFIGURATION_Handle *first_cfg,
179 const struct GNUNET_CONFIGURATION_Handle *second_cfg,
180 struct GNUNET_TESTING_Daemon *first_daemon,
181 struct GNUNET_TESTING_Daemon *second_daemon,
188 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "connected peer %s to peer %s\n",
189 first_daemon->shortname, second_daemon->shortname);
191 if (dotOutFile != NULL)
192 fprintf (dotOutFile, "\tn%s -- n%s;\n", first_daemon->shortname,
193 second_daemon->shortname);
198 failed_connections++;
200 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
201 "Failed to connect peer %s to peer %s with error :\n%s\n",
202 first_daemon->shortname, second_daemon->shortname, emsg);
207 if (total_connections == expected_connections)
210 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
211 "Created %d total connections, which is our target number (that's bad)!\n",
215 GNUNET_SCHEDULER_cancel (die_task);
216 die_task = GNUNET_SCHEDULER_NO_TASK;
218 GNUNET_SCHEDULER_add_now (&end_badly,
219 "from topology_callback (too many successful connections)");
221 else if (total_connections + failed_connections == expected_connections)
223 if ((failed_connections == expected_failed_connections) &&
224 (total_connections ==
225 expected_connections - expected_failed_connections))
227 GNUNET_SCHEDULER_cancel (die_task);
228 die_task = GNUNET_SCHEDULER_NO_TASK;
229 die_task = GNUNET_SCHEDULER_add_now (&finish_testing, NULL);
233 GNUNET_SCHEDULER_cancel (die_task);
235 GNUNET_SCHEDULER_add_now (&end_badly,
236 "from topology_callback (wrong number of failed connections)");
242 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
243 "Have %d total connections, %d failed connections, Want %d (failed) and %d (successful)\n",
244 total_connections, failed_connections,
245 expected_failed_connections,
246 expected_connections - expected_failed_connections);
254 expected_connections = -1;
255 if ((pg != NULL) && (peers_left == 0))
257 expected_connections =
258 GNUNET_TESTING_connect_topology (pg, connection_topology,
259 connect_topology_option,
260 connect_topology_option_modifier,
261 connect_timeout, connect_attempts,
264 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Have %d expected connections\n",
265 expected_connections);
269 GNUNET_SCHEDULER_cancel (die_task);
270 if (expected_connections == GNUNET_SYSERR)
273 GNUNET_SCHEDULER_add_now (&end_badly,
274 "from connect topology (bad return)");
278 GNUNET_SCHEDULER_add_delayed (TEST_TIMEOUT, &end_badly,
279 "from connect topology (timeout)");
285 peers_left = num_peers; /* Reset counter */
286 if (GNUNET_TESTING_create_topology
287 (pg, topology, blacklist_topology, blacklist_transports) != GNUNET_SYSERR)
290 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
291 "Topology set up, now starting peers!\n");
293 GNUNET_TESTING_daemons_continue_startup (pg);
297 GNUNET_SCHEDULER_cancel (die_task);
299 GNUNET_SCHEDULER_add_now (&end_badly,
300 "from create topology (bad return)");
302 GNUNET_SCHEDULER_cancel (die_task);
304 GNUNET_SCHEDULER_add_delayed (TEST_TIMEOUT, &end_badly,
305 "from continue startup (timeout)");
310 peers_started_callback (void *cls, const struct GNUNET_PeerIdentity *id,
311 const struct GNUNET_CONFIGURATION_Handle *cfg,
312 struct GNUNET_TESTING_Daemon *d, const char *emsg)
316 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
317 "Failed to start daemon with error: `%s'\n", emsg);
320 GNUNET_assert (id != NULL);
322 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Started daemon %llu out of %llu\n",
323 (num_peers - peers_left) + 1, num_peers);
329 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
330 "All %d daemons started, now creating topology!\n", num_peers);
332 GNUNET_SCHEDULER_cancel (die_task);
333 /* Set up task in case topology creation doesn't finish
334 * within a reasonable amount of time */
336 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
337 (GNUNET_TIME_UNIT_MINUTES, 5), &end_badly,
338 "from peers_started_callback");
345 * Callback indicating that the hostkey was created for a peer.
348 * @param id the peer identity
349 * @param d the daemon handle (pretty useless at this point, remove?)
350 * @param emsg non-null on failure
353 hostkey_callback (void *cls, const struct GNUNET_PeerIdentity *id,
354 struct GNUNET_TESTING_Daemon *d, const char *emsg)
358 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
359 "Hostkey callback received error: %s\n", emsg);
363 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Hostkey created for peer `%s'\n",
370 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
371 "All %d hostkeys created, now creating topology!\n", num_peers);
373 GNUNET_SCHEDULER_cancel (die_task);
374 /* Set up task in case topology creation doesn't finish
375 * within a reasonable amount of time */
377 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
378 (GNUNET_TIME_UNIT_MINUTES, 5), &end_badly,
379 "from hostkey_callback");
380 GNUNET_SCHEDULER_add_now (&create_topology, NULL);
386 run (void *cls, char *const *args, const char *cfgfile,
387 const struct GNUNET_CONFIGURATION_Handle *cfg)
389 unsigned long long topology_num;
390 unsigned long long connect_topology_num;
391 unsigned long long blacklist_topology_num;
392 unsigned long long connect_topology_option_num;
393 unsigned long long temp_connect;
394 char *connect_topology_option_modifier_string;
398 dotOutFile = fopen (dotOutFileName, "w");
399 if (dotOutFile != NULL)
401 fprintf (dotOutFile, "strict graph G {\n");
405 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
406 "Starting daemons based on config file %s\n", cfgfile);
410 GNUNET_CONFIGURATION_get_value_string (cfg, "paths", "servicehome",
414 if (dotOutFile != NULL)
422 GNUNET_CONFIGURATION_get_value_number (cfg, "testing", "topology",
424 topology = topology_num;
427 GNUNET_CONFIGURATION_get_value_number (cfg, "testing", "connect_topology",
428 &connect_topology_num))
429 connection_topology = connect_topology_num;
432 GNUNET_CONFIGURATION_get_value_number (cfg, "testing",
433 "connect_topology_option",
434 &connect_topology_option_num))
435 connect_topology_option = connect_topology_option_num;
438 GNUNET_CONFIGURATION_get_value_string (cfg, "testing",
439 "connect_topology_option_modifier",
440 &connect_topology_option_modifier_string))
443 (connect_topology_option_modifier_string, "%lf",
444 &connect_topology_option_modifier) != 1)
446 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
448 ("Invalid value `%s' for option `%s' in section `%s': expected float\n"),
449 connect_topology_option_modifier_string,
450 "connect_topology_option_modifier", "TESTING");
451 GNUNET_free (connect_topology_option_modifier_string);
453 if (dotOutFile != NULL)
459 GNUNET_free (connect_topology_option_modifier_string);
463 GNUNET_CONFIGURATION_get_value_string (cfg, "testing",
464 "blacklist_transports",
465 &blacklist_transports))
467 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
468 "No transports specified for blacklisting in blacklist testcase (this shouldn't happen!)\n");
470 if (dotOutFile != NULL)
478 GNUNET_CONFIGURATION_get_value_number (cfg, "testing",
479 "blacklist_topology",
480 &blacklist_topology_num))
481 blacklist_topology = blacklist_topology_num;
484 GNUNET_CONFIGURATION_get_value_number (cfg, "testing", "num_peers",
486 num_peers = DEFAULT_NUM_PEERS;
489 GNUNET_CONFIGURATION_get_value_number (cfg, "testing", "connect_timeout",
492 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, temp_connect);
495 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Must provide option %s:%s!\n",
496 "testing", "connect_timeout");
502 GNUNET_CONFIGURATION_get_value_number (cfg, "testing", "connect_attempts",
505 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Must provide option %s:%s!\n",
506 "testing", "connect_attempts");
512 GNUNET_assert (num_peers > 0 && num_peers < (unsigned int) -1);
513 peers_left = num_peers;
515 /* For this specific test we only really want a CLIQUE topology as the
516 * overlay allowed topology, and a RING topology as the underlying connection
517 * allowed topology. So we will expect only num_peers * 2 connections to
518 * work, and (num_peers * (num_peers - 1)) - (num_peers * 2) to fail.
520 expected_connections = num_peers * (num_peers - 1);
521 expected_failed_connections = expected_connections - (num_peers * 2);
524 /* Set up a task to end testing if peer start fails */
526 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
527 (GNUNET_TIME_UNIT_MINUTES, 5), &end_badly,
528 "didn't start all daemons in reasonable amount of time!!!");
530 pg = GNUNET_TESTING_daemons_start (cfg, peers_left, peers_left, peers_left,
531 TIMEOUT, &hostkey_callback, NULL,
532 &peers_started_callback, NULL,
533 &topology_callback, NULL, NULL);
542 char *const argv[] = { "test-testing-topology-blacklist",
544 "test_testing_data_topology_blacklist.conf",
550 struct GNUNET_GETOPT_CommandLineOption options[] = {
551 GNUNET_GETOPT_OPTION_END
554 GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
555 "test-testing-topology-blacklist", "nohelp", options,
557 if (ret != GNUNET_OK)
559 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
560 "`test-testing-topology-blacklist': Failed with error code %d\n",
568 main (int argc, char *argv[])
572 GNUNET_log_setup ("test_testing_topology_blacklist",
582 * Need to remove base directory, subdirectories taken care
583 * of by the testing framework.
585 if (test_directory != NULL)
587 if (GNUNET_DISK_directory_remove (test_directory) != GNUNET_OK)
589 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
590 "Failed to remove testing directory %s\n", test_directory);
597 /* end of test_testing_topology_blacklist.c */