test_sorcery.c

Go to the documentation of this file.

/*
 * Asterisk -- An open source telephony toolkit.
 *
 * Copyright (C) 2012 - 2013, Digium, Inc.
 *
 * Joshua Colp <[email protected]>
 *
 * See http://www.asterisk.org for more information about
 * the Asterisk project. Please do not directly contact
 * any of the maintainers of this project for assistance;
 * the project provides a web site, mailing lists and IRC
 * channels for your use.
 *
 * This program is free software, distributed under the terms of
 * the GNU General Public License Version 2. See the LICENSE file
 * at the top of the source tree.
 */

/*!
 * \file
 * \brief Sorcery Unit Tests
 *
 * \author Joshua Colp <[email protected]>
 *
 */

/*** MODULEINFO
   <depend>TEST_FRAMEWORK</depend>
   <depend>func_sorcery</depend>
   <support_level>core</support_level>
 ***/

#include "asterisk.h"

#include "asterisk/test.h"
#include "asterisk/module.h"
#include "asterisk/astobj2.h"
#include "asterisk/pbx.h"
#include "asterisk/sorcery.h"
#include "asterisk/logger.h"
#include "asterisk/json.h"

/*! \brief Dummy sorcery object */
struct test_sorcery_object {
   SORCERY_OBJECT(details);
   unsigned int bob;
   unsigned int joe;
   struct ast_variable *jim;
   struct ast_variable *jack;
};

/*! \brief Internal function to destroy a test object */
static void test_sorcery_object_destroy(void *obj)
{
   struct test_sorcery_object *tobj = obj;
   ast_variables_destroy(tobj->jim);
   ast_variables_destroy(tobj->jack);
}

/*! \brief Internal function to allocate a test object */
static void *test_sorcery_object_alloc(const char *id)
{
   return ast_sorcery_generic_alloc(sizeof(struct test_sorcery_object), test_sorcery_object_destroy);
}

/*! \brief Internal function for object set transformation */
static struct ast_variable *test_sorcery_transform(struct ast_variable *set)
{
   struct ast_variable *field, *transformed = NULL;

   for (field = set; field; field = field->next) {
      struct ast_variable *transformed_field;

      if (!strcmp(field->name, "joe")) {
         transformed_field = ast_variable_new(field->name, "5000", "");
      } else {
         transformed_field = ast_variable_new(field->name, field->value, "");
      }

      if (!transformed_field) {
         ast_variables_destroy(transformed);
         return NULL;
      }

      transformed_field->next = transformed;
      transformed = transformed_field;
   }

   return transformed;
}

/*! \brief Internal function which copies pre-defined data into an object, natively */
static int test_sorcery_copy(const void *src, void *dst)
{
   struct test_sorcery_object *obj = dst;
   obj->bob = 10;
   obj->joe = 20;
   obj->jim = ast_variable_new("jim", "444", "");
   obj->jack = ast_variable_new("jack", "999,000", "");
   return 0;
}

/*! \brief Internal function which creates a pre-defined diff natively */
static int test_sorcery_diff(const void *original, const void *modified, struct ast_variable **changes)
{
   *changes = ast_variable_new("yes", "itworks", "");
   return 0;
}

/*! \brief Internal function which sets some values */
static int test_sorcery_regex_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
{
   struct test_sorcery_object *test = obj;

   test->bob = 256;

   return 0;
}

/*! \brief Internal function which creates some ast_variable structures */
static int test_sorcery_regex_fields(const void *obj, struct ast_variable **fields)
{
   *fields = ast_variable_new("toast-bob", "10", "");

   return 0;
}

/*! \brief Test structure for caching */
struct sorcery_test_caching {
   /*! \brief Whether the object has been created in the cache or not */
   unsigned int created:1;

   /*! \brief Whether the object has been updated in the cache or not */
   unsigned int updated:1;

   /*! \brief Whether the object has been deleted from the cache or not */
   unsigned int deleted:1;

   /*! \brief Whether the object is stale or not */
   unsigned int is_stale:1;

   /*! \brief Object to return when asked */
   struct test_sorcery_object object;
};

/*! \brief Test structure for observer */
struct sorcery_test_observer {
   /*! \brief Lock for notification */
   ast_mutex_t lock;

   /*! \brief Condition for notification */
   ast_cond_t cond;

   /*! \brief Pointer to the created object */
   const void *created;

   /*! \brief Pointer to the update object */
   const void *updated;

   /*! \brief Pointer to the deleted object */
   const void *deleted;

   /*! \brief Whether the type has been loaded */
   unsigned int loaded:1;
};

/*! \brief Global scope apply handler integer to make sure it executed */
static int apply_handler_called;

/*! \brief Simple apply handler which sets global scope integer to 1 if called */
static int test_apply_handler(const struct ast_sorcery *sorcery, void *obj)
{
   apply_handler_called = 1;
   return 0;
}

/*! \brief Global scope caching structure for testing */
static struct sorcery_test_caching cache = { 0, };

/*! \brief Global scope observer structure for testing */
static struct sorcery_test_observer observer;

static void *wizard2_data;

static void *sorcery_test_open(const char *data)
{
   wizard2_data = (void *)data;
   return wizard2_data;
}

static void sorcery_test_close(void *data)
{

}

static int sorcery_test_create(const struct ast_sorcery *sorcery, void *data, void *object)
{
   cache.created = 1;
   cache.updated = 0;
   cache.deleted = 0;
   return 0;
}

static void *sorcery_test_retrieve_id(const struct ast_sorcery *sorcery, void *data, const char *type, const char *id)
{
   return (cache.created && !cache.deleted) ? ast_sorcery_alloc(sorcery, type, id) : NULL;
}

static int sorcery_test_update(const struct ast_sorcery *sorcery, void *data, void *object)
{
   cache.updated = 1;
   return 0;
}

static int sorcery_test_delete(const struct ast_sorcery *sorcery, void *data, void *object)
{
   cache.deleted = 1;
   return 0;
}

static int sorcery_test_is_stale(const struct ast_sorcery *sorcery, void *data, void *object)
{
   cache.is_stale = 1;
   return 1;
}

/*! \brief Dummy sorcery wizards, not actually used so we only populate the name and nothing else */
static struct ast_sorcery_wizard test_wizard = {
   .name = "test",
   .create = sorcery_test_create,
   .retrieve_id = sorcery_test_retrieve_id,
   .update = sorcery_test_update,
   .delete = sorcery_test_delete,
};

static struct ast_sorcery_wizard test_wizard2 = {
   .name = "test2",
   .open = sorcery_test_open,
   .close = sorcery_test_close,
   .create = sorcery_test_create,
   .retrieve_id = sorcery_test_retrieve_id,
   .update = sorcery_test_update,
   .delete = sorcery_test_delete,
   .is_stale = sorcery_test_is_stale,
};

static void sorcery_observer_created(const void *object)
{
   SCOPED_MUTEX(lock, &observer.lock);
   observer.created = object;
   ast_cond_signal(&observer.cond);
}

static void sorcery_observer_updated(const void *object)
{
   SCOPED_MUTEX(lock, &observer.lock);
   observer.updated = object;
   ast_cond_signal(&observer.cond);
}

static void sorcery_observer_deleted(const void *object)
{
   SCOPED_MUTEX(lock, &observer.lock);
   observer.deleted = object;
   ast_cond_signal(&observer.cond);
}

static void sorcery_observer_loaded(const char *object_type)
{
   SCOPED_MUTEX(lock, &observer.lock);
   observer.loaded = 1;
   ast_cond_signal(&observer.cond);
}

/*! \brief Test sorcery observer implementation */
static const struct ast_sorcery_observer test_observer = {
   .created = sorcery_observer_created,
   .updated = sorcery_observer_updated,
   .deleted = sorcery_observer_deleted,
   .loaded = sorcery_observer_loaded,
};

/*  This handler takes a simple value and creates new list entry for it*/
static int jim_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
{
   struct test_sorcery_object *tobj = obj;

   ast_variable_list_append(&tobj->jim, ast_variables_dup(var));

   return 0;
}

/*  This handler takes a CSV string and creates new a new list entry for each value */
static int jack_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
{
   struct test_sorcery_object *tobj = obj;

   char *jacks = ast_strdupa(var->value);
   char *val;

   while ((val = strsep(&jacks, ","))) {
      ast_variable_list_append(&tobj->jack, ast_variable_new("jack", val, ""));
   }
   return 0;
}

static int jim_vl(const void *obj, struct ast_variable **fields)
{
   const struct test_sorcery_object *tobj = obj;
   if (tobj->jim) {
      *fields = ast_variables_dup(tobj->jim);
   }
   return 0;
}

static int jack_str(const void *obj, const intptr_t *args, char **buf)
{
   const struct test_sorcery_object *tobj = obj;
   struct ast_variable *curr = tobj->jack;
   RAII_VAR(struct ast_str *, str,  ast_str_create(128), ast_free);

   while(curr) {
      ast_str_append(&str, 0, "%s,", curr->value);
      curr = curr->next;
   }
   ast_str_truncate(str, -1);
   *buf = ast_strdup(ast_str_buffer(str));
   str = NULL;
   return 0;
}

static struct ast_sorcery *alloc_and_initialize_sorcery(void)
{
   struct ast_sorcery *sorcery;

   if (!(sorcery = ast_sorcery_open())) {
      return NULL;
   }

   if ((ast_sorcery_apply_default(sorcery, "test", "memory", NULL) != AST_SORCERY_APPLY_SUCCESS) ||
      ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, NULL)) {
      ast_sorcery_unref(sorcery);
      return NULL;
   }

   ast_sorcery_object_field_register_nodoc(sorcery, "test", "bob", "5", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, bob));
   ast_sorcery_object_field_register_nodoc(sorcery, "test", "joe", "10", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, joe));
   ast_sorcery_object_field_register_custom_nodoc(sorcery, "test", "jim", "444", jim_handler, NULL, jim_vl, 0, 0);
   ast_sorcery_object_field_register_custom_nodoc(sorcery, "test", "jack", "888,999", jack_handler, jack_str, NULL, 0, 0);

   return sorcery;
}

