testing_api_cmd_exec.c File Reference

cmd to block the interpreter loop until all peers started. More...

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

Include dependency graph for testing_api_cmd_exec.c:

Go to the source code of this file.

Data Structures
struct	BashScriptState

Macros
#define	LOG(kind, ...)   GNUNET_log (kind, __VA_ARGS__)

Functions
static void	exec_bash_script_cleanup (void *cls)
	The cleanup function of this cmd frees resources the cmd allocated. More...
static void	child_completed_callback (void *cls, enum GNUNET_OS_ProcessStatusType type, long unsigned int exit_code)
	Callback which will be called if the setup script finished. More...
static void	exec_bash_script_run (void *cls, struct GNUNET_TESTING_Interpreter *is)
	Run method of the command created by the interpreter to wait for another command to finish. More...
static enum GNUNET_GenericReturnValue	traits (void *cls, const void **ret, const char *trait, unsigned int index)
	This function prepares an array with traits. 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...

Detailed Description

cmd to block the interpreter loop until all peers started.

Author

t3sserakt

Definition in file testing_api_cmd_exec.c.

Macro Definition Documentation

LOG

#define LOG	(		kind,
			...
	)		GNUNET_log (kind, __VA_ARGS__)

Definition at line 30 of file testing_api_cmd_exec.c.

Function Documentation

exec_bash_script_cleanup()

static void exec_bash_script_cleanup ( void *  cls )

static

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

Definition at line 77 of file testing_api_cmd_exec.c.

{
  struct BashScriptState *bss = cls;
 
  if (NULL != bss->cwh)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Cancel child\n");
    GNUNET_wait_child_cancel (bss->cwh);
    bss->cwh = NULL;
  }
  if (NULL != bss->start_proc)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Kill process\n");
    GNUNET_assert (0 ==
                   GNUNET_OS_process_kill (bss->start_proc,
                                           SIGKILL));
    GNUNET_assert (GNUNET_OK ==
                   GNUNET_OS_process_wait (bss->start_proc));
    GNUNET_OS_process_destroy (bss->start_proc);
    bss->start_proc = NULL;
  }
  for (unsigned int i = 0; NULL != bss->args[i]; i++)
    GNUNET_free (bss->args[i]);
  GNUNET_free (bss->args);
  GNUNET_free (bss);
}

References BashScriptState::args, BashScriptState::cwh, GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, GNUNET_OK, GNUNET_OS_process_destroy(), GNUNET_OS_process_kill(), GNUNET_OS_process_wait(), GNUNET_wait_child_cancel(), and BashScriptState::start_proc.

Referenced by GNUNET_TESTING_cmd_exec(), and GNUNET_TESTING_cmd_exec_va().

Here is the call graph for this function:

Here is the caller graph for this function:

child_completed_callback()

static void child_completed_callback ( void *  cls, enum GNUNET_OS_ProcessStatusType  type, long unsigned int  exit_code  )

static

Callback which will be called if the setup script finished.

Definition at line 112 of file testing_api_cmd_exec.c.

{
  struct BashScriptState *bss = cls;
 
  bss->cwh = NULL;
  GNUNET_OS_process_destroy (bss->start_proc);
  bss->start_proc = NULL;
  if ( (bss->expected_type != type) ||
       (bss->expected_exit_code != exit_code) )
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Child failed with error %lu (wanted %lu) %d/%d!\n",
                exit_code,
                bss->expected_exit_code,
                type,
                bss->expected_type);
    GNUNET_TESTING_async_fail (&bss->ac);
    return;
  }
  GNUNET_TESTING_async_finish (&bss->ac);
}

References BashScriptState::ac, BashScriptState::cwh, exit_code, BashScriptState::expected_exit_code, BashScriptState::expected_type, GNUNET_ERROR_TYPE_ERROR, GNUNET_log, GNUNET_OS_process_destroy(), GNUNET_TESTING_async_fail(), GNUNET_TESTING_async_finish(), BashScriptState::start_proc, and type.

Referenced by exec_bash_script_run().

Here is the call graph for this function:

Here is the caller graph for this function:

exec_bash_script_run()

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

static

Run method of the command created by the interpreter to wait for another command to finish.

Definition at line 143 of file testing_api_cmd_exec.c.

{
  struct BashScriptState *bss = cls;
 
  GNUNET_assert (NULL == bss->cwh);
  bss->start_proc
    = GNUNET_OS_start_process_vap (
        GNUNET_OS_INHERIT_STD_ERR,
        NULL,
        NULL,
        NULL,
        bss->args[0],
        bss->args);
  bss->cwh = GNUNET_wait_child (bss->start_proc,
                                &child_completed_callback,
                                bss);
  GNUNET_break (NULL != bss->cwh);
}

References BashScriptState::args, child_completed_callback(), BashScriptState::cwh, GNUNET_assert, GNUNET_break, GNUNET_OS_INHERIT_STD_ERR, GNUNET_OS_start_process_vap(), GNUNET_wait_child(), and BashScriptState::start_proc.

Referenced by GNUNET_TESTING_cmd_exec(), and GNUNET_TESTING_cmd_exec_va().

Here is the call graph for this function:

Here is the caller graph for this function:

traits()

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

static

This function prepares an array with traits.

Definition at line 168 of file testing_api_cmd_exec.c.

{
  struct BashScriptState *bss = cls;
  struct GNUNET_TESTING_Trait traits[] = {
    GNUNET_TESTING_make_trait_process (&bss->start_proc),
    GNUNET_TESTING_trait_end ()
  };
 
  return GNUNET_TESTING_get_trait (traits,
                                   ret,
                                   trait,
                                   index);
}

References GNUNET_TESTING_get_trait(), GNUNET_TESTING_make_trait_process(), GNUNET_TESTING_trait_end(), GNUNET_TESTING_Trait::index, ret, BashScriptState::start_proc, and traits().

Referenced by barrier_reached_traits(), barrier_traits(), batch_traits(), connect_peers_traits(), GNUNET_TESTING_cmd_exec(), GNUNET_TESTING_cmd_exec_va(), GNUNET_TESTING_command_new_ac(), GNUNET_TESTING_get_trait(), 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_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: