From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.3 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,NICE_REPLY_A,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_SANE_1 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2524AC433DB for ; Tue, 9 Feb 2021 14:52:32 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 88FAC64E7C for ; Tue, 9 Feb 2021 14:52:31 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 88FAC64E7C Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:33796 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1l9UNS-0005OA-I5 for qemu-devel@archiver.kernel.org; Tue, 09 Feb 2021 09:52:30 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:56244) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1l9UME-0003ze-9R for qemu-devel@nongnu.org; Tue, 09 Feb 2021 09:51:14 -0500 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:22097) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1l9UMC-0004t6-73 for qemu-devel@nongnu.org; Tue, 09 Feb 2021 09:51:14 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1612882271; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=3YEvZMainYuYXuGBuoid5bUC2dw9GiHxnGESqyF0+E4=; b=cCxJU0iEY/uOrs095zh03nhg7bivdphJxL/L13BDWbarTydxfcf8JG43zsmeuDBOa+kmYb DW/GHxoDxz80eZaWi5S7s/PL87VJMdUiaQo33b9OWbA4zlRGf7lv6XExPDEdLojXGtfjxQ hpb3PFi9nM7iydU/dBqM6ZhWbiQWWtk= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-271-51ZquEr4N4elIQP5XCjUFw-1; Tue, 09 Feb 2021 09:51:09 -0500 X-MC-Unique: 51ZquEr4N4elIQP5XCjUFw-1 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 6324280196C; Tue, 9 Feb 2021 14:51:07 +0000 (UTC) Received: from wainer-laptop.localdomain (ovpn-116-126.gru2.redhat.com [10.97.116.126]) by smtp.corp.redhat.com (Postfix) with ESMTP id 475ED60C5C; Tue, 9 Feb 2021 14:50:54 +0000 (UTC) Subject: Re: [PATCH 10/22] Python: add utility function for retrieving port redirection To: Cleber Rosa , qemu-devel@nongnu.org References: <20210203172357.1422425-1-crosa@redhat.com> <20210203172357.1422425-11-crosa@redhat.com> From: Wainer dos Santos Moschetta Message-ID: <4d848476-c5b4-2fd0-cbcc-01f87e4dfb71@redhat.com> Date: Tue, 9 Feb 2021 11:50:51 -0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.7.0 MIME-Version: 1.0 In-Reply-To: <20210203172357.1422425-11-crosa@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=wainersm@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Content-Language: en-US Received-SPF: pass client-ip=216.205.24.124; envelope-from=wainersm@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -35 X-Spam_score: -3.6 X-Spam_bar: --- X-Spam_report: (-3.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.57, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, NICE_REPLY_A=-0.265, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_FILL_THIS_FORM_SHORT=0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Fam Zheng , Aleksandar Rikalo , Beraldo Leal , John Snow , =?UTF-8?Q?Philippe_Mathieu-Daud=c3=a9?= , =?UTF-8?Q?Philippe_Mathieu-Daud=c3=a9?= , Max Reitz , Eric Auger , Willian Rampazzo , Thomas Huth , =?UTF-8?Q?Marc-Andr=c3=a9_Lureau?= , =?UTF-8?Q?Alex_Benn=c3=a9e?= , Aurelien Jarno , Eduardo Habkost Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Hi, On 2/3/21 2:23 PM, Cleber Rosa wrote: > Slightly different versions for the same utility code are currently > present on different locations. This unifies them all, giving > preference to the version from virtiofs_submounts.py, because of the > last tweaks added to it. > > While at it, this adds a "qemu.util" module to host the utility > function and a test. > > Signed-off-by: Cleber Rosa > --- > python/qemu/utils.py | 35 ++++++++++++++++++++++++ > tests/acceptance/info_usernet.py | 29 ++++++++++++++++++++ > tests/acceptance/linux_ssh_mips_malta.py | 16 +++++------ > tests/acceptance/virtiofs_submounts.py | 20 +++----------- > tests/vm/basevm.py | 7 ++--- > 5 files changed, 77 insertions(+), 30 deletions(-) > create mode 100644 python/qemu/utils.py > create mode 100644 tests/acceptance/info_usernet.py I've a few suggestions: - IMHO "utils" is too broad, people may start throwing random stuffs there. Maybe call it "net". I am sure there will be more net-related code to be clustered on that module in the future. - Rename the method to "get_hostfwd_port()" because the parameter's name already implies it is expected an "info usernet" output. - Drop the InfoUsernet Test. It is too simple, and the same functionality is tested indirectly by other tests. > > diff --git a/python/qemu/utils.py b/python/qemu/utils.py > new file mode 100644 > index 0000000000..89a246ab30 > --- /dev/null > +++ b/python/qemu/utils.py > @@ -0,0 +1,35 @@ > +""" > +QEMU utility library > + > +This offers miscellaneous utility functions, which may not be easily > +distinguishable or numerous to be in their own module. > +""" > + > +# Copyright (C) 2021 Red Hat Inc. > +# > +# Authors: > +# Cleber Rosa > +# > +# This work is licensed under the terms of the GNU GPL, version 2. See > +# the COPYING file in the top-level directory. > +# > + > +import re > +from typing import Optional > + > + > +def get_info_usernet_hostfwd_port(info_usernet_output: str) -> Optional[int]: > + """ > + Returns the port given to the hostfwd parameter via info usernet > + > + :param info_usernet_output: output generated by hmp command "info usernet" > + :param info_usernet_output: str > + :return: the port number allocated by the hostfwd option > + :rtype: int > + """ > + for line in info_usernet_output.split('\r\n'): > + regex = r'TCP.HOST_FORWARD.*127\.0\.0\.1\s+(\d+)\s+10\.' > + match = re.search(regex, line) > + if match is not None: > + return int(match[1]) > + return None > diff --git a/tests/acceptance/info_usernet.py b/tests/acceptance/info_usernet.py > new file mode 100644 > index 0000000000..9c1fd903a0 > --- /dev/null > +++ b/tests/acceptance/info_usernet.py > @@ -0,0 +1,29 @@ > +# Test for the hmp command "info usernet" > +# > +# Copyright (c) 2021 Red Hat, Inc. > +# > +# Author: > +# Cleber Rosa > +# > +# This work is licensed under the terms of the GNU GPL, version 2 or > +# later. See the COPYING file in the top-level directory. > + > +from avocado_qemu import Test > + > +from qemu.utils import get_info_usernet_hostfwd_port > + > + > +class InfoUsernet(Test): > + > + def test_hostfwd(self): > + self.vm.add_args('-netdev', 'user,id=vnet,hostfwd=:127.0.0.1:0-:22') > + self.vm.launch() > + res = self.vm.command('human-monitor-command', > + command_line='info usernet') > + port = get_info_usernet_hostfwd_port(res) > + self.assertIsNotNone(port, > + ('"info usernet" output content does not seem to ' > + 'contain the redirected port')) > + self.assertGreater(port, 0, > + ('Found a redirected port that is not greater than' > + ' zero')) > diff --git a/tests/acceptance/linux_ssh_mips_malta.py b/tests/acceptance/linux_ssh_mips_malta.py > index 25c5c5f741..275659c785 100644 > --- a/tests/acceptance/linux_ssh_mips_malta.py > +++ b/tests/acceptance/linux_ssh_mips_malta.py > @@ -18,6 +18,8 @@ from avocado.utils import process > from avocado.utils import archive > from avocado.utils import ssh > > +from qemu.utils import get_info_usernet_hostfwd_port > + > > class LinuxSSH(Test): > > @@ -70,18 +72,14 @@ class LinuxSSH(Test): > def setUp(self): > super(LinuxSSH, self).setUp() > > - def get_portfwd(self): > + def ssh_connect(self, username, password): > + self.ssh_logger = logging.getLogger('ssh') > res = self.vm.command('human-monitor-command', > command_line='info usernet') > - line = res.split('\r\n')[2] > - port = re.split(r'.*TCP.HOST_FORWARD.*127\.0\.0\.1 (\d+)\s+10\..*', > - line)[1] > + port = get_info_usernet_hostfwd_port(res) > + if not port: > + self.cancel("Failed to retrieve SSH port") Here I think it should assert not none, otherwise there is a bug somewhere. - Wainer > self.log.debug("sshd listening on port:" + port) > - return port > - > - def ssh_connect(self, username, password): > - self.ssh_logger = logging.getLogger('ssh') > - port = self.get_portfwd() > self.ssh_session = ssh.Session(self.VM_IP, port=int(port), > user=username, password=password) > for i in range(10): > diff --git a/tests/acceptance/virtiofs_submounts.py b/tests/acceptance/virtiofs_submounts.py > index 0f9d7a5d9c..bf99164fcb 100644 > --- a/tests/acceptance/virtiofs_submounts.py > +++ b/tests/acceptance/virtiofs_submounts.py > @@ -10,6 +10,7 @@ from avocado_qemu import wait_for_console_pattern > from avocado.utils import ssh > > from qemu.accel import kvm_available > +from qemu.utils import get_info_usernet_hostfwd_port > > from boot_linux import BootLinux > > @@ -76,27 +77,14 @@ class VirtiofsSubmountsTest(BootLinux): > :avocado: tags=arch:x86_64 > """ > > - def get_portfwd(self): > - port = None > - > + def ssh_connect(self, username, keyfile): > + self.ssh_logger = logging.getLogger('ssh') > res = self.vm.command('human-monitor-command', > command_line='info usernet') > - for line in res.split('\r\n'): > - match = \ > - re.search(r'TCP.HOST_FORWARD.*127\.0\.0\.1\s+(\d+)\s+10\.', > - line) > - if match is not None: > - port = int(match[1]) > - break > - > + port = get_info_usernet_hostfwd_port(res) > self.assertIsNotNone(port) > self.assertGreater(port, 0) > self.log.debug('sshd listening on port: %d', port) > - return port > - > - def ssh_connect(self, username, keyfile): > - self.ssh_logger = logging.getLogger('ssh') > - port = self.get_portfwd() > self.ssh_session = ssh.Session('127.0.0.1', port=port, > user=username, key=keyfile) > for i in range(10): > diff --git a/tests/vm/basevm.py b/tests/vm/basevm.py > index 00f1d5ca8d..75ce07df36 100644 > --- a/tests/vm/basevm.py > +++ b/tests/vm/basevm.py > @@ -21,6 +21,7 @@ import datetime > sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python')) > from qemu.accel import kvm_available > from qemu.machine import QEMUMachine > +from qemu.utils import get_info_usernet_hostfwd_port > import subprocess > import hashlib > import argparse > @@ -306,11 +307,7 @@ class BaseVM(object): > self.console_init() > usernet_info = guest.qmp("human-monitor-command", > command_line="info usernet") > - self.ssh_port = None > - for l in usernet_info["return"].splitlines(): > - fields = l.split() > - if "TCP[HOST_FORWARD]" in fields and "22" in fields: > - self.ssh_port = l.split()[3] > + self.ssh_port = get_info_usernet_hostfwd_port(usernet_info) > if not self.ssh_port: > raise Exception("Cannot find ssh port from 'info usernet':\n%s" % \ > usernet_info)