Re: [PATCH] Acceptance tests: refactor wait_for_console_pattern

["Philippe Mathieu-Daudé" <philmd@redhat.com>]

On 9/16/19 6:40 PM, Cleber Rosa wrote:
> The same utility method is already present in two different test
> files, so let's consolidate it into a single utility function.
> 
> Signed-off-by: Cleber Rosa <crosa@redhat.com>
> ---
>   tests/acceptance/avocado_qemu/__init__.py | 26 +++++++++++++
>   tests/acceptance/boot_linux_console.py    | 47 +++++++----------------
>   tests/acceptance/linux_ssh_mips_malta.py  | 18 ++-------
>   3 files changed, 42 insertions(+), 49 deletions(-)
> 
> diff --git a/tests/acceptance/avocado_qemu/__init__.py b/tests/acceptance/avocado_qemu/__init__.py
> index bd41e0443c..a0fe16e47f 100644
> --- a/tests/acceptance/avocado_qemu/__init__.py
> +++ b/tests/acceptance/avocado_qemu/__init__.py
> @@ -8,6 +8,7 @@
>   # This work is licensed under the terms of the GNU GPL, version 2 or
>   # later.  See the COPYING file in the top-level directory.
>   
> +import logging
>   import os
>   import sys
>   import uuid
> @@ -53,6 +54,31 @@ def pick_default_qemu_bin(arch=None):
>           return qemu_bin_from_src_dir_path
>   
>   
> +def wait_for_console_pattern(test, success_message,
> +                             failure_message='Kernel panic - not syncing'):
> +    """
> +    Waits for messages to appear on the console, while logging the content
> +
> +    :param test: an Avocado test containing a VM that will have its console
> +                 read and probed for a success or failure message
> +    :type test: :class:`avocado_qemu.Test`
> +    :param success_message: if this message appears, test succeeds
> +    :param failure_message: if this message appears, test fails
> +    """
> +    console = test.vm.console_socket.makefile()
> +    console_logger = logging.getLogger('console')
> +    while True:
> +        msg = console.readline().strip()
> +        if not msg:
> +            continue
> +        console_logger.debug(msg)
> +        if success_message in msg:
> +            break
> +        if failure_message in msg:
> +            fail = 'Failure message found in console: %s' % failure_message
> +            test.fail(fail)
> +
> +
>   class Test(avocado.Test):
>       def setUp(self):
>           self._vms = {}
> diff --git a/tests/acceptance/boot_linux_console.py b/tests/acceptance/boot_linux_console.py
> index 8a9a314ab4..9ff2213874 100644
> --- a/tests/acceptance/boot_linux_console.py
> +++ b/tests/acceptance/boot_linux_console.py
> @@ -9,12 +9,12 @@
>   # later.  See the COPYING file in the top-level directory.
>   
>   import os
> -import logging
>   import lzma
>   import gzip
>   import shutil
>   
>   from avocado_qemu import Test
> +from avocado_qemu import wait_for_console_pattern
>   from avocado.utils import process
>   from avocado.utils import archive
>   
> @@ -29,31 +29,10 @@ class BootLinuxConsole(Test):
>   
>       KERNEL_COMMON_COMMAND_LINE = 'printk.time=0 '
>   
> -    def wait_for_console_pattern(self, success_message,
> -                                 failure_message='Kernel panic - not syncing'):
> -        """
> -        Waits for messages to appear on the console, while logging the content
> -
> -        :param success_message: if this message appears, test succeeds
> -        :param failure_message: if this message appears, test fails
> -        """
> -        console = self.vm.console_socket.makefile()
> -        console_logger = logging.getLogger('console')
> -        while True:
> -            msg = console.readline().strip()
> -            if not msg:
> -                continue
> -            console_logger.debug(msg)
> -            if success_message in msg:
> -                break
> -            if failure_message in msg:
> -                fail = 'Failure message found in console: %s' % failure_message
> -                self.fail(fail)
> -
>       def exec_command_and_wait_for_pattern(self, command, success_message):
>           command += '\n'
>           self.vm.console_socket.sendall(command.encode())
> -        self.wait_for_console_pattern(success_message)
> +        wait_for_console_pattern(self, success_message)
>   
>       def extract_from_deb(self, deb, path):
>           """
> @@ -89,7 +68,7 @@ class BootLinuxConsole(Test):
>                            '-append', kernel_command_line)
>           self.vm.launch()
>           console_pattern = 'Kernel command line: %s' % kernel_command_line
> -        self.wait_for_console_pattern(console_pattern)
> +        wait_for_console_pattern(self, console_pattern)
>   
>       def test_mips_malta(self):
>           """
> @@ -112,7 +91,7 @@ class BootLinuxConsole(Test):
>                            '-append', kernel_command_line)
>           self.vm.launch()
>           console_pattern = 'Kernel command line: %s' % kernel_command_line
> -        self.wait_for_console_pattern(console_pattern)
> +        wait_for_console_pattern(self, console_pattern)
>   
>       def test_mips64el_malta(self):
>           """
> @@ -145,7 +124,7 @@ class BootLinuxConsole(Test):
>                            '-append', kernel_command_line)
>           self.vm.launch()
>           console_pattern = 'Kernel command line: %s' % kernel_command_line
> -        self.wait_for_console_pattern(console_pattern)
> +        wait_for_console_pattern(self, console_pattern)
>   
>       def test_mips_malta_cpio(self):
>           """
> @@ -181,7 +160,7 @@ class BootLinuxConsole(Test):
>                            '-append', kernel_command_line,
>                            '-no-reboot')
>           self.vm.launch()
> -        self.wait_for_console_pattern('Boot successful.')
> +        wait_for_console_pattern(self, 'Boot successful.')
>   
>           self.exec_command_and_wait_for_pattern('cat /proc/cpuinfo',
>                                                  'BogoMIPS')
> @@ -208,7 +187,7 @@ class BootLinuxConsole(Test):
>                            '-append', kernel_command_line)
>           self.vm.launch()
>           console_pattern = 'Kernel command line: %s' % kernel_command_line
> -        self.wait_for_console_pattern(console_pattern)
> +        wait_for_console_pattern(self, console_pattern)
>   
>       def test_mips_malta32el_nanomips_4k(self):
>           """
> @@ -266,7 +245,7 @@ class BootLinuxConsole(Test):
>                            '-append', kernel_command_line)
>           self.vm.launch()
>           console_pattern = 'Kernel command line: %s' % kernel_command_line
> -        self.wait_for_console_pattern(console_pattern)
> +        wait_for_console_pattern(self, console_pattern)
>   
>       def test_arm_virt(self):
>           """
> @@ -287,7 +266,7 @@ class BootLinuxConsole(Test):
>                            '-append', kernel_command_line)
>           self.vm.launch()
>           console_pattern = 'Kernel command line: %s' % kernel_command_line
> -        self.wait_for_console_pattern(console_pattern)
> +        wait_for_console_pattern(self, console_pattern)
>   
>       def test_arm_emcraft_sf2(self):
>           """
> @@ -314,7 +293,7 @@ class BootLinuxConsole(Test):
>                            '-drive', 'file=' + spi_path + ',if=mtd,format=raw',
>                            '-no-reboot')
>           self.vm.launch()
> -        self.wait_for_console_pattern('init started: BusyBox')
> +        wait_for_console_pattern(self, 'init started: BusyBox')
>   
>       def test_s390x_s390_ccw_virtio(self):
>           """
> @@ -335,7 +314,7 @@ class BootLinuxConsole(Test):
>                            '-append', kernel_command_line)
>           self.vm.launch()
>           console_pattern = 'Kernel command line: %s' % kernel_command_line
> -        self.wait_for_console_pattern(console_pattern)
> +        wait_for_console_pattern(self, console_pattern)
>   
>       def test_alpha_clipper(self):
>           """
> @@ -357,7 +336,7 @@ class BootLinuxConsole(Test):
>                            '-append', kernel_command_line)
>           self.vm.launch()
>           console_pattern = 'Kernel command line: %s' % kernel_command_line
> -        self.wait_for_console_pattern(console_pattern)
> +        wait_for_console_pattern(self, console_pattern)
>   
>       def test_ppc64_pseries(self):
>           """
> @@ -377,4 +356,4 @@ class BootLinuxConsole(Test):
>                            '-append', kernel_command_line)
>           self.vm.launch()
>           console_pattern = 'Kernel command line: %s' % kernel_command_line
> -        self.wait_for_console_pattern(console_pattern)
> +        wait_for_console_pattern(self, console_pattern)
> diff --git a/tests/acceptance/linux_ssh_mips_malta.py b/tests/acceptance/linux_ssh_mips_malta.py
> index 134f10cac3..da7a386117 100644
> --- a/tests/acceptance/linux_ssh_mips_malta.py
> +++ b/tests/acceptance/linux_ssh_mips_malta.py
> @@ -14,6 +14,7 @@ import time
>   
>   from avocado import skipIf
>   from avocado_qemu import Test
> +from avocado_qemu import wait_for_console_pattern
>   from avocado.utils import process
>   from avocado.utils import archive
>   
> @@ -56,19 +57,6 @@ class LinuxSSH(Test):
>           },
>       }
>   
> -    def wait_for_console_pattern(self, success_message,
> -                                 failure_message='Oops'):
> -        console = self.vm.console_socket.makefile()
> -        console_logger = logging.getLogger('console')
> -        while True:
> -            msg = console.readline()
> -            console_logger.debug(msg.strip())
> -            if success_message in msg:
> -                break
> -            if failure_message in msg:
> -                fail = 'Failure message found in console: %s' % failure_message
> -                self.fail(fail)
> -
>       def get_portfwd(self):
>           res = self.vm.command('human-monitor-command',
>                                 command_line='info usernet')
> @@ -135,7 +123,7 @@ class LinuxSSH(Test):
>   
>           self.log.info('VM launched, waiting for sshd')
>           console_pattern = 'Starting OpenBSD Secure Shell server: sshd'
> -        self.wait_for_console_pattern(console_pattern)
> +        wait_for_console_pattern(self, console_pattern, 'Oops')
>           self.log.info('sshd ready')
>   
>           self.ssh_connect('root', 'root', rsa_hostkey_b64=rsa_hostkey_b64)
> @@ -143,7 +131,7 @@ class LinuxSSH(Test):
>       def shutdown_via_ssh(self):
>           self.ssh_command('poweroff')
>           self.ssh_disconnect_vm()
> -        self.wait_for_console_pattern('Power down')
> +        wait_for_console_pattern(self, 'Power down', 'Oops')
>   
>       def run_common_commands(self):
>           stdout, stderr = self.ssh_command('lspci -d 11ab:4620')
> 

Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>