test_ari_model.c File Reference

Test the native ARI JSON validators. More...

#include "asterisk.h"
#include "asterisk/utils.h"
#include "asterisk/module.h"
#include "asterisk/test.h"
#include "../res/ari/ari_model_validators.h"

Include dependency graph for test_ari_model.c:

Go to the source code of this file.

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
	AST_TEST_DEFINE (validate_byte)
	AST_TEST_DEFINE (validate_boolean)
	AST_TEST_DEFINE (validate_int)
	AST_TEST_DEFINE (validate_long)
	AST_TEST_DEFINE (validate_string)
	AST_TEST_DEFINE (validate_date)
	AST_TEST_DEFINE (validate_list)
static int	load_module (void)
static int	unload_module (void)
static int	wrap_ast_ari_validate_int (struct ast_json *json)
static int	wrap_ast_ari_validate_string (struct ast_json *json)

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

Detailed Description

Test the native ARI JSON validators.

Author

David M. Lee, II dlee@.nosp@m.digi.nosp@m.um.co.nosp@m.m

Definition in file test_ari_model.c.

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 460 of file test_ari_model.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 460 of file test_ari_model.c.

AST_MODULE_SELF_SYM()

struct ast_module* AST_MODULE_SELF_SYM

(

void

)

Definition at line 460 of file test_ari_model.c.

AST_TEST_DEFINE() [1/7]

AST_TEST_DEFINE

(

validate_byte

)

Definition at line 65 of file test_ari_model.c.

References ast_ari_validate_byte(), ast_json_integer_create(), ast_json_integer_set(), ast_json_null(), ast_json_string_create(), ast_json_string_set(), ast_json_unref(), AST_TEST_NOT_RUN, AST_TEST_PASS, sip_to_pjsip::info(), NULL, RAII_VAR, str, TEST_EXECUTE, and TEST_INIT.

