aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNeels Hofmeyr <neels@hofmeyr.de>2019-01-31 09:06:53 +0100
committerNeels Hofmeyr <nhofmeyr@sysmocom.de>2019-02-04 16:43:57 +0000
commitfaa49e24cb8044134a6c0d5621ca298cae628c4e (patch)
tree3a868a7cb0b3aa030d280a392faa212563025fc9
parentb3e9b313838fe4c80acdf0a95e0cd9609370f8f2 (diff)
add generic vty_transcript_test.c, vty_transcript_test.vty
I want to tweak general VTY features and need to cover with a transcript test to show the differences. Start by showing the current situation of optional and multi-choice arguments. Change-Id: I5a79c83fabd02aba6406b6e0d620969c4bd0cc1d
-rw-r--r--tests/Makefile.am20
-rw-r--r--tests/vty/vty_transcript_test.c230
-rw-r--r--tests/vty/vty_transcript_test.vty53
3 files changed, 301 insertions, 2 deletions
diff --git a/tests/Makefile.am b/tests/Makefile.am
index a307886..91f042e 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -26,6 +26,7 @@ check_PROGRAMS = timer/timer_test sms/sms_test ussd/ussd_test \
codec/codec_ecu_fr_test timer/clk_override_test \
oap/oap_client_test gsm29205/gsm29205_test \
logging/logging_vty_test \
+ vty/vty_transcript_test \
$(NULL)
if ENABLE_MSGFILE
@@ -156,6 +157,9 @@ logging_logging_test_SOURCES = logging/logging_test.c
logging_logging_vty_test_SOURCES = logging/logging_vty_test.c
logging_logging_vty_test_LDADD = $(LDADD) $(top_builddir)/src/vty/libosmovty.la
+vty_vty_transcript_test_SOURCES = vty/vty_transcript_test.c
+vty_vty_transcript_test_LDADD = $(LDADD) $(top_builddir)/src/vty/libosmovty.la
+
fr_fr_test_SOURCES = fr/fr_test.c
fr_fr_test_LDADD = $(LDADD) $(top_builddir)/src/gb/libosmogb.la $(LIBRARY_DLSYM) \
$(top_builddir)/src/vty/libosmovty.la \
@@ -278,7 +282,9 @@ EXTRA_DIST = testsuite.at $(srcdir)/package.m4 $(TESTSUITE) \
sercomm/sercomm_test.ok prbs/prbs_test.ok \
gsm29205/gsm29205_test.ok gsm23003/gsm23003_test.ok \
timer/clk_override_test.ok \
- oap/oap_client_test.ok oap/oap_client_test.err
+ oap/oap_client_test.ok oap/oap_client_test.err \
+ vty/vty_transcript_test.vty \
+ $(NULL)
DISTCLEANFILES = atconfig atlocal conv/gsm0503_test_vectors.c
BUILT_SOURCES = conv/gsm0503_test_vectors.c
@@ -322,11 +328,21 @@ endif
# To update the VTY script from current application behavior,
# pass -u to osmo_verify_transcript_vty.py by doing:
# make vty-test U=-u
-vty-test:
+vty-test-logging:
osmo_verify_transcript_vty.py -v \
-p 42042 \
-r "$(top_builddir)/tests/logging/logging_vty_test" \
$(U) $(srcdir)/logging/*.vty
+vty-test-vty:
+ osmo_verify_transcript_vty.py -v \
+ -p 42042 \
+ -r "$(top_builddir)/tests/vty/vty_transcript_test" \
+ $(U) $(srcdir)/vty/*.vty
+
+vty-test:
+ $(MAKE) vty-test-logging
+ $(MAKE) vty-test-vty
+
ctrl-test:
echo "No CTRL tests exist currently"
diff --git a/tests/vty/vty_transcript_test.c b/tests/vty/vty_transcript_test.c
new file mode 100644
index 0000000..50131ea
--- /dev/null
+++ b/tests/vty/vty_transcript_test.c
@@ -0,0 +1,230 @@
+/* Test implementation for VTY transcript testing. */
+/*
+ * (C) 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
+ *
+ * All Rights Reserved
+ *
+ * SPDX-License-Identifier: GPL-2.0+
+ *
+ * Author: Neels Hofmeyr <nhofmeyr@sysmocom.de>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (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.
+ */
+
+#define _GNU_SOURCE
+#include <getopt.h>
+#include <signal.h>
+#include <limits.h>
+#include <string.h>
+
+#include <osmocom/core/application.h>
+
+#include <osmocom/vty/command.h>
+#include <osmocom/vty/misc.h>
+#include <osmocom/vty/telnet_interface.h>
+
+#include <stdlib.h>
+
+#include "config.h"
+
+void *root_ctx = NULL;
+
+static void print_help()
+{
+ printf( "options:\n"
+ " -h --help this text\n"
+ " -d --debug MASK Enable debugging (e.g. -d DRSL:DOML:DLAPDM)\n"
+ " -D --daemonize For the process into a background daemon\n"
+ " -c --config-file Specify the filename of the config file\n"
+ " -s --disable-color Don't use colors in stderr log output\n"
+ " -T --timestamp Prefix every log line with a timestamp\n"
+ " -V --version Print version information and exit\n"
+ " -e --log-level Set a global log-level\n"
+ );
+}
+
+static struct {
+ const char *config_file;
+ int daemonize;
+} cmdline_config = {};
+
+static void handle_options(int argc, char **argv)
+{
+ while (1) {
+ int option_idx = 0, c;
+ static const struct option long_options[] = {
+ { "help", 0, 0, 'h' },
+ { "debug", 1, 0, 'd' },
+ { "daemonize", 0, 0, 'D' },
+ { "config-file", 1, 0, 'c' },
+ { "disable-color", 0, 0, 's' },
+ { "timestamp", 0, 0, 'T' },
+ { "version", 0, 0, 'V' },
+ { "log-level", 1, 0, 'e' },
+ {}
+ };
+
+ c = getopt_long(argc, argv, "hc:d:Dc:sTVe:",
+ long_options, &option_idx);
+ if (c == -1)
+ break;
+
+ switch (c) {
+ case 'h':
+ print_help();
+ exit(0);
+ case 's':
+ log_set_use_color(osmo_stderr_target, 0);
+ break;
+ case 'd':
+ log_parse_category_mask(osmo_stderr_target, optarg);
+ break;
+ case 'D':
+ cmdline_config.daemonize = 1;
+ break;
+ case 'c':
+ cmdline_config.config_file = optarg;
+ break;
+ case 'T':
+ log_set_print_timestamp(osmo_stderr_target, 1);
+ break;
+ case 'e':
+ log_set_log_level(osmo_stderr_target, atoi(optarg));
+ break;
+ case 'V':
+ print_version(1);
+ exit(0);
+ break;
+ default:
+ /* catch unknown options *as well as* missing arguments. */
+ fprintf(stderr, "Error in command line options. Exiting.\n");
+ exit(-1);
+ }
+ }
+}
+
+static int quit = 0;
+
+static void signal_handler(int signal)
+{
+ fprintf(stdout, "signal %u received\n", signal);
+
+ switch (signal) {
+ case SIGINT:
+ case SIGTERM:
+ quit++;
+ break;
+ case SIGABRT:
+ osmo_generate_backtrace();
+ /* in case of abort, we want to obtain a talloc report
+ * and then return to the caller, who will abort the process */
+ case SIGUSR1:
+ talloc_report(tall_vty_ctx, stderr);
+ talloc_report_full(root_ctx, stderr);
+ break;
+ case SIGUSR2:
+ talloc_report_full(tall_vty_ctx, stderr);
+ break;
+ default:
+ break;
+ }
+}
+
+static struct vty_app_info vty_info = {
+ .name = "vty_transcript_test",
+ .version = PACKAGE_VERSION,
+};
+
+static const struct log_info_cat default_categories[] = {};
+
+const struct log_info log_info = {
+ .cat = default_categories,
+ .num_cat = ARRAY_SIZE(default_categories),
+};
+
+DEFUN(multi0, multi0_cmd,
+ "multi0 (one|two|three)",
+ "multi0 test command\n" "1\n2\n3\n")
+{
+ vty_out(vty, "ok argc=%d%s%s%s", argc, argc ? " " : "", argc ? argv[0] : "", VTY_NEWLINE);
+ return CMD_SUCCESS;
+}
+
+DEFUN(multi1, multi1_cmd,
+ "multi1 ([one]|[two]|[three])",
+ "multi1 test command\n" "1\n2\n3\n")
+{
+ vty_out(vty, "ok argc=%d%s%s%s", argc, argc ? " " : "", argc ? argv[0] : "", VTY_NEWLINE);
+ return CMD_SUCCESS;
+}
+
+static void init_vty_cmds()
+{
+ install_element_ve(&multi0_cmd);
+ install_element_ve(&multi1_cmd);
+}
+
+int main(int argc, char **argv)
+{
+ int rc;
+
+ root_ctx = talloc_named_const(NULL, 0, "vty_transcript_test");
+
+ vty_info.tall_ctx = root_ctx;
+ vty_init(&vty_info);
+ osmo_talloc_vty_add_cmds();
+ init_vty_cmds();
+
+ osmo_init_logging2(root_ctx, &log_info);
+
+ handle_options(argc, argv);
+
+ if (cmdline_config.config_file) {
+ rc = vty_read_config_file(cmdline_config.config_file, NULL);
+ if (rc < 0) {
+ fprintf(stderr, "Failed to parse the config file: '%s'\n", cmdline_config.config_file);
+ return 1;
+ }
+ }
+
+ rc = telnet_init_dynif(root_ctx, NULL, vty_get_bind_addr(), 42042);
+ if (rc < 0)
+ return 2;
+
+ signal(SIGINT, &signal_handler);
+ signal(SIGTERM, &signal_handler);
+ signal(SIGABRT, &signal_handler);
+ signal(SIGUSR1, &signal_handler);
+ signal(SIGUSR2, &signal_handler);
+ osmo_init_ignore_signals();
+
+ if (cmdline_config.daemonize) {
+ rc = osmo_daemonize();
+ if (rc < 0) {
+ perror("Error during daemonize");
+ return 6;
+ }
+ }
+
+ while (!quit) {
+ log_reset_context();
+ osmo_select_main(0);
+ }
+
+ talloc_free(root_ctx);
+ talloc_free(tall_vty_ctx);
+
+ return 0;
+}
diff --git a/tests/vty/vty_transcript_test.vty b/tests/vty/vty_transcript_test.vty
new file mode 100644
index 0000000..1ae7c0d
--- /dev/null
+++ b/tests/vty/vty_transcript_test.vty
@@ -0,0 +1,53 @@
+vty_transcript_test> list
+...
+ multi0 (one|two|three)
+ multi1 ([one]|[two]|[three])
+
+vty_transcript_test> multi0 ?
+ one 1
+ two 2
+ three 3
+
+vty_transcript_test> multi0 one
+ok argc=1 one
+
+vty_transcript_test> multi0 two
+ok argc=1 two
+
+vty_transcript_test> multi0 o
+ok argc=1 o
+
+vty_transcript_test> multi0 t
+ok argc=1 t
+
+vty_transcript_test> multi0 th
+ok argc=1 th
+
+vty_transcript_test> multi0
+% Command incomplete.
+
+vty_transcript_test> multi1 ?
+ [one] 1
+ [two] 2
+ [three] 3
+
+vty_transcript_test> multi1 one
+ok argc=1 one
+
+vty_transcript_test> multi1 two
+ok argc=1 two
+
+vty_transcript_test> multi1 o
+ok argc=1 o
+
+vty_transcript_test> multi1 t
+ok argc=1 t
+
+vty_transcript_test> multi1 th
+ok argc=1 th
+
+vty_transcript_test> multi1
+% Command incomplete.
+
+vty_transcript_test> multi1 [one]
+% Unknown command.