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 include/gnunet_testing_lib.h
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 #ifndef GNUNET_TESTING_LIB_H
33 #define GNUNET_TESTING_LIB_H
35 #include "gnunet_util_lib.h"
36 #include "gnunet_statistics_service.h"
41 #if 0 /* keep Emacsens' auto-indent happy */
47 * Handle for a GNUnet daemon (technically a set of
48 * daemons; the handle is really for the master ARM
49 * daemon) started by the testing library.
51 struct GNUNET_TESTING_Daemon;
54 * Linked list of hostnames and ports to use for starting daemons.
56 struct GNUNET_TESTING_Host
59 * Pointer to next item in the list.
61 struct GNUNET_TESTING_Host *next;
64 * Hostname to connect to.
69 * Username to use when connecting (may be null).
74 * Port to use for SSH connection (used for ssh
75 * connection forwarding, 0 to let ssh decide)
81 * Prototype of a function that will be called whenever
82 * a daemon was started by the testing library.
85 * @param id identifier for the daemon, NULL on error
86 * @param d handle for the daemon
87 * @param emsg error message (NULL on success)
89 typedef void (*GNUNET_TESTING_NotifyHostkeyCreated)(void *cls,
90 const struct GNUNET_PeerIdentity *id,
91 struct GNUNET_TESTING_Daemon *d,
95 * Prototype of a function that will be called whenever
96 * a daemon was started by the testing library.
99 * @param id identifier for the daemon, NULL on error
100 * @param cfg configuration used by this daemon
101 * @param d handle for the daemon
102 * @param emsg error message (NULL on success)
104 typedef void (*GNUNET_TESTING_NotifyDaemonRunning)(void *cls,
105 const struct GNUNET_PeerIdentity *id,
106 const struct GNUNET_CONFIGURATION_Handle *cfg,
107 struct GNUNET_TESTING_Daemon *d,
112 * Handle to an entire testbed of GNUnet peers.
114 struct GNUNET_TESTING_Testbed;
117 * Phases of starting GNUnet on a system.
119 enum GNUNET_TESTING_StartPhase
122 * Copy the configuration file to the target system.
127 * Configuration file has been copied, generate hostkey.
132 * Create the hostkey for the peer.
137 * Hostkey generated, wait for topology to be finished.
142 * Topology has been created, now start ARM.
147 * ARM has been started, check that it has properly daemonized and
148 * then try to connect to the CORE service (which should be
149 * auto-started by ARM).
154 * We're waiting for CORE to start.
159 * Core has notified us that we've established a connection to the service.
160 * The main FSM halts here and waits to be moved to UPDATE or CLEANUP.
165 * We've been asked to terminate the instance and are now waiting for
166 * the remote command to stop the gnunet-arm process and delete temporary
172 * We've received a configuration update and are currently waiting for
173 * the copy process for the update to complete. Once it is, we will
174 * return to "SP_START_DONE" (and rely on ARM to restart all affected
181 * Prototype of a function that will be called when a
182 * particular operation was completed the testing library.
185 * @param emsg NULL on success
187 typedef void (*GNUNET_TESTING_NotifyCompletion)(void *cls,
191 * Prototype of a function that will be called with the
192 * number of connections created for a particular topology.
195 * @param num_connections the number of connections created
197 typedef void (*GNUNET_TESTING_NotifyConnections)(void *cls,
198 unsigned int num_connections);
201 * Handle for a GNUnet daemon (technically a set of
202 * daemons; the handle is really for the master ARM
203 * daemon) started by the testing library.
205 struct GNUNET_TESTING_Daemon
210 struct GNUNET_SCHEDULER_Handle *sched;
215 struct GNUNET_CONFIGURATION_Handle *cfg;
218 * At what time to give up starting the peer
220 struct GNUNET_TIME_Absolute max_timeout;
223 * Host to run GNUnet on.
228 * Port to use for ssh, NULL to let system choose default.
233 * Result of GNUNET_i2s of this peer,
239 * Username we are using.
244 * Name of the configuration file
249 * Callback to inform initiator that the peer's
250 * hostkey has been created.
252 GNUNET_TESTING_NotifyHostkeyCreated hostkey_callback;
255 * Closure for hostkey creation callback.
260 * Function to call when the peer is running.
262 GNUNET_TESTING_NotifyDaemonRunning cb;
270 * Arguments from "daemon_stop" call.
272 GNUNET_TESTING_NotifyCompletion dead_cb;
275 * Closure for 'dead_cb'.
280 * Arguments from "daemon_stop" call.
282 GNUNET_TESTING_NotifyCompletion update_cb;
285 * Closure for 'update_cb'.
290 * Identity of this peer (once started).
292 struct GNUNET_PeerIdentity id;
295 * Flag to indicate that we've already been asked
296 * to terminate (but could not because some action
297 * was still pending).
302 * PID of the process that we started last.
307 * In which phase are we during the start of
310 enum GNUNET_TESTING_StartPhase phase;
313 * ID of the current task.
315 GNUNET_SCHEDULER_TaskIdentifier task;
318 * Handle to the server.
320 struct GNUNET_CORE_Handle *server;
323 * Handle to the transport service of this peer
325 struct GNUNET_TRANSPORT_Handle *th;
328 * HELLO message for this peer
330 struct GNUNET_HELLO_Message *hello;
333 * Handle to a pipe for reading the hostkey.
335 struct GNUNET_DISK_PipeHandle *pipe_stdout;
338 * Output from gnunet-peerinfo is read into this buffer.
340 char hostkeybuf[105];
343 * Current position in 'hostkeybuf' (for reading from gnunet-peerinfo)
345 unsigned int hostkeybufpos;
348 * Set to GNUNET_YES once the peer is up.
353 * Used to tell shutdown not to remove configuration for the peer
354 * (if it's going to be restarted later)
361 * Handle to a group of GNUnet peers.
363 struct GNUNET_TESTING_PeerGroup;
367 * Prototype of a function that will be called whenever
368 * two daemons are connected by the testing library.
371 * @param first peer id for first daemon
372 * @param second peer id for the second daemon
373 * @param distance distance between the connected peers
374 * @param first_cfg config for the first daemon
375 * @param second_cfg config for the second daemon
376 * @param first_daemon handle for the first daemon
377 * @param second_daemon handle for the second daemon
378 * @param emsg error message (NULL on success)
380 typedef void (*GNUNET_TESTING_NotifyConnection)(void *cls,
381 const struct GNUNET_PeerIdentity *first,
382 const struct GNUNET_PeerIdentity *second,
384 const struct GNUNET_CONFIGURATION_Handle *first_cfg,
385 const struct GNUNET_CONFIGURATION_Handle *second_cfg,
386 struct GNUNET_TESTING_Daemon *first_daemon,
387 struct GNUNET_TESTING_Daemon *second_daemon,
391 * Prototype of a callback function indicating that two peers
392 * are currently connected.
395 * @param first peer id for first daemon
396 * @param second peer id for the second daemon
397 * @param distance distance between the connected peers
398 * @param emsg error message (NULL on success)
400 typedef void (*GNUNET_TESTING_NotifyTopology)(void *cls,
401 const struct GNUNET_PeerIdentity *first,
402 const struct GNUNET_PeerIdentity *second,
403 struct GNUNET_TIME_Relative latency,
408 * Starts a GNUnet daemon. GNUnet must be installed on the target
409 * system and available in the PATH. The machine must furthermore be
410 * reachable via "ssh" (unless the hostname is "NULL") without the
411 * need to enter a password.
413 * @param sched scheduler to use
414 * @param cfg configuration to use
415 * @param timeout how long to wait starting up peers
416 * @param hostname name of the machine where to run GNUnet
417 * (use NULL for localhost).
418 * @param ssh_username ssh username to use when connecting to hostname
419 * @param sshport port to pass to ssh process when connecting to hostname
420 * @param hostkey_callback function to call once the hostkey has been
421 * generated for this peer, but it hasn't yet been started
422 * (NULL to start immediately, otherwise waits on GNUNET_TESTING_daemon_continue_start)
423 * @param hostkey_cls closure for hostkey callback
424 * @param cb function to call once peer is up, or failed to start
425 * @param cb_cls closure for cb
426 * @return handle to the daemon (actual start will be completed asynchronously)
428 struct GNUNET_TESTING_Daemon *
429 GNUNET_TESTING_daemon_start (struct GNUNET_SCHEDULER_Handle *sched,
430 const struct GNUNET_CONFIGURATION_Handle *cfg,
431 struct GNUNET_TIME_Relative timeout,
432 const char *hostname,
433 const char *ssh_username,
435 GNUNET_TESTING_NotifyHostkeyCreated hostkey_callback,
437 GNUNET_TESTING_NotifyDaemonRunning cb,
441 * Continues GNUnet daemon startup when user wanted to be notified
442 * once a hostkey was generated (for creating friends files, blacklists,
445 * @param daemon the daemon to finish starting
448 GNUNET_TESTING_daemon_continue_startup(struct GNUNET_TESTING_Daemon *daemon);
451 * Restart (stop and start) a GNUnet daemon.
453 * @param d the daemon that should be restarted
454 * @param cb function called once the daemon is (re)started
455 * @param cb_cls closure for cb
458 GNUNET_TESTING_daemon_restart (struct GNUNET_TESTING_Daemon *d,
459 GNUNET_TESTING_NotifyDaemonRunning cb, void *cb_cls);
462 * Start a peer that has previously been stopped using the daemon_stop
463 * call (and files weren't deleted and the allow restart flag)
465 * @param daemon the daemon to start (has been previously stopped)
466 * @param timeout how long to wait for restart
467 * @param cb the callback for notification when the peer is running
468 * @param cb_cls closure for the callback
471 GNUNET_TESTING_daemon_start_stopped (struct GNUNET_TESTING_Daemon *daemon,
472 struct GNUNET_TIME_Relative timeout,
473 GNUNET_TESTING_NotifyDaemonRunning cb,
477 * Get a certain testing daemon handle.
479 * @param pg handle to the set of running peers
480 * @param position the number of the peer to return
482 struct GNUNET_TESTING_Daemon *
483 GNUNET_TESTING_daemon_get (struct GNUNET_TESTING_PeerGroup *pg,
484 unsigned int position);
487 * Get a daemon by peer identity, so callers can
488 * retrieve the daemon without knowing it's offset.
490 * @param pg the peer group to retrieve the daemon from
491 * @param peer_id the peer identity of the daemon to retrieve
493 * @return the daemon on success, or NULL if no such peer identity is found
495 struct GNUNET_TESTING_Daemon *
496 GNUNET_TESTING_daemon_get_by_id (struct GNUNET_TESTING_PeerGroup *pg,
497 struct GNUNET_PeerIdentity *peer_id);
500 * Stops a GNUnet daemon.
502 * @param d the daemon that should be stopped
503 * @param timeout how long to wait for process for shutdown to complete
504 * @param cb function called once the daemon was stopped
505 * @param cb_cls closure for cb
506 * @param delete_files GNUNET_YES to remove files, GNUNET_NO
507 * to leave them (i.e. for restarting at a later time,
508 * or logfile inspection once finished)
509 * @param allow_restart GNUNET_YES to restart peer later (using this API)
510 * GNUNET_NO to kill off and clean up for good
513 GNUNET_TESTING_daemon_stop (struct GNUNET_TESTING_Daemon *d,
514 struct GNUNET_TIME_Relative timeout,
515 GNUNET_TESTING_NotifyCompletion cb, void *cb_cls,
516 int delete_files, int allow_restart);
520 * Changes the configuration of a GNUnet daemon.
522 * @param d the daemon that should be modified
523 * @param cfg the new configuration for the daemon
524 * @param cb function called once the configuration was changed
525 * @param cb_cls closure for cb
527 void GNUNET_TESTING_daemon_reconfigure (struct GNUNET_TESTING_Daemon *d,
528 struct GNUNET_CONFIGURATION_Handle *cfg,
529 GNUNET_TESTING_NotifyCompletion cb,
534 * Establish a connection between two GNUnet daemons.
536 * @param d1 handle for the first daemon
537 * @param d2 handle for the second daemon
538 * @param timeout how long is the connection attempt
540 * @param max_connect_attempts how many times should we try to reconnect
542 * @param cb function to call at the end
543 * @param cb_cls closure for cb
545 void GNUNET_TESTING_daemons_connect (struct GNUNET_TESTING_Daemon *d1,
546 struct GNUNET_TESTING_Daemon *d2,
547 struct GNUNET_TIME_Relative timeout,
548 unsigned int max_connect_attempts,
549 GNUNET_TESTING_NotifyConnection cb,
556 * Start count gnunetd processes with the same set of transports and
557 * applications. The port numbers (any option called "PORT") will be
558 * adjusted to ensure that no two peers running on the same system
559 * have the same port(s) in their respective configurations.
561 * @param sched scheduler to use
562 * @param cfg configuration template to use
563 * @param total number of daemons to start
564 * @param timeout total time allowed for peers to start
565 * @param hostkey_callback function to call on each peers hostkey generation
566 * if NULL, peers will be started by this call, if non-null,
567 * GNUNET_TESTING_daemons_continue_startup must be called after
568 * successful hostkey generation
569 * @param hostkey_cls closure for hostkey callback
570 * @param cb function to call on each daemon that was started
571 * @param cb_cls closure for cb
572 * @param connect_callback function to call each time two hosts are connected
573 * @param connect_callback_cls closure for connect_callback
574 * @param hostnames linked list of hosts to use to start peers on (NULL to run on localhost only)
576 * @return NULL on error, otherwise handle to control peer group
578 struct GNUNET_TESTING_PeerGroup *
579 GNUNET_TESTING_daemons_start (struct GNUNET_SCHEDULER_Handle *sched,
580 const struct GNUNET_CONFIGURATION_Handle *cfg,
582 struct GNUNET_TIME_Relative timeout,
583 GNUNET_TESTING_NotifyHostkeyCreated hostkey_callback,
585 GNUNET_TESTING_NotifyDaemonRunning cb,
587 GNUNET_TESTING_NotifyConnection
588 connect_callback, void *connect_callback_cls,
589 const struct GNUNET_TESTING_Host *hostnames);
592 * Function which continues a peer group starting up
593 * after successfully generating hostkeys for each peer.
595 * @param pg the peer group to continue starting
598 GNUNET_TESTING_daemons_continue_startup(struct GNUNET_TESTING_PeerGroup *pg);
601 * Restart all peers in the given group.
603 * @param pg the handle to the peer group
604 * @param callback function to call on completion (or failure)
605 * @param callback_cls closure for the callback function
608 GNUNET_TESTING_daemons_restart (struct GNUNET_TESTING_PeerGroup *pg,
609 GNUNET_TESTING_NotifyCompletion callback,
614 * Shutdown all peers started in the given group.
616 * @param pg handle to the peer group
617 * @param timeout how long to wait for shutdown
618 * @param cb callback to notify upon success or failure
619 * @param cb_cls closure for cb
622 GNUNET_TESTING_daemons_stop (struct GNUNET_TESTING_PeerGroup *pg,
623 struct GNUNET_TIME_Relative timeout,
624 GNUNET_TESTING_NotifyCompletion cb,
629 * Count the number of running peers.
631 * @param pg handle for the peer group
633 * @return the number of currently running peers in the peer group
636 GNUNET_TESTING_daemons_running (struct GNUNET_TESTING_PeerGroup *pg);
639 * Simulate churn by stopping some peers (and possibly
640 * re-starting others if churn is called multiple times). This
641 * function can only be used to create leave-join churn (peers "never"
642 * leave for good). First "voff" random peers that are currently
643 * online will be taken offline; then "von" random peers that are then
644 * offline will be put back online. No notifications will be
645 * generated for any of these operations except for the callback upon
646 * completion. Note that the implementation is at liberty to keep
647 * the ARM service itself (but none of the other services or daemons)
648 * running even though the "peer" is being varied offline.
650 * @param pg handle for the peer group
651 * @param voff number of peers that should go offline
652 * @param von number of peers that should come back online;
653 * must be zero on first call (since "testbed_start"
654 * always starts all of the peers)
655 * @param timeout how long to wait for operations to finish before
657 * @param cb function to call at the end
658 * @param cb_cls closure for cb
661 GNUNET_TESTING_daemons_churn (struct GNUNET_TESTING_PeerGroup *pg,
664 struct GNUNET_TIME_Relative timeout,
665 GNUNET_TESTING_NotifyCompletion cb,
669 * Callback function to process statistic values.
672 * @param peer the peer the statistics belong to
673 * @param subsystem name of subsystem that created the statistic
674 * @param name the name of the datum
675 * @param value the current value
676 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
677 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
679 typedef int (*GNUNET_TESTING_STATISTICS_Iterator) (void *cls,
680 const struct GNUNET_PeerIdentity *peer,
681 const char *subsystem,
687 * Iterate over all (running) peers in the peer group, retrieve
688 * all statistics from each.
691 GNUNET_TESTING_get_statistics (struct GNUNET_TESTING_PeerGroup *pg,
692 GNUNET_STATISTICS_Callback cont,
693 GNUNET_TESTING_STATISTICS_Iterator proc, void *cls);
696 * Topologies supported for testbeds.
698 enum GNUNET_TESTING_Topology
701 * A clique (everyone connected to everyone else).
703 GNUNET_TESTING_TOPOLOGY_CLIQUE,
706 * Small-world network (2d torus plus random links).
708 GNUNET_TESTING_TOPOLOGY_SMALL_WORLD,
711 * Small-world network (ring plus random links).
713 GNUNET_TESTING_TOPOLOGY_SMALL_WORLD_RING,
718 GNUNET_TESTING_TOPOLOGY_RING,
723 GNUNET_TESTING_TOPOLOGY_2D_TORUS,
728 GNUNET_TESTING_TOPOLOGY_ERDOS_RENYI,
731 * Certain percentage of peers are unable to communicate directly
732 * replicating NAT conditions
734 GNUNET_TESTING_TOPOLOGY_INTERNAT,
737 * Scale free topology.
739 GNUNET_TESTING_TOPOLOGY_SCALE_FREE,
742 * Straight line topology.
744 GNUNET_TESTING_TOPOLOGY_LINE,
747 * All peers are disconnected.
749 GNUNET_TESTING_TOPOLOGY_NONE
753 * Options for connecting a topology.
755 enum GNUNET_TESTING_TopologyOption
758 * Try to connect all peers specified in the topology.
760 GNUNET_TESTING_TOPOLOGY_OPTION_ALL,
763 * Choose a random subset of connections to create.
765 GNUNET_TESTING_TOPOLOGY_OPTION_RANDOM,
768 * Create at least X connections for each peer.
770 GNUNET_TESTING_TOPOLOGY_OPTION_MINIMUM,
773 * Using a depth first search, create one connection
774 * per peer. If any are missed (graph disconnected)
775 * start over at those peers until all have at least one
778 GNUNET_TESTING_TOPOLOGY_OPTION_DFS,
781 * No options specified.
783 GNUNET_TESTING_TOPOLOGY_OPTION_NONE
788 * Get a topology from a string input.
790 * @param topology where to write the retrieved topology
791 * @param topology_string The string to attempt to
792 * get a configuration value from
793 * @return GNUNET_YES if topology string matched a
794 * known topology, GNUNET_NO if not
797 GNUNET_TESTING_topology_get(enum GNUNET_TESTING_Topology *topology, char * topology_string);
800 * Get connect topology option from string input.
802 * @param topology_option where to write the retrieved topology
803 * @param topology_string The string to attempt to
804 * get a configuration value from
805 * @return GNUNET_YES if topology string matched a
806 * known topology, GNUNET_NO if not
809 GNUNET_TESTING_topology_option_get(enum GNUNET_TESTING_TopologyOption *topology_option,
810 char * topology_string);
814 * Takes a peer group and creates a topology based on the
815 * one specified. Creates a topology means generates friend
816 * files for the peers so they can only connect to those allowed
817 * by the topology. This will only have an effect once peers
818 * are started if the FRIENDS_ONLY option is set in the base
819 * config. Also takes an optional restrict topology which
820 * disallows direct TCP connections UNLESS they are specified in
821 * the restricted topology.
823 * @param pg the peer group struct representing the running peers
824 * @param topology which topology to connect the peers in
825 * @param restrict_topology allow only direct TCP connections in this topology
826 * @param restrict_transports space delimited list of transports to blacklist
827 * to create restricted topology
829 * @return the maximum number of connections were all allowed peers
830 * connected to each other
833 GNUNET_TESTING_create_topology (struct GNUNET_TESTING_PeerGroup *pg,
834 enum GNUNET_TESTING_Topology topology,
835 enum GNUNET_TESTING_Topology restrict_topology,
836 char *restrict_transports);
839 * Iterate over all (running) peers in the peer group, retrieve
840 * all connections that each currently has.
842 * @param pg the peer group we are concerned with
843 * @param cb callback for topology information
844 * @param cls closure for callback
847 GNUNET_TESTING_get_topology (struct GNUNET_TESTING_PeerGroup *pg, GNUNET_TESTING_NotifyTopology cb, void *cls);
850 * There are many ways to connect peers that are supported by this function.
851 * To connect peers in the same topology that was created via the
852 * GNUNET_TESTING_create_topology, the topology variable must be set to
853 * GNUNET_TESTING_TOPOLOGY_NONE. If the topology variable is specified,
854 * a new instance of that topology will be generated and attempted to be
855 * connected. This could result in some connections being impossible,
856 * because some topologies are non-deterministic.
858 * @param pg the peer group struct representing the running peers
859 * @param topology which topology to connect the peers in
860 * @param options options for connecting the topology
861 * @param option_modifier modifier for options that take a parameter
862 * @return the number of connections that will be attempted, GNUNET_SYSERR on error
865 GNUNET_TESTING_connect_topology (struct GNUNET_TESTING_PeerGroup *pg,
866 enum GNUNET_TESTING_Topology topology,
867 enum GNUNET_TESTING_TopologyOption options,
868 double option_modifier);
871 * Start or stop an individual peer from the given group.
873 * @param pg handle to the peer group
874 * @param offset which peer to start or stop
875 * @param desired_status GNUNET_YES to have it running, GNUNET_NO to stop it
876 * @param timeout how long to wait for shutdown
877 * @param cb function to call at the end
878 * @param cb_cls closure for cb
881 GNUNET_TESTING_daemons_vary (struct GNUNET_TESTING_PeerGroup *pg,
884 struct GNUNET_TIME_Relative timeout,
885 GNUNET_TESTING_NotifyCompletion cb,
889 #if 0 /* keep Emacsens' auto-indent happy */