gnunet_testing_ng_lib.h File Reference

#include "gnunet_util_lib.h"
#include "gnunet_testing_lib.h"

Include dependency graph for gnunet_testing_ng_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_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_S(a)   #a
	API for writing an interpreter to test GNUnet components. More...
#define	GNUNET_TESTING_CMD_MAX_LABEL_LENGTH   127
	Maximum length of label in command. More...
#define	GNUNET_TESTING_FAIL(is)
	Print failing line number and trigger shutdown. More...
#define	GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT(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(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(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(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)
	Call op on all simple traits. More...
#define	GNUNET_TESTING_INDEXED_TRAITS(op)
	Call op on all indexed traits. More...

Typedefs
typedef void(*	GNUNET_TESTING_CommandRunRoutine) (void *cls, struct GNUNET_TESTING_Interpreter *is)
typedef void(*	GNUNET_TESTING_CommandCleanupRoutine) (void *cls)
typedef enum GNUNET_GenericReturnValue(*	GNUNET_TESTING_CommandGetTraits) (void *cls, const void **ret, const char *trait, unsigned int index)
typedef void(*	GNUNET_TESTING_ResultCallback) (void *cls, enum GNUNET_GenericReturnValue rv)
	Function called with the final result of the test. More...

Functions
struct GNUNET_TESTING_Command	GNUNET_TESTING_command_new (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. More...
const struct GNUNET_TESTING_Command *	GNUNET_TESTING_interpreter_lookup_future_command (struct GNUNET_TESTING_Interpreter *is, const char *label)
	Lookup command by label. 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_lookup_command_all (struct GNUNET_TESTING_Interpreter *is, const char *label)
	Lookup command by label. More...
const char *	GNUNET_TESTING_interpreter_get_current_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_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_cmd_end (void)
	Create command array terminator. More...
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_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 (struct GNUNET_TESTING_Command *commands, struct GNUNET_TIME_Relative timeout)
	Start a GNUnet scheduler event loop and run the testsuite. More...
enum GNUNET_GenericReturnValue	GNUNET_TESTING_running (const struct GNUNET_TESTING_Command *command)
	Check if the command is running. More...
enum GNUNET_GenericReturnValue	GNUNET_TESTING_finished (const struct GNUNET_TESTING_Command *command)
	Check if a command is finished. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_signal (const char *label, const char *process_label, unsigned int process_index, 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...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_batch (const char *label, struct GNUNET_TESTING_Command *batch)
	Create a "batch" command. More...
struct GNUNET_PeerIdentity *	GNUNET_TESTING_get_peer (unsigned int num, const struct GNUNET_TESTING_System *tl_system)
	Retrieve peer identity from the test system with the unique node id. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_stat (struct GNUNET_TESTING_Timer *timers)
	Obtain performance data from the interpreter. More...
struct GNUNET_TESTING_Trait	GNUNET_TESTING_trait_end (void)
	"end" trait. More...
enum GNUNET_GenericReturnValue	GNUNET_TESTING_get_trait (const struct GNUNET_TESTING_Trait *traits, const void **ret, const char *trait, unsigned int index)
	Extract a trait. More...
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)
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)

Macro Definition Documentation

GNUNET_S

#define GNUNET_S

(

a

)

#a

API for writing an interpreter to test GNUnet components.

Author

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

Marcello Stanisci

t3sserakt Stringify operator.

Parameters

a	some expression to stringify. Must NOT be a macro.

Returns

same expression as a constant string.

Definition at line 40 of file gnunet_testing_ng_lib.h.

GNUNET_TESTING_CMD_MAX_LABEL_LENGTH

#define GNUNET_TESTING_CMD_MAX_LABEL_LENGTH   127

Maximum length of label in command.

Definition at line 45 of file gnunet_testing_ng_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.

Definition at line 53 of file gnunet_testing_ng_lib.h.

GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT

#define GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT	(		name,
			type
	)

Value:

  enum GNUNET_GenericReturnValue                          \
  GNUNET_TESTING_get_trait_ ## name (                    \
    const struct GNUNET_TESTING_Command *cmd,              \
    type **ret);                                          \
  struct GNUNET_TESTING_Trait                              \
  GNUNET_TESTING_make_trait_ ## name (                   \
    type * value);

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

Definition at line 610 of file gnunet_testing_ng_lib.h.

GNUNET_TESTING_MAKE_IMPL_SIMPLE_TRAIT

#define GNUNET_TESTING_MAKE_IMPL_SIMPLE_TRAIT	(		name,
			type
	)

Value:

  enum GNUNET_GenericReturnValue                         \
  GNUNET_TESTING_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                             \
  GNUNET_TESTING_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.

Definition at line 624 of file gnunet_testing_ng_lib.h.

