cadet_test_lib.h File Reference

library for writing CADET tests More...

#include "gnunet_testbed_service.h"
#include "gnunet_cadet_service.h"

Include dependency graph for cadet_test_lib.h:

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

Go to the source code of this file.

Typedefs
typedef void(*	GNUNET_CADET_TEST_AppMain) (void *cls, struct GNUNET_CADET_TEST_Context *ctx, unsigned int num_peers, struct GNUNET_TESTBED_Peer **peers, struct GNUNET_CADET_Handle **cadets)
	Main function of a CADET test. More...

Functions
void	GNUNET_CADET_TEST_ruN (const char *testname, const char *cfgfile, unsigned int num_peers, GNUNET_CADET_TEST_AppMain tmain, void *tmain_cls, GNUNET_CADET_ConnectEventHandler connects, GNUNET_CADET_WindowSizeEventHandler window_changes, GNUNET_CADET_DisconnectEventHandler disconnects, struct GNUNET_MQ_MessageHandler *handlers, const struct GNUNET_HashCode **ports)
	Run a test using the given name, configuration file and number of peers. More...
void	GNUNET_CADET_TEST_cleanup (struct GNUNET_CADET_TEST_Context *ctx)
	Clean up the testbed. More...

Detailed Description

library for writing CADET tests

Author

Bartlomiej Polot

Definition in file cadet_test_lib.h.

Typedef Documentation

GNUNET_CADET_TEST_AppMain

typedef void(* GNUNET_CADET_TEST_AppMain) (void *cls, struct GNUNET_CADET_TEST_Context *ctx, unsigned int num_peers, struct GNUNET_TESTBED_Peer **peers, struct GNUNET_CADET_Handle **cadets)

Main function of a CADET test.

Parameters

cls	Closure.
ctx	Argument to give to GNUNET_CADET_TEST_cleanup on test end.
num_peers	Number of peers that are running.
peers	Array of peers.
cadets	Handle to each of the CADETs of the peers.

Definition at line 54 of file cadet_test_lib.h.

Function Documentation

GNUNET_CADET_TEST_ruN()

void GNUNET_CADET_TEST_ruN	(	const char *	testname,
		const char *	cfgfile,
		unsigned int	num_peers,
		GNUNET_CADET_TEST_AppMain	tmain,
		void *	tmain_cls,
		GNUNET_CADET_ConnectEventHandler	connects,
		GNUNET_CADET_WindowSizeEventHandler	window_changes,
		GNUNET_CADET_DisconnectEventHandler	disconnects,
		struct GNUNET_MQ_MessageHandler *	handlers,
		const struct GNUNET_HashCode **	ports
	)

Run a test using the given name, configuration file and number of peers.

All cadet callbacks will receive the peer number (long) as the closure.

Parameters

testname	Name of the test (for logging).
cfgfile	Name of the configuration file.
num_peers	Number of peers to start.
tmain	Main function to run once the testbed is ready.
tmain_cls	Closure for tmain.
connects	Handler for incoming channels.
window_changes	Handler for the window size change notification.
disconnects	Cleaner for destroyed incoming channels.
handlers	Message handlers.
ports	Ports the peers offer, NULL-terminated.

Definition at line 338 of file cadet_test_lib.c.

{
  struct GNUNET_CADET_TEST_Context *ctx;
 
  ctx = GNUNET_new (struct GNUNET_CADET_TEST_Context);
  ctx->num_peers = num_peers;
  ctx->ops = GNUNET_new_array (num_peers,
                               struct GNUNET_TESTBED_Operation *);
  ctx->cadets = GNUNET_new_array (num_peers,
                                  struct GNUNET_CADET_Handle *);
  ctx->app_main = tmain;
  ctx->app_main_cls = tmain_cls;
  ctx->connects = connects;
  ctx->window_changes = window_changes;
  ctx->disconnects = disconnects;
  ctx->handlers = GNUNET_MQ_copy_handlers (handlers);
  ctx->ports = ports;
  ctx->port_count = 0;
  while (NULL != ctx->ports[ctx->port_count])
    ctx->port_count++;
  GNUNET_TESTBED_test_run (testname,
                           cfgfile,
                           num_peers,
                           0LL, NULL, NULL,
                           &cadet_test_run,
                           ctx);
}

References cadet_test_run(), connects(), ctx, disconnects(), GNUNET_MQ_copy_handlers(), GNUNET_new, GNUNET_new_array, GNUNET_TESTBED_test_run(), handlers, num_peers, GNUNET_CADET_TEST_Context::ports, tmain(), and GNUNET_CADET_TEST_Context::window_changes.

Here is the call graph for this function:

GNUNET_CADET_TEST_cleanup()

void GNUNET_CADET_TEST_cleanup

(

struct GNUNET_CADET_TEST_Context *

ctx

)

Clean up the testbed.

Parameters

ctx	handle for the testbed

Definition at line 238 of file cadet_test_lib.c.

{
  for (unsigned int i = 0; i < ctx->num_peers; i++)
  {
    GNUNET_assert (NULL != ctx->ops[i]);
    GNUNET_TESTBED_operation_done (ctx->ops[i]);
    ctx->ops[i] = NULL;
  }
  GNUNET_free (ctx->ops);
  GNUNET_free (ctx->cadets);
  GNUNET_free (ctx->handlers);
  GNUNET_free (ctx);
  GNUNET_SCHEDULER_shutdown ();
}

References ctx, GNUNET_assert, GNUNET_free, GNUNET_SCHEDULER_shutdown(), and GNUNET_TESTBED_operation_done().

Referenced by disconnect_cadet_peers(), start_test(), and warmup().

Here is the call graph for this function:

Here is the caller graph for this function: