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
32 * - modify configuration to allow 2087-connections from
33 * controlling host (otherwise shutdown won't work)
37 #include "gnunet_arm_service.h"
38 #include "gnunet_core_service.h"
39 #include "gnunet_constants.h"
40 #include "gnunet_testing_lib.h"
41 #include "gnunet_transport_service.h"
43 #define DEBUG_TESTING GNUNET_YES
46 * How long do we wait after starting gnunet-service-arm
47 * for the core service to be alive?
49 #define ARM_START_WAIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 2)
52 * How many times are we willing to try to wait for "scp" or
53 * "gnunet-service-arm" to complete (waitpid) before giving up?
55 #define MAX_EXEC_WAIT_RUNS 50
58 * Phases of starting GNUnet on a system.
63 * Copy the configuration file to the target system.
68 * Configuration file has been copied, start ARM on target system.
73 * ARM has been started, check that it has properly daemonized and
74 * then try to connect to the CORE service (which should be
75 * auto-started by ARM).
80 * We're waiting for CORE to start.
85 * Core has notified us that we've established a connection to the service.
86 * The main FSM halts here and waits to be moved to UPDATE or CLEANUP.
91 * We've been asked to terminate the instance and are now waiting for
92 * the remote command to delete the configuration file to complete.
97 * We've received a configuration update and are currently waiting for
98 * the copy process for the update to complete. Once it is, we will
99 * return to "SP_START_DONE" (and rely on ARM to restart all affected
107 * Handle for a GNUnet daemon (technically a set of
108 * daemons; the handle is really for the master ARM
109 * daemon) started by the testing library.
111 struct GNUNET_TESTING_Daemon
116 struct GNUNET_SCHEDULER_Handle *sched;
121 struct GNUNET_CONFIGURATION_Handle *cfg;
124 * Host to run GNUnet on.
129 * Username we are using.
134 * Name of the configuration file
139 * Function to call when the peer is running.
141 GNUNET_TESTING_NotifyDaemonRunning cb;
149 * Arguments from "daemon_stop" call.
151 GNUNET_TESTING_NotifyCompletion dead_cb;
154 * Closure for 'dead_cb'.
159 * Arguments from "daemon_stop" call.
161 GNUNET_TESTING_NotifyCompletion update_cb;
164 * Closure for 'update_cb'.
169 * Identity of this peer (once started).
171 struct GNUNET_PeerIdentity id;
174 * Flag to indicate that we've already been asked
175 * to terminate (but could not because some action
176 * was still pending).
181 * PID of the process that we started last.
186 * How many iterations have we been waiting for
187 * the started process to complete?
189 unsigned int wait_runs;
192 * In which phase are we during the start of
195 enum StartPhase phase;
198 * ID of the current task.
200 GNUNET_SCHEDULER_TaskIdentifier task;
203 * Handle to the server.
205 struct GNUNET_CORE_Handle * server;
210 * Function called after GNUNET_CORE_connect has succeeded
211 * (or failed for good). Note that the private key of the
212 * peer is intentionally not exposed here; if you need it,
213 * your process should try to read the private key file
214 * directly (which should work if you are authorized...).
217 * @param server handle to the server, NULL if we failed
218 * @param my_identity ID of this peer, NULL if we failed
219 * @param publicKey public key of this peer, NULL if we failed
222 testing_init (void *cls,
223 struct GNUNET_CORE_Handle * server,
224 const struct GNUNET_PeerIdentity *
227 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *
230 struct GNUNET_TESTING_Daemon *d = cls;
231 GNUNET_TESTING_NotifyDaemonRunning cb;
233 GNUNET_assert (d->phase == SP_START_CORE);
234 d->phase = SP_START_DONE;
239 if (GNUNET_YES == d->dead)
240 GNUNET_TESTING_daemon_stop (d, d->dead_cb, d->dead_cb_cls);
242 cb (d->cb_cls, NULL, d->cfg, d,
243 _("Failed to connect to core service\n"));
247 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
248 "Successfully started peer `%4s'.\n",
249 GNUNET_i2s(my_identity));
251 d->id = *my_identity;
253 if (GNUNET_YES == d->dead)
254 GNUNET_TESTING_daemon_stop (d, d->dead_cb, d->dead_cb_cls);
256 cb (d->cb_cls, my_identity, d->cfg, d, NULL);
261 * Finite-state machine for starting GNUnet.
263 * @param cls our "struct GNUNET_TESTING_Daemon"
267 start_fsm (void *cls,
268 const struct GNUNET_SCHEDULER_TaskContext *tc)
270 static struct GNUNET_CORE_MessageHandler no_handlers[] =
272 struct GNUNET_TESTING_Daemon * d = cls;
273 GNUNET_TESTING_NotifyDaemonRunning cb;
274 enum GNUNET_OS_ProcessStatusType type;
279 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
280 "Peer FSM is in phase %u.\n",
283 d->task = GNUNET_SCHEDULER_NO_TASK;
287 /* confirm copying complete */
289 GNUNET_OS_process_status (d->pid,
294 if (d->wait_runs > MAX_EXEC_WAIT_RUNS)
303 _("`scp' does not seem to terminate.\n"));
308 = GNUNET_SCHEDULER_add_delayed (d->sched,
310 GNUNET_SCHEDULER_PRIORITY_KEEP,
311 GNUNET_SCHEDULER_NO_TASK,
312 GNUNET_CONSTANTS_EXEC_WAIT,
317 if ( (type != GNUNET_OS_PROCESS_EXITED) ||
327 _("`scp' did not complete cleanly.\n"));
331 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
332 "Successfully copied configuration file.\n");
334 d->phase = SP_COPIED;
337 /* start GNUnet on remote host */
338 if (NULL == d->hostname)
340 d->pid = GNUNET_OS_start_process ("gnunet-service-arm",
341 "gnunet-service-arm",
352 if (d->username != NULL)
353 GNUNET_asprintf (&dst,
358 dst = GNUNET_strdup (d->hostname);
359 d->pid = GNUNET_OS_start_process ("ssh",
362 "gnunet-service-arm",
371 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
372 _("Could not start `%s' process to start GNUnet.\n"),
373 (NULL == d->hostname) ? "gnunet-service-arm" : "ssh");
381 (NULL == d->hostname)
382 ? _("Failed to start `gnunet-service-arm' process.\n")
383 : _("Failed to start `ssh' process.\n"));
386 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
387 "Started `%s', waiting for `%s' to be up.\n",
388 "gnunet-service-arm",
389 "gnunet-service-core");
391 d->phase = SP_START_ARMING;
394 = GNUNET_SCHEDULER_add_delayed (d->sched,
396 GNUNET_SCHEDULER_PRIORITY_KEEP,
397 GNUNET_SCHEDULER_NO_TASK,
398 GNUNET_CONSTANTS_EXEC_WAIT,
402 case SP_START_ARMING:
404 GNUNET_OS_process_status (d->pid,
409 if (d->wait_runs > MAX_EXEC_WAIT_RUNS)
418 (NULL == d->hostname)
419 ? _("`gnunet-service-arm' does not seem to terminate.\n")
420 : _("`ssh' does not seem to terminate.\n"));
425 = GNUNET_SCHEDULER_add_delayed (d->sched,
427 GNUNET_SCHEDULER_PRIORITY_KEEP,
428 GNUNET_SCHEDULER_NO_TASK,
429 GNUNET_CONSTANTS_EXEC_WAIT,
435 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
436 "Successfully started `%s'.\n",
437 "gnunet-service-arm");
439 d->phase = SP_START_CORE;
440 GNUNET_CORE_connect (d->sched,
457 /* confirm copying complete */
459 GNUNET_OS_process_status (d->pid,
464 if (d->wait_runs > MAX_EXEC_WAIT_RUNS)
466 d->dead_cb (d->dead_cb_cls,
467 _("`ssh' does not seem to terminate.\n"));
468 GNUNET_free (d->cfgfile);
469 GNUNET_free_non_null (d->hostname);
470 GNUNET_free_non_null (d->username);
476 = GNUNET_SCHEDULER_add_delayed (d->sched,
478 GNUNET_SCHEDULER_PRIORITY_KEEP,
479 GNUNET_SCHEDULER_NO_TASK,
480 GNUNET_CONSTANTS_EXEC_WAIT,
485 if ( (type != GNUNET_OS_PROCESS_EXITED) ||
488 if (NULL != d->dead_cb)
489 d->dead_cb (d->dead_cb_cls,
490 _("`ssh' did not complete cleanly.\n"));
491 GNUNET_free (d->cfgfile);
492 GNUNET_free_non_null (d->hostname);
493 GNUNET_free_non_null (d->username);
498 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
499 "Peer shutdown complete.\n");
501 GNUNET_free (d->cfgfile);
502 GNUNET_free_non_null (d->hostname);
503 GNUNET_free_non_null (d->username);
504 if (NULL != d->dead_cb)
505 d->dead_cb (d->dead_cb_cls, NULL);
508 case SP_CONFIG_UPDATE:
509 /* confirm copying complete */
511 GNUNET_OS_process_status (d->pid,
516 if (d->wait_runs > MAX_EXEC_WAIT_RUNS)
525 _("`scp' does not seem to terminate.\n"));
530 = GNUNET_SCHEDULER_add_delayed (d->sched,
532 GNUNET_SCHEDULER_PRIORITY_KEEP,
533 GNUNET_SCHEDULER_NO_TASK,
534 GNUNET_CONSTANTS_EXEC_WAIT,
539 if ( (type != GNUNET_OS_PROCESS_EXITED) ||
542 if (NULL != d->update_cb)
543 d->update_cb (d->update_cb_cls,
544 _("`scp' did not complete cleanly.\n"));
548 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
549 "Successfully copied configuration file.\n");
551 if (NULL != d->update_cb)
552 d->update_cb (d->update_cb_cls, NULL);
553 d->phase = SP_START_DONE;
560 * Starts a GNUnet daemon. GNUnet must be installed on the target
561 * system and available in the PATH. The machine must furthermore be
562 * reachable via "ssh" (unless the hostname is "NULL") without the
563 * need to enter a password.
565 * @param sched scheduler to use
566 * @param cfg configuration to use
567 * @param hostname name of the machine where to run GNUnet
568 * (use NULL for localhost).
569 * @param cb function to call with the result
570 * @param cb_cls closure for cb
571 * @return handle to the daemon (actual start will be completed asynchronously)
573 struct GNUNET_TESTING_Daemon *
574 GNUNET_TESTING_daemon_start (struct GNUNET_SCHEDULER_Handle *sched,
575 const struct GNUNET_CONFIGURATION_Handle *cfg,
576 const char *hostname,
577 GNUNET_TESTING_NotifyDaemonRunning cb,
580 struct GNUNET_TESTING_Daemon * ret;
584 ret = GNUNET_malloc (sizeof(struct GNUNET_TESTING_Daemon));
586 ret->hostname = (hostname == NULL) ? NULL : GNUNET_strdup (hostname);
587 ret->cfgfile = GNUNET_DISK_mktemp ("gnunet-testing-config");
589 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
590 "Setting up peer with configuration file `%s'.\n",
593 if (NULL == ret->cfgfile)
595 GNUNET_free_non_null (ret->hostname);
600 ret->cb_cls = cb_cls;
601 ret->cfg = GNUNET_CONFIGURATION_dup (cfg);
602 GNUNET_CONFIGURATION_set_value_string (ret->cfg,
606 /* 1) write configuration to temporary file */
608 GNUNET_CONFIGURATION_write (ret->cfg,
611 if (0 != UNLINK (ret->cfgfile))
612 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
615 GNUNET_CONFIGURATION_destroy (ret->cfg);
616 GNUNET_free_non_null (ret->hostname);
617 GNUNET_free (ret->cfgfile);
622 GNUNET_CONFIGURATION_get_value_string (cfg,
627 if (NULL != getenv ("USER"))
628 username = GNUNET_strdup (getenv("USER"));
632 ret->username = username;
634 /* 2) copy file to remote host */
635 if (NULL != hostname)
637 ret->phase = SP_COPYING;
638 if (NULL != username)
639 GNUNET_asprintf (&arg,
645 GNUNET_asprintf (&arg,
649 ret->pid = GNUNET_OS_start_process ("scp",
657 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
658 _("Could not start `%s' process to copy configuration file.\n"),
660 if (0 != UNLINK (ret->cfgfile))
661 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
664 GNUNET_CONFIGURATION_destroy (ret->cfg);
665 GNUNET_free_non_null (ret->hostname);
666 GNUNET_free_non_null (ret->username);
667 GNUNET_free (ret->cfgfile);
672 = GNUNET_SCHEDULER_add_delayed (sched,
674 GNUNET_SCHEDULER_PRIORITY_KEEP,
675 GNUNET_SCHEDULER_NO_TASK,
676 GNUNET_CONSTANTS_EXEC_WAIT,
682 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
683 "No need to copy configuration file since we are running locally.\n");
685 ret->phase = SP_COPIED;
686 GNUNET_SCHEDULER_add_continuation (sched,
690 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
696 * Stops a GNUnet daemon.
698 * @param d the daemon that should be stopped
699 * @param cb function called once the daemon was stopped
700 * @param cb_cls closure for cb
702 void GNUNET_TESTING_daemon_stop (struct GNUNET_TESTING_Daemon *d,
703 GNUNET_TESTING_NotifyCompletion cb,
706 struct GNUNET_CLIENT_Connection *cc;
711 d->dead = GNUNET_YES;
713 d->dead_cb_cls = cb_cls;
716 if (d->phase == SP_CONFIG_UPDATE)
718 GNUNET_SCHEDULER_cancel (d->sched,
720 d->phase = SP_START_DONE;
722 if (d->server != NULL)
724 GNUNET_CORE_disconnect (d->server);
727 /* shutdown ARM process (will also terminate others) */
728 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
729 _("Terminating peer `%4s'\n"),
731 cc = GNUNET_CLIENT_connect (d->sched,
734 GNUNET_CLIENT_service_shutdown (cc);
735 GNUNET_CLIENT_disconnect (cc);
737 /* state clean up and notifications */
738 if (0 != UNLINK (d->cfgfile))
739 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
742 if (d->hostname != NULL)
744 if (NULL != d->username)
745 GNUNET_asprintf (&dst,
750 dst = GNUNET_strdup (d->hostname);
751 d->pid = GNUNET_OS_start_process ("ssh",
760 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
761 _("Could not start `%s' process to delete configuration file.\n"),
763 GNUNET_free (d->cfgfile);
764 GNUNET_free_non_null (d->hostname);
765 GNUNET_free_non_null (d->username);
767 cb (cb_cls, _("Error cleaning up configuration file.\n"));
770 d->phase = SP_CLEANUP;
772 d->dead_cb_cls = cb_cls;
774 = GNUNET_SCHEDULER_add_delayed (d->sched,
776 GNUNET_SCHEDULER_PRIORITY_KEEP,
777 GNUNET_SCHEDULER_NO_TASK,
778 GNUNET_CONSTANTS_EXEC_WAIT,
783 GNUNET_CONFIGURATION_destroy (d->cfg);
784 GNUNET_free (d->cfgfile);
785 GNUNET_free_non_null (d->hostname);
786 GNUNET_free_non_null (d->username);
794 * Changes the configuration of a GNUnet daemon.
796 * @param d the daemon that should be modified
797 * @param cfg the new configuration for the daemon
798 * @param cb function called once the configuration was changed
799 * @param cb_cls closure for cb
801 void GNUNET_TESTING_daemon_reconfigure (struct GNUNET_TESTING_Daemon *d,
802 struct GNUNET_CONFIGURATION_Handle *cfg,
803 GNUNET_TESTING_NotifyCompletion cb,
808 if (d->phase != SP_START_DONE)
812 _("Peer not yet running, can not change configuration at this point."));
816 /* 1) write configuration to temporary file */
818 GNUNET_CONFIGURATION_write (cfg,
823 _("Failed to write new configuration to disk."));
827 /* 2) copy file to remote host (if necessary) */
828 if (NULL == d->hostname)
835 d->phase = SP_CONFIG_UPDATE;
836 if (NULL != d->username)
837 GNUNET_asprintf (&arg,
843 GNUNET_asprintf (&arg,
847 d->pid = GNUNET_OS_start_process ("scp",
855 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
856 _("Could not start `%s' process to copy configuration file.\n"),
860 _("Failed to copy new configuration to remote machine."));
861 d->phase = SP_START_DONE;
865 d->update_cb_cls = cb_cls;
867 = GNUNET_SCHEDULER_add_delayed (d->sched,
869 GNUNET_SCHEDULER_PRIORITY_KEEP,
870 GNUNET_SCHEDULER_NO_TASK,
871 GNUNET_CONSTANTS_EXEC_WAIT,
879 struct ConnectContext
884 struct GNUNET_TESTING_Daemon *d1;
889 struct GNUNET_TESTING_Daemon *d2;
894 struct GNUNET_TRANSPORT_Handle *d1th;
899 struct GNUNET_TRANSPORT_Handle *d2th;
902 * When should this operation be complete (or we must trigger
905 struct GNUNET_TIME_Absolute timeout;
908 * Function to call once we are done (or have timed out).
910 GNUNET_TESTING_NotifyCompletion cb;
920 * Success, connection is up. Signal client our success.
923 * @param size number of bytes available in buf
924 * @param buf where to copy the message, NULL on error
925 * @return number of bytes copied to buf
928 transmit_ready (void *cls, size_t size, void *buf)
930 struct ConnectContext *ctx = cls;
935 ctx->cb (ctx->cb_cls, _("Peers failed to connect"));
937 ctx->cb (ctx->cb_cls, NULL);
945 * Receive the HELLO from one peer, give it to the other
946 * and ask them to connect.
948 * @param cls "struct ConnectContext"
949 * @param latency how fast is the connection
950 * @param peer ID of peer giving us the HELLO
951 * @param message HELLO message of peer
954 process_hello (void *cls,
955 struct GNUNET_TIME_Relative latency,
956 const struct GNUNET_PeerIdentity *peer,
957 const struct GNUNET_MessageHeader *message)
959 struct ConnectContext *ctx = cls;
965 ctx->cb (ctx->cb_cls,
966 _("Failed to receive `HELLO' from peer\n"));
967 GNUNET_TRANSPORT_disconnect (ctx->d1th);
968 GNUNET_TRANSPORT_disconnect (ctx->d2th);
972 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
973 "Received `%s' from transport service of `%4s'\n",
974 "HELLO", GNUNET_i2s (peer));
975 GNUNET_assert (message != NULL);
976 GNUNET_TRANSPORT_offer_hello (ctx->d2th, message);
977 GNUNET_CORE_notify_transmit_ready (ctx->d2->server,
979 GNUNET_TIME_absolute_get_remaining (ctx->timeout),
981 sizeof (struct GNUNET_MessageHeader),
982 &transmit_ready, ctx);
987 * Establish a connection between two GNUnet daemons.
989 * @param d1 handle for the first daemon
990 * @param d2 handle for the second daemon
991 * @param timeout how long is the connection attempt
993 * @param cb function to call at the end
994 * @param cb_cls closure for cb
996 void GNUNET_TESTING_daemons_connect (struct GNUNET_TESTING_Daemon *d1,
997 struct GNUNET_TESTING_Daemon *d2,
998 struct GNUNET_TIME_Relative timeout,
999 GNUNET_TESTING_NotifyCompletion cb,
1002 struct ConnectContext *ctx;
1004 if ( (d1->server == NULL) ||
1005 (d2->server == NULL) )
1008 cb (cb_cls, _("Peers are not fully running yet, can not connect!\n"));
1011 ctx = GNUNET_malloc (sizeof(struct ConnectContext));
1014 ctx->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1016 ctx->cb_cls = cb_cls;
1017 ctx->d1th = GNUNET_TRANSPORT_connect (d1->sched, d1->cfg, d1, NULL, NULL, NULL);
1018 if (ctx->d1th == NULL)
1022 cb (cb_cls, _("Failed to connect to transport service!\n"));
1025 ctx->d2th = GNUNET_TRANSPORT_connect (d2->sched, d2->cfg, d2, NULL, NULL, NULL);
1026 if (ctx->d2th == NULL)
1028 GNUNET_TRANSPORT_disconnect (ctx->d1th);
1031 cb (cb_cls, _("Failed to connect to transport service!\n"));
1034 GNUNET_TRANSPORT_get_hello (ctx->d1th,
1041 /* end of testing.c */