Asterisk - The Open Source Telephony Project  18.5.0
test_scope_trace.c
Go to the documentation of this file.
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2020, Sangoma Technologies Corp
5  *
6  * George Joseph <[email protected]>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18 
19 /*!
20  * \file
21  * \brief Test for Scope Trace
22  *
23  * \author\verbatim George Joseph <[email protected]> \endverbatim
24  *
25  * tests for Scope Trace
26  * \ingroup tests
27  */
28 
29 /*** MODULEINFO
30  <depend>TEST_FRAMEWORK</depend>
31  <support_level>core</support_level>
32  ***/
33 
34 #include "asterisk.h"
35 
36 #include "asterisk/utils.h"
37 #include "asterisk/module.h"
38 #include "asterisk/test.h"
39 #include "asterisk/logger.h"
40 
41 
42 static const char *str_appender(struct ast_str**buf, char *a)
43 {
44  ast_str_append(buf, 0, "<append %s>", a);
45  return ast_str_buffer(*buf);
46 }
47 
48 static void test_scope_trace(void)
49 {
50  SCOPE_ENTER(1, "subfunction\n");
51  SCOPE_EXIT_RTN("got out\n");
52 }
53 
54 static int test_scope_enter_function(void)
55 {
56  SCOPE_ENTER(1, "%s %s %s %s %s %s %s\n",
57  ast_str_tmp(12, str_appender(&STR_TMP, "str1")),
58  ast_str_tmp(12, str_appender(&STR_TMP, "str2")),
59  ast_str_tmp(32, str_appender(&STR_TMP, "AAAAAAAAAAAAAAAAAAAAAAAA")),
60  ast_str_tmp(12, str_appender(&STR_TMP, "B")),
61  "ccccccccccccc",
62  ast_str_tmp(12, str_appender(&STR_TMP, "DDDDD")),
63  ast_str_tmp(12, str_appender(&STR_TMP, "ww"))
64  );
65 
66  test_scope_trace();
67 
68  SCOPE_EXIT_RTN_VALUE(AST_TEST_PASS, "test no variables\n");
69 }
70 
71 
72 AST_TEST_DEFINE(scope_test)
73 {
74  SCOPE_ENTER(1, "top %s function\n", "scope_test");
75 
76  ast_trace(1, "%s\n", "test outer");
77 
78  switch (cmd) {
79  case TEST_INIT:
80  {
81  SCOPE_ENTER(1, "TEST_INIT\n");
82  info->name = "scope_test";
83  info->category = "/main/logging/";
84  info->summary = "Scope Trace Tests";
85  info->description = "Scope Trace Tests";
86  /* need to exit the case scope */
87  SCOPE_EXIT("TEST_INIT\n");
88  /* need to exit the function */
89  SCOPE_EXIT_RTN_VALUE(AST_TEST_NOT_RUN, "BYE\n");
90  }
91  case TEST_EXECUTE:
92  {
93  SCOPE_ENTER(1, "TEST_EXECUTE\n");
94  ast_trace(1, "%s\n", "test execute");
95  SCOPE_EXIT_EXPR(break, "TEST_EXECUTE\n");
96  }
97  default:
98  ast_test_status_update(test, "Shouldn't have gotten here\n");
99  return AST_TEST_FAIL;
100  }
101 
102  if (1) {
103  SCOPE_TRACE(1, "IF block\n");
104  test_scope_enter_function();
105  }
106 
107  ast_trace(1);
108  ast_trace(1, "test no variables\n");
109  ast_trace(1, "%s\n", "test variable");
110 
111  SCOPE_EXIT_RTN_VALUE(AST_TEST_PASS, "Something: %d\n", AST_TEST_PASS);
112 }
113 
114 static int unload_module(void)
115 {
116  AST_TEST_UNREGISTER(scope_test);
117  return 0;
118 }
119 
120 static int load_module(void)
121 {
122  AST_TEST_REGISTER(scope_test);
123  return AST_MODULE_LOAD_SUCCESS;
124 }
125 
126 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Scope Trace Test");
AST_MODULE_INFO_STANDARD
#define AST_MODULE_INFO_STANDARD(keystr, desc)
Definition: module.h:567
asterisk.h
Asterisk main include file. File version handling, generic pbx functions.
test_scope_enter_function
static int test_scope_enter_function(void)
Definition: test_scope_trace.c:54
buf
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
ast_str_buffer
char * ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition: strings.h:714
test.h
Test Framework API.
AST_TEST_REGISTER
#define AST_TEST_REGISTER(cb)
Definition: test.h:127
str_appender
static const char * str_appender(struct ast_str **buf, char *a)
Definition: test_scope_trace.c:42
ast_trace
#define ast_trace(level,...)
Print a basic trace message.
Definition: logger.h:692
ast_str_append
int ast_str_append(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Append to a thread local dynamic string.
Definition: strings.h:1091
utils.h
Utility functions.
ast_str_tmp
#define ast_str_tmp(init_len, __expr)
Definition: strings.h:1136
ast_test_status_update
#define ast_test_status_update(a, b, c...)
Definition: test.h:129
SCOPE_EXIT
#define SCOPE_EXIT(...)
Scope Exit.
Definition: logger.h:805
SCOPE_EXIT_EXPR
#define SCOPE_EXIT_EXPR(__expr,...)
Definition: logger.h:834
ast_str
The descriptor of a dynamic string XXX storage will be optimized later if needed We use the ts field ...
Definition: strings.h:584
AST_TEST_UNREGISTER
#define AST_TEST_UNREGISTER(cb)
Definition: test.h:128
sip_to_pjsip.info
def info(msg)
Definition: sip_to_pjsip.py:1313
load_module
static int load_module(void)
Definition: test_scope_trace.c:120
SCOPE_EXIT_RTN
#define SCOPE_EXIT_RTN(...)
Scope Exit with return.
Definition: logger.h:854
SCOPE_ENTER
#define SCOPE_ENTER(level,...)
Non RAII_VAR Scope Trace macros The advantage of these macros is that the EXITs will have the actual ...
Definition: logger.h:780
logger.h
Support for logging to various files, console and syslog Configuration in file logger.conf.
SCOPE_EXIT_RTN_VALUE
#define SCOPE_EXIT_RTN_VALUE(__return_value,...)
Scope Exit with return value.
Definition: logger.h:875
SCOPE_TRACE
#define SCOPE_TRACE(level,...)
Print a trace message with details when a scope is entered or existed.
Definition: logger.h:749
AST_TEST_DEFINE
AST_TEST_DEFINE(scope_test)
Definition: test_scope_trace.c:72
test_scope_trace
static void test_scope_trace(void)
Definition: test_scope_trace.c:48
ASTERISK_GPL_KEY
#define ASTERISK_GPL_KEY
The text the key() function should return.
Definition: module.h:46
module.h
Asterisk module definitions.
unload_module
static int unload_module(void)
Definition: test_scope_trace.c:114
a
static struct test_val a
Definition: test_linkedlists.c:46
Generated on Sun Aug 8 2021 19:44:21 for Asterisk - The Open Source Telephony Project by   doxygen 1.8.13