GNUnet 0.22.0
Data Structures | Functions
testing_arm_cmd_start_peer.c File Reference
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_testing_lib.h"
#include "gnunet_testbed_lib.h"
#include "gnunet_testing_testbed_lib.h"
#include "gnunet_testing_arm_lib.h"
Include dependency graph for testing_arm_cmd_start_peer.c:

Go to the source code of this file.

Data Structures

struct  GNUNET_TESTING_StartPeerState
 Handle for a peer controlled via ARM. More...
 

Functions

static void conn_status (void *cls, enum GNUNET_GenericReturnValue connected)
 Function called whenever we connect to or disconnect from ARM. More...
 
static void start_peer_run (void *cls, struct GNUNET_TESTING_Interpreter *is)
 The run method of this cmd will start all services of a peer to test the transport service. More...
 
static void start_peer_cleanup (void *cls)
 The cleanup function of this cmd frees resources the cmd allocated. More...
 
static enum GNUNET_GenericReturnValue start_peer_traits (void *cls, const void **ret, const char *trait, unsigned int index)
 This function prepares an array with traits. More...
 
struct GNUNET_TESTING_Command GNUNET_TESTING_ARM_cmd_start_peer (const char *label, const char *system_label, const char *cfgname)
 Create command. More...
 

Function Documentation

◆ conn_status()

static void conn_status ( void *  cls,
enum GNUNET_GenericReturnValue  connected 
)
static

Function called whenever we connect to or disconnect from ARM.

Parameters
clsclosure
connectedGNUNET_YES if connected, GNUNET_NO if disconnected, GNUNET_SYSERR if there was an error.

Definition at line 85 of file testing_arm_cmd_start_peer.c.

88{
89 struct GNUNET_TESTING_StartPeerState *sps = cls;
90 struct GNUNET_TESTING_AsyncContext ac = sps->ac;
91
92 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
93 "We %s arm\n",
94 GNUNET_OK != connected ? "disconnected from" : "connected to");
95 if (GNUNET_NO == ac.finished && GNUNET_OK != connected)
96 {
97 GNUNET_break (0);
98 GNUNET_TESTING_async_fail (&sps->ac);
99 return;
100 }
101 else if (GNUNET_NO == ac.finished)
102 GNUNET_TESTING_async_finish (&sps->ac);
103}
GNUNET_TESTING_async_finish
void GNUNET_TESTING_async_finish(struct GNUNET_TESTING_AsyncContext *ac)
The asynchronous command of ac has finished.
Definition: testing_api_loop.c:528
GNUNET_TESTING_async_fail
void GNUNET_TESTING_async_fail(struct GNUNET_TESTING_AsyncContext *ac)
The asynchronous command of ac has failed.
Definition: testing_api_loop.c:519
GNUNET_log
#define GNUNET_log(kind,...)
Definition: gnunet_common.h:571
GNUNET_OK
@ GNUNET_OK
Definition: gnunet_common.h:111
GNUNET_NO
@ GNUNET_NO
Definition: gnunet_common.h:110
GNUNET_break
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
Definition: gnunet_common.h:1064
GNUNET_ERROR_TYPE_DEBUG
@ GNUNET_ERROR_TYPE_DEBUG
Definition: gnunet_common.h:444
GNUNET_TESTING_AsyncContext
State each asynchronous command must have in its closure.
Definition: gnunet_testing_lib.h:81
GNUNET_TESTING_AsyncContext::finished
enum GNUNET_GenericReturnValue finished
Indication if the command finished (GNUNET_OK).
Definition: gnunet_testing_lib.h:104
GNUNET_TESTING_StartPeerState
Handle for a peer controlled via ARM.
Definition: gnunet_testing_transport_lib.h:46
GNUNET_TESTING_StartPeerState::ac
struct GNUNET_TESTING_AsyncContext ac
Context for our asynchronous completion.
Definition: gnunet_testing_transport_lib.h:50

References GNUNET_TESTING_StartPeerState::ac, GNUNET_TESTING_AsyncContext::finished, GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_NO, GNUNET_OK, GNUNET_TESTING_async_fail(), and GNUNET_TESTING_async_finish().

Referenced by start_peer_run().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ start_peer_run()

static void start_peer_run ( void *  cls,
struct GNUNET_TESTING_Interpreter *  is 
)
static

The run method of this cmd will start all services of a peer to test the transport service.

