gnunet_testing_lib.h File Reference

#include "gnunet_util_lib.h"

Include dependency graph for gnunet_testing_lib.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	GNUNET_TESTING_AsyncContext
	State each asynchronous command must have in its closure. More...
struct	GNUNET_TESTING_CommandLabel
	Structure with storage space for a label. More...
struct	GNUNET_TESTING_Command
	A command to be run by the interpreter. More...
struct	GNUNET_TESTING_Timer
	Performance counter. More...
struct	GNUNET_TESTING_Trait
	A struct GNUNET_TESTING_Trait can be used to exchange data between cmds. More...

Macros
#define	GNUNET_TESTING_CMD_MAX_LABEL_LENGTH   127
	Central interpreter and command loop for writing an interpreter to test asynchronous systems. More...
#define	GNUNET_TESTING_FAIL(is)
	Print failing line number and trigger shutdown. More...
#define	GNUNET_TESTING_command_incomplete(is, label)
	Log an error message about a command not having run to completion. More...
#define	GNUNET_TESTING_command_new(cls, label, run, cleanup, traits)    GNUNET_TESTING_command_new_ac (cls,label,run,cleanup,traits,NULL)
	Create a new command. More...
#define	GNUNET_TESTING_NETJAIL_START_SCRIPT   "netjail_start_new.sh"
#define	GNUNET_TESTING_NETJAIL_STOP_SCRIPT   "netjail_stop.sh"
#define	GNUNET_TESTING_MAKE_PLUGIN(prefix, name, ...)
#define	GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT(prefix, name, type)
	Create headers for a trait with name name for statically allocated data of type type. More...
#define	GNUNET_TESTING_MAKE_IMPL_SIMPLE_TRAIT(prefix, name, type)
	Create C implementation for a trait with name name for statically allocated data of type type. More...
#define	GNUNET_TESTING_MAKE_DECL_INDEXED_TRAIT(prefix, name, type)
	Create headers for a trait with name name for statically allocated data of type type. More...
#define	GNUNET_TESTING_MAKE_IMPL_INDEXED_TRAIT(prefix, name, type)
	Create C implementation for a trait with name name for statically allocated data of type type. More...
#define	GNUNET_TESTING_SIMPLE_TRAITS(op, prefix)
	Call op on all simple traits needed by testing core logic. More...

Typedefs
typedef void(*	GNUNET_TESTING_CommandRunRoutine) (void *cls, struct GNUNET_TESTING_Interpreter *is)
	Signature of a function used to start executing a command of a test. More...
typedef void(*	GNUNET_TESTING_CommandCleanupRoutine) (void *cls)
	Signature of a function used to clean up resources allocated by a command. More...
typedef enum GNUNET_GenericReturnValue(*	GNUNET_TESTING_CommandGetTraits) (void *cls, const void **ret, const char *trait, unsigned int index)
	Signature of a function used to extract traits exposed by a command. More...
typedef void(*	GNUNET_TESTING_CommandIterator) (void *cls, const struct GNUNET_TESTING_Command *cmd)
	Callback over commands of an interpreter. More...
typedef void(*	GNUNET_TESTING_ResultCallback) (void *cls, enum GNUNET_GenericReturnValue rv)
	Function called with the final result of the test. More...

Functions
void	GNUNET_TESTING_async_fail (struct GNUNET_TESTING_AsyncContext *ac)
	The asynchronous command of ac has failed. More...
void	GNUNET_TESTING_async_finish (struct GNUNET_TESTING_AsyncContext *ac)
	The asynchronous command of ac has finished. More...
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. More...
void	GNUNET_TESTING_set_label (struct GNUNET_TESTING_CommandLabel *label, const char *value)
	Set label to value. More...
const struct GNUNET_TESTING_Command *	GNUNET_TESTING_interpreter_lookup_command (struct GNUNET_TESTING_Interpreter *is, const char *label)
	Lookup command by label. More...
const struct GNUNET_TESTING_Command *	GNUNET_TESTING_interpreter_get_command (struct GNUNET_TESTING_Interpreter *is, const char *name)
	Get command from hash map by variable name. More...
void	GNUNET_TESTING_interpreter_current_cmd_touch (struct GNUNET_TESTING_Interpreter *is)
	Update the last request time of the current command to the current time. More...
void	GNUNET_TESTING_interpreter_current_cmd_inc_tries (struct GNUNET_TESTING_Interpreter *is)
	Increment the 'num_tries' counter for the current command. More...
const char *	GNUNET_TESTING_interpreter_current_cmd_get_label (struct GNUNET_TESTING_Interpreter *is)
	Obtain label of the command being now run. More...
void	GNUNET_TESTING_interpreter_fail (struct GNUNET_TESTING_Interpreter *is)
	Current command failed, clean up and fail the test case. More...
void	GNUNET_TESTING_interpreter_skip (struct GNUNET_TESTING_Interpreter *is)
	Skips the current test, the environment is not prepared correctly. More...
void	GNUNET_TESTING_interpreter_commands_iterate (struct GNUNET_TESTING_Interpreter *is, bool asc, GNUNET_TESTING_CommandIterator cb, void *cb_cls)
	Iterates over all of the top-level commands of an interpreter. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_end (void)
	Create command array terminator. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_batch (const char *label, struct GNUNET_TESTING_Command *batch)
	Create a "batch" command. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_stat (const char *label, struct GNUNET_TESTING_Timer *timers)
	Obtain performance data from the interpreter. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_set_var (const char *name, struct GNUNET_TESTING_Command cmd)
	Set variable to command as side-effect of running a command. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_barrier_create (const char *label, unsigned int number_to_be_reached)
	Command to create a barrier. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_barrier_reached (const char *label, const char *barrier_label)
	If this command is executed the the process is signaling the master process that it reached a barrier. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_netjail_start_helpers (const char *label, const char *topology_cmd_label, struct GNUNET_TIME_Relative timeout)
	Create command. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_netjail_setup (const char *label, const char *script, const char *topology_cmd_label)
	This command executes a shell script to setup the netjail environment. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_load_topology_from_file (const char *label, const char *filename)
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_load_topology_from_string (const char *label, const char *topology_data)
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_make_unblocking (struct GNUNET_TESTING_Command cmd)
	Turn asynchronous command into non-blocking command by setting asynchronous_finish to true. More...
const struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_finish (const char *finish_label, const char *cmd_ref, struct GNUNET_TIME_Relative timeout)
	Create (synchronous) command that waits for another command to finish. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_signal (const char *label, const char *process_label, int signal)
	Create a "signal" CMD. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_sleep (const char *label, struct GNUNET_TIME_Relative duration)
	Sleep for duration. More...
const struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_exec (const char *label, enum GNUNET_OS_ProcessStatusType expected_type, unsigned long int expected_exit_code, char *const script_argv[])
	Command to execute a command. More...
const struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_exec_va (const char *label, enum GNUNET_OS_ProcessStatusType expected_type, unsigned long int expected_exit_code,...)
	Command to execute a command. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_rewind_ip (const char *label, const char *target_label, unsigned int counter)
	Make the instruction pointer point to target_label only if counter is greater than zero. More...
struct GNUNET_TESTING_Interpreter *	GNUNET_TESTING_run (const struct GNUNET_TESTING_Command *commands, struct GNUNET_TIME_Relative timeout, GNUNET_TESTING_ResultCallback rc, void *rc_cls)
	Run the testsuite. More...
int	GNUNET_TESTING_main (const struct GNUNET_TESTING_Command *commands, struct GNUNET_TIME_Relative timeout)
	Start a GNUnet scheduler event loop and run the testsuite. More...
struct GNUNET_TESTING_PluginFunctions *	GNUNET_TESTING_make_plugin (const struct GNUNET_TESTING_Command *commands)
struct GNUNET_TESTING_Trait	GNUNET_TESTING_trait_end (void)
	"end" of traits array. More...
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. More...
enum GNUNET_GenericReturnValue	GNUNET_TESTING_get_trait_process (const struct GNUNET_TESTING_Command *cmd, struct GNUNET_OS_Process ***ret)
struct GNUNET_TESTING_Trait	GNUNET_TESTING_make_trait_process (struct GNUNET_OS_Process **value)
enum GNUNET_GenericReturnValue	GNUNET_TESTING_get_trait_cmd (const struct GNUNET_TESTING_Command *cmd, const struct GNUNET_TESTING_Command **ret)
struct GNUNET_TESTING_Trait	GNUNET_TESTING_make_trait_cmd (const struct GNUNET_TESTING_Command *value)
enum GNUNET_GenericReturnValue	GNUNET_TESTING_get_trait_batch_cmds (const struct GNUNET_TESTING_Command *cmd, struct GNUNET_TESTING_Command ***ret)
struct GNUNET_TESTING_Trait	GNUNET_TESTING_make_trait_batch_cmds (struct GNUNET_TESTING_Command **value)

Macro Definition Documentation

GNUNET_TESTING_CMD_MAX_LABEL_LENGTH

#define GNUNET_TESTING_CMD_MAX_LABEL_LENGTH   127

Central interpreter and command loop for writing an interpreter to test asynchronous systems.

Author

Christian Grothoff chris.nosp@m.tian.nosp@m.@grot.nosp@m.hoff.nosp@m..org

Marcello Stanisci

t3sserakt Maximum length of label in command

Definition at line 35 of file gnunet_testing_lib.h.

GNUNET_TESTING_FAIL

#define GNUNET_TESTING_FAIL

(

is

)

Value:

        do {                                    \
          GNUNET_break (0);                     \
          GNUNET_TESTING_interpreter_fail (is); \
          return;                               \
        } while (0)

Print failing line number and trigger shutdown.

Useful quite any time after the command "run" method has been called. Returns from the current function.

Definition at line 44 of file gnunet_testing_lib.h.

GNUNET_TESTING_command_incomplete

#define GNUNET_TESTING_command_incomplete	(		is,
			label
	)

Value:

        do {                                                              \
          GNUNET_log (GNUNET_ERROR_TYPE_ERROR,                            \
                      "Command %s (%s:%u) did not complete (at %s)\n",    \
                      label,                                              \
                      __FILE__,                                           \
                      __LINE__,                                           \
                      GNUNET_TESTING_interpreter_current_cmd_get_label (is)); \
        } while (0)

Log an error message about a command not having run to completion.

Parameters

is	interpreter
label	command label of the incomplete command

Definition at line 58 of file gnunet_testing_lib.h.

GNUNET_TESTING_command_new

#define GNUNET_TESTING_command_new	(		cls,
			label,
			run,
			cleanup,
			traits
	)		GNUNET_TESTING_command_new_ac (cls,label,run,cleanup,traits,NULL)

Create a new command.

Parameters

cls	the closure
label	the Label. Maximum length is GNUNET_TESTING_CMD_MAX_LABEL_LENGTH
run	the run routing
cleanup	the cleanup function
traits	the traits function (optional)

Returns

the command the function cannot fail

Definition at line 209 of file gnunet_testing_lib.h.

GNUNET_TESTING_NETJAIL_START_SCRIPT

#define GNUNET_TESTING_NETJAIL_START_SCRIPT   "netjail_start_new.sh"

Definition at line 568 of file gnunet_testing_lib.h.

GNUNET_TESTING_NETJAIL_STOP_SCRIPT

#define GNUNET_TESTING_NETJAIL_STOP_SCRIPT   "netjail_stop.sh"

Definition at line 570 of file gnunet_testing_lib.h.

GNUNET_TESTING_MAKE_PLUGIN

#define GNUNET_TESTING_MAKE_PLUGIN	(		prefix,
			name,
			...
	)

Value:

        void *                                                 \
        prefix ## _plugin_ ## name ## _init (void *cls) { \
          const char *my_node_id = cls; (void) my_node_id;     \
          struct GNUNET_TESTING_Command commands[] = {         \
            __VA_ARGS__,                                       \
            GNUNET_TESTING_cmd_end ()                          \
          };                                                   \
          return GNUNET_TESTING_make_plugin (commands);        \
        }                                                      \
        void *                                                 \
        prefix ## _plugin_ ## name ## _done (void *cls) {      \
          struct GNUNET_TESTING_PluginFunctions *api = cls;    \
          GNUNET_free (api);                                   \
          return NULL;                                         \
        }

Definition at line 784 of file gnunet_testing_lib.h.

GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT

#define GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT	(		prefix,
			name,
			type
	)

Value:

        enum GNUNET_GenericReturnValue                           \
        prefix ## _get_trait_ ## name (                          \
          const struct GNUNET_TESTING_Command *cmd,              \
          type * *ret);                                          \
        struct GNUNET_TESTING_Trait                              \
        prefix ## _make_trait_ ## name (                         \
          type * value);

Create headers for a trait with name name for statically allocated data of type type.

Parameters

prefix	symbol prefix to use
name	name of the trait
type	data type for the trait

Definition at line 868 of file gnunet_testing_lib.h.

GNUNET_TESTING_MAKE_IMPL_SIMPLE_TRAIT

#define GNUNET_TESTING_MAKE_IMPL_SIMPLE_TRAIT	(		prefix,
			name,
			type
	)

Value:

        enum GNUNET_GenericReturnValue                          \
        prefix ## _get_trait_ ## name (                         \
          const struct GNUNET_TESTING_Command *cmd,             \
          type * *ret)                                          \
        {                                                       \
          if (NULL == cmd->traits) return GNUNET_SYSERR;        \
          return cmd->traits (cmd->cls,                         \
                              (const void **) ret,              \
                              GNUNET_S (name),                  \
                              0);                               \
        }                                                       \
        struct GNUNET_TESTING_Trait                             \
        prefix ## _make_trait_ ## name (                        \
          type * value)                                         \
        {                                                       \
          struct GNUNET_TESTING_Trait ret = {                   \
            .trait_name = GNUNET_S (name),                      \
            .ptr = (const void *) value                         \
          };                                                    \
          return ret;                                           \
        }

Create C implementation for a trait with name name for statically allocated data of type type.

Parameters

prefix	symbol prefix to use
name	name of the trait
type	data type for the trait