AST_TEST_DEFINE(wizard_registration)
{
   switch (cmd) {
   case TEST_INIT:
      info->name = "wizard_registration";
      info->category = "/main/sorcery/";
      info->summary = "sorcery wizard registration and unregistration unit test";
      info->description =
         "Test registration and unregistration of a sorcery wizard";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (ast_sorcery_wizard_register(&test_wizard)) {
      ast_test_status_update(test, "Failed to register a perfectly valid sorcery wizard\n");
      return AST_TEST_FAIL;
   }

   if (!ast_sorcery_wizard_register(&test_wizard)) {
      ast_test_status_update(test, "Successfully registered a sorcery wizard twice, which is bad\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_wizard_unregister(&test_wizard)) {
      ast_test_status_update(test, "Failed to unregister a perfectly valid sorcery wizard\n");
      return AST_TEST_FAIL;
   }

   if (!ast_sorcery_wizard_unregister(&test_wizard)) {
      ast_test_status_update(test, "Successfully unregistered a sorcery wizard twice, which is bad\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(sorcery_open)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct ast_sorcery *, sorcery2, NULL, ast_sorcery_unref);
   int refcount;

   switch (cmd) {
   case TEST_INIT:
      info->name = "open";
      info->category = "/main/sorcery/";
      info->summary = "sorcery open/close unit test";
      info->description =
         "Test opening of sorcery and registry operations";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if ((sorcery = ast_sorcery_retrieve_by_module_name(AST_MODULE))) {
      ast_test_status_update(test, "There should NOT have been an existing sorcery instance\n");
      return AST_TEST_FAIL;
   }

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open new sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(sorcery2 = ast_sorcery_retrieve_by_module_name(AST_MODULE))) {
      ast_test_status_update(test, "Failed to find sorcery structure in registry\n");
      return AST_TEST_FAIL;
   }

   if (sorcery2 != sorcery) {
      ast_test_status_update(test, "Should have gotten same sorcery on retrieve\n");
      return AST_TEST_FAIL;
   }
   ast_sorcery_unref(sorcery2);

   if ((refcount = ao2_ref(sorcery, 0)) != 2) {
      ast_test_status_update(test, "Should have been 2 references to sorcery instead of %d\n", refcount);
      return AST_TEST_FAIL;
   }

   if (!(sorcery2 = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open second sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (sorcery2 != sorcery) {
      ast_test_status_update(test, "Should have gotten same sorcery on 2nd open\n");
      return AST_TEST_FAIL;
   }

   if ((refcount = ao2_ref(sorcery, 0)) != 3) {
      ast_test_status_update(test, "Should have been 3 references to sorcery instead of %d\n", refcount);
      return AST_TEST_FAIL;
   }

   ast_sorcery_unref(sorcery);
   ast_sorcery_unref(sorcery2);

   sorcery2 = NULL;

   if ((sorcery = ast_sorcery_retrieve_by_module_name(AST_MODULE))) {
      ast_sorcery_unref(sorcery);
      sorcery = NULL;
      ast_test_status_update(test, "Should NOT have found sorcery structure in registry\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(apply_default)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);

   switch (cmd) {
   case TEST_INIT:
      info->name = "apply_default";
      info->category = "/main/sorcery/";
      info->summary = "sorcery default wizard unit test";
      info->description =
         "Test setting default type wizard in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_apply_default(sorcery, "test", "dummy", NULL) != AST_SORCERY_APPLY_FAIL) {
      ast_test_status_update(test, "Successfully set a default wizard that doesn't exist\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_apply_default(sorcery, "test", "memory", NULL) != AST_SORCERY_APPLY_SUCCESS) {
      ast_test_status_update(test, "Failed to set a known wizard as a default\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_apply_default(sorcery, "test", "memory", NULL) != AST_SORCERY_APPLY_DEFAULT_UNNECESSARY) {
      ast_test_status_update(test, "Successfully set a default wizard on a type twice\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(apply_config)
{
   struct ast_flags flags = { CONFIG_FLAG_NOCACHE };
   struct ast_config *config;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);

   switch (cmd) {
   case TEST_INIT:
      info->name = "apply_config";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object mapping configuration unit test";
      info->description =
         "Test configured object mapping in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(config = ast_config_load2("sorcery.conf", "test_sorcery", flags))) {
      ast_test_status_update(test, "Sorcery configuration file not present - skipping apply_config test\n");
      return AST_TEST_NOT_RUN;
   }

   if (!ast_category_get(config, "test_sorcery_section", NULL)) {
      ast_test_status_update(test, "Sorcery configuration file does not have test_sorcery section\n");
      ast_config_destroy(config);
      return AST_TEST_NOT_RUN;
   }

   ast_config_destroy(config);

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_apply_config(sorcery, "test_sorcery_section") != AST_SORCERY_APPLY_SUCCESS) {
      ast_test_status_update(test, "Failed to apply configured object mappings\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_register)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_register";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object type registration unit test";
      info->description =
         "Test object type registration in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open structure\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_apply_default(sorcery, "test", "memory", NULL) != AST_SORCERY_APPLY_SUCCESS) {
      ast_test_status_update(test, "Failed to set a known wizard as a default\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, NULL)) {
      ast_test_status_update(test, "Failed to register object type\n");
      return AST_TEST_FAIL;
   }

   if (!ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, NULL)) {
      ast_test_status_update(test, "Registered object type a second time, despite it being registered already\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_register_without_mapping)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_register_without_mapping";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object type registration (without mapping) unit test";
      info->description =
         "Test object type registration when no mapping exists in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, NULL)) {
      ast_test_status_update(test, "Registered object type when no object mapping exists\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_field_register)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_field_register";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object field registration unit test";
      info->description =
         "Test object field registration in sorcery with a provided id";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!ast_sorcery_object_field_register_nodoc(sorcery, "test", "bob", "5", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, bob))) {
      ast_test_status_update(test, "Registered an object field successfully when no mappings or object types exist\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_apply_default(sorcery, "test", "memory", NULL) != AST_SORCERY_APPLY_SUCCESS) {
      ast_test_status_update(test, "Failed to set a known wizard as a default\n");
      return AST_TEST_FAIL;
   }

   if (!ast_sorcery_object_field_register_nodoc(sorcery, "test", "bob", "5", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, bob))) {
      ast_test_status_update(test, "Registered an object field successfully when object type does not exist\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, NULL)) {
      ast_test_status_update(test, "Failed to register object type\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_object_field_register_nodoc(sorcery, "test", "bob", "5", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, bob))) {
      ast_test_status_update(test, "Could not successfully register object field when mapping and object type exists\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_fields_register)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_fields_register";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object regex fields registration unit test";
      info->description =
         "Test object regex fields registration in sorcery with a provided id";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!ast_sorcery_object_fields_register(sorcery, "test", "^toast-", test_sorcery_regex_handler, test_sorcery_regex_fields)) {
      ast_test_status_update(test, "Registered a regex object field successfully when no mappings or object types exist\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_apply_default(sorcery, "test", "memory", NULL) != AST_SORCERY_APPLY_SUCCESS) {
      ast_test_status_update(test, "Failed to set a known wizard as a default\n");
      return AST_TEST_FAIL;
   }

   if (!ast_sorcery_object_fields_register(sorcery, "test", "^toast-", test_sorcery_regex_handler, test_sorcery_regex_fields)) {
      ast_test_status_update(test, "Registered a regex object field successfully when object type does not exist\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, NULL)) {
      ast_test_status_update(test, "Failed to register object type\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_object_fields_register(sorcery, "test", "^toast-", test_sorcery_regex_handler, test_sorcery_regex_fields)) {
      ast_test_status_update(test, "Registered a regex object field successfully when no mappings or object types exist\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_alloc_with_id)
{
   int res = AST_TEST_PASS;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_alloc_with_id";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object allocation (with id) unit test";
      info->description =
         "Test object allocation in sorcery with a provided id";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      res = AST_TEST_FAIL;
   } else if (ast_strlen_zero(ast_sorcery_object_get_id(obj))) {
      ast_test_status_update(test, "Allocated object has empty id when it should not\n");
      res = AST_TEST_FAIL;
   } else if (strcmp(ast_sorcery_object_get_id(obj), "blah")) {
      ast_test_status_update(test, "Allocated object does not have correct id\n");
      res = AST_TEST_FAIL;
   } else if (ast_strlen_zero(ast_sorcery_object_get_type(obj))) {
      ast_test_status_update(test, "Allocated object has empty type when it should not\n");
      res = AST_TEST_FAIL;
   } else if (strcmp(ast_sorcery_object_get_type(obj), "test")) {
      ast_test_status_update(test, "Allocated object does not have correct type\n");
      res = AST_TEST_FAIL;
   } else if ((obj->bob != 5) || (obj->joe != 10)) {
      ast_test_status_update(test, "Allocated object does not have defaults set as it should\n");
      res = AST_TEST_FAIL;
   }

   return res;
}

AST_TEST_DEFINE(object_alloc_without_id)
{
   int res = AST_TEST_PASS;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_alloc_without_id";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object allocation (without id) unit test";
      info->description =
         "Test object allocation in sorcery with no provided id";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", NULL))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      res = AST_TEST_FAIL;
   } else if (ast_strlen_zero(ast_sorcery_object_get_id(obj))) {
      ast_test_status_update(test, "Allocated object has empty id when it should not\n");
      res = AST_TEST_FAIL;
   }

   return res;
}


AST_TEST_DEFINE(object_copy)
{
   int res = AST_TEST_PASS;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct test_sorcery_object *, copy, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_copy";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object copy unit test";
      info->description =
         "Test object copy in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   obj->bob = 50;
   obj->joe = 100;
   jim_handler(NULL, ast_variable_new("jim", "444", ""), obj);
   jim_handler(NULL, ast_variable_new("jim", "555", ""), obj);

   if (!(copy = ast_sorcery_copy(sorcery, obj))) {
      ast_test_status_update(test, "Failed to create a copy of a known valid object\n");
      res = AST_TEST_FAIL;
   } else if (copy == obj) {
      ast_test_status_update(test, "Created copy is actually the original object\n");
      res = AST_TEST_FAIL;
   } else if (copy->bob != obj->bob) {
      ast_test_status_update(test, "Value of 'bob' on newly created copy is not the same as original\n");
      res = AST_TEST_FAIL;
   } else if (copy->joe != obj->joe) {
      ast_test_status_update(test, "Value of 'joe' on newly created copy is not the same as original\n");
      res = AST_TEST_FAIL;
   } else if (!copy->jim) {
      ast_test_status_update(test, "A new ast_variable was not created for 'jim'\n");
      res = AST_TEST_FAIL;
   } else if (copy->jim == obj->jim) {
      ast_test_status_update(test, "Created copy of 'jim' is actually the ogirinal 'jim'\n");
      res = AST_TEST_FAIL;
   } else if (strcmp(copy->jim->value, obj->jim->value)) {
      ast_test_status_update(test, "Value of 1st 'jim' on newly created copy is not the same as original\n");
      res = AST_TEST_FAIL;
   } else if (!copy->jim->next) {
      ast_test_status_update(test, "A new ast_variable was not created for 2nd 'jim'\n");
      res = AST_TEST_FAIL;
   } else if (strcmp(copy->jim->next->value, obj->jim->next->value)) {
      ast_test_status_update(test, "Value of 2nd 'jim' (%s %s) on newly created copy is not the same as original (%s %s)\n",
         copy->jim->value, copy->jim->next->value, obj->jim->value, obj->jim->next->value);
      res = AST_TEST_FAIL;
   }

   return res;
}

AST_TEST_DEFINE(object_copy_native)
{
   int res = AST_TEST_PASS;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct test_sorcery_object *, copy, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_copy_native";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object native copy unit test";
      info->description =
         "Test object native copy in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   ast_sorcery_object_set_copy_handler(sorcery, "test", test_sorcery_copy);

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   obj->bob = 50;
   obj->joe = 100;

   if (!(copy = ast_sorcery_copy(sorcery, obj))) {
      ast_test_status_update(test, "Failed to create a copy of a known valid object\n");
      res = AST_TEST_FAIL;
   } else if (copy == obj) {
      ast_test_status_update(test, "Created copy is actually the original object\n");
      res = AST_TEST_FAIL;
   } else if (copy->bob != 10) {
      ast_test_status_update(test, "Value of 'bob' on newly created copy is not the predefined native copy value\n");
      res = AST_TEST_FAIL;
   } else if (copy->joe != 20) {
      ast_test_status_update(test, "Value of 'joe' on newly created copy is not the predefined native copy value\n");
      res = AST_TEST_FAIL;
   } else if (!copy->jim) {
      ast_test_status_update(test, "A new ast_variable was not created for 'jim'\n");
      res = AST_TEST_FAIL;
   } else if (strcmp(copy->jim->value, "444")) {
      ast_test_status_update(test, "Value of 'jim' on newly created copy is not the predefined native copy value\n");
      res = AST_TEST_FAIL;
   }

   return res;
}

AST_TEST_DEFINE(object_diff)
{
       RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
       RAII_VAR(struct test_sorcery_object *, obj1, NULL, ao2_cleanup);
       RAII_VAR(struct test_sorcery_object *, obj2, NULL, ao2_cleanup);
       RAII_VAR(struct ast_variable *, changes, NULL, ast_variables_destroy);
       struct ast_variable *field;
       int res = AST_TEST_PASS;
       int jims = 0;

       switch (cmd) {
       case TEST_INIT:
          info->name = "object_diff";
          info->category = "/main/sorcery/";
          info->summary = "sorcery object diff unit test";
          info->description =
             "Test object diffing in sorcery";
          return AST_TEST_NOT_RUN;
       case TEST_EXECUTE:
          break;
       }

       if (!(sorcery = alloc_and_initialize_sorcery())) {
          ast_test_status_update(test, "Failed to open sorcery structure\n");
          return AST_TEST_FAIL;
       }

       if (!(obj1 = ast_sorcery_alloc(sorcery, "test", "blah"))) {
          ast_test_status_update(test, "Failed to allocate a known object type\n");
          return AST_TEST_FAIL;
       }

       obj1->bob = 99;
       obj1->joe = 55;
       jim_handler(NULL, ast_variable_new("jim", "444", ""), obj1);
       jim_handler(NULL, ast_variable_new("jim", "555", ""), obj1);

       if (!(obj2 = ast_sorcery_alloc(sorcery, "test", "blah2"))) {
          ast_test_status_update(test, "Failed to allocate a second known object type\n");
          return AST_TEST_FAIL;
       }

       obj2->bob = 99;
       obj2->joe = 42;
       jim_handler(NULL, ast_variable_new("jim", "444", ""), obj2);
       jim_handler(NULL, ast_variable_new("jim", "666", ""), obj2);
       jim_handler(NULL, ast_variable_new("jim", "777", ""), obj2);

       if (ast_sorcery_diff(sorcery, obj1, obj2, &changes)) {
          ast_test_status_update(test, "Failed to diff obj1 and obj2\n");
       } else if (!changes) {
          ast_test_status_update(test, "Failed to produce a diff of two objects, despite there being differences\n");
          return AST_TEST_FAIL;
       }

   for (field = changes; field; field = field->next) {
      if (!strcmp(field->name, "joe")) {
         if (strcmp(field->value, "42")) {
            ast_test_status_update(test,
               "Object diff produced unexpected value '%s' for joe\n", field->value);
            res = AST_TEST_FAIL;
         }
      } else if (!strcmp(field->name, "jim")) {
         jims++;
         if (!strcmp(field->value, "555")) {
            ast_test_status_update(test,
               "Object diff produced unexpected value '%s' for jim\n", field->value);
            res = AST_TEST_FAIL;
         }
      } else {
         ast_test_status_update(test, "Object diff produced unexpected field '%s'\n",
            field->name);
         res = AST_TEST_FAIL;
      }
   }

       if (jims != 2) {
          ast_test_status_update(test, "Object diff didn't produce 2 jims\n");
          res = AST_TEST_FAIL;
       }

       return res;
}

AST_TEST_DEFINE(object_diff_native)
{
       RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
       RAII_VAR(struct test_sorcery_object *, obj1, NULL, ao2_cleanup);
       RAII_VAR(struct test_sorcery_object *, obj2, NULL, ao2_cleanup);
       RAII_VAR(struct ast_variable *, changes, NULL, ast_variables_destroy);
       struct ast_variable *field;
       int res = AST_TEST_PASS;

       switch (cmd) {
       case TEST_INIT:
          info->name = "object_diff_native";
          info->category = "/main/sorcery/";
          info->summary = "sorcery object native diff unit test";
          info->description =
             "Test native object diffing in sorcery";
          return AST_TEST_NOT_RUN;
       case TEST_EXECUTE:
          break;
       }

       if (!(sorcery = alloc_and_initialize_sorcery())) {
          ast_test_status_update(test, "Failed to open sorcery structure\n");
          return AST_TEST_FAIL;
       }

       ast_sorcery_object_set_diff_handler(sorcery, "test", test_sorcery_diff);

       if (!(obj1 = ast_sorcery_alloc(sorcery, "test", "blah"))) {
          ast_test_status_update(test, "Failed to allocate a known object type\n");
          return AST_TEST_FAIL;
       }

       obj1->bob = 99;
       obj1->joe = 55;

       if (!(obj2 = ast_sorcery_alloc(sorcery, "test", "blah2"))) {
          ast_test_status_update(test, "Failed to allocate a second known object type\n");
          return AST_TEST_FAIL;
       }

       obj2->bob = 99;
       obj2->joe = 42;

       if (ast_sorcery_diff(sorcery, obj1, obj2, &changes)) {
          ast_test_status_update(test, "Failed to diff obj1 and obj2\n");
       } else if (!changes) {
          ast_test_status_update(test, "Failed to produce a diff of two objects, despite there being differences\n");
          return AST_TEST_FAIL;
       }

       for (field = changes; field; field = field->next) {
          if (!strcmp(field->name, "yes")) {
             if (strcmp(field->value, "itworks")) {
                ast_test_status_update(test, "Object diff produced unexpected value '%s' for joe\n", field->value);
                res = AST_TEST_FAIL;
             }
          } else {
             ast_test_status_update(test, "Object diff produced unexpected field '%s'\n", field->name);
             res = AST_TEST_FAIL;
          }
       }

       return res;
}

AST_TEST_DEFINE(objectset_create)
{
   int res = AST_TEST_PASS;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct ast_variable *, objset, NULL, ast_variables_destroy);
   struct ast_variable *field;

   switch (cmd) {
   case TEST_INIT:
      info->name = "objectset_create";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object set creation unit test";
      info->description =
         "Test object set creation in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (!(objset = ast_sorcery_objectset_create(sorcery, obj))) {
      ast_test_status_update(test, "Failed to create an object set for a known sane object\n");
      return AST_TEST_FAIL;
   }

   for (field = objset; field; field = field->next) {
      if (!strcmp(field->name, "bob")) {
         if (strcmp(field->value, "5")) {
            ast_test_status_update(test, "Object set failed to create proper value for 'bob'\n");
            res = AST_TEST_FAIL;
         }
      } else if (!strcmp(field->name, "joe")) {
         if (strcmp(field->value, "10")) {
            ast_test_status_update(test, "Object set failed to create proper value for 'joe'\n");
            res = AST_TEST_FAIL;
         }
      } else if (!strcmp(field->name, "jim")) {
         if (strcmp(field->value, "444")) {
            ast_test_status_update(test, "Object set failed to create proper value for 'jim'\n");
            res = AST_TEST_FAIL;
         }
      } else if (!strcmp(field->name, "jack")) {
         if (strcmp(field->value, "888,999")) {
            ast_test_status_update(test, "Object set failed to create proper value (%s) for 'jack'\n", field->value);
            res = AST_TEST_FAIL;
         }
      } else {
         ast_test_status_update(test, "Object set created field '%s' which is unknown\n", field->name);
         res = AST_TEST_FAIL;
      }
   }

   return res;
}

AST_TEST_DEFINE(objectset_json_create)
{
   int res = AST_TEST_PASS;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct ast_json *, objset, NULL, ast_json_unref);
   struct ast_json_iter *field;

   switch (cmd) {
   case TEST_INIT:
      info->name = "objectset_json_create";
      info->category = "/main/sorcery/";
      info->summary = "sorcery json object set creation unit test";
      info->description =
         "Test object set creation (for JSON format) in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (!(objset = ast_sorcery_objectset_json_create(sorcery, obj))) {
      ast_test_status_update(test, "Failed to create an object set for a known sane object\n");
      return AST_TEST_FAIL;
   }

   for (field = ast_json_object_iter(objset); field; field = ast_json_object_iter_next(objset, field)) {
      struct ast_json *value = ast_json_object_iter_value(field);

      if (!strcmp(ast_json_object_iter_key(field), "bob")) {
         if (strcmp(ast_json_string_get(value), "5")) {
            ast_test_status_update(test, "Object set failed to create proper value for 'bob'\n");
            res = AST_TEST_FAIL;
         }
      } else if (!strcmp(ast_json_object_iter_key(field), "joe")) {
         if (strcmp(ast_json_string_get(value), "10")) {
            ast_test_status_update(test, "Object set failed to create proper value for 'joe'\n");
            res = AST_TEST_FAIL;
         }
      } else if (!strcmp(ast_json_object_iter_key(field), "jim")) {
         if (strcmp(ast_json_string_get(value), "444")) {
            ast_test_status_update(test, "Object set failed to create proper value for 'jim'\n");
            res = AST_TEST_FAIL;
         }
      } else if (!strcmp(ast_json_object_iter_key(field), "jack")) {
         if (strcmp(ast_json_string_get(value), "888,999")) {
            ast_test_status_update(test, "Object set failed to create proper value for 'jack'\n");
            res = AST_TEST_FAIL;
         }
      } else {
         ast_test_status_update(test, "Object set created field '%s' which is unknown\n", ast_json_object_iter_key(field));
         res = AST_TEST_FAIL;
      }
   }

   return res;
}

AST_TEST_DEFINE(objectset_create_regex)
{
   int res = AST_TEST_PASS;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct ast_variable *, objset, NULL, ast_variables_destroy);
   struct ast_variable *field;

   switch (cmd) {
   case TEST_INIT:
      info->name = "objectset_create_regex";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object set creation with regex fields unit test";
      info->description =
         "Test object set creation with regex fields in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if ((ast_sorcery_apply_default(sorcery, "test", "memory", NULL) != AST_SORCERY_APPLY_SUCCESS) ||
       ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, test_apply_handler)) {
      ast_test_status_update(test, "Failed to register 'test' object type\n");
      return AST_TEST_FAIL;
   }

   ast_sorcery_object_fields_register(sorcery, "test", "^toast-", test_sorcery_regex_handler, test_sorcery_regex_fields);

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (!(objset = ast_sorcery_objectset_create(sorcery, obj))) {
      ast_test_status_update(test, "Failed to create an object set for a known sane object\n");
      return AST_TEST_FAIL;
   }

   for (field = objset; field; field = field->next) {
      if (!strcmp(field->name, "toast-bob")) {
         if (strcmp(field->value, "10")) {
            ast_test_status_update(test, "Object set failed to create proper value for 'bob'\n");
            res = AST_TEST_FAIL;
         }
      } else {
         ast_test_status_update(test, "Object set created field '%s' which is unknown\n", field->name);
         res = AST_TEST_FAIL;
      }
   }

   return res;
}

AST_TEST_DEFINE(objectset_apply)
{
   int res = AST_TEST_PASS;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct ast_variable *, objset, NULL, ast_variables_destroy);

   switch (cmd) {
   case TEST_INIT:
      info->name = "objectset_apply";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object apply unit test";
      info->description =
         "Test object set applying in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (!(objset = ast_variable_new("joe", "25", ""))) {
      ast_test_status_update(test, "Failed to create an object set, test could not occur\n");
      res = AST_TEST_FAIL;
   } else if (ast_sorcery_objectset_apply(sorcery, obj, objset)) {
      ast_test_status_update(test, "Failed to apply valid object set to object\n");
      res = AST_TEST_FAIL;
   } else if (obj->joe != 25) {
      ast_test_status_update(test, "Object set was not actually applied to object despite it returning success\n");
      res = AST_TEST_FAIL;
   }

   return res;
}

AST_TEST_DEFINE(objectset_apply_handler)
{
   int res = AST_TEST_PASS;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct ast_variable *, objset, NULL, ast_variables_destroy);

   switch (cmd) {
   case TEST_INIT:
      info->name = "objectset_apply_handler";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object apply handler unit test";
      info->description =
         "Test object set apply handler call in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if ((ast_sorcery_apply_default(sorcery, "test", "memory", NULL) != AST_SORCERY_APPLY_SUCCESS) ||
       ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, test_apply_handler)) {
      ast_test_status_update(test, "Failed to register 'test' object type\n");
      return AST_TEST_FAIL;
   }

   ast_sorcery_object_field_register_nodoc(sorcery, "test", "bob", "5", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, bob));
   ast_sorcery_object_field_register_nodoc(sorcery, "test", "joe", "10", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, joe));

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   apply_handler_called = 0;

   if (!(objset = ast_variable_new("joe", "25", ""))) {
      ast_test_status_update(test, "Failed to create an object set, test could not occur\n");
      res = AST_TEST_FAIL;
   } else if (ast_sorcery_objectset_apply(sorcery, obj, objset)) {
      ast_test_status_update(test, "Failed to apply valid object set to object\n");
      res = AST_TEST_FAIL;
   } else if (!apply_handler_called) {
      ast_test_status_update(test, "Apply handler was not called when it should have been\n");
      res = AST_TEST_FAIL;
   }

   return res;
}

AST_TEST_DEFINE(objectset_apply_invalid)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct ast_variable *, objset, NULL, ast_variables_destroy);

   switch (cmd) {
   case TEST_INIT:
      info->name = "objectset_apply_invalid";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object invalid apply unit test";
      info->description =
         "Test object set applying of an invalid set in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (!(objset = ast_variable_new("fred", "99", ""))) {
      ast_test_status_update(test, "Failed to create an object set, test could not occur\n");
      return AST_TEST_FAIL;
   } else if (!ast_sorcery_objectset_apply(sorcery, obj, objset)) {
      ast_test_status_update(test, "Successfully applied an invalid object set\n");
      return AST_TEST_FAIL;
   } else if ((obj->bob != 5) || (obj->joe != 10)) {
      ast_test_status_update(test, "Object set modified object fields when it should not have\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(objectset_transform)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct ast_variable *, objset, NULL, ast_variables_destroy);

   switch (cmd) {
   case TEST_INIT:
      info->name = "objectset_transform";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object set transformation unit test";
      info->description =
         "Test object set transformation in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_apply_default(sorcery, "test", "memory", NULL) != AST_SORCERY_APPLY_SUCCESS) {
      ast_test_status_update(test, "Failed to set a known wizard as a default\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, test_sorcery_transform, NULL)) {
      ast_test_status_update(test, "Failed to register object type\n");
      return AST_TEST_FAIL;
   }

   ast_sorcery_object_field_register_nodoc(sorcery, "test", "bob", "5", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, bob));
   ast_sorcery_object_field_register_nodoc(sorcery, "test", "joe", "10", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, joe));

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (!(objset = ast_sorcery_objectset_create(sorcery, obj))) {
      ast_test_status_update(test, "Failed to create an object set for a known sane object\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_objectset_apply(sorcery, obj, objset)) {
      ast_test_status_update(test, "Failed to apply properly created object set against object\n");
      return AST_TEST_FAIL;
   }

   if (obj->bob != 5) {
      ast_test_status_update(test, "Application of object set produced incorrect value on 'bob'\n");
      return AST_TEST_FAIL;
   } else if (obj->joe == 10) {
      ast_test_status_update(test, "Transformation callback did not change value of 'joe' from provided value\n");
      return AST_TEST_FAIL;
   } else if (obj->joe != 5000) {
      ast_test_status_update(test, "Value of 'joe' differs from default AND from transformation value\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(objectset_apply_fields)
{
   int res = AST_TEST_PASS;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct ast_variable *, objset, NULL, ast_variables_destroy);

   switch (cmd) {
   case TEST_INIT:
      info->name = "objectset_apply_fields";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object apply regex fields unit test";
      info->description =
         "Test object set apply with regex fields in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if ((ast_sorcery_apply_default(sorcery, "test", "memory", NULL) != AST_SORCERY_APPLY_SUCCESS) ||
       ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, test_apply_handler)) {
      ast_test_status_update(test, "Failed to register 'test' object type\n");
      return AST_TEST_FAIL;
   }

   ast_sorcery_object_fields_register(sorcery, "test", "^toast-", test_sorcery_regex_handler, test_sorcery_regex_fields);

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (!(objset = ast_variable_new("toast-bob", "20", ""))) {
      ast_test_status_update(test, "Failed to create an object set, test could not occur\n");
      res = AST_TEST_FAIL;
   } else if (ast_sorcery_objectset_apply(sorcery, obj, objset)) {
      ast_test_status_update(test, "Failed to apply valid object set to object\n");
      res = AST_TEST_FAIL;
   } else if (obj->bob != 256) {
      ast_test_status_update(test, "Regex field handler was not called when it should have been\n");
      res = AST_TEST_FAIL;
   }

   return res;
}

AST_TEST_DEFINE(extended_fields)
{
   int res = AST_TEST_PASS;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct ast_variable *, objset, NULL, ast_variables_destroy);
   const char *value;

   switch (cmd) {
   case TEST_INIT:
      info->name = "extended_fields";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object extended fields unit test";
      info->description =
         "Test extended fields support in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (!(objset = ast_variable_new("@testing", "toast", ""))) {
      ast_test_status_update(test, "Failed to create an object set, test could not occur\n");
      res = AST_TEST_FAIL;
   } else if (ast_sorcery_objectset_apply(sorcery, obj, objset)) {
      ast_test_status_update(test, "Failed to apply valid object set to object\n");
      res = AST_TEST_FAIL;
   } else if (!(value = ast_sorcery_object_get_extended(obj, "testing"))) {
      ast_test_status_update(test, "Extended field, which was set using object set, could not be found\n");
      res = AST_TEST_FAIL;
   } else if (strcmp(value, "toast")) {
      ast_test_status_update(test, "Extended field does not contain expected value\n");
      res = AST_TEST_FAIL;
   } else if (ast_sorcery_object_set_extended(obj, "@tacos", "supreme")) {
      ast_test_status_update(test, "Extended field could not be set\n");
      res = AST_TEST_FAIL;
   } else if (!(value = ast_sorcery_object_get_extended(obj, "tacos"))) {
      ast_test_status_update(test, "Extended field, which was set using the API, could not be found\n");
      res = AST_TEST_FAIL;
   } else if (strcmp(value, "supreme")) {
      ast_test_status_update(test, "Extended field does not contain expected value\n");
      res = AST_TEST_FAIL;
   } else if (ast_sorcery_object_set_extended(obj, "@tacos", "canadian")) {
      ast_test_status_update(test, "Extended field could not be set a second time\n");
      res = AST_TEST_FAIL;
   } else if (!(value = ast_sorcery_object_get_extended(obj, "tacos"))) {
      ast_test_status_update(test, "Extended field, which was set using the API, could not be found\n");
      res = AST_TEST_FAIL;
   } else if (strcmp(value, "canadian")) {
      ast_test_status_update(test, "Extended field does not contain expected value\n");
      res = AST_TEST_FAIL;
   }

   return res;
}

AST_TEST_DEFINE(changeset_create)
{
   int res = AST_TEST_PASS;
   RAII_VAR(struct ast_variable *, original, NULL, ast_variables_destroy);
   RAII_VAR(struct ast_variable *, modified, NULL, ast_variables_destroy);
   RAII_VAR(struct ast_variable *, changes, NULL, ast_variables_destroy);
   struct ast_variable *tmp;

   switch (cmd) {
   case TEST_INIT:
      info->name = "changeset_create";
      info->category = "/main/sorcery/";
      info->summary = "sorcery changeset creation unit test";
      info->description =
         "Test changeset creation in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(tmp = ast_variable_new("bananas", "purple", ""))) {
      ast_test_status_update(test, "Failed to create first field for original objectset\n");
      return AST_TEST_FAIL;
   }
   tmp->next = original;
   original = tmp;

   if (!(tmp = ast_variable_new("apples", "orange", ""))) {
      ast_test_status_update(test, "Failed to create second field for original objectset\n");
      return AST_TEST_FAIL;
   }
   tmp->next = original;
   original = tmp;

   if (!(tmp = ast_variable_new("bananas", "green", ""))) {
      ast_test_status_update(test, "Failed to create first field for modified objectset\n");
      return AST_TEST_FAIL;
   }
   tmp->next = modified;
   modified = tmp;

   if (!(tmp = ast_variable_new("apples", "orange", ""))) {
      ast_test_status_update(test, "Failed to create second field for modified objectset\n");
      return AST_TEST_FAIL;
   }
   tmp->next = modified;
   modified = tmp;

   if (ast_sorcery_changeset_create(original, modified, &changes)) {
      ast_test_status_update(test, "Failed to create a changeset due to an error\n");
      return AST_TEST_FAIL;
   } else if (!changes) {
      ast_test_status_update(test, "Failed to produce a changeset when there should be one\n");
      return AST_TEST_FAIL;
   }

   for (tmp = changes; tmp; tmp = tmp->next) {
      if (!strcmp(tmp->name, "bananas")) {
         if (strcmp(tmp->value, "green")) {
            ast_test_status_update(test, "Changeset produced had unexpected value '%s' for bananas\n", tmp->value);
            res = AST_TEST_FAIL;
         }
      } else {
         ast_test_status_update(test, "Changeset produced had unexpected field '%s'\n", tmp->name);
         res = AST_TEST_FAIL;
      }
   }

   return res;
}

AST_TEST_DEFINE(changeset_create_unchanged)
{
   RAII_VAR(struct ast_variable *, original, NULL, ast_variables_destroy);
   RAII_VAR(struct ast_variable *, changes, NULL, ast_variables_destroy);
   RAII_VAR(struct ast_variable *, same, NULL, ast_variables_destroy);
   struct ast_variable *tmp;

   switch (cmd) {
   case TEST_INIT:
      info->name = "changeset_create_unchanged";
      info->category = "/main/sorcery/";
      info->summary = "sorcery changeset creation unit test when no changes exist";
      info->description =
         "Test changeset creation in sorcery when no changes actually exist";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(tmp = ast_variable_new("bananas", "purple", ""))) {
      ast_test_status_update(test, "Failed to create first field for original objectset\n");
      return AST_TEST_FAIL;
   }
   tmp->next = original;
   original = tmp;

   if (!(tmp = ast_variable_new("apples", "orange", ""))) {
      ast_test_status_update(test, "Failed to create second field for original objectset\n");
      return AST_TEST_FAIL;
   }
   tmp->next = original;
   original = tmp;

   if (ast_sorcery_changeset_create(original, original, &changes)) {
      ast_test_status_update(test, "Failed to create a changeset due to an error\n");
      return AST_TEST_FAIL;
   } else if (changes) {
      ast_test_status_update(test, "Created a changeset when no changes actually exist\n");
      return AST_TEST_FAIL;
   }

   if (!(tmp = ast_variable_new("bananas", "purple", ""))) {
      ast_test_status_update(test, "Failed to create first field for same objectset\n");
      return AST_TEST_FAIL;
   }
   tmp->next = same;
   same = tmp;

   if (!(tmp = ast_variable_new("apples", "orange", ""))) {
      ast_test_status_update(test, "Failed to create second field for same objectset\n");
      return AST_TEST_FAIL;
   }
   tmp->next = same;
   same = tmp;

   if (ast_sorcery_changeset_create(original, same, &changes)) {
      ast_test_status_update(test, "Failed to create a changeset due to an error\n");
      return AST_TEST_FAIL;
   } else if (changes) {
      ast_test_status_update(test, "Created a changeset between two different objectsets when no changes actually exist\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_create)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_create";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object creation unit test";
      info->description =
         "Test object creation in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_create(sorcery, obj)) {
      ast_test_status_update(test, "Failed to create object using in-memory wizard\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_retrieve_id)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_retrieve_id";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object retrieval using id unit test";
      info->description =
         "Test object retrieval using id in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_create(sorcery, obj)) {
      ast_test_status_update(test, "Failed to create object using in-memory wizard\n");
      return AST_TEST_FAIL;
   }

   ao2_cleanup(obj);

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah2"))) {
      ast_test_status_update(test, "Failed to allocate second instance of a known object type\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_create(sorcery, obj)) {
      ast_test_status_update(test, "Failed to create second object using in-memory wizard\n");
      return AST_TEST_FAIL;
   }

   ao2_cleanup(obj);

   if (!(obj = ast_sorcery_retrieve_by_id(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to retrieve properly created object using id of 'blah'\n");
      return AST_TEST_FAIL;
   } else if (strcmp(ast_sorcery_object_get_id(obj), "blah")) {
      ast_test_status_update(test, "Retrieved object does not have correct id\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_retrieve_field)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct ast_variable *, fields, ast_variable_new("joe", "42", ""), ast_variables_destroy);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_retrieve_field";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object retrieval using a specific field unit test";
      info->description =
         "Test object retrieval using a specific field in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!fields) {
      ast_test_status_update(test, "Failed to create fields for object retrieval attempt\n");
      return AST_TEST_FAIL;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   obj->joe = 42;

   if (ast_sorcery_create(sorcery, obj)) {
      ast_test_status_update(test, "Failed to create object using in-memory wizard\n");
      return AST_TEST_FAIL;
   }

   ao2_cleanup(obj);

   if (!(obj = ast_sorcery_retrieve_by_fields(sorcery, "test", AST_RETRIEVE_FLAG_DEFAULT, fields))) {
      ast_test_status_update(test, "Failed to retrieve properly created object using 'joe' field\n");
      return AST_TEST_FAIL;
   }

   ao2_cleanup(obj);
   ast_variables_destroy(fields);

   if (!(fields = ast_variable_new("joe", "49", ""))) {
      ast_test_status_update(test, "Failed to create fields for object retrieval attempt\n");
      return AST_TEST_FAIL;
   }

   if ((obj = ast_sorcery_retrieve_by_fields(sorcery, "test", AST_RETRIEVE_FLAG_DEFAULT, fields))) {
      ast_test_status_update(test, "Retrieved an object using a field with an in-correct value... that should not happen\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_retrieve_multiple_all)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct ao2_container *, objects, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_retrieve_multiple_all";
      info->category = "/main/sorcery/";
      info->summary = "sorcery multiple object retrieval unit test";
      info->description =
         "Test multiple object retrieval in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_create(sorcery, obj)) {
      ast_test_status_update(test, "Failed to create object using in-memory wizard\n");
      return AST_TEST_FAIL;
   }

   ao2_cleanup(obj);

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah2"))) {
      ast_test_status_update(test, "Failed to allocate second instance of a known object type\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_create(sorcery, obj)) {
      ast_test_status_update(test, "Failed to create second object using in-memory wizard\n");
      return AST_TEST_FAIL;
   }

   if (!(objects = ast_sorcery_retrieve_by_fields(sorcery, "test", AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL))) {
      ast_test_status_update(test, "Failed to retrieve a container of all objects\n");
      return AST_TEST_FAIL;
   } else if (ao2_container_count(objects) != 2) {
      ast_test_status_update(test, "Received a container with no objects in it when there should be some\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_retrieve_multiple_field)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct ao2_container *, objects, NULL, ao2_cleanup);
   RAII_VAR(struct ast_variable *, fields, ast_variable_new("joe", "6", ""), ast_variables_destroy);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_retrieve_multiple_field";
      info->category = "/main/sorcery/";
      info->summary = "sorcery multiple object retrieval unit test";
      info->description =
         "Test multiple object retrieval in sorcery using fields";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!fields) {
      ast_test_status_update(test, "Failed to create fields for multiple retrieve\n");
      return AST_TEST_FAIL;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   obj->joe = 6;

   if (ast_sorcery_create(sorcery, obj)) {
      ast_test_status_update(test, "Failed to create object using in-memory wizard\n");
      return AST_TEST_FAIL;
   }

   if (!(objects = ast_sorcery_retrieve_by_fields(sorcery, "test", AST_RETRIEVE_FLAG_MULTIPLE, fields))) {
      ast_test_status_update(test, "Failed to retrieve a container of all objects\n");
      return AST_TEST_FAIL;
   } else if (ao2_container_count(objects) != 1) {
      ast_test_status_update(test, "Received a container with no objects in it when there should be some\n");
      return AST_TEST_FAIL;
   }

   ao2_cleanup(objects);
   ast_variables_destroy(fields);

   if (!(fields = ast_variable_new("joe", "7", ""))) {
      ast_test_status_update(test, "Failed to create fields for multiple retrieval\n");
      return AST_TEST_FAIL;
   } else if (!(objects = ast_sorcery_retrieve_by_fields(sorcery, "test", AST_RETRIEVE_FLAG_MULTIPLE, fields))) {
      ast_test_status_update(test, "Failed to retrieve an empty container when retrieving multiple\n");
      return AST_TEST_FAIL;
   } else if (ao2_container_count(objects)) {
      ast_test_status_update(test, "Received a container with objects when there should be none in it\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_retrieve_regex)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct ao2_container *, objects, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_retrieve_regex";
      info->category = "/main/sorcery/";
      info->summary = "sorcery multiple object retrieval using regex unit test";
      info->description =
         "Test multiple object retrieval in sorcery using regular expression for matching";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah-98joe"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_create(sorcery, obj)) {
      ast_test_status_update(test, "Failed to create object using in-memory wizard\n");
      return AST_TEST_FAIL;
   }

   ao2_cleanup(obj);

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah-93joe"))) {
      ast_test_status_update(test, "Failed to allocate second instance of a known object type\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_create(sorcery, obj)) {
      ast_test_status_update(test, "Failed to create second object using in-memory wizard\n");
      return AST_TEST_FAIL;
   }

   ao2_cleanup(obj);

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "neener-93joe"))) {
      ast_test_status_update(test, "Failed to allocate third instance of a known object type\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_create(sorcery, obj)) {
      ast_test_status_update(test, "Failed to create third object using in-memory wizard\n");
      return AST_TEST_FAIL;
   }

   if (!(objects = ast_sorcery_retrieve_by_regex(sorcery, "test", "^blah-"))) {
      ast_test_status_update(test, "Failed to retrieve a container of objects\n");
      return AST_TEST_FAIL;
   } else if (ao2_container_count(objects) != 2) {
      ast_test_status_update(test, "Received a container with incorrect number of objects in it\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_update)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct test_sorcery_object *, obj2, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_update";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object update unit test";
      info->description =
         "Test object updating in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_create(sorcery, obj)) {
      ast_test_status_update(test, "Failed to create object using in-memory wizard\n");
      return AST_TEST_FAIL;
   }

   if (!(obj2 = ast_sorcery_copy(sorcery, obj))) {
      ast_test_status_update(test, "Failed to allocate a known object type for updating\n");
      return AST_TEST_FAIL;
   }

   ao2_cleanup(obj);

   if (ast_sorcery_update(sorcery, obj2)) {
      ast_test_status_update(test, "Failed to update sorcery with new object\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_retrieve_by_id(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to retrieve properly updated object\n");
      return AST_TEST_FAIL;
   } else if (obj != obj2) {
      ast_test_status_update(test, "Object retrieved is not the updated object\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_update_uncreated)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_update_uncreated";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object update unit test";
      info->description =
         "Test updating of an uncreated object in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (!ast_sorcery_update(sorcery, obj)) {
      ast_test_status_update(test, "Successfully updated an object which has not been created yet\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_delete)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_delete";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object deletion unit test";
      info->description =
         "Test object deletion in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_create(sorcery, obj)) {
      ast_test_status_update(test, "Failed to create object using in-memory wizard\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_delete(sorcery, obj)) {
      ast_test_status_update(test, "Failed to delete object using in-memory wizard\n");
      return AST_TEST_FAIL;
   }

   ao2_cleanup(obj);

   if ((obj = ast_sorcery_retrieve_by_id(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Retrieved deleted object that should not be there\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_delete_uncreated)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_delete_uncreated";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object deletion unit test";
      info->description =
         "Test object deletion of an uncreated object in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (!ast_sorcery_delete(sorcery, obj)) {
      ast_test_status_update(test, "Successfully deleted an object which was never created\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_is_stale)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct ast_sorcery_wizard *, wizard1, &test_wizard, ast_sorcery_wizard_unregister);
   RAII_VAR(struct ast_sorcery_wizard *, wizard2, &test_wizard2, ast_sorcery_wizard_unregister);
   RAII_VAR(struct test_sorcery_object *, obj1, NULL, ao2_cleanup);
   RAII_VAR(struct test_sorcery_object *, obj2, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_is_stale";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object staleness unit test";
      info->description =
         "Test whether sorcery will query a wizard correctly if asked\n"
         "if an object is stale.";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (ast_sorcery_wizard_register(&test_wizard)) {
      ast_test_status_update(test, "Failed to register a perfectly valid sorcery wizard\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_wizard_register(&test_wizard2)) {
      ast_test_status_update(test, "Failed to register a perfectly valid sorcery wizard\n");
      return AST_TEST_FAIL;
   }

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if ((ast_sorcery_apply_default(sorcery, "test", "test", NULL) != AST_SORCERY_APPLY_SUCCESS) ||
      ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, NULL)) {
      return AST_TEST_FAIL;
   }

   ast_sorcery_object_field_register_nodoc(sorcery, "test", "bob", "5", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, bob));
   ast_sorcery_object_field_register_nodoc(sorcery, "test", "joe", "10", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, joe));
   ast_sorcery_object_field_register_custom_nodoc(sorcery, "test", "jim", "444", jim_handler, NULL, jim_vl, 0, 0);
   ast_sorcery_object_field_register_custom_nodoc(sorcery, "test", "jack", "888,999", jack_handler, jack_str, NULL, 0, 0);


   if ((ast_sorcery_apply_default(sorcery, "test2", "test2", "test2data") != AST_SORCERY_APPLY_SUCCESS) ||
      ast_sorcery_internal_object_register(sorcery, "test2", test_sorcery_object_alloc, NULL, NULL)) {
      return AST_TEST_FAIL;
   }

   ast_sorcery_object_field_register_nodoc(sorcery, "test2", "bob", "5", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, bob));
   ast_sorcery_object_field_register_nodoc(sorcery, "test2", "joe", "10", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, joe));
   ast_sorcery_object_field_register_custom_nodoc(sorcery, "test2", "jim", "444", jim_handler, NULL, jim_vl, 0, 0);
   ast_sorcery_object_field_register_custom_nodoc(sorcery, "test2", "jack", "888,999", jack_handler, jack_str, NULL, 0, 0);


   if (!(obj1 = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (!(obj2 = ast_sorcery_alloc(sorcery, "test2", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   /* The 'test' wizard has no is_stale callback */
   ast_test_validate(test, ast_sorcery_is_stale(sorcery, obj1) == 0);

   /* The 'test2' wizard should return stale */
   ast_test_validate(test, ast_sorcery_is_stale(sorcery, obj2) == 1);
   ast_test_validate(test, cache.is_stale == 1);

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(caching_wizard_behavior)
{
   struct ast_flags flags = { CONFIG_FLAG_NOCACHE };
   struct ast_config *config;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct test_sorcery_object *, obj2, NULL, ao2_cleanup);
   int res = AST_TEST_FAIL;

   switch (cmd) {
   case TEST_INIT:
      info->name = "caching_wizard_behavior";
      info->category = "/main/sorcery/";
      info->summary = "sorcery caching wizard behavior unit test";
      info->description =
         "Test internal behavior of caching wizards";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(config = ast_config_load2("sorcery.conf", "test_sorcery_cache", flags))) {
      ast_test_status_update(test, "Sorcery configuration file not present - skipping caching_wizard_behavior test\n");
      return AST_TEST_NOT_RUN;
   }

   if (!ast_category_get(config, "test_sorcery_cache", NULL)) {
      ast_test_status_update(test, "Sorcery configuration file does not contain 'test_sorcery_cache' section\n");
      ast_config_destroy(config);
      return AST_TEST_NOT_RUN;
   }

   ast_config_destroy(config);

   if (ast_sorcery_wizard_register(&test_wizard)) {
      ast_test_status_update(test, "Failed to register a perfectly valid sorcery wizard\n");
      return AST_TEST_FAIL;
   }

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      goto end;
   }

   if (ast_sorcery_apply_config(sorcery, "test_sorcery_cache") != AST_SORCERY_APPLY_SUCCESS) {
      ast_test_status_update(test, "Failed to apply configured object mappings\n");
      goto end;
   }

   if (ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, NULL)) {
      ast_test_status_update(test, "Failed to register object type\n");
      goto end;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      goto end;
   }

   if (ast_sorcery_create(sorcery, obj)) {
      ast_test_status_update(test, "Failed to create object using in-memory wizard\n");
      goto end;
   }

   ao2_cleanup(obj);

   if (!(obj = ast_sorcery_retrieve_by_id(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to retrieve just created object\n");
      goto end;
   } else if (!cache.created) {
      ast_test_status_update(test, "Caching wizard was not told to cache just created object\n");
      goto end;
   } else if (!(obj2 = ast_sorcery_retrieve_by_id(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to retrieve just cached object\n");
      goto end;
   } else if (obj == obj2) {
      ast_test_status_update(test, "Returned object is *NOT* a cached object\n");
      goto end;
   } else if (ast_sorcery_update(sorcery, obj)) {
      ast_test_status_update(test, "Failed to update a known stored object\n");
      goto end;
   } else if (!cache.updated) {
      ast_test_status_update(test, "Caching wizard was not told to update object\n");
      goto end;
   } else if (ast_sorcery_delete(sorcery, obj)) {
      ast_test_status_update(test, "Failed to delete a known stored object\n");
      goto end;
   } else if (!cache.deleted) {
      ast_test_status_update(test, "Caching wizard was not told to delete object\n");
      goto end;
   }

   ao2_cleanup(obj2);

   if ((obj2 = ast_sorcery_retrieve_by_id(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Retrieved an object that should have been deleted\n");
      goto end;
   }

   res = AST_TEST_PASS;

end:
   ast_sorcery_unref(sorcery);
   sorcery = NULL;

   if (ast_sorcery_wizard_unregister(&test_wizard)) {
      ast_test_status_update(test, "Failed to unregister test sorcery wizard\n");
      return AST_TEST_FAIL;
   }

   return res;
}

AST_TEST_DEFINE(object_type_observer)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   int res = AST_TEST_FAIL;

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_type_observer";
      info->category = "/main/sorcery/";
      info->summary = "sorcery object type observer unit test";
      info->description =
         "Test that object type observers get called when they should";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!ast_sorcery_observer_add(sorcery, "test", NULL)) {
      ast_test_status_update(test, "Successfully added a NULL observer when it should not be possible\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_observer_add(sorcery, "test", &test_observer)) {
      ast_test_status_update(test, "Failed to add a proper observer\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      goto end;
   }

   ast_mutex_init(&observer.lock);
   ast_cond_init(&observer.cond, NULL);
   observer.created = NULL;
   observer.updated = NULL;
   observer.deleted = NULL;

   if (ast_sorcery_create(sorcery, obj)) {
      ast_test_status_update(test, "Failed to create object using in-memory wizard\n");
      goto end;
   }

   ast_mutex_lock(&observer.lock);
   while (!observer.created) {
        struct timeval start = ast_tvnow();
        struct timespec end = {
                .tv_sec = start.tv_sec + 10,
                .tv_nsec = start.tv_usec * 1000,
        };
      if (ast_cond_timedwait(&observer.cond, &observer.lock, &end) == ETIMEDOUT) {
         break;
      }
   }
   ast_mutex_unlock(&observer.lock);

   if (!observer.created) {
      ast_test_status_update(test, "Failed to receive observer notification for object creation within suitable timeframe\n");
      goto end;
   }

   if (ast_sorcery_update(sorcery, obj)) {
      ast_test_status_update(test, "Failed to update object using in-memory wizard\n");
      goto end;
   }

   ast_mutex_lock(&observer.lock);
   while (!observer.updated) {
        struct timeval start = ast_tvnow();
        struct timespec end = {
                .tv_sec = start.tv_sec + 10,
                .tv_nsec = start.tv_usec * 1000,
        };
      if (ast_cond_timedwait(&observer.cond, &observer.lock, &end) == ETIMEDOUT) {
         break;
      }
   }
   ast_mutex_unlock(&observer.lock);

   if (!observer.updated) {
      ast_test_status_update(test, "Failed to receive observer notification for object updating within suitable timeframe\n");
      goto end;
   }

   if (ast_sorcery_delete(sorcery, obj)) {
      ast_test_status_update(test, "Failed to delete object using in-memory wizard\n");
      goto end;
   }

   ast_mutex_lock(&observer.lock);
   while (!observer.deleted) {
        struct timeval start = ast_tvnow();
        struct timespec end = {
                .tv_sec = start.tv_sec + 10,
                .tv_nsec = start.tv_usec * 1000,
        };
      if (ast_cond_timedwait(&observer.cond, &observer.lock, &end) == ETIMEDOUT) {
         break;
      }
   }
   ast_mutex_unlock(&observer.lock);

   if (!observer.deleted) {
      ast_test_status_update(test, "Failed to receive observer notification for object deletion within suitable timeframe\n");
      goto end;
   }

   ast_sorcery_reload(sorcery);

   ast_mutex_lock(&observer.lock);
   while (!observer.loaded) {
        struct timeval start = ast_tvnow();
        struct timespec end = {
                .tv_sec = start.tv_sec + 10,
                .tv_nsec = start.tv_usec * 1000,
        };
      if (ast_cond_timedwait(&observer.cond, &observer.lock, &end) == ETIMEDOUT) {
         break;
      }
   }
   ast_mutex_unlock(&observer.lock);

   if (!observer.loaded) {
      ast_test_status_update(test, "Failed to receive observer notification for object type load within suitable timeframe\n");
      goto end;
   }

   res = AST_TEST_PASS;

end:
   observer.created = NULL;
   observer.updated = NULL;
   observer.deleted = NULL;
   ast_mutex_destroy(&observer.lock);
   ast_cond_destroy(&observer.cond);

   return res;
}

AST_TEST_DEFINE(configuration_file_wizard)
{
   struct ast_flags flags = { CONFIG_FLAG_NOCACHE };
   struct ast_config *config;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "configuration_file_wizard";
      info->category = "/main/sorcery/";
      info->summary = "sorcery configuration file wizard unit test";
      info->description =
         "Test the configuration file wizard in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(config = ast_config_load2("test_sorcery.conf", "test_sorcery", flags))) {
      ast_test_status_update(test, "Test sorcery configuration file wizard file not present - skipping configuration_file_wizard test\n");
      return AST_TEST_NOT_RUN;
   }

   ast_config_destroy(config);

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_apply_default(sorcery, "test", "config", "test_sorcery.conf") != AST_SORCERY_APPLY_SUCCESS) {
      ast_test_status_update(test, "Could not set a default wizard of the 'config' type, so skipping since it may not be loaded\n");
      return AST_TEST_NOT_RUN;
   }

   if (ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, NULL)) {
      ast_test_status_update(test, "Failed to register object type\n");
      return AST_TEST_FAIL;
   }

   ast_sorcery_object_field_register_nodoc(sorcery, "test", "bob", "5", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, bob));
   ast_sorcery_object_field_register_nodoc(sorcery, "test", "joe", "10", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, joe));

   ast_sorcery_load(sorcery);

   if ((obj = ast_sorcery_retrieve_by_id(sorcery, "test", "hey2"))) {
      ast_test_status_update(test, "Retrieved object which has an unknown field\n");
      return AST_TEST_FAIL;
   } else if (!(obj = ast_sorcery_retrieve_by_id(sorcery, "test", "hey"))) {
      ast_test_status_update(test, "Failed to retrieve a known object that has been configured in the configuration file\n");
      return AST_TEST_FAIL;
   } else if (obj->bob != 98) {
      ast_test_status_update(test, "Value of 'bob' on object is not what is configured in configuration file\n");
      return AST_TEST_FAIL;
   } else if (obj->joe != 41) {
      ast_test_status_update(test, "Value of 'joe' on object is not what is configured in configuration file\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(configuration_file_wizard_with_file_integrity)
{
   struct ast_flags flags = { CONFIG_FLAG_NOCACHE };
   struct ast_config *config;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "configuration_file_wizard_with_file_integrity";
      info->category = "/main/sorcery/";
      info->summary = "sorcery configuration file wizard file integrity unit test";
      info->description =
         "Test the configuration file wizard with file integrity turned on in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(config = ast_config_load2("test_sorcery.conf", "test_sorcery", flags))) {
      ast_test_status_update(test, "Test sorcery configuration file wizard file not present - skipping configuration_file_wizard_with_file_integrity test\n");
      return AST_TEST_NOT_RUN;
   }

   ast_config_destroy(config);

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_apply_default(sorcery, "test", "config", "test_sorcery.conf,integrity=file") != AST_SORCERY_APPLY_SUCCESS) {
      ast_test_status_update(test, "Could not set a default wizard of the 'config' type, so skipping since it may not be loaded\n");
      return AST_TEST_NOT_RUN;
   }

   if (ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, NULL)) {
      ast_test_status_update(test, "Failed to register object type\n");
      return AST_TEST_FAIL;
   }

   ast_sorcery_object_field_register_nodoc(sorcery, "test", "bob", "5", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, bob));
   ast_sorcery_object_field_register_nodoc(sorcery, "test", "joe", "10", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, joe));

   ast_sorcery_load(sorcery);

   if ((obj = ast_sorcery_retrieve_by_id(sorcery, "test", "hey"))) {
      ast_test_status_update(test, "Retrieved object which has an unknown field\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(configuration_file_wizard_with_criteria)
{
   struct ast_flags flags = { CONFIG_FLAG_NOCACHE };
   struct ast_config *config;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "configuration_file_wizard_with_criteria";
      info->category = "/main/sorcery/";
      info->summary = "sorcery configuration file wizard with criteria unit test";
      info->description =
         "Test the configuration file wizard with criteria matching in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(config = ast_config_load2("test_sorcery.conf", "test_sorcery", flags))) {
      ast_test_status_update(test, "Test sorcery configuration file wizard file not present - skipping configuration_file_wizard_with_criteria test\n");
      return AST_TEST_NOT_RUN;
   }

   ast_config_destroy(config);

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_apply_default(sorcery, "test", "config", "test_sorcery.conf,criteria=type=zombies") != AST_SORCERY_APPLY_SUCCESS) {
      ast_test_status_update(test, "Could not set a default wizard of the 'config' type, so skipping since it may not be loaded\n");
      return AST_TEST_NOT_RUN;
   }

   if (ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, NULL)) {
      ast_test_status_update(test, "Failed to register object type\n");
      return AST_TEST_FAIL;
   }

   ast_sorcery_object_field_register_nodoc(sorcery, "test", "bob", "5", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, bob));
   ast_sorcery_object_field_register_nodoc(sorcery, "test", "joe", "10", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, joe));
   ast_sorcery_object_field_register_nodoc(sorcery, "test", "type", NULL, OPT_NOOP_T, 0, NULL);

   ast_sorcery_load(sorcery);

   if ((obj = ast_sorcery_retrieve_by_id(sorcery, "test", "hey"))) {
      ast_test_status_update(test, "Retrieved object which did not match criteria\n");
      return AST_TEST_FAIL;
   } else if (!(obj = ast_sorcery_retrieve_by_id(sorcery, "test", "hey2"))) {
      ast_test_status_update(test, "Failed to retrieve a known object which matches criteria\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(configuration_file_wizard_retrieve_field)
{
   struct ast_flags flags = { CONFIG_FLAG_NOCACHE };
   struct ast_config *config;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct ast_variable *, fields, ast_variable_new("joe", "41", ""), ast_variables_destroy);

   switch (cmd) {
   case TEST_INIT:
      info->name = "configuration_file_wizard_retrieve_field";
      info->category = "/main/sorcery/";
      info->summary = "sorcery configuration file wizard field retrieval unit test";
      info->description =
         "Test the configuration file wizard retrieval using field in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(config = ast_config_load2("test_sorcery.conf", "test_sorcery", flags))) {
      ast_test_status_update(test, "Test sorcery configuration file wizard file not present - skipping configuration_file_wizard_retrieve_field test\n");
      return AST_TEST_NOT_RUN;
   }

   ast_config_destroy(config);

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_apply_default(sorcery, "test", "config", "test_sorcery.conf") != AST_SORCERY_APPLY_SUCCESS) {
      ast_test_status_update(test, "Could not set a default wizard of the 'config' type, so skipping since it may not be loaded\n");
      return AST_TEST_NOT_RUN;
   }

   if (ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, NULL)) {
      ast_test_status_update(test, "Failed to register object type\n");
      return AST_TEST_FAIL;
   }

   ast_sorcery_object_field_register_nodoc(sorcery, "test", "bob", "5", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, bob));
   ast_sorcery_object_field_register_nodoc(sorcery, "test", "joe", "10", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, joe));

   ast_sorcery_load(sorcery);

   if (!(obj = ast_sorcery_retrieve_by_fields(sorcery, "test", AST_RETRIEVE_FLAG_DEFAULT, fields))) {
      ast_test_status_update(test, "Failed to retrieve a known object that has been configured with the correct field\n");
      return AST_TEST_FAIL;
   } else if (strcmp(ast_sorcery_object_get_id(obj), "hey")) {
      ast_test_status_update(test, "Retrieved object has incorrect object id of '%s'\n", ast_sorcery_object_get_id(obj));
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(configuration_file_wizard_retrieve_multiple)
{
   struct ast_flags flags = { CONFIG_FLAG_NOCACHE };
   struct ast_config *config;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct ao2_container *, objects, NULL, ao2_cleanup);
   RAII_VAR(struct ast_variable *, fields, ast_variable_new("joe", "99", ""), ast_variables_destroy);

   switch (cmd) {
   case TEST_INIT:
      info->name = "configuration_file_wizard_retrieve_multiple";
      info->category = "/main/sorcery/";
      info->summary = "sorcery configuration file wizard multiple retrieval unit test";
      info->description =
         "Test the configuration file wizard multiple retrieval in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(config = ast_config_load2("test_sorcery.conf", "test_sorcery", flags))) {
      ast_test_status_update(test, "Test sorcery configuration file wizard file not present - skipping configuration_file_wizard_retrieve_multiple test\n");
      return AST_TEST_NOT_RUN;
   }

   ast_config_destroy(config);

   if (!fields) {
      ast_test_status_update(test, "Failed to create fields for multiple retrieve\n");
      return AST_TEST_FAIL;
   }

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_apply_default(sorcery, "test", "config", "test_sorcery.conf") != AST_SORCERY_APPLY_SUCCESS) {
      ast_test_status_update(test, "Could not set a default wizard of the 'config' type, so skipping since it may not be loaded\n");
      return AST_TEST_NOT_RUN;
   }

   if (ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, NULL)) {
      ast_test_status_update(test, "Failed to register object type\n");
      return AST_TEST_FAIL;
   }

   ast_sorcery_object_field_register_nodoc(sorcery, "test", "bob", "5", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, bob));
   ast_sorcery_object_field_register_nodoc(sorcery, "test", "joe", "10", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, joe));

   ast_sorcery_load(sorcery);

   if (!(objects = ast_sorcery_retrieve_by_fields(sorcery, "test", AST_RETRIEVE_FLAG_MULTIPLE, fields))) {
      ast_test_status_update(test, "Failed to retrieve an empty container when retrieving multiple\n");
      return AST_TEST_FAIL;
   } else if (ao2_container_count(objects)) {
      ast_test_status_update(test, "Received a container with objects when there should be none in it\n");
      return AST_TEST_FAIL;
   }

   ao2_cleanup(objects);
   ast_variables_destroy(fields);

   if (!(fields = ast_variable_new("joe", "41", ""))) {
      ast_test_status_update(test, "Failed to create fields for multiple retrieve\n");
      return AST_TEST_FAIL;
   } else if (!(objects = ast_sorcery_retrieve_by_fields(sorcery, "test", AST_RETRIEVE_FLAG_MULTIPLE, fields))) {
      ast_test_status_update(test, "Failed to retrieve a container when retrieving multiple\n");
      return AST_TEST_FAIL;
   } else if (ao2_container_count(objects) != 1) {
      ast_test_status_update(test, "Received a container with no objects in it when there should be\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(configuration_file_wizard_retrieve_multiple_all)
{
   struct ast_flags flags = { CONFIG_FLAG_NOCACHE };
   struct ast_config *config;
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct ao2_container *, objects, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "configuration_file_wizard_retrieve_multiple_all";
      info->category = "/main/sorcery/";
      info->summary = "sorcery configuration file wizard multiple retrieve all unit test";
      info->description =
         "Test the configuration file wizard multiple retrieve all in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(config = ast_config_load2("test_sorcery.conf", "test_sorcery", flags))) {
      ast_test_status_update(test, "Test sorcery configuration file wizard file not present - skipping configuration_file_wizard_retrieve_multiple_all test\n");
      return AST_TEST_NOT_RUN;
   }

   ast_config_destroy(config);

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_apply_default(sorcery, "test", "config", "test_sorcery.conf") != AST_SORCERY_APPLY_SUCCESS) {
      ast_test_status_update(test, "Could not set a default wizard of the 'config' type, so skipping since it may not be loaded\n");
      return AST_TEST_NOT_RUN;
   }

   if (ast_sorcery_internal_object_register(sorcery, "test", test_sorcery_object_alloc, NULL, NULL)) {
      ast_test_status_update(test, "Failed to register object type\n");
      return AST_TEST_FAIL;
   }

   ast_sorcery_object_field_register_nodoc(sorcery, "test", "bob", "5", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, bob));
   ast_sorcery_object_field_register_nodoc(sorcery, "test", "joe", "10", OPT_UINT_T, 0, FLDSET(struct test_sorcery_object, joe));

   ast_sorcery_load(sorcery);

   if (!(objects = ast_sorcery_retrieve_by_fields(sorcery, "test", AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL))) {
      ast_test_status_update(test, "Failed to retrieve a container with all objects when there should be one\n");
      return AST_TEST_FAIL;
   } else if (ao2_container_count(objects) != 2) {
      ast_test_status_update(test, "Returned container does not have the correct number of objects in it\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(dialplan_function)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   RAII_VAR(struct ast_variable *, objset, NULL, ast_variables_destroy);
   struct ast_str *buf;
   char expression[256];

   switch (cmd) {
   case TEST_INIT:
      info->name = "dialplan_function";
      info->category = "/main/sorcery/";
      info->summary = "AST_SORCERY dialplan function";
      info->description =
         "Test the AST_SORCERY dialplan function";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   if (!(obj = ast_sorcery_alloc(sorcery, "test", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_create(sorcery, obj)) {
      ast_test_status_update(test, "Failed to create a known object type\n");
      return AST_TEST_FAIL;
   }

   if (!(buf = ast_str_create(16))) {
      ast_test_status_update(test, "Failed to allocate return buffer\n");
      return AST_TEST_FAIL;
   }

   ast_str_reset(buf);
   snprintf(expression, sizeof(expression), "AST_SORCERY(%s,%s,%s,%s)", "notest_sorcery", "test", "blah", "bob");
   if (!ast_func_read2(NULL, expression, &buf, 16)) {
      ast_free(buf);
      ast_test_status_update(test, "Retrieved a non-existent module\n");
      return AST_TEST_FAIL;
   }

   ast_str_reset(buf);
   snprintf(expression, sizeof(expression), "AST_SORCERY(%s,%s,%s,%s)", "test_sorcery", "notest", "blah", "bob");
   if (!ast_func_read2(NULL, expression, &buf, 16)) {
      ast_free(buf);
      ast_test_status_update(test, "Retrieved a non-existent type\n");
      return AST_TEST_FAIL;
   }

   ast_str_reset(buf);
   snprintf(expression, sizeof(expression), "AST_SORCERY(%s,%s,%s,%s)", "test_sorcery", "test", "noid", "bob");
   if (!ast_func_read2(NULL, expression, &buf, 16)) {
      ast_free(buf);
      ast_test_status_update(test, "Retrieved a non-existent id\n");
      return AST_TEST_FAIL;
   }

   ast_str_reset(buf);
   snprintf(expression, sizeof(expression), "AST_SORCERY(%s,%s,%s,%s)", "test_sorcery", "test", "blah", "nobob");
   if (!ast_func_read2(NULL, expression, &buf, 16)) {
      ast_free(buf);
      ast_test_status_update(test, "Retrieved a non-existent field\n");
      return AST_TEST_FAIL;
   }

   ast_str_reset(buf);
   snprintf(expression, sizeof(expression), "AST_SORCERY(%s,%s,%s,%s)", "test_sorcery", "test", "blah", "bob");
   if (ast_func_read2(NULL, expression, &buf, 16)) {
      ast_free(buf);
      ast_test_status_update(test, "Failed retrieve field 'bob'\n");
      return AST_TEST_FAIL;
   }
   if (strcmp(ast_str_buffer(buf), "5")) {
      ast_free(buf);
      ast_test_status_update(test, "Failed retrieve field.  Got '%u', should be '5'\n", obj->bob);
      return AST_TEST_FAIL;
   }

   ast_str_reset(buf);
   snprintf(expression, sizeof(expression), "AST_SORCERY(%s,%s,%s,%s,single,1)", "test_sorcery", "test", "blah", "bob");
   if (ast_func_read2(NULL, expression, &buf, 16)) {
      ast_free(buf);
      ast_test_status_update(test, "Failed retrieve field 'bob'\n");
      return AST_TEST_FAIL;
   }
   if (strcmp(ast_str_buffer(buf), "5")) {
      ast_free(buf);
      ast_test_status_update(test, "Failed retrieve field.  Got '%u', should be '5'\n", obj->bob);
      return AST_TEST_FAIL;
   }

   ast_str_reset(buf);
   snprintf(expression, sizeof(expression), "AST_SORCERY(%s,%s,%s,%s,single,2)", "test_sorcery", "test", "blah", "bob");
   if (!ast_func_read2(NULL, expression, &buf, 16)) {
      ast_free(buf);
      ast_test_status_update(test, "Got a second 'bob' and shouldn't have\n");
      return AST_TEST_FAIL;
   }

   /* 444 is already the first item in the list */
   jim_handler(NULL, ast_variable_new("jim", "555", ""), obj);
   jim_handler(NULL, ast_variable_new("jim", "666", ""), obj);

   ast_str_reset(buf);
   snprintf(expression, sizeof(expression), "AST_SORCERY(%s,%s,%s,%s)", "test_sorcery", "test", "blah", "jim");
   if (ast_func_read2(NULL, expression, &buf, 16)) {
      ast_free(buf);
      ast_test_status_update(test, "Couldn't retrieve 'jim'\n");
      return AST_TEST_FAIL;
   }
   if (strcmp(ast_str_buffer(buf), "444,555,666")) {
      ast_free(buf);
      ast_test_status_update(test, "Failed retrieve jim.  Got '%s', should be '444,555,666'\n", ast_str_buffer(buf));
      return AST_TEST_FAIL;
   }

   ast_str_reset(buf);
   snprintf(expression, sizeof(expression), "AST_SORCERY(%s,%s,%s,%s,single,2)", "test_sorcery", "test", "blah", "jim");
   if (ast_func_read2(NULL, expression, &buf, 16)) {
      ast_free(buf);
      ast_test_status_update(test, "Couldn't retrieve 2nd jim\n");
      return AST_TEST_FAIL;
   }
   if (strcmp(ast_str_buffer(buf), "555")) {
      ast_free(buf);
      ast_test_status_update(test, "Failed retrieve 2nd jim.  Got '%s', should be '555'\n", ast_str_buffer(buf));
      return AST_TEST_FAIL;
   }

   ast_str_reset(buf);
   snprintf(expression, sizeof(expression), "AST_SORCERY(%s,%s,%s,%s,concat,|)", "test_sorcery", "test", "blah", "jim");
   if (ast_func_read2(NULL, expression, &buf, 16)) {
      ast_free(buf);
      ast_test_status_update(test, "Couldn't retrieve any 'jim'\n");
      return AST_TEST_FAIL;
   }
   if (strcmp(ast_str_buffer(buf), "444|555|666")) {
      ast_free(buf);
      ast_test_status_update(test, "Failed retrieve 'jim'.  Got '%s', should be '444|555|666'\n", ast_str_buffer(buf));
      return AST_TEST_FAIL;
   }

   ast_str_reset(buf);
   snprintf(expression, sizeof(expression), "AST_SORCERY(%s,%s,%s,%s,noconcat,3)", "test_sorcery", "test", "blah", "jim");
   if (!ast_func_read2(NULL, expression, &buf, 16)) {
      ast_free(buf);
      ast_test_status_update(test, "Should have failed with invalid retrieval_type\n");
      return AST_TEST_FAIL;
   }

   ast_str_reset(buf);
   snprintf(expression, sizeof(expression), "AST_SORCERY(%s,%s,%s,%s,single,|)", "test_sorcery", "test", "blah", "jim");
   if (!ast_func_read2(NULL, expression, &buf, 16)) {
      ast_free(buf);
      ast_test_status_update(test, "Should have failed with invalid occurrence_number\n");
      return AST_TEST_FAIL;
   }

   ast_free(buf);

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(object_field_registered)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct ast_sorcery_object_type *, object_type, NULL, ao2_cleanup);

   switch (cmd) {
   case TEST_INIT:
      info->name = "object_field_registered";
      info->category = "/main/sorcery/";
      info->summary = "ast_sorcery_is_object_field_registered unit test";
      info->description =
         "Test ast_sorcery_is_object_field_registered in sorcery";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!(sorcery = alloc_and_initialize_sorcery())) {
      ast_test_status_update(test, "Failed to open sorcery structure\n");
      return AST_TEST_FAIL;
   }

   object_type = ast_sorcery_get_object_type(sorcery, "test");

   ast_sorcery_object_fields_register(sorcery, "test", "^prefix/.", test_sorcery_regex_handler, test_sorcery_regex_fields);

   ast_test_validate(test, ast_sorcery_is_object_field_registered(object_type, "joe"));
   ast_test_validate(test, ast_sorcery_is_object_field_registered(object_type, "bob"));
   ast_test_validate(test, ast_sorcery_is_object_field_registered(object_type, "@joebob"));
   ast_test_validate(test, ast_sorcery_is_object_field_registered(object_type, "prefix/goober"));

   ast_test_validate(test, !ast_sorcery_is_object_field_registered(object_type, "joebob"));
   ast_test_validate(test, !ast_sorcery_is_object_field_registered(object_type, "prefix/"));
   ast_test_validate(test, !ast_sorcery_is_object_field_registered(object_type, "goober"));

   ast_sorcery_object_fields_register(sorcery, "test", "^", test_sorcery_regex_handler, test_sorcery_regex_fields);

   ast_test_validate(test, ast_sorcery_is_object_field_registered(object_type, "goober"));

   return AST_TEST_PASS;
}

static int event_observed;

static void wizard_observer(const char *name, const struct ast_sorcery_wizard *wizard)
{
   if (!strcmp(wizard->name, "test")) {
      event_observed = 1;
   }
}

static void instance_observer(const char *name, struct ast_sorcery *sorcery)
{
   if (!strcmp(name, "test_sorcery")) {
      event_observed = 1;
   }
}

AST_TEST_DEFINE(global_observation)
{
   RAII_VAR(struct ast_sorcery_wizard *, wizard, &test_wizard, ast_sorcery_wizard_unregister);
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   const struct ast_sorcery_global_observer observer = {
      .wizard_registered = wizard_observer,
      .instance_created = instance_observer,
      .wizard_unregistering = wizard_observer,
      .instance_destroying = instance_observer,
   };

   switch (cmd) {
   case TEST_INIT:
      info->name = "global_observation";
      info->category = "/main/sorcery/";
      info->summary = "global sorcery observation test";
      info->description =
         "Test observation of sorcery (global)";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   ast_sorcery_global_observer_add(&observer);

   event_observed = 0;
   ast_sorcery_wizard_register(wizard);
   ast_test_validate(test, (event_observed == 1), "Wizard registered failed");

   event_observed = 0;
   ast_sorcery_wizard_unregister(wizard);
   ast_test_validate(test, (event_observed == 1), "Wizard unregistered failed");

   event_observed = 0;
   sorcery = ast_sorcery_open();
   ast_test_validate(test, (event_observed == 1), "Instance created failed");

   event_observed = 0;
   ast_sorcery_unref(sorcery);
   sorcery = NULL;
   ast_test_validate(test, (event_observed == 1), "Instance destroyed failed");

   ast_sorcery_global_observer_remove(&observer);
   event_observed = 0;
   ast_sorcery_wizard_register(&test_wizard);
   ast_test_validate(test, (event_observed == 0), "Observer removed failed");

   return AST_TEST_PASS;
}

static void instance_loaded_observer(const char *name, const struct ast_sorcery *sorcery,
   int reloaded)
{
   if (!strcmp(name, "test_sorcery") && !reloaded) {
      event_observed++;
   }
}

static void instance_reloaded_observer(const char *name,
   const struct ast_sorcery *sorcery, int reloaded)
{
   if (!strcmp(name, "test_sorcery") && reloaded) {
      event_observed++;
   }
}

static void wizard_mapped_observer(const char *name, struct ast_sorcery *sorcery,
   const char *object_type, struct ast_sorcery_wizard *wizard,
   const char *wizard_args, void *wizard_data)
{
   if (!strcmp(name, "test_sorcery") && !strcmp(object_type, "test_object_type")
      && !strcmp(wizard->name, "memory") && !strcmp(wizard_args, "memwiz")) {
      event_observed++;
   }
}

static void object_type_registered_observer(const char *name,
   struct ast_sorcery *sorcery, const char *object_type)
{
   if (!strcmp(name, "test_sorcery") && !strcmp(object_type, "test_object_type")) {
      event_observed++;
   }
}

static void object_type_loaded_observer(const char *name,
   const struct ast_sorcery *sorcery, const char *object_type, int reloaded)
{
   if (!strcmp(name, "test_sorcery") && !strcmp(object_type, "test_object_type")
      && !reloaded) {
      event_observed++;
   }
}

static void object_type_reloaded_observer(const char *name,
   const struct ast_sorcery *sorcery, const char *object_type, int reloaded)
{
   if (!strcmp(name, "test_sorcery") && !strcmp(object_type, "test_object_type")
      && reloaded) {
      event_observed++;
   }
}

AST_TEST_DEFINE(instance_observation)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   struct ast_sorcery_instance_observer observer = {
      .wizard_mapped = wizard_mapped_observer,
      .object_type_registered = object_type_registered_observer,
   };

   switch (cmd) {
   case TEST_INIT:
      info->name = "instance_observation";
      info->category = "/main/sorcery/";
      info->summary = "sorcery instance observation test";
      info->description =
         "Test observation of sorcery (instance)";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   /* Test instance load */
   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open a sorcery instance\n");
      return AST_TEST_FAIL;
   }
   observer.instance_loading = instance_loaded_observer;
   observer.instance_loaded = instance_loaded_observer;
   ast_sorcery_instance_observer_add(sorcery, &observer);
   event_observed = 0;
   ast_sorcery_load(sorcery);
   ast_test_validate(test, (event_observed == 2), "Instance loaded failed");
   event_observed = 0;
   ast_sorcery_reload(sorcery);
   ast_test_validate(test, (event_observed == 0), "Instance reloaded failed");

   /* Test instance reload */
   ast_sorcery_instance_observer_remove(sorcery, &observer);
   observer.instance_loading = instance_reloaded_observer;
   observer.instance_loaded = instance_reloaded_observer;
   ast_sorcery_instance_observer_add(sorcery, &observer);
   event_observed = 0;
   ast_sorcery_load(sorcery);
   ast_test_validate(test, (event_observed == 0), "Instance loaded failed");
   event_observed = 0;
   ast_sorcery_reload(sorcery);
   ast_test_validate(test, (event_observed == 2), "Instance reloaded failed");

   /* Test wizard mapping */
   event_observed = 0;
   ast_sorcery_apply_default(sorcery, "test_object_type", "memory", "memwiz");
   ast_test_validate(test, (event_observed == 1), "Wizard mapping failed");

   /* Test object type register */
   event_observed = 0;
   ast_sorcery_internal_object_register(sorcery, "test_object_type",
      test_sorcery_object_alloc, NULL, NULL);
   ast_test_validate(test, (event_observed == 1), "Object type registered failed");

   /* Test object type load */
   ast_sorcery_instance_observer_remove(sorcery, &observer);
   observer.object_type_loading = object_type_loaded_observer;
   observer.object_type_loaded = object_type_loaded_observer;
   ast_sorcery_instance_observer_add(sorcery, &observer);
   event_observed = 0;
   ast_sorcery_load_object(sorcery, "test_object_type");
   ast_test_validate(test, (event_observed == 2), "Object type loaded failed");
   event_observed = 0;
   ast_sorcery_reload_object(sorcery, "test_object_type");
   ast_test_validate(test, (event_observed == 0), "Object type reloaded failed");

   /* Test object type reload */
   ast_sorcery_instance_observer_remove(sorcery, &observer);
   observer.object_type_loading = object_type_reloaded_observer;
   observer.object_type_loaded = object_type_reloaded_observer;
   ast_sorcery_instance_observer_add(sorcery, &observer);
   event_observed = 0;
   ast_sorcery_load_object(sorcery, "test_object_type");
   ast_test_validate(test, (event_observed == 0), "Object type loaded failed");
   event_observed = 0;
   ast_sorcery_reload_object(sorcery, "test_object_type");
   ast_test_validate(test, (event_observed == 2), "Object type reloaded failed");

   ast_sorcery_instance_observer_remove(sorcery, &observer);
   event_observed = 0;
   ast_sorcery_apply_default(sorcery, "test_object_type", "memory", "memwiz");
   ast_test_validate(test, (event_observed == 0), "Observer remove failed");

   return AST_TEST_PASS;
}

static void wizard_loaded_observer(const char *name,
   const struct ast_sorcery_wizard *wizard, const char *object_type, int reloaded)
{
   if (!strcmp(name, "test") && !strcmp(object_type, "test_object_type")
      && !reloaded) {
      event_observed++;
   }
}

static void sorcery_test_load(void *data, const struct ast_sorcery *sorcery, const char *type)
{
   return;
}

static void wizard_reloaded_observer(const char *name,
   const struct ast_sorcery_wizard *wizard, const char *object_type, int reloaded)
{
   if (!strcmp(name, "test") && !strcmp(object_type, "test_object_type")
      && reloaded) {
      event_observed++;
   }
}

AST_TEST_DEFINE(wizard_observation)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct ast_sorcery_wizard *, wizard, &test_wizard, ast_sorcery_wizard_unregister);
   struct ast_sorcery_wizard_observer observer = {
      .wizard_loading = wizard_loaded_observer,
      .wizard_loaded = wizard_loaded_observer,
   };

   switch (cmd) {
   case TEST_INIT:
      info->name = "wizard_observation";
      info->category = "/main/sorcery/";
      info->summary = "sorcery wizard observation test";
      info->description =
         "Test observation of sorcery (wizard)";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   wizard->load = sorcery_test_load;
   wizard->reload = sorcery_test_load;

   /* Test wizard observer remove and wizard unregister */
   ast_sorcery_wizard_register(wizard);
   ast_sorcery_wizard_observer_add(wizard, &observer);
   ast_sorcery_wizard_observer_remove(wizard, &observer);
   event_observed = 0;
   ast_sorcery_wizard_unregister(wizard);
   ast_test_validate(test, (event_observed == 0), "Wizard observer removed failed");

   /* Setup for test loaded and reloaded */
   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open a sorcery instance\n");
      return AST_TEST_FAIL;
   }

   ast_sorcery_wizard_register(wizard);
   ast_sorcery_apply_default(sorcery, "test_object_type", "test", NULL);
   ast_sorcery_internal_object_register(sorcery, "test_object_type",
      test_sorcery_object_alloc, NULL, NULL);

   /* Test wizard loading and loaded */
   ast_sorcery_wizard_observer_add(wizard, &observer);

   event_observed = 0;
   ast_sorcery_load_object(sorcery, "test_object_type");
   ast_test_validate(test, (event_observed == 2), "Wizard loaded failed");

   event_observed = 0;
   ast_sorcery_reload_object(sorcery, "test_object_type");
   ast_sorcery_wizard_observer_remove(wizard, &observer);
   ast_test_validate(test, (event_observed == 0), "Wizard reloaded failed");

   /* Test wizard reloading and reloaded */
   observer.wizard_loading = wizard_reloaded_observer;
   observer.wizard_loaded = wizard_reloaded_observer;
   ast_sorcery_wizard_observer_add(wizard, &observer);

   event_observed = 0;
   ast_sorcery_load_object(sorcery, "test_object_type");
   ast_test_validate(test, (event_observed == 0), "Wizard loaded failed");

   event_observed = 0;
   ast_sorcery_reload_object(sorcery, "test_object_type");
   ast_sorcery_wizard_observer_remove(wizard, &observer);
   ast_test_validate(test, (event_observed == 2), "Wizard reloaded failed");

   return AST_TEST_PASS;
}

AST_TEST_DEFINE(wizard_apply_and_insert)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct ast_sorcery_wizard *, wizard1, &test_wizard, ast_sorcery_wizard_unregister);
   RAII_VAR(struct ast_sorcery_wizard *, wizard2, &test_wizard2, ast_sorcery_wizard_unregister);
   RAII_VAR(struct ast_sorcery_wizard *, wizard, NULL, ao2_cleanup);
   void *data;

   switch (cmd) {
   case TEST_INIT:
      info->name = "wizard_apply_and_insert";
      info->category = "/main/sorcery/";
      info->summary = "sorcery wizard apply and insert test";
      info->description =
         "sorcery wizard apply and insert test";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   wizard1->load = sorcery_test_load;
   wizard1->reload = sorcery_test_load;

   wizard2->load = sorcery_test_load;
   wizard2->reload = sorcery_test_load;

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open a sorcery instance\n");
      return AST_TEST_FAIL;
   }

   ast_sorcery_wizard_register(wizard1);
   ast_sorcery_wizard_register(wizard2);

   /* test_object_type isn't registered yet so count should return error */
   ast_test_validate(test,
      ast_sorcery_get_wizard_mapping_count(sorcery, "test_object_type") == -1);

   ast_sorcery_apply_default(sorcery, "test_object_type", "test", NULL);

   ast_test_validate(test,
      ast_sorcery_get_wizard_mapping_count(sorcery, "test_object_type") == 1);

   ast_test_validate(test,
      ast_sorcery_get_wizard_mapping(sorcery, "test_object_type", 0, &wizard, NULL) == 0);
   ast_test_validate(test, strcmp("test", wizard->name) == 0);
   ao2_ref(wizard, -1);
   wizard = NULL;

   ast_test_validate(test,
      ast_sorcery_insert_wizard_mapping(sorcery, "test_object_type", "test2", "test2data", 0, 0) == 0);

   ast_test_validate(test,
      ast_sorcery_insert_wizard_mapping(sorcery, "test_object_type", "test2", "test2data", 0, 0) != 0);

   ast_test_validate(test,
      ast_sorcery_object_type_insert_wizard(sorcery, "test_object_type", "test2", "test2data2",
         AST_SORCERY_WIZARD_APPLY_ALLOW_DUPLICATE, 0, NULL, NULL) == 0);

   ast_test_validate(test,
      ast_sorcery_object_type_remove_wizard(sorcery, "test_object_type", "test2", "test2data2") == 0);

   ast_test_validate(test,
      ast_sorcery_get_wizard_mapping(sorcery, "test_object_type", 0, &wizard, &data) == 0);
   ast_test_validate(test, strcmp("test2", wizard->name) == 0);
   ast_test_validate(test, strcmp("test2data", data) == 0);
   ao2_ref(wizard, -1);
   wizard = NULL;

   ast_test_validate(test,
      ast_sorcery_get_wizard_mapping(sorcery, "test_object_type", 1, &wizard, NULL) == 0);
   ast_test_validate(test, strcmp("test", wizard->name) == 0);
   ao2_ref(wizard, -1);
   wizard = NULL;

   /* Test failures */
   ast_test_validate(test,
      ast_sorcery_get_wizard_mapping(sorcery, "non-existent-type", 0, &wizard, NULL) != 0);

   ast_test_validate(test,
      ast_sorcery_get_wizard_mapping(sorcery, "test_object_type", -1, &wizard, &data) != 0);

   ast_test_validate(test,
      ast_sorcery_get_wizard_mapping(sorcery, "test_object_type", 2, &wizard, NULL) != 0);

   ast_test_validate(test,
      ast_sorcery_get_wizard_mapping(sorcery, "test_object_type", 2, NULL, NULL) != 0);

   /* Test remove */
   /* Should fail */
   ast_test_validate(test,
      ast_sorcery_remove_wizard_mapping(sorcery, "non-existent-type", "somewizard") != 0);
   ast_test_validate(test,
      ast_sorcery_remove_wizard_mapping(sorcery, "test_object_type", "somewizard") != 0);

   /* should work */
   ast_test_validate(test,
      ast_sorcery_remove_wizard_mapping(sorcery, "test_object_type", "test") == 0);

   ast_test_validate(test,
      ast_sorcery_get_wizard_mapping_count(sorcery, "test_object_type") == 1);

   ast_test_validate(test,
      ast_sorcery_get_wizard_mapping(sorcery, "test_object_type", 0, &wizard, &data) == 0);
   ast_test_validate(test, strcmp("test2", wizard->name) == 0);
   ast_test_validate(test, strcmp("test2data", data) == 0);
   ao2_ref(wizard, -1);
   wizard = NULL;

   return AST_TEST_PASS;
}

static struct ast_sorcery_wizard test_read_only_wizard = {
   .name = "test-read-only",
   .retrieve_id = sorcery_test_retrieve_id,
};

AST_TEST_DEFINE(wizard_read_only)
{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct ast_sorcery_wizard *, wizard_read_only, &test_read_only_wizard, ast_sorcery_wizard_unregister);
   RAII_VAR(struct ast_sorcery_wizard *, wizard1, &test_wizard, ast_sorcery_wizard_unregister);
   RAII_VAR(struct test_sorcery_object *, obj, NULL, ao2_cleanup);
   struct ast_sorcery_wizard *wizard;

   switch (cmd) {
   case TEST_INIT:
      info->name = "wizard_read_only";
      info->category = "/main/sorcery/";
      info->summary = "sorcery wizard read-only test";
      info->description =
         "sorcery wizard read-only test";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   wizard1->load = sorcery_test_load;
   wizard1->reload = sorcery_test_load;

   if (!(sorcery = ast_sorcery_open())) {
      ast_test_status_update(test, "Failed to open a sorcery instance\n");
      return AST_TEST_FAIL;
   }

   ast_sorcery_wizard_register(wizard_read_only);
   ast_sorcery_wizard_register(wizard1);

   if ((ast_sorcery_apply_default(sorcery, "test_object_type", "test-read-only", NULL) != AST_SORCERY_APPLY_SUCCESS) ||
      ast_sorcery_internal_object_register(sorcery, "test_object_type", test_sorcery_object_alloc, NULL, NULL)) {
      ast_test_status_update(test, "Failed to apply object defaults\n");
      return AST_TEST_FAIL;
   }

   ast_test_validate(test,
      ast_sorcery_get_wizard_mapping_count(sorcery, "test_object_type") == 1);

   ast_test_validate(test,
      ast_sorcery_object_type_apply_wizard(sorcery, "test_object_type",
         "test", "test2data", AST_SORCERY_WIZARD_APPLY_READONLY, &wizard, NULL) == 0);

   ast_test_validate(test, strcmp(wizard->name, wizard1->name) == 0);

   ast_test_validate(test,
      ast_sorcery_get_wizard_mapping_count(sorcery, "test_object_type") == 2);

   if (!(obj = ast_sorcery_alloc(sorcery, "test_object_type", "blah"))) {
      ast_test_status_update(test, "Failed to allocate a known object type\n");
      return AST_TEST_FAIL;
   }

   if (ast_sorcery_create(sorcery, obj) == 0) {
      ast_test_status_update(test, "Should not have created object using read-only wizard\n");
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

static int unload_module(void)
{
   AST_TEST_UNREGISTER(wizard_registration);
   AST_TEST_UNREGISTER(sorcery_open);
   AST_TEST_UNREGISTER(apply_default);
   AST_TEST_UNREGISTER(apply_config);
   AST_TEST_UNREGISTER(object_register);
   AST_TEST_UNREGISTER(object_register_without_mapping);
   AST_TEST_UNREGISTER(object_field_register);
   AST_TEST_UNREGISTER(object_fields_register);
   AST_TEST_UNREGISTER(object_alloc_with_id);
   AST_TEST_UNREGISTER(object_alloc_without_id);
   AST_TEST_UNREGISTER(object_copy);
   AST_TEST_UNREGISTER(object_copy_native);
   AST_TEST_UNREGISTER(object_diff);
   AST_TEST_UNREGISTER(object_diff_native);
   AST_TEST_UNREGISTER(objectset_create);
   AST_TEST_UNREGISTER(objectset_json_create);
   AST_TEST_UNREGISTER(objectset_create_regex);
   AST_TEST_UNREGISTER(objectset_apply);
   AST_TEST_UNREGISTER(objectset_apply_handler);
   AST_TEST_UNREGISTER(objectset_apply_invalid);
   AST_TEST_UNREGISTER(objectset_transform);
   AST_TEST_UNREGISTER(objectset_apply_fields);
   AST_TEST_UNREGISTER(extended_fields);
   AST_TEST_UNREGISTER(changeset_create);
   AST_TEST_UNREGISTER(changeset_create_unchanged);
   AST_TEST_UNREGISTER(object_create);
   AST_TEST_UNREGISTER(object_retrieve_id);
   AST_TEST_UNREGISTER(object_retrieve_field);
   AST_TEST_UNREGISTER(object_retrieve_multiple_all);
   AST_TEST_UNREGISTER(object_retrieve_multiple_field);
   AST_TEST_UNREGISTER(object_retrieve_regex);
   AST_TEST_UNREGISTER(object_update);
   AST_TEST_UNREGISTER(object_update_uncreated);
   AST_TEST_UNREGISTER(object_delete);
   AST_TEST_UNREGISTER(object_delete_uncreated);
   AST_TEST_UNREGISTER(object_is_stale);
   AST_TEST_UNREGISTER(caching_wizard_behavior);
   AST_TEST_UNREGISTER(object_type_observer);
   AST_TEST_UNREGISTER(configuration_file_wizard);
   AST_TEST_UNREGISTER(configuration_file_wizard_with_file_integrity);
   AST_TEST_UNREGISTER(configuration_file_wizard_with_criteria);
   AST_TEST_UNREGISTER(configuration_file_wizard_retrieve_field);
   AST_TEST_UNREGISTER(configuration_file_wizard_retrieve_multiple);
   AST_TEST_UNREGISTER(configuration_file_wizard_retrieve_multiple_all);
   AST_TEST_UNREGISTER(dialplan_function);
   AST_TEST_UNREGISTER(object_field_registered);
   AST_TEST_UNREGISTER(global_observation);
   AST_TEST_UNREGISTER(instance_observation);
   AST_TEST_UNREGISTER(wizard_observation);
   AST_TEST_UNREGISTER(wizard_apply_and_insert);
   AST_TEST_UNREGISTER(wizard_read_only);

   return 0;
}

static int load_module(void)
{
   AST_TEST_REGISTER(wizard_apply_and_insert);
   AST_TEST_REGISTER(wizard_registration);
   AST_TEST_REGISTER(sorcery_open);
   AST_TEST_REGISTER(apply_default);
   AST_TEST_REGISTER(apply_config);
   AST_TEST_REGISTER(object_register);
   AST_TEST_REGISTER(object_register_without_mapping);
   AST_TEST_REGISTER(object_field_register);
   AST_TEST_REGISTER(object_fields_register);
   AST_TEST_REGISTER(object_alloc_with_id);
   AST_TEST_REGISTER(object_alloc_without_id);
   AST_TEST_REGISTER(object_copy);
   AST_TEST_REGISTER(object_copy_native);
   AST_TEST_REGISTER(object_diff);
   AST_TEST_REGISTER(object_diff_native);
   AST_TEST_REGISTER(objectset_create);
   AST_TEST_REGISTER(objectset_json_create);
   AST_TEST_REGISTER(objectset_create_regex);
   AST_TEST_REGISTER(objectset_apply);
   AST_TEST_REGISTER(objectset_apply_handler);
   AST_TEST_REGISTER(objectset_apply_invalid);
   AST_TEST_REGISTER(objectset_transform);
   AST_TEST_REGISTER(objectset_apply_fields);
   AST_TEST_REGISTER(extended_fields);
   AST_TEST_REGISTER(changeset_create);
   AST_TEST_REGISTER(changeset_create_unchanged);
   AST_TEST_REGISTER(object_create);
   AST_TEST_REGISTER(object_retrieve_id);
   AST_TEST_REGISTER(object_retrieve_field);
   AST_TEST_REGISTER(object_retrieve_multiple_all);
   AST_TEST_REGISTER(object_retrieve_multiple_field);
   AST_TEST_REGISTER(object_retrieve_regex);
   AST_TEST_REGISTER(object_update);
   AST_TEST_REGISTER(object_update_uncreated);
   AST_TEST_REGISTER(object_delete);
   AST_TEST_REGISTER(object_delete_uncreated);
   AST_TEST_REGISTER(object_is_stale);
   AST_TEST_REGISTER(caching_wizard_behavior);
   AST_TEST_REGISTER(object_type_observer);
   AST_TEST_REGISTER(configuration_file_wizard);
   AST_TEST_REGISTER(configuration_file_wizard_with_file_integrity);
   AST_TEST_REGISTER(configuration_file_wizard_with_criteria);
   AST_TEST_REGISTER(configuration_file_wizard_retrieve_field);
   AST_TEST_REGISTER(configuration_file_wizard_retrieve_multiple);
   AST_TEST_REGISTER(configuration_file_wizard_retrieve_multiple_all);
   AST_TEST_REGISTER(dialplan_function);
   AST_TEST_REGISTER(object_field_registered);
   AST_TEST_REGISTER(global_observation);
   AST_TEST_REGISTER(instance_observation);
   AST_TEST_REGISTER(wizard_observation);
   AST_TEST_REGISTER(wizard_read_only);

   return AST_MODULE_LOAD_SUCCESS;
}

AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Sorcery test module");