I forgot to add the unit tests for scoped locks earlier today.
[asterisk/asterisk.git] / tests / test_strings.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2010, Digium, Inc.
5  *
6  * Mark Michelson <mmichelson@digium.com>
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 Dynamic string tests
22  *
23  * \author Mark Michelson <mmichelson@digium.com>
24  *
25  * This module will run some dyanmic string tests.
26  *
27  * \ingroup tests
28  */
29
30 /*** MODULEINFO
31         <depend>TEST_FRAMEWORK</depend>
32         <support_level>core</support_level>
33  ***/
34
35 #include "asterisk.h"
36
37 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
38
39 #include "asterisk/test.h"
40 #include "asterisk/utils.h"
41 #include "asterisk/strings.h"
42 #include "asterisk/module.h"
43
44 AST_TEST_DEFINE(str_test)
45 {
46         struct ast_str *stack_str;
47         struct ast_str *heap_str;
48         const char short_string1[] = "apple";
49         const char short_string2[] = "banana";
50         char short_string_cat[30];
51         const char long_string1[] = "applebananapeachmangocherrypeargrapeplumlimetangerinepomegranategravel";
52         const char long_string2[] = "passionuglinectarinepineapplekiwilemonpaintthinner";
53         char long_string_cat[200];
54         char string_limit_cat[11];
55         const int string_limit = 5;
56         int current_size;
57         enum ast_test_result_state res = AST_TEST_PASS;
58
59         switch (cmd) {
60         case TEST_INIT:
61                 info->name = "str_test";
62                 info->category = "/main/strings/";
63                 info->summary = "Test dynamic string operations";
64                 info->description = "Test setting and appending stack and heap-allocated strings";
65                 return AST_TEST_NOT_RUN;
66         case TEST_EXECUTE:
67                 break;
68         }
69         snprintf(short_string_cat, sizeof(short_string_cat), "%s%s", short_string1, short_string2);
70         snprintf(long_string_cat, sizeof(long_string_cat), "%s%s", long_string1, long_string2);
71         snprintf(string_limit_cat, string_limit, "%s", long_string1);
72         strncat(string_limit_cat, long_string2, string_limit);
73
74         if (!(stack_str = ast_str_alloca(15))) {
75                 ast_test_status_update(test, "Failed to allocate an ast_str on the stack\n");
76                 return AST_TEST_FAIL;
77         }
78
79         if (!(heap_str = ast_str_create(15))) {
80                 ast_test_status_update(test, "Failed to allocate an ast_str on the heap\n");
81         }
82
83         /* Stack string tests:
84          * Part 1: Basic tests
85          * a. set a small string
86          * b. append a small string
87          * c. clear a string
88          * Part 2: Advanced tests
89          * a. Set a string that is larger than our allocation
90          * b. Append a string that is larger than our allocation
91          */
92
93         /* Part 1a */
94         if (ast_str_set(&stack_str, 0, "%s", short_string1) < 0) {
95                 ast_test_status_update(test, "Error setting stack string\n");
96                 res = AST_TEST_FAIL;
97                 goto cleanup;
98         }
99         if (strcmp(ast_str_buffer(stack_str), short_string1)) {
100                 ast_test_status_update(test, "ast_str_set failed for stack string. Expected '%s' but"
101                                 "instead got %s\n", short_string1, ast_str_buffer(stack_str));
102                 res = AST_TEST_FAIL;
103                 goto cleanup;
104         }
105         /* Part 1b */
106         if (ast_str_append(&stack_str, 0, "%s", short_string2) < 0) {
107                 ast_test_status_update(test, "Error appending to stack string\n");
108                 res = AST_TEST_FAIL;
109                 goto cleanup;
110         }
111         if (strcmp(ast_str_buffer(stack_str), short_string_cat)) {
112                 ast_test_status_update(test, "ast_str_set failed for stack string. Expected '%s'"
113                                 "but instead got %s\n", short_string_cat, ast_str_buffer(stack_str));
114                 res = AST_TEST_FAIL;
115                 goto cleanup;
116         }
117         /* Part 1c */
118         ast_str_reset(stack_str);
119         if (ast_str_strlen(stack_str) != 0) {
120                 ast_test_status_update(test, "ast_str_reset resulted in non-zero length for stack_str\n");
121                 res = AST_TEST_FAIL;
122                 goto cleanup;
123         }
124
125         /* Part 2a */
126         if (ast_str_set(&stack_str, -1, "%s", long_string1) < 0) {
127                 ast_test_status_update(test, "Error setting stack string with long input\n");
128                 res = AST_TEST_FAIL;
129                 goto cleanup;
130         }
131         if (strncmp(ast_str_buffer(stack_str), long_string1, ast_str_strlen(stack_str))) {
132                 ast_test_status_update(test, "Stack string not set to what is expected.\n");
133                 res = AST_TEST_FAIL;
134                 goto cleanup;
135         }
136         /* Part 2b */
137         if (ast_str_append(&stack_str, -1, "%s", long_string2) < 0) {
138                 ast_test_status_update(test, "Error appending long string to full stack string buffer\n");
139                 res = AST_TEST_FAIL;
140                 goto cleanup;
141         }
142         if (strncmp(ast_str_buffer(stack_str), long_string_cat, ast_str_strlen(stack_str))) {
143                 ast_test_status_update(test, "Stack string not set to what is expected.\n");
144                 res = AST_TEST_FAIL;
145                 goto cleanup;
146         }
147
148         /* Heap string tests
149          *
150          * All stack string tests from part 1.
151          * All stack string tests 2a and 2b.
152          * Tests 2a and 2b from stack string tests, passing 0 as max_len
153          * instead of -1. This allows for the buffer to grow.
154          */
155         /* Part 1a */
156         if (ast_str_set(&heap_str, 0, "%s", short_string1) < 0) {
157                 ast_test_status_update(test, "Error setting heap string\n");
158                 res = AST_TEST_FAIL;
159                 goto cleanup;
160         }
161         if (strcmp(ast_str_buffer(heap_str), short_string1)) {
162                 ast_test_status_update(test, "ast_str_set failed for heap string. Expected '%s' but"
163                                 "instead got %s\n", short_string1, ast_str_buffer(heap_str));
164                 res = AST_TEST_FAIL;
165                 goto cleanup;
166         }
167         /* Part 1b */
168         if (ast_str_append(&heap_str, 0, "%s", short_string2) < 0) {
169                 ast_test_status_update(test, "Error appending to heap string\n");
170                 res = AST_TEST_FAIL;
171                 goto cleanup;
172         }
173         if (strcmp(ast_str_buffer(heap_str), short_string_cat)) {
174                 ast_test_status_update(test, "ast_str_set failed for stack string. Expected '%s'"
175                                 "but instead got %s\n", short_string_cat, ast_str_buffer(stack_str));
176                 res = AST_TEST_FAIL;
177                 goto cleanup;
178         }
179         /* Part 1c */
180         ast_str_reset(heap_str);
181         if (ast_str_strlen(heap_str) != 0) {
182                 ast_test_status_update(test, "ast_str_reset resulted in non-zero length for stack_str\n");
183                 res = AST_TEST_FAIL;
184                 goto cleanup;
185         }
186         /* Part 2a with -1 arg */
187         current_size = ast_str_size(heap_str);
188         if (ast_str_set(&heap_str, -1, "%s", long_string1) < 0) {
189                 ast_test_status_update(test, "Error setting heap string with long input\n");
190                 res = AST_TEST_FAIL;
191                 goto cleanup;
192         }
193         if (current_size != ast_str_size(heap_str)) {
194                 ast_test_status_update(test, "Heap string changed size during ast_str_set when it was"
195                                 "instructed not to. Was %d and now is %d\n", current_size, (int) ast_str_size(heap_str));
196                 res = AST_TEST_FAIL;
197                 goto cleanup;
198         }
199         if (strncmp(ast_str_buffer(heap_str), long_string1, ast_str_strlen(heap_str))) {
200                 ast_test_status_update(test, "Heap string not set to what is expected.\n");
201                 res = AST_TEST_FAIL;
202                 goto cleanup;
203         }
204         /* Part 2b with -1 arg */
205         current_size = ast_str_size(heap_str);
206         if (ast_str_append(&heap_str, -1, "%s", long_string2) < 0) {
207                 ast_test_status_update(test, "Error appending long string to full heap string buffer\n");
208                 res = AST_TEST_FAIL;
209                 goto cleanup;
210         }
211         if (current_size != ast_str_size(heap_str)) {
212                 ast_test_status_update(test, "Heap string changed size during ast_str_append when it was"
213                                 "instructed not to. Was %d and now is %d\n", current_size, (int) ast_str_size(heap_str));
214                 res = AST_TEST_FAIL;
215                 goto cleanup;
216         }
217         if (strncmp(ast_str_buffer(heap_str), long_string_cat, ast_str_strlen(heap_str))) {
218                 ast_test_status_update(test, "Heap string not set to what is expected.\n");
219                 res = AST_TEST_FAIL;
220                 goto cleanup;
221         }
222         /* reset string before continuing */
223         ast_str_reset(heap_str);
224         /* Part 2a with 0 arg */
225         if (ast_str_set(&heap_str, 0, "%s", long_string1) < 0) {
226                 ast_test_status_update(test, "Error setting heap string with long input\n");
227                 res = AST_TEST_FAIL;
228                 goto cleanup;
229         }
230         if (strcmp(ast_str_buffer(heap_str), long_string1)) {
231                 ast_test_status_update(test, "Heap string does not contain what was expected. Expected %s"
232                                 "but have %s instead\n", long_string1, ast_str_buffer(heap_str));
233                 res = AST_TEST_FAIL;
234                 goto cleanup;
235         }
236         /* Part 2b with 0 arg */
237         if (ast_str_append(&heap_str, 0, "%s", long_string2) < 0) {
238                 ast_test_status_update(test, "Error setting heap string with long input\n");
239                 res = AST_TEST_FAIL;
240                 goto cleanup;
241         }
242         if (strcmp(ast_str_buffer(heap_str), long_string_cat)) {
243                 ast_test_status_update(test, "Heap string does not contain what was expected. Expected %s"
244                                 "but have %s instead\n", long_string_cat, ast_str_buffer(heap_str));
245                 res = AST_TEST_FAIL;
246                 goto cleanup;
247         }
248
249 cleanup:
250         ast_free(heap_str);
251         return res;
252 }
253
254 static int unload_module(void)
255 {
256         AST_TEST_UNREGISTER(str_test);
257         return 0;
258 }
259
260 static int load_module(void)
261 {
262         AST_TEST_REGISTER(str_test);
263         return AST_MODULE_LOAD_SUCCESS;
264 }
265
266 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Dynamic string test module");