Definition at line 886 of file gnunet_testing_lib.h.

GNUNET_TESTING_MAKE_DECL_INDEXED_TRAIT

#define GNUNET_TESTING_MAKE_DECL_INDEXED_TRAIT	(		prefix,
			name,
			type
	)

Value:

        enum GNUNET_GenericReturnValue                           \
        prefix ## _get_trait_ ## name (                          \
          const struct GNUNET_TESTING_Command *cmd,              \
          unsigned int index,                                    \
          type * *ret);                                          \
        struct GNUNET_TESTING_Trait                              \
        prefix ## _make_trait_ ## name (                         \
          unsigned int index,                                    \
          type * value);

Create headers for a trait with name name for statically allocated data of type type.

Parameters

prefix	symbol prefix to use
name	name of the trait
type	data type for the trait

Definition at line 918 of file gnunet_testing_lib.h.

GNUNET_TESTING_MAKE_IMPL_INDEXED_TRAIT

#define GNUNET_TESTING_MAKE_IMPL_INDEXED_TRAIT	(		prefix,
			name,
			type
	)

Value:

        enum GNUNET_GenericReturnValue                          \
        prefix ## _get_trait_ ## name (                         \
          const struct GNUNET_TESTING_Command *cmd,             \
          unsigned int index,                                   \
          type * *ret)                                          \
        {                                                       \
          if (NULL == cmd->traits) return GNUNET_SYSERR;        \
          return cmd->traits (cmd->cls,                         \
                              (const void **) ret,              \
                              GNUNET_S (name),                  \
                              index);                           \
        }                                                       \
        struct GNUNET_TESTING_Trait                             \
        prefix ## _make_trait_ ## name (                        \
          unsigned int index,                                   \
          type * value)                                         \
        {                                                       \
          struct GNUNET_TESTING_Trait ret = {                   \
            .index = index,                                     \
            .trait_name = GNUNET_S (name),                      \
            .ptr = (const void *) value                         \
          };                                                    \
          return ret;                                           \
        }

Create C implementation for a trait with name name for statically allocated data of type type.

Definition at line 934 of file gnunet_testing_lib.h.

GNUNET_TESTING_SIMPLE_TRAITS

#define GNUNET_TESTING_SIMPLE_TRAITS	(		op,
			prefix
	)

Value:

        op (prefix, process, struct GNUNET_OS_Process *)         \
        op (prefix, cmd, const struct GNUNET_TESTING_Command)    \
        op (prefix, batch_cmds, struct GNUNET_TESTING_Command *)

Call op on all simple traits needed by testing core logic.

Parameters

op	operation to perform
prefix	prefix to pass to op

Definition at line 967 of file gnunet_testing_lib.h.

Typedef Documentation

GNUNET_TESTING_CommandRunRoutine

typedef void(* GNUNET_TESTING_CommandRunRoutine) (void *cls, struct GNUNET_TESTING_Interpreter *is)

Signature of a function used to start executing a command of a test.

Runs the command. Note that upon return, the interpreter will not automatically run the next command if this is an asynchronous command unless the command was wrapped in GNUNET_TESTING_cmd_make_unblocking(), as the command may then continue asynchronously in other scheduler tasks. In this case, GNUNET_TESTING_async_finish() must be called to run the next task.

Parameters

cls	closure
is	interpreter running the command

Definition at line 145 of file gnunet_testing_lib.h.

GNUNET_TESTING_CommandCleanupRoutine

typedef void(* GNUNET_TESTING_CommandCleanupRoutine) (void *cls)

Signature of a function used to clean up resources allocated by a command.

Parameters

cls

closure

Definition at line 157 of file gnunet_testing_lib.h.

GNUNET_TESTING_CommandGetTraits

typedef enum GNUNET_GenericReturnValue(* GNUNET_TESTING_CommandGetTraits) (void *cls, const void **ret, const char *trait, unsigned int index)

Signature of a function used to extract traits exposed by a command.

Parameters

	cls	closure
[out]	ret	where to return the trait data
	trait	name of the trait to return
	index	index of the trait (for traits that are indexed)

Returns

GNUNET_OK on success

Definition at line 157 of file gnunet_testing_lib.h.

GNUNET_TESTING_CommandIterator

typedef void(* GNUNET_TESTING_CommandIterator) (void *cls, const struct GNUNET_TESTING_Command *cmd)

Callback over commands of an interpreter.

Parameters

cls	closure
cmd	a command to process

Definition at line 430 of file gnunet_testing_lib.h.

GNUNET_TESTING_ResultCallback

typedef void(* GNUNET_TESTING_ResultCallback) (void *cls, enum GNUNET_GenericReturnValue rv)

Function called with the final result of the test.

Parameters

cls	closure
rv	GNUNET_OK if the test passed

Definition at line 732 of file gnunet_testing_lib.h.

Function Documentation

GNUNET_TESTING_async_fail()

void GNUNET_TESTING_async_fail

(

struct GNUNET_TESTING_AsyncContext *

ac

)

The asynchronous command of ac has failed.

Parameters

ac	command-specific context

Definition at line 519 of file testing_api_loop.c.

{
  GNUNET_assert (GNUNET_NO == ac->finished);
  ac->finished = GNUNET_SYSERR;
  GNUNET_TESTING_interpreter_fail (ac->is);
}

References GNUNET_TESTING_Command::ac, GNUNET_TESTING_AsyncContext::finished, GNUNET_assert, GNUNET_NO, GNUNET_SYSERR, GNUNET_TESTING_interpreter_fail(), and GNUNET_TESTING_AsyncContext::is.

Referenced by barrier_reached_run(), child_completed_callback(), conn_status(), exp_cb(), handle_helper_barrier_reached(), handle_helper_local_finished(), helper_mst(), stop_cb(), and timeout_finish().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_async_finish()

void GNUNET_TESTING_async_finish

(

struct GNUNET_TESTING_AsyncContext *

ac

)

The asynchronous command of ac has finished.

Parameters

ac	command-specific context

Definition at line 528 of file testing_api_loop.c.

{
  GNUNET_assert (GNUNET_NO == ac->finished);
  ac->finished = GNUNET_OK;
  if (NULL != ac->notify_finished)
  {
    ac->notify_finished (ac->notify_finished_cls);
    ac->notify_finished = NULL;
  }
  if (! ac->next_called)
  {
    ac->next_called = true;
    GNUNET_TESTING_interpreter_next_ (ac->is);
  }
}

References GNUNET_TESTING_Command::ac, GNUNET_TESTING_AsyncContext::finished, GNUNET_assert, GNUNET_NO, GNUNET_OK, GNUNET_TESTING_interpreter_next_(), GNUNET_TESTING_AsyncContext::is, GNUNET_TESTING_AsyncContext::next_called, GNUNET_TESTING_AsyncContext::notify_finished, and GNUNET_TESTING_AsyncContext::notify_finished_cls.

Referenced by backchannel_check_run(), barrier_reached_run(), child_completed_callback(), conn_status(), do_timeout(), done_finish(), handle_helper_barrier_crossable(), handle_helper_barrier_reached(), handle_helper_local_finished(), hello_iter_cb(), notify_connect(), read_from_log(), run_finish(), send_run(), send_simple_single(), and stop_cb().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Parameters

cls	the closure
label	the Label. Maximum length is GNUNET_TESTING_CMD_MAX_LABEL_LENGTH
run	the run routing
cleanup	the cleanup function
traits	the traits function (optional)
ac	the async context, NULL if command is always synchronous

Returns

the command the function cannot fail

Definition at line 34 of file testing_api_cmds.c.

{
  struct GNUNET_TESTING_Command cmd = {
    .cls = cls,
    .run = run,
    .ac = ac,
    .cleanup = cleanup,
    .traits = traits
  };
 
  GNUNET_assert (NULL != run);
  if (NULL != label)
    GNUNET_TESTING_set_label (&cmd.label,
                              label);
  return cmd;
}

References GNUNET_TESTING_Command::ac, cleanup(), GNUNET_TESTING_Command::cls, GNUNET_assert, GNUNET_TESTING_set_label(), GNUNET_TESTING_Command::label, run(), and traits().

Referenced by GNUNET_CORE_cmd_connect_peers(), GNUNET_TESTING_ARM_cmd_start_peer(), GNUNET_TESTING_cmd_barrier_reached(), GNUNET_TESTING_cmd_exec(), GNUNET_TESTING_cmd_exec_va(), GNUNET_TESTING_cmd_finish(), GNUNET_TESTING_cmd_load_topology_from_file(), GNUNET_TESTING_cmd_load_topology_from_string(), GNUNET_TESTING_cmd_netjail_setup(), GNUNET_TESTING_cmd_netjail_start_helpers(), GNUNET_TESTING_cmd_stop_peer(), GNUNET_TRANSPORT_cmd_backchannel_check(), GNUNET_TRANSPORT_cmd_connect_peers(), GNUNET_TRANSPORT_cmd_send_simple_performance(), and GNUNET_TRANSPORT_cmd_start_peer().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_set_label()

void GNUNET_TESTING_set_label	(	struct GNUNET_TESTING_CommandLabel *	label,
		const char *	value
	)

Set label to value.

Asserts that value is not longer than GNUNET_TESTING_CMD_MAX_LABEL_LENGTH.

Parameters

[out]	label	label to initialize
	value	value to store into label

Definition at line 59 of file testing_api_cmds.c.

{
  size_t len;
 
  len = strlen (value);
  GNUNET_assert (len <=
                 GNUNET_TESTING_CMD_MAX_LABEL_LENGTH);
  memcpy (label->value,
          value,
          len + 1);
}

References GNUNET_assert, GNUNET_TESTING_CMD_MAX_LABEL_LENGTH, GNUNET_TESTING_Command::label, value, and GNUNET_TESTING_CommandLabel::value.

Referenced by GNUNET_TESTING_cmd_batch(), GNUNET_TESTING_command_new_ac(), and GNUNET_TESTING_DHTU_cmd_send().

Here is the caller graph for this function:

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.

Parameters

is	interpreter to lookup command in
label	label of the command to lookup.

Returns

the command, if it is found, or NULL.

Definition at line 147 of file testing_api_loop.c.

{
  if (NULL == label)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                "Attempt to lookup command for empty label\n");
    return NULL;
  }
  for (int i = is->ip; i >= 0; i--)
  {
    const struct GNUNET_TESTING_Command *cmd = &is->commands[i];
 
    /* Give precedence to top-level commands.  */
    if ( (NULL != cmd->run) &&
         (0 == strcmp (cmd->label.value,
                       label)) )
      return cmd;
 
    if (GNUNET_TESTING_cmd_is_batch_ (cmd))
    {
      struct GNUNET_TESTING_Command **batch;
      const struct GNUNET_TESTING_Command *current;
      const struct GNUNET_TESTING_Command *icmd;
      const struct GNUNET_TESTING_Command *match;
 
      GNUNET_assert (GNUNET_OK ==
                     GNUNET_TESTING_get_trait_cmd (cmd,
                                                   &current));
      GNUNET_assert (GNUNET_OK ==
                     GNUNET_TESTING_get_trait_batch_cmds (cmd,
                                                          &batch));
      /* We must do the loop forward, but we can find the last match */
      match = NULL;
      for (unsigned int j = 0;
           NULL != (icmd = &(*batch)[j])->run;
           j++)
      {
        if (current == icmd)
          break; /* do not go past current command */
        if ( (NULL != icmd->run) &&
             (0 == strcmp (icmd->label.value,
                           label)) )
          match = icmd;
      }
      if (NULL != match)
        return match;
    }
  }
  GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
              "Command `%s' not found\n",
              label);
  return NULL;
}

References GNUNET_TESTING_Interpreter::commands, GNUNET_assert, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_log, GNUNET_OK, GNUNET_TESTING_cmd_is_batch_(), GNUNET_TESTING_get_trait_batch_cmds(), GNUNET_TESTING_get_trait_cmd(), GNUNET_TESTING_Interpreter::ip, is, GNUNET_TESTING_Command::label, run(), GNUNET_TESTING_Command::run, and GNUNET_TESTING_CommandLabel::value.

Referenced by backchannel_check_run(), connect_peers_run(), join_room_run(), netjail_exec_run(), netjail_start_run(), rewind_ip_run(), run_finish(), send_simple_run(), signal_run(), start_peer_run(), start_service_run(), stop_peer_run(), and stop_service_run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_interpreter_get_command()

const struct GNUNET_TESTING_Command * GNUNET_TESTING_interpreter_get_command	(	struct GNUNET_TESTING_Interpreter *	is,
		const char *	name
	)

Get command from hash map by variable name.

Parameters

is	interpreter state.
name	name of the variable to get command by

Returns

the command, if it is found, or NULL.

Definition at line 205 of file testing_api_loop.c.

{
  const struct GNUNET_TESTING_Command *cmd;
  struct GNUNET_HashCode h_name;
 
  GNUNET_CRYPTO_hash (name,
                      strlen (name),
                      &h_name);
  cmd = GNUNET_CONTAINER_multihashmap_get (is->vars,
                                           &h_name);
  if (NULL == cmd)
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Command not found by variable name: %s\n",
                name);
  return cmd;
}

References GNUNET_CONTAINER_multihashmap_get(), GNUNET_CRYPTO_hash(), GNUNET_ERROR_TYPE_ERROR, GNUNET_log, is, name, and GNUNET_TESTING_Interpreter::vars.

Here is the call graph for this function:

GNUNET_TESTING_interpreter_current_cmd_touch()

void GNUNET_TESTING_interpreter_current_cmd_touch

(

struct GNUNET_TESTING_Interpreter *

is

)

Update the last request time of the current command to the current time.

Parameters

[in,out]

is

interpreter state where to show that we are doing something

Definition at line 810 of file testing_api_loop.c.

{
  is->commands[is->ip].last_req_time
    = GNUNET_TIME_absolute_get ();
}

References GNUNET_TESTING_Interpreter::commands, GNUNET_TIME_absolute_get(), GNUNET_TESTING_Interpreter::ip, is, and GNUNET_TESTING_Command::last_req_time.

Here is the call graph for this function:

GNUNET_TESTING_interpreter_current_cmd_inc_tries()

void GNUNET_TESTING_interpreter_current_cmd_inc_tries

(

struct GNUNET_TESTING_Interpreter *

is

)

Increment the 'num_tries' counter for the current command.

Parameters

[in,out]

is

interpreter state where to increment the counter

Definition at line 819 of file testing_api_loop.c.

{
  is->commands[is->ip].num_tries++;
}

References GNUNET_TESTING_Interpreter::commands, GNUNET_TESTING_Interpreter::ip, is, and GNUNET_TESTING_Command::num_tries.

GNUNET_TESTING_interpreter_current_cmd_get_label()

const char * GNUNET_TESTING_interpreter_current_cmd_get_label

(

struct GNUNET_TESTING_Interpreter *

is

)

Obtain label of the command being now run.

Parameters

is	interpreter state.

Returns

the label.

Definition at line 827 of file testing_api_loop.c.

{
  return is->commands[is->ip].label.value;
}

References GNUNET_TESTING_Interpreter::commands, GNUNET_TESTING_Interpreter::ip, is, GNUNET_TESTING_Command::label, and GNUNET_TESTING_CommandLabel::value.

GNUNET_TESTING_interpreter_fail()

void GNUNET_TESTING_interpreter_fail

(

struct GNUNET_TESTING_Interpreter *

is

)

Current command failed, clean up and fail the test case.

Parameters

is	interpreter state.

Definition at line 465 of file testing_api_loop.c.

{
  struct GNUNET_TESTING_Command *cmd
    = &is->commands[is->ip];
 
  if (GNUNET_SYSERR == is->result)
  {
    GNUNET_break (0);
    return; /* ignore, we already failed! */
  }
  if (NULL == cmd)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Failed with CMD being NULL!\n");
  }
  else
  {
    const struct GNUNET_TESTING_Command *pos = cmd;
 
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Failed during command `%s'\n",
                cmd->label.value);
    while (GNUNET_TESTING_cmd_is_batch_ (pos))
    {
      GNUNET_assert (GNUNET_OK ==
                     GNUNET_TESTING_get_trait_cmd (pos,
                                                   &pos));
      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                  "Failed in batch during command `%s'\n",
                  pos->label.value);
    }
  }
  if (NULL != is->timeout_task)
  {
    GNUNET_SCHEDULER_cancel (is->timeout_task);
    is->timeout_task = NULL;
  }
  is->result = GNUNET_SYSERR;
  GNUNET_assert (NULL == is->final_task);
  is->final_task = GNUNET_SCHEDULER_add_now (&finish_test,
                                             is);
}

References GNUNET_TESTING_Interpreter::commands, GNUNET_TESTING_Interpreter::final_task, finish_test(), GNUNET_assert, GNUNET_break, GNUNET_ERROR_TYPE_ERROR, GNUNET_log, GNUNET_OK, GNUNET_SCHEDULER_add_now(), GNUNET_SCHEDULER_cancel(), GNUNET_SYSERR, GNUNET_TESTING_cmd_is_batch_(), GNUNET_TESTING_get_trait_cmd(), GNUNET_TESTING_Interpreter::ip, is, GNUNET_TESTING_Command::label, GNUNET_TESTING_Interpreter::result, GNUNET_TESTING_Interpreter::timeout_task, and GNUNET_TESTING_CommandLabel::value.

Referenced by connect_peers_run(), do_shutdown(), GNUNET_TESTING_async_fail(), GNUNET_TESTING_interpreter_skip(), join_room_run(), on_message_cb(), rewind_ip_run(), seek_batch(), start_peer_run(), and start_service_run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_interpreter_skip()

void GNUNET_TESTING_interpreter_skip

(

struct GNUNET_TESTING_Interpreter *

is

)

Skips the current test, the environment is not prepared correctly.

Parameters

is	interpreter state.

Definition at line 510 of file testing_api_loop.c.

{
  is->skip = true;
  GNUNET_TESTING_interpreter_fail (is);
}

References GNUNET_TESTING_interpreter_fail(), is, and GNUNET_TESTING_Interpreter::skip.

Referenced by netjail_start_run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_interpreter_commands_iterate()

void GNUNET_TESTING_interpreter_commands_iterate	(	struct GNUNET_TESTING_Interpreter *	is,
		bool	asc,
		GNUNET_TESTING_CommandIterator	cb,
		void *	cb_cls
	)

Iterates over all of the top-level commands of an interpreter.

Parameters

[in]	is	interpreter to iterate over
	asc	true in execution order, false for reverse execution order
	cb	function to call on each command
	cb_cls	closure for cb

Definition at line 776 of file testing_api_loop.c.

{
  unsigned int start;
  unsigned int end;
  int inc;
 
  if (asc)
  {
    inc = 1;
    start = 0;
    end = is->ip;
  }
  else
  {
    inc = -1;
    start = is->ip;
    end = 0;
  }
  for (unsigned int off = start; off != end + inc; off += inc)
  {
    const struct GNUNET_TESTING_Command *cmd
      = &is->commands[off];
 
    cb (cb_cls,
        cmd);
  }
}

References GNUNET_TESTING_Interpreter::commands, end, GNUNET_TESTING_Interpreter::ip, is, and start.

Referenced by stat_run().

Here is the caller graph for this function:

GNUNET_TESTING_cmd_end()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_end

(

void

)

Create command array terminator.

Returns

a end-command.

Definition at line 85 of file testing_api_cmds.c.

{
  struct GNUNET_TESTING_Command cmd = {
    .run = NULL
  };
 
  return cmd;
}

References GNUNET_TESTING_Command::run.

Referenced by main().

Here is the caller graph for this function:

GNUNET_TESTING_cmd_batch()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_batch	(	const char *	label,
		struct GNUNET_TESTING_Command *	batch
	)

Create a "batch" command.

Such command takes a end_CMD-terminated array of CMDs and executed them. Once it hits the end CMD, it passes the control to the next top-level CMD, regardless of it being another batch or ordinary CMD.

Parameters

label	the command label.
batch	array of CMDs to execute.

Returns

the command.

Definition at line 150 of file testing_api_cmd_batch.c.

{
  struct BatchState *bs;
  unsigned int i;
 
  bs = GNUNET_new (struct BatchState);
  GNUNET_TESTING_set_label (&bs->label,
                            label);
  /* Get number of commands.  */
  for (i = 0; NULL != batch[i].run; i++)
    /* noop */
    ;
 
  bs->batch = GNUNET_new_array (i + 1,
                                struct GNUNET_TESTING_Command);
  memcpy (bs->batch,
          batch,
          sizeof (struct GNUNET_TESTING_Command) * i);
  return GNUNET_TESTING_command_new (bs,
                                     label,
                                     &batch_run,
                                     &batch_cleanup,
                                     &batch_traits);
}

References BatchState::batch, batch_cleanup(), batch_run(), batch_traits(), GNUNET_new, GNUNET_new_array, GNUNET_TESTING_command_new, GNUNET_TESTING_set_label(), BatchState::label, and GNUNET_TESTING_Command::run.

Here is the call graph for this function:

