testing_api_cmd_exec_bash_script.c File Reference

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_testing_ng_lib.h"

Include dependency graph for testing_api_cmd_exec_bash_script.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...
const struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_exec_bash_script (const char *label, const char *script, char *const script_argv[], int argc, GNUNET_ChildCompletedCallback cb)
	Command to execute a script synchronously. More...

Macro Definition Documentation

LOG

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

Definition at line 30 of file testing_api_cmd_exec_bash_script.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 75 of file testing_api_cmd_exec_bash_script.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;
  }
  GNUNET_free (bss);
}

References 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_bash_script().

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 106 of file testing_api_cmd_exec_bash_script.c.

{
  struct BashScriptState *bss = cls;
 
  GNUNET_OS_process_destroy (bss->start_proc);
  bss->start_proc = NULL;
  bss->cwh = NULL;
  if (0 == exit_code)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Child succeeded!\n");
    GNUNET_TESTING_async_finish (&bss->ac);
  }
  else
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Child failed with error %lu!\n",
                exit_code);
    GNUNET_TESTING_async_fail (&bss->ac);
  }
  bss->cb (cls, type, exit_code);
}

References BashScriptState::ac, BashScriptState::cb, BashScriptState::cwh, exit_code, 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 137 of file testing_api_cmd_exec_bash_script.c.

{
  struct BashScriptState *bss = cls;
  enum GNUNET_GenericReturnValue helper_check;
  char *argv[bss->argc + 2];
 
  char *data_dir;
  char *script_name;
 
  data_dir = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_DATADIR);
  GNUNET_asprintf (&script_name, "%s%s", data_dir, bss->script);
 
  helper_check = GNUNET_OS_check_helper_binary (
    script_name,
    GNUNET_YES,
    NULL);
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "script_name %s\n",
       script_name);
 
  if (GNUNET_NO == helper_check)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "No SUID for %s!\n",
                script_name);
    GNUNET_TESTING_interpreter_fail (is);
    return;
  }
  if (GNUNET_SYSERR == helper_check)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "%s not found!\n",
                script_name);
    GNUNET_TESTING_interpreter_fail (is);
    return;
  }
  argv[0] = script_name;
  if (NULL != bss->script_argv)
  {
    for (int i = 0; i < bss->argc;i++)
      argv[i + 1] = bss->script_argv[i];
  }
  argv[bss->argc] = NULL;
 
  bss->start_proc = GNUNET_OS_start_process_vap (GNUNET_OS_INHERIT_STD_ERR,
                                     NULL,
                                     NULL,
                                     NULL,
                                     script_name,
                                     argv);
  bss->cwh = GNUNET_wait_child (bss->start_proc,
                               &child_completed_callback,
                               bss);
  GNUNET_break (NULL != bss->cwh);
}

References BashScriptState::argc, child_completed_callback(), BashScriptState::cwh, GNUNET_asprintf(), GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_log, GNUNET_NO, GNUNET_OS_check_helper_binary(), GNUNET_OS_INHERIT_STD_ERR, GNUNET_OS_installation_get_path(), GNUNET_OS_IPK_DATADIR, GNUNET_OS_start_process_vap(), GNUNET_SYSERR, GNUNET_TESTING_interpreter_fail(), GNUNET_wait_child(), GNUNET_YES, is, LOG, BashScriptState::script, BashScriptState::script_argv, and BashScriptState::start_proc.

Referenced by GNUNET_TESTING_cmd_exec_bash_script().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_cmd_exec_bash_script()

const struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_exec_bash_script	(	const char *	label,
		const char *	script,
		char *const	script_argv[],
		int	argc,
		GNUNET_ChildCompletedCallback	cb
	)

Command to execute a script synchronously.

FIXME: is this accurate? How is this limited to BASH scripts or even scripts?

Parameters

label	Label of the command.
script	The name of the script.
script_argv	The arguments of the script.

Definition at line 196 of file testing_api_cmd_exec_bash_script.c.

{
  struct BashScriptState *bss;
 
  bss = GNUNET_new (struct BashScriptState);
  bss->script = script;
  bss->script_argv = script_argv; // FIXME this is not just a cast to fix
  bss->argc = argc;
  bss->cb = cb;
 
  return GNUNET_TESTING_command_new (bss,
                                     label,
                                     &exec_bash_script_run,
                                     &exec_bash_script_cleanup,
                                     NULL,
                                     &bss->ac);
}

References BashScriptState::ac, BashScriptState::argc, BashScriptState::cb, exec_bash_script_cleanup(), exec_bash_script_run(), GNUNET_new, GNUNET_TESTING_command_new(), BashScriptState::script, and BashScriptState::script_argv.

Here is the call graph for this function: