automatic tests for TUI (ncurses)

package/yast2-ruby-bindings.changes

@@ -1,3 +1,9 @@
+-------------------------------------------------------------------
+Tue Oct 13 14:42:52 UTC 2020 - Martin Vidner <[email protected]>
+
+- Add automatic TUI (ncurses) tests using tmux (bsc#1165388).
+- 4.3.5
+
 -------------------------------------------------------------------
 Thu Sep 24 19:46:00 UTC 2020 - [email protected]
 

package/yast2-ruby-bindings.spec

@@ -17,7 +17,7 @@
 
 
 Name:           yast2-ruby-bindings
-Version:        4.3.4
+Version:        4.3.5
 Release:        0
 URL:            https://github.com/yast/yast-ruby-bindings
 BuildRoot:      %{_tmppath}/%{name}-%{version}-build
@@ -46,9 +46,9 @@ BuildRequires:  yast2-ycp-ui-bindings-devel >= 4.3.1
 # The test suite includes a regression test (std_streams_spec.rb) for a
 # libyui-ncurses bug fixed in 2.47.3
 BuildRequires:  libyui-ncurses >= 2.47.3
-# The mentioned test requires to check if tmux is there, because tmux is
-# needed to execute the test in headless systems
-BuildRequires:  which
+# The mentioned test requires tmux in order to be executed in headless systems
+# Also many other libyui tests to come
+BuildRequires:  tmux
 
 # only a soft dependency, the Ruby debugger is optional
 Suggests:       rubygem(%{rb_default_ruby_abi}:byebug)

tests/CMakeLists.txt

@@ -1,6 +1,11 @@
-#
-# CMakeLists.txt for yast2/ruby-bindings/tests/ruby
-#
+# CMakeLists.txt for yast-ruby-bindings/tests
+
+# use
+#   make test
+# or, for verbose output,
+#   make test ARGS=-V
+# ARGS is passed to ctest; see also
+#   man ctest
 
 ENABLE_TESTING()
 
@@ -12,3 +17,8 @@ endforeach(test)
 
 ADD_TEST("integration"  ruby ${CMAKE_CURRENT_SOURCE_DIR}/integration/run.rb)
 ADD_TEST("translations" rspec --format doc ${CMAKE_CURRENT_SOURCE_DIR}/integration/translations_spec.rb)
+
+file(GLOB libyui_tests "libyui/*.test")
+foreach(test ${libyui_tests})
+    ADD_TEST(${test} ${test})
+endforeach()

tests/libyui/README.md

@@ -0,0 +1,3 @@
+
+- `foo.test` - main script of the test case
+- `foo.rb` - UI set up

tests/libyui/menu_hotkeys_1177760.test

@@ -0,0 +1,37 @@
+#!/bin/sh
+
+# Test https://bugzilla.suse.com/show_bug.cgi?id=1177760
+# Menu items lose their hotkeys
+
+set -u                          # unset variables are an error
+MYDIR=$(dirname "$0")
+# shellcheck source=/dev/null # that file is checked separately
+. "$MYDIR"/tmux-uitest.sh
+BUG=1177760
+BASE=menu_hotkeys_$BUG
+
+tmux_new_session "${MYDIR}/yast_ncurses /usr/share/doc/packages/yast2-ycp-ui-bindings/examples/MenuBar1.rb" || exit
+trap tmux_cleanup EXIT
+
+tmux_await "File.*Edit.*View" || exit
+sleep 0.1                       # draw the rest of the screen
+tmux_capture_pane_to "${BASE}-1-initial"
+
+tmux_send_keys M-V # &View
+tmux_capture_pane_to "${BASE}-2-view-menu-activated"
+
+tmux_send_keys M-N # &Normal
+tmux_capture_pane_to "${BASE}-3-normal-menu-item-activated"
+
+if ! tmux_grep "Last Event"; then
+    echo "The script does not echo what it should"
+    exit 1
+fi
+
+if ! tmux_grep "view_normal"; then
+    echo "view_normal was not activated, bug boo#$BUG exists"
+    exit 1
+fi
+
+tmux_send_keys M-Q # &Quit
+exit 0

tests/libyui/shellcheck.test

@@ -0,0 +1,12 @@
+#!/bin/bash
+set -e
+set -u
+
+if ! type -P shellcheck >/dev/null; then
+   echo "SKIP https://www.shellcheck.net/ is not installed"
+   exit 0
+fi
+
+MYDIR=$(dirname "$0")
+FILES=("$MYDIR"/*.test "$MYDIR"/tmux-uitest.sh)
+shellcheck --wiki-link-count=99 "${FILES[@]}"

tests/libyui/tmux-uitest.sh

@@ -0,0 +1,106 @@
+#!/bin/bash
+# tmux-uitest.sh - a shell library to test Text User Interface using tmux
+
+SESSION=uitest
+: "${VERBOSE=false}"
+
+# $1 shell command for sh -c
+tmux_new_session() {
+    if $VERBOSE; then
+        echo Starting session
+    fi
+    # -s session name
+    # -x width -y height,
+    # -d detached
+    # FIXME: sleep to be able to see errors when running $1
+    tmux new-session -s "$SESSION" -x 80 -y 24 -d sh -c "$1; sleep 9999"
+}
+
+# A --quiet grep
+# $1 regex (POSIX ERE) to find in captured pane
+# retcode: true or false
+tmux_grep() {
+    local REGEX="$1"
+    tmux capture-pane -t "$SESSION" -p | grep -E --quiet "$REGEX"
+    RESULT=("${PIPESTATUS[@]}")
+
+    if [ "${RESULT[0]}" != 0 ]; then
+        # capturing the pane failed; the session may have exited already
+        return 2
+    fi
+
+    # capturing went fine, pass on the grep result
+    test "${RESULT[1]}" = 0
+}
+
+# $1 regex (POSIX ERE) to find in captured pane
+tmux_await() {
+    local REGEX="$1"
+
+    local SLEEPS=(0.1 0.2 0.2 0.5 1 2 2 5)
+    for SL in "${SLEEPS[@]}"; do
+        tmux_grep "$REGEX" && return 0
+        if [ $? = 2 ]; then return 2; fi # session not found
+        # text not found, continue waiting for it
+        sleep "$SL"
+    done
+    # text not found, timed out
+    false
+}
+
+# capture the session to stdout
+tmux_capture_pane() {
+    tmux capture-pane -t "$SESSION" -p
+}
+
+# $1
+# $1.txt plain text
+# $1.esc text with escape sequences for colors
+tmux_capture_pane_to() {
+    local OUT="$1"
+
+    # -t target-pane, -p to stdout,
+    # -e escape sequences for text and background attributes
+    tmux capture-pane -t "$SESSION" -p -e > "$OUT.esc"
+    tmux capture-pane -t "$SESSION" -p    > "$OUT.txt"
+    # this is racy. if it is a problem we should make .txt from .esc
+    # by filtering out the escape sequences
+}
+
+# $1 keys ("C-X" for Ctrl-X, "M-X" for Alt-X, think "Meta"); for details see:
+#   man tmux | less +/"^KEY BINDINGS"
+tmux_send_keys() {
+    if $VERBOSE; then
+        echo Sending "$1"
+    fi
+    # -t target-pane
+    tmux send-keys -t "$SESSION" "$1"
+}
+
+# usage: trap tmux_cleanup EXIT
+tmux_cleanup() {
+    if tmux_has_session; then
+        echo "SCREEN BEGIN (non-empty lines only)"
+        tmux_capture_pane | grep .
+        echo "SCREEN END"
+        tmux_kill_session
+    fi
+}
+
+# ret code: true or false
+tmux_has_session() {
+    if $VERBOSE; then
+        echo Detecting the session
+    fi
+    # -t target-session
+    tmux has-session -t "$SESSION"
+}
+
+
+tmux_kill_session() {
+    if $VERBOSE; then
+        echo Killing the session
+    fi
+    # -t target-session
+    tmux kill-session -t "$SESSION"
+}

tests/libyui/yast_ncurses

@@ -0,0 +1,5 @@
+#! /usr/bin/env ruby
+require_relative "../test_helper"
+require "yast"
+Yast.ui_component = "ncurses"
+load ARGV[0]