From nobody Sun Jul 13 20:52:08 2025 Delivered-To: importer2@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer2=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1622590431; cv=none; d=zohomail.com; s=zohoarc; b=ejxppUNtKe/JfmMbmfP3/jdVQclAp3UOC0xkCBOAVfAFEGu3Dr5+WlNygjjE+djEqNI0sURTYt2/MSQ5TGk4hhbDiX54L+OwVlSssf5q+owTvT37PULMpoRLkF3d2Sfn9HAKppuOeWtkVlRjU1PSNsyjACEtTXSkvEdMd+h6CKw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1622590431; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=5ZQjTXAycv1OItPIJPVgRnKEeZ3GhjVPe/G5mq6F7tk=; b=MfsxgG4FERaJj9yc9mjEdMFLYLPhEb70b+OaCp7QUGVsv5INDM0Q0fHW5BC1KMl73wwoCLOi7OpjL4Y6CBVXNTokoXuwpa1a+9GlI1i1Q9Q8SrZt+lZX8I8Z7HNRT5MJA7FMhzVvDvqItfUnuTEw/YfQgfSANd5bVn+Rz6Lx2fs= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer2=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1622590431710578.0823328969057; Tue, 1 Jun 2021 16:33:51 -0700 (PDT) Received: from localhost ([::1]:55668 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1loDtO-0003Ho-Kv for importer2@patchew.org; Tue, 01 Jun 2021 19:33:50 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:55948) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1loDrY-0001bi-Us for qemu-devel@nongnu.org; Tue, 01 Jun 2021 19:31:56 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:32969) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1loDrW-0005na-Nj for qemu-devel@nongnu.org; Tue, 01 Jun 2021 19:31:56 -0400 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-601-OSADVlg1NjyNIgtDFAgDQQ-1; Tue, 01 Jun 2021 19:31:51 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 64E49802690; Tue, 1 Jun 2021 23:31:50 +0000 (UTC) Received: from scv.redhat.com (ovpn-116-137.rdu2.redhat.com [10.10.116.137]) by smtp.corp.redhat.com (Postfix) with ESMTP id 06D602BFED; Tue, 1 Jun 2021 23:31:41 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1622590313; 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=5ZQjTXAycv1OItPIJPVgRnKEeZ3GhjVPe/G5mq6F7tk=; b=ZvDmXMhsI8CMQFJTPV3Oyhg2v+ik4LQtWy38MT3uKqeU3/KE802s45hap2JS/yp2LP0A+d jEPwq3qBva+UtIyIr1Ls9g8y6A2u9Ho8ECqG+4iXekKHGk3CQhVdvq2qWgGRHYbI0S5+Hz /EU/PbASNplkd5pNblvEKzCjrCl7KEk= X-MC-Unique: OSADVlg1NjyNIgtDFAgDQQ-1 From: John Snow To: qemu-devel@nongnu.org Subject: [PULL v2 04/44] Python: add utility function for retrieving port redirection Date: Tue, 1 Jun 2021 19:31:18 -0400 Message-Id: <20210601233118.1103509-2-jsnow@redhat.com> In-Reply-To: <20210601233118.1103509-1-jsnow@redhat.com> References: <20210601233118.1103509-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=jsnow@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer2=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=216.205.24.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -31 X-Spam_score: -3.2 X-Spam_bar: --- X-Spam_report: (-3.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.371, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=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=unavailable 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: Kevin Wolf , Peter Maydell , Thomas Huth , Eduardo Habkost , qemu-block@nongnu.org, =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Wainer dos Santos Moschetta , Max Reitz , Willian Rampazzo , Eric Auger , John Snow , Cleber Rosa , =?UTF-8?q?Alex=20Benn=C3=A9e?= , Aurelien Jarno Errors-To: qemu-devel-bounces+importer2=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" From: Cleber Rosa 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.utils" module to host the utility function and a test. Signed-off-by: Cleber Rosa Reviewed-by: Wainer dos Santos Moschetta Reviewed-by: Eric Auger Reviewed-by: Willian Rampazzo Message-Id: <20210412044644.55083-4-crosa@redhat.com> Signed-off-by: John Snow [Squashed in below fix. --js] Signed-off-by: John Snow Signed-off-by: Cleber Rosa Message-Id: <20210601154546.130870-2-crosa@redhat.com> Signed-off-by: John Snow --- python/qemu/utils.py | 33 ++++++++++++++++++++++++ tests/acceptance/info_usernet.py | 29 +++++++++++++++++++++ tests/acceptance/linux_ssh_mips_malta.py | 16 +++++------- tests/acceptance/virtiofs_submounts.py | 21 ++++----------- tests/vm/basevm.py | 11 +++----- 5 files changed, 78 insertions(+), 32 deletions(-) create mode 100644 python/qemu/utils.py create mode 100644 tests/acceptance/info_usernet.py diff --git a/python/qemu/utils.py b/python/qemu/utils.py new file mode 100644 index 00000000000..5ed789275ee --- /dev/null +++ b/python/qemu/utils.py @@ -0,0 +1,33 @@ +""" +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[in= t]: + """ + Returns the port given to the hostfwd parameter via info usernet + + :param info_usernet_output: output generated by hmp command "info user= net" + :return: the port number allocated by the hostfwd option + """ + for line in info_usernet_output.split('\r\n'): + regex =3D r'TCP.HOST_FORWARD.*127\.0\.0\.1\s+(\d+)\s+10\.' + match =3D 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_usern= et.py new file mode 100644 index 00000000000..9c1fd903a0b --- /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=3Dvnet,hostfwd=3D:127.0.0.1:0= -:22') + self.vm.launch() + res =3D self.vm.command('human-monitor-command', + command_line=3D'info usernet') + port =3D 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 t= han' + ' zero')) diff --git a/tests/acceptance/linux_ssh_mips_malta.py b/tests/acceptance/li= nux_ssh_mips_malta.py index 6dbd02d49d5..052008f02d4 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 archive from avocado.utils import ssh =20 +from qemu.utils import get_info_usernet_hostfwd_port + =20 class LinuxSSH(Test): =20 @@ -70,18 +72,14 @@ def get_kernel_info(self, endianess, wordsize): def setUp(self): super(LinuxSSH, self).setUp() =20 - def get_portfwd(self): + def ssh_connect(self, username, password): + self.ssh_logger =3D logging.getLogger('ssh') res =3D self.vm.command('human-monitor-command', command_line=3D'info usernet') - line =3D res.split('\r\n')[2] - port =3D re.split(r'.*TCP.HOST_FORWARD.*127\.0\.0\.1 (\d+)\s+10\..= *', - line)[1] + port =3D get_info_usernet_hostfwd_port(res) + if not port: + self.cancel("Failed to retrieve SSH port") self.log.debug("sshd listening on port:" + port) - return port - - def ssh_connect(self, username, password): - self.ssh_logger =3D logging.getLogger('ssh') - port =3D self.get_portfwd() self.ssh_session =3D ssh.Session(self.VM_IP, port=3Dint(port), user=3Dusername, password=3Dpasswor= d) for i in range(10): diff --git a/tests/acceptance/virtiofs_submounts.py b/tests/acceptance/virt= iofs_submounts.py index ca64b76301f..57a7047342f 100644 --- a/tests/acceptance/virtiofs_submounts.py +++ b/tests/acceptance/virtiofs_submounts.py @@ -9,6 +9,8 @@ from avocado_qemu import wait_for_console_pattern from avocado.utils import ssh =20 +from qemu.utils import get_info_usernet_hostfwd_port + =20 def run_cmd(args): subp =3D subprocess.Popen(args, @@ -73,27 +75,14 @@ class VirtiofsSubmountsTest(LinuxTest): :avocado: tags=3Daccel:kvm """ =20 - def get_portfwd(self): - port =3D None - + def ssh_connect(self, username, keyfile): + self.ssh_logger =3D logging.getLogger('ssh') res =3D self.vm.command('human-monitor-command', command_line=3D'info usernet') - for line in res.split('\r\n'): - match =3D \ - re.search(r'TCP.HOST_FORWARD.*127\.0\.0\.1\s+(\d+)\s+10\.', - line) - if match is not None: - port =3D int(match[1]) - break - + port =3D 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 =3D logging.getLogger('ssh') - port =3D self.get_portfwd() self.ssh_session =3D ssh.Session('127.0.0.1', port=3Dport, user=3Dusername, key=3Dkeyfile) for i in range(10): diff --git a/tests/vm/basevm.py b/tests/vm/basevm.py index 00f1d5ca8da..995e642465b 100644 --- a/tests/vm/basevm.py +++ b/tests/vm/basevm.py @@ -21,6 +21,7 @@ sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'pytho= n')) 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 @@ -227,7 +228,7 @@ def _ssh_do(self, user, cmd, check): "-o", "UserKnownHostsFile=3D" + os.devnull, "-o", "ConnectTimeout=3D{}".format(self._config["ssh_timeout"= ]), - "-p", self.ssh_port, "-i", self._ssh_tmp_key_file] + "-p", str(self.ssh_port), "-i", self._ssh_tmp_key_file] # If not in debug mode, set ssh to quiet mode to # avoid printing the results of commands. if not self.debug: @@ -305,12 +306,8 @@ def boot(self, img, extra_args=3D[]): # Init console so we can start consuming the chars. self.console_init() usernet_info =3D guest.qmp("human-monitor-command", - command_line=3D"info usernet") - self.ssh_port =3D None - for l in usernet_info["return"].splitlines(): - fields =3D l.split() - if "TCP[HOST_FORWARD]" in fields and "22" in fields: - self.ssh_port =3D l.split()[3] + command_line=3D"info usernet").get("retur= n") + self.ssh_port =3D 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) --=20 2.31.1