{
   RAII_VAR(struct ast_json *, uut, NULL, ast_json_unref);
   RAII_VAR(struct ast_json *, str, NULL, ast_json_unref);
   int res;

   switch (cmd) {
   case TEST_INIT:
      info->name = __func__;
      info->category = "/ari/validators/";
      info->summary = "Test byte validation";
      info->description =
         "Test byte validation";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   uut = ast_json_integer_create(-128);
   ast_test_validate(test, NULL != uut);
   ast_test_validate(test, ast_ari_validate_byte(uut));

   res = ast_json_integer_set(uut, 0);
   ast_test_validate(test, 0 == res);
   ast_test_validate(test, ast_ari_validate_byte(uut));

   res = ast_json_integer_set(uut, 255);
   ast_test_validate(test, 0 == res);
   ast_test_validate(test, ast_ari_validate_byte(uut));

   res = ast_json_integer_set(uut, -129);
   ast_test_validate(test, 0 == res);
   ast_test_validate(test, !ast_ari_validate_byte(uut));

   res = ast_json_integer_set(uut, 256);
   ast_test_validate(test, 0 == res);
   ast_test_validate(test, !ast_ari_validate_byte(uut));

   str = ast_json_string_create("not a byte");
   ast_test_validate(test, NULL != str);
   ast_test_validate(test, !ast_ari_validate_byte(str));

   /* Even if the string has an integral value */
   res = ast_json_string_set(str, "0");
   ast_test_validate(test, 0 == res);
   ast_test_validate(test, !ast_ari_validate_byte(str));

   ast_test_validate(test, !ast_ari_validate_byte(ast_json_null()));

   return AST_TEST_PASS;
}

AST_TEST_DEFINE() [2/7]

AST_TEST_DEFINE

(

validate_boolean

)

Definition at line 117 of file test_ari_model.c.

References ast_ari_validate_boolean(), ast_json_false(), ast_json_null(), ast_json_string_create(), ast_json_string_set(), ast_json_true(), ast_json_unref(), AST_TEST_NOT_RUN, AST_TEST_PASS, sip_to_pjsip::info(), NULL, RAII_VAR, str, TEST_EXECUTE, and TEST_INIT.

{
   RAII_VAR(struct ast_json *, str, NULL, ast_json_unref);
   int res;

   switch (cmd) {
   case TEST_INIT:
      info->name = __func__;
      info->category = "/ari/validators/";
      info->summary = "Test byte validation";
      info->description =
         "Test byte validation";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   ast_test_validate(test, ast_ari_validate_boolean(ast_json_true()));
   ast_test_validate(test, ast_ari_validate_boolean(ast_json_false()));

   str = ast_json_string_create("not a bool");
   ast_test_validate(test, NULL != str);
   ast_test_validate(test, !ast_ari_validate_boolean(str));

   /* Even if the string has a boolean value */
   res = ast_json_string_set(str, "true");
   ast_test_validate(test, 0 == res);
   ast_test_validate(test, !ast_ari_validate_boolean(str));

   /* Even if the string has a boolean text in it */
   res = ast_json_string_set(str, "true");
   ast_test_validate(test, 0 == res);
   ast_test_validate(test, !ast_ari_validate_boolean(str));

   ast_test_validate(test, !ast_ari_validate_boolean(ast_json_null()));

   return AST_TEST_PASS;
}

AST_TEST_DEFINE() [3/7]

AST_TEST_DEFINE

(

validate_int

)

Definition at line 156 of file test_ari_model.c.

References ast_ari_validate_int(), ast_json_integer_create(), ast_json_integer_set(), ast_json_null(), ast_json_string_create(), ast_json_string_set(), ast_json_unref(), AST_TEST_NOT_RUN, AST_TEST_PASS, sip_to_pjsip::info(), NULL, RAII_VAR, str, TEST_EXECUTE, and TEST_INIT.

{
   RAII_VAR(struct ast_json *, uut, NULL, ast_json_unref);
   RAII_VAR(struct ast_json *, str, NULL, ast_json_unref);
   int res;

   switch (cmd) {
   case TEST_INIT:
      info->name = __func__;
      info->category = "/ari/validators/";
      info->summary = "Test int validation";
      info->description =
         "Test int validation";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   uut = ast_json_integer_create(-2147483648LL);
   ast_test_validate(test, NULL != uut);
   ast_test_validate(test, ast_ari_validate_int(uut));

   res = ast_json_integer_set(uut, 0);
   ast_test_validate(test, 0 == res);
   ast_test_validate(test, ast_ari_validate_int(uut));

   res = ast_json_integer_set(uut, 2147483647LL);
   ast_test_validate(test, 0 == res);
   ast_test_validate(test, ast_ari_validate_int(uut));

   res = ast_json_integer_set(uut, -2147483649LL);
   ast_test_validate(test, 0 == res);
   ast_test_validate(test, !ast_ari_validate_int(uut));

   res = ast_json_integer_set(uut, 2147483648LL);
   ast_test_validate(test, 0 == res);
   ast_test_validate(test, !ast_ari_validate_int(uut));

   str = ast_json_string_create("not a int");
   ast_test_validate(test, NULL != str);
   ast_test_validate(test, !ast_ari_validate_int(str));

   /* Even if the string has an integral value */
   res = ast_json_string_set(str, "0");
   ast_test_validate(test, 0 == res);
   ast_test_validate(test, !ast_ari_validate_int(str));

   ast_test_validate(test, !ast_ari_validate_int(ast_json_null()));

   return AST_TEST_PASS;
}

AST_TEST_DEFINE() [4/7]

AST_TEST_DEFINE

(

validate_long

)

Definition at line 208 of file test_ari_model.c.

References ast_ari_validate_long(), ast_json_integer_create(), ast_json_null(), ast_json_string_create(), ast_json_string_set(), ast_json_unref(), AST_TEST_NOT_RUN, AST_TEST_PASS, sip_to_pjsip::info(), NULL, RAII_VAR, str, TEST_EXECUTE, and TEST_INIT.

{
   RAII_VAR(struct ast_json *, uut, NULL, ast_json_unref);
   RAII_VAR(struct ast_json *, str, NULL, ast_json_unref);
   int res;

   switch (cmd) {
   case TEST_INIT:
      info->name = __func__;
      info->category = "/ari/validators/";
      info->summary = "Test long validation";
      info->description =
         "Test long validation";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   uut = ast_json_integer_create(0);
   ast_test_validate(test, NULL != uut);
   ast_test_validate(test, ast_ari_validate_long(uut));

   str = ast_json_string_create("not a long");
   ast_test_validate(test, NULL != str);
   ast_test_validate(test, !ast_ari_validate_long(str));

   /* Even if the string has an integral value */
   res = ast_json_string_set(str, "0");
   ast_test_validate(test, 0 == res);
   ast_test_validate(test, !ast_ari_validate_long(str));

   ast_test_validate(test, !ast_ari_validate_long(ast_json_null()));

   return AST_TEST_PASS;
}

AST_TEST_DEFINE() [5/7]

AST_TEST_DEFINE

(

validate_string

)

Definition at line 244 of file test_ari_model.c.

References ast_ari_validate_string(), ast_json_null(), ast_json_string_create(), ast_json_string_set(), ast_json_unref(), AST_TEST_NOT_RUN, AST_TEST_PASS, sip_to_pjsip::info(), NULL, RAII_VAR, str, TEST_EXECUTE, and TEST_INIT.

{
   RAII_VAR(struct ast_json *, uut, NULL, ast_json_unref);
   RAII_VAR(struct ast_json *, str, NULL, ast_json_unref);
   int res;

   switch (cmd) {
   case TEST_INIT:
      info->name = __func__;
      info->category = "/ari/validators/";
      info->summary = "Test string validation";
      info->description =
         "Test string validation";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   uut = ast_json_string_create("text");
   ast_test_validate(test, NULL != uut);
   ast_test_validate(test, ast_ari_validate_string(uut));

   res = ast_json_string_set(uut, "");
   ast_test_validate(test, 0 == res);
   ast_test_validate(test, ast_ari_validate_string(uut));

   ast_test_validate(test, !ast_ari_validate_string(ast_json_null()));

   return AST_TEST_PASS;
}

AST_TEST_DEFINE() [6/7]

AST_TEST_DEFINE

(

validate_date

)

Definition at line 275 of file test_ari_model.c.

References ARRAY_LEN, ast_ari_validate_date(), ast_ari_validate_string(), ast_json_null(), ast_json_string_create(), ast_json_string_set(), ast_json_unref(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, sip_to_pjsip::info(), NULL, RAII_VAR, str, TEST_EXECUTE, TEST_INIT, and test_res.

{
   RAII_VAR(struct ast_json *, uut, NULL, ast_json_unref);
   RAII_VAR(struct ast_json *, str, NULL, ast_json_unref);
   enum ast_test_result_state test_res;
   int res;
   int i;
   const char *valid_dates[] = {
      /* Time is optional */
      "2013-06-17",
      /* Seconds are optional */
      "2013-06-17T23:59Z",
      /* Subseconds are optional */
      "2013-06-17T23:59:59Z",
      /* Leap seconds are valid */
      "2013-06-30T23:59:61Z",
      /* Subseconds are allowed */
      "2013-06-17T23:59:59.999999Z",
      /* Now with -06:00 for the timezone */
      "2013-06-17T23:59-06:00",
      "2013-06-17T23:59:59-06:00",
      "2013-06-30T23:59:61-06:00",
      "2013-06-17T23:59:59.999999-06:00",
      /* Again, with +06:30 for the timezone */
      "2013-06-17T23:59+06:30",
      "2013-06-17T23:59:59+06:30",
      "2013-06-30T23:59:61+06:30",
      "2013-06-17T23:59:59.999999+06:30",
      /* So the colon in the timezone is optional */
      "2013-06-17T23:59-0600",
      "2013-06-17T23:59:59-0600",
      "2013-06-30T23:59:61-0600",
      "2013-06-17T23:59:59.999999-0600",
      /* Sure, why not */
      "2013-06-17T23:59+0630",
      "2013-06-17T23:59:59+0630",
      "2013-06-30T23:59:61+0630",
      "2013-06-17T23:59:59.999999+0630",
      "9999-12-31T23:59:61.999999Z",
      /* In fact, you don't even have to specify minutes */
      "2013-06-17T23:59-06",
      "2013-06-17T23:59:59-06",
      "2013-06-30T23:59:61-06",
      "2013-06-17T23:59:59.999999-06",
   };

   /* There are lots of invalid dates that the validator lets through.
    * Those would be strings properly formatted as a ridiculous date. Such
    * as 0000-00-00, or 9999-19-39. Those are harder to catch with a regex,
    * and actually aren't as important. So long as the valid dates pass the
    * validator, and poorly formatted dates are rejected, it's fine.
    * Catching the occasional ridiculous date is just bonus.
    */
   const char *invalid_dates[] = {
      "",
      "Not a date",
      "2013-06-17T", /* Missing time, but has T */
      "2013-06-17T23:59:59.Z", /* Missing subsecond, but has dot */
      "2013-06-17T23:59", /* Missing timezone, but has time */
      "2013-06-17T23:59:59.999999", /* Missing timezone */
      "9999-99-31T23:59:61.999999Z", /* Invalid month */
      "9999-12-99T23:59:61.999999Z", /* Invalid day */
      "9999-12-31T99:59:61.999999Z", /* Invalid hour */
      "9999-12-31T23:99:61.999999Z", /* Invalid minute */
      "9999-12-31T23:59:99.999999Z", /* Invalid second */
      "2013-06-17T23:59:59.999999-99:00", /* Invalid timezone */
      "2013-06-17T23:59:59.999999-06:99", /* Invalid timezone */
      "2013-06-17T23:59:59.999999-06:", /* Invalid timezone */
      "2013-06-17T23:59:59.999999-06:0", /* Invalid timezone */
      "2013-06-17T23:59:59.999999-060", /* Invalid timezone */
   };

   switch (cmd) {
   case TEST_INIT:
      info->name = __func__;
      info->category = "/ari/validators/";
      info->summary = "Test date validation";
      info->description =
         "Test date validation";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   uut = ast_json_string_create("");
   ast_test_validate(test, NULL != uut);

   /* Instead of using ast_test_validate, we'll collect the results from
    * several test cases, since we have so many */
   test_res = AST_TEST_PASS;
   for (i = 0; i < ARRAY_LEN(valid_dates); ++i) {
      res = ast_json_string_set(uut, valid_dates[i]);
      ast_test_validate(test, 0 == res);
      if (!ast_ari_validate_date(uut)) {
         ast_test_status_update(test,
            "Expected '%s' to be a valid date\n",
            valid_dates[i]);
         test_res = AST_TEST_FAIL;
      }
   }

   for (i = 0; i < ARRAY_LEN(invalid_dates); ++i) {
      res = ast_json_string_set(uut, invalid_dates[i]);
      ast_test_validate(test, 0 == res);
      if (ast_ari_validate_date(uut)) {
         ast_test_status_update(test,
            "Expected '%s' to be an invalid date\n",
            invalid_dates[i]);
         test_res = AST_TEST_FAIL;
      }
   }

   ast_test_validate(test, !ast_ari_validate_string(ast_json_null()));

   return test_res;
}

AST_TEST_DEFINE() [7/7]

AST_TEST_DEFINE

(

validate_list

)

Definition at line 392 of file test_ari_model.c.

References ast_ari_validate_list(), ast_json_array_append(), ast_json_array_create(), ast_json_integer_create(), ast_json_null(), ast_json_string_create(), ast_json_unref(), AST_TEST_NOT_RUN, AST_TEST_PASS, sip_to_pjsip::info(), NULL, RAII_VAR, str, TEST_EXECUTE, TEST_INIT, wrap_ast_ari_validate_int(), and wrap_ast_ari_validate_string().

{
   RAII_VAR(struct ast_json *, uut, NULL, ast_json_unref);
   RAII_VAR(struct ast_json *, str, NULL, ast_json_unref);
   int res;

   switch (cmd) {
   case TEST_INIT:
      info->name = __func__;
      info->category = "/ari/validators/";
      info->summary = "Test list validation";
      info->description =
         "Test list validation";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   uut = ast_json_array_create();
   ast_test_validate(test, NULL != uut);
   ast_test_validate(test, ast_ari_validate_list(uut, wrap_ast_ari_validate_string));
   ast_test_validate(test, ast_ari_validate_list(uut, wrap_ast_ari_validate_int));

   res = ast_json_array_append(uut, ast_json_string_create(""));
   ast_test_validate(test, 0 == res);
   ast_test_validate(test, ast_ari_validate_list(uut, wrap_ast_ari_validate_string));
   ast_test_validate(test, !ast_ari_validate_list(uut, wrap_ast_ari_validate_int));

   res = ast_json_array_append(uut, ast_json_integer_create(0));
   ast_test_validate(test, 0 == res);
   ast_test_validate(test, !ast_ari_validate_list(uut, wrap_ast_ari_validate_string));
   ast_test_validate(test, !ast_ari_validate_list(uut, wrap_ast_ari_validate_int));

   ast_test_validate(test,
      !ast_ari_validate_list(ast_json_null(), wrap_ast_ari_validate_string));

   return AST_TEST_PASS;
}

load_module()

static int load_module ( void  )

static

Definition at line 443 of file test_ari_model.c.

References AST_MODFLAG_DEFAULT, AST_MODULE_INFO(), AST_MODULE_LOAD_SUCCESS, AST_MODULE_SUPPORT_CORE, AST_TEST_REGISTER, ASTERISK_GPL_KEY, and unload_module().

{
   AST_TEST_REGISTER(validate_byte);
   AST_TEST_REGISTER(validate_boolean);
   AST_TEST_REGISTER(validate_int);
   AST_TEST_REGISTER(validate_long);
   AST_TEST_REGISTER(validate_string);
   AST_TEST_REGISTER(validate_date);
   AST_TEST_REGISTER(validate_list);
   return AST_MODULE_LOAD_SUCCESS;
}

unload_module()

static int unload_module ( void  )

static

Definition at line 431 of file test_ari_model.c.

References AST_TEST_UNREGISTER.

Referenced by load_module().

{
   AST_TEST_UNREGISTER(validate_byte);
   AST_TEST_UNREGISTER(validate_boolean);
   AST_TEST_UNREGISTER(validate_int);
   AST_TEST_UNREGISTER(validate_long);
   AST_TEST_UNREGISTER(validate_string);
   AST_TEST_UNREGISTER(validate_date);
   AST_TEST_UNREGISTER(validate_list);
   return 0;
}

wrap_ast_ari_validate_int()

static int wrap_ast_ari_validate_int ( struct ast_json *  json )

static

Wrapper of ast_test_validate_int() so an external function pointer is not used.

Note

We do this because using an external function pointer did not play nicely when we loaded with RTLD_LAZY.

Definition at line 46 of file test_ari_model.c.

References ast_ari_validate_int().

Referenced by AST_TEST_DEFINE().

{
   return ast_ari_validate_int(json);
}

wrap_ast_ari_validate_string()

static int wrap_ast_ari_validate_string ( struct ast_json *  json )

static

Wrapper of ast_ari_validate_string() so an external function pointer is not used.

Note

We do this because using an external function pointer did not play nicely when we loaded with RTLD_LAZY.

Definition at line 59 of file test_ari_model.c.

References ast_ari_validate_string().

Referenced by AST_TEST_DEFINE().

{
   return ast_ari_validate_string(json);
}

Variable Documentation

__mod_info

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

static

Definition at line 460 of file test_ari_model.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 460 of file test_ari_model.c.