test_mwi.c File Reference

#include "asterisk.h"
#include "asterisk/astobj2.h"
#include "asterisk/conversions.h"
#include "asterisk/module.h"
#include "asterisk/mwi.h"
#include "asterisk/stasis.h"
#include "asterisk/test.h"

Include dependency graph for test_mwi.c:

Go to the source code of this file.

Macros
#define	MAILBOX_COUNT   500
#define	MAILBOX_PREFIX   "test~" /* Hopefully sufficiently unlikely */
#define	MAILBOX_SIZE   32
#define	test_category   "/mwi/"

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
	AST_TEST_DEFINE (implicit_publish)
	AST_TEST_DEFINE (explicit_publish)
	AST_VECTOR (subscriptions, struct ast_mwi_subscriber *)
	AST_VECTOR (publishers, struct ast_mwi_publisher *)
static int	explicit_publish_cb (struct ast_mwi_state *mwi_state, void *data)
static void	handle_validate (const char *mailbox, struct ast_mwi_subscriber *sub)
static int	implicit_publish_cb (struct ast_mwi_state *mwi_state, void *data)
static int	load_module (void)
static int	mailbox_to_num (const char *mailbox, size_t *num)
static void	mwi_type_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
static int	num_to_mailbox (char *mailbox, size_t size, size_t num)
static int	publish (on_mwi_state cb, void *user_data)
static int	publishers_create (struct publishers *pubs)
static int	publishers_destroy (struct publishers *pubs)
static int	subscriptions_create (struct subscriptions *subs)
static int	subscriptions_destroy (struct subscriptions *subs)
static int	unload_module (void)
static int	validate_data (struct ast_mwi_state *mwi_state)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "MWI testing" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
static const struct ast_module_info *	ast_module_info = &__mod_info
static int	expect_zero
struct ast_mwi_observer	mwi_observer
static size_t	running_total
static size_t	sum_total

Macro Definition Documentation

MAILBOX_COUNT

#define MAILBOX_COUNT   500

Definition at line 36 of file test_mwi.c.

Referenced by publishers_create(), publishers_destroy(), and subscriptions_create().

MAILBOX_PREFIX

#define MAILBOX_PREFIX   "test~" /* Hopefully sufficiently unlikely */

Definition at line 35 of file test_mwi.c.

Referenced by explicit_publish_cb(), handle_validate(), implicit_publish_cb(), and num_to_mailbox().

MAILBOX_SIZE

#define MAILBOX_SIZE   32

Definition at line 37 of file test_mwi.c.

Referenced by publishers_create(), publishers_destroy(), and subscriptions_create().

test_category

#define test_category   "/mwi/"

Definition at line 33 of file test_mwi.c.

Referenced by AST_TEST_DEFINE().

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 407 of file test_mwi.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 407 of file test_mwi.c.

AST_MODULE_SELF_SYM()

struct ast_module* AST_MODULE_SELF_SYM

(

void

)

Definition at line 407 of file test_mwi.c.

AST_TEST_DEFINE() [1/2]

AST_TEST_DEFINE

(

implicit_publish

)

Definition at line 331 of file test_mwi.c.

References AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, cleanup(), implicit_publish_cb(), sip_to_pjsip::info(), NULL, publish(), publishers_destroy(), subscriptions_create(), subscriptions_destroy(), test_category, TEST_EXECUTE, and TEST_INIT.

{
   struct subscriptions subs;
   int rc = AST_TEST_PASS;

   switch (cmd) {
   case TEST_INIT:
      info->name = __func__;
      info->category = test_category;
      info->summary = "Test implicit publishing of MWI state";
      info->description = info->summary;
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   ast_test_validate(test, !subscriptions_create(&subs));

   ast_test_validate_cleanup(test, !publish(implicit_publish_cb, NULL),
      rc, cleanup);

cleanup:
   if (subscriptions_destroy(&subs) || publishers_destroy(NULL)) {
      return AST_TEST_FAIL;
   }

   return rc;
}

AST_TEST_DEFINE() [2/2]

AST_TEST_DEFINE

(

explicit_publish

)

Definition at line 360 of file test_mwi.c.

References AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, cleanup(), explicit_publish_cb(), sip_to_pjsip::info(), publish(), publishers, publishers_create(), publishers_destroy(), subscriptions_create(), subscriptions_destroy(), test_category, TEST_EXECUTE, and TEST_INIT.

{
   struct subscriptions subs;
   struct publishers pubs;
   int rc = AST_TEST_PASS;

   switch (cmd) {
   case TEST_INIT:
      info->name = __func__;
      info->category = test_category;
      info->summary = "Test explicit publishing of MWI state";
      info->description = info->summary;
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   ast_test_validate(test, !subscriptions_create(&subs));
   ast_test_validate_cleanup(test, !publishers_create(&pubs), rc, cleanup);

   ast_test_validate_cleanup(test, !publish(explicit_publish_cb, &pubs),
      rc, cleanup);

cleanup:
   if (subscriptions_destroy(&subs) || publishers_destroy(&pubs)) {
      return AST_TEST_FAIL;
   }

   return rc;
}

AST_VECTOR() [1/2]

AST_VECTOR	(	subscriptions	,
		struct ast_mwi_subscriber *
	)

AST_VECTOR() [2/2]

AST_VECTOR	(	publishers	,
		struct ast_mwi_publisher *
	)

explicit_publish_cb()

static int explicit_publish_cb ( struct ast_mwi_state *  mwi_state, void *  data  )

static

Definition at line 271 of file test_mwi.c.

References ast_begins_with(), ast_log, ast_mwi_publish(), AST_VECTOR_GET, CMP_STOP, LOG_ERROR, MAILBOX_PREFIX, mailbox_to_num(), NULL, publishers, ast_mwi_state::uniqueid, and validate_data().

Referenced by AST_TEST_DEFINE().

{
   struct publishers *pubs = data;
   struct ast_mwi_publisher *pub;
   size_t num;

   if (!ast_begins_with(mwi_state->uniqueid, MAILBOX_PREFIX)) {
      /* Ignore any mailboxes not prefixed */
      return 0;
   }

   num = validate_data(mwi_state);
   if (num < 0) {
      return CMP_STOP;
   }

   if (mailbox_to_num(mwi_state->uniqueid, &num)) {
      return CMP_STOP;
   }

   /* Mailbox number will always be the index */
   pub = AST_VECTOR_GET(pubs, num);

   if (!pub) {
      ast_log(LOG_ERROR, "Unable to locate MWI publisher for mailbox '%s'\n", mwi_state->uniqueid);
      return CMP_STOP;
   }

   ast_mwi_publish(pub, num, num, num, NULL, NULL);

   return 0;
}

handle_validate()

static void handle_validate ( const char *  mailbox, struct ast_mwi_subscriber *  sub  )

static

Definition at line 104 of file test_mwi.c.

References ao2_cleanup, ast_begins_with(), ast_mwi_subscriber_data(), MAILBOX_PREFIX, ast_mwi_state::uniqueid, and validate_data().

{
   struct ast_mwi_state *mwi_state = ast_mwi_subscriber_data(sub);

   if (ast_begins_with(mwi_state->uniqueid, MAILBOX_PREFIX)) {
      validate_data(mwi_state);
   }

   ao2_cleanup(mwi_state);
}

implicit_publish_cb()

static int implicit_publish_cb ( struct ast_mwi_state *  mwi_state, void *  data  )

static

Definition at line 252 of file test_mwi.c.

References ast_begins_with(), ast_mwi_publish_by_mailbox(), CMP_STOP, MAILBOX_PREFIX, NULL, ast_mwi_state::uniqueid, and validate_data().

Referenced by AST_TEST_DEFINE().

{
   size_t num;

   if (!ast_begins_with(mwi_state->uniqueid, MAILBOX_PREFIX)) {
      /* Ignore any mailboxes not prefixed */
      return 0;
   }

   num = validate_data(mwi_state);
   if (num < 0) {
      return CMP_STOP;
   }

   ast_mwi_publish_by_mailbox(mwi_state->uniqueid, NULL, num, num, num, NULL, NULL);

   return 0;
}

load_module()

static int load_module ( void  )

static

Definition at line 399 of file test_mwi.c.

References AST_MODULE_LOAD_SUCCESS, and AST_TEST_REGISTER.

{
   AST_TEST_REGISTER(implicit_publish);
   AST_TEST_REGISTER(explicit_publish);

   return AST_MODULE_LOAD_SUCCESS;
}

mailbox_to_num()

static int mailbox_to_num ( const char *  mailbox, size_t *  num  )

static

Definition at line 64 of file test_mwi.c.

References ast_log, ast_str_to_umax(), and LOG_ERROR.

Referenced by explicit_publish_cb(), and validate_data().

{
   const char *p = strchr(mailbox, '~');

   if (!p) {
      ast_log(LOG_ERROR, "Prefix separator '~' not found in '%s'\n", mailbox);
      return -1;
   }

   if (ast_str_to_umax(++p, num)) {
      ast_log(LOG_ERROR, "Unable to convert mailbox '%s' to numeric\n", mailbox);
      return -1;
   }

   return 0;
}

mwi_type_cb()

static void mwi_type_cb ( void *  data, struct stasis_subscription *  sub, struct stasis_message *  message  )

static

Definition at line 120 of file test_mwi.c.

Referenced by subscriptions_create().

{
   /* No op since we are not really testing stasis topic handling here */
}

num_to_mailbox()

static int num_to_mailbox ( char *  mailbox, size_t  size, size_t  num  )

static

Definition at line 54 of file test_mwi.c.

References ast_log, LOG_ERROR, and MAILBOX_PREFIX.

Referenced by publishers_create(), publishers_destroy(), and subscriptions_create().

{
   if (snprintf(mailbox, 10, MAILBOX_PREFIX "%zu", num) == -1) {
      ast_log(LOG_ERROR, "Unable to convert mailbox to string\n");
      return -1;
   }

   return 0;
}

publish()

static int publish ( on_mwi_state  cb, void *  user_data  )

static

Definition at line 304 of file test_mwi.c.

References ast_log, ast_mwi_state_callback_all(), expect_zero, LOG_ERROR, running_total, and sum_total.

Referenced by AST_TEST_DEFINE().

{
   /* First time there is no state data */
   expect_zero = 1;

   running_total = 0;
   ast_mwi_state_callback_all(cb, user_data);

   if (running_total != sum_total) {
      ast_log(LOG_ERROR, "Failed MWI state callback (1): running=%zu, sum=%zu\n",
            running_total, sum_total);
      return -1;
   }

   /* Second time check valid state data exists */
   running_total = expect_zero = 0;
   ast_mwi_state_callback_all(cb, user_data);

   if (running_total != sum_total) {
      ast_log(LOG_ERROR, "Failed MWI state callback (2): running=%zu, sum=%zu\n",
            running_total, sum_total);
      return -1;
   }

   return 0;
}

publishers_create()

static int publishers_create ( struct publishers *  pubs )

static

Definition at line 213 of file test_mwi.c.

References ao2_ref, ast_log, ast_mwi_add_publisher(), AST_VECTOR_APPEND, AST_VECTOR_INIT, LOG_ERROR, mailbox, MAILBOX_COUNT, MAILBOX_SIZE, num_to_mailbox(), and publishers_destroy().

Referenced by AST_TEST_DEFINE().

{
   size_t i;

   if (AST_VECTOR_INIT(pubs, MAILBOX_COUNT)) {
      return -1;
   }

   for (i = 0; i < MAILBOX_COUNT; ++i) {
      struct ast_mwi_publisher *pub;
      char mailbox[MAILBOX_SIZE];

      if (num_to_mailbox(mailbox, MAILBOX_SIZE, i)) {
         break;
      }

      /* Create the MWI publisher */
      pub = ast_mwi_add_publisher(mailbox);
      if (!pub) {
         ast_log(LOG_ERROR, "Failed to create an MWI publisher for mailbox '%s'\n", mailbox);
         break;
      }

      if (AST_VECTOR_APPEND(pubs, pub)) {
         ast_log(LOG_ERROR, "Failed to add to an MWI publisher to vector for mailbox '%s'\n", mailbox);
         ao2_ref(pub, -1);
         break;
      }
   }

   if (i != MAILBOX_COUNT) {
      ast_log(LOG_ERROR, "Failed to create all MWI publishers: count=%zu\n", i);
      publishers_destroy(pubs);
      return -1;
   }

   return 0;
}

publishers_destroy()

static int publishers_destroy ( struct publishers *  pubs )

static

Definition at line 188 of file test_mwi.c.

References ao2_cleanup, ast_delete_mwi_state, AST_VECTOR_CALLBACK_VOID, AST_VECTOR_FREE, mailbox, MAILBOX_COUNT, MAILBOX_SIZE, NULL, and num_to_mailbox().

Referenced by AST_TEST_DEFINE(), and publishers_create().

{
   size_t i;

   if (pubs) {
      /* Remove explicit publishers */
      AST_VECTOR_CALLBACK_VOID(pubs, ao2_cleanup);
      AST_VECTOR_FREE(pubs);
      return 0;
   }

   for (i = 0; i < MAILBOX_COUNT; ++i) {
      char mailbox[MAILBOX_SIZE];

      /* Remove implicit publishers */
      if (num_to_mailbox(mailbox, MAILBOX_SIZE, i)) {
         return -1;
      }

      ast_delete_mwi_state(mailbox, NULL);
   }

   return 0;
}

subscriptions_create()

static int subscriptions_create ( struct subscriptions *  subs )

static

Definition at line 143 of file test_mwi.c.

References ao2_ref, ast_log, ast_mwi_add_observer(), ast_mwi_subscribe_pool(), AST_VECTOR_APPEND, AST_VECTOR_INIT, expect_zero, LOG_ERROR, mailbox, MAILBOX_COUNT, MAILBOX_SIZE, mwi_type_cb(), NULL, num_to_mailbox(), running_total, sub, subscriptions_destroy(), and sum_total.

Referenced by AST_TEST_DEFINE().

{
   size_t i;

   if (ast_mwi_add_observer(&mwi_observer) ||
      AST_VECTOR_INIT(subs, MAILBOX_COUNT)) {
      return -1;
   }

   sum_total = running_total = 0;
   expect_zero = 1;

   for (i = 0; i < MAILBOX_COUNT; ++i) {
      struct ast_mwi_subscriber *sub;
      char mailbox[MAILBOX_SIZE];

      if (num_to_mailbox(mailbox, MAILBOX_SIZE, i)) {
         break;
      }

      sub = ast_mwi_subscribe_pool(mailbox, mwi_type_cb, NULL);
      if (!sub) {
         ast_log(LOG_ERROR, "Failed to create a MWI subscriber for mailbox '%s'\n", mailbox);
         break;
      }

      if (AST_VECTOR_APPEND(subs, sub)) {
         ast_log(LOG_ERROR, "Failed to add to MWI sub to vector for mailbox '%s'\n", mailbox);
         ao2_ref(sub, -1);
         break;
      }

      sum_total += i;
   }

   if (i != MAILBOX_COUNT || running_total != sum_total) {
      ast_log(LOG_ERROR, "Failed to create all MWI subscriptions: running=%zu, sum=%zu\n",
            running_total, sum_total);
      subscriptions_destroy(subs);
      return -1;
   }

   return 0;
}

subscriptions_destroy()

static int subscriptions_destroy ( struct subscriptions *  subs )

static

Definition at line 125 of file test_mwi.c.

References ast_log, ast_mwi_remove_observer(), ast_mwi_unsubscribe_and_join(), AST_VECTOR_CALLBACK_VOID, AST_VECTOR_FREE, expect_zero, LOG_ERROR, running_total, and sum_total.

Referenced by AST_TEST_DEFINE(), and subscriptions_create().

{
   running_total = expect_zero = 0;

   AST_VECTOR_CALLBACK_VOID(subs, ast_mwi_unsubscribe_and_join);
   AST_VECTOR_FREE(subs);

   ast_mwi_remove_observer(&mwi_observer);

   if (running_total != sum_total) {
      ast_log(LOG_ERROR, "Failed to destroy all MWI subscriptions: running=%zu, sum=%zu\n",
            running_total, sum_total);
      return -1;
   }

   return 0;
}

unload_module()

static int unload_module ( void  )

static

Definition at line 391 of file test_mwi.c.

References AST_TEST_UNREGISTER.

{
   AST_TEST_UNREGISTER(implicit_publish);
   AST_TEST_UNREGISTER(explicit_publish);

   return 0;
}

validate_data()

static int validate_data ( struct ast_mwi_state *  mwi_state )

static

Definition at line 81 of file test_mwi.c.

References ast_log, expect_zero, LOG_ERROR, mailbox_to_num(), ast_mwi_state::new_msgs, ast_mwi_state::old_msgs, running_total, ast_mwi_state::uniqueid, and ast_mwi_state::urgent_msgs.

Referenced by explicit_publish_cb(), handle_validate(), and implicit_publish_cb().

{
   size_t num;
   size_t val;

   if (mailbox_to_num(mwi_state->uniqueid, &num)) {
      return -1;
   }

   running_total += num;

   val = expect_zero ? 0 : num;

   if (mwi_state->urgent_msgs != val || mwi_state->new_msgs != val ||
         mwi_state->old_msgs != val) {
      ast_log(LOG_ERROR, "Unexpected MWI state data for '%s', %d != %zu\n",
            mwi_state->uniqueid, mwi_state->urgent_msgs, val);
      return -1;
   }

   return num;
}

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "MWI testing" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }

static

Definition at line 407 of file test_mwi.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 407 of file test_mwi.c.

expect_zero

int expect_zero

static

This value is set to check if MWI data is zero before publishing

Definition at line 52 of file test_mwi.c.

Referenced by publish(), subscriptions_create(), subscriptions_destroy(), and validate_data().

mwi_observer

struct ast_mwi_observer mwi_observer

Initial value:

= {
   .on_subscribe = handle_validate,
   .on_unsubscribe = handle_validate
}

Definition at line 115 of file test_mwi.c.

running_total

size_t running_total

static

Test variable that tracks the running total of mailboxes

Definition at line 49 of file test_mwi.c.

Referenced by publish(), subscriptions_create(), subscriptions_destroy(), and validate_data().

sum_total

size_t sum_total

static

For testing purposes each subscribed mailbox is a number. This value is the summation of all mailboxes.

Definition at line 46 of file test_mwi.c.

Referenced by publish(), subscriptions_create(), and subscriptions_destroy().