GNUNET_TESTING_cmd_stat()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_stat	(	const char *	label,
		struct GNUNET_TESTING_Timer *	timers
	)

Obtain performance data from the interpreter.

Parameters

	label	command label.
[in,out]	timers	NULL-prefix terminated array that specifies what commands (by label) to obtain runtimes for

Returns

the command

Definition at line 150 of file testing_api_cmd_stat.c.

{
  return GNUNET_TESTING_command_new ((void *) timers,
                                     label,
                                     &stat_run,
                                     NULL,
                                     NULL);
}

References GNUNET_TESTING_command_new, and stat_run().

Here is the call graph for this function:

GNUNET_TESTING_cmd_set_var()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_set_var	(	const char *	name,
		struct GNUNET_TESTING_Command	cmd
	)

Set variable to command as side-effect of running a command.

Parameters

name	name of the variable to set
cmd	command to set to variable when run

Returns

modified command

Definition at line 75 of file testing_api_cmds.c.

{
  cmd.name = name;
  return cmd;
}

References GNUNET_TESTING_Command::name.

Referenced by start_testcase().

Here is the caller graph for this function:

GNUNET_TESTING_cmd_barrier_create()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_barrier_create	(	const char *	label,
		unsigned int	number_to_be_reached
	)

Command to create a barrier.

Parameters

label	The label of this command.
number_to_be_reached	If this number of processes reached this barrier, all processes waiting at this barrier can pass it.

Definition at line 91 of file testing_api_cmd_barrier_create.c.

{
  struct GNUNET_TESTING_Barrier *barrier;
 
  barrier = GNUNET_new (struct GNUNET_TESTING_Barrier);
  GNUNET_TESTING_barrier_name_hash_ (label,
                                     &barrier->barrier_id);
  barrier->expected_reaches = number_to_be_reached;
  return GNUNET_TESTING_command_new (barrier,
                                     label,
                                     &barrier_run,
                                     &barrier_cleanup,
                                     &barrier_traits);
}

References barrier_cleanup(), GNUNET_TESTING_Barrier::barrier_id, barrier_run(), barrier_traits(), GNUNET_TESTING_Barrier::expected_reaches, GNUNET_new, GNUNET_TESTING_barrier_name_hash_(), and GNUNET_TESTING_command_new.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_cmd_barrier_reached()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_barrier_reached	(	const char *	label,
		const char *	barrier_label
	)

If this command is executed the the process is signaling the master process that it reached a barrier.

If this command is synchronous it will block.

Parameters

label	name for command.
barrier_label	The name of the barrier we waited for and which was reached.

Returns

command.

Definition at line 173 of file testing_api_cmd_barrier_reached.c.

{
  struct BarrierReachedState *brs;
 
  brs = GNUNET_new (struct BarrierReachedState);
  brs->label = label;
  brs->barrier_name = barrier_label;
  return GNUNET_TESTING_command_new_ac (
    brs,
    label,
    &barrier_reached_run,
    &barrier_reached_cleanup,
    &barrier_reached_traits,
    &brs->ac);
}

References BarrierReachedState::ac, BarrierReachedState::barrier_name, barrier_reached_cleanup(), barrier_reached_run(), barrier_reached_traits(), GNUNET_new, GNUNET_TESTING_command_new_ac(), and BarrierReachedState::label.

Here is the call graph for this function:

GNUNET_TESTING_cmd_netjail_start_helpers()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_netjail_start_helpers	(	const char *	label,
		const char *	topology_cmd_label,
		struct GNUNET_TIME_Relative	timeout
	)

Create command.

Parameters

label	Name for the command.
topology_data	topology data
timeout	Before this timeout is reached this cmd MUST finish.

Returns

command.

Definition at line 580 of file testing_api_cmd_netjail_start_cmds_helper.c.

{
  struct NetJailState *ns;
 
  ns = GNUNET_new (struct NetJailState);
  ns->topology_cmd_label = topology_cmd_label;
  ns->timeout = timeout;
  return GNUNET_TESTING_command_new_ac (ns,
                                        label,
                                        &netjail_exec_run,
                                        &netjail_exec_cleanup,
                                        &netjail_exec_traits,
                                        &ns->ac);
}

References GNUNET_new, GNUNET_TESTING_command_new_ac(), netjail_exec_cleanup(), netjail_exec_run(), netjail_exec_traits(), ns, timeout, and NetJailState::topology_cmd_label.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_cmd_netjail_setup()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_netjail_setup	(	const char *	label,
		const char *	script,
		const char *	topology_cmd_label
	)

This command executes a shell script to setup the netjail environment.

Parameters

label	name for command.
script	which script to run, e.g. GNUNET_TESTING_NETJAIL_START_SCRIPT
topology_config	Configuration file for the test topology.
read_file	Flag indicating if the the name of the topology file is send to the helper, or a string with the topology data.

Returns

command.

Definition at line 205 of file testing_api_cmd_netjail_start.c.

{
  struct NetJailState *ns;
 
  ns = GNUNET_new (struct NetJailState);
  ns->script = script;
  ns->topology_cmd_label = topology_cmd_label;
  return GNUNET_TESTING_command_new_ac (
    ns,
    label,
    &netjail_start_run,
    &netjail_start_cleanup,
    NULL,
    &ns->ac);
}

References GNUNET_new, GNUNET_TESTING_command_new_ac(), netjail_start_cleanup(), netjail_start_run(), ns, NetJailState::script, and NetJailState::topology_cmd_label.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_cmd_load_topology_from_file()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_load_topology_from_file	(	const char *	label,
		const char *	filename
	)

Definition at line 177 of file testing_api_cmd_get_topo.c.

{
  struct TopologyState *ts;
 
  ts = GNUNET_new (struct TopologyState);
  ts->label = label;
  ts->file_name = file_name;
  return GNUNET_TESTING_command_new_ac (
    ts,
    label,
    &run,
    &cleanup,
    traits,
    NULL);
}

References cleanup(), file_name, TopologyState::file_name, GNUNET_new, GNUNET_TESTING_command_new_ac(), TopologyState::label, run(), and traits().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_cmd_load_topology_from_string()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_load_topology_from_string	(	const char *	label,
		const char *	topology_data
	)

Definition at line 197 of file testing_api_cmd_get_topo.c.

{
  struct TopologyState *ts;
 
  GNUNET_assert (NULL != topology_string);
  ts = GNUNET_new (struct TopologyState);
  ts->label = label;
  ts->topology_string = topology_string;
  return GNUNET_TESTING_command_new_ac (
    ts,
    label,
    &run,
    &cleanup,
    traits,
    NULL);
}

References cleanup(), GNUNET_assert, GNUNET_new, GNUNET_TESTING_command_new_ac(), TopologyState::label, run(), TopologyState::topology_string, topology_string, and traits().

Referenced by main(), and start_testcase().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_cmd_make_unblocking()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_make_unblocking

(

struct GNUNET_TESTING_Command

cmd

)

Turn asynchronous command into non-blocking command by setting asynchronous_finish to true.

