Jacob Erlbeck | ae15a2c | 2013-08-06 14:29:14 +0200 | [diff] [blame] | 1 | /* (C) 2013 by Jacob Erlbeck <jerlbeck@sysmocom.de> |
| 2 | * All Rights Reserved |
| 3 | * |
| 4 | * This program is iree software; you can redistribute it and/or modify |
| 5 | * it under the terms of the GNU General Public License as published by |
| 6 | * the Free Software Foundation; either version 3 of the License, or |
| 7 | * (at your option) any later version. |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License along |
| 15 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 16 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 17 | * |
| 18 | */ |
| 19 | |
| 20 | #include <stdio.h> |
| 21 | #include <string.h> |
| 22 | |
Jacob Erlbeck | 0c987bd | 2013-09-06 16:52:00 +0200 | [diff] [blame] | 23 | #include <sys/types.h> |
| 24 | #include <sys/socket.h> |
| 25 | #include <sys/un.h> |
| 26 | |
Holger Hans Peter Freyther | 6ef71b0 | 2013-09-10 11:17:46 +0200 | [diff] [blame] | 27 | #include <osmocom/core/application.h> |
Jacob Erlbeck | ae15a2c | 2013-08-06 14:29:14 +0200 | [diff] [blame] | 28 | #include <osmocom/core/talloc.h> |
| 29 | #include <osmocom/core/logging.h> |
Jacob Erlbeck | be37fb7 | 2015-11-03 15:21:34 +0100 | [diff] [blame] | 30 | #include <osmocom/core/stats.h> |
Jacob Erlbeck | ae15a2c | 2013-08-06 14:29:14 +0200 | [diff] [blame] | 31 | #include <osmocom/core/utils.h> |
Holger Hans Peter Freyther | 2c9168c | 2013-10-10 20:21:33 +0200 | [diff] [blame] | 32 | #include <osmocom/core/signal.h> |
Jacob Erlbeck | ae15a2c | 2013-08-06 14:29:14 +0200 | [diff] [blame] | 33 | #include <osmocom/vty/misc.h> |
Jacob Erlbeck | 0c987bd | 2013-09-06 16:52:00 +0200 | [diff] [blame] | 34 | #include <osmocom/vty/vty.h> |
| 35 | #include <osmocom/vty/command.h> |
| 36 | #include <osmocom/vty/buffer.h> |
Holger Hans Peter Freyther | 6ef71b0 | 2013-09-10 11:17:46 +0200 | [diff] [blame] | 37 | #include <osmocom/vty/logging.h> |
Jacob Erlbeck | be37fb7 | 2015-11-03 15:21:34 +0100 | [diff] [blame] | 38 | #include <osmocom/vty/stats.h> |
Jacob Erlbeck | 0c987bd | 2013-09-06 16:52:00 +0200 | [diff] [blame] | 39 | |
| 40 | static enum event last_vty_connection_event = -1; |
Jacob Erlbeck | ae15a2c | 2013-08-06 14:29:14 +0200 | [diff] [blame] | 41 | |
| 42 | static void test_cmd_string_from_valstr(void) |
| 43 | { |
| 44 | char *cmd; |
| 45 | const struct value_string printf_seq_vs[] = { |
| 46 | { .value = 42, .str = "[foo%s%s%s%s%s]"}, |
| 47 | { .value = 43, .str = "[bar%s%s%s%s%s]"}, |
| 48 | { .value = 0, .str = NULL} |
| 49 | }; |
| 50 | |
| 51 | printf("Going to test vty_cmd_string_from_valstr()\n"); |
| 52 | |
| 53 | /* check against character strings that could break printf */ |
| 54 | |
| 55 | cmd = vty_cmd_string_from_valstr (NULL, printf_seq_vs, "[prefix%s%s%s%s%s]", "[sep%s%s%s%s%s]", "[end%s%s%s%s%s]", 1); |
| 56 | printf ("Tested with %%s-strings, resulting cmd = '%s'\n", cmd); |
| 57 | talloc_free (cmd); |
| 58 | } |
| 59 | |
Jacob Erlbeck | 0c987bd | 2013-09-06 16:52:00 +0200 | [diff] [blame] | 60 | static int do_vty_command(struct vty *vty, const char *cmd) |
| 61 | { |
| 62 | vector vline; |
| 63 | int ret; |
| 64 | |
| 65 | printf("Going to execute '%s'\n", cmd); |
| 66 | vline = cmd_make_strvec(cmd); |
| 67 | ret = cmd_execute_command(vline, vty, NULL, 0); |
| 68 | cmd_free_strvec(vline); |
| 69 | printf("Returned: %d, Current node: %d '%s'\n", ret, vty->node, cmd_prompt(vty->node)); |
| 70 | return ret; |
| 71 | } |
| 72 | |
Holger Hans Peter Freyther | 2c9168c | 2013-10-10 20:21:33 +0200 | [diff] [blame] | 73 | /* Handle the events from telnet_interface.c */ |
| 74 | static int vty_event_cb(unsigned int subsys, unsigned int signal, |
| 75 | void *handler_data, void *_signal_data) |
Jacob Erlbeck | 0c987bd | 2013-09-06 16:52:00 +0200 | [diff] [blame] | 76 | { |
Holger Hans Peter Freyther | 2c9168c | 2013-10-10 20:21:33 +0200 | [diff] [blame] | 77 | struct vty_signal_data *signal_data; |
Jacob Erlbeck | 0c987bd | 2013-09-06 16:52:00 +0200 | [diff] [blame] | 78 | |
Holger Hans Peter Freyther | 2c9168c | 2013-10-10 20:21:33 +0200 | [diff] [blame] | 79 | if (subsys != SS_L_VTY) |
| 80 | return 0; |
| 81 | if (signal != S_VTY_EVENT) |
| 82 | return 0; |
| 83 | |
| 84 | signal_data = _signal_data; |
| 85 | last_vty_connection_event = signal_data->event; |
| 86 | |
| 87 | fprintf(stderr, "Got VTY event: %d\n", signal_data->event); |
| 88 | return 0; |
Jacob Erlbeck | 0c987bd | 2013-09-06 16:52:00 +0200 | [diff] [blame] | 89 | } |
| 90 | |
Jacob Erlbeck | ca6602f | 2015-11-03 13:47:11 +0100 | [diff] [blame] | 91 | struct vty_test { |
| 92 | int sock[2]; |
| 93 | }; |
| 94 | |
| 95 | static struct vty* create_test_vty(struct vty_test *data) |
| 96 | { |
| 97 | struct vty *vty; |
| 98 | /* Fake connection. */ |
| 99 | socketpair(AF_UNIX, SOCK_STREAM, 0, data->sock); |
| 100 | |
| 101 | vty = vty_create(data->sock[0], NULL); |
| 102 | OSMO_ASSERT(vty != NULL); |
| 103 | OSMO_ASSERT(vty->status != VTY_CLOSE); |
| 104 | |
| 105 | return vty; |
| 106 | } |
| 107 | |
| 108 | static void destroy_test_vty(struct vty_test *data, struct vty *vty) |
| 109 | { |
| 110 | vty_close(vty); |
| 111 | OSMO_ASSERT(last_vty_connection_event == VTY_CLOSED); |
| 112 | } |
| 113 | |
Jacob Erlbeck | 0c987bd | 2013-09-06 16:52:00 +0200 | [diff] [blame] | 114 | static void test_node_tree_structure(void) |
| 115 | { |
Jacob Erlbeck | ca6602f | 2015-11-03 13:47:11 +0100 | [diff] [blame] | 116 | struct vty_test test; |
Jacob Erlbeck | 0c987bd | 2013-09-06 16:52:00 +0200 | [diff] [blame] | 117 | struct vty *vty; |
Jacob Erlbeck | 0c987bd | 2013-09-06 16:52:00 +0200 | [diff] [blame] | 118 | |
| 119 | printf("Going to test VTY node tree structure\n"); |
Jacob Erlbeck | ca6602f | 2015-11-03 13:47:11 +0100 | [diff] [blame] | 120 | vty = create_test_vty(&test); |
Jacob Erlbeck | 0c987bd | 2013-09-06 16:52:00 +0200 | [diff] [blame] | 121 | |
| 122 | OSMO_ASSERT(do_vty_command(vty, "enable") == CMD_SUCCESS); |
| 123 | OSMO_ASSERT(vty->node == ENABLE_NODE); |
| 124 | |
| 125 | OSMO_ASSERT(do_vty_command(vty, "configure terminal") == CMD_SUCCESS); |
| 126 | OSMO_ASSERT(vty->node == CONFIG_NODE); |
| 127 | OSMO_ASSERT(do_vty_command(vty, "exit") == CMD_SUCCESS); |
| 128 | OSMO_ASSERT(vty->node == ENABLE_NODE); |
| 129 | |
| 130 | OSMO_ASSERT(do_vty_command(vty, "configure terminal") == CMD_SUCCESS); |
| 131 | OSMO_ASSERT(vty->node == CONFIG_NODE); |
| 132 | OSMO_ASSERT(do_vty_command(vty, "end") == CMD_SUCCESS); |
| 133 | OSMO_ASSERT(vty->node == ENABLE_NODE); |
| 134 | |
| 135 | OSMO_ASSERT(do_vty_command(vty, "configure terminal") == CMD_SUCCESS); |
| 136 | OSMO_ASSERT(vty->node == CONFIG_NODE); |
| 137 | OSMO_ASSERT(do_vty_command(vty, "log stderr") == CMD_SUCCESS); |
| 138 | OSMO_ASSERT(vty->node == CFG_LOG_NODE); |
| 139 | OSMO_ASSERT(do_vty_command(vty, "exit") == CMD_SUCCESS); |
| 140 | OSMO_ASSERT(vty->node == CONFIG_NODE); |
| 141 | OSMO_ASSERT(do_vty_command(vty, "log stderr") == CMD_SUCCESS); |
| 142 | OSMO_ASSERT(vty->node == CFG_LOG_NODE); |
| 143 | OSMO_ASSERT(do_vty_command(vty, "end") == CMD_SUCCESS); |
| 144 | OSMO_ASSERT(vty->node == ENABLE_NODE); |
| 145 | |
| 146 | OSMO_ASSERT(do_vty_command(vty, "configure terminal") == CMD_SUCCESS); |
| 147 | OSMO_ASSERT(vty->node == CONFIG_NODE); |
| 148 | OSMO_ASSERT(do_vty_command(vty, "line vty") == CMD_SUCCESS); |
| 149 | OSMO_ASSERT(vty->node == VTY_NODE); |
| 150 | OSMO_ASSERT(do_vty_command(vty, "exit") == CMD_SUCCESS); |
| 151 | OSMO_ASSERT(vty->node == CONFIG_NODE); |
| 152 | OSMO_ASSERT(do_vty_command(vty, "line vty") == CMD_SUCCESS); |
| 153 | OSMO_ASSERT(vty->node == VTY_NODE); |
| 154 | OSMO_ASSERT(do_vty_command(vty, "end") == CMD_SUCCESS); |
| 155 | OSMO_ASSERT(vty->node == ENABLE_NODE); |
| 156 | |
| 157 | |
| 158 | /* Check searching the parents nodes for matching commands. */ |
| 159 | OSMO_ASSERT(do_vty_command(vty, "configure terminal") == CMD_SUCCESS); |
| 160 | OSMO_ASSERT(vty->node == CONFIG_NODE); |
| 161 | OSMO_ASSERT(do_vty_command(vty, "log stderr") == CMD_SUCCESS); |
| 162 | OSMO_ASSERT(vty->node == CFG_LOG_NODE); |
| 163 | OSMO_ASSERT(do_vty_command(vty, "line vty") == CMD_SUCCESS); |
| 164 | OSMO_ASSERT(vty->node == VTY_NODE); |
| 165 | OSMO_ASSERT(do_vty_command(vty, "log stderr") == CMD_SUCCESS); |
| 166 | OSMO_ASSERT(vty->node == CFG_LOG_NODE); |
| 167 | OSMO_ASSERT(do_vty_command(vty, "end") == CMD_SUCCESS); |
| 168 | OSMO_ASSERT(vty->node == ENABLE_NODE); |
| 169 | |
| 170 | /* Check for final 'exit' (connection close). */ |
| 171 | OSMO_ASSERT(do_vty_command(vty, "exit") == CMD_SUCCESS); |
| 172 | OSMO_ASSERT(vty->node == ENABLE_NODE); |
| 173 | OSMO_ASSERT(vty->status == VTY_CLOSE); |
| 174 | |
Jacob Erlbeck | ca6602f | 2015-11-03 13:47:11 +0100 | [diff] [blame] | 175 | destroy_test_vty(&test, vty); |
Jacob Erlbeck | 0c987bd | 2013-09-06 16:52:00 +0200 | [diff] [blame] | 176 | } |
| 177 | |
Jacob Erlbeck | be37fb7 | 2015-11-03 15:21:34 +0100 | [diff] [blame] | 178 | static void check_srep_vty_config(struct vty* vty, |
| 179 | struct osmo_stats_reporter *srep) |
| 180 | { |
| 181 | OSMO_ASSERT(srep->enabled == 0); |
| 182 | |
| 183 | OSMO_ASSERT(do_vty_command(vty, "prefix myprefix") == CMD_SUCCESS); |
| 184 | OSMO_ASSERT(srep->name_prefix != NULL); |
| 185 | OSMO_ASSERT(strcmp(srep->name_prefix, "myprefix") == 0); |
| 186 | OSMO_ASSERT(do_vty_command(vty, "no prefix") == CMD_SUCCESS); |
| 187 | OSMO_ASSERT(srep->name_prefix == NULL || strlen(srep->name_prefix) == 0); |
| 188 | |
| 189 | OSMO_ASSERT(srep->max_class == OSMO_STATS_CLASS_GLOBAL); |
| 190 | OSMO_ASSERT(do_vty_command(vty, "level peer") == CMD_SUCCESS); |
| 191 | OSMO_ASSERT(srep->max_class == OSMO_STATS_CLASS_PEER); |
| 192 | OSMO_ASSERT(do_vty_command(vty, "level subscriber") == CMD_SUCCESS); |
| 193 | OSMO_ASSERT(srep->max_class == OSMO_STATS_CLASS_SUBSCRIBER); |
| 194 | OSMO_ASSERT(do_vty_command(vty, "level global") == CMD_SUCCESS); |
| 195 | OSMO_ASSERT(srep->max_class == OSMO_STATS_CLASS_GLOBAL); |
| 196 | OSMO_ASSERT(do_vty_command(vty, "level foobar") == CMD_ERR_NO_MATCH); |
| 197 | |
| 198 | if (srep->have_net_config) { |
| 199 | OSMO_ASSERT(do_vty_command(vty, "remote-ip 127.0.0.99") == |
| 200 | CMD_SUCCESS); |
| 201 | OSMO_ASSERT(srep->dest_addr_str && |
| 202 | strcmp(srep->dest_addr_str, "127.0.0.99") == 0); |
| 203 | OSMO_ASSERT(do_vty_command(vty, "remote-ip 678.0.0.99") == |
| 204 | CMD_WARNING); |
| 205 | OSMO_ASSERT(srep->dest_addr_str && |
| 206 | strcmp(srep->dest_addr_str, "127.0.0.99") == 0); |
| 207 | |
| 208 | OSMO_ASSERT(do_vty_command(vty, "remote-port 12321") == |
| 209 | CMD_SUCCESS); |
| 210 | OSMO_ASSERT(srep->dest_port == 12321); |
| 211 | |
| 212 | OSMO_ASSERT(srep->bind_addr_str == NULL); |
| 213 | OSMO_ASSERT(do_vty_command(vty, "local-ip 127.0.0.98") == |
| 214 | CMD_SUCCESS); |
| 215 | OSMO_ASSERT(srep->bind_addr_str && |
| 216 | strcmp(srep->bind_addr_str, "127.0.0.98") == 0); |
| 217 | OSMO_ASSERT(do_vty_command(vty, "no local-ip") == CMD_SUCCESS); |
| 218 | OSMO_ASSERT(srep->bind_addr_str == NULL); |
| 219 | |
| 220 | OSMO_ASSERT(srep->mtu == 0); |
| 221 | OSMO_ASSERT(do_vty_command(vty, "mtu 987") == CMD_SUCCESS); |
| 222 | OSMO_ASSERT(srep->mtu == 987); |
| 223 | OSMO_ASSERT(do_vty_command(vty, "no mtu") == CMD_SUCCESS); |
| 224 | OSMO_ASSERT(srep->mtu == 0); |
| 225 | }; |
| 226 | |
| 227 | OSMO_ASSERT(do_vty_command(vty, "enable") == CMD_SUCCESS); |
| 228 | OSMO_ASSERT(srep->enabled != 0); |
| 229 | OSMO_ASSERT(do_vty_command(vty, "disable") == CMD_SUCCESS); |
| 230 | OSMO_ASSERT(srep->enabled == 0); |
| 231 | } |
| 232 | |
| 233 | static void test_stats_vty(void) |
| 234 | { |
| 235 | struct osmo_stats_reporter *srep; |
| 236 | struct vty_test test; |
| 237 | struct vty *vty; |
| 238 | |
| 239 | printf("Going to test VTY configuration of the stats subsystem\n"); |
| 240 | vty = create_test_vty(&test); |
| 241 | |
| 242 | /* Go to config node */ |
| 243 | OSMO_ASSERT(do_vty_command(vty, "enable") == CMD_SUCCESS); |
| 244 | OSMO_ASSERT(vty->node == ENABLE_NODE); |
| 245 | OSMO_ASSERT(do_vty_command(vty, "configure terminal") == CMD_SUCCESS); |
| 246 | OSMO_ASSERT(vty->node == CONFIG_NODE); |
| 247 | |
| 248 | /* Try to create invalid reporter */ |
| 249 | OSMO_ASSERT(do_vty_command(vty, "stats reporter foobar") == |
| 250 | CMD_ERR_NO_MATCH); |
| 251 | |
| 252 | /* Set reporting interval */ |
| 253 | OSMO_ASSERT(do_vty_command(vty, "stats interval 42") == CMD_SUCCESS); |
| 254 | OSMO_ASSERT(osmo_stats_config->interval == 42); |
| 255 | |
| 256 | /* Create log reporter */ |
| 257 | srep = osmo_stats_reporter_find(OSMO_STATS_REPORTER_LOG, NULL); |
| 258 | OSMO_ASSERT(srep == NULL); |
| 259 | OSMO_ASSERT(do_vty_command(vty, "stats reporter log") == CMD_SUCCESS); |
| 260 | OSMO_ASSERT(vty->node == CFG_STATS_NODE); |
| 261 | srep = osmo_stats_reporter_find(OSMO_STATS_REPORTER_LOG, NULL); |
| 262 | OSMO_ASSERT(srep != NULL); |
| 263 | OSMO_ASSERT(srep->type == OSMO_STATS_REPORTER_LOG); |
| 264 | check_srep_vty_config(vty, srep); |
| 265 | OSMO_ASSERT(do_vty_command(vty, "exit") == CMD_SUCCESS); |
| 266 | OSMO_ASSERT(vty->node == CONFIG_NODE); |
| 267 | |
| 268 | /* Create statsd reporter */ |
| 269 | srep = osmo_stats_reporter_find(OSMO_STATS_REPORTER_STATSD, NULL); |
| 270 | OSMO_ASSERT(srep == NULL); |
| 271 | OSMO_ASSERT(do_vty_command(vty, "stats reporter statsd") == CMD_SUCCESS); |
| 272 | OSMO_ASSERT(vty->node == CFG_STATS_NODE); |
| 273 | srep = osmo_stats_reporter_find(OSMO_STATS_REPORTER_STATSD, NULL); |
| 274 | OSMO_ASSERT(srep != NULL); |
| 275 | OSMO_ASSERT(srep->type == OSMO_STATS_REPORTER_STATSD); |
| 276 | check_srep_vty_config(vty, srep); |
| 277 | OSMO_ASSERT(do_vty_command(vty, "exit") == CMD_SUCCESS); |
| 278 | OSMO_ASSERT(vty->node == CONFIG_NODE); |
| 279 | |
| 280 | /* Destroy log reporter */ |
| 281 | OSMO_ASSERT(osmo_stats_reporter_find(OSMO_STATS_REPORTER_LOG, NULL)); |
| 282 | OSMO_ASSERT(do_vty_command(vty, "no stats reporter log") == CMD_SUCCESS); |
| 283 | OSMO_ASSERT(!osmo_stats_reporter_find(OSMO_STATS_REPORTER_LOG, NULL)); |
| 284 | |
| 285 | /* Destroy statsd reporter */ |
| 286 | OSMO_ASSERT(osmo_stats_reporter_find(OSMO_STATS_REPORTER_STATSD, NULL)); |
| 287 | OSMO_ASSERT(do_vty_command(vty, "no stats reporter statsd") == CMD_SUCCESS); |
| 288 | OSMO_ASSERT(!osmo_stats_reporter_find(OSMO_STATS_REPORTER_STATSD, NULL)); |
| 289 | |
| 290 | destroy_test_vty(&test, vty); |
| 291 | } |
| 292 | |
Jacob Erlbeck | ae15a2c | 2013-08-06 14:29:14 +0200 | [diff] [blame] | 293 | int main(int argc, char **argv) |
| 294 | { |
Jacob Erlbeck | ca6602f | 2015-11-03 13:47:11 +0100 | [diff] [blame] | 295 | struct vty_app_info vty_info = { |
| 296 | .name = "VtyTest", |
| 297 | .version = 0, |
| 298 | .go_parent_cb = NULL, |
| 299 | .is_config_node = NULL, |
| 300 | }; |
| 301 | |
| 302 | const struct log_info_cat default_categories[] = {}; |
| 303 | |
| 304 | const struct log_info log_info = { |
| 305 | .cat = default_categories, |
| 306 | .num_cat = ARRAY_SIZE(default_categories), |
| 307 | }; |
Jacob Erlbeck | be37fb7 | 2015-11-03 15:21:34 +0100 | [diff] [blame] | 308 | void *stats_ctx = talloc_named_const(NULL, 1, "stats test context"); |
| 309 | |
Holger Hans Peter Freyther | 2c9168c | 2013-10-10 20:21:33 +0200 | [diff] [blame] | 310 | osmo_signal_register_handler(SS_L_VTY, vty_event_cb, NULL); |
| 311 | |
Jacob Erlbeck | ca6602f | 2015-11-03 13:47:11 +0100 | [diff] [blame] | 312 | /* Fake logging. */ |
| 313 | osmo_init_logging(&log_info); |
| 314 | |
Jacob Erlbeck | be37fb7 | 2015-11-03 15:21:34 +0100 | [diff] [blame] | 315 | /* Init stats */ |
| 316 | osmo_stats_init(stats_ctx); |
| 317 | |
Jacob Erlbeck | ca6602f | 2015-11-03 13:47:11 +0100 | [diff] [blame] | 318 | vty_init(&vty_info); |
| 319 | |
| 320 | /* Setup VTY commands */ |
| 321 | logging_vty_add_cmds(&log_info); |
Jacob Erlbeck | be37fb7 | 2015-11-03 15:21:34 +0100 | [diff] [blame] | 322 | osmo_stats_vty_add_cmds(); |
Jacob Erlbeck | ca6602f | 2015-11-03 13:47:11 +0100 | [diff] [blame] | 323 | |
Jacob Erlbeck | ae15a2c | 2013-08-06 14:29:14 +0200 | [diff] [blame] | 324 | test_cmd_string_from_valstr(); |
Jacob Erlbeck | 0c987bd | 2013-09-06 16:52:00 +0200 | [diff] [blame] | 325 | test_node_tree_structure(); |
Jacob Erlbeck | be37fb7 | 2015-11-03 15:21:34 +0100 | [diff] [blame] | 326 | test_stats_vty(); |
| 327 | |
| 328 | /* Leak check */ |
| 329 | OSMO_ASSERT(talloc_total_blocks(stats_ctx) == 1); |
Jacob Erlbeck | ca6602f | 2015-11-03 13:47:11 +0100 | [diff] [blame] | 330 | |
Jacob Erlbeck | ae15a2c | 2013-08-06 14:29:14 +0200 | [diff] [blame] | 331 | printf("All tests passed\n"); |
| 332 | |
| 333 | return 0; |
| 334 | } |