GNUnet 0.22.2
testing_arm_cmd_start_peer.c
Go to the documentation of this file.
1/*
2 This file is part of GNUnet
3 Copyright (C) 2021 GNUnet e.V.
4
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
9
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 Affero General Public License for more details.
14
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
17
18 SPDX-License-Identifier: AGPL3.0-or-later
19 */
20
26#include "platform.h"
27#include "gnunet_util_lib.h"
28#include "gnunet_testing_lib.h"
29#include "gnunet_testbed_lib.h"
32
33
38{
39
40 const char *system_label;
41
42 const char *cfgname;
43
48
53
58
63
68
73
74};
75
76
84static void
86 void *cls,
87 enum GNUNET_GenericReturnValue connected)
88{
89 struct GNUNET_TESTING_StartPeerState *sps = cls;
90 struct GNUNET_TESTING_AsyncContext ac = sps->ac;
91
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);
99 return;
100 }
101 else if (GNUNET_NO == ac.finished)
103}
104
105
110static void
111start_peer_run (void *cls,
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 ==
120 {
122 "File not found: `%s'\n",
123 sps->cfgname);
125 }
126 system_cmd
128 sps->system_label);
129 if (NULL == system_cmd)
131 if (GNUNET_OK !=
133 system_cmd,
134 &sps->system))
137 if (GNUNET_OK !=
139 sps->cfgname))
141 if (GNUNET_SYSERR ==
143 sps->cfg,
144 NULL,
145 NULL))
147 {
148 char *config_filename;
149 char *libexec_binary;
150 char *main_binary;
151 char *args;
152 char *prefix;
153 int16_t ret;
154
156 GNUNET_OK ==
158 sps->cfg,
159 "PATHS",
160 "DEFAULTCONFIG",
161 &config_filename));
162 if (GNUNET_OK !=
164 config_filename))
165 {
167 "Failed to write configuration file `%s': %s\n",
168 config_filename,
169 strerror (errno));
170 GNUNET_free (config_filename);
172 }
173
174 libexec_binary
176 "gnunet-service-arm");
177
179 "arm",
180 "PREFIX",
181 &prefix);
182 if ((GNUNET_SYSERR == ret) || (NULL == prefix))
183 {
184 /* No prefix */
185 main_binary = libexec_binary;
186 args = GNUNET_strdup ("");
187 }
188 else
189 {
190 main_binary = prefix;
191 args = libexec_binary;
192 }
193 sps->arm
195 NULL,
196 main_binary,
197 args,
198 "-c",
199 config_filename,
200 NULL);
201 if (NULL == sps->arm)
202 {
204 _ ("Failed to start `%s': %s\n"),
205 main_binary,
206 strerror (errno));
208 }
209 GNUNET_free (config_filename);
210 GNUNET_free (main_binary);
212 }
213
214 sps->ah = GNUNET_ARM_connect (sps->cfg,
216 sps);
217 if (NULL == sps->ah)
219}
220
221
226static void
228{
229 struct GNUNET_TESTING_StartPeerState *sps = cls;
230
231 if (NULL != sps->ah)
232 {
234 sps->ah = NULL;
235 }
236 if (NULL != sps->arm)
237 {
238 GNUNET_break (0 ==
240 SIGTERM));
244 sps->ah = NULL;
245 }
246
247 if (NULL != sps->cfg)
248 {
250 sps->cfg = NULL;
251 }
252 GNUNET_free (sps);
253}
254
255
262 const void **ret,
263 const char *trait,
264 unsigned int index)
265{
266 struct GNUNET_TESTING_StartPeerState *sps = cls;
267 struct GNUNET_TESTING_Trait traits[] = {
269 &sps->arm),
270 GNUNET_TESTING_ARM_make_trait_config (
271 sps->cfg),
272 GNUNET_TESTING_ARM_make_trait_arm_handle (
273 sps->ah),
275 };
276
278 ret,
279 trait,
280 index);
281}
282
283
286 const char *label,
287 const char *system_label,
288 const char *cfgname)
289{
291
294 sps->cfgname = cfgname;
296 label,
300 &sps->ac);
301}
static int ret
Final status code.
Definition: gnunet-arm.c:93
static struct GNUNET_TESTING_Interpreter * is
static int prefix
If printing the value of PREFIX has been requested.
Definition: gnunet-config.c:65
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
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.
struct GNUNET_TESTING_Trait GNUNET_TESTING_make_trait_process(struct GNUNET_OS_Process **value)
void GNUNET_TESTING_async_finish(struct GNUNET_TESTING_AsyncContext *ac)
The asynchronous command of ac has finished.
#define GNUNET_TESTING_FAIL(is)
Print failing line number and trigger shutdown.
void GNUNET_TESTING_async_fail(struct GNUNET_TESTING_AsyncContext *ac)
The asynchronous command of ac has failed.
const struct GNUNET_TESTING_Command * GNUNET_TESTING_interpreter_lookup_command(struct GNUNET_TESTING_Interpreter *is, const char *label)
Lookup command by label.
struct GNUNET_TESTING_Trait GNUNET_TESTING_trait_end(void)
"end" of traits array.
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.
enum GNUNET_GenericReturnValue GNUNET_TESTING_TESTBED_get_trait_test_system(const struct GNUNET_TESTING_Command *cmd, struct GNUNET_TESTBED_System **ret)
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
void GNUNET_ARM_disconnect(struct GNUNET_ARM_Handle *h)
Disconnect from the ARM service and destroy the handle.
Definition: arm_api.c:603
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create(const struct GNUNET_OS_ProjectData *pd)
Create a new configuration object.
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.
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
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.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_load(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Load configuration.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_write(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Write configuration file.
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:520
#define GNUNET_log(kind,...)
GNUNET_GenericReturnValue
Named constants for return values.
@ GNUNET_OK
@ GNUNET_NO
@ GNUNET_SYSERR
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
@ GNUNET_ERROR_TYPE_ERROR
@ GNUNET_ERROR_TYPE_DEBUG
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define GNUNET_free(ptr)
Wrapper around free.
const struct GNUNET_OS_ProjectData * GNUNET_OS_project_data_gnunet(void)
Return default project data used by 'libgnunetutil' for GNUnet.
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:659
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
int GNUNET_OS_process_kill(struct GNUNET_OS_Process *proc, int sig)
Sends a signal to the process.
Definition: os_priority.c:210
enum GNUNET_GenericReturnValue GNUNET_OS_process_wait(struct GNUNET_OS_Process *proc)
Wait for a process to terminate.
Definition: os_priority.c:871
char * GNUNET_OS_get_libexec_binary_path(const struct GNUNET_OS_ProjectData *pd, const char *progname)
Given the name of a gnunet-helper, gnunet-service or gnunet-daemon binary, try to prefix it with the ...
@ GNUNET_OS_INHERIT_STD_OUT_AND_ERR
When these flags are set, the child process will inherit stdout and stderr of the parent.
#define _(String)
GNU gettext support macro.
Definition: platform.h:179
Handle for interacting with ARM.
Definition: arm_api.c:103
Handle for a system on which GNUnet peers are executed; a system is used for reserving unique paths a...
Definition: testbed.c:54
State each asynchronous command must have in its closure.
enum GNUNET_GenericReturnValue finished
Indication if the command finished (GNUNET_OK).
A command to be run by the interpreter.
struct GNUNET_TESTING_CommandLabel label
Label for the command.
void * cls
Closure for all commands with command-specific context information.
Global state of the interpreter, used by a command to access information about other commands.
Handle for a peer controlled via ARM.
struct GNUNET_TESTING_AsyncContext ac
Context for our asynchronous completion.
struct GNUNET_TRANSPORT_ApplicationHandle * ah
Application handle.
char * system_label
The label of the command which was started by calling GNUNET_TESTING_cmd_system_create.
struct GNUNET_TESTING_Interpreter * is
Our interpreter.
struct GNUNET_OS_Process * arm
Handle to the ARM process information.
struct GNUNET_ARM_Handle * ah
The handle to the peer's ARM service.
struct GNUNET_CONFIGURATION_Handle * cfg
Peer's configuration.
struct GNUNET_TESTBED_System * system
The TESTBED system associated with this peer.
char * cfgname
GNUnet configuration file used to start a peer.
A struct GNUNET_TESTING_Trait can be used to exchange data between cmds.
unsigned int index
Index number associated with the trait.
static enum GNUNET_GenericReturnValue traits(void *cls, const void **ret, const char *trait, unsigned int index)
This function prepares an array with traits.
static void conn_status(void *cls, enum GNUNET_GenericReturnValue connected)
Function called whenever we connect to or disconnect from ARM.
static void start_peer_cleanup(void *cls)
The cleanup function of this cmd frees resources the cmd allocated.
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.
struct GNUNET_TESTING_Command GNUNET_TESTING_ARM_cmd_start_peer(const char *label, const char *system_label, const char *cfgname)
Create command.
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.