testing_api_cmd_batch.c File Reference

Implement batch-execution of CMDs. More...

#include "platform.h"
#include "gnunet_testing_ng_lib.h"
#include "testing.h"

Include dependency graph for testing_api_cmd_batch.c:

Go to the source code of this file.

Data Structures
struct	BatchState
	State for a "batch" CMD. More...

Macros
#define	CURRENT_CMD_INDEX   0
#define	BATCH_INDEX   1

Functions
static void	batch_run (void *cls, struct GNUNET_TESTING_Interpreter *is)
	Run the command. More...
static void	batch_cleanup (void *cls)
	Cleanup the state from a "reserve status" CMD, and possibly cancel a pending operation thereof. More...
static enum GNUNET_GenericReturnValue	batch_traits (void *cls, const void **ret, const char *trait, unsigned int index)
	Offer internal data from a "batch" CMD, to other commands. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_batch (const char *label, struct GNUNET_TESTING_Command *batch)
	Create a "batch" command. More...
bool	GNUNET_TESTING_cmd_batch_next_ (void *cls)
	Advance internal pointer to next command. More...
bool	GNUNET_TESTING_cmd_is_batch_ (const struct GNUNET_TESTING_Command *cmd)
	Test if this command is a batch command. More...
struct GNUNET_TESTING_Command *	GNUNET_TESTING_cmd_batch_get_current_ (const struct GNUNET_TESTING_Command *cmd)
	Obtain what command the batch is at. More...
void	GNUNET_TESTING_cmd_batch_set_current_ (const struct GNUNET_TESTING_Command *cmd, unsigned int new_ip)
	Set what command the batch should be at. More...

Detailed Description

Implement batch-execution of CMDs.

Author

Marcello Stanisci (GNU Taler testing)

t3sserakt

Definition in file testing_api_cmd_batch.c.

Macro Definition Documentation

CURRENT_CMD_INDEX

#define CURRENT_CMD_INDEX   0

BATCH_INDEX

#define BATCH_INDEX   1

Function Documentation

batch_run()

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

static

Run the command.

Parameters

cls	closure.
is	the interpreter state.

Definition at line 60 of file testing_api_cmd_batch.c.

{
  struct BatchState *bs = cls;
 
  if (NULL != bs->batch[bs->batch_ip].run)
    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
                "Running batched command: %s\n",
                bs->batch[bs->batch_ip].label.value);
 
  /* hit end command, leap to next top-level command.  */
  if (NULL == bs->batch[bs->batch_ip].run)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
                "Exiting from batch: %s\n",
                bs->label.value);
    return;
  }
  bs->batch[bs->batch_ip].start_time
    = bs->batch[bs->batch_ip].last_req_time
      = GNUNET_TIME_absolute_get ();
  bs->batch[bs->batch_ip].num_tries = 1;
  bs->batch[bs->batch_ip].run (bs->batch[bs->batch_ip].cls,
                               is);
}

References BatchState::batch, BatchState::batch_ip, GNUNET_TESTING_Command::cls, GNUNET_ERROR_TYPE_INFO, GNUNET_log, GNUNET_TIME_absolute_get(), is, GNUNET_TESTING_Command::label, BatchState::label, GNUNET_TESTING_Command::last_req_time, GNUNET_TESTING_Command::num_tries, GNUNET_TESTING_Command::run, GNUNET_TESTING_Command::start_time, and GNUNET_TESTING_CommandLabel::value.

Referenced by GNUNET_TESTING_cmd_batch(), and GNUNET_TESTING_cmd_is_batch_().

Here is the call graph for this function:

Here is the caller graph for this function:

batch_cleanup()

static void batch_cleanup ( void *  cls )

static

Cleanup the state from a "reserve status" CMD, and possibly cancel a pending operation thereof.

Parameters

cls

closure.

Definition at line 94 of file testing_api_cmd_batch.c.

{
  struct BatchState *bs = cls;
 
  for (unsigned int i = 0;
       NULL != bs->batch[i].run;
       i++)
    bs->batch[i].cleanup (bs->batch[i].cls);
  GNUNET_free (bs->batch);
  GNUNET_free (bs);
}

References BatchState::batch, GNUNET_TESTING_Command::cleanup, GNUNET_TESTING_Command::cls, GNUNET_free, and GNUNET_TESTING_Command::run.

Referenced by GNUNET_TESTING_cmd_batch().

Here is the caller graph for this function:

batch_traits()

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

static