Modifies (and then returns) cmd simply setting the bit. By default, most commands are blocking, and by wrapping the command construction in this function a blocking command can be turned into an asynchronous command where the interpreter continues after initiating the asynchronous action. Does nothing if the command is fundamentally synchronous.

Parameters

[in,out]

cmd

command to make non-blocking

Returns

a finish-command.

Definition at line 209 of file testing_api_cmd_finish.c.

{
  /* do not permit this function to be used on
     a finish command! */
  GNUNET_assert (cmd.run != &run_finish);
  cmd.asynchronous_finish = true;
  return cmd;
}

References GNUNET_assert, and run_finish().

Here is the call graph for this function:

GNUNET_TESTING_cmd_finish()

const struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_finish	(	const char *	finish_label,
		const char *	cmd_ref,
		struct GNUNET_TIME_Relative	timeout
	)

Create (synchronous) command that waits for another command to finish.

If cmd_ref did not finish after timeout, this command will fail the test case.

Parameters

finish_label	label for this command
cmd_ref	reference to a previous command which we should wait for (call finish() on)
timeout	how long to wait at most for cmd_ref to finish

Returns

a finish-command.

Definition at line 188 of file testing_api_cmd_finish.c.

{
  struct FinishState *finish_state;
 
  finish_state = GNUNET_new (struct FinishState);
  finish_state->async_label = cmd_ref;
  finish_state->timeout = timeout;
  return GNUNET_TESTING_command_new_ac (
    finish_state,
    finish_label,
    &run_finish,
    &cleanup_finish,
    NULL,
    &finish_state->ac);
}

References FinishState::ac, FinishState::async_label, cleanup_finish(), GNUNET_new, GNUNET_TESTING_command_new_ac(), run_finish(), timeout, and FinishState::timeout.

Here is the call graph for this function:

GNUNET_TESTING_cmd_signal()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_signal	(	const char *	label,
		const char *	process_label,
		int	signal
	)

Create a "signal" CMD.

Parameters

label	command label.
process_label	label of a command that has a process trait
signal	signal to send to process.

Returns

the command.

Parameters

label	command label.
process	handle to the process to signal.
signal	signal to send.

Returns

the command.

Definition at line 105 of file testing_api_cmd_signal.c.

{
  struct SignalState *ss;
 
  ss = GNUNET_new (struct SignalState);
  ss->process_label = process_label;
  ss->signal = signal;
  return GNUNET_TESTING_command_new (ss,
                                     label,
                                     &signal_run,
                                     &signal_cleanup,
                                     NULL);
}

References GNUNET_new, GNUNET_TESTING_command_new, SignalState::process_label, SignalState::signal, signal_cleanup(), and signal_run().

Here is the call graph for this function:

GNUNET_TESTING_cmd_sleep()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_sleep	(	const char *	label,
		struct GNUNET_TIME_Relative	duration
	)

Sleep for duration.

Parameters

label	command label.
duration	time to sleep

Returns

the command.

GNUNET_TESTING_cmd_exec()

const struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_exec	(	const char *	label,
		enum GNUNET_OS_ProcessStatusType	expected_type,
		unsigned long int	expected_exit_code,
		char *const	script_argv[]
	)

Command to execute a command.

Parameters

label

Label of the command.

Definition at line 187 of file testing_api_cmd_exec.c.

{
  struct BashScriptState *bss;
  unsigned int cnt;
 
  cnt = 0;
  while (NULL != script_argv[cnt])
    cnt++;
  bss = GNUNET_new (struct BashScriptState);
  bss->args = GNUNET_new_array (cnt + 1,
                                char *);
  for (unsigned int i = 0; i<cnt; i++)
    bss->args[i] = GNUNET_strdup (script_argv[i]);
  bss->expected_type = expected_type;
  bss->expected_exit_code = expected_exit_code;
  return GNUNET_TESTING_command_new_ac (
    bss,
    label,
    &exec_bash_script_run,
    &exec_bash_script_cleanup,
    &traits,
    &bss->ac);
}

References BashScriptState::ac, BashScriptState::args, exec_bash_script_cleanup(), exec_bash_script_run(), BashScriptState::expected_exit_code, BashScriptState::expected_type, GNUNET_new, GNUNET_new_array, GNUNET_strdup, GNUNET_TESTING_command_new_ac(), and traits().

Here is the call graph for this function:

GNUNET_TESTING_cmd_exec_va()

const struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_exec_va	(	const char *	label,
		enum GNUNET_OS_ProcessStatusType	expected_type,
		unsigned long int	expected_exit_code,
			...
	)

Command to execute a command.

Parameters

label

Label of the command.

Definition at line 217 of file testing_api_cmd_exec.c.

{
  struct BashScriptState *bss;
  va_list ap;
  const char *arg;
  unsigned int cnt;
 
  bss = GNUNET_new (struct BashScriptState);
  va_start (ap,
            expected_exit_code);
  cnt = 1;
  while (NULL != (arg = va_arg (ap,
                                const char *)))
    cnt++;
  va_end (ap);
  bss->args = GNUNET_new_array (cnt,
                                char *);
  cnt = 0;
  va_start (ap,
            expected_exit_code);
  while (NULL != (arg = va_arg (ap,
                                const char *)))
    bss->args[cnt++] = GNUNET_strdup (arg);
  va_end (ap);
  bss->expected_type = expected_type;
  bss->expected_exit_code = expected_exit_code;
  return GNUNET_TESTING_command_new_ac (
    bss,
    label,
    &exec_bash_script_run,
    &exec_bash_script_cleanup,
    &traits,
    &bss->ac);
}

References BashScriptState::ac, find_typedefs::arg, BashScriptState::args, exec_bash_script_cleanup(), exec_bash_script_run(), BashScriptState::expected_exit_code, BashScriptState::expected_type, GNUNET_new, GNUNET_new_array, GNUNET_strdup, GNUNET_TESTING_command_new_ac(), and traits().

Here is the call graph for this function:

GNUNET_TESTING_cmd_rewind_ip()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_rewind_ip	(	const char *	label,
		const char *	target_label,
		unsigned int	counter
	)

Make the instruction pointer point to target_label only if counter is greater than zero.

Note that the command that will be executed next in this case is the one AFTER target_label, as the command we jump to is skipped by the advancing IP after the rewind.

Parameters

label	command label
target_label	label of the new instruction pointer's destination after the jump; must be before the current instruction (and the command at the target_label itself will not be run, but the one afterwards)
counter	counts how many times the rewinding is to happen.

Definition at line 1007 of file testing_api_loop.c.

{
  struct RewindIpState *ris;
 
  ris = GNUNET_new (struct RewindIpState);
  ris->target_label = target_label;
  ris->counter = counter;
  return GNUNET_TESTING_command_new (ris,
                                     label,
                                     &rewind_ip_run,
                                     &rewind_ip_free,
                                     NULL);
}

References RewindIpState::counter, GNUNET_new, GNUNET_TESTING_command_new, rewind_ip_free(), rewind_ip_run(), and RewindIpState::target_label.

Here is the call graph for this function:

GNUNET_TESTING_run()

