vty: Add vty_install_default() and use for the vty nodes

This adds the vty_install_default() function that is basically the
install_default() function plus the registration of the commands
'exit' and 'end'. The latter is only provided in subnodes of
ENABLED_NODE and CONFIG_NONE.

The VTY test program is extended to check these commands.

Ticket: OW#952

2 files changed, 167 insertions, 0 deletions

diff --git a/tests/vty/vty_test.c b/tests/vty/vty_test.c
index 2a9be84c..e54a205a 100644
--- a/tests/vty/vty_test.c
+++ b/tests/vty/vty_test.c
@@ -20,10 +20,19 @@
 #include <stdio.h>
 #include <string.h>
 
+#include <sys/types.h>
+#include <sys/socket.h>
+#include <sys/un.h>
+
 #include <osmocom/core/talloc.h>
 #include <osmocom/core/logging.h>
 #include <osmocom/core/utils.h>
 #include <osmocom/vty/misc.h>
+#include <osmocom/vty/vty.h>
+#include <osmocom/vty/command.h>
+#include <osmocom/vty/buffer.h>
+
+static enum event last_vty_connection_event = -1;
 
 static void test_cmd_string_from_valstr(void)
 {
@@ -43,9 +52,124 @@ static void test_cmd_string_from_valstr(void)
 	talloc_free (cmd);
 }
 