GNUNET_TESTING_MAKE_DECL_INDEXED_TRAIT

#define GNUNET_TESTING_MAKE_DECL_INDEXED_TRAIT	(		name,
			type
	)

Value:

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

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

Definition at line 652 of file gnunet_testing_ng_lib.h.

GNUNET_TESTING_MAKE_IMPL_INDEXED_TRAIT

#define GNUNET_TESTING_MAKE_IMPL_INDEXED_TRAIT	(		name,
			type
	)

Value:

  enum GNUNET_GenericReturnValue                         \
  GNUNET_TESTING_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                             \
  GNUNET_TESTING_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 668 of file gnunet_testing_ng_lib.h.

GNUNET_TESTING_SIMPLE_TRAITS

#define GNUNET_TESTING_SIMPLE_TRAITS

(

op

)

Value:

  op (batch_cmds, struct GNUNET_TESTING_Command *) \
  op (process, struct GNUNET_OS_Process *)

Call op on all simple traits.

Definition at line 698 of file gnunet_testing_ng_lib.h.

GNUNET_TESTING_INDEXED_TRAITS

#define GNUNET_TESTING_INDEXED_TRAITS

(

op

)

Value:

  op (uint32, const uint32_t) \
  op (uint64, const uint64_t) \
  op (int64, const int64_t) \
  op (uint, const unsigned int) \
  op (string, const char) \
  op (cmd, const struct GNUNET_TESTING_Command) \
  op (uuid, const struct GNUNET_Uuid) \
  op (time, const struct GNUNET_TIME_Absolute) \
  op (absolute_time, const struct GNUNET_TIME_Absolute) \
  op (relative_time, const struct GNUNET_TIME_Relative)

Call op on all indexed traits.

Definition at line 706 of file gnunet_testing_ng_lib.h.

Typedef Documentation

GNUNET_TESTING_CommandRunRoutine

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

Definition at line 99 of file gnunet_testing_ng_lib.h.

GNUNET_TESTING_CommandCleanupRoutine

typedef void(* GNUNET_TESTING_CommandCleanupRoutine) (void *cls)

Definition at line 103 of file gnunet_testing_ng_lib.h.

GNUNET_TESTING_CommandGetTraits

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

Definition at line 103 of file gnunet_testing_ng_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.

FIXME: This may want to use a GNUNET_ErrorCode (namespaced, e.g. GNUNET_EC_TESTING_*)

Parameters

cls	closure
rv	GNUNET_OK if the test passed

Definition at line 382 of file gnunet_testing_ng_lib.h.

Function Documentation

GNUNET_TESTING_command_new()

struct GNUNET_TESTING_Command GNUNET_TESTING_command_new	(	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.

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)
the	async context

Returns

the command the function cannot fail

Definition at line 566 of file testing_api_loop.c.

{
  struct GNUNET_TESTING_Command cmd = {
    .cls = cls,
    .run = run,
    .ac = ac,
    .cleanup = cleanup,
    .traits = traits
  };
  memset (&cmd.label, 0, sizeof (cmd.label));
  if (NULL != label)
    strncpy (cmd.label, label, GNUNET_TESTING_CMD_MAX_LABEL_LENGTH);
 
  return cmd;
 
}

References GNUNET_TESTING_Interpreter::barriers, GNUNET_TESTING_Interpreter::cmds_n, commands, GNUNET_TESTING_Interpreter::commands, do_timeout(), GNUNET_CONTAINER_multishortmap_create(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_new, GNUNET_new_array, GNUNET_NO, GNUNET_SCHEDULER_add_delayed(), GNUNET_SCHEDULER_add_now(), interpreter_run(), is, GNUNET_TESTING_Interpreter::rc, GNUNET_TESTING_Interpreter::rc_cls, GNUNET_TESTING_Interpreter::task, timeout, and GNUNET_TESTING_Interpreter::timeout_task.

Referenced by GNUNET_TESTING_cmd_end().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_interpreter_lookup_future_command()

const struct GNUNET_TESTING_Command* GNUNET_TESTING_interpreter_lookup_future_command	(	struct GNUNET_TESTING_Interpreter *	is,
		const char *	label
	)

Lookup command by label.

Only future commands are looked up.

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 203 of file testing_api_loop.c.

{
  return get_command (is, label, GNUNET_YES);
}

References get_command(), GNUNET_YES, is, and GNUNET_TESTING_Command::label.

Here is the call 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.

Only commands from current command to commands in the past are looked up.

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 220 of file testing_api_loop.c.

{
  return get_command (is, label, GNUNET_NO);
}

References get_command(), GNUNET_NO, is, and GNUNET_TESTING_Command::label.

Referenced by backchannel_check_run(), connect_peers_run(), run_finish(), send_simple_run(), start_peer_run(), stop_peer_run(), stop_testing_system_run(), and system_destroy_run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_interpreter_lookup_command_all()

const struct GNUNET_TESTING_Command* GNUNET_TESTING_interpreter_lookup_command_all	(	struct GNUNET_TESTING_Interpreter *	is,
		const char *	label
	)

Lookup command by label.

All commands, first into the past, then into the future are looked up.

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 229 of file testing_api_loop.c.

{
  const struct GNUNET_TESTING_Command *cmd;
 
  cmd = get_command (is, label, GNUNET_NO);
  if (NULL == cmd)
    cmd = get_command (is, label, GNUNET_YES);
  return cmd;
}

References get_command(), GNUNET_NO, GNUNET_YES, is, and GNUNET_TESTING_Command::label.

Referenced by notify_connect().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_interpreter_get_current_label()

const char* GNUNET_TESTING_interpreter_get_current_label

(

struct GNUNET_TESTING_Interpreter *

is

)

Obtain label of the command being now run.

Parameters

is	interpreter state.

Returns

the label.

Definition at line 462 of file testing_api_loop.c.

{
  struct GNUNET_TESTING_Command *cmd = &is->commands[is->ip];
 
  return cmd->label;
}

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

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 412 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 at command `%s'\n",
                cmd->label);
    while (GNUNET_TESTING_cmd_is_batch_ (cmd))
    {
      cmd = GNUNET_TESTING_cmd_batch_get_current_ (cmd);
      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                  "Failed in batch at command `%s'\n",
                  cmd->label);
    }
  }
  else
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Failed with CMD being NULL!\n");
  }
  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_SCHEDULER_add_now(), GNUNET_SYSERR, GNUNET_TESTING_cmd_batch_get_current_(), GNUNET_TESTING_cmd_is_batch_(), GNUNET_TESTING_Interpreter::ip, is, GNUNET_TESTING_Command::label, and GNUNET_TESTING_Interpreter::result.

Referenced by GNUNET_TESTING_async_fail(), netjail_stop_run(), run_finish(), start_helper(), and start_peer_run().

Here is the call graph for this function:

Here is the caller graph for this function:

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 891 of file testing_api_loop.c.

{
  GNUNET_assert (GNUNET_NO == ac->finished);
  ac->finished = GNUNET_SYSERR;
  GNUNET_TESTING_interpreter_fail (ac->is);
  if (NULL != ac->cont)
  {
    ac->cont (ac->cont_cls);
    ac->cont = NULL;
  }
}

References ac, GNUNET_assert, GNUNET_NO, GNUNET_SYSERR, and GNUNET_TESTING_interpreter_fail().

Referenced by child_completed_callback(), exp_cb(), helper_mst(), 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 905 of file testing_api_loop.c.

{
  GNUNET_assert (GNUNET_NO == ac->finished);
  ac->finished = GNUNET_OK;
  if (NULL != ac->cont)
  {
    ac->cont (ac->cont_cls);
    ac->cont = NULL;
  }
}

References ac, GNUNET_assert, GNUNET_NO, and GNUNET_OK.

Referenced by backchannel_check_run(), child_completed_callback(), do_timeout(), done_finish(), hello_iter_cb(), helper_mst(), notify_connect(), read_from_log(), run_finish(), send_simple_single(), and TST_interpreter_finish_attached_cmds().

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 1 of file testing_api_cmd_end.c.

{
  return GNUNET_TESTING_command_new (NULL, NULL,
                                     NULL, NULL,
                                     NULL, NULL);
}

References GNUNET_TESTING_command_new().

Here is the call 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.

FIXME: what is this API doing? Is it returning a new cmd which is unblocking? Is it modifying cmd? Looking at the code, it both modifying cmd AND returning a copy oO

Parameters

cmd	command to make synchronous.

Returns

a finish-command.

Definition at line 157 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;
}

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 157 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 (finish_state, finish_label,
                                     &run_finish,
                                     &cleanup_finish,
                                     NULL, &finish_state->ac);
}

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.

Parameters

label	command label
target_label	label of the new instruction pointer's destination after the jump; must be before the current instruction
counter	counts how many times the rewinding is to happen.

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 566 of file testing_api_loop.c.

{
  struct GNUNET_TESTING_Interpreter *is;
  unsigned int i;
 
  is = GNUNET_new (struct GNUNET_TESTING_Interpreter);
  is->rc = rc;
  is->rc_cls = rc_cls;
  is->barriers = GNUNET_CONTAINER_multishortmap_create (1,GNUNET_NO);
  /* get the number of commands */
  for (i = 0; NULL != commands[i].run; i++)
    ;
  is->cmds_n = i + 1;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got %u commands\n", i);
  is->commands = GNUNET_new_array (is->cmds_n,
                                   struct GNUNET_TESTING_Command);
  memcpy (is->commands,
          commands,
          sizeof (struct GNUNET_TESTING_Command) * i);
  is->timeout_task
    = GNUNET_SCHEDULER_add_delayed (timeout,
                                    &do_timeout,
                                    is);
  is->task = GNUNET_SCHEDULER_add_now (&interpreter_run,
                                       is);
 
  return is;
}

