res_ari: Add http prefix to generated docs
[asterisk/asterisk.git] / tests / test_ari.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@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 Test ARI API.
22  * \author\verbatim David M. Lee, II <dlee@digium.com> \endverbatim
23  *
24  * \ingroup tests
25  */
26
27 /*** MODULEINFO
28         <depend>TEST_FRAMEWORK</depend>
29         <depend>res_ari</depend>
30         <support_level>core</support_level>
31  ***/
32
33 #include "asterisk.h"
34
35 ASTERISK_REGISTER_FILE()
36
37 #include "asterisk/module.h"
38 #include "asterisk/test.h"
39 #include "asterisk/ari.h"
40
41 /*!@{*/
42
43 /*!
44  * \internal
45  * The following code defines a simple RESTful API for unit testing. The
46  * response encodes the inputs of the invocation. The invocation_count
47  * counter is also incremented.
48  *
49  *  - /foo (GET)
50  *  - /foo/bar (GET, POST)
51  *  - /foo/{bam} (GET)
52  *  - /foo/{bam}/bang (GET, POST, DE1LETE)
53  */
54
55 static int invocation_count;
56
57 /*!
58  * \internal
59  * Shared code for all handlers
60  */
61 static void handler(const char *name,
62                     int response_code,
63                     struct ast_variable *get_params,
64                     struct ast_variable *path_vars,
65                     struct ast_variable *headers,
66                     struct ast_ari_response *response)
67 {
68         struct ast_json *message = ast_json_pack("{s: s, s: {}, s: {}, s: {}}",
69                                                  "name", name,
70                                                  "get_params",
71                                                  "path_vars",
72                                                  "headers");
73         struct ast_json *get_params_obj = ast_json_object_get(message, "get_params");
74         struct ast_json *path_vars_obj = ast_json_object_get(message, "path_vars");
75         struct ast_json *headers_obj = ast_json_object_get(message, "headers");
76
77         for (; get_params != NULL; get_params = get_params->next) {
78                 ast_json_object_set(get_params_obj, get_params->name, ast_json_string_create(get_params->value));
79         }
80
81         for (; path_vars != NULL; path_vars = path_vars->next) {
82                 ast_json_object_set(path_vars_obj, path_vars->name, ast_json_string_create(path_vars->value));
83         }
84
85         for (; headers != NULL; headers = headers->next) {
86                 ast_json_object_set(headers_obj, headers->name, ast_json_string_create(headers->value));
87         }
88
89         ++invocation_count;
90         response->response_code = response_code;
91         response->message = message;
92 }
93
94 /*!
95  * \internal
96  * Macro to reduce the handler definition boiler-plate.
97  */
98 #define HANDLER(name, response_code)                                    \
99         static void name(struct ast_tcptls_session_instance *ser,       \
100                 struct ast_variable *get_params,                        \
101                 struct ast_variable *path_vars,                         \
102                 struct ast_variable *headers,                           \
103                 struct ast_ari_response *response)                      \
104         {                                                               \
105                 handler(#name, response_code, get_params, path_vars, headers, response); \
106         }
107
108 HANDLER(bang_get, 200)
109 HANDLER(bang_post, 200)
110 HANDLER(bang_delete, 204)
111 HANDLER(bar_get, 200)
112 HANDLER(bar_post, 200)
113 HANDLER(bam_get, 200)
114 HANDLER(foo_get, 200)
115
116 static struct stasis_rest_handlers bang = {
117         .path_segment = "bang",
118         .callbacks = {
119                 [AST_HTTP_GET] = bang_get,
120                 [AST_HTTP_POST] = bang_post,
121                 [AST_HTTP_DELETE] = bang_delete,
122         },
123         .num_children = 0
124 };
125 static struct stasis_rest_handlers bar = {
126         .path_segment = "bar",
127         .callbacks = {
128                 [AST_HTTP_GET] = bar_get,
129                 [AST_HTTP_POST] = bar_post,
130         },
131         .num_children = 0
132 };
133 static struct stasis_rest_handlers bam = {
134         .path_segment = "bam",
135         .is_wildcard = 1,
136         .callbacks = {
137                 [AST_HTTP_GET] = bam_get,
138         },
139         .num_children = 1,
140         .children = { &bang }
141 };
142 static struct stasis_rest_handlers test_root = {
143         .path_segment = "foo",
144         .callbacks = {
145                 [AST_HTTP_GET] = foo_get,
146         },
147         .num_children = 3,
148         .children = { &bar, &bam, &bang }
149 };
150 /*!@}*/
151
152 /*!
153  * \internal
154  * \c ast_ari_response constructor.
155  */
156 static struct ast_ari_response *response_alloc(void)
157 {
158         struct ast_ari_response *resp = ast_calloc(1, sizeof(struct ast_ari_response));
159         resp->headers = ast_str_create(24);
160         return resp;
161 }
162
163 /*!
164  * \internal
165  * \c ast_ari_response destructor.
166  */
167 static void response_free(struct ast_ari_response *resp)
168 {
169         if (!resp) {
170                 return;
171         }
172         ast_free(resp->headers);
173         ast_json_unref(resp->message);
174         ast_free(resp);
175 }
176
177 /*!
178  * \ internal
179  * Setup test fixture for invocation tests.
180  */
181 static void *setup_invocation_test(void) {
182         int r;
183         invocation_count = 0;
184         r = ast_ari_add_handler(&test_root);
185         ast_assert(r == 0);
186         return &invocation_count;
187 }
188
189 /*!
190  * \ internal
191  * Tear down test fixture for invocation tests.
192  */
193 static void tear_down_invocation_test(void *ignore) {
194         if (!ignore) {
195                 return;
196         }
197         ast_ari_remove_handler(&test_root);
198 }
199
200
201 AST_TEST_DEFINE(get_docs)
202 {
203         RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
204         RAII_VAR(struct ast_variable *, headers, NULL, ast_variables_destroy);
205         struct ast_json *basePathJson;
206         const char *basePath;
207
208         switch (cmd) {
209         case TEST_INIT:
210                 info->name = __func__;
211                 info->category = "/res/ari/";
212                 info->summary = "Test simple API get.";
213                 info->description = "Test ARI binding logic.";
214                 return AST_TEST_NOT_RUN;
215         case TEST_EXECUTE:
216                 break;
217         }
218
219         response = response_alloc();
220         headers = ast_variable_new("Host", "stasis.asterisk.org", __FILE__);
221         ast_ari_get_docs("resources.json", "", headers, response);
222         ast_test_validate(test, 200 == response->response_code);
223
224         /* basePath should be relative to the Host header */
225         basePathJson = ast_json_object_get(response->message, "basePath");
226         ast_test_validate(test, NULL != basePathJson);
227         basePath = ast_json_string_get(basePathJson);
228         ast_test_validate(test, 0 == strcmp("http://stasis.asterisk.org/ari", basePath));
229
230         return AST_TEST_PASS;
231 }
232
233 AST_TEST_DEFINE(get_docs_nohost)
234 {
235         RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
236         struct ast_variable *headers = NULL;
237         struct ast_json *basePathJson;
238
239         switch (cmd) {
240         case TEST_INIT:
241                 info->name = __func__;
242                 info->category = "/res/ari/";
243                 info->summary = "Test API get without a Host header";
244                 info->description = "Test ARI binding logic.";
245                 return AST_TEST_NOT_RUN;
246         case TEST_EXECUTE:
247                 break;
248         }
249
250         response = response_alloc();
251         ast_ari_get_docs("resources.json",  "", headers, response);
252         ast_test_validate(test, 200 == response->response_code);
253
254         /* basePath should be relative to the Host header */
255         basePathJson = ast_json_object_get(response->message, "basePath");
256         ast_test_validate(test, NULL == basePathJson);
257
258         return AST_TEST_PASS;
259 }
260
261 AST_TEST_DEFINE(get_docs_notfound)
262 {
263         RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
264         struct ast_variable *headers = NULL;
265
266         switch (cmd) {
267         case TEST_INIT:
268                 info->name = __func__;
269                 info->category = "/res/ari/";
270                 info->summary = "Test API get for invalid resource";
271                 info->description = "Test ARI binding logic.";
272                 return AST_TEST_NOT_RUN;
273         case TEST_EXECUTE:
274                 break;
275         }
276
277         response = response_alloc();
278         ast_ari_get_docs("i-am-not-a-resource.json", "", headers, response);
279         ast_test_validate(test, 404 == response->response_code);
280
281         return AST_TEST_PASS;
282 }
283
284 AST_TEST_DEFINE(get_docs_hackerz)
285 {
286         RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
287         struct ast_variable *headers = NULL;
288
289         switch (cmd) {
290         case TEST_INIT:
291                 info->name = __func__;
292                 info->category = "/res/ari/";
293                 info->summary = "Test API get for a file outside the rest-api path";
294                 info->description = "Test ARI binding logic.";
295                 return AST_TEST_NOT_RUN;
296         case TEST_EXECUTE:
297                 break;
298         }
299
300         response = response_alloc();
301         ast_ari_get_docs("../../../../sbin/asterisk", "", headers, response);
302         ast_test_validate(test, 404 == response->response_code);
303
304         return AST_TEST_PASS;
305 }
306
307 AST_TEST_DEFINE(invoke_get)
308 {
309         RAII_VAR(void *, fixture, NULL, tear_down_invocation_test);
310         RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
311         RAII_VAR(struct ast_json *, expected, NULL, ast_json_unref);
312         struct ast_variable *get_params = NULL;
313         struct ast_variable *headers = NULL;
314
315         switch (cmd) {
316         case TEST_INIT:
317                 info->name = __func__;
318                 info->category = "/res/ari/";
319                 info->summary = "Test simple GET of an HTTP resource.";
320                 info->description = "Test ARI binding logic.";
321                 return AST_TEST_NOT_RUN;
322         case TEST_EXECUTE:
323                 break;
324         }
325
326         fixture = setup_invocation_test();
327         response = response_alloc();
328         get_params = ast_variable_new("get1", "get-one", __FILE__);
329         ast_assert(get_params != NULL);
330         get_params->next = ast_variable_new("get2", "get-two", __FILE__);
331         ast_assert(get_params->next != NULL);
332
333         headers = ast_variable_new("head1", "head-one", __FILE__);
334         ast_assert(headers != NULL);
335         headers->next = ast_variable_new("head2", "head-two", __FILE__);
336         ast_assert(headers->next != NULL);
337
338         expected = ast_json_pack("{s: s, s: {s: s, s: s}, s: {s: s, s: s}, s: {}}",
339                                  "name", "foo_get",
340                                  "get_params",
341                                  "get1", "get-one",
342                                  "get2", "get-two",
343                                  "headers",
344                                  "head1", "head-one",
345                                  "head2", "head-two",
346                                  "path_vars");
347
348         ast_ari_invoke(NULL, "foo", AST_HTTP_GET, get_params, headers, response);
349
350         ast_test_validate(test, 1 == invocation_count);
351         ast_test_validate(test, 200 == response->response_code);
352         ast_test_validate(test, ast_json_equal(expected, response->message));
353
354         return AST_TEST_PASS;
355 }
356
357 AST_TEST_DEFINE(invoke_wildcard)
358 {
359         RAII_VAR(void *, fixture, NULL, tear_down_invocation_test);
360         RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
361         RAII_VAR(struct ast_json *, expected, NULL, ast_json_unref);
362         struct ast_variable *get_params = NULL;
363         struct ast_variable *headers = NULL;
364
365         switch (cmd) {
366         case TEST_INIT:
367                 info->name = __func__;
368                 info->category = "/res/ari/";
369                 info->summary = "Test GET of a wildcard resource.";
370                 info->description = "Test ARI binding logic.";
371                 return AST_TEST_NOT_RUN;
372         case TEST_EXECUTE:
373                 break;
374         }
375
376         fixture = setup_invocation_test();
377         response = response_alloc();
378         expected = ast_json_pack("{s: s, s: {}, s: {}, s: {s: s}}",
379                                  "name", "bam_get",
380                                  "get_params",
381                                  "headers",
382                                  "path_vars",
383                                  "bam", "foshizzle");
384
385         ast_ari_invoke(NULL, "foo/foshizzle", AST_HTTP_GET, get_params, headers, response);
386
387         ast_test_validate(test, 1 == invocation_count);
388         ast_test_validate(test, 200 == response->response_code);
389         ast_test_validate(test, ast_json_equal(expected, response->message));
390
391         return AST_TEST_PASS;
392 }
393
394 AST_TEST_DEFINE(invoke_delete)
395 {
396         RAII_VAR(void *, fixture, NULL, tear_down_invocation_test);
397         RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
398         RAII_VAR(struct ast_json *, expected, NULL, ast_json_unref);
399         struct ast_variable *get_params = NULL;
400         struct ast_variable *headers = NULL;
401
402         switch (cmd) {
403         case TEST_INIT:
404                 info->name = __func__;
405                 info->category = "/res/ari/";
406                 info->summary = "Test DELETE of an HTTP resource.";
407                 info->description = "Test ARI binding logic.";
408                 return AST_TEST_NOT_RUN;
409         case TEST_EXECUTE:
410                 break;
411         }
412
413         fixture = setup_invocation_test();
414         response = response_alloc();
415         expected = ast_json_pack("{s: s, s: {}, s: {}, s: {s: s}}",
416                                  "name", "bang_delete",
417                                  "get_params",
418                                  "headers",
419                                  "path_vars",
420                                  "bam", "foshizzle");
421
422         ast_ari_invoke(NULL, "foo/foshizzle/bang", AST_HTTP_DELETE, get_params, headers, response);
423
424         ast_test_validate(test, 1 == invocation_count);
425         ast_test_validate(test, 204 == response->response_code);
426         ast_test_validate(test, ast_json_equal(expected, response->message));
427
428         return AST_TEST_PASS;
429 }
430
431 AST_TEST_DEFINE(invoke_post)
432 {
433         RAII_VAR(void *, fixture, NULL, tear_down_invocation_test);
434         RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
435         RAII_VAR(struct ast_json *, expected, NULL, ast_json_unref);
436         struct ast_variable *get_params = NULL;
437         struct ast_variable *headers = NULL;
438
439         switch (cmd) {
440         case TEST_INIT:
441                 info->name = __func__;
442                 info->category = "/res/ari/";
443                 info->summary = "Test POST of an HTTP resource.";
444                 info->description = "Test ARI binding logic.";
445                 return AST_TEST_NOT_RUN;
446         case TEST_EXECUTE:
447                 break;
448         }
449
450         fixture = setup_invocation_test();
451         response = response_alloc();
452         get_params = ast_variable_new("get1", "get-one", __FILE__);
453         ast_assert(get_params != NULL);
454         get_params->next = ast_variable_new("get2", "get-two", __FILE__);
455         ast_assert(get_params->next != NULL);
456
457         headers = ast_variable_new("head1", "head-one", __FILE__);
458         ast_assert(headers != NULL);
459         headers->next = ast_variable_new("head2", "head-two", __FILE__);
460         ast_assert(headers->next != NULL);
461
462         expected = ast_json_pack("{s: s, s: {s: s, s: s}, s: {s: s, s: s}, s: {}}",
463                                  "name", "bar_post",
464                                  "get_params",
465                                  "get1", "get-one",
466                                  "get2", "get-two",
467                                  "headers",
468                                  "head1", "head-one",
469                                  "head2", "head-two",
470                                  "path_vars");
471
472         ast_ari_invoke(NULL, "foo/bar", AST_HTTP_POST, get_params, headers, response);
473
474         ast_test_validate(test, 1 == invocation_count);
475         ast_test_validate(test, 200 == response->response_code);
476         ast_test_validate(test, ast_json_equal(expected, response->message));
477
478         return AST_TEST_PASS;
479 }
480
481 AST_TEST_DEFINE(invoke_bad_post)
482 {
483         RAII_VAR(void *, fixture, NULL, tear_down_invocation_test);
484         RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
485         struct ast_variable *get_params = NULL;
486         struct ast_variable *headers = NULL;
487
488         switch (cmd) {
489         case TEST_INIT:
490                 info->name = __func__;
491                 info->category = "/res/ari/";
492                 info->summary = "Test POST on a resource that doesn't support it.";
493                 info->description = "Test ARI binding logic.";
494                 return AST_TEST_NOT_RUN;
495         case TEST_EXECUTE:
496                 break;
497         }
498
499         fixture = setup_invocation_test();
500         response = response_alloc();
501         ast_ari_invoke(NULL, "foo", AST_HTTP_POST, get_params, headers, response);
502
503         ast_test_validate(test, 0 == invocation_count);
504         ast_test_validate(test, 405 == response->response_code);
505
506         return AST_TEST_PASS;
507 }
508
509 AST_TEST_DEFINE(invoke_not_found)
510 {
511         RAII_VAR(void *, fixture, NULL, tear_down_invocation_test);
512         RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
513         struct ast_variable *get_params = NULL;
514         struct ast_variable *headers = NULL;
515
516         switch (cmd) {
517         case TEST_INIT:
518                 info->name = __func__;
519                 info->category = "/res/ari/";
520                 info->summary = "Test GET on a resource that does not exist.";
521                 info->description = "Test ARI binding logic.";
522                 return AST_TEST_NOT_RUN;
523         case TEST_EXECUTE:
524                 break;
525         }
526
527         fixture = setup_invocation_test();
528         response = response_alloc();
529         ast_ari_invoke(NULL, "foo/fizzle/i-am-not-a-resource", AST_HTTP_GET, get_params, headers, response);
530
531         ast_test_validate(test, 0 == invocation_count);
532         ast_test_validate(test, 404 == response->response_code);
533
534         return AST_TEST_PASS;
535 }
536
537 static int unload_module(void)
538 {
539         AST_TEST_UNREGISTER(get_docs);
540         AST_TEST_UNREGISTER(get_docs_nohost);
541         AST_TEST_UNREGISTER(get_docs_notfound);
542         AST_TEST_UNREGISTER(get_docs_hackerz);
543         AST_TEST_UNREGISTER(invoke_get);
544         AST_TEST_UNREGISTER(invoke_wildcard);
545         AST_TEST_UNREGISTER(invoke_delete);
546         AST_TEST_UNREGISTER(invoke_post);
547         AST_TEST_UNREGISTER(invoke_bad_post);
548         AST_TEST_UNREGISTER(invoke_not_found);
549         return 0;
550 }
551
552 static int load_module(void)
553 {
554         AST_TEST_REGISTER(get_docs);
555         AST_TEST_REGISTER(get_docs_nohost);
556         AST_TEST_REGISTER(get_docs_notfound);
557         AST_TEST_REGISTER(get_docs_hackerz);
558         AST_TEST_REGISTER(invoke_get);
559         AST_TEST_REGISTER(invoke_wildcard);
560         AST_TEST_REGISTER(invoke_delete);
561         AST_TEST_REGISTER(invoke_post);
562         AST_TEST_REGISTER(invoke_bad_post);
563         AST_TEST_REGISTER(invoke_not_found);
564         return AST_MODULE_LOAD_SUCCESS;
565 }
566
567 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "ARI testing",
568         .load = load_module,
569         .unload = unload_module,
570         .nonoptreq = "res_ari",
571 );