osmocom
/
libosmocore
mirror of https://gerrit.osmocom.org/libosmocore
11
0
Fork 1
Code Issues Releases Wiki Activity
libosmocore/tests/vty/vty_test.c

545 lines
16 KiB
C
Raw Normal View History

Fix/Update copyright notices; Add SPDX annotation Let's fix some erroneous/accidential references to wrong license, update copyright information where applicable and introduce a SPDX-License-Identifier to all files. Change-Id: I39af26c6aaaf5c926966391f6565fc5936be21af
2017-11-12 16:00:26 +00:00
/* (C) 2013 by sysmocom - s.f.m.c. GmbH, Author: Jacob Erlbeck <jerlbeck@sysmocom.de>
vty: Fix misusage of snprintf in vty/utils.c Compiled with ubuntu 1204 (precise), where -Wformat-security is enabled by -Wall. Test yields ok, but the current implementation doesn't properly support multi-character separators and end strings. So the test output is truncated. Addresses: utils.c: In function 'vty_cmd_string_from_valstr': utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security]
2013-08-06 12:29:14 +00:00
* All Rights Reserved
*
Fix/Update copyright notices; Add SPDX annotation Let's fix some erroneous/accidential references to wrong license, update copyright information where applicable and introduce a SPDX-License-Identifier to all files. Change-Id: I39af26c6aaaf5c926966391f6565fc5936be21af
2017-11-12 16:00:26 +00:00
* SPDX-License-Identifier: GPL-2.0+
*
* This program is free software; you can redistribute it and/or modify
vty: Fix misusage of snprintf in vty/utils.c Compiled with ubuntu 1204 (precise), where -Wformat-security is enabled by -Wall. Test yields ok, but the current implementation doesn't properly support multi-character separators and end strings. So the test output is truncated. Addresses: utils.c: In function 'vty_cmd_string_from_valstr': utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security]
2013-08-06 12:29:14 +00:00
* it under the terms of the GNU General Public License as published by
Fix/Update copyright notices; Add SPDX annotation Let's fix some erroneous/accidential references to wrong license, update copyright information where applicable and introduce a SPDX-License-Identifier to all files. Change-Id: I39af26c6aaaf5c926966391f6565fc5936be21af
2017-11-12 16:00:26 +00:00
* the Free Software Foundation; either version 2 of the License, or
vty: Fix misusage of snprintf in vty/utils.c Compiled with ubuntu 1204 (precise), where -Wformat-security is enabled by -Wall. Test yields ok, but the current implementation doesn't properly support multi-character separators and end strings. So the test output is truncated. Addresses: utils.c: In function 'vty_cmd_string_from_valstr': utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security]
2013-08-06 12:29:14 +00:00
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*/
#include <stdio.h>
#include <string.h>
VTY: implicit node exit by de-indenting, not parent lookup Note: This will break users' config files if they do not use consistent indenting. (see below for a definition of "consistent".) When reading VTY commands from a file, use indenting as means to implicitly exit child nodes. Do not look for commands in the parent node implicitly. The VTY so far implies 'exit' commands if a VTY line cannot be parsed on the current node, but succeeds on the parent node. That is the mechanism by which our VTY config files do not need 'exit' at the end of each child node. We've hit problems with this in the following scenarios, which will show improved user experience after this patch: *) When both a parent and its child node have commands with identical names: cs7 instace 0 point-code 1.2.3 sccp-address osmo-msc point-code 0.0.1 If I put the parent's command below the child, it is still interpreted in the context of the child node: cs7 instace 0 sccp-address osmo-msc point-code 0.0.1 point-code 1.2.3 Though the indenting lets me assume I am setting the cs7 instance's global PC to 1.2.3, I'm actually overwriting osmo-msc's PC with 1.2.3 and discarding the 0.0.1. *) When a software change moves a VTY command from a child to a parent. Say 'timezone' moved from 'bts' to 'network' level: network timezone 1 2 Say a user still has an old config file with 'timezone' on the child level: network bts 0 timezone 1 2 trx 0 The user would expect an error message that 'timezone' is invalid on the 'bts' level. Instead, the VTY finds the parent node's 'timezone', steps out of 'bts' to the 'network' level, and instead says that the 'trx' command does not exist. Format: Consistent means that two adjacent indenting lines have the exact same indenting characters for the common length: Weird mix if you ask me, but correct and consistent: ROOT <space>PARENT <space><tab><space>CHILD <space><tab><space><tab><tab>GRANDCHILD <space><tab><space><tab><tab>GRANDCHILD2 <space>SIBLING Inconsistent: ROOT <space>PARENT <tab><space>CHILD <space><space><tab>GRANDCHILD <space><tab><tab>GRANDCHILD2 <tab>SIBLING Also, when going back to a parent level, the exact same indenting must be used as before in that node: Incorrect: ROOT <tab>PARENT <tab><tab><tab>CHILD <tab><tab>SIBLING As not really intended side effect, it is also permitted to indent the entire file starting from the root level. We could guard against it but there's no harm: Correct and consistent: <tab>ROOT <tab><tab>PARENT <tab><tab><tab><tab>CHILD <tab><tab>SIBLING Implementation: Track parent nodes state: whenever a command enters a child node, push a parent node onto an llist to remember the exact indentation characters used for that level. As soon as the first line on a child node is parsed, remember this new indentation (which must have a longer strlen() than its parent level) to apply to all remaining child siblings and grandchildren. If the amount of spaces that indent a following VTY command are less than this expected indentation, call vty_go_parent() until it matches up. At any level, if the common length of indentation characters mismatch, abort parsing in error. Transitions to child node are spread across VTY implementations and are hard to change. But transitions to the parent node are all handled by vty_go_parent(). By popping a parent from the list of parents in vty_go_parent(), we can also detect that a command has changed the node without changing the parent, hence it must have stepped into a child node, and we can push a parent frame. The behavior on the interactive telnet VTY remains unchanged. Change-Id: I24cbb3f6de111f2d31110c3c484c066f1153aac9
2017-09-07 01:08:06 +00:00
#include <errno.h>
vty: Fix misusage of snprintf in vty/utils.c Compiled with ubuntu 1204 (precise), where -Wformat-security is enabled by -Wall. Test yields ok, but the current implementation doesn't properly support multi-character separators and end strings. So the test output is truncated. Addresses: utils.c: In function 'vty_cmd_string_from_valstr': utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security]
2013-08-06 12:29:14 +00:00
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
2013-09-06 14:52:00 +00:00
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/un.h>
vty: Fix compiler warning in the test
2013-09-10 09:17:46 +00:00
#include <osmocom/core/application.h>
vty: Fix misusage of snprintf in vty/utils.c Compiled with ubuntu 1204 (precise), where -Wformat-security is enabled by -Wall. Test yields ok, but the current implementation doesn't properly support multi-character separators and end strings. So the test output is truncated. Addresses: utils.c: In function 'vty_cmd_string_from_valstr': utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security]
2013-08-06 12:29:14 +00:00
#include <osmocom/core/talloc.h>
logging/vty: fix: actually ignore deprecated logging commands We shall not prevent programs from starting if their configuration files contain deprecated 'logging level ...' commands. Just print a warning and return CMD_SUCCESS instead of CMD_WARNING. While writing a unit test, another funny bug has been uncovered. Parsing of a deprecated command indeed triggers a deprecation warning, originated from libosmovty's log_deprecated_func(). This function simply calls vty_out(), but... Since the invocation of the vty_out() happens _before_ the VTY is initialized, the process is actually writing that warning to its own stdin! Most likely, because we use talloc_zero() to allocate a new instance of struct 'vty'. As a side effect, the evil warning magically appears in the output of 'make check', breaking the test statistics. Let's work around this bug for now by redirecting stdin to /dev/null. Change-Id: Ia934581410cd41594791d4e14ee74c16abe1009a Fixes: Ic9c1b566ec4a459f03e6319cf369691903cf9d00
2019-11-20 17:19:36 +00:00
#include <osmocom/core/logging_internal.h>
vty: Fix misusage of snprintf in vty/utils.c Compiled with ubuntu 1204 (precise), where -Wformat-security is enabled by -Wall. Test yields ok, but the current implementation doesn't properly support multi-character separators and end strings. So the test output is truncated. Addresses: utils.c: In function 'vty_cmd_string_from_valstr': utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security]
2013-08-06 12:29:14 +00:00
#include <osmocom/core/logging.h>
stats/test: Add tests to check VTY configuration This commit adds tests to verify the stats related VTY configuration commands. Sponsored-by: On-Waves ehf
2015-11-03 14:21:34 +00:00
#include <osmocom/core/stats.h>
vty: Fix misusage of snprintf in vty/utils.c Compiled with ubuntu 1204 (precise), where -Wformat-security is enabled by -Wall. Test yields ok, but the current implementation doesn't properly support multi-character separators and end strings. So the test output is truncated. Addresses: utils.c: In function 'vty_cmd_string_from_valstr': utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security]
2013-08-06 12:29:14 +00:00
#include <osmocom/core/utils.h>
vty: Make vty_event dispatch signals and use it in the testcase The testcase didn't work on Ubuntu 12.04 because vty_create will directly call vty_event (e.g. not through the plt). This means that the approach to override vty_event in the testcase failed. Use the signal interface of libosmocore and make the testcase use it. The signals can be generally useful as well.
2013-10-10 18:21:33 +00:00
#include <osmocom/core/signal.h>
vty: Fix misusage of snprintf in vty/utils.c Compiled with ubuntu 1204 (precise), where -Wformat-security is enabled by -Wall. Test yields ok, but the current implementation doesn't properly support multi-character separators and end strings. So the test output is truncated. Addresses: utils.c: In function 'vty_cmd_string_from_valstr': utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security]
2013-08-06 12:29:14 +00:00
#include <osmocom/vty/misc.h>
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
2013-09-06 14:52:00 +00:00
#include <osmocom/vty/vty.h>
#include <osmocom/vty/command.h>
#include <osmocom/vty/buffer.h>
vty: Fix compiler warning in the test
2013-09-10 09:17:46 +00:00
#include <osmocom/vty/logging.h>
stats/test: Add tests to check VTY configuration This commit adds tests to verify the stats related VTY configuration commands. Sponsored-by: On-Waves ehf
2015-11-03 14:21:34 +00:00
#include <osmocom/vty/stats.h>
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
2013-09-06 14:52:00 +00:00
static enum event last_vty_connection_event = -1;
use osmo_init_logging2() with proper talloc ctx Ironically, when deprecating osmo_init_logging() in I216837780e9405fdaec8059c63d10699c695b360, I forgot to change the callers within libosmocore itself, i.e. in the various regression tests. Change-Id: Ia36c248f99353d5baaa2533f46a2f60a8579bdf8
2018-04-05 01:02:35 +00:00
void *ctx = NULL;
vty: Fix misusage of snprintf in vty/utils.c Compiled with ubuntu 1204 (precise), where -Wformat-security is enabled by -Wall. Test yields ok, but the current implementation doesn't properly support multi-character separators and end strings. So the test output is truncated. Addresses: utils.c: In function 'vty_cmd_string_from_valstr': utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security]
2013-08-06 12:29:14 +00:00
static void test_cmd_string_from_valstr(void)
{
char *cmd;
const struct value_string printf_seq_vs[] = {
{ .value = 42, .str = "[foo%s%s%s%s%s]"},
{ .value = 43, .str = "[bar%s%s%s%s%s]"},
{ .value = 0, .str = NULL}
};
printf("Going to test vty_cmd_string_from_valstr()\n");
/* check against character strings that could break printf */
use osmo_init_logging2() with proper talloc ctx Ironically, when deprecating osmo_init_logging() in I216837780e9405fdaec8059c63d10699c695b360, I forgot to change the callers within libosmocore itself, i.e. in the various regression tests. Change-Id: Ia36c248f99353d5baaa2533f46a2f60a8579bdf8
2018-04-05 01:02:35 +00:00
cmd = vty_cmd_string_from_valstr (ctx, printf_seq_vs, "[prefix%s%s%s%s%s]", "[sep%s%s%s%s%s]", "[end%s%s%s%s%s]", 1);
vty: Fix misusage of snprintf in vty/utils.c Compiled with ubuntu 1204 (precise), where -Wformat-security is enabled by -Wall. Test yields ok, but the current implementation doesn't properly support multi-character separators and end strings. So the test output is truncated. Addresses: utils.c: In function 'vty_cmd_string_from_valstr': utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security]
2013-08-06 12:29:14 +00:00
printf ("Tested with %%s-strings, resulting cmd = '%s'\n", cmd);
talloc_free (cmd);
}
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
2013-09-06 14:52:00 +00:00
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;
}
vty: Make vty_event dispatch signals and use it in the testcase The testcase didn't work on Ubuntu 12.04 because vty_create will directly call vty_event (e.g. not through the plt). This means that the approach to override vty_event in the testcase failed. Use the signal interface of libosmocore and make the testcase use it. The signals can be generally useful as well.
2013-10-10 18:21:33 +00:00
/* Handle the events from telnet_interface.c */
static int vty_event_cb(unsigned int subsys, unsigned int signal,
void *handler_data, void *_signal_data)
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
2013-09-06 14:52:00 +00:00
{
vty: Make vty_event dispatch signals and use it in the testcase The testcase didn't work on Ubuntu 12.04 because vty_create will directly call vty_event (e.g. not through the plt). This means that the approach to override vty_event in the testcase failed. Use the signal interface of libosmocore and make the testcase use it. The signals can be generally useful as well.
2013-10-10 18:21:33 +00:00
struct vty_signal_data *signal_data;
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
2013-09-06 14:52:00 +00:00
vty: Make vty_event dispatch signals and use it in the testcase The testcase didn't work on Ubuntu 12.04 because vty_create will directly call vty_event (e.g. not through the plt). This means that the approach to override vty_event in the testcase failed. Use the signal interface of libosmocore and make the testcase use it. The signals can be generally useful as well.
2013-10-10 18:21:33 +00:00
if (subsys != SS_L_VTY)
return 0;
if (signal != S_VTY_EVENT)
return 0;
signal_data = _signal_data;
last_vty_connection_event = signal_data->event;
fprintf(stderr, "Got VTY event: %d\n", signal_data->event);
return 0;
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
2013-09-06 14:52:00 +00:00
}
vty/test: Refactor vty creation/deletion into separate functions Currently this is part of the only test function that uses the vty directly. In preperation for more such test cases, this commit moves this code into separate functions. Sponsored-by: On-Waves ehf
2015-11-03 12:47:11 +00:00
struct vty_test {
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
2013-09-06 14:52:00 +00:00
int sock[2];
vty/test: Refactor vty creation/deletion into separate functions Currently this is part of the only test function that uses the vty directly. In preperation for more such test cases, this commit moves this code into separate functions. Sponsored-by: On-Waves ehf
2015-11-03 12:47:11 +00:00
};
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
2013-09-06 14:52:00 +00:00
vty/test: Refactor vty creation/deletion into separate functions Currently this is part of the only test function that uses the vty directly. In preperation for more such test cases, this commit moves this code into separate functions. Sponsored-by: On-Waves ehf
2015-11-03 12:47:11 +00:00
static struct vty* create_test_vty(struct vty_test *data)
{
struct vty *vty;
/* Fake connection. */
socketpair(AF_UNIX, SOCK_STREAM, 0, data->sock);
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
2013-09-06 14:52:00 +00:00
vty/test: Refactor vty creation/deletion into separate functions Currently this is part of the only test function that uses the vty directly. In preperation for more such test cases, this commit moves this code into separate functions. Sponsored-by: On-Waves ehf
2015-11-03 12:47:11 +00:00
vty = vty_create(data->sock[0], NULL);
OSMO_ASSERT(vty != NULL);
OSMO_ASSERT(vty->status != VTY_CLOSE);
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
2013-09-06 14:52:00 +00:00
vty/test: Refactor vty creation/deletion into separate functions Currently this is part of the only test function that uses the vty directly. In preperation for more such test cases, this commit moves this code into separate functions. Sponsored-by: On-Waves ehf
2015-11-03 12:47:11 +00:00
return vty;
}
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
2013-09-06 14:52:00 +00:00
vty/test: Refactor vty creation/deletion into separate functions Currently this is part of the only test function that uses the vty directly. In preperation for more such test cases, this commit moves this code into separate functions. Sponsored-by: On-Waves ehf
2015-11-03 12:47:11 +00:00
static void destroy_test_vty(struct vty_test *data, struct vty *vty)
{
vty_close(vty);
OSMO_ASSERT(last_vty_connection_event == VTY_CLOSED);
}
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
2013-09-06 14:52:00 +00:00
vty/test: Refactor vty creation/deletion into separate functions Currently this is part of the only test function that uses the vty directly. In preperation for more such test cases, this commit moves this code into separate functions. Sponsored-by: On-Waves ehf
2015-11-03 12:47:11 +00:00
static void test_node_tree_structure(void)
{
struct vty_test test;
struct vty *vty;
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
2013-09-06 14:52:00 +00:00
vty/test: Refactor vty creation/deletion into separate functions Currently this is part of the only test function that uses the vty directly. In preperation for more such test cases, this commit moves this code into separate functions. Sponsored-by: On-Waves ehf
2015-11-03 12:47:11 +00:00
printf("Going to test VTY node tree structure\n");
vty = create_test_vty(&test);
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
2013-09-06 14:52:00 +00:00
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);
VTY: interactive: never look for matching commands on parent node For interactive telnet VTY, remove the implicit move up to the parent node when a command did not succeed on the current node level. When reading config files, this behavior was useful to allow skipping explicit 'exit' commands. (A different patch deals with that.) In the telnet VTY, this behavior was never necessary. Explicit 'exit' commands can move to the parent node, and typically uninformed users expect to require that. On a telnet VTY, counting indents like for reading config files is not an option: a user will always type from the first column or may paste some leading spaces without intended meaning. After this patch, it is thus no longer possible to paste a complete config across several node levels directly to a telnet session, unless it contains 'exit' commands. Change-Id: Id73cba2dd34676bad8a130e9c45e67a272f19588
2017-09-07 02:52:05 +00:00
/* Check for not searching the parent node for matching commands. */
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
2013-09-06 14:52:00 +00:00
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);
VTY: interactive: never look for matching commands on parent node For interactive telnet VTY, remove the implicit move up to the parent node when a command did not succeed on the current node level. When reading config files, this behavior was useful to allow skipping explicit 'exit' commands. (A different patch deals with that.) In the telnet VTY, this behavior was never necessary. Explicit 'exit' commands can move to the parent node, and typically uninformed users expect to require that. On a telnet VTY, counting indents like for reading config files is not an option: a user will always type from the first column or may paste some leading spaces without intended meaning. After this patch, it is thus no longer possible to paste a complete config across several node levels directly to a telnet session, unless it contains 'exit' commands. Change-Id: Id73cba2dd34676bad8a130e9c45e67a272f19588
2017-09-07 02:52:05 +00:00
OSMO_ASSERT(do_vty_command(vty, "line vty") == CMD_ERR_NO_MATCH);
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
2013-09-06 14:52:00 +00:00
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/test: Refactor vty creation/deletion into separate functions Currently this is part of the only test function that uses the vty directly. In preperation for more such test cases, this commit moves this code into separate functions. Sponsored-by: On-Waves ehf
2015-11-03 12:47:11 +00:00
destroy_test_vty(&test, vty);
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
2013-09-06 14:52:00 +00:00
}
stats/test: Add tests to check VTY configuration This commit adds tests to verify the stats related VTY configuration commands. Sponsored-by: On-Waves ehf
2015-11-03 14:21:34 +00:00
static void check_srep_vty_config(struct vty* vty,
struct osmo_stats_reporter *srep)
{
OSMO_ASSERT(srep->enabled == 0);
OSMO_ASSERT(do_vty_command(vty, "prefix myprefix") == CMD_SUCCESS);
OSMO_ASSERT(srep->name_prefix != NULL);
OSMO_ASSERT(strcmp(srep->name_prefix, "myprefix") == 0);
OSMO_ASSERT(do_vty_command(vty, "no prefix") == CMD_SUCCESS);
OSMO_ASSERT(srep->name_prefix == NULL || strlen(srep->name_prefix) == 0);
OSMO_ASSERT(srep->max_class == OSMO_STATS_CLASS_GLOBAL);
OSMO_ASSERT(do_vty_command(vty, "level peer") == CMD_SUCCESS);
OSMO_ASSERT(srep->max_class == OSMO_STATS_CLASS_PEER);
OSMO_ASSERT(do_vty_command(vty, "level subscriber") == CMD_SUCCESS);
OSMO_ASSERT(srep->max_class == OSMO_STATS_CLASS_SUBSCRIBER);
OSMO_ASSERT(do_vty_command(vty, "level global") == CMD_SUCCESS);
OSMO_ASSERT(srep->max_class == OSMO_STATS_CLASS_GLOBAL);
OSMO_ASSERT(do_vty_command(vty, "level foobar") == CMD_ERR_NO_MATCH);
if (srep->have_net_config) {
OSMO_ASSERT(do_vty_command(vty, "remote-ip 127.0.0.99") ==
CMD_SUCCESS);
OSMO_ASSERT(srep->dest_addr_str &&
strcmp(srep->dest_addr_str, "127.0.0.99") == 0);
OSMO_ASSERT(do_vty_command(vty, "remote-ip 678.0.0.99") ==
CMD_WARNING);
OSMO_ASSERT(srep->dest_addr_str &&
strcmp(srep->dest_addr_str, "127.0.0.99") == 0);
OSMO_ASSERT(do_vty_command(vty, "remote-port 12321") ==
CMD_SUCCESS);
OSMO_ASSERT(srep->dest_port == 12321);
OSMO_ASSERT(srep->bind_addr_str == NULL);
OSMO_ASSERT(do_vty_command(vty, "local-ip 127.0.0.98") ==
CMD_SUCCESS);
OSMO_ASSERT(srep->bind_addr_str &&
strcmp(srep->bind_addr_str, "127.0.0.98") == 0);
OSMO_ASSERT(do_vty_command(vty, "no local-ip") == CMD_SUCCESS);
OSMO_ASSERT(srep->bind_addr_str == NULL);
OSMO_ASSERT(srep->mtu == 0);
OSMO_ASSERT(do_vty_command(vty, "mtu 987") == CMD_SUCCESS);
OSMO_ASSERT(srep->mtu == 987);
OSMO_ASSERT(do_vty_command(vty, "no mtu") == CMD_SUCCESS);
OSMO_ASSERT(srep->mtu == 0);
};
OSMO_ASSERT(do_vty_command(vty, "enable") == CMD_SUCCESS);
OSMO_ASSERT(srep->enabled != 0);
OSMO_ASSERT(do_vty_command(vty, "disable") == CMD_SUCCESS);
OSMO_ASSERT(srep->enabled == 0);
}
static void test_stats_vty(void)
{
struct osmo_stats_reporter *srep;
struct vty_test test;
struct vty *vty;
printf("Going to test VTY configuration of the stats subsystem\n");
vty = create_test_vty(&test);
/* Go to config node */
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);
/* Try to create invalid reporter */
OSMO_ASSERT(do_vty_command(vty, "stats reporter foobar") ==
CMD_ERR_NO_MATCH);
/* Set reporting interval */
OSMO_ASSERT(do_vty_command(vty, "stats interval 42") == CMD_SUCCESS);
OSMO_ASSERT(osmo_stats_config->interval == 42);
/* Create log reporter */
srep = osmo_stats_reporter_find(OSMO_STATS_REPORTER_LOG, NULL);
OSMO_ASSERT(srep == NULL);
OSMO_ASSERT(do_vty_command(vty, "stats reporter log") == CMD_SUCCESS);
OSMO_ASSERT(vty->node == CFG_STATS_NODE);
srep = osmo_stats_reporter_find(OSMO_STATS_REPORTER_LOG, NULL);
OSMO_ASSERT(srep != NULL);
OSMO_ASSERT(srep->type == OSMO_STATS_REPORTER_LOG);
check_srep_vty_config(vty, srep);
OSMO_ASSERT(do_vty_command(vty, "exit") == CMD_SUCCESS);
OSMO_ASSERT(vty->node == CONFIG_NODE);
/* Create statsd reporter */
srep = osmo_stats_reporter_find(OSMO_STATS_REPORTER_STATSD, NULL);
OSMO_ASSERT(srep == NULL);
OSMO_ASSERT(do_vty_command(vty, "stats reporter statsd") == CMD_SUCCESS);
OSMO_ASSERT(vty->node == CFG_STATS_NODE);
srep = osmo_stats_reporter_find(OSMO_STATS_REPORTER_STATSD, NULL);
OSMO_ASSERT(srep != NULL);
OSMO_ASSERT(srep->type == OSMO_STATS_REPORTER_STATSD);
check_srep_vty_config(vty, srep);
OSMO_ASSERT(do_vty_command(vty, "exit") == CMD_SUCCESS);
OSMO_ASSERT(vty->node == CONFIG_NODE);
/* Destroy log reporter */
OSMO_ASSERT(osmo_stats_reporter_find(OSMO_STATS_REPORTER_LOG, NULL));
OSMO_ASSERT(do_vty_command(vty, "no stats reporter log") == CMD_SUCCESS);
OSMO_ASSERT(!osmo_stats_reporter_find(OSMO_STATS_REPORTER_LOG, NULL));
/* Destroy statsd reporter */
OSMO_ASSERT(osmo_stats_reporter_find(OSMO_STATS_REPORTER_STATSD, NULL));
OSMO_ASSERT(do_vty_command(vty, "no stats reporter statsd") == CMD_SUCCESS);
OSMO_ASSERT(!osmo_stats_reporter_find(OSMO_STATS_REPORTER_STATSD, NULL));
destroy_test_vty(&test, vty);
}
VTY: implicit node exit by de-indenting, not parent lookup Note: This will break users' config files if they do not use consistent indenting. (see below for a definition of "consistent".) When reading VTY commands from a file, use indenting as means to implicitly exit child nodes. Do not look for commands in the parent node implicitly. The VTY so far implies 'exit' commands if a VTY line cannot be parsed on the current node, but succeeds on the parent node. That is the mechanism by which our VTY config files do not need 'exit' at the end of each child node. We've hit problems with this in the following scenarios, which will show improved user experience after this patch: *) When both a parent and its child node have commands with identical names: cs7 instace 0 point-code 1.2.3 sccp-address osmo-msc point-code 0.0.1 If I put the parent's command below the child, it is still interpreted in the context of the child node: cs7 instace 0 sccp-address osmo-msc point-code 0.0.1 point-code 1.2.3 Though the indenting lets me assume I am setting the cs7 instance's global PC to 1.2.3, I'm actually overwriting osmo-msc's PC with 1.2.3 and discarding the 0.0.1. *) When a software change moves a VTY command from a child to a parent. Say 'timezone' moved from 'bts' to 'network' level: network timezone 1 2 Say a user still has an old config file with 'timezone' on the child level: network bts 0 timezone 1 2 trx 0 The user would expect an error message that 'timezone' is invalid on the 'bts' level. Instead, the VTY finds the parent node's 'timezone', steps out of 'bts' to the 'network' level, and instead says that the 'trx' command does not exist. Format: Consistent means that two adjacent indenting lines have the exact same indenting characters for the common length: Weird mix if you ask me, but correct and consistent: ROOT <space>PARENT <space><tab><space>CHILD <space><tab><space><tab><tab>GRANDCHILD <space><tab><space><tab><tab>GRANDCHILD2 <space>SIBLING Inconsistent: ROOT <space>PARENT <tab><space>CHILD <space><space><tab>GRANDCHILD <space><tab><tab>GRANDCHILD2 <tab>SIBLING Also, when going back to a parent level, the exact same indenting must be used as before in that node: Incorrect: ROOT <tab>PARENT <tab><tab><tab>CHILD <tab><tab>SIBLING As not really intended side effect, it is also permitted to indent the entire file starting from the root level. We could guard against it but there's no harm: Correct and consistent: <tab>ROOT <tab><tab>PARENT <tab><tab><tab><tab>CHILD <tab><tab>SIBLING Implementation: Track parent nodes state: whenever a command enters a child node, push a parent node onto an llist to remember the exact indentation characters used for that level. As soon as the first line on a child node is parsed, remember this new indentation (which must have a longer strlen() than its parent level) to apply to all remaining child siblings and grandchildren. If the amount of spaces that indent a following VTY command are less than this expected indentation, call vty_go_parent() until it matches up. At any level, if the common length of indentation characters mismatch, abort parsing in error. Transitions to child node are spread across VTY implementations and are hard to change. But transitions to the parent node are all handled by vty_go_parent(). By popping a parent from the list of parents in vty_go_parent(), we can also detect that a command has changed the node without changing the parent, hence it must have stepped into a child node, and we can push a parent frame. The behavior on the interactive telnet VTY remains unchanged. Change-Id: I24cbb3f6de111f2d31110c3c484c066f1153aac9
2017-09-07 01:08:06 +00:00
void test_exit_by_indent(const char *fname, int expect_rc)
{
int rc;
printf("reading file %s, expecting rc=%d\n", fname, expect_rc);
rc = vty_read_config_file(fname, NULL);
printf("got rc=%d\n", rc);
OSMO_ASSERT(rc == expect_rc);
}
vty_test: add artificial node levels for better testing In vty_test, add three levels of parent nodes (level1, level2, level3) with each having a leaf child (child1, child2, child3). Use these to enhance the vty_test cfg files and test more diverse situations. The current VTY code expects a go_parent_cb() to be present, otherwise it will bump right back to the CONFIG_NODE, which will not work with more than one node level below the CONFIG_NODE. Hence provide a minimal go_parent_cb(). Change-Id: Ib9bcf58b655fbd85e196f363fb7d8305d7dfc997
2017-09-19 23:49:11 +00:00
enum test_nodes {
LEVEL1_NODE = _LAST_OSMOVTY_NODE + 1,
LEVEL2_NODE,
LEVEL3_NODE,
};
struct cmd_node level1_node = {
LEVEL1_NODE,
"%s(config-level1)# ",
1
};
struct cmd_node level2_node = {
LEVEL2_NODE,
"%s(config-level1-level2)# ",
1
};
struct cmd_node level3_node = {
LEVEL3_NODE,
"%s(config-level1-level2-level3)# ",
1
};
DEFUN(cfg_level1, cfg_level1_cmd,
"level1 [MARKER]",
"Level 1 node for VTY testing purposes\n"
"optional string to mark the line for test debugging\n")
{
vty->index = NULL;
vty->node = LEVEL1_NODE;
printf("called level1 node %s\n", argc? argv[0] : "");
return CMD_SUCCESS;
}
DEFUN(cfg_level1_child, cfg_level1_child_cmd,
"child1 [MARKER]",
"Level 1 child cmd for VTY testing purposes\n"
"optional string to mark the line for test debugging\n")
{
printf("called level1 child cmd %s\n", argc? argv[0] : "");
return CMD_SUCCESS;
}
DEFUN(cfg_level2, cfg_level2_cmd,
"level2 [MARKER]",
"Level 2 node for VTY testing purposes\n"
"optional string to mark the line for test debugging\n")
{
vty->index = NULL;
vty->node = LEVEL2_NODE;
printf("called level2 node %s\n", argc? argv[0] : "");
return CMD_SUCCESS;
}
DEFUN(cfg_level2_child, cfg_level2_child_cmd,
"child2 [MARKER]",
"Level 2 child cmd for VTY testing purposes\n"
"optional string to mark the line for test debugging\n")
{
printf("called level2 child cmd %s\n", argc? argv[0] : "");
return CMD_SUCCESS;
}
DEFUN(cfg_level3, cfg_level3_cmd,
"level3 [MARKER]",
"Level 3 node for VTY testing purposes\n"
"optional string to mark the line for test debugging\n")
{
vty->index = NULL;
vty->node = LEVEL3_NODE;
printf("called level3 node %s\n", argc? argv[0] : "");
return CMD_SUCCESS;
}
DEFUN(cfg_level3_child, cfg_level3_child_cmd,
"child3 [MARKER]",
"Level 3 child cmd for VTY testing purposes\n"
"optional string to mark the line for test debugging\n")
{
printf("called level3 child cmd %s\n", argc? argv[0] : "");
return CMD_SUCCESS;
}
vty: fix use-after-free and memleaks in is_cmd_ambiguous() vty_test: add test against ambiguous cmd causing use-after-free and memory leaks. Add this test along with the fix, because the new test triggers the memory use-after-free and leaks, causing build failures. Add cmd_deopt_with_ctx() to allow passing a specific talloc ctx. is_cmd_ambiguous(): keep all cmd_deopt() allocations until the function exits. Add a comment explaining why. Before this, if a command matched an optional "[arg]" with square brackets, we would keep it in local var 'matched', but we would free the string it points to at the end of that loop iteration; upon encountering another match, we would attempt to strcmp against the freed 'matched'. Instead of adding hard-to-read and -verify free/alloc dances to keep the 'matched' accurately freed/non-freed/..., just keep all cmd_deopt() string allocated until done. Needless to say that this should have been implemented on a lower level upon inventing optional args, but at least this is fixing a program crash. Related: OS#33903390 Change-Id: Ia71ba742108b5ff020997bfb612ad5eb30d04fcd
2018-07-09 21:22:21 +00:00
DEFUN(cfg_ambiguous_nr_1, cfg_ambiguous_nr_1_cmd,
"ambiguous_nr [<0-23>]",
"testing is_cmd_ambiguous()\n"
"optional number arg\n")
{
printf("Called: 'ambiguous_nr [<0-23>]' (argc=%d)\n", argc);
return CMD_SUCCESS;
}
DEFUN(cfg_ambiguous_nr_2, cfg_ambiguous_nr_2_cmd,
"ambiguous_nr <0-23> keyword",
"testing is_cmd_ambiguous()\n"
"optional number arg\n")
{
printf("Called: 'ambiguous_nr <0-23> keyword'\n");
return CMD_SUCCESS;
}
DEFUN(cfg_ambiguous_str_1, cfg_ambiguous_str_1_cmd,
"ambiguous_str [ARG]",
"testing is_cmd_ambiguous()\n"
"optional string arg\n")
{
printf("Called: 'ambiguous_str [ARG]' (argc=%d)\n", argc);
return CMD_SUCCESS;
}
DEFUN(cfg_ambiguous_str_2, cfg_ambiguous_str_2_cmd,
"ambiguous_str ARG keyword",
"testing is_cmd_ambiguous()\n"
"optional string arg\n")
{
printf("Called: 'ambiguous_str ARG keyword'\n");
return CMD_SUCCESS;
}
vty: Return error if cmd returns CMD_WARNING while reading cfg file Otherwise bad configurations can easily sneak in and produce unexpected behavior. Change-Id: Ic9c1b566ec4a459f03e6319cf369691903cf9d00
2019-10-22 16:38:01 +00:00
DEFUN(cfg_ret_success, cfg_ret_success_cmd,
"return-success",
"testing return success\n")
{
printf("Called: 'return-success'\n");
return CMD_SUCCESS;
}
DEFUN(cfg_ret_warning, cfg_ret_warning_cmd,
"return-warning",
"testing return warning\n")
{
printf("Called: 'return-warning'\n");
return CMD_WARNING;
}
vty_test: add artificial node levels for better testing In vty_test, add three levels of parent nodes (level1, level2, level3) with each having a leaf child (child1, child2, child3). Use these to enhance the vty_test cfg files and test more diverse situations. The current VTY code expects a go_parent_cb() to be present, otherwise it will bump right back to the CONFIG_NODE, which will not work with more than one node level below the CONFIG_NODE. Hence provide a minimal go_parent_cb(). Change-Id: Ib9bcf58b655fbd85e196f363fb7d8305d7dfc997
2017-09-19 23:49:11 +00:00
void test_vty_add_cmds()
{
vty: Return error if cmd returns CMD_WARNING while reading cfg file Otherwise bad configurations can easily sneak in and produce unexpected behavior. Change-Id: Ic9c1b566ec4a459f03e6319cf369691903cf9d00
2019-10-22 16:38:01 +00:00
install_element(CONFIG_NODE, &cfg_ret_warning_cmd);
install_element(CONFIG_NODE, &cfg_ret_success_cmd);
logging/vty: fix: actually ignore deprecated logging commands We shall not prevent programs from starting if their configuration files contain deprecated 'logging level ...' commands. Just print a warning and return CMD_SUCCESS instead of CMD_WARNING. While writing a unit test, another funny bug has been uncovered. Parsing of a deprecated command indeed triggers a deprecation warning, originated from libosmovty's log_deprecated_func(). This function simply calls vty_out(), but... Since the invocation of the vty_out() happens _before_ the VTY is initialized, the process is actually writing that warning to its own stdin! Most likely, because we use talloc_zero() to allocate a new instance of struct 'vty'. As a side effect, the evil warning magically appears in the output of 'make check', breaking the test statistics. Let's work around this bug for now by redirecting stdin to /dev/null. Change-Id: Ia934581410cd41594791d4e14ee74c16abe1009a Fixes: Ic9c1b566ec4a459f03e6319cf369691903cf9d00
2019-11-20 17:19:36 +00:00
logging_vty_add_deprecated_subsys(tall_log_ctx, "depr");
vty_test: add artificial node levels for better testing In vty_test, add three levels of parent nodes (level1, level2, level3) with each having a leaf child (child1, child2, child3). Use these to enhance the vty_test cfg files and test more diverse situations. The current VTY code expects a go_parent_cb() to be present, otherwise it will bump right back to the CONFIG_NODE, which will not work with more than one node level below the CONFIG_NODE. Hence provide a minimal go_parent_cb(). Change-Id: Ib9bcf58b655fbd85e196f363fb7d8305d7dfc997
2017-09-19 23:49:11 +00:00
install_element(CONFIG_NODE, &cfg_level1_cmd);
install_node(&level1_node, NULL);
install_element(LEVEL1_NODE, &cfg_level1_child_cmd);
install_element(LEVEL1_NODE, &cfg_level2_cmd);
install_node(&level2_node, NULL);
install_element(LEVEL2_NODE, &cfg_level2_child_cmd);
install_element(LEVEL2_NODE, &cfg_level3_cmd);
install_node(&level3_node, NULL);
install_element(LEVEL3_NODE, &cfg_level3_child_cmd);
vty: fix use-after-free and memleaks in is_cmd_ambiguous() vty_test: add test against ambiguous cmd causing use-after-free and memory leaks. Add this test along with the fix, because the new test triggers the memory use-after-free and leaks, causing build failures. Add cmd_deopt_with_ctx() to allow passing a specific talloc ctx. is_cmd_ambiguous(): keep all cmd_deopt() allocations until the function exits. Add a comment explaining why. Before this, if a command matched an optional "[arg]" with square brackets, we would keep it in local var 'matched', but we would free the string it points to at the end of that loop iteration; upon encountering another match, we would attempt to strcmp against the freed 'matched'. Instead of adding hard-to-read and -verify free/alloc dances to keep the 'matched' accurately freed/non-freed/..., just keep all cmd_deopt() string allocated until done. Needless to say that this should have been implemented on a lower level upon inventing optional args, but at least this is fixing a program crash. Related: OS#33903390 Change-Id: Ia71ba742108b5ff020997bfb612ad5eb30d04fcd
2018-07-09 21:22:21 +00:00
install_element_ve(&cfg_ambiguous_nr_1_cmd);
install_element_ve(&cfg_ambiguous_nr_2_cmd);
install_element_ve(&cfg_ambiguous_str_1_cmd);
install_element_ve(&cfg_ambiguous_str_2_cmd);
}
void test_is_cmd_ambiguous()
{
struct vty *vty;
struct vty_test test;
printf("Going to test is_cmd_ambiguous()\n");
vty = create_test_vty(&test);
OSMO_ASSERT(do_vty_command(vty, "ambiguous_nr") == CMD_SUCCESS);
OSMO_ASSERT(do_vty_command(vty, "ambiguous_nr 23") == CMD_SUCCESS);
OSMO_ASSERT(do_vty_command(vty, "ambiguous_nr 23 keyword") == CMD_SUCCESS);
OSMO_ASSERT(do_vty_command(vty, "ambiguous_str") == CMD_SUCCESS);
OSMO_ASSERT(do_vty_command(vty, "ambiguous_str arg") == CMD_SUCCESS);
OSMO_ASSERT(do_vty_command(vty, "ambiguous_str arg keyword") == CMD_SUCCESS);
destroy_test_vty(&test, vty);
vty_test: add artificial node levels for better testing In vty_test, add three levels of parent nodes (level1, level2, level3) with each having a leaf child (child1, child2, child3). Use these to enhance the vty_test cfg files and test more diverse situations. The current VTY code expects a go_parent_cb() to be present, otherwise it will bump right back to the CONFIG_NODE, which will not work with more than one node level below the CONFIG_NODE. Hence provide a minimal go_parent_cb(). Change-Id: Ib9bcf58b655fbd85e196f363fb7d8305d7dfc997
2017-09-19 23:49:11 +00:00
}
vty: Fix misusage of snprintf in vty/utils.c Compiled with ubuntu 1204 (precise), where -Wformat-security is enabled by -Wall. Test yields ok, but the current implementation doesn't properly support multi-character separators and end strings. So the test output is truncated. Addresses: utils.c: In function 'vty_cmd_string_from_valstr': utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security]
2013-08-06 12:29:14 +00:00
int main(int argc, char **argv)
{
vty/test: Refactor vty creation/deletion into separate functions Currently this is part of the only test function that uses the vty directly. In preperation for more such test cases, this commit moves this code into separate functions. Sponsored-by: On-Waves ehf
2015-11-03 12:47:11 +00:00
struct vty_app_info vty_info = {
.name = "VtyTest",
.version = 0,
};
const struct log_info_cat default_categories[] = {};
const struct log_info log_info = {
.cat = default_categories,
.num_cat = ARRAY_SIZE(default_categories),
};
use osmo_init_logging2() with proper talloc ctx Ironically, when deprecating osmo_init_logging() in I216837780e9405fdaec8059c63d10699c695b360, I forgot to change the callers within libosmocore itself, i.e. in the various regression tests. Change-Id: Ia36c248f99353d5baaa2533f46a2f60a8579bdf8
2018-04-05 01:02:35 +00:00
void *stats_ctx;
ctx = talloc_named_const(NULL, 0, "stats test context");
stats_ctx = talloc_named_const(ctx, 1, "stats test context");
stats/test: Add tests to check VTY configuration This commit adds tests to verify the stats related VTY configuration commands. Sponsored-by: On-Waves ehf
2015-11-03 14:21:34 +00:00
vty: Make vty_event dispatch signals and use it in the testcase The testcase didn't work on Ubuntu 12.04 because vty_create will directly call vty_event (e.g. not through the plt). This means that the approach to override vty_event in the testcase failed. Use the signal interface of libosmocore and make the testcase use it. The signals can be generally useful as well.
2013-10-10 18:21:33 +00:00
osmo_signal_register_handler(SS_L_VTY, vty_event_cb, NULL);
vty/test: Refactor vty creation/deletion into separate functions Currently this is part of the only test function that uses the vty directly. In preperation for more such test cases, this commit moves this code into separate functions. Sponsored-by: On-Waves ehf
2015-11-03 12:47:11 +00:00
/* Fake logging. */
use osmo_init_logging2() with proper talloc ctx Ironically, when deprecating osmo_init_logging() in I216837780e9405fdaec8059c63d10699c695b360, I forgot to change the callers within libosmocore itself, i.e. in the various regression tests. Change-Id: Ia36c248f99353d5baaa2533f46a2f60a8579bdf8
2018-04-05 01:02:35 +00:00
osmo_init_logging2(ctx, &log_info);
vty/test: Refactor vty creation/deletion into separate functions Currently this is part of the only test function that uses the vty directly. In preperation for more such test cases, this commit moves this code into separate functions. Sponsored-by: On-Waves ehf
2015-11-03 12:47:11 +00:00
stats/test: Add tests to check VTY configuration This commit adds tests to verify the stats related VTY configuration commands. Sponsored-by: On-Waves ehf
2015-11-03 14:21:34 +00:00
/* Init stats */
osmo_stats_init(stats_ctx);
vty/test: Refactor vty creation/deletion into separate functions Currently this is part of the only test function that uses the vty directly. In preperation for more such test cases, this commit moves this code into separate functions. Sponsored-by: On-Waves ehf
2015-11-03 12:47:11 +00:00
vty_init(&vty_info);
/* Setup VTY commands */
vty: cleanup logging functions * remove unused parameter from logging_vty_add_cmds() * mark log level descriptors static * change internal static function int check_log_to_target() to more appropriate bool should_log_to_target() * deprecate log_vty_command_*() from public API as it should only be used by logging_vty_add_cmds() Change-Id: I0e9ddd7ba3ce211302d99a3494eb408907a2916e Related: OS#71
2017-03-15 12:20:23 +00:00
logging_vty_add_cmds();
stats/test: Add tests to check VTY configuration This commit adds tests to verify the stats related VTY configuration commands. Sponsored-by: On-Waves ehf
2015-11-03 14:21:34 +00:00
osmo_stats_vty_add_cmds();
vty/test: Refactor vty creation/deletion into separate functions Currently this is part of the only test function that uses the vty directly. In preperation for more such test cases, this commit moves this code into separate functions. Sponsored-by: On-Waves ehf
2015-11-03 12:47:11 +00:00
vty_test: add artificial node levels for better testing In vty_test, add three levels of parent nodes (level1, level2, level3) with each having a leaf child (child1, child2, child3). Use these to enhance the vty_test cfg files and test more diverse situations. The current VTY code expects a go_parent_cb() to be present, otherwise it will bump right back to the CONFIG_NODE, which will not work with more than one node level below the CONFIG_NODE. Hence provide a minimal go_parent_cb(). Change-Id: Ib9bcf58b655fbd85e196f363fb7d8305d7dfc997
2017-09-19 23:49:11 +00:00
test_vty_add_cmds();
vty: Fix misusage of snprintf in vty/utils.c Compiled with ubuntu 1204 (precise), where -Wformat-security is enabled by -Wall. Test yields ok, but the current implementation doesn't properly support multi-character separators and end strings. So the test output is truncated. Addresses: utils.c: In function 'vty_cmd_string_from_valstr': utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security]
2013-08-06 12:29:14 +00:00
test_cmd_string_from_valstr();
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
2013-09-06 14:52:00 +00:00
test_node_tree_structure();
stats/test: Add tests to check VTY configuration This commit adds tests to verify the stats related VTY configuration commands. Sponsored-by: On-Waves ehf
2015-11-03 14:21:34 +00:00
test_stats_vty();
VTY: implicit node exit by de-indenting, not parent lookup Note: This will break users' config files if they do not use consistent indenting. (see below for a definition of "consistent".) When reading VTY commands from a file, use indenting as means to implicitly exit child nodes. Do not look for commands in the parent node implicitly. The VTY so far implies 'exit' commands if a VTY line cannot be parsed on the current node, but succeeds on the parent node. That is the mechanism by which our VTY config files do not need 'exit' at the end of each child node. We've hit problems with this in the following scenarios, which will show improved user experience after this patch: *) When both a parent and its child node have commands with identical names: cs7 instace 0 point-code 1.2.3 sccp-address osmo-msc point-code 0.0.1 If I put the parent's command below the child, it is still interpreted in the context of the child node: cs7 instace 0 sccp-address osmo-msc point-code 0.0.1 point-code 1.2.3 Though the indenting lets me assume I am setting the cs7 instance's global PC to 1.2.3, I'm actually overwriting osmo-msc's PC with 1.2.3 and discarding the 0.0.1. *) When a software change moves a VTY command from a child to a parent. Say 'timezone' moved from 'bts' to 'network' level: network timezone 1 2 Say a user still has an old config file with 'timezone' on the child level: network bts 0 timezone 1 2 trx 0 The user would expect an error message that 'timezone' is invalid on the 'bts' level. Instead, the VTY finds the parent node's 'timezone', steps out of 'bts' to the 'network' level, and instead says that the 'trx' command does not exist. Format: Consistent means that two adjacent indenting lines have the exact same indenting characters for the common length: Weird mix if you ask me, but correct and consistent: ROOT <space>PARENT <space><tab><space>CHILD <space><tab><space><tab><tab>GRANDCHILD <space><tab><space><tab><tab>GRANDCHILD2 <space>SIBLING Inconsistent: ROOT <space>PARENT <tab><space>CHILD <space><space><tab>GRANDCHILD <space><tab><tab>GRANDCHILD2 <tab>SIBLING Also, when going back to a parent level, the exact same indenting must be used as before in that node: Incorrect: ROOT <tab>PARENT <tab><tab><tab>CHILD <tab><tab>SIBLING As not really intended side effect, it is also permitted to indent the entire file starting from the root level. We could guard against it but there's no harm: Correct and consistent: <tab>ROOT <tab><tab>PARENT <tab><tab><tab><tab>CHILD <tab><tab>SIBLING Implementation: Track parent nodes state: whenever a command enters a child node, push a parent node onto an llist to remember the exact indentation characters used for that level. As soon as the first line on a child node is parsed, remember this new indentation (which must have a longer strlen() than its parent level) to apply to all remaining child siblings and grandchildren. If the amount of spaces that indent a following VTY command are less than this expected indentation, call vty_go_parent() until it matches up. At any level, if the common length of indentation characters mismatch, abort parsing in error. Transitions to child node are spread across VTY implementations and are hard to change. But transitions to the parent node are all handled by vty_go_parent(). By popping a parent from the list of parents in vty_go_parent(), we can also detect that a command has changed the node without changing the parent, hence it must have stepped into a child node, and we can push a parent frame. The behavior on the interactive telnet VTY remains unchanged. Change-Id: I24cbb3f6de111f2d31110c3c484c066f1153aac9
2017-09-07 01:08:06 +00:00
test_exit_by_indent("ok.cfg", 0);
test_exit_by_indent("ok_more_spaces.cfg", 0);
test_exit_by_indent("ok_tabs.cfg", 0);
test_exit_by_indent("ok_tabs_and_spaces.cfg", 0);
test_exit_by_indent("ok_ignore_comment.cfg", 0);
test_exit_by_indent("ok_ignore_blank.cfg", 0);
test_exit_by_indent("fail_not_de-indented.cfg", -EINVAL);
test_exit_by_indent("fail_too_much_indent.cfg", -EINVAL);
test_exit_by_indent("fail_tabs_and_spaces.cfg", -EINVAL);
test_exit_by_indent("ok_indented_root.cfg", 0);
fix vty regression: empty parent node The recent exit-by-indent patch breaks a VTY case where a node is entered but directly followed by a sibling or ancestor without listing any child nodes. Regression introduced by I24cbb3f6de111f2d31110c3c484c066f1153aac9. An example is a common usage in osmo-bts, where 'phy N' / 'instance N' is a parent node that is commonly left empty: phy 0 instance 0 bts 0 band 1800 Before this patch, this case produces the error: There is no such command. Error occurred during reading the below line: bts 0 Fix indentation parsing logic in command.c to accomodate this case. Add a unit test for empty parent node. Change-Id: Ia0880a17ae55accb092ae8585cc3a1bec9986891
2017-09-19 21:54:01 +00:00
test_exit_by_indent("ok_empty_parent.cfg", 0);
vty: Return error if cmd returns CMD_WARNING while reading cfg file Otherwise bad configurations can easily sneak in and produce unexpected behavior. Change-Id: Ic9c1b566ec4a459f03e6319cf369691903cf9d00
2019-10-22 16:38:01 +00:00
test_exit_by_indent("fail_cmd_ret_warning.cfg", -EINVAL);
logging/vty: fix: actually ignore deprecated logging commands We shall not prevent programs from starting if their configuration files contain deprecated 'logging level ...' commands. Just print a warning and return CMD_SUCCESS instead of CMD_WARNING. While writing a unit test, another funny bug has been uncovered. Parsing of a deprecated command indeed triggers a deprecation warning, originated from libosmovty's log_deprecated_func(). This function simply calls vty_out(), but... Since the invocation of the vty_out() happens _before_ the VTY is initialized, the process is actually writing that warning to its own stdin! Most likely, because we use talloc_zero() to allocate a new instance of struct 'vty'. As a side effect, the evil warning magically appears in the output of 'make check', breaking the test statistics. Let's work around this bug for now by redirecting stdin to /dev/null. Change-Id: Ia934581410cd41594791d4e14ee74c16abe1009a Fixes: Ic9c1b566ec4a459f03e6319cf369691903cf9d00
2019-11-20 17:19:36 +00:00
test_exit_by_indent("ok_deprecated_logging.cfg", 0);
stats/test: Add tests to check VTY configuration This commit adds tests to verify the stats related VTY configuration commands. Sponsored-by: On-Waves ehf
2015-11-03 14:21:34 +00:00
vty: fix use-after-free and memleaks in is_cmd_ambiguous() vty_test: add test against ambiguous cmd causing use-after-free and memory leaks. Add this test along with the fix, because the new test triggers the memory use-after-free and leaks, causing build failures. Add cmd_deopt_with_ctx() to allow passing a specific talloc ctx. is_cmd_ambiguous(): keep all cmd_deopt() allocations until the function exits. Add a comment explaining why. Before this, if a command matched an optional "[arg]" with square brackets, we would keep it in local var 'matched', but we would free the string it points to at the end of that loop iteration; upon encountering another match, we would attempt to strcmp against the freed 'matched'. Instead of adding hard-to-read and -verify free/alloc dances to keep the 'matched' accurately freed/non-freed/..., just keep all cmd_deopt() string allocated until done. Needless to say that this should have been implemented on a lower level upon inventing optional args, but at least this is fixing a program crash. Related: OS#33903390 Change-Id: Ia71ba742108b5ff020997bfb612ad5eb30d04fcd
2018-07-09 21:22:21 +00:00
test_is_cmd_ambiguous();
stats/test: Add tests to check VTY configuration This commit adds tests to verify the stats related VTY configuration commands. Sponsored-by: On-Waves ehf
2015-11-03 14:21:34 +00:00
/* Leak check */
OSMO_ASSERT(talloc_total_blocks(stats_ctx) == 1);
vty/test: Refactor vty creation/deletion into separate functions Currently this is part of the only test function that uses the vty directly. In preperation for more such test cases, this commit moves this code into separate functions. Sponsored-by: On-Waves ehf
2015-11-03 12:47:11 +00:00
vty: Fix misusage of snprintf in vty/utils.c Compiled with ubuntu 1204 (precise), where -Wformat-security is enabled by -Wall. Test yields ok, but the current implementation doesn't properly support multi-character separators and end strings. So the test output is truncated. Addresses: utils.c: In function 'vty_cmd_string_from_valstr': utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:84:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security] utils.c:108:2: warning: format not a string literal and no format arguments [-Wformat-security]
2013-08-06 12:29:14 +00:00
printf("All tests passed\n");
return 0;
}