Referenced by loop_run().

Here is the caller graph for this function:

GNUNET_TESTING_main()

int GNUNET_TESTING_main	(	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(). FIXME: Why is this commands array here not const?

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 875 of file testing_api_loop.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.

Here is the call graph for this function:

GNUNET_TESTING_running()

enum GNUNET_GenericReturnValue GNUNET_TESTING_running

(

const struct GNUNET_TESTING_Command *

command

)

Check if the command is running.

FIXME: Unused function.

Parameters

command

The command to check.

Returns

GNUNET_NO if the command is not running, GNUNET_YES if it is running.

Definition at line 534 of file testing_api_loop.c.

{
  return 0 != command->start_time.abs_value_us && 0 ==
         command->finish_time.abs_value_us;
}

GNUNET_TESTING_finished()

enum GNUNET_GenericReturnValue GNUNET_TESTING_finished

(

const struct GNUNET_TESTING_Command *

command

)

Check if a command is finished.

FIXME: Unused function

Parameters

command

The command to check.

Returns

GNUNET_NO if the command is not finished, GNUNET_YES if it is finished.

Definition at line 534 of file testing_api_loop.c.

{
  struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get ();
  struct GNUNET_TIME_Relative diff = GNUNET_TIME_absolute_get_difference (
    command->finish_time,
    now);
  return 0 < diff.rel_value_us;
}

GNUNET_TESTING_cmd_signal()

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

Create a "signal" CMD.

Parameters

label	command label.
process_label	label of a command that has a process trait
process_index	index of the process trait at process_label // FIXME: enum? needed?
signal	signal to send to process.

Returns

the command.

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_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 94 of file testing_api_cmd_batch.c.

{
  struct BatchState *bs;
  unsigned int i;
 
  bs = GNUNET_new (struct BatchState);
  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, NULL);
}

GNUNET_TESTING_get_peer()

struct GNUNET_PeerIdentity* GNUNET_TESTING_get_peer	(	unsigned int	num,
		const struct GNUNET_TESTING_System *	tl_system
	)

Retrieve peer identity from the test system with the unique node id.

Parameters

num	The unique node id.
tl_system	The test system.

Returns

The peer identity wrapping the public key.

Retrieve peer identity from the test system with the unique node id.

Parameters

num	The unique node id.
tl_system	The test system.

Returns

The peer identity wrapping the public key.

Definition at line 2309 of file testing.c.

{
  struct GNUNET_PeerIdentity *peer = GNUNET_new (struct GNUNET_PeerIdentity);
  struct GNUNET_CRYPTO_EddsaPrivateKey *priv_key;
 
  priv_key = GNUNET_TESTING_hostkey_get (tl_system,
                                         num,
                                         peer);
 
  GNUNET_CRYPTO_eddsa_key_get_public (priv_key,
                                      &peer->public_key);
  GNUNET_free (priv_key);
  return peer;
}

References GNUNET_CRYPTO_eddsa_key_get_public(), GNUNET_free, GNUNET_new, GNUNET_TESTING_hostkey_get(), and peer.

Referenced by add_search_string(), connect_peers_run(), and notify_connect().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_cmd_stat()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_stat

(

struct GNUNET_TESTING_Timer *

timers

)

Obtain performance data from the interpreter.

Parameters

timers

what commands (by label) to obtain runtimes for

Returns

the command

GNUNET_TESTING_trait_end()

struct GNUNET_TESTING_Trait GNUNET_TESTING_trait_end

(

void

)

"end" trait.

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

"end" trait.

Usually, commands offer several traits, and put them in arrays.

Definition at line 1 of file testing_api_traits.c.

{
  struct GNUNET_TESTING_Trait end = {
    .index = 0,
    .trait_name = NULL,
    .ptr = NULL
  };
 
  return end;
}

Referenced by block_until_external_trigger_traits(), start_peer_traits(), and system_create_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
	)

Extract a trait.

FIXME: Naming. This is something like "contains trait".

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.

Extract a trait.

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 1 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 end.

Referenced by block_until_external_trigger_traits(), start_peer_traits(), and system_create_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 get_command().

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

)

GNUNET_TESTING_get_trait_process()

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

GNUNET_TESTING_make_trait_process()

struct GNUNET_TESTING_Trait GNUNET_TESTING_make_trait_process

(

struct GNUNET_OS_Process **

value

)