Merge "doc/lang/language-criteria.txt: Link to wiki."
[asterisk/asterisk.git] / tests / test_websocket_client.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2014, Digium, Inc.
5  *
6  * Kevin Harwell <kharwell@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 Websocket Client Unit Tests
22  *
23  * \author Kevin Harwell <kharwell@digium.com>
24  *
25  */
26
27 /*** MODULEINFO
28         <depend>TEST_FRAMEWORK</depend>
29         <depend>res_http_websocket</depend>
30         <support_level>core</support_level>
31  ***/
32
33 #include "asterisk.h"
34
35 #include "asterisk/test.h"
36 #include "asterisk/module.h"
37 #include "asterisk/astobj2.h"
38 #include "asterisk/pbx.h"
39 #include "asterisk/http_websocket.h"
40
41 #define CATEGORY "/res/websocket/"
42 #define REMOTE_URL "ws://127.0.0.1:8088/ws"
43
44 AST_TEST_DEFINE(websocket_client_create_and_connect)
45 {
46         RAII_VAR(struct ast_websocket *, client, NULL, ao2_cleanup);
47
48         enum ast_websocket_result result;
49         const char write_buf[] = "this is only a test";
50         RAII_VAR(char *, read_buf, NULL, ast_free);
51
52         switch (cmd) {
53         case TEST_INIT:
54                 info->name = __func__;
55                 info->category = CATEGORY;
56                 info->summary = "test creation and connection of a client websocket";
57                 info->description = "test creation and connection of a client websocket";
58                 return AST_TEST_NOT_RUN;
59         case TEST_EXECUTE:
60                 break;
61         }
62
63         ast_test_validate(test, (client = ast_websocket_client_create(
64                                          REMOTE_URL, "echo", NULL, &result)));
65
66         ast_test_validate(test, !ast_websocket_write_string(client, write_buf));
67         ast_test_validate(test, ast_websocket_read_string(client, &read_buf) > 0);
68         ast_test_validate(test, !strcmp(write_buf, read_buf));
69
70         return AST_TEST_PASS;
71 }
72
73 AST_TEST_DEFINE(websocket_client_bad_url)
74 {
75         RAII_VAR(struct ast_websocket *, client, NULL, ao2_cleanup);
76         enum ast_websocket_result result;
77
78         switch (cmd) {
79         case TEST_INIT:
80                 info->name = __func__;
81                 info->category = CATEGORY;
82                 info->summary = "websocket client - test bad url";
83                 info->description = "pass a bad url and make sure it fails";
84                 return AST_TEST_NOT_RUN;
85         case TEST_EXECUTE:
86                 break;
87         }
88
89         ast_test_validate(test, !(client = ast_websocket_client_create(
90                                           "invalid", NULL, NULL, &result)));
91         return AST_TEST_PASS;
92 }
93
94 AST_TEST_DEFINE(websocket_client_unsupported_protocol)
95 {
96         RAII_VAR(struct ast_websocket *, client, NULL, ao2_cleanup);
97         enum ast_websocket_result result;
98
99         switch (cmd) {
100         case TEST_INIT:
101                 info->name = __func__;
102                 info->category = CATEGORY;
103                 info->summary = "websocket client - unsupported protocol";
104                 info->description = "fails on an unsupported protocol";
105                 return AST_TEST_NOT_RUN;
106         case TEST_EXECUTE:
107                 break;
108         }
109
110         ast_test_validate(test, !(client = ast_websocket_client_create(
111                                           REMOTE_URL, "unsupported", NULL, &result)));
112         return AST_TEST_PASS;
113 }
114
115 AST_TEST_DEFINE(websocket_client_multiple_protocols)
116 {
117         RAII_VAR(struct ast_websocket *, client, NULL, ao2_cleanup);
118         const char *accept_protocol;
119         enum ast_websocket_result result;
120
121         switch (cmd) {
122         case TEST_INIT:
123                 info->name = __func__;
124                 info->category = CATEGORY;
125                 info->summary = "websocket client - test multiple protocols";
126                 info->description = "test multi-protocol client";
127                 return AST_TEST_NOT_RUN;
128         case TEST_EXECUTE:
129                 break;
130         }
131
132         ast_test_validate(test, (client = ast_websocket_client_create(
133                                          REMOTE_URL, "echo,unsupported", NULL, &result)));
134
135         accept_protocol = ast_websocket_client_accept_protocol(client);
136         ast_test_validate(test, accept_protocol && !strcmp(accept_protocol, "echo"));
137
138         return AST_TEST_PASS;
139 }
140
141 static int load_module(void)
142 {
143         AST_TEST_REGISTER(websocket_client_create_and_connect);
144         AST_TEST_REGISTER(websocket_client_bad_url);
145         AST_TEST_REGISTER(websocket_client_unsupported_protocol);
146         AST_TEST_REGISTER(websocket_client_multiple_protocols);
147         return AST_MODULE_LOAD_SUCCESS;
148 }
149
150 static int unload_module(void)
151 {
152         AST_TEST_UNREGISTER(websocket_client_multiple_protocols);
153         AST_TEST_UNREGISTER(websocket_client_unsupported_protocol);
154         AST_TEST_UNREGISTER(websocket_client_bad_url);
155         AST_TEST_UNREGISTER(websocket_client_create_and_connect);
156         return 0;
157 }
158
159 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Websocket client test module",
160         .support_level = AST_MODULE_SUPPORT_CORE,
161         .load = load_module,
162         .unload = unload_module,
163         .requires = "res_http_websocket",
164 );