bridges/bridge_t38: Add a bridging module for managing T.38 state
[asterisk/asterisk.git] / tests / test_media_cache.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2015, Matt Jordan
5  *
6  * Matt Jordan <mjordan@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 Tests for the media cache API
22  *
23  * \author \verbatim Matt Jordan <mjordan@digium.com> \endverbatim
24  *
25  * \ingroup tests
26  */
27
28 /*** MODULEINFO
29         <depend>TEST_FRAMEWORK</depend>
30         <support_level>core</support_level>
31  ***/
32
33 #include "asterisk.h"
34
35 ASTERISK_REGISTER_FILE()
36
37 #include "asterisk/utils.h"
38 #include "asterisk/module.h"
39 #include "asterisk/test.h"
40 #include "asterisk/bucket.h"
41 #include "asterisk/media_cache.h"
42
43 /*! The unit test category */
44 #define CATEGORY "/main/media_cache/"
45
46 /*! A 'valid' resource for the test bucket behind the media cache facade */
47 #define VALID_RESOURCE "httptest://localhost:8088/test_media_cache/monkeys.wav"
48
49 /*! An 'invalid' resource for the test bucket behind the media cache facade */
50 #define INVALID_RESOURCE "httptest://localhost:8088/test_media_cache/bad.wav"
51
52 /*! An 'invalid' scheme, not mapping to a valid bucket backend */
53 #define INVALID_SCHEME "foo://localhost:8088/test_media_cache/monkeys.wav"
54
55 /*! A URI with no scheme */
56 #define NO_SCHEME "localhost:8088/test_media_cache/monkeys.wav"
57
58 /*!
59  * \internal
60  * \brief Create callback for the httptest bucket backend
61  */
62 static int bucket_http_test_wizard_create(const struct ast_sorcery *sorcery, void *data,
63         void *object)
64 {
65         if (!strcmp(ast_sorcery_object_get_id(object), VALID_RESOURCE)) {
66                 return 0;
67         }
68
69         return -1;
70 }
71
72 /*!
73  * \internal
74  * \brief Update callback for the httptest bucket backend
75  */
76 static int bucket_http_test_wizard_update(const struct ast_sorcery *sorcery, void *data,
77         void *object)
78 {
79         if (!strcmp(ast_sorcery_object_get_id(object), VALID_RESOURCE)) {
80                 return 0;
81         }
82
83         return -1;
84 }
85
86 /*!
87  * \internal
88  * \brief Retrieve callback for the httptest bucket backend
89  */
90 static void *bucket_http_test_wizard_retrieve_id(const struct ast_sorcery *sorcery,
91         void *data, const char *type, const char *id)
92 {
93         struct ast_bucket_file *bucket_file;
94
95         if (!strcmp(type, "file") && !strcmp(id, VALID_RESOURCE)) {
96                 bucket_file = ast_bucket_file_alloc(id);
97                 if (!bucket_file) {
98                         return NULL;
99                 }
100
101                 ast_bucket_file_temporary_create(bucket_file);
102                 return bucket_file;
103         }
104         return NULL;
105 }
106
107 /*!
108  * \internal
109  * \brief Delete callback for the httptest bucket backend
110  */
111 static int bucket_http_test_wizard_delete(const struct ast_sorcery *sorcery, void *data,
112         void *object)
113 {
114         if (!strcmp(ast_sorcery_object_get_id(object), VALID_RESOURCE)) {
115                 return 0;
116         }
117
118         return -1;
119 }
120
121 static struct ast_sorcery_wizard bucket_test_wizard = {
122         .name = "httptest",
123         .create = bucket_http_test_wizard_create,
124         .retrieve_id = bucket_http_test_wizard_retrieve_id,
125         .delete = bucket_http_test_wizard_delete,
126 };
127
128 static struct ast_sorcery_wizard bucket_file_test_wizard = {
129         .name = "httptest",
130         .create = bucket_http_test_wizard_create,
131         .update = bucket_http_test_wizard_update,
132         .retrieve_id = bucket_http_test_wizard_retrieve_id,
133         .delete = bucket_http_test_wizard_delete,
134 };
135
136 AST_TEST_DEFINE(exists_nominal)
137 {
138         int res;
139
140         switch (cmd) {
141         case TEST_INIT:
142                 info->name = __func__;
143                 info->category = CATEGORY;
144                 info->summary = "Test nominal existance of resources in the cache";
145                 info->description =
146                         "This test verifies that if a known resource is in the cache, "
147                         "calling ast_media_cache_exists will return logical True. If "
148                         "a resource does not exist, the same function call will return "
149                         "logical False.";
150                 return AST_TEST_NOT_RUN;
151         case TEST_EXECUTE:
152                 break;
153         }
154
155         res = ast_media_cache_exists(INVALID_RESOURCE);
156         ast_test_validate(test, res == 0);
157
158         res = ast_media_cache_exists(VALID_RESOURCE);
159         ast_test_validate(test, res == 1);
160
161         return AST_TEST_PASS;
162 }
163
164 AST_TEST_DEFINE(exists_off_nominal)
165 {
166         int res;
167
168         switch (cmd) {
169         case TEST_INIT:
170                 info->name = __func__;
171                 info->category = CATEGORY;
172                 info->summary = "Test off nominal existance of resources in the cache";
173                 info->description =
174                         "This test verifies that checking for bad resources (NULL, bad "
175                         "scheme, etc.) does not result in false positivies.";
176                 return AST_TEST_NOT_RUN;
177         case TEST_EXECUTE:
178                 break;
179         }
180
181         res = ast_media_cache_exists("");
182         ast_test_validate(test, res != 1);
183
184         res = ast_media_cache_exists(NULL);
185         ast_test_validate(test, res != 1);
186
187         res = ast_media_cache_exists(NO_SCHEME);
188         ast_test_validate(test, res != 1);
189
190         res = ast_media_cache_exists(INVALID_SCHEME);
191         ast_test_validate(test, res != 1);
192
193         return AST_TEST_PASS;
194 }
195
196 AST_TEST_DEFINE(create_update_nominal)
197 {
198         int res;
199         char file_path[PATH_MAX];
200         char tmp_path_one[PATH_MAX] = "/tmp/test-media-cache-XXXXXX";
201         char tmp_path_two[PATH_MAX] = "/tmp/test-media-cache-XXXXXX";
202         int fd;
203
204         switch (cmd) {
205         case TEST_INIT:
206                 info->name = __func__;
207                 info->category = CATEGORY;
208                 info->summary = "Test nominal creation/updating of a resource";
209                 info->description =
210                         "This test creates a resource and associates it with a file. "
211                         "It then updates the resource with a new file. In both cases, "
212                         "the test verifies that the resource is associated with the "
213                         "file.";
214                 return AST_TEST_NOT_RUN;
215         case TEST_EXECUTE:
216                 break;
217         }
218
219         /* Create two local files to associate with a resource */
220         fd = mkstemp(tmp_path_one);
221         if (fd < 0) {
222                 ast_test_status_update(test, "Failed to create first tmp file: %s\n",
223                         tmp_path_one);
224                 return AST_TEST_FAIL;
225         }
226         /* We don't need anything in the file */
227         close(fd);
228
229         fd = mkstemp(tmp_path_two);
230         if (fd < 0) {
231                 ast_test_status_update(test, "Failed to create second tmp file: %s\n",
232                         tmp_path_two);
233                 return AST_TEST_FAIL;
234         }
235         close(fd);
236
237         ast_test_status_update(test, "Creating resource with %s\n", tmp_path_one);
238         res = ast_media_cache_create_or_update(VALID_RESOURCE, tmp_path_one, NULL);
239         ast_test_validate(test, res == 0);
240
241         res = ast_media_cache_retrieve(VALID_RESOURCE, NULL, file_path, PATH_MAX);
242         ast_test_status_update(test, "Got %s for first file path\n", file_path);
243         ast_test_validate(test, res == 0);
244         ast_test_validate(test, strcmp(file_path, tmp_path_one) == 0);
245
246         ast_test_status_update(test, "Creating resource with %s\n", tmp_path_two);
247         res = ast_media_cache_create_or_update(VALID_RESOURCE, tmp_path_two, NULL);
248         ast_test_validate(test, res == 0);
249
250         res = ast_media_cache_retrieve(VALID_RESOURCE, NULL, file_path, PATH_MAX);
251         ast_test_status_update(test, "Got %s for second file path\n", file_path);
252         ast_test_validate(test, res == 0);
253         ast_test_validate(test, strcmp(file_path, tmp_path_two) == 0);
254
255         unlink(tmp_path_one);
256         unlink(tmp_path_two);
257
258         return AST_TEST_PASS;
259 }
260
261 AST_TEST_DEFINE(create_update_off_nominal)
262 {
263         int res;
264         char tmp_path[PATH_MAX] = "/tmp/test-media-cache-XXXXXX";
265         int fd;
266
267         switch (cmd) {
268         case TEST_INIT:
269                 info->name = __func__;
270                 info->category = CATEGORY;
271                 info->summary = "Test off nominal creation/updating of a resource";
272                 info->description =
273                         "Test creation/updating of a resource with a variety of invalid\n"
274                         "inputs.";
275                 return AST_TEST_NOT_RUN;
276         case TEST_EXECUTE:
277                 break;
278         }
279
280         /* Create two local files to associate with a resource */
281         fd = mkstemp(tmp_path);
282         if (fd < 0) {
283                 ast_test_status_update(test, "Failed to create first tmp file: %s\n",
284                         tmp_path);
285                 return AST_TEST_FAIL;
286         }
287         /* We don't need anything in the file */
288         close(fd);
289
290         res = ast_media_cache_create_or_update(VALID_RESOURCE, NULL, NULL);
291         ast_test_validate(test, res != 0);
292
293         res = ast_media_cache_create_or_update(VALID_RESOURCE, "", NULL);
294         ast_test_validate(test, res != 0);
295
296         res = ast_media_cache_create_or_update(VALID_RESOURCE, "I don't exist", NULL);
297         ast_test_validate(test, res != 0);
298
299         res = ast_media_cache_create_or_update(INVALID_RESOURCE, tmp_path, NULL);
300         ast_test_validate(test, res != 0);
301
302         res = ast_media_cache_create_or_update(INVALID_SCHEME, tmp_path, NULL);
303         ast_test_validate(test, res != 0);
304
305         res = ast_media_cache_create_or_update(NO_SCHEME, tmp_path, NULL);
306         ast_test_validate(test, res != 0);
307
308         unlink(tmp_path);
309
310         return AST_TEST_PASS;
311 }
312
313 AST_TEST_DEFINE(create_update_metadata)
314 {
315         int res;
316         char tmp_path[PATH_MAX] = "/tmp/test-media-cache-XXXXXX";
317         char file_path[PATH_MAX];
318         char actual_metadata[32];
319         struct ast_variable *meta_list = NULL;
320         struct ast_variable *tmp;
321         int fd;
322
323         switch (cmd) {
324         case TEST_INIT:
325                 info->name = __func__;
326                 info->category = CATEGORY;
327                 info->summary = "Test nominal creation/updating of a resource";
328                 info->description =
329                         "This test creates a resource and associates it with a file. "
330                         "It then updates the resource with a new file. In both cases, "
331                         "the test verifies that the resource is associated with the "
332                         "file.";
333                 return AST_TEST_NOT_RUN;
334         case TEST_EXECUTE:
335                 break;
336         }
337
338         /* Create two local files to associate with a resource */
339         fd = mkstemp(tmp_path);
340         if (fd < 0) {
341                 ast_test_status_update(test, "Failed to create first tmp file: %s\n",
342                         tmp_path);
343                 return AST_TEST_FAIL;
344         }
345         /* We don't need anything in the file */
346         close(fd);
347
348         tmp = ast_variable_new("meta1", "value1", __FILE__);
349         if (!tmp) {
350                 ast_test_status_update(test, "Failed to create metadata 1 for test\n");
351                 return AST_TEST_FAIL;
352         }
353         ast_variable_list_append(&meta_list, tmp);
354
355         tmp = ast_variable_new("meta2", "value2", __FILE__);
356         if (!tmp) {
357                 ast_test_status_update(test, "Failed to create metadata 2 for test\n");
358                 return AST_TEST_FAIL;
359         }
360         ast_variable_list_append(&meta_list, tmp);
361
362         res = ast_media_cache_create_or_update(VALID_RESOURCE, tmp_path, meta_list);
363         ast_test_validate(test, res == 0);
364
365         res = ast_media_cache_retrieve(VALID_RESOURCE, NULL, file_path, PATH_MAX);
366         ast_test_status_update(test, "Got %s for second file path\n", file_path);
367         ast_test_validate(test, res == 0);
368         ast_test_validate(test, strcmp(file_path, tmp_path) == 0);
369
370         res = ast_media_cache_retrieve_metadata(VALID_RESOURCE, "meta1",
371                 actual_metadata, sizeof(actual_metadata));
372         ast_test_validate(test, res == 0);
373         ast_test_validate(test, strcmp(actual_metadata, "value1") == 0);
374
375         res = ast_media_cache_retrieve_metadata(VALID_RESOURCE, "meta2",
376                 actual_metadata, sizeof(actual_metadata));
377         ast_test_validate(test, res == 0);
378         ast_test_validate(test, strcmp(actual_metadata, "value2") == 0);
379
380         unlink(tmp_path);
381
382         return AST_TEST_PASS;
383 }
384
385 static int unload_module(void)
386 {
387         AST_TEST_UNREGISTER(exists_nominal);
388         AST_TEST_UNREGISTER(exists_off_nominal);
389
390         AST_TEST_UNREGISTER(create_update_nominal);
391         AST_TEST_UNREGISTER(create_update_metadata);
392         AST_TEST_UNREGISTER(create_update_off_nominal);
393
394         return 0;
395 }
396
397 static int load_module(void)
398 {
399         if (ast_bucket_scheme_register("httptest", &bucket_test_wizard,
400                 &bucket_file_test_wizard, NULL, NULL)) {
401                 ast_log(LOG_ERROR, "Failed to register Bucket HTTP test wizard scheme implementation\n");
402                 return AST_MODULE_LOAD_FAILURE;
403         }
404
405         AST_TEST_REGISTER(exists_nominal);
406         AST_TEST_REGISTER(exists_off_nominal);
407
408         AST_TEST_REGISTER(create_update_nominal);
409         AST_TEST_REGISTER(create_update_metadata);
410         AST_TEST_REGISTER(create_update_off_nominal);
411
412         return AST_MODULE_LOAD_SUCCESS;
413 }
414
415 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Media Cache Tests");