From 4abda9ea26403e24b2d91b83a1e4c81f5fb4b003 Mon Sep 17 00:00:00 2001 From: Vadim Yanitskiy Date: Thu, 21 Nov 2019 00:19:36 +0700 Subject: [PATCH] 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 --- src/vty/logging_vty.c | 2 +- tests/Makefile.am | 1 + tests/testsuite.at | 5 ++++- tests/vty/ok_deprecated_logging.cfg | 3 +++ tests/vty/vty_test.c | 4 ++++ tests/vty/vty_test.ok | 2 ++ 6 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 tests/vty/ok_deprecated_logging.cfg diff --git a/src/vty/logging_vty.c b/src/vty/logging_vty.c index b4c3776e3..6d908d9e9 100644 --- a/src/vty/logging_vty.c +++ b/src/vty/logging_vty.c @@ -998,7 +998,7 @@ static int config_write_log(struct vty *vty) static int log_deprecated_func(struct cmd_element *cmd, struct vty *vty, int argc, const char *argv[]) { vty_out(vty, "%% Ignoring deprecated '%s'%s", cmd->string, VTY_NEWLINE); - return CMD_WARNING; + return CMD_SUCCESS; /* Otherwise the process would terminate */ } void logging_vty_add_deprecated_subsys(void *ctx, const char *name) diff --git a/tests/Makefile.am b/tests/Makefile.am index 762499667..e8e4dee15 100644 --- a/tests/Makefile.am +++ b/tests/Makefile.am @@ -306,6 +306,7 @@ EXTRA_DIST = testsuite.at $(srcdir)/package.m4 $(TESTSUITE) \ vty/ok_more_spaces.cfg \ vty/ok_tabs_and_spaces.cfg \ vty/ok_tabs.cfg \ + vty/ok_deprecated_logging.cfg \ comp128/comp128_test.ok bits/bitfield_test.ok \ utils/utils_test.ok utils/utils_test.err stats/stats_test.ok \ bitvec/bitvec_test.ok msgb/msgb_test.ok bits/bitcomp_test.ok \ diff --git a/tests/testsuite.at b/tests/testsuite.at index c231b964c..586514097 100644 --- a/tests/testsuite.at +++ b/tests/testsuite.at @@ -199,7 +199,10 @@ AT_SETUP([vty]) AT_KEYWORDS([vty]) cat $abs_srcdir/vty/vty_test.ok > expout cp $abs_srcdir/vty/*.cfg . -AT_CHECK([$abs_top_builddir/tests/vty/vty_test], [0], [expout], [ignore]) +# FIXME: calling vty_out() during initialization of the VTY interface would cause +# the process write to its own *stdin*! This breaks the output of 'make check'. +# Let's work this around untill the bug in libosmovty is fixed. +AT_CHECK([$abs_top_builddir/tests/vty/vty_test 0>/dev/null], [0], [expout], [ignore]) AT_CLEANUP AT_SETUP([gprs-bssgp]) diff --git a/tests/vty/ok_deprecated_logging.cfg b/tests/vty/ok_deprecated_logging.cfg new file mode 100644 index 000000000..2699719e6 --- /dev/null +++ b/tests/vty/ok_deprecated_logging.cfg @@ -0,0 +1,3 @@ +log stderr + logging filter all 1 + logging level depr debug diff --git a/tests/vty/vty_test.c b/tests/vty/vty_test.c index 0d68a6c01..1139638d8 100644 --- a/tests/vty/vty_test.c +++ b/tests/vty/vty_test.c @@ -29,6 +29,7 @@ #include #include +#include #include #include #include @@ -442,6 +443,8 @@ void test_vty_add_cmds() install_element(CONFIG_NODE, &cfg_ret_warning_cmd); install_element(CONFIG_NODE, &cfg_ret_success_cmd); + logging_vty_add_deprecated_subsys(tall_log_ctx, "depr"); + install_element(CONFIG_NODE, &cfg_level1_cmd); install_node(&level1_node, NULL); install_element(LEVEL1_NODE, &cfg_level1_child_cmd); @@ -544,6 +547,7 @@ int main(int argc, char **argv) test_exit_by_indent("ok_indented_root.cfg", 0); test_exit_by_indent("ok_empty_parent.cfg", 0); test_exit_by_indent("fail_cmd_ret_warning.cfg", -EINVAL); + test_exit_by_indent("ok_deprecated_logging.cfg", 0); test_is_cmd_ambiguous(); diff --git a/tests/vty/vty_test.ok b/tests/vty/vty_test.ok index 0b5ac9c0b..d2c96111e 100644 --- a/tests/vty/vty_test.ok +++ b/tests/vty/vty_test.ok @@ -290,6 +290,8 @@ reading file fail_cmd_ret_warning.cfg, expecting rc=-22 Called: 'return-success' Called: 'return-warning' got rc=-22 +reading file ok_deprecated_logging.cfg, expecting rc=0 +got rc=0 Going to test is_cmd_ambiguous() Going to execute 'ambiguous_nr' Called: 'ambiguous_nr [<0-23>]' (argc=0)