Definition at line 111 of file testing_arm_cmd_start_peer.c.

113{
114 struct GNUNET_TESTING_StartPeerState *sps = cls;
115 const struct GNUNET_TESTING_Command *system_cmd;
116
117 sps->is = is;
118 if (GNUNET_NO ==
119 GNUNET_DISK_file_test (sps->cfgname))
120 {
121 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
122 "File not found: `%s'\n",
123 sps->cfgname);
124 GNUNET_TESTING_FAIL (is);
125 }
126 system_cmd
127 = GNUNET_TESTING_interpreter_lookup_command (is,
128 sps->system_label);
129 if (NULL == system_cmd)
130 GNUNET_TESTING_FAIL (is);
131 if (GNUNET_OK !=
132 GNUNET_TESTING_TESTBED_get_trait_test_system (
133 system_cmd,
134 &sps->system))
135 GNUNET_TESTING_FAIL (is);
136 sps->cfg = GNUNET_CONFIGURATION_create ();
137 if (GNUNET_OK !=
138 GNUNET_CONFIGURATION_load (sps->cfg,
139 sps->cfgname))
140 GNUNET_TESTING_FAIL (is);
141 if (GNUNET_SYSERR ==
142 GNUNET_TESTBED_configuration_create (sps->system,
143 sps->cfg,
144 NULL,
145 NULL))
146 GNUNET_TESTING_FAIL (is);
147 {
148 char *config_filename;
149 char *libexec_binary;
150 char *main_binary;
151 char *args;
152 char *prefix;
153
154 GNUNET_assert (
155 GNUNET_OK ==
156 GNUNET_CONFIGURATION_get_value_filename (
157 sps->cfg,
158 "PATHS",
159 "DEFAULTCONFIG",
160 &config_filename));
161 if (GNUNET_OK !=
162 GNUNET_CONFIGURATION_write (sps->cfg,
163 config_filename))
164 {
165 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
166 "Failed to write configuration file `%s': %s\n",
167 config_filename,
168 strerror (errno));
169 GNUNET_free (config_filename);
170 GNUNET_TESTING_FAIL (is);
171 }
172
173 libexec_binary
174 = GNUNET_OS_get_libexec_binary_path ("gnunet-service-arm");
175
176 if (GNUNET_SYSERR ==
177 GNUNET_CONFIGURATION_get_value_string (sps->cfg,
178 "arm",
179 "PREFIX",
180 &prefix))
181 {
182 /* No prefix */
183 main_binary = libexec_binary;
184 args = GNUNET_strdup ("");
185 }
186 else
187 {
188 main_binary = prefix;
189 args = libexec_binary;
190 }
191 sps->arm
192 = GNUNET_OS_start_process_s (GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
193 NULL,
194 main_binary,
195 args,
196 "-c",
197 config_filename,
198 NULL);
199 if (NULL == sps->arm)
200 {
201 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
202 _ ("Failed to start `%s': %s\n"),
203 main_binary,
204 strerror (errno));
205 GNUNET_TESTING_FAIL (is);
206 }
207 GNUNET_free (config_filename);
208 GNUNET_free (main_binary);
209 GNUNET_free (args);
210 }
211
212 sps->ah = GNUNET_ARM_connect (sps->cfg,
213 &conn_status,
214 sps);
215 if (NULL == sps->ah)
216 GNUNET_TESTING_FAIL (is);
217}
is
static struct GNUNET_TESTING_Interpreter * is
Definition: gnunet-cmds-helper.c:85
prefix
static int prefix
If printing the value of PREFIX has been requested.
Definition: gnunet-config.c:66
GNUNET_TESTBED_configuration_create
enum GNUNET_GenericReturnValue GNUNET_TESTBED_configuration_create(struct GNUNET_TESTBED_System *system, struct GNUNET_CONFIGURATION_Handle *cfg, uint16_t **ports, unsigned int *nports)
Create a new configuration using the given configuration as a template; ports and paths will be modif...
Definition: testbed.c:532
GNUNET_TESTING_FAIL
#define GNUNET_TESTING_FAIL(is)
Print failing line number and trigger shutdown.
Definition: gnunet_testing_lib.h:44
GNUNET_TESTING_interpreter_lookup_command
const struct GNUNET_TESTING_Command * GNUNET_TESTING_interpreter_lookup_command(struct GNUNET_TESTING_Interpreter *is, const char *label)
Lookup command by label.
Definition: testing_api_loop.c:147
GNUNET_TESTING_TESTBED_get_trait_test_system
enum GNUNET_GenericReturnValue GNUNET_TESTING_TESTBED_get_trait_test_system(const struct GNUNET_TESTING_Command *cmd, struct GNUNET_TESTBED_System **ret)
GNUNET_ARM_connect
struct GNUNET_ARM_Handle * GNUNET_ARM_connect(const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_ARM_ConnectionStatusCallback conn_status, void *conn_status_cls)
Set up a context for communicating with ARM, then start connecting to the ARM service using that cont...
Definition: arm_api.c:577
GNUNET_CONFIGURATION_get_value_filename
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_filename(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be the name of a file or directory.
Definition: configuration.c:2084
GNUNET_CONFIGURATION_get_value_string
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_string(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be a string.
Definition: configuration.c:1780
GNUNET_CONFIGURATION_create
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create(void)
Create a new configuration object.
Definition: configuration.c:222
GNUNET_CONFIGURATION_load
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_load(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Load configuration.
Definition: configuration.c:2565
GNUNET_CONFIGURATION_write
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_write(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Write configuration file.
Definition: configuration.c:1344
GNUNET_DISK_file_test
enum GNUNET_GenericReturnValue GNUNET_DISK_file_test(const char *fil)
Check that fil corresponds to a filename (of a file that exists and that is not a directory).
Definition: disk.c:483
GNUNET_SYSERR
@ GNUNET_SYSERR
Definition: gnunet_common.h:109
GNUNET_assert
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
Definition: gnunet_common.h:979
GNUNET_ERROR_TYPE_ERROR
@ GNUNET_ERROR_TYPE_ERROR
Definition: gnunet_common.h:437
GNUNET_strdup
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
Definition: gnunet_common.h:1474
GNUNET_free
#define GNUNET_free(ptr)
Wrapper around free.
Definition: gnunet_common.h:1460
GNUNET_OS_get_libexec_binary_path
char * GNUNET_OS_get_libexec_binary_path(const char *progname)
Given the name of a gnunet-helper, gnunet-service or gnunet-daemon binary, try to prefix it with the ...
Definition: os_installation.c:684
GNUNET_OS_start_process_s
struct GNUNET_OS_Process * GNUNET_OS_start_process_s(enum GNUNET_OS_InheritStdioFlags std_inheritance, const int *lsocks, const char *filename,...)
Start a process.
Definition: os_priority.c:665
GNUNET_OS_INHERIT_STD_OUT_AND_ERR
@ GNUNET_OS_INHERIT_STD_OUT_AND_ERR
When these flags are set, the child process will inherit stdout and stderr of the parent.
Definition: gnunet_os_lib.h:101
_
#define _(String)
GNU gettext support macro.
Definition: platform.h:178
GNUNET_TESTING_Command
A command to be run by the interpreter.
Definition: gnunet_testing_lib.h:239
GNUNET_TESTING_StartPeerState::ah
struct GNUNET_TRANSPORT_ApplicationHandle * ah
Application handle.
Definition: gnunet_testing_transport_lib.h:90
GNUNET_TESTING_StartPeerState::system_label
char * system_label
The label of the command which was started by calling GNUNET_TESTING_cmd_system_create.
Definition: gnunet_testing_transport_lib.h:165
GNUNET_TESTING_StartPeerState::is
struct GNUNET_TESTING_Interpreter * is
Our interpreter.
Definition: testing_arm_cmd_start_peer.c:47
GNUNET_TESTING_StartPeerState::arm
struct GNUNET_OS_Process * arm
Handle to the ARM process information.
Definition: testing_arm_cmd_start_peer.c:67
GNUNET_TESTING_StartPeerState::cfg
struct GNUNET_CONFIGURATION_Handle * cfg
Peer's configuration.
Definition: gnunet_testing_transport_lib.h:70
GNUNET_TESTING_StartPeerState::system
struct GNUNET_TESTBED_System * system
The TESTBED system associated with this peer.
Definition: testing_arm_cmd_start_peer.c:57
GNUNET_TESTING_StartPeerState::cfgname
char * cfgname
GNUnet configuration file used to start a peer.
Definition: gnunet_testing_transport_lib.h:65
conn_status
static void conn_status(void *cls, enum GNUNET_GenericReturnValue connected)
Function called whenever we connect to or disconnect from ARM.
Definition: testing_arm_cmd_start_peer.c:85

References _, GNUNET_TESTING_StartPeerState::ah, consensus-simulation::args, GNUNET_TESTING_StartPeerState::arm, GNUNET_TESTING_StartPeerState::cfg, GNUNET_TESTING_StartPeerState::cfgname, conn_status(), GNUNET_ARM_connect(), GNUNET_assert, GNUNET_CONFIGURATION_create(), GNUNET_CONFIGURATION_get_value_filename(), GNUNET_CONFIGURATION_get_value_string(), GNUNET_CONFIGURATION_load(), GNUNET_CONFIGURATION_write(), GNUNET_DISK_file_test(), GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_log, GNUNET_NO, GNUNET_OK, GNUNET_OS_get_libexec_binary_path(), GNUNET_OS_INHERIT_STD_OUT_AND_ERR, GNUNET_OS_start_process_s(), GNUNET_strdup, GNUNET_SYSERR, GNUNET_TESTBED_configuration_create(), GNUNET_TESTING_FAIL, GNUNET_TESTING_interpreter_lookup_command(), GNUNET_TESTING_TESTBED_get_trait_test_system(), is, GNUNET_TESTING_StartPeerState::is, prefix, GNUNET_TESTING_StartPeerState::system, and GNUNET_TESTING_StartPeerState::system_label.

Referenced by GNUNET_TESTING_ARM_cmd_start_peer().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ start_peer_cleanup()

static void start_peer_cleanup ( void *  cls)
static

The cleanup function of this cmd frees resources the cmd allocated.

Definition at line 225 of file testing_arm_cmd_start_peer.c.

226{
227 struct GNUNET_TESTING_StartPeerState *sps = cls;
228
229 if (NULL != sps->ah)
230 {
231 GNUNET_ARM_disconnect (sps->ah);
232 sps->ah = NULL;
233 }
234 if (NULL != sps->arm)
235 {
236 GNUNET_break (0 ==
237 GNUNET_OS_process_kill (sps->arm,
238 SIGTERM));
239 GNUNET_break (GNUNET_OK ==
240 GNUNET_OS_process_wait (sps->arm));
241 GNUNET_OS_process_destroy (sps->arm);
242 sps->ah = NULL;
243 }
244
245 if (NULL != sps->cfg)
246 {
247 GNUNET_CONFIGURATION_destroy (sps->cfg);
248 sps->cfg = NULL;
249 }
250 GNUNET_free (sps);
251}
GNUNET_ARM_disconnect
void GNUNET_ARM_disconnect(struct GNUNET_ARM_Handle *h)
Disconnect from the ARM service and destroy the handle.
Definition: arm_api.c:603
GNUNET_CONFIGURATION_destroy
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
Definition: configuration.c:307
GNUNET_OS_process_destroy
void GNUNET_OS_process_destroy(struct GNUNET_OS_Process *proc)
Cleans up process structure contents (OS-dependent) and deallocates it.
Definition: os_priority.c:260
GNUNET_OS_process_kill
int GNUNET_OS_process_kill(struct GNUNET_OS_Process *proc, int sig)
Sends a signal to the process.
Definition: os_priority.c:210
GNUNET_OS_process_wait
enum GNUNET_GenericReturnValue GNUNET_OS_process_wait(struct GNUNET_OS_Process *proc)
Wait for a process to terminate.
Definition: os_priority.c:877

References GNUNET_TESTING_StartPeerState::ah, GNUNET_TESTING_StartPeerState::arm, GNUNET_TESTING_StartPeerState::cfg, GNUNET_ARM_disconnect(), GNUNET_break, GNUNET_CONFIGURATION_destroy(), GNUNET_free, GNUNET_OK, GNUNET_OS_process_destroy(), GNUNET_OS_process_kill(), and GNUNET_OS_process_wait().

Referenced by GNUNET_TESTING_ARM_cmd_start_peer().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ start_peer_traits()

static enum GNUNET_GenericReturnValue start_peer_traits ( void *  cls,
const void **  ret,
const char *  trait,
unsigned int  index 
)
static

This function prepares an array with traits.

Definition at line 259 of file testing_arm_cmd_start_peer.c.

263{
264 struct GNUNET_TESTING_StartPeerState *sps = cls;
265 struct GNUNET_TESTING_Trait traits[] = {
266 GNUNET_TESTING_make_trait_process (
267 &sps->arm),
268 // FIXME: expose sps->cfg as trait...
269 GNUNET_TESTING_ARM_make_trait_arm_handle (
270 sps->ah),
271 GNUNET_TESTING_trait_end ()
272 };
273
274 return GNUNET_TESTING_get_trait (traits,
275 ret,
276 trait,
277 index);
278}
ret
static int ret
Final status code.
Definition: gnunet-arm.c:93
GNUNET_TESTING_make_trait_process
struct GNUNET_TESTING_Trait GNUNET_TESTING_make_trait_process(struct GNUNET_OS_Process **value)
GNUNET_TESTING_trait_end
struct GNUNET_TESTING_Trait GNUNET_TESTING_trait_end(void)
"end" of traits array.
GNUNET_TESTING_get_trait
enum GNUNET_GenericReturnValue GNUNET_TESTING_get_trait(const struct GNUNET_TESTING_Trait *traits, const void **ret, const char *trait, unsigned int index)
Obtain value of a trait from a command.
Definition: testing_api_traits.c:62
GNUNET_TESTING_Trait
A struct GNUNET_TESTING_Trait can be used to exchange data between cmds.
Definition: gnunet_testing_lib.h:814
GNUNET_TESTING_Trait::index
unsigned int index
Index number associated with the trait.
Definition: gnunet_testing_lib.h:820
traits
static enum GNUNET_GenericReturnValue traits(void *cls, const void **ret, const char *trait, unsigned int index)
This function prepares an array with traits.
Definition: testing_api_cmd_exec.c:168

References GNUNET_TESTING_StartPeerState::ah, GNUNET_TESTING_StartPeerState::arm, GNUNET_TESTING_get_trait(), GNUNET_TESTING_make_trait_process(), GNUNET_TESTING_trait_end(), GNUNET_TESTING_Trait::index, ret, and traits().

Referenced by GNUNET_TESTING_ARM_cmd_start_peer().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_TESTING_ARM_cmd_start_peer()

struct GNUNET_TESTING_Command GNUNET_TESTING_ARM_cmd_start_peer ( const char *  label,
const char *  system_label,
const char *  cfgname 
)

Create command.

Parameters
labelname for command.
system_labelLabel of the cmd to setup a test environment.
cfgnameConfiguration file name for this peer.
Returns
command.

Definition at line 282 of file testing_arm_cmd_start_peer.c.

286{
287 struct GNUNET_TESTING_StartPeerState *sps;
288
289 sps = GNUNET_new (struct GNUNET_TESTING_StartPeerState);
290 sps->system_label = GNUNET_strdup (system_label);
291 sps->cfgname = cfgname;
292 return GNUNET_TESTING_command_new_ac (sps,
293 label,
294 &start_peer_run,
295 &start_peer_cleanup,
296 &start_peer_traits,
297 &sps->ac);
298}
GNUNET_TESTING_command_new_ac
struct GNUNET_TESTING_Command GNUNET_TESTING_command_new_ac(void *cls, const char *label, GNUNET_TESTING_CommandRunRoutine run, GNUNET_TESTING_CommandCleanupRoutine cleanup, GNUNET_TESTING_CommandGetTraits traits, struct GNUNET_TESTING_AsyncContext *ac)
Create a new command that may be asynchronous.
Definition: testing_api_cmds.c:34
GNUNET_new
#define GNUNET_new(type)
Allocate a struct or union of the given type.
Definition: gnunet_common.h:1259
start_peer_cleanup
static void start_peer_cleanup(void *cls)
The cleanup function of this cmd frees resources the cmd allocated.
Definition: testing_arm_cmd_start_peer.c:225
start_peer_traits
static enum GNUNET_GenericReturnValue start_peer_traits(void *cls, const void **ret, const char *trait, unsigned int index)
This function prepares an array with traits.
Definition: testing_arm_cmd_start_peer.c:259
start_peer_run
static void start_peer_run(void *cls, struct GNUNET_TESTING_Interpreter *is)
The run method of this cmd will start all services of a peer to test the transport service.
Definition: testing_arm_cmd_start_peer.c:111

References GNUNET_TESTING_StartPeerState::ac, GNUNET_TESTING_StartPeerState::cfgname, GNUNET_new, GNUNET_strdup, GNUNET_TESTING_command_new_ac(), start_peer_cleanup(), start_peer_run(), start_peer_traits(), and GNUNET_TESTING_StartPeerState::system_label.

Here is the call graph for this function: