2 This file is part of GNUnet
3 (C) 2008--2012 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 testbed/testbed_api_test.c
23 * @brief high-level test function
24 * @author Christian Grothoff
25 * @author Sree Harsha Totakura
28 #include "gnunet_testbed_service.h"
32 * Context information for test run
37 * Test master callback
39 GNUNET_TESTBED_TestMaster test_master;
42 * Closure for test master
44 void *test_master_cls;
47 * The controller event callback
49 GNUNET_TESTBED_ControllerCallback cc;
52 * Closure for the above callback
57 * event mask for the controller callback
62 * Number of peers to start
64 unsigned int num_peers;
72 * @param args arguments passed to GNUNET_PROGRAM_run
73 * @param cfgfile the path to configuration file
74 * @param config the configuration file handle
77 run (void *cls, char *const *args, const char *cfgfile,
78 const struct GNUNET_CONFIGURATION_Handle *config)
80 struct TestRunContext *rc = cls;
82 GNUNET_TESTBED_run (NULL, config, rc->num_peers, rc->event_mask, rc->cc,
83 rc->cc_cls, rc->test_master, rc->test_master_cls);
88 * Convenience method for running a "simple" test on the local system
89 * with a single call from 'main'. Underlay and overlay topology are
90 * configured using the "UNDERLAY" and "OVERLAY" options in the
91 * "[testbed]" section of the configuration (with possible options
92 * given in "UNDERLAY_XXX" and/or "OVERLAY_XXX").
94 * The test is to be terminated using a call to
95 * "GNUNET_SCHEDULER_shutdown". If starting the test fails,
96 * the program is stopped without 'master' ever being run.
98 * NOTE: this function should be called from 'main', NOT from
99 * within a GNUNET_SCHEDULER-loop. This function will initialze
100 * the scheduler loop, the testbed and then pass control to
103 * @param testname name of the testcase (to configure logging, etc.)
104 * @param cfg_filename configuration filename to use
105 * (for testbed, controller and peers)
106 * @param num_peers number of peers to start
107 * @param event_mask bit mask with set of events to call 'cc' for;
108 * or-ed values of "1LL" shifted by the
109 * respective 'enum GNUNET_TESTBED_EventType'
110 * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...")
111 * @param cc controller callback to invoke on events; This callback is called
112 * for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't
113 * set in the event_mask as this is the only way get access to the
114 * handle of each peer
115 * @param cc_cls closure for cc
116 * @param test_master task to run once the test is ready
117 * @param test_master_cls closure for 'task'.
118 * @return GNUNET_SYSERR on error, GNUNET_OK on success
121 GNUNET_TESTBED_test_run (const char *testname, const char *cfg_filename,
122 unsigned int num_peers, uint64_t event_mask,
123 GNUNET_TESTBED_ControllerCallback cc, void *cc_cls,
124 GNUNET_TESTBED_TestMaster test_master,
125 void *test_master_cls)
133 struct GNUNET_GETOPT_CommandLineOption options[] = {
134 GNUNET_GETOPT_OPTION_END
136 struct TestRunContext *rc;
139 argv2[0] = GNUNET_strdup (testname);
140 argv2[2] = GNUNET_strdup (cfg_filename);
141 GNUNET_assert (NULL != test_master);
142 GNUNET_assert (num_peers > 0);
143 rc = GNUNET_malloc (sizeof (struct TestRunContext) +
144 (num_peers * sizeof (struct GNUNET_TESTBED_Peer *)));
145 rc->test_master = test_master;
146 rc->test_master_cls = test_master_cls;
147 rc->num_peers = num_peers;
148 rc->event_mask = event_mask;
152 GNUNET_PROGRAM_run ((sizeof (argv2) / sizeof (char *)) - 1, argv2,
153 testname, "nohelp", options, &run, rc);
155 GNUNET_free (argv2[0]);
156 GNUNET_free (argv2[2]);
160 /* end of testbed_api_test.c */