Add new unit test for stringfields.
[asterisk/asterisk.git] / tests / test_stringfields.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2009, Mark Michelson
5  *
6  * Mark Michelson <mmmichelson@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 /*! \file
20  *
21  * \brief String fields test
22  *
23  * \author\verbatim Mark Michelson <mmichelson@digium.com> \endverbatim
24  *
25  * Test module for string fields API
26  * \ingroup tests
27  * \todo need to test ast_calloc_with_stringfields
28  */
29
30 /*** MODULEINFO
31         <depend>TEST_FRAMEWORK</depend>
32  ***/
33
34 #include "asterisk.h"
35 #include "asterisk/module.h"
36 #include "asterisk/stringfields.h"
37 #include "asterisk/cli.h"
38 #include "asterisk/utils.h"
39 #include "asterisk/test.h"
40
41 AST_TEST_DEFINE(string_field_test)
42 {
43         const char *address_holder;
44         struct ast_string_field_pool *field_pool1;
45         struct ast_string_field_pool *field_pool2;
46         struct ast_string_field_pool *field_pool3;
47         static const char LONG_STRING[] = "A professional panoramic photograph of the majestic elephant bathing itself and its young by the shores of the raging Mississippi River";
48
49         struct {
50                 AST_DECLARE_STRING_FIELDS (
51                         AST_STRING_FIELD(string1);
52                         AST_STRING_FIELD(string2);
53                 );
54         } test_struct;
55
56         struct {
57                 AST_DECLARE_STRING_FIELDS (
58                         AST_STRING_FIELD(string1);
59                         AST_STRING_FIELD(string2);
60                         AST_STRING_FIELD(string3);
61                 );
62         } test_struct2;
63
64         switch (cmd) {
65         case TEST_INIT:
66                 info->name = "string_field_test";
67                 info->category = "main/utils/";
68                 info->summary = "Test stringfield operations";
69                 info->description =
70                         "This tests the stringfield API";
71                 return AST_TEST_NOT_RUN;
72         case TEST_EXECUTE:
73                 break;
74         }
75
76         ast_test_status_update(test, "First things first. Let's see if we can actually allocate string fields\n");
77
78         if (ast_string_field_init(&test_struct, 32)) {
79                 ast_test_status_update(test, "Failure to initialize string fields. They are totally messed up\n");
80                 return AST_TEST_FAIL;
81         } else {
82                 ast_test_status_update(test, "All right! Successfully allocated! Now let's get down to business\n");
83         }
84
85         ast_test_status_update(test,"We're going to set some string fields and perform some checks\n");
86
87         ast_string_field_set(&test_struct, string1, "elephant");
88         ast_string_field_set(&test_struct, string2, "hippopotamus");
89
90         ast_test_status_update(test, "First we're going to make sure that the strings are actually set to what we expect\n");
91
92         if (strcmp(test_struct.string1, "elephant")) {
93                 ast_test_status_update(test, "We were expecting test_struct.string1 to have 'elephant' but it has %s\n", test_struct.string1);
94                 goto error;
95         } else {
96                 ast_test_status_update(test, "test_struct.string1 appears to be all clear. It has '%s' and that's what we expect\n", test_struct.string1);
97         }
98
99         if (strcmp(test_struct.string2, "hippopotamus")) {
100                 ast_test_status_update(test, "We were expecting test_struct.string2 to have 'hippopotamus' but it has %s\n", test_struct.string2);
101                 goto error;
102         } else {
103                 ast_test_status_update(test, "test_struct.string2 appears to be all clear. It has '%s' and that's what we expect\n", test_struct.string2);
104         }
105
106         ast_test_status_update(test, "Now let's make sure that our recorded capacities for these strings is what we expect\n");
107
108         if (AST_STRING_FIELD_ALLOCATION(test_struct.string1) != strlen("elephant") + 1) {
109                 ast_test_status_update(test, "string1 has allocation area of %hu but we expect %lu\n",
110                                 AST_STRING_FIELD_ALLOCATION(test_struct.string1), strlen("elephant") + 1);
111                 goto error;
112         } else {
113                 ast_test_status_update(test, "string1 has the allocation area we expect: %hu\n", AST_STRING_FIELD_ALLOCATION(test_struct.string1));
114         }
115
116         if (AST_STRING_FIELD_ALLOCATION(test_struct.string2) != strlen("hippopotamus") + 1) {
117                 ast_test_status_update(test, "string2 has allocation area of %hu but we expect %lu\n",
118                                 AST_STRING_FIELD_ALLOCATION(test_struct.string2), strlen("hippopotamus") + 1);
119                 goto error;
120         } else {
121                 ast_test_status_update(test, "string2 has the allocation area we expect: %hu\n", AST_STRING_FIELD_ALLOCATION(test_struct.string2));
122         }
123
124         ast_test_status_update(test, "Now we're going to shrink string1 and see if it's in the same place in memory\n");
125
126         address_holder = test_struct.string1;
127         ast_string_field_set(&test_struct, string1, "rhino");
128
129         if (strcmp(test_struct.string1, "rhino")) {
130                 ast_test_status_update(test, "string1 has the wrong value in it. We want 'rhino' but it has '%s'\n", test_struct.string1);
131                 goto error;
132         } else {
133                 ast_test_status_update(test, "string1 successfully was changed to '%s'\n", test_struct.string1);
134         }
135
136         if (address_holder != test_struct.string1) {
137                 ast_test_status_update(test, "We shrunk string1, but it moved?!\n");
138                 goto error;
139         } else {
140                 ast_test_status_update(test, "Shrinking string1 allowed it to stay in the same place in memory\n");
141         }
142
143         if (AST_STRING_FIELD_ALLOCATION(test_struct.string1) != strlen("elephant") + 1) {
144                 ast_test_status_update(test, "The allocation amount changed when we shrunk the string...\n");
145                 goto error;
146         } else {
147                 ast_test_status_update(test, "Shrinking string1 did not change its allocation area (This is a good thing)\n");
148         }
149
150         ast_test_status_update(test, "Next, let's increase it a little but not all the way to its original size\n");
151
152         address_holder = test_struct.string1;
153         ast_string_field_set(&test_struct, string1, "mammoth");
154
155         if (strcmp(test_struct.string1, "mammoth")) {
156                 ast_test_status_update(test, "string1 has the wrong value in it. We want 'mammoth' but it has '%s'\n", test_struct.string1);
157                 goto error;
158         } else {
159                 ast_test_status_update(test, "string1 successfully was changed to '%s'\n", test_struct.string1);
160         }
161
162         if (address_holder != test_struct.string1) {
163                 ast_test_status_update(test, "We expanded string1, but it moved?!\n");
164                 goto error;
165         } else {
166                 ast_test_status_update(test, "Expanding string1 allowed it to stay in the same place in memory\n");
167         }
168
169         if (AST_STRING_FIELD_ALLOCATION(test_struct.string1) != strlen("elephant") + 1) {
170                 ast_test_status_update(test, "The allocation amount changed when we expanded the string...\n");
171                 goto error;
172         } else {
173                 ast_test_status_update(test, "Expanding string1 did not change its allocation area (This is a good thing)\n");
174         }
175
176         ast_test_status_update(test, "Cool, now let's bring it back to its original size and see what happens\n");
177
178         ast_string_field_set(&test_struct, string1, "elephant");
179
180         if (strcmp(test_struct.string1, "elephant")) {
181                 ast_test_status_update(test, "string1 has the wrong value in it. We want 'elephant' but it has '%s'\n", test_struct.string1);
182                 goto error;
183         } else {
184                 ast_test_status_update(test, "string1 successfully changed to '%s'\n", test_struct.string1);
185         }
186
187         if (address_holder != test_struct.string1) {
188                 ast_test_status_update(test, "We restored string1 to its original size, but it moved?!\n");
189                 goto error;
190         } else {
191                 ast_test_status_update(test, "Restoring string1 did not cause it to move (This is a good thing)\n");
192         }
193
194         if (AST_STRING_FIELD_ALLOCATION(test_struct.string1) != strlen("elephant") + 1) {
195                 ast_test_status_update(test, "The allocation amount changed when we re-expanded the string...\n");
196                 goto error;
197         } else {
198                 ast_test_status_update(test, "The allocation amount for string1 is still holding steady\n");
199         }
200
201         ast_test_status_update(test, "All right, now we're going to expand string 2. It should stay in place since it was the last string allocated in this pool\n");
202
203         address_holder = test_struct.string2;
204         ast_string_field_set(&test_struct, string2, "hippopotamus face");
205
206         if (strcmp(test_struct.string2, "hippopotamus face")) {
207                 ast_test_status_update(test, "string2 has the wrong value. We want 'hippopotamus face' but it has '%s'\n", test_struct.string2);
208                 goto error;
209         } else {
210                 ast_test_status_update(test, "string2 successfully changed to '%s'\n", test_struct.string2);
211         }
212
213         if (AST_STRING_FIELD_ALLOCATION(test_struct.string2) != strlen("hippopotamus face") + 1) {
214                 ast_test_status_update(test, "The allocation amount is incorrect for string2. We expect %lu but it has %hu\n",
215                                 strlen("hippopotamus face"), AST_STRING_FIELD_ALLOCATION(test_struct.string2) + 1);
216                 goto error;
217         } else {
218                 ast_test_status_update(test, "The allocation amount successfully increased for string2 when it grew\n");
219         }
220
221         if (test_struct.string2 != address_holder) {
222                 ast_test_status_update(test, "string2 has moved, but it should not have since it had room to grow\n");
223                 goto error;
224         } else {
225                 ast_test_status_update(test, "string2 stayed in place when it grew. Good job!\n");
226         }
227
228         ast_test_status_update(test, "Now we're going to set string1 to a very long string so that a new string field pool must be allocated\n");
229
230         address_holder = test_struct.string1;
231         ast_string_field_set(&test_struct, string1, LONG_STRING);
232
233         if (strcmp(test_struct.string1, LONG_STRING)) {
234                 ast_test_status_update(test, "We were expecting string1 to be '%s'\nbut it was actually '%s'\n", LONG_STRING, test_struct.string1);
235                 goto error;
236         } else {
237                 ast_test_status_update(test, "string1 successfully changed to '%s'\n", test_struct.string1);
238         }
239
240         if (address_holder == test_struct.string1) {
241                 ast_test_status_update(test, "Uh oh, string1 didn't move when we set it to a long value\n");
242                 goto error;
243         } else {
244                 ast_test_status_update(test, "Good. Setting string1 to a long value caused it to change addresses\n");
245         }
246
247         if (AST_STRING_FIELD_ALLOCATION(test_struct.string1) != strlen(LONG_STRING) + 1) {
248                 ast_test_status_update(test, "The string field allocation for string1 indicates a length of %hu instead of the expected %lu\n",
249                                 AST_STRING_FIELD_ALLOCATION(test_struct.string1), strlen(LONG_STRING) + 1);
250                 goto error;
251         } else {
252                 ast_test_status_update(test, "The stored allocation size of string1 is what we expect\n");
253         }
254
255         ast_string_field_init(&test_struct2, 32);
256         ast_test_status_update(test, "Now using a totally separate area of memory we're going to test a basic pool freeing scenario\n");
257
258         ast_string_field_set(&test_struct2, string1, "first");
259         ast_string_field_set(&test_struct2, string2, "second");
260         ast_string_field_set(&test_struct2, string3, "third");
261
262         /* This string is 208 characters long, which will surely exceed the initial pool size */
263         ast_string_field_set(&test_struct2, string1, "Expanded first string to create new pool-----------------------------------------------------------------------------------------------------------------------------------------------------------------------");
264         /* Pool size at this point is 976, so 1000 chars should do it */
265         ast_string_field_set(&test_struct2, string2, "Expanded second string to create new pool----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------");
266
267         field_pool3 = test_struct2.__field_mgr_pool;
268         field_pool2 = test_struct2.__field_mgr_pool->prev;
269         field_pool1 = test_struct2.__field_mgr_pool->prev->prev;
270
271         if(field_pool3->prev != field_pool2 || field_pool2->prev != field_pool1) {
272                 ast_test_status_update(test, "Pools are not linked properly!\n");
273                 goto error;
274         } else {
275                 ast_test_status_update(test, "Three different pools are linked as expected.\n");
276         }
277
278         ast_string_field_set(&test_struct2, string1, NULL);
279         if (test_struct2.string1 != __ast_string_field_empty || field_pool3->prev != field_pool1) {
280                 ast_test_status_update(test, "Things did not work out when removing the middle pool!\n");
281                 goto error;
282         } else {
283                 ast_test_status_update(test, "After removing a pool the remaining two are linked as expected.\n");
284         }
285
286         ast_string_field_free_memory(&test_struct2);
287         ast_string_field_free_memory(&test_struct);
288         return AST_TEST_PASS;
289
290 error:
291         ast_string_field_free_memory(&test_struct);
292         ast_string_field_free_memory(&test_struct2);
293         return AST_TEST_FAIL;
294 }
295
296 static int unload_module(void)
297 {
298         AST_TEST_UNREGISTER(string_field_test);
299         return 0;
300 }
301
302 static int load_module(void)
303 {
304         AST_TEST_REGISTER(string_field_test);
305         return AST_MODULE_LOAD_SUCCESS;
306 }
307
308 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "String Fields Test");