2 This file is part of GNUnet
3 (C) 2008, 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 2, 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.
22 * @file testing/testing.c
23 * @brief convenience API for writing testcases for GNUnet
24 * Many testcases need to start and stop gnunetd,
25 * and this library is supposed to make that easier
26 * for TESTCASES. Normal programs should always
27 * use functions from gnunet_{util,arm}_lib.h. This API is
28 * ONLY for writing testcases!
29 * @author Christian Grothoff
33 #include "gnunet_arm_service.h"
34 #include "gnunet_core_service.h"
35 #include "gnunet_constants.h"
36 #include "gnunet_testing_lib.h"
37 #include "gnunet_transport_service.h"
38 #include "gnunet_hello_lib.h"
40 #define DEBUG_TESTING GNUNET_NO
41 #define DEBUG_TESTING_RECONNECT GNUNET_NO
44 * How long do we wait after starting gnunet-service-arm
45 * for the core service to be alive?
47 #define ARM_START_WAIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 120)
50 * How many times are we willing to try to wait for "scp" or
51 * "gnunet-service-arm" to complete (waitpid) before giving up?
53 #define MAX_EXEC_WAIT_RUNS 250
55 static struct GNUNET_CORE_MessageHandler no_handlers[] = { {NULL, 0, 0} };
58 * Receive the HELLO from one peer, give it to the other
59 * and ask them to connect.
61 * @param cls "struct ConnectContext"
62 * @param message HELLO message of peer
65 process_hello (void *cls, const struct GNUNET_MessageHeader *message)
67 struct GNUNET_TESTING_Daemon *daemon = cls;
71 if (daemon->server != NULL)
73 GNUNET_CORE_disconnect(daemon->server);
74 daemon->server = NULL;
77 GNUNET_assert (message != NULL);
78 if (daemon->th != NULL)
80 GNUNET_TRANSPORT_get_hello_cancel(daemon->th, &process_hello, daemon);
83 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
84 "Received `%s' from transport service of `%4s'\n",
85 "HELLO", GNUNET_i2s (&daemon->id));
88 GNUNET_free_non_null(daemon->hello);
89 daemon->hello = GNUNET_malloc(ntohs(message->size));
90 memcpy(daemon->hello, message, ntohs(message->size));
92 if (daemon->th != NULL)
94 GNUNET_TRANSPORT_disconnect(daemon->th);
101 * Function called after GNUNET_CORE_connect has succeeded
102 * (or failed for good). Note that the private key of the
103 * peer is intentionally not exposed here; if you need it,
104 * your process should try to read the private key file
105 * directly (which should work if you are authorized...).
108 * @param server handle to the server, NULL if we failed
109 * @param my_identity ID of this peer, NULL if we failed
110 * @param publicKey public key of this peer, NULL if we failed
113 testing_init (void *cls,
114 struct GNUNET_CORE_Handle *server,
115 const struct GNUNET_PeerIdentity *my_identity,
116 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *publicKey)
118 struct GNUNET_TESTING_Daemon *d = cls;
119 GNUNET_TESTING_NotifyDaemonRunning cb;
121 GNUNET_assert (d->phase == SP_START_CORE);
122 d->phase = SP_START_DONE;
128 if (GNUNET_YES == d->dead)
129 GNUNET_TESTING_daemon_stop (d, GNUNET_TIME_absolute_get_remaining(d->max_timeout), d->dead_cb, d->dead_cb_cls, GNUNET_YES, GNUNET_NO);
131 cb (d->cb_cls, NULL, d->cfg, d,
132 _("Failed to connect to core service\n"));
136 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
137 "Successfully started peer `%4s'.\n", GNUNET_i2s (my_identity));
139 d->id = *my_identity;
140 d->shortname = strdup (GNUNET_i2s (my_identity));
142 d->running = GNUNET_YES;
143 if (GNUNET_YES == d->dead)
144 GNUNET_TESTING_daemon_stop (d, GNUNET_TIME_absolute_get_remaining(d->max_timeout), d->dead_cb, d->dead_cb_cls, GNUNET_YES, GNUNET_NO);
146 cb (d->cb_cls, my_identity, d->cfg, d, NULL);
148 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
149 "Successfully started peer `%4s'.\n", GNUNET_i2s (my_identity));
153 d->th = GNUNET_TRANSPORT_connect (d->sched,
154 d->cfg, d, NULL, NULL, NULL);
157 if (GNUNET_YES == d->dead)
158 GNUNET_TESTING_daemon_stop (d, GNUNET_TIME_absolute_get_remaining(d->max_timeout), d->dead_cb, d->dead_cb_cls, GNUNET_YES, GNUNET_NO);
159 else if (NULL != d->cb)
160 d->cb (d->cb_cls, &d->id, d->cfg, d,
161 _("Failed to connect to transport service!\n"));
165 GNUNET_TRANSPORT_get_hello (d->th, &process_hello, d);
170 * Finite-state machine for starting GNUnet.
172 * @param cls our "struct GNUNET_TESTING_Daemon"
176 start_fsm (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
178 struct GNUNET_TESTING_Daemon *d = cls;
179 GNUNET_TESTING_NotifyDaemonRunning cb;
180 enum GNUNET_OS_ProcessStatusType type;
184 static char hostkeybuf[105];
185 static const char temphostkey[104];
188 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
189 "Peer FSM is in phase %u.\n", d->phase);
192 d->task = GNUNET_SCHEDULER_NO_TASK;
196 /* confirm copying complete */
197 if (GNUNET_OK != GNUNET_OS_process_status (d->pid, &type, &code))
199 if (GNUNET_TIME_absolute_get_remaining(d->max_timeout).value == 0)
206 d->cfg, d, _("`scp' does not seem to terminate (timeout copying config).\n"));
211 = GNUNET_SCHEDULER_add_delayed (d->sched,
212 GNUNET_CONSTANTS_EXEC_WAIT,
216 if ((type != GNUNET_OS_PROCESS_EXITED) || (code != 0))
222 NULL, d->cfg, d, _("`scp' did not complete cleanly.\n"));
226 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
227 "Successfully copied configuration file.\n");
229 d->phase = SP_COPIED;
232 /* Start create hostkey process */
233 d->pipe_stdout = GNUNET_DISK_pipe(GNUNET_NO);
234 if (d->pipe_stdout == NULL)
243 (NULL == d->hostname)
244 ? _("Failed to create pipe for `gnunet-peerinfo' process.\n")
245 : _("Failed to create pipe for `ssh' process.\n"));
248 if (NULL == d->hostname)
251 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
252 "Starting `%s', with command `%s %s %s %s'.\n",
253 "gnunet-peerinfo", "gnunet-peerinfo", "-c", d->cfgfile,
256 d->pid = GNUNET_OS_start_process (NULL, d->pipe_stdout, "gnunet-peerinfo",
260 GNUNET_DISK_pipe_close_end(d->pipe_stdout, GNUNET_DISK_PIPE_END_WRITE);
264 if (d->username != NULL)
265 GNUNET_asprintf (&dst, "%s@%s", d->username, d->hostname);
267 dst = GNUNET_strdup (d->hostname);
270 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
271 "Starting `%s', with command `%s %s %s %s %s %s'.\n",
272 "gnunet-peerinfo", "ssh", dst, "gnunet-peerinfo", "-c", d->cfgfile,
275 d->pid = GNUNET_OS_start_process (NULL, d->pipe_stdout, "ssh",
279 "-c", d->cfgfile, "-sq", NULL);
280 GNUNET_DISK_pipe_close_end(d->pipe_stdout, GNUNET_DISK_PIPE_END_WRITE);
285 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
286 _("Could not start `%s' process to create hostkey.\n"),
287 (NULL == d->hostname) ? "gnunet-peerinfo" : "ssh");
295 (NULL == d->hostname)
296 ? _("Failed to start `gnunet-peerinfo' process.\n")
297 : _("Failed to start `ssh' process.\n"));
298 GNUNET_DISK_pipe_close(d->pipe_stdout);
302 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
303 "Started `%s', waiting for hostkey.\n",
306 d->phase = SP_HOSTKEY_CREATE;
308 = GNUNET_SCHEDULER_add_delayed (d->sched,
309 GNUNET_CONSTANTS_EXEC_WAIT,
312 case SP_HOSTKEY_CREATE:
314 bytes_read = GNUNET_DISK_file_read(GNUNET_DISK_pipe_handle(d->pipe_stdout, GNUNET_DISK_PIPE_END_READ), &hostkeybuf, sizeof(hostkeybuf));
315 if (bytes_read == 104) /* Success, we have read in the hostkey */
317 if (hostkeybuf[103] == '\n')
318 hostkeybuf[103] = '\0';
320 GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "Malformed output from gnunet-peerinfo!\n");
321 memcpy(&temphostkey, &hostkeybuf, bytes_read);
323 if (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (&temphostkey[0],
326 GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "Failed to convert string to peer identity!\n");
330 GNUNET_DISK_pipe_close(d->pipe_stdout);
331 d->pipe_stdout = NULL;
335 if (GNUNET_OK != GNUNET_OS_process_status (d->pid, &type, &code))
337 if (GNUNET_TIME_absolute_get_remaining(d->max_timeout).value == 0)
346 (NULL == d->hostname)
347 ? _("`gnunet-peerinfo' does not seem to terminate.\n")
348 : _("`ssh' does not seem to terminate.\n"));
350 GNUNET_DISK_pipe_close(d->pipe_stdout);
355 = GNUNET_SCHEDULER_add_delayed (d->sched,
356 GNUNET_CONSTANTS_EXEC_WAIT,
361 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
362 "Successfully got hostkey!\n");
364 if (d->pipe_stdout != NULL)
373 _("`Failed to get hostkey!\n"));
374 GNUNET_DISK_pipe_close(d->pipe_stdout);
378 if (d->hostkey_callback != NULL)
380 d->hostkey_callback(d->hostkey_cls, &d->id, d, NULL);
381 d->phase = SP_HOSTKEY_CREATED;
385 d->phase = SP_TOPOLOGY_SETUP;
389 case SP_HOSTKEY_CREATED:
390 /* wait for topology finished */
391 if ((GNUNET_YES == d->dead) || (GNUNET_TIME_absolute_get_remaining(d->max_timeout).value == 0))
400 _("`Failed while waiting for topology setup!\n"));
405 = GNUNET_SCHEDULER_add_delayed (d->sched,
406 GNUNET_CONSTANTS_EXEC_WAIT,
409 case SP_TOPOLOGY_SETUP:
410 /* start GNUnet on remote host */
411 if (NULL == d->hostname)
414 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
415 "Starting `%s', with command `%s %s %s %s %s %s'.\n",
416 "gnunet-arm", "gnunet-arm", "-c", d->cfgfile,
420 d->pid = GNUNET_OS_start_process (NULL, NULL, "gnunet-arm",
430 if (d->username != NULL)
431 GNUNET_asprintf (&dst, "%s@%s", d->username, d->hostname);
433 dst = GNUNET_strdup (d->hostname);
436 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
437 "Starting `%s', with command `%s %s %s %s %s %s %s %s'.\n",
438 "gnunet-arm", "ssh", dst, "gnunet-arm", "-c", d->cfgfile,
439 "-L", "DEBUG", "-s", "-q");
441 d->pid = GNUNET_OS_start_process (NULL, NULL, "ssh",
448 "-c", d->cfgfile, "-s", "-q", NULL);
453 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
454 _("Could not start `%s' process to start GNUnet.\n"),
455 (NULL == d->hostname) ? "gnunet-arm" : "ssh");
463 (NULL == d->hostname)
464 ? _("Failed to start `gnunet-arm' process.\n")
465 : _("Failed to start `ssh' process.\n"));
469 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
470 "Started `%s', waiting for `%s' to be up.\n",
471 "gnunet-arm", "gnunet-service-core");
473 d->phase = SP_START_ARMING;
475 = GNUNET_SCHEDULER_add_delayed (d->sched,
476 GNUNET_CONSTANTS_EXEC_WAIT,
479 case SP_START_ARMING:
480 if (GNUNET_OK != GNUNET_OS_process_status (d->pid, &type, &code))
482 if (GNUNET_TIME_absolute_get_remaining(d->max_timeout).value == 0)
491 (NULL == d->hostname)
492 ? _("`gnunet-arm' does not seem to terminate.\n")
493 : _("`ssh' does not seem to terminate.\n"));
498 = GNUNET_SCHEDULER_add_delayed (d->sched,
499 GNUNET_CONSTANTS_EXEC_WAIT,
504 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
505 "Successfully started `%s'.\n", "gnunet-arm");
507 d->phase = SP_START_CORE;
508 d->server = GNUNET_CORE_connect (d->sched,
515 NULL, GNUNET_NO, no_handlers);
523 case SP_SHUTDOWN_START:
524 /* confirm copying complete */
525 if (GNUNET_OK != GNUNET_OS_process_status (d->pid, &type, &code))
527 if (GNUNET_TIME_absolute_get_remaining(d->max_timeout).value == 0)
529 d->dead_cb (d->dead_cb_cls,
530 _("either `gnunet-arm' or `ssh' does not seem to terminate.\n"));
533 GNUNET_TRANSPORT_get_hello_cancel(d->th, &process_hello, d);
534 GNUNET_TRANSPORT_disconnect(d->th);
537 GNUNET_CONFIGURATION_destroy (d->cfg);
538 GNUNET_free (d->cfgfile);
539 GNUNET_free_non_null(d->hello);
540 GNUNET_free_non_null (d->hostname);
541 GNUNET_free_non_null (d->username);
542 GNUNET_free_non_null (d->shortname);
547 fprintf(stderr, "scheduling in shutdown_start\n");
549 = GNUNET_SCHEDULER_add_delayed (d->sched,
550 GNUNET_CONSTANTS_EXEC_WAIT,
554 if ((type != GNUNET_OS_PROCESS_EXITED) || (code != 0))
556 if (NULL != d->dead_cb)
557 d->dead_cb (d->dead_cb_cls,
558 _("shutdown (either `gnunet-arm' or `ssh') did not complete cleanly.\n"));
561 GNUNET_TRANSPORT_get_hello_cancel(d->th, &process_hello, d);
562 GNUNET_TRANSPORT_disconnect(d->th);
565 GNUNET_CONFIGURATION_destroy (d->cfg);
566 GNUNET_free (d->cfgfile);
567 GNUNET_free_non_null(d->hello);
568 GNUNET_free_non_null (d->hostname);
569 GNUNET_free_non_null (d->username);
570 GNUNET_free_non_null (d->shortname);
575 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer shutdown complete.\n");
579 GNUNET_TRANSPORT_get_hello_cancel(d->th, &process_hello, d);
580 GNUNET_TRANSPORT_disconnect(d->th);
583 /* state clean up and notifications */
584 if (d->churn == GNUNET_NO)
586 GNUNET_CONFIGURATION_destroy (d->cfg);
587 GNUNET_free (d->cfgfile);
588 GNUNET_free_non_null (d->hostname);
589 GNUNET_free_non_null (d->username);
592 GNUNET_free_non_null(d->hello);
594 GNUNET_free_non_null (d->shortname);
596 if (NULL != d->dead_cb)
597 d->dead_cb (d->dead_cb_cls, NULL);
599 if (d->churn == GNUNET_NO)
603 case SP_CONFIG_UPDATE:
604 /* confirm copying complete */
605 if (GNUNET_OK != GNUNET_OS_process_status (d->pid, &type, &code))
607 if (GNUNET_TIME_absolute_get_remaining(d->max_timeout).value == 0) /* FIXME: config update should take timeout parameter! */
614 d->cfg, d, _("`scp' does not seem to terminate.\n"));
619 = GNUNET_SCHEDULER_add_delayed (d->sched,
620 GNUNET_CONSTANTS_EXEC_WAIT,
624 if ((type != GNUNET_OS_PROCESS_EXITED) || (code != 0))
626 if (NULL != d->update_cb)
627 d->update_cb (d->update_cb_cls,
628 _("`scp' did not complete cleanly.\n"));
632 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
633 "Successfully copied configuration file.\n");
635 if (NULL != d->update_cb)
636 d->update_cb (d->update_cb_cls, NULL);
637 d->phase = SP_START_DONE;
643 * Continues GNUnet daemon startup when user wanted to be notified
644 * once a hostkey was generated (for creating friends files, blacklists,
647 * @param daemon the daemon to finish starting
650 GNUNET_TESTING_daemon_continue_startup(struct GNUNET_TESTING_Daemon *daemon)
652 GNUNET_assert(daemon->phase == SP_HOSTKEY_CREATED);
653 daemon->phase = SP_TOPOLOGY_SETUP;
658 * Start a peer that has previously been stopped using the daemon_stop
659 * call (and files weren't deleted and the allow restart flag)
661 * @param daemon the daemon to start (has been previously stopped)
662 * @param timeout how long to wait for restart
663 * @param cb the callback for notification when the peer is running
664 * @param cb_cls closure for the callback
667 GNUNET_TESTING_daemon_start_stopped (struct GNUNET_TESTING_Daemon *daemon,
668 struct GNUNET_TIME_Relative timeout,
669 GNUNET_TESTING_NotifyDaemonRunning cb,
672 if (daemon->running == GNUNET_YES)
674 cb(cb_cls, &daemon->id, daemon->cfg, daemon, "Daemon already running, can't restart!");
679 daemon->cb_cls = cb_cls;
680 daemon->phase = SP_TOPOLOGY_SETUP;
681 daemon->max_timeout = GNUNET_TIME_relative_to_absolute(timeout);
683 GNUNET_SCHEDULER_add_continuation (daemon->sched,
686 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
690 * Starts a GNUnet daemon. GNUnet must be installed on the target
691 * system and available in the PATH. The machine must furthermore be
692 * reachable via "ssh" (unless the hostname is "NULL") without the
693 * need to enter a password.
695 * @param sched scheduler to use
696 * @param cfg configuration to use
697 * @param timeout how long to wait starting up peers
698 * @param hostname name of the machine where to run GNUnet
699 * (use NULL for localhost).
700 * @param hostkey_callback function to call once the hostkey has been
701 * generated for this peer, but it hasn't yet been started
702 * (NULL to start immediately, otherwise waits on GNUNET_TESTING_daemon_continue_start)
703 * @param hostkey_cls closure for hostkey callback
704 * @param cb function to call with the result
705 * @param cb_cls closure for cb
706 * @return handle to the daemon (actual start will be completed asynchronously)
708 struct GNUNET_TESTING_Daemon *
709 GNUNET_TESTING_daemon_start (struct GNUNET_SCHEDULER_Handle *sched,
710 const struct GNUNET_CONFIGURATION_Handle *cfg,
711 struct GNUNET_TIME_Relative timeout,
712 const char *hostname,
713 GNUNET_TESTING_NotifyHostkeyCreated hostkey_callback,
715 GNUNET_TESTING_NotifyDaemonRunning cb,
718 struct GNUNET_TESTING_Daemon *ret;
722 ret = GNUNET_malloc (sizeof (struct GNUNET_TESTING_Daemon));
724 ret->hostname = (hostname == NULL) ? NULL : GNUNET_strdup (hostname);
725 ret->cfgfile = GNUNET_DISK_mktemp ("gnunet-testing-config");
727 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
728 "Setting up peer with configuration file `%s'.\n",
731 if (NULL == ret->cfgfile)
733 GNUNET_free_non_null (ret->hostname);
737 ret->hostkey_callback = hostkey_callback;
738 ret->hostkey_cls = hostkey_cls;
740 ret->cb_cls = cb_cls;
741 ret->max_timeout = GNUNET_TIME_relative_to_absolute(timeout);
742 ret->cfg = GNUNET_CONFIGURATION_dup (cfg);
743 GNUNET_CONFIGURATION_set_value_string (ret->cfg,
745 "DEFAULTCONFIG", ret->cfgfile);
746 /* 1) write configuration to temporary file */
747 if (GNUNET_OK != GNUNET_CONFIGURATION_write (ret->cfg, ret->cfgfile))
749 if (0 != UNLINK (ret->cfgfile))
750 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
751 "unlink", ret->cfgfile);
752 GNUNET_CONFIGURATION_destroy (ret->cfg);
753 GNUNET_free_non_null (ret->hostname);
754 GNUNET_free (ret->cfgfile);
759 GNUNET_CONFIGURATION_get_value_string (cfg,
761 "USERNAME", &username))
763 if (NULL != getenv ("USER"))
764 username = GNUNET_strdup (getenv ("USER"));
768 ret->username = username;
770 /* 2) copy file to remote host */
771 if (NULL != hostname)
774 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
775 "Copying configuration file to host `%s'.\n", hostname);
777 ret->phase = SP_COPYING;
778 if (NULL != username)
779 GNUNET_asprintf (&arg, "%s@%s:%s", username, hostname, ret->cfgfile);
781 GNUNET_asprintf (&arg, "%s:%s", hostname, ret->cfgfile);
782 ret->pid = GNUNET_OS_start_process (NULL, NULL, "scp",
783 "scp", ret->cfgfile, arg, NULL);
787 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
789 ("Could not start `%s' process to copy configuration file.\n"),
791 if (0 != UNLINK (ret->cfgfile))
792 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
793 "unlink", ret->cfgfile);
794 GNUNET_CONFIGURATION_destroy (ret->cfg);
795 GNUNET_free_non_null (ret->hostname);
796 GNUNET_free_non_null (ret->username);
797 GNUNET_free (ret->cfgfile);
802 = GNUNET_SCHEDULER_add_delayed (sched,
803 GNUNET_CONSTANTS_EXEC_WAIT,
808 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
809 "No need to copy configuration file since we are running locally.\n");
811 ret->phase = SP_COPIED;
812 GNUNET_SCHEDULER_add_continuation (sched,
815 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
821 * Restart (stop and start) a GNUnet daemon.
823 * @param d the daemon that should be restarted
824 * @param cb function called once the daemon is (re)started
825 * @param cb_cls closure for cb
828 GNUNET_TESTING_daemon_restart (struct GNUNET_TESTING_Daemon *d,
829 GNUNET_TESTING_NotifyDaemonRunning cb, void *cb_cls)
837 d->dead = GNUNET_YES;
844 if (d->phase == SP_CONFIG_UPDATE)
846 GNUNET_SCHEDULER_cancel (d->sched, d->task);
847 d->phase = SP_START_DONE;
849 if (d->server != NULL)
851 GNUNET_CORE_disconnect (d->server);
857 GNUNET_TRANSPORT_get_hello_cancel(d->th, &process_hello, d);
858 GNUNET_TRANSPORT_disconnect(d->th);
861 /* state clean up and notifications */
862 GNUNET_free_non_null(d->hello);
865 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
866 _("Terminating peer `%4s'\n"), GNUNET_i2s (&d->id));
869 d->phase = SP_START_ARMING;
871 /* Check if this is a local or remote process */
872 if (NULL != d->hostname)
875 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
876 "Stopping gnunet-arm with config `%s' on host `%s'.\n", d->cfgfile, d->hostname);
879 if (d->username != NULL)
880 GNUNET_asprintf (&arg, "%s@%s", d->username, d->hostname);
882 arg = GNUNET_strdup (d->hostname);
884 d->pid = GNUNET_OS_start_process (NULL, NULL, "ssh", "ssh",
889 "-c", d->cfgfile, "-e", "-r", NULL);
890 /* Use -r to restart arm and all services */
897 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
898 "Stopping gnunet-arm with config `%s' locally.\n", d->cfgfile);
900 d->pid = GNUNET_OS_start_process (NULL, NULL, "gnunet-arm",
905 "-c", d->cfgfile, "-e", "-r", NULL);
908 GNUNET_free_non_null(del_arg);
910 = GNUNET_SCHEDULER_add_delayed (d->sched,
911 GNUNET_CONSTANTS_EXEC_WAIT,
918 * Stops a GNUnet daemon.
920 * @param d the daemon that should be stopped
921 * @param timeout how long to wait for process for shutdown to complete
922 * @param cb function called once the daemon was stopped
923 * @param cb_cls closure for cb
924 * @param delete_files GNUNET_YES to remove files, GNUNET_NO
926 * @param allow_restart GNUNET_YES to restart peer later (using this API)
927 * GNUNET_NO to kill off and clean up for good
930 GNUNET_TESTING_daemon_stop (struct GNUNET_TESTING_Daemon *d,
931 struct GNUNET_TIME_Relative timeout,
932 GNUNET_TESTING_NotifyCompletion cb, void *cb_cls,
933 int delete_files, int allow_restart)
938 d->dead_cb_cls = cb_cls;
943 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
944 _("Setting d->dead on peer `%4s'\n"), GNUNET_i2s (&d->id));
946 d->dead = GNUNET_YES;
951 if (delete_files == GNUNET_YES)
953 GNUNET_asprintf(&del_arg, "-d");
956 if (d->phase == SP_CONFIG_UPDATE)
958 GNUNET_SCHEDULER_cancel (d->sched, d->task);
959 d->phase = SP_START_DONE;
961 if (d->server != NULL)
963 GNUNET_CORE_disconnect (d->server);
966 /* shutdown ARM process (will terminate others) */
968 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
969 _("Terminating peer `%4s'\n"), GNUNET_i2s (&d->id));
972 d->phase = SP_SHUTDOWN_START;
973 d->running = GNUNET_NO;
975 if (allow_restart == GNUNET_YES)
976 d->churn = GNUNET_YES;
980 GNUNET_TRANSPORT_get_hello_cancel(d->th, &process_hello, d);
981 GNUNET_TRANSPORT_disconnect(d->th);
984 /* Check if this is a local or remote process */
985 if (NULL != d->hostname)
988 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
989 "Stopping gnunet-arm with config `%s' on host `%s'.\n", d->cfgfile, d->hostname);
992 if (d->username != NULL)
993 GNUNET_asprintf (&arg, "%s@%s", d->username, d->hostname);
995 arg = GNUNET_strdup (d->hostname);
997 d->pid = GNUNET_OS_start_process (NULL, NULL, "ssh", "ssh",
1002 "-c", d->cfgfile, "-e", "-q", del_arg, NULL);
1003 /* Use -e to end arm, and -d to remove temp files */
1010 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1011 "Stopping gnunet-arm with config `%s' locally.\n", d->cfgfile);
1013 d->pid = GNUNET_OS_start_process (NULL, NULL, "gnunet-arm",
1018 "-c", d->cfgfile, "-e", "-q", del_arg, NULL);
1021 GNUNET_free_non_null(del_arg);
1022 d->max_timeout = GNUNET_TIME_relative_to_absolute(timeout);
1023 fprintf(stderr, "scheduling shutdown fsm phase\n");
1025 = GNUNET_SCHEDULER_add_now (d->sched,
1031 * Changes the configuration of a GNUnet daemon.
1033 * @param d the daemon that should be modified
1034 * @param cfg the new configuration for the daemon
1035 * @param cb function called once the configuration was changed
1036 * @param cb_cls closure for cb
1039 GNUNET_TESTING_daemon_reconfigure (struct GNUNET_TESTING_Daemon *d,
1040 struct GNUNET_CONFIGURATION_Handle *cfg,
1041 GNUNET_TESTING_NotifyCompletion cb,
1046 if (d->phase != SP_START_DONE)
1051 ("Peer not yet running, can not change configuration at this point."));
1055 /* 1) write configuration to temporary file */
1056 if (GNUNET_OK != GNUNET_CONFIGURATION_write (cfg, d->cfgfile))
1059 cb (cb_cls, _("Failed to write new configuration to disk."));
1063 /* 2) copy file to remote host (if necessary) */
1064 if (NULL == d->hostname)
1066 /* signal success */
1072 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1073 "Copying updated configuration file to remote host `%s'.\n",
1076 d->phase = SP_CONFIG_UPDATE;
1077 if (NULL != d->username)
1078 GNUNET_asprintf (&arg, "%s@%s:%s", d->username, d->hostname, d->cfgfile);
1080 GNUNET_asprintf (&arg, "%s:%s", d->hostname, d->cfgfile);
1081 d->pid = GNUNET_OS_start_process (NULL, NULL, "scp", "scp", d->cfgfile, arg, NULL);
1085 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1087 ("Could not start `%s' process to copy configuration file.\n"),
1090 cb (cb_cls, _("Failed to copy new configuration to remote machine."));
1091 d->phase = SP_START_DONE;
1095 d->update_cb_cls = cb_cls;
1097 = GNUNET_SCHEDULER_add_delayed (d->sched,
1098 GNUNET_CONSTANTS_EXEC_WAIT,
1104 * Data kept for each pair of peers that we try
1107 struct ConnectContext
1110 * Testing handle to the first daemon.
1112 struct GNUNET_TESTING_Daemon *d1;
1115 * Handle to core of first daemon (to check connect)
1117 struct GNUNET_CORE_Handle * d1core;
1120 * Testing handle to the second daemon.
1122 struct GNUNET_TESTING_Daemon *d2;
1125 * Transport handle to the second daemon.
1127 struct GNUNET_TRANSPORT_Handle *d2th;
1130 * Function to call once we are done (or have timed out).
1132 GNUNET_TESTING_NotifyConnection cb;
1140 * When should this operation be complete (or we must trigger
1143 struct GNUNET_TIME_Absolute timeout;
1146 * The relative timeout from whence this connect attempt was
1147 * started. Allows for reconnect attempts.
1149 struct GNUNET_TIME_Relative relative_timeout;
1152 * Maximum number of connect attempts, will retry connection
1153 * this number of times on failures.
1155 unsigned int max_connect_attempts;
1158 * Hello timeout task
1160 GNUNET_SCHEDULER_TaskIdentifier hello_send_task;
1163 * Connect timeout task
1165 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
1168 * When should this operation be complete (or we must trigger
1171 struct GNUNET_TIME_Relative timeout_hello;
1175 * Was the connection attempt successful?
1181 /** Forward declaration **/
1183 reattempt_daemons_connect(void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
1187 * Notify callback about success or failure of the attempt
1188 * to connect the two peers
1190 * @param cls our "struct ConnectContext" (freed)
1191 * @param tc reason tells us if we succeeded or failed
1194 notify_connect_result (void *cls,
1195 const struct GNUNET_SCHEDULER_TaskContext *tc)
1197 struct ConnectContext *ctx = cls;
1198 struct GNUNET_TIME_Relative remaining;
1200 if (ctx->hello_send_task != GNUNET_SCHEDULER_NO_TASK)
1202 GNUNET_SCHEDULER_cancel(ctx->d1->sched, ctx->hello_send_task);
1203 ctx->hello_send_task = GNUNET_SCHEDULER_NO_TASK;
1206 if ((ctx->timeout_task != GNUNET_SCHEDULER_NO_TASK) && (tc->reason != GNUNET_SCHEDULER_REASON_TIMEOUT))
1208 GNUNET_SCHEDULER_cancel(ctx->d1->sched, ctx->timeout_task);
1209 ctx->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1212 if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
1214 if (ctx->d2th != NULL)
1215 GNUNET_TRANSPORT_disconnect (ctx->d2th);
1217 if (ctx->d1core != NULL)
1218 GNUNET_CORE_disconnect (ctx->d1core);
1225 remaining = GNUNET_TIME_absolute_get_remaining(ctx->timeout);
1227 if (ctx->connected == GNUNET_YES)
1229 if (ctx->cb != NULL)
1231 ctx->cb (ctx->cb_cls, &ctx->d1->id, &ctx->d2->id, ctx->d1->cfg,
1232 ctx->d2->cfg, ctx->d1, ctx->d2, NULL);
1235 else if (remaining.value > 0)
1237 if (ctx->d1core != NULL)
1239 GNUNET_CORE_disconnect(ctx->d1core);
1243 if (ctx->d2th != NULL)
1245 GNUNET_TRANSPORT_disconnect(ctx->d2th);
1248 GNUNET_SCHEDULER_add_now(ctx->d1->sched, &reattempt_daemons_connect, ctx);
1253 if (ctx->cb != NULL)
1255 ctx->cb (ctx->cb_cls, &ctx->d1->id, &ctx->d2->id, ctx->d1->cfg,
1256 ctx->d2->cfg, ctx->d1, ctx->d2,
1257 _("Peers failed to connect"));
1261 GNUNET_TRANSPORT_disconnect (ctx->d2th);
1263 GNUNET_CORE_disconnect (ctx->d1core);
1270 * Success, connection is up. Signal client our success.
1272 * @param cls our "struct ConnectContext"
1273 * @param peer identity of the peer that has connected
1274 * @param latency the round trip latency of the connection to this peer
1275 * @param distance distance the transport level distance to this peer
1279 connect_notify (void *cls, const struct GNUNET_PeerIdentity * peer, struct GNUNET_TIME_Relative latency,
1282 struct ConnectContext *ctx = cls;
1284 if (memcmp(&ctx->d2->id, peer, sizeof(struct GNUNET_PeerIdentity)) == 0)
1286 ctx->connected = GNUNET_YES;
1287 GNUNET_SCHEDULER_cancel(ctx->d1->sched, ctx->timeout_task);
1288 ctx->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1289 GNUNET_SCHEDULER_add_now (ctx->d1->sched,
1290 ¬ify_connect_result,
1297 send_hello(void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1299 struct ConnectContext *ctx = cls;
1301 if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
1304 if (ctx->d1->hello != NULL)
1306 GNUNET_TRANSPORT_offer_hello (ctx->d2th, GNUNET_HELLO_get_header(ctx->d1->hello));
1307 ctx->timeout_hello = GNUNET_TIME_relative_add(ctx->timeout_hello,
1308 GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS,
1311 ctx->hello_send_task = GNUNET_SCHEDULER_add_delayed(ctx->d1->sched,
1317 * Establish a connection between two GNUnet daemons.
1319 * @param d1 handle for the first daemon
1320 * @param d2 handle for the second daemon
1321 * @param timeout how long is the connection attempt
1323 * @param max_connect_attempts how many times should we try to reconnect
1325 * @param cb function to call at the end
1326 * @param cb_cls closure for cb
1329 GNUNET_TESTING_daemons_connect (struct GNUNET_TESTING_Daemon *d1,
1330 struct GNUNET_TESTING_Daemon *d2,
1331 struct GNUNET_TIME_Relative timeout,
1332 unsigned int max_connect_attempts,
1333 GNUNET_TESTING_NotifyConnection cb,
1336 struct ConnectContext *ctx;
1338 if ((d1->running == GNUNET_NO) || (d2->running == GNUNET_NO))
1341 cb (cb_cls, &d1->id, &d2->id, d1->cfg, d2->cfg, d1, d2,
1342 _("Peers are not fully running yet, can not connect!\n"));
1345 ctx = GNUNET_malloc (sizeof (struct ConnectContext));
1348 ctx->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1349 ctx->timeout_hello = GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 500);
1350 ctx->relative_timeout = timeout;
1352 ctx->cb_cls = cb_cls;
1353 ctx->max_connect_attempts = max_connect_attempts;
1354 ctx->connected = GNUNET_NO;
1356 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1357 "Asked to connect peer %s to peer %s\n",
1358 d1->shortname, d2->shortname);
1361 ctx->d1core = GNUNET_CORE_connect (d1->sched,
1366 &connect_notify, NULL,
1368 NULL, GNUNET_NO, no_handlers);
1369 if (ctx->d1core == NULL)
1373 cb (cb_cls, &d1->id, &d2->id, d1->cfg, d2->cfg, d1, d2,
1374 _("Failed to connect to core service of first peer!\n"));
1378 #if DEBUG_TESTING > 2
1379 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1380 "Asked to connect peer %s to peer %s\n",
1381 d1->shortname, d2->shortname);
1382 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1383 "Connecting to transport service of peer %s\n", d2->shortname);
1387 ctx->d2th = GNUNET_TRANSPORT_connect (d2->sched,
1388 d2->cfg, d2, NULL, NULL, NULL);
1389 if (ctx->d2th == NULL)
1391 GNUNET_CORE_disconnect(ctx->d1core);
1394 cb (cb_cls, &d1->id, &d2->id, d1->cfg, d2->cfg, d1, d2,
1395 _("Failed to connect to transport service!\n"));
1399 ctx->timeout_task = GNUNET_SCHEDULER_add_delayed (d1->sched,
1400 GNUNET_TIME_relative_divide(ctx->relative_timeout, max_connect_attempts), /* Allow up to 8 reconnect attempts */
1401 ¬ify_connect_result, ctx);
1403 ctx->hello_send_task = GNUNET_SCHEDULER_add_now(ctx->d1->sched, &send_hello, ctx);
1407 reattempt_daemons_connect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1410 struct ConnectContext *ctx = cls;
1411 if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
1415 #if DEBUG_TESTING_RECONNECT
1416 GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "re-attempting connect of peer %s to peer %s\n",
1417 ctx->d1->shortname, ctx->d2->shortname);
1420 GNUNET_assert(ctx->d1core == NULL);
1422 ctx->d1core = GNUNET_CORE_connect (ctx->d1->sched,
1424 GNUNET_TIME_absolute_get_remaining(ctx->timeout),
1427 &connect_notify, NULL,
1429 NULL, GNUNET_NO, no_handlers);
1430 if (ctx->d1core == NULL)
1432 if (NULL != ctx->cb)
1433 ctx->cb (ctx->cb_cls, &ctx->d1->id, &ctx->d2->id, ctx->d1->cfg, ctx->d2->cfg, ctx->d1, ctx->d2,
1434 _("Failed to connect to core service of first peer!\n"));
1439 ctx->d2th = GNUNET_TRANSPORT_connect (ctx->d2->sched,
1440 ctx->d2->cfg, ctx->d2, NULL, NULL, NULL);
1441 if (ctx->d2th == NULL)
1443 GNUNET_CORE_disconnect(ctx->d1core);
1445 if (NULL != ctx->cb)
1446 ctx->cb (ctx->cb_cls, &ctx->d1->id, &ctx->d2->id, ctx->d1->cfg, ctx->d2->cfg, ctx->d1, ctx->d2,
1447 _("Failed to connect to transport service!\n"));
1451 ctx->timeout_task = GNUNET_SCHEDULER_add_delayed (ctx->d1->sched,
1452 GNUNET_TIME_relative_divide(ctx->relative_timeout, ctx->max_connect_attempts),
1453 ¬ify_connect_result, ctx);
1455 ctx->hello_send_task = GNUNET_SCHEDULER_add_now(ctx->d1->sched, &send_hello, ctx);
1458 /* end of testing.c */