Offer internal data from a "batch" CMD, to other commands.

Parameters

	cls	closure.
[out]	ret	result.
	trait	name of the trait.
	index	index number of the object to offer.

Returns

GNUNET_OK on success.

Definition at line 117 of file testing_api_cmd_batch.c.

{
  struct BatchState *bs = cls;
  // FIXME: these constants should be more global!
#define CURRENT_CMD_INDEX 0
#define BATCH_INDEX 1
  struct GNUNET_TESTING_Trait traits[] = {
    GNUNET_TESTING_make_trait_cmd (CURRENT_CMD_INDEX,
                                   &bs->batch[bs->batch_ip]),
    GNUNET_TESTING_make_trait_cmd (BATCH_INDEX,
                                   bs->batch),
    GNUNET_TESTING_trait_end ()
  };
 
  /* Always return current command.  */
  return GNUNET_TESTING_get_trait (traits,
                                   ret,
                                   trait,
                                   index);
}

References BatchState::batch, BATCH_INDEX, BatchState::batch_ip, CURRENT_CMD_INDEX, GNUNET_TESTING_get_trait(), GNUNET_TESTING_make_trait_cmd(), GNUNET_TESTING_trait_end(), GNUNET_TESTING_Trait::index, and ret.

Referenced by GNUNET_TESTING_cmd_batch().

Here is the call graph for this function:

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 155 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, NULL);
}

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_batch_next_()

bool GNUNET_TESTING_cmd_batch_next_

(

void *

cls

)

Advance internal pointer to next command.

Parameters

cls	batch internal state

Returns

true if we could advance, false if the batch has completed and cannot advance anymore

Definition at line 183 of file testing_api_cmd_batch.c.

{
  struct BatchState *bs = cls;
 
  if (NULL == bs->batch[bs->batch_ip].run)
    return false;
  bs->batch[bs->batch_ip].finish_time
    = GNUNET_TIME_absolute_get ();
  bs->batch_ip++;
  return true;
}

References BatchState::batch, BatchState::batch_ip, GNUNET_TESTING_Command::finish_time, GNUNET_TIME_absolute_get(), and GNUNET_TESTING_Command::run.

Referenced by interpreter_next().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_cmd_is_batch_()

bool GNUNET_TESTING_cmd_is_batch_

(

const struct GNUNET_TESTING_Command *

cmd

)

Test if this command is a batch command.

Returns

false if not, true if it is a batch command

Definition at line 197 of file testing_api_cmd_batch.c.

{
  return cmd->run == &batch_run;
}

References batch_run(), and GNUNET_TESTING_Command::run.

Referenced by get_command(), GNUNET_TESTING_cmd_batch_get_current_(), GNUNET_TESTING_cmd_batch_set_current_(), GNUNET_TESTING_interpreter_fail(), and interpreter_next().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_cmd_batch_get_current_()

struct GNUNET_TESTING_Command * GNUNET_TESTING_cmd_batch_get_current_

(

const struct GNUNET_TESTING_Command *

cmd

)

Obtain what command the batch is at.

Returns

cmd current batch command

Definition at line 204 of file testing_api_cmd_batch.c.

{
  struct BatchState *bs = cmd->cls;
 
  GNUNET_assert (GNUNET_TESTING_cmd_is_batch_ (cmd));
  return &bs->batch[bs->batch_ip];
}

References BatchState::batch, BatchState::batch_ip, GNUNET_TESTING_Command::cls, GNUNET_assert, and GNUNET_TESTING_cmd_is_batch_().

Referenced by get_command(), and GNUNET_TESTING_interpreter_fail().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_cmd_batch_set_current_()

void GNUNET_TESTING_cmd_batch_set_current_	(	const struct GNUNET_TESTING_Command *	cmd,
		unsigned int	new_ip
	)

Set what command the batch should be at.

Needed for loops. We may want to change this to take a label and/or expose it in the public API in the future. Not used for now.

Parameters

cmd	current batch command
new_ip	where to move the IP

Definition at line 214 of file testing_api_cmd_batch.c.

{
  struct BatchState *bs = cmd->cls;
 
  /* sanity checks */
  GNUNET_assert (GNUNET_TESTING_cmd_is_batch_ (cmd));
  /* actual logic */
  bs->batch_ip = new_ip;
}

References BatchState::batch_ip, GNUNET_TESTING_Command::cls, GNUNET_assert, and GNUNET_TESTING_cmd_is_batch_().

Here is the call graph for this function: