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 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.
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;
72 if (daemon->server != NULL)
74 GNUNET_CORE_disconnect(daemon->server);
75 daemon->server = NULL;
78 GNUNET_assert (message != NULL);
79 msize = ntohs(message->size);
84 if (daemon->th != NULL)
86 GNUNET_TRANSPORT_get_hello_cancel(daemon->th, &process_hello, daemon);
89 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
90 "Received `%s' from transport service of `%4s'\n",
91 "HELLO", GNUNET_i2s (&daemon->id));
97 GNUNET_free_non_null(daemon->hello);
98 daemon->hello = GNUNET_malloc(msize);
99 memcpy(daemon->hello, message, msize);
101 if (daemon->th != NULL)
103 GNUNET_TRANSPORT_disconnect(daemon->th);
111 * Function called after GNUNET_CORE_connect has succeeded
112 * (or failed for good). Note that the private key of the
113 * peer is intentionally not exposed here; if you need it,
114 * your process should try to read the private key file
115 * directly (which should work if you are authorized...).
118 * @param server handle to the server, NULL if we failed
119 * @param my_identity ID of this peer, NULL if we failed
120 * @param publicKey public key of this peer, NULL if we failed
123 testing_init (void *cls,
124 struct GNUNET_CORE_Handle *server,
125 const struct GNUNET_PeerIdentity *my_identity,
126 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *publicKey)
128 struct GNUNET_TESTING_Daemon *d = cls;
129 GNUNET_TESTING_NotifyDaemonRunning cb;
131 GNUNET_assert (d->phase == SP_START_CORE);
132 d->phase = SP_START_DONE;
138 if (GNUNET_YES == d->dead)
139 GNUNET_TESTING_daemon_stop (d, GNUNET_TIME_absolute_get_remaining(d->max_timeout), d->dead_cb, d->dead_cb_cls, GNUNET_YES, GNUNET_NO);
141 cb (d->cb_cls, NULL, d->cfg, d,
142 _("Failed to connect to core service\n"));
146 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
147 "Successfully started peer `%4s'.\n", GNUNET_i2s (my_identity));
149 d->id = *my_identity;
150 d->shortname = strdup (GNUNET_i2s (my_identity));
152 d->running = GNUNET_YES;
153 if (GNUNET_YES == d->dead)
154 GNUNET_TESTING_daemon_stop (d, GNUNET_TIME_absolute_get_remaining(d->max_timeout), d->dead_cb, d->dead_cb_cls, GNUNET_YES, GNUNET_NO);
156 cb (d->cb_cls, my_identity, d->cfg, d, NULL);
158 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
159 "Successfully started peer `%4s'.\n", GNUNET_i2s (my_identity));
163 d->th = GNUNET_TRANSPORT_connect (d->sched,
166 d, NULL, NULL, NULL);
169 if (GNUNET_YES == d->dead)
170 GNUNET_TESTING_daemon_stop (d, GNUNET_TIME_absolute_get_remaining(d->max_timeout), d->dead_cb, d->dead_cb_cls, GNUNET_YES, GNUNET_NO);
171 else if (NULL != d->cb)
172 d->cb (d->cb_cls, &d->id, d->cfg, d,
173 _("Failed to connect to transport service!\n"));
177 GNUNET_TRANSPORT_get_hello (d->th, &process_hello, d);
182 * Finite-state machine for starting GNUnet.
184 * @param cls our "struct GNUNET_TESTING_Daemon"
188 start_fsm (void *cls,
189 const struct GNUNET_SCHEDULER_TaskContext *tc)
191 struct GNUNET_TESTING_Daemon *d = cls;
192 GNUNET_TESTING_NotifyDaemonRunning cb;
193 enum GNUNET_OS_ProcessStatusType type;
199 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
200 "Peer FSM is in phase %u.\n", d->phase);
203 d->task = GNUNET_SCHEDULER_NO_TASK;
207 /* confirm copying complete */
208 if (GNUNET_OK != GNUNET_OS_process_status (d->proc, &type, &code))
210 if (GNUNET_TIME_absolute_get_remaining(d->max_timeout).rel_value == 0)
217 d->cfg, d, _("`scp' does not seem to terminate (timeout copying config).\n"));
222 = GNUNET_SCHEDULER_add_delayed (d->sched,
223 GNUNET_CONSTANTS_EXEC_WAIT,
227 if ((type != GNUNET_OS_PROCESS_EXITED) || (code != 0))
233 NULL, d->cfg, d, _("`scp' did not complete cleanly.\n"));
237 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
238 "Successfully copied configuration file.\n");
240 d->phase = SP_COPIED;
243 /* Start create hostkey process */
244 d->pipe_stdout = GNUNET_DISK_pipe (GNUNET_NO, GNUNET_NO, GNUNET_YES);
245 if (d->pipe_stdout == NULL)
254 (NULL == d->hostname)
255 ? _("Failed to create pipe for `gnunet-peerinfo' process.\n")
256 : _("Failed to create pipe for `ssh' process.\n"));
259 if (NULL == d->hostname)
262 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
263 "Starting `%s', with command `%s %s %s %s'.\n",
264 "gnunet-peerinfo", "gnunet-peerinfo", "-c", d->cfgfile,
267 d->proc = GNUNET_OS_start_process (NULL, d->pipe_stdout, "gnunet-peerinfo",
271 GNUNET_DISK_pipe_close_end(d->pipe_stdout, GNUNET_DISK_PIPE_END_WRITE);
275 if (d->username != NULL)
276 GNUNET_asprintf (&dst, "%s@%s", d->username, d->hostname);
278 dst = GNUNET_strdup (d->hostname);
281 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
282 "Starting `%s', with command `%s %s %s %s %s %s'.\n",
283 "gnunet-peerinfo", "ssh", dst, "gnunet-peerinfo", "-c", d->cfgfile,
286 if (d->ssh_port_str == NULL)
288 d->proc = GNUNET_OS_start_process (NULL, d->pipe_stdout, "ssh",
295 "-c", d->cfgfile, "-sq", NULL);
299 d->proc = GNUNET_OS_start_process (NULL, d->pipe_stdout, "ssh",
300 "ssh", "-p", d->ssh_port_str,
306 "-c", d->cfgfile, "-sq", NULL);
308 GNUNET_DISK_pipe_close_end(d->pipe_stdout, GNUNET_DISK_PIPE_END_WRITE);
313 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
314 _("Could not start `%s' process to create hostkey.\n"),
315 (NULL == d->hostname) ? "gnunet-peerinfo" : "ssh");
323 (NULL == d->hostname)
324 ? _("Failed to start `gnunet-peerinfo' process.\n")
325 : _("Failed to start `ssh' process.\n"));
326 GNUNET_DISK_pipe_close(d->pipe_stdout);
330 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
331 "Started `%s', waiting for hostkey.\n",
334 d->phase = SP_HOSTKEY_CREATE;
336 = GNUNET_SCHEDULER_add_read_file (d->sched,
337 GNUNET_TIME_absolute_get_remaining(d->max_timeout),
338 GNUNET_DISK_pipe_handle(d->pipe_stdout,
339 GNUNET_DISK_PIPE_END_READ),
343 case SP_HOSTKEY_CREATE:
344 bytes_read = GNUNET_DISK_file_read(GNUNET_DISK_pipe_handle(d->pipe_stdout,
345 GNUNET_DISK_PIPE_END_READ),
346 &d->hostkeybuf[d->hostkeybufpos],
347 sizeof(d->hostkeybuf) - d->hostkeybufpos);
349 d->hostkeybufpos += bytes_read;
351 if ( (d->hostkeybufpos < 104) &&
356 = GNUNET_SCHEDULER_add_read_file (d->sched,
357 GNUNET_TIME_absolute_get_remaining(d->max_timeout),
358 GNUNET_DISK_pipe_handle(d->pipe_stdout,
359 GNUNET_DISK_PIPE_END_READ),
364 d->hostkeybuf[103] = '\0';
365 if ( (bytes_read < 0) ||
366 (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (d->hostkeybuf,
367 &d->id.hashPubKey)) )
371 GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
372 _("Error reading from gnunet-peerinfo: %s\n"),
375 GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
376 _("Malformed output from gnunet-peerinfo!\n"));
379 GNUNET_DISK_pipe_close(d->pipe_stdout);
380 d->pipe_stdout = NULL;
381 (void) GNUNET_OS_process_kill (d->proc, SIGKILL);
382 GNUNET_break (GNUNET_OK == GNUNET_OS_process_wait (d->proc));
383 GNUNET_OS_process_close (d->proc);
390 _("`Failed to get hostkey!\n"));
393 GNUNET_DISK_pipe_close(d->pipe_stdout);
394 d->pipe_stdout = NULL;
395 (void) GNUNET_OS_process_kill (d->proc, SIGKILL);
396 GNUNET_break (GNUNET_OK == GNUNET_OS_process_wait (d->proc));
397 GNUNET_OS_process_close (d->proc);
400 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
401 "Successfully got hostkey!\n");
403 if (d->hostkey_callback != NULL)
405 d->hostkey_callback(d->hostkey_cls, &d->id, d, NULL);
406 d->phase = SP_HOSTKEY_CREATED;
410 d->phase = SP_TOPOLOGY_SETUP;
413 case SP_HOSTKEY_CREATED:
414 /* wait for topology finished */
415 if ((GNUNET_YES == d->dead) || (GNUNET_TIME_absolute_get_remaining(d->max_timeout).rel_value == 0))
424 _("`Failed while waiting for topology setup!\n"));
429 = GNUNET_SCHEDULER_add_delayed (d->sched,
430 GNUNET_CONSTANTS_EXEC_WAIT,
433 case SP_TOPOLOGY_SETUP:
434 /* start GNUnet on remote host */
435 if (NULL == d->hostname)
438 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
439 "Starting `%s', with command `%s %s %s %s %s %s'.\n",
440 "gnunet-arm", "gnunet-arm", "-c", d->cfgfile,
444 d->proc = GNUNET_OS_start_process (NULL, NULL, "gnunet-arm",
454 if (d->username != NULL)
455 GNUNET_asprintf (&dst, "%s@%s", d->username, d->hostname);
457 dst = GNUNET_strdup (d->hostname);
460 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
461 "Starting `%s', with command `%s %s %s %s %s %s %s %s'.\n",
462 "gnunet-arm", "ssh", dst, "gnunet-arm", "-c", d->cfgfile,
463 "-L", "DEBUG", "-s", "-q");
465 if (d->ssh_port_str == NULL)
467 d->proc = GNUNET_OS_start_process (NULL, NULL, "ssh",
477 "-c", d->cfgfile, "-s", "-q", NULL);
482 d->proc = GNUNET_OS_start_process (NULL, NULL, "ssh",
483 "ssh", "-p", d->ssh_port_str,
492 "-c", d->cfgfile, "-s", "-q", NULL);
498 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
499 _("Could not start `%s' process to start GNUnet.\n"),
500 (NULL == d->hostname) ? "gnunet-arm" : "ssh");
508 (NULL == d->hostname)
509 ? _("Failed to start `gnunet-arm' process.\n")
510 : _("Failed to start `ssh' process.\n"));
514 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
515 "Started `%s', waiting for `%s' to be up.\n",
516 "gnunet-arm", "gnunet-service-core");
518 d->phase = SP_START_ARMING;
520 = GNUNET_SCHEDULER_add_delayed (d->sched,
521 GNUNET_CONSTANTS_EXEC_WAIT,
524 case SP_START_ARMING:
525 if (GNUNET_OK != GNUNET_OS_process_status (d->proc, &type, &code))
527 if (GNUNET_TIME_absolute_get_remaining(d->max_timeout).rel_value == 0)
536 (NULL == d->hostname)
537 ? _("`gnunet-arm' does not seem to terminate.\n")
538 : _("`ssh' does not seem to terminate.\n"));
543 = GNUNET_SCHEDULER_add_delayed (d->sched,
544 GNUNET_CONSTANTS_EXEC_WAIT,
549 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
550 "Successfully started `%s'.\n", "gnunet-arm");
552 d->phase = SP_START_CORE;
553 d->server = GNUNET_CORE_connect (d->sched,
560 NULL, GNUNET_NO, no_handlers);
568 case SP_SHUTDOWN_START:
569 /* confirm copying complete */
570 if (GNUNET_OK != GNUNET_OS_process_status (d->proc, &type, &code))
572 if (GNUNET_TIME_absolute_get_remaining(d->max_timeout).rel_value == 0)
574 if (NULL != d->dead_cb)
575 d->dead_cb (d->dead_cb_cls,
576 _("either `gnunet-arm' or `ssh' does not seem to terminate.\n"));
579 GNUNET_TRANSPORT_get_hello_cancel(d->th, &process_hello, d);
580 GNUNET_TRANSPORT_disconnect(d->th);
583 GNUNET_CONFIGURATION_destroy (d->cfg);
584 GNUNET_free (d->cfgfile);
585 GNUNET_free_non_null(d->hello);
586 GNUNET_free_non_null (d->hostname);
587 GNUNET_free_non_null (d->username);
588 GNUNET_free_non_null (d->shortname);
594 = GNUNET_SCHEDULER_add_delayed (d->sched,
595 GNUNET_CONSTANTS_EXEC_WAIT,
599 if ((type != GNUNET_OS_PROCESS_EXITED) || (code != 0))
601 if (NULL != d->dead_cb)
602 d->dead_cb (d->dead_cb_cls,
603 _("shutdown (either `gnunet-arm' or `ssh') did not complete cleanly.\n"));
606 GNUNET_TRANSPORT_get_hello_cancel(d->th, &process_hello, d);
607 GNUNET_TRANSPORT_disconnect(d->th);
610 GNUNET_CONFIGURATION_destroy (d->cfg);
611 GNUNET_free (d->cfgfile);
612 GNUNET_free_non_null(d->hello);
613 GNUNET_free_non_null (d->hostname);
614 GNUNET_free_non_null (d->username);
615 GNUNET_free_non_null (d->shortname);
620 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer shutdown complete.\n");
624 GNUNET_TRANSPORT_get_hello_cancel(d->th, &process_hello, d);
625 GNUNET_TRANSPORT_disconnect(d->th);
628 /* state clean up and notifications */
629 if (d->churn == GNUNET_NO)
631 GNUNET_CONFIGURATION_destroy (d->cfg);
632 GNUNET_free (d->cfgfile);
633 GNUNET_free_non_null (d->hostname);
634 GNUNET_free_non_null (d->username);
637 GNUNET_free_non_null(d->hello);
639 GNUNET_free_non_null (d->shortname);
641 if (NULL != d->dead_cb)
642 d->dead_cb (d->dead_cb_cls, NULL);
644 if (d->churn == GNUNET_NO)
648 case SP_CONFIG_UPDATE:
649 /* confirm copying complete */
650 if (GNUNET_OK != GNUNET_OS_process_status (d->proc, &type, &code))
652 if (GNUNET_TIME_absolute_get_remaining(d->max_timeout).rel_value == 0) /* FIXME: config update should take timeout parameter! */
659 d->cfg, d, _("`scp' does not seem to terminate.\n"));
664 = GNUNET_SCHEDULER_add_delayed (d->sched,
665 GNUNET_CONSTANTS_EXEC_WAIT,
669 if ((type != GNUNET_OS_PROCESS_EXITED) || (code != 0))
671 if (NULL != d->update_cb)
672 d->update_cb (d->update_cb_cls,
673 _("`scp' did not complete cleanly.\n"));
677 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
678 "Successfully copied configuration file.\n");
680 if (NULL != d->update_cb)
681 d->update_cb (d->update_cb_cls, NULL);
682 d->phase = SP_START_DONE;
688 * Continues GNUnet daemon startup when user wanted to be notified
689 * once a hostkey was generated (for creating friends files, blacklists,
692 * @param daemon the daemon to finish starting
695 GNUNET_TESTING_daemon_continue_startup(struct GNUNET_TESTING_Daemon *daemon)
697 GNUNET_assert(daemon->phase == SP_HOSTKEY_CREATED);
698 daemon->phase = SP_TOPOLOGY_SETUP;
702 * Check whether the given daemon is running.
704 * @param daemon the daemon to check
706 * @return GNUNET_YES if the daemon is up, GNUNET_NO if the
707 * daemon is down, GNUNET_SYSERR on error.
710 GNUNET_TESTING_daemon_running (struct GNUNET_TESTING_Daemon *daemon)
713 return GNUNET_SYSERR;
715 if (daemon->running == GNUNET_YES)
722 * Start a peer that has previously been stopped using the daemon_stop
723 * call (and files weren't deleted and the allow restart flag)
725 * @param daemon the daemon to start (has been previously stopped)
726 * @param timeout how long to wait for restart
727 * @param cb the callback for notification when the peer is running
728 * @param cb_cls closure for the callback
731 GNUNET_TESTING_daemon_start_stopped (struct GNUNET_TESTING_Daemon *daemon,
732 struct GNUNET_TIME_Relative timeout,
733 GNUNET_TESTING_NotifyDaemonRunning cb,
736 if (daemon->running == GNUNET_YES)
738 cb(cb_cls, &daemon->id, daemon->cfg, daemon, "Daemon already running, can't restart!");
743 daemon->cb_cls = cb_cls;
744 daemon->phase = SP_TOPOLOGY_SETUP;
745 daemon->max_timeout = GNUNET_TIME_relative_to_absolute(timeout);
747 GNUNET_SCHEDULER_add_continuation (daemon->sched,
750 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
754 * Starts a GNUnet daemon. GNUnet must be installed on the target
755 * system and available in the PATH. The machine must furthermore be
756 * reachable via "ssh" (unless the hostname is "NULL") without the
757 * need to enter a password.
759 * @param sched scheduler to use
760 * @param cfg configuration to use
761 * @param timeout how long to wait starting up peers
762 * @param hostname name of the machine where to run GNUnet
763 * (use NULL for localhost).
764 * @param ssh_username ssh username to use when connecting to hostname
765 * @param sshport port to pass to ssh process when connecting to hostname
766 * @param hostkey_callback function to call once the hostkey has been
767 * generated for this peer, but it hasn't yet been started
768 * (NULL to start immediately, otherwise waits on GNUNET_TESTING_daemon_continue_start)
769 * @param hostkey_cls closure for hostkey callback
770 * @param cb function to call once peer is up, or failed to start
771 * @param cb_cls closure for cb
772 * @return handle to the daemon (actual start will be completed asynchronously)
774 struct GNUNET_TESTING_Daemon *
775 GNUNET_TESTING_daemon_start (struct GNUNET_SCHEDULER_Handle *sched,
776 const struct GNUNET_CONFIGURATION_Handle *cfg,
777 struct GNUNET_TIME_Relative timeout,
778 const char *hostname,
779 const char *ssh_username,
781 GNUNET_TESTING_NotifyHostkeyCreated hostkey_callback,
783 GNUNET_TESTING_NotifyDaemonRunning cb,
786 struct GNUNET_TESTING_Daemon *ret;
790 ret = GNUNET_malloc (sizeof (struct GNUNET_TESTING_Daemon));
792 ret->hostname = (hostname == NULL) ? NULL : GNUNET_strdup (hostname);
795 GNUNET_asprintf(&ret->ssh_port_str, "%d", sshport);
798 ret->ssh_port_str = NULL;
799 ret->cfgfile = GNUNET_DISK_mktemp ("gnunet-testing-config");
801 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
802 "Setting up peer with configuration file `%s'.\n",
805 if (NULL == ret->cfgfile)
807 GNUNET_free_non_null (ret->hostname);
811 ret->hostkey_callback = hostkey_callback;
812 ret->hostkey_cls = hostkey_cls;
814 ret->cb_cls = cb_cls;
815 ret->max_timeout = GNUNET_TIME_relative_to_absolute(timeout);
816 ret->cfg = GNUNET_CONFIGURATION_dup (cfg);
817 GNUNET_CONFIGURATION_set_value_string (ret->cfg,
819 "DEFAULTCONFIG", ret->cfgfile);
820 /* 1) write configuration to temporary file */
821 if (GNUNET_OK != GNUNET_CONFIGURATION_write (ret->cfg, ret->cfgfile))
823 if (0 != UNLINK (ret->cfgfile))
824 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
825 "unlink", ret->cfgfile);
826 GNUNET_CONFIGURATION_destroy (ret->cfg);
827 GNUNET_free_non_null (ret->hostname);
828 GNUNET_free (ret->cfgfile);
832 if (ssh_username != NULL)
833 username = GNUNET_strdup(ssh_username);
834 if ((ssh_username == NULL) && (GNUNET_OK !=
835 GNUNET_CONFIGURATION_get_value_string (cfg,
837 "USERNAME", &username)))
839 if (NULL != getenv ("USER"))
840 username = GNUNET_strdup (getenv ("USER"));
844 ret->username = username;
846 /* 2) copy file to remote host */
847 if (NULL != hostname)
850 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
851 "Copying configuration file to host `%s'.\n", hostname);
853 ret->phase = SP_COPYING;
854 if (NULL != username)
855 GNUNET_asprintf (&arg, "%s@%s:%s", username, hostname, ret->cfgfile);
857 GNUNET_asprintf (&arg, "%s:%s", hostname, ret->cfgfile);
859 if (ret->ssh_port_str == NULL)
861 ret->proc = GNUNET_OS_start_process (NULL, NULL, "scp",
866 ret->cfgfile, arg, NULL);
870 ret->proc = GNUNET_OS_start_process (NULL, NULL, "scp",
871 "scp", "-P", ret->ssh_port_str,
875 ret->cfgfile, arg, NULL);
878 if (NULL == ret->proc)
880 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
882 ("Could not start `%s' process to copy configuration file.\n"),
884 if (0 != UNLINK (ret->cfgfile))
885 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
886 "unlink", ret->cfgfile);
887 GNUNET_CONFIGURATION_destroy (ret->cfg);
888 GNUNET_free_non_null (ret->hostname);
889 GNUNET_free_non_null (ret->username);
890 GNUNET_free (ret->cfgfile);
895 = GNUNET_SCHEDULER_add_delayed (sched,
896 GNUNET_CONSTANTS_EXEC_WAIT,
901 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
902 "No need to copy configuration file since we are running locally.\n");
904 ret->phase = SP_COPIED;
905 GNUNET_SCHEDULER_add_continuation (sched,
908 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
914 * Restart (stop and start) a GNUnet daemon.
916 * @param d the daemon that should be restarted
917 * @param cb function called once the daemon is (re)started
918 * @param cb_cls closure for cb
921 GNUNET_TESTING_daemon_restart (struct GNUNET_TESTING_Daemon *d,
922 GNUNET_TESTING_NotifyDaemonRunning cb, void *cb_cls)
930 d->dead = GNUNET_YES;
937 if (d->phase == SP_CONFIG_UPDATE)
939 GNUNET_SCHEDULER_cancel (d->sched, d->task);
940 d->phase = SP_START_DONE;
942 if (d->server != NULL)
944 GNUNET_CORE_disconnect (d->server);
950 GNUNET_TRANSPORT_get_hello_cancel(d->th, &process_hello, d);
951 GNUNET_TRANSPORT_disconnect(d->th);
954 /* state clean up and notifications */
955 GNUNET_free_non_null(d->hello);
958 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
959 _("Terminating peer `%4s'\n"), GNUNET_i2s (&d->id));
962 d->phase = SP_START_ARMING;
964 /* Check if this is a local or remote process */
965 if (NULL != d->hostname)
968 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
969 "Stopping gnunet-arm with config `%s' on host `%s'.\n", d->cfgfile, d->hostname);
972 if (d->username != NULL)
973 GNUNET_asprintf (&arg, "%s@%s", d->username, d->hostname);
975 arg = GNUNET_strdup (d->hostname);
977 d->proc = GNUNET_OS_start_process (NULL, NULL, "ssh", "ssh",
985 "-c", d->cfgfile, "-e", "-r", NULL);
986 /* Use -r to restart arm and all services */
993 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
994 "Stopping gnunet-arm with config `%s' locally.\n", d->cfgfile);
996 d->proc = GNUNET_OS_start_process (NULL, NULL, "gnunet-arm",
1001 "-c", d->cfgfile, "-e", "-r", NULL);
1004 GNUNET_free_non_null(del_arg);
1006 = GNUNET_SCHEDULER_add_delayed (d->sched,
1007 GNUNET_CONSTANTS_EXEC_WAIT,
1014 * Stops a GNUnet daemon.
1016 * @param d the daemon that should be stopped
1017 * @param timeout how long to wait for process for shutdown to complete
1018 * @param cb function called once the daemon was stopped
1019 * @param cb_cls closure for cb
1020 * @param delete_files GNUNET_YES to remove files, GNUNET_NO
1022 * @param allow_restart GNUNET_YES to restart peer later (using this API)
1023 * GNUNET_NO to kill off and clean up for good
1026 GNUNET_TESTING_daemon_stop (struct GNUNET_TESTING_Daemon *d,
1027 struct GNUNET_TIME_Relative timeout,
1028 GNUNET_TESTING_NotifyCompletion cb, void *cb_cls,
1035 d->dead_cb_cls = cb_cls;
1040 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1041 _("Setting d->dead on peer `%4s'\n"), GNUNET_i2s (&d->id));
1043 d->dead = GNUNET_YES;
1047 if ((d->running == GNUNET_NO) && (d->churn == GNUNET_YES)) /* Peer has already been stopped in churn context! */
1049 /* Free what was left from churning! */
1050 GNUNET_assert(d->cfg != NULL);
1051 GNUNET_CONFIGURATION_destroy (d->cfg);
1052 if (delete_files == GNUNET_YES)
1054 if (0 != UNLINK(d->cfgfile))
1056 GNUNET_log_strerror(GNUNET_ERROR_TYPE_WARNING, "unlink");
1059 GNUNET_free (d->cfgfile);
1060 GNUNET_free_non_null (d->hostname);
1061 GNUNET_free_non_null (d->username);
1062 if (NULL != d->dead_cb)
1063 d->dead_cb (d->dead_cb_cls, NULL);
1069 if (delete_files == GNUNET_YES)
1071 GNUNET_asprintf(&del_arg, "-d");
1074 if (d->phase == SP_CONFIG_UPDATE)
1076 GNUNET_SCHEDULER_cancel (d->sched, d->task);
1077 d->phase = SP_START_DONE;
1079 if (d->server != NULL)
1081 GNUNET_CORE_disconnect (d->server);
1084 /* shutdown ARM process (will terminate others) */
1086 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1087 _("Terminating peer `%4s'\n"), GNUNET_i2s (&d->id));
1089 d->phase = SP_SHUTDOWN_START;
1090 d->running = GNUNET_NO;
1091 if (allow_restart == GNUNET_YES)
1092 d->churn = GNUNET_YES;
1095 GNUNET_TRANSPORT_get_hello_cancel(d->th, &process_hello, d);
1096 GNUNET_TRANSPORT_disconnect(d->th);
1099 /* Check if this is a local or remote process */
1100 if (NULL != d->hostname)
1103 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1104 "Stopping gnunet-arm with config `%s' on host `%s'.\n", d->cfgfile, d->hostname);
1107 if (d->username != NULL)
1108 GNUNET_asprintf (&arg, "%s@%s", d->username, d->hostname);
1110 arg = GNUNET_strdup (d->hostname);
1112 d->proc = GNUNET_OS_start_process (NULL, NULL, "ssh", "ssh",
1120 "-c", d->cfgfile, "-e", "-q", del_arg, NULL);
1121 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1122 "Stopping gnunet-arm with command ssh %s gnunet-arm -c %s -e -q %s\n", arg, "gnunet-arm", d->cfgfile, del_arg);
1123 /* Use -e to end arm, and -d to remove temp files */
1129 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1130 "Stopping gnunet-arm with config `%s' locally.\n", d->cfgfile);
1132 d->proc = GNUNET_OS_start_process (NULL, NULL, "gnunet-arm",
1137 "-c", d->cfgfile, "-e", "-q", del_arg, NULL);
1140 GNUNET_free_non_null(del_arg);
1141 d->max_timeout = GNUNET_TIME_relative_to_absolute(timeout);
1143 = GNUNET_SCHEDULER_add_now (d->sched,
1149 * Changes the configuration of a GNUnet daemon.
1151 * @param d the daemon that should be modified
1152 * @param cfg the new configuration for the daemon
1153 * @param cb function called once the configuration was changed
1154 * @param cb_cls closure for cb
1157 GNUNET_TESTING_daemon_reconfigure (struct GNUNET_TESTING_Daemon *d,
1158 struct GNUNET_CONFIGURATION_Handle *cfg,
1159 GNUNET_TESTING_NotifyCompletion cb,
1164 if (d->phase != SP_START_DONE)
1169 ("Peer not yet running, can not change configuration at this point."));
1173 /* 1) write configuration to temporary file */
1174 if (GNUNET_OK != GNUNET_CONFIGURATION_write (cfg, d->cfgfile))
1177 cb (cb_cls, _("Failed to write new configuration to disk."));
1181 /* 2) copy file to remote host (if necessary) */
1182 if (NULL == d->hostname)
1184 /* signal success */
1190 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1191 "Copying updated configuration file to remote host `%s'.\n",
1194 d->phase = SP_CONFIG_UPDATE;
1195 if (NULL != d->username)
1196 GNUNET_asprintf (&arg, "%s@%s:%s", d->username, d->hostname, d->cfgfile);
1198 GNUNET_asprintf (&arg, "%s:%s", d->hostname, d->cfgfile);
1199 d->proc = GNUNET_OS_start_process (NULL, NULL, "scp", "scp",
1203 d->cfgfile, arg, NULL);
1205 if (NULL == d->proc)
1207 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1209 ("Could not start `%s' process to copy configuration file.\n"),
1212 cb (cb_cls, _("Failed to copy new configuration to remote machine."));
1213 d->phase = SP_START_DONE;
1217 d->update_cb_cls = cb_cls;
1219 = GNUNET_SCHEDULER_add_delayed (d->sched,
1220 GNUNET_CONSTANTS_EXEC_WAIT,
1226 * Data kept for each pair of peers that we try
1229 struct ConnectContext
1232 * Testing handle to the first daemon.
1234 struct GNUNET_TESTING_Daemon *d1;
1237 * Handle to core of first daemon (to check connect)
1239 struct GNUNET_CORE_Handle * d1core;
1242 * Testing handle to the second daemon.
1244 struct GNUNET_TESTING_Daemon *d2;
1247 * Handler for the request to core to connect to this peer.
1249 struct GNUNET_CORE_PeerRequestHandle *connect_request_handle;
1252 * Transport handle to the second daemon.
1254 struct GNUNET_TRANSPORT_Handle *d2th;
1257 * Function to call once we are done (or have timed out).
1259 GNUNET_TESTING_NotifyConnection cb;
1267 * When should this operation be complete (or we must trigger
1270 struct GNUNET_TIME_Absolute timeout;
1273 * The relative timeout from whence this connect attempt was
1274 * started. Allows for reconnect attempts.
1276 struct GNUNET_TIME_Relative relative_timeout;
1279 * Maximum number of connect attempts, will retry connection
1280 * this number of times on failures.
1282 unsigned int max_connect_attempts;
1285 * Hello timeout task
1287 GNUNET_SCHEDULER_TaskIdentifier hello_send_task;
1290 * Connect timeout task
1292 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
1295 * When should this operation be complete (or we must trigger
1298 struct GNUNET_TIME_Relative timeout_hello;
1301 * Was the connection attempt successful?
1306 * The distance between the two connected peers
1312 /** Forward declaration **/
1314 reattempt_daemons_connect(void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
1318 * Notify callback about success or failure of the attempt
1319 * to connect the two peers
1321 * @param cls our "struct ConnectContext" (freed)
1322 * @param tc reason tells us if we succeeded or failed
1325 notify_connect_result (void *cls,
1326 const struct GNUNET_SCHEDULER_TaskContext *tc)
1328 struct ConnectContext *ctx = cls;
1329 struct GNUNET_TIME_Relative remaining;
1331 ctx->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1332 if (ctx->hello_send_task != GNUNET_SCHEDULER_NO_TASK)
1334 GNUNET_SCHEDULER_cancel(ctx->d1->sched, ctx->hello_send_task);
1335 ctx->hello_send_task = GNUNET_SCHEDULER_NO_TASK;
1338 if (ctx->connect_request_handle != NULL)
1340 GNUNET_CORE_peer_request_connect_cancel (ctx->connect_request_handle);
1341 ctx->connect_request_handle = NULL;
1343 if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
1345 if (ctx->d2th != NULL)
1346 GNUNET_TRANSPORT_disconnect (ctx->d2th);
1348 if (ctx->d1core != NULL)
1349 GNUNET_CORE_disconnect (ctx->d1core);
1351 if (ctx->d2core != NULL)
1352 GNUNET_CORE_disconnect (ctx->d2core);
1361 remaining = GNUNET_TIME_absolute_get_remaining(ctx->timeout);
1363 if (ctx->connected == GNUNET_YES)
1365 if (ctx->cb != NULL)
1367 ctx->cb (ctx->cb_cls, &ctx->d1->id, &ctx->d2->id, ctx->distance, ctx->d1->cfg,
1368 ctx->d2->cfg, ctx->d1, ctx->d2, NULL);
1371 else if (remaining.rel_value > 0)
1373 if (ctx->d1core != NULL)
1375 GNUNET_CORE_disconnect(ctx->d1core);
1379 if (ctx->d2core != NULL)
1381 GNUNET_CORE_disconnect(ctx->d2core);
1386 if (ctx->d2th != NULL)
1388 GNUNET_TRANSPORT_disconnect(ctx->d2th);
1391 GNUNET_SCHEDULER_add_now(ctx->d1->sched, &reattempt_daemons_connect, ctx);
1396 if (ctx->cb != NULL)
1398 ctx->cb (ctx->cb_cls, &ctx->d1->id, &ctx->d2->id, 0, ctx->d1->cfg,
1399 ctx->d2->cfg, ctx->d1, ctx->d2,
1400 _("Peers failed to connect"));
1404 GNUNET_TRANSPORT_disconnect (ctx->d2th);
1406 GNUNET_CORE_disconnect (ctx->d1core);
1413 * Success, connection is up. Signal client our success.
1415 * @param cls our "struct ConnectContext"
1416 * @param peer identity of the peer that has connected
1417 * @param latency the round trip latency of the connection to this peer
1418 * @param distance distance the transport level distance to this peer
1422 connect_notify (void *cls, const struct GNUNET_PeerIdentity * peer, struct GNUNET_TIME_Relative latency,
1425 struct ConnectContext *ctx = cls;
1427 if (memcmp(&ctx->d2->id, peer, sizeof(struct GNUNET_PeerIdentity)) == 0)
1429 ctx->connected = GNUNET_YES;
1430 ctx->distance = distance;
1431 GNUNET_SCHEDULER_cancel(ctx->d1->sched, ctx->timeout_task);
1432 ctx->timeout_task = GNUNET_SCHEDULER_add_now (ctx->d1->sched,
1433 ¬ify_connect_result,
1441 * Success, connection is up. Signal client our success.
1443 * @param cls our "struct ConnectContext"
1444 * @param peer identity of the peer that has connected
1445 * @param latency the round trip latency of the connection to this peer
1446 * @param distance distance the transport level distance to this peer
1450 connect_notify_core2 (void *cls, const struct GNUNET_PeerIdentity * peer, struct GNUNET_TIME_Relative latency,
1453 struct ConnectContext *ctx = cls;
1455 if (memcmp(&ctx->d2->id, peer, sizeof(struct GNUNET_PeerIdentity)) == 0)
1457 ctx->connected = GNUNET_YES;
1458 ctx->distance = distance;
1459 GNUNET_SCHEDULER_cancel(ctx->d1->sched, ctx->timeout_task);
1460 ctx->timeout_task = GNUNET_SCHEDULER_add_now (ctx->d1->sched,
1461 ¬ify_connect_result,
1469 * Task called once a core connect request has been transmitted.
1471 * @param cls struct ConnectContext
1472 * @param tc context information (why was this task triggered now)
1474 void core_connect_request_cont (void *cls,
1476 GNUNET_SCHEDULER_TaskContext * tc)
1478 struct ConnectContext *ctx = cls;
1480 if (tc->reason == GNUNET_SCHEDULER_REASON_PREREQ_DONE)
1481 ctx->connect_request_handle = NULL;
1486 send_hello(void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1488 struct ConnectContext *ctx = cls;
1489 struct GNUNET_MessageHeader *hello;
1490 ctx->hello_send_task = GNUNET_SCHEDULER_NO_TASK;
1491 if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
1493 if ((ctx->d1->hello != NULL) && (NULL != GNUNET_HELLO_get_header(ctx->d1->hello)))
1495 hello = GNUNET_HELLO_get_header(ctx->d1->hello);
1496 GNUNET_assert(hello != NULL);
1497 GNUNET_TRANSPORT_offer_hello (ctx->d2th, hello);
1499 ctx->connect_request_handle = GNUNET_CORE_peer_request_connect (ctx->d1->sched,
1501 GNUNET_TIME_relative_divide(ctx->relative_timeout,
1502 ctx->max_connect_attempts + 1),
1504 &core_connect_request_cont,
1506 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Sending connect request to core for peer %s\n", GNUNET_i2s(&ctx->d1->id));
1507 ctx->timeout_hello = GNUNET_TIME_relative_add(ctx->timeout_hello,
1508 GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS,
1511 ctx->hello_send_task = GNUNET_SCHEDULER_add_delayed(ctx->d1->sched,
1517 * Establish a connection between two GNUnet daemons.
1519 * @param d1 handle for the first daemon
1520 * @param d2 handle for the second daemon
1521 * @param timeout how long is the connection attempt
1523 * @param max_connect_attempts how many times should we try to reconnect
1525 * @param cb function to call at the end
1526 * @param cb_cls closure for cb
1529 GNUNET_TESTING_daemons_connect (struct GNUNET_TESTING_Daemon *d1,
1530 struct GNUNET_TESTING_Daemon *d2,
1531 struct GNUNET_TIME_Relative timeout,
1532 unsigned int max_connect_attempts,
1533 GNUNET_TESTING_NotifyConnection cb,
1536 struct ConnectContext *ctx;
1538 if ((d1->running == GNUNET_NO) || (d2->running == GNUNET_NO))
1541 cb (cb_cls, &d1->id, &d2->id, 0, d1->cfg, d2->cfg, d1, d2,
1542 _("Peers are not fully running yet, can not connect!\n"));
1545 ctx = GNUNET_malloc (sizeof (struct ConnectContext));
1548 ctx->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1549 ctx->timeout_hello = GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 500);
1550 ctx->relative_timeout = timeout;
1552 ctx->cb_cls = cb_cls;
1553 ctx->max_connect_attempts = max_connect_attempts;
1554 ctx->connected = GNUNET_NO;
1556 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1557 "Asked to connect peer %s to peer %s\n",
1558 d1->shortname, d2->shortname);
1561 ctx->d1core = GNUNET_CORE_connect (d1->sched,
1566 &connect_notify, NULL, NULL,
1568 NULL, GNUNET_NO, no_handlers);
1569 if (ctx->d1core == NULL)
1573 cb (cb_cls, &d1->id, &d2->id, 0, d1->cfg, d2->cfg, d1, d2,
1574 _("Failed to connect to core service of first peer!\n"));
1579 ctx->d2core = GNUNET_CORE_connect (d2->sched,
1586 NULL, GNUNET_NO, no_handlers);
1587 if (ctx->d2core == NULL)
1591 cb (cb_cls, &d1->id, &d2->id, 0, d1->cfg, d2->cfg, d1, d2,
1592 _("Failed to connect to core service of second peer!\n"));
1597 #if DEBUG_TESTING > 2
1598 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1599 "Asked to connect peer %s to peer %s\n",
1600 d1->shortname, d2->shortname);
1601 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1602 "Connecting to transport service of peer %s\n", d2->shortname);
1606 ctx->d2th = GNUNET_TRANSPORT_connect (d2->sched,
1609 d2, NULL, NULL, NULL);
1610 if (ctx->d2th == NULL)
1612 GNUNET_CORE_disconnect(ctx->d1core);
1615 cb (cb_cls, &d1->id, &d2->id, 0, d1->cfg, d2->cfg, d1, d2,
1616 _("Failed to connect to transport service!\n"));
1620 ctx->timeout_task = GNUNET_SCHEDULER_add_delayed (d1->sched,
1621 GNUNET_TIME_relative_divide(ctx->relative_timeout,
1622 ctx->max_connect_attempts),
1623 ¬ify_connect_result, ctx);
1625 ctx->hello_send_task = GNUNET_SCHEDULER_add_now(ctx->d1->sched, &send_hello, ctx);
1629 reattempt_daemons_connect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1632 struct ConnectContext *ctx = cls;
1633 if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
1637 #if DEBUG_TESTING_RECONNECT
1638 GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "re-attempting connect of peer %s to peer %s\n",
1639 ctx->d1->shortname, ctx->d2->shortname);
1642 GNUNET_assert(ctx->d1core == NULL);
1644 ctx->d1core = GNUNET_CORE_connect (ctx->d1->sched,
1646 GNUNET_TIME_absolute_get_remaining(ctx->timeout),
1649 &connect_notify, NULL, NULL,
1651 NULL, GNUNET_NO, no_handlers);
1652 if (ctx->d1core == NULL)
1654 if (NULL != ctx->cb)
1655 ctx->cb (ctx->cb_cls, &ctx->d1->id, &ctx->d2->id, 0, ctx->d1->cfg, ctx->d2->cfg, ctx->d1, ctx->d2,
1656 _("Failed to connect to core service of first peer!\n"));
1661 ctx->d2th = GNUNET_TRANSPORT_connect (ctx->d2->sched,
1664 ctx->d2, NULL, NULL, NULL);
1665 if (ctx->d2th == NULL)
1667 GNUNET_CORE_disconnect(ctx->d1core);
1669 if (NULL != ctx->cb)
1670 ctx->cb (ctx->cb_cls, &ctx->d1->id, &ctx->d2->id, 0, ctx->d1->cfg, ctx->d2->cfg, ctx->d1, ctx->d2,
1671 _("Failed to connect to transport service!\n"));
1675 ctx->timeout_task = GNUNET_SCHEDULER_add_delayed (ctx->d1->sched,
1676 GNUNET_TIME_relative_divide(ctx->relative_timeout, ctx->max_connect_attempts),
1677 ¬ify_connect_result, ctx);
1679 ctx->hello_send_task = GNUNET_SCHEDULER_add_now(ctx->d1->sched, &send_hello, ctx);
1682 /* end of testing.c */