+static int do_vty_command(struct vty *vty, const char *cmd)
+{
+	vector vline;
+	int ret;
+
+	printf("Going to execute '%s'\n", cmd);
+	vline = cmd_make_strvec(cmd);
+	ret = cmd_execute_command(vline, vty, NULL, 0);
+	cmd_free_strvec(vline);
+	printf("Returned: %d, Current node: %d '%s'\n", ret, vty->node, cmd_prompt(vty->node));
+	return ret;
+}
+
+/* Override the implementation from telnet_interface.c */
+void vty_event(enum event event, int sock, struct vty *vty)
+{
+	last_vty_connection_event = event;
+
+	fprintf(stderr, "Got VTY event: %d\n", event);
+}
+
+static void test_node_tree_structure(void)
+{
+	struct vty_app_info vty_info = {
+		.name 		= "VtyTest",
+		.version	= 0,
+		.go_parent_cb	= NULL,
+		.is_config_node	= NULL,
+	};
+
+	const struct log_info_cat default_categories[] = {};
+
+	const struct log_info log_info = {
+		.cat = default_categories,
+		.num_cat = ARRAY_SIZE(default_categories),
+	};
+
+	struct vty *vty;
+	vector vline;
+	int sock[2];
+
+	printf("Going to test VTY node tree structure\n");
+
+	/* Fake logging. */
+	osmo_init_logging(&log_info);
+
+	vty_init(&vty_info);
+
+	logging_vty_add_cmds(&log_info);
+
+	/* Fake connection. */
+	socketpair(AF_UNIX, SOCK_STREAM, 0, sock);
+
+	vty = vty_create(sock[0], NULL);
+
+	OSMO_ASSERT(vty != NULL);
+
+	OSMO_ASSERT(do_vty_command(vty, "enable") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == ENABLE_NODE);
+
+	OSMO_ASSERT(do_vty_command(vty, "configure terminal") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == CONFIG_NODE);
+	OSMO_ASSERT(do_vty_command(vty, "exit") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == ENABLE_NODE);
+
+	OSMO_ASSERT(do_vty_command(vty, "configure terminal") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == CONFIG_NODE);
+	OSMO_ASSERT(do_vty_command(vty, "end") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == ENABLE_NODE);
+
+	OSMO_ASSERT(do_vty_command(vty, "configure terminal") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == CONFIG_NODE);
+	OSMO_ASSERT(do_vty_command(vty, "log stderr") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == CFG_LOG_NODE);
+	OSMO_ASSERT(do_vty_command(vty, "exit") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == CONFIG_NODE);
+	OSMO_ASSERT(do_vty_command(vty, "log stderr") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == CFG_LOG_NODE);
+	OSMO_ASSERT(do_vty_command(vty, "end") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == ENABLE_NODE);
+
+	OSMO_ASSERT(do_vty_command(vty, "configure terminal") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == CONFIG_NODE);
+	OSMO_ASSERT(do_vty_command(vty, "line vty") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == VTY_NODE);
+	OSMO_ASSERT(do_vty_command(vty, "exit") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == CONFIG_NODE);
+	OSMO_ASSERT(do_vty_command(vty, "line vty") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == VTY_NODE);
+	OSMO_ASSERT(do_vty_command(vty, "end") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == ENABLE_NODE);
+
+
+	/* Check searching the parents nodes for matching commands. */
+	OSMO_ASSERT(do_vty_command(vty, "configure terminal") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == CONFIG_NODE);
+	OSMO_ASSERT(do_vty_command(vty, "log stderr") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == CFG_LOG_NODE);
+	OSMO_ASSERT(do_vty_command(vty, "line vty") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == VTY_NODE);
+	OSMO_ASSERT(do_vty_command(vty, "log stderr") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == CFG_LOG_NODE);
+	OSMO_ASSERT(do_vty_command(vty, "end") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == ENABLE_NODE);
+
+	/* Check for final 'exit' (connection close). */
+	OSMO_ASSERT(do_vty_command(vty, "exit") == CMD_SUCCESS);
+	OSMO_ASSERT(vty->node == ENABLE_NODE);
+	OSMO_ASSERT(vty->status == VTY_CLOSE);
+
+	vty_close(vty);
+	OSMO_ASSERT(last_vty_connection_event == VTY_CLOSED);
+}
+
 int main(int argc, char **argv)
 {
 	test_cmd_string_from_valstr();
+	test_node_tree_structure();
 	printf("All tests passed\n");
 
 	return 0;
diff --git a/tests/vty/vty_test.ok b/tests/vty/vty_test.ok
index baec2499..0ea2dabf 100644
--- a/tests/vty/vty_test.ok
+++ b/tests/vty/vty_test.ok
@@ -1,3 +1,46 @@
 Going to test vty_cmd_string_from_valstr()
 Tested with %s-strings, resulting cmd = '[prefix%s%s%s%s%s][foo%s%s%s%s%s][sep%s%s%s%s%s][bar%s%s%s%s%s][end%s%s%s%s%s]'
+Going to test VTY node tree structure
+Going to execute 'enable'
+Returned: 0, Current node: 3 '%s# '
+Going to execute 'configure terminal'
+Returned: 0, Current node: 4 '%s(config)# '
+Going to execute 'exit'
+Returned: 0, Current node: 3 '%s# '
+Going to execute 'configure terminal'
+Returned: 0, Current node: 4 '%s(config)# '
+Going to execute 'end'
+Returned: 0, Current node: 3 '%s# '
+Going to execute 'configure terminal'
+Returned: 0, Current node: 4 '%s(config)# '
+Going to execute 'log stderr'
+Returned: 0, Current node: 7 '%s(config-log)# '
+Going to execute 'exit'
+Returned: 0, Current node: 4 '%s(config)# '
+Going to execute 'log stderr'
+Returned: 0, Current node: 7 '%s(config-log)# '
+Going to execute 'end'
+Returned: 0, Current node: 3 '%s# '
+Going to execute 'configure terminal'
+Returned: 0, Current node: 4 '%s(config)# '
+Going to execute 'line vty'
+Returned: 0, Current node: 8 '%s(config-line)# '
+Going to execute 'exit'
+Returned: 0, Current node: 4 '%s(config)# '
+Going to execute 'line vty'
+Returned: 0, Current node: 8 '%s(config-line)# '
+Going to execute 'end'
+Returned: 0, Current node: 3 '%s# '
+Going to execute 'configure terminal'
+Returned: 0, Current node: 4 '%s(config)# '
+Going to execute 'log stderr'
+Returned: 0, Current node: 7 '%s(config-log)# '
+Going to execute 'line vty'
+Returned: 0, Current node: 8 '%s(config-line)# '
+Going to execute 'log stderr'
+Returned: 0, Current node: 7 '%s(config-log)# '
+Going to execute 'end'
+Returned: 0, Current node: 3 '%s# '
+Going to execute 'exit'
+Returned: 0, Current node: 3 '%s# '
 All tests passed