struct GNUNET_TESTING_Interpreter * GNUNET_TESTING_run	(	const struct GNUNET_TESTING_Command *	commands,
		struct GNUNET_TIME_Relative	timeout,
		GNUNET_TESTING_ResultCallback	rc,
		void *	rc_cls
	)

Run the testsuite.

Note, CMDs are copied into the interpreter state because they are usually defined into the "run" method that returns after having scheduled the test interpreter.

Parameters

commands	the array of command to execute
timeout	how long to wait for each command to execute
rc	function to call with the final result
rc_cls	closure for rc

Returns

The interpreter.

Definition at line 604 of file testing_api_loop.c.

{
  struct GNUNET_TESTING_Interpreter *is;
 
  is = GNUNET_new (struct GNUNET_TESTING_Interpreter);
  is->timeout_task
    = GNUNET_SCHEDULER_add_delayed (timeout,
                                    &do_timeout,
                                    is);
  is->rc = rc;
  is->rc_cls = rc_cls;
  setup_is (is,
            NULL,
            commands);
  return is;
}

References commands, do_timeout(), GNUNET_new, GNUNET_SCHEDULER_add_delayed(), is, GNUNET_TESTING_Interpreter::rc, GNUNET_TESTING_Interpreter::rc_cls, setup_is(), timeout, and GNUNET_TESTING_Interpreter::timeout_task.

Referenced by loop_run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_main()

int GNUNET_TESTING_main	(	const struct GNUNET_TESTING_Command *	commands,
		struct GNUNET_TIME_Relative	timeout
	)

Start a GNUnet scheduler event loop and run the testsuite.

Return 0 upon success. Expected to be called directly from main().

Parameters

commands	the list of command to execute
timeout	how long to wait for each command to execute

Returns

EXIT_SUCCESS on success, EXIT_FAILURE on failure

Definition at line 127 of file testing_api_main.c.

{
  struct MainParams mp = {
    .commands = commands,
    .timeout = timeout,
    .rv = EXIT_SUCCESS
  };
 
  GNUNET_SCHEDULER_run (&loop_run,
                        &mp);
  return mp.rv;
}

References commands, MainParams::commands, GNUNET_SCHEDULER_run(), loop_run(), MainParams::rv, and timeout.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_make_plugin()

struct GNUNET_TESTING_PluginFunctions * GNUNET_TESTING_make_plugin

(

const struct GNUNET_TESTING_Command *

commands

)

Definition at line 679 of file testing_api_loop.c.

{
  struct GNUNET_TESTING_PluginFunctions *api;
  struct GNUNET_TESTING_Command *commands_copy;
  unsigned int i;
 
  for (i = 0; NULL != commands[i].run; i++)
    ;
  commands_copy = GNUNET_malloc_large ( (i + 1)
                                       * sizeof (struct
                                                 GNUNET_TESTING_Command));
  memcpy (commands_copy,
          commands,
          sizeof (struct GNUNET_TESTING_Command) * i + 1);
 
  api = GNUNET_new (struct GNUNET_TESTING_PluginFunctions);
  api->cls = (void *) commands_copy;
  api->start_testcase = &start_testcase;
  return api;
}

References GNUNET_TESTING_PluginFunctions::cls, commands, GNUNET_malloc_large, GNUNET_new, start_testcase(), and GNUNET_TESTING_PluginFunctions::start_testcase.

Here is the call graph for this function:

GNUNET_TESTING_trait_end()

struct GNUNET_TESTING_Trait GNUNET_TESTING_trait_end

(

void

)

"end" of traits array.

Because traits are offered into arrays, this type of trait is used to mark the end of such arrays; useful when iterating over those.

Referenced by barrier_reached_traits(), barrier_traits(), batch_traits(), connect_peers_traits(), netjail_exec_traits(), start_peer_traits(), start_service_traits(), stop_peer_traits(), system_create_traits(), and traits().

Here is the caller graph for this function:

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.

Parameters

	traits	the array of all the traits.
[out]	ret	where to store the result.
	trait	type of the trait to extract.
	index	index number of the trait to extract.

Returns

GNUNET_OK when the trait is found.

Obtain value of a trait from a command.

Parameters

traits	the traits array.
ret	where to store the result.
trait	type of the trait to extract.
index	index number of the object to extract.

Returns

GNUNET_OK if no error occurred, GNUNET_SYSERR otherwise.

Definition at line 62 of file testing_api_traits.c.

{
  for (unsigned int i = 0; NULL != traits[i].trait_name; i++)
  {
    if ( (0 == strcmp (trait, traits[i].trait_name)) &&
         (index == traits[i].index) )
    {
      *ret = (void *) traits[i].ptr;
      return GNUNET_OK;
    }
  }
  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              "Trait %s/%u not found.\n",
              trait, index);
 
  return GNUNET_SYSERR;
}

References GNUNET_ERROR_TYPE_INFO, GNUNET_log, GNUNET_OK, GNUNET_SYSERR, GNUNET_TESTING_Trait::index, GNUNET_TESTING_Trait::ptr, ret, GNUNET_TESTING_Trait::trait_name, and traits().

Referenced by barrier_reached_traits(), barrier_traits(), batch_traits(), connect_peers_traits(), netjail_exec_traits(), start_peer_traits(), start_service_traits(), stop_peer_traits(), system_create_traits(), and traits().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_get_trait_process()

enum GNUNET_GenericReturnValue GNUNET_TESTING_get_trait_process	(	const struct GNUNET_TESTING_Command *	cmd,
		struct GNUNET_OS_Process ***	ret
	)

Referenced by signal_run().

Here is the caller graph for this function:

GNUNET_TESTING_make_trait_process()

struct GNUNET_TESTING_Trait GNUNET_TESTING_make_trait_process

(

struct GNUNET_OS_Process **

value

)

Referenced by start_peer_traits(), and traits().

Here is the caller graph for this function:

GNUNET_TESTING_get_trait_cmd()

enum GNUNET_GenericReturnValue GNUNET_TESTING_get_trait_cmd	(	const struct GNUNET_TESTING_Command *	cmd,
		const struct GNUNET_TESTING_Command **	ret
	)

Referenced by GNUNET_TESTING_interpreter_fail(), GNUNET_TESTING_interpreter_lookup_command(), and seek_batch().

Here is the caller graph for this function:

GNUNET_TESTING_make_trait_cmd()

struct GNUNET_TESTING_Trait GNUNET_TESTING_make_trait_cmd

(

const struct GNUNET_TESTING_Command *

value

)

Referenced by batch_traits().

Here is the caller graph for this function:

GNUNET_TESTING_get_trait_batch_cmds()

enum GNUNET_GenericReturnValue GNUNET_TESTING_get_trait_batch_cmds	(	const struct GNUNET_TESTING_Command *	cmd,
		struct GNUNET_TESTING_Command ***	ret
	)

Referenced by do_stat(), GNUNET_TESTING_interpreter_lookup_command(), and seek_batch().

Here is the caller graph for this function:

GNUNET_TESTING_make_trait_batch_cmds()

struct GNUNET_TESTING_Trait GNUNET_TESTING_make_trait_batch_cmds

(

struct GNUNET_TESTING_Command **

value

)

Referenced by batch_traits().

Here is the caller graph for this function: