From nobody Sat May 4 18:41:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1503560812601330.3069829242361; Thu, 24 Aug 2017 00:46:52 -0700 (PDT) Received: from localhost ([::1]:47087 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dkmqo-0005cQ-V3 for importer@patchew.org; Thu, 24 Aug 2017 03:46:51 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:53689) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dkmop-0003pw-9O for qemu-devel@nongnu.org; Thu, 24 Aug 2017 03:44:48 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dkmok-0007I1-DP for qemu-devel@nongnu.org; Thu, 24 Aug 2017 03:44:47 -0400 Received: from mx1.redhat.com ([209.132.183.28]:40092) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dkmok-0007Ho-6g for qemu-devel@nongnu.org; Thu, 24 Aug 2017 03:44:42 -0400 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 mx1.redhat.com (Postfix) with ESMTPS id 30A4FC047B64 for ; Thu, 24 Aug 2017 07:44:41 +0000 (UTC) Received: from localhost (ovpn-117-92.ams2.redhat.com [10.36.117.92]) by smtp.corp.redhat.com (Postfix) with ESMTP id 4ED328024F; Thu, 24 Aug 2017 07:44:38 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com 30A4FC047B64 Authentication-Results: ext-mx07.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx07.extmail.prod.ext.phx2.redhat.com; spf=fail smtp.mailfrom=stefanha@redhat.com From: Stefan Hajnoczi To: Date: Thu, 24 Aug 2017 08:22:00 +0100 Message-Id: <20170824072202.26818-2-stefanha@redhat.com> In-Reply-To: <20170824072202.26818-1-stefanha@redhat.com> References: <20170824072202.26818-1-stefanha@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.31]); Thu, 24 Aug 2017 07:44:41 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH 1/3] qemu.py: make VM() a context manager X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Kevin Wolf , Eduardo Habkost , Stefan Hajnoczi Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" There are a number of ways to ensure that the QEMU process is shut down when the test ends, including atexit.register(), try: finally:, or unittest.teardown() methods. All of these require extra code and the programmer must remember to add vm.shutdown(). A nice solution is context managers: with VM(binary) as vm: ... # vm is guaranteed to be shut down here Cc: Eduardo Habkost Signed-off-by: Stefan Hajnoczi Reviewed-by: Eduardo Habkost --- scripts/qemu.py | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/scripts/qemu.py b/scripts/qemu.py index 880e3e8219..4d8ee10943 100644 --- a/scripts/qemu.py +++ b/scripts/qemu.py @@ -21,7 +21,14 @@ import qmp.qmp =20 =20 class QEMUMachine(object): - '''A QEMU VM''' + '''A QEMU VM + + Use this object as a context manager to ensure the QEMU process termin= ates:: + + with VM(binary) as vm: + ... + # vm is guaranteed to be shut down here + ''' =20 def __init__(self, binary, args=3D[], wrapper=3D[], name=3DNone, test_= dir=3D"/var/tmp", monitor_address=3DNone, socket_scm_helper=3DNone, debug= =3DFalse): @@ -40,6 +47,13 @@ class QEMUMachine(object): self._socket_scm_helper =3D socket_scm_helper self._debug =3D debug =20 + def __enter__(self): + return self + + def __exit__(self, exc_type, exc_val, exc_tb): + self.shutdown() + return False + # This can be used to add an unused monitor instance. def add_monitor_telnet(self, ip, port): args =3D 'tcp:%s:%d,server,nowait,telnet' % (ip, port) --=20 2.13.5 From nobody Sat May 4 18:41:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1503560808284438.16172996627154; Thu, 24 Aug 2017 00:46:48 -0700 (PDT) Received: from localhost ([::1]:47086 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dkmqk-0005aY-QU for importer@patchew.org; Thu, 24 Aug 2017 03:46:46 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:53712) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dkmoq-0003vl-R7 for qemu-devel@nongnu.org; Thu, 24 Aug 2017 03:44:49 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dkmoq-0007K1-0B for qemu-devel@nongnu.org; Thu, 24 Aug 2017 03:44:48 -0400 Received: from mx1.redhat.com ([209.132.183.28]:45082) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dkmop-0007Ja-Q6 for qemu-devel@nongnu.org; Thu, 24 Aug 2017 03:44:47 -0400 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 mx1.redhat.com (Postfix) with ESMTPS id B366585546 for ; Thu, 24 Aug 2017 07:44:46 +0000 (UTC) Received: from localhost (ovpn-117-92.ams2.redhat.com [10.36.117.92]) by smtp.corp.redhat.com (Postfix) with ESMTP id 457F38024F; Thu, 24 Aug 2017 07:44:46 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com B366585546 Authentication-Results: ext-mx04.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx04.extmail.prod.ext.phx2.redhat.com; spf=fail smtp.mailfrom=stefanha@redhat.com From: Stefan Hajnoczi To: Date: Thu, 24 Aug 2017 08:22:01 +0100 Message-Id: <20170824072202.26818-3-stefanha@redhat.com> In-Reply-To: <20170824072202.26818-1-stefanha@redhat.com> References: <20170824072202.26818-1-stefanha@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.28]); Thu, 24 Aug 2017 07:44:46 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH 2/3] iotests.py: add FilePath context manager X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Kevin Wolf , Stefan Hajnoczi Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" The scratch/ (TEST_DIR) directory is not automatically cleaned up after test execution. It is the responsibility of tests to remove any files they create. A nice way of doing this is to declare files at the beginning of the test and automatically remove them with a context manager: with iotests.FilePath('test.img') as img_path: qemu_img(...) qemu_io(...) # img_path is guaranteed to be deleted here Signed-off-by: Stefan Hajnoczi --- tests/qemu-iotests/iotests.py | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py index 7233983f3c..07fa1626a0 100644 --- a/tests/qemu-iotests/iotests.py +++ b/tests/qemu-iotests/iotests.py @@ -160,6 +160,32 @@ class Timeout: def timeout(self, signum, frame): raise Exception(self.errmsg) =20 + +class FilePath(object): + '''An auto-generated filename that cleans itself up. + + Use this context manager to generate filenames and ensure that the file + gets deleted:: + + with TestFilePath('test.img') as img_path: + qemu_img('create', img_path, '1G') + # migration_sock_path is automatically deleted + ''' + def __init__(self, name): + filename =3D '{0}-{1}'.format(os.getpid(), name) + self.path =3D os.path.join(test_dir, filename) + + def __enter__(self): + return self.path + + def __exit__(self, exc_type, exc_val, exc_tb): + try: + os.remove(self.path) + except OSError: + pass + return False + + class VM(qtest.QEMUQtestMachine): '''A QEMU VM''' =20 --=20 2.13.5 From nobody Sat May 4 18:41:09 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1503560815273955.3961102233354; Thu, 24 Aug 2017 00:46:55 -0700 (PDT) Received: from localhost ([::1]:47088 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dkmqs-0005ea-3k for importer@patchew.org; Thu, 24 Aug 2017 03:46:54 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:53745) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dkmot-00041n-AR for qemu-devel@nongnu.org; Thu, 24 Aug 2017 03:44:52 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dkmos-0007Kv-97 for qemu-devel@nongnu.org; Thu, 24 Aug 2017 03:44:51 -0400 Received: from mx1.redhat.com ([209.132.183.28]:39274) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dkmos-0007KZ-0l for qemu-devel@nongnu.org; Thu, 24 Aug 2017 03:44:50 -0400 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 mx1.redhat.com (Postfix) with ESMTPS id F1977883B6 for ; Thu, 24 Aug 2017 07:44:48 +0000 (UTC) Received: from localhost (ovpn-117-92.ams2.redhat.com [10.36.117.92]) by smtp.corp.redhat.com (Postfix) with ESMTP id 1ECE680337; Thu, 24 Aug 2017 07:44:47 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com F1977883B6 Authentication-Results: ext-mx02.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx02.extmail.prod.ext.phx2.redhat.com; spf=fail smtp.mailfrom=stefanha@redhat.com From: Stefan Hajnoczi To: Date: Thu, 24 Aug 2017 08:22:02 +0100 Message-Id: <20170824072202.26818-4-stefanha@redhat.com> In-Reply-To: <20170824072202.26818-1-stefanha@redhat.com> References: <20170824072202.26818-1-stefanha@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.26]); Thu, 24 Aug 2017 07:44:49 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH 3/3] qemu-iotests: use context managers for resource cleanup in 194 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Kevin Wolf , Stefan Hajnoczi Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Switch from atexit.register() to a more elegant idiom of declaring resources in a with statement: with FilePath('monitor.sock') as monitor_path, VM() as vm: ... The files and VMs will be automatically cleaned up whether the test passes or fails. Signed-off-by: Stefan Hajnoczi --- tests/qemu-iotests/194 | 83 +++++++++++++++++++++++++---------------------= ---- 1 file changed, 41 insertions(+), 42 deletions(-) diff --git a/tests/qemu-iotests/194 b/tests/qemu-iotests/194 index 8028111e21..06aea661d4 100755 --- a/tests/qemu-iotests/194 +++ b/tests/qemu-iotests/194 @@ -19,55 +19,54 @@ # # Non-shared storage migration test using NBD server and drive-mirror =20 -import os -import atexit import iotests =20 iotests.verify_platform(['linux']) =20 -img_size =3D '1G' -source_img_path =3D os.path.join(iotests.test_dir, 'source.img') -dest_img_path =3D os.path.join(iotests.test_dir, 'dest.img') -iotests.qemu_img_pipe('create', '-f', iotests.imgfmt, source_img_path, img= _size) -iotests.qemu_img_pipe('create', '-f', iotests.imgfmt, dest_img_path, img_s= ize) +with iotests.FilePath('source.img') as source_img_path, \ + iotests.FilePath('dest.img') as dest_img_path, \ + iotests.FilePath('migration.sock') as migration_sock_path, \ + iotests.FilePath('nbd.sock') as nbd_sock_path, \ + iotests.VM('source') as source_vm, \ + iotests.VM('dest') as dest_vm: =20 -iotests.log('Launching VMs...') -migration_sock_path =3D os.path.join(iotests.test_dir, 'migration.sock') -nbd_sock_path =3D os.path.join(iotests.test_dir, 'nbd.sock') -source_vm =3D iotests.VM('source').add_drive(source_img_path) -dest_vm =3D (iotests.VM('dest').add_drive(dest_img_path) - .add_incoming('unix:{0}'.format(migration_soc= k_path))) -source_vm.launch() -atexit.register(source_vm.shutdown) -dest_vm.launch() -atexit.register(dest_vm.shutdown) + img_size =3D '1G' + iotests.qemu_img_pipe('create', '-f', iotests.imgfmt, source_img_path,= img_size) + iotests.qemu_img_pipe('create', '-f', iotests.imgfmt, dest_img_path, i= mg_size) =20 -iotests.log('Launching NBD server on destination...') -iotests.log(dest_vm.qmp('nbd-server-start', addr=3D{'type': 'unix', 'data'= : {'path': nbd_sock_path}})) -iotests.log(dest_vm.qmp('nbd-server-add', device=3D'drive0', writable=3DTr= ue)) + iotests.log('Launching VMs...') + (source_vm.add_drive(source_img_path) + .launch()) + (dest_vm.add_drive(dest_img_path) + .add_incoming('unix:{0}'.format(migration_sock_path)) + .launch()) =20 -iotests.log('Starting drive-mirror on source...') -iotests.log(source_vm.qmp( - 'drive-mirror', - device=3D'drive0', - target=3D'nbd+unix:///drive0?socket=3D{0}'.format(nbd_sock_p= ath), - sync=3D'full', - format=3D'raw', # always raw, the server handles the format - mode=3D'existing')) + iotests.log('Launching NBD server on destination...') + iotests.log(dest_vm.qmp('nbd-server-start', addr=3D{'type': 'unix', 'd= ata': {'path': nbd_sock_path}})) + iotests.log(dest_vm.qmp('nbd-server-add', device=3D'drive0', writable= =3DTrue)) =20 -iotests.log('Waiting for drive-mirror to complete...') -iotests.log(source_vm.event_wait('BLOCK_JOB_READY'), - filters=3D[iotests.filter_qmp_event]) + iotests.log('Starting drive-mirror on source...') + iotests.log(source_vm.qmp( + 'drive-mirror', + device=3D'drive0', + target=3D'nbd+unix:///drive0?socket=3D{0}'.format(nbd_so= ck_path), + sync=3D'full', + format=3D'raw', # always raw, the server handles the for= mat + mode=3D'existing')) =20 -iotests.log('Starting migration...') -source_vm.qmp('migrate-set-capabilities', - capabilities=3D[{'capability': 'events', 'state': True}]) -dest_vm.qmp('migrate-set-capabilities', - capabilities=3D[{'capability': 'events', 'state': True}]) -iotests.log(source_vm.qmp('migrate', uri=3D'unix:{0}'.format(migration_soc= k_path))) + iotests.log('Waiting for drive-mirror to complete...') + iotests.log(source_vm.event_wait('BLOCK_JOB_READY'), + filters=3D[iotests.filter_qmp_event]) =20 -while True: - event =3D source_vm.event_wait('MIGRATION') - iotests.log(event, filters=3D[iotests.filter_qmp_event]) - if event['data']['status'] in ('completed', 'failed'): - break + iotests.log('Starting migration...') + source_vm.qmp('migrate-set-capabilities', + capabilities=3D[{'capability': 'events', 'state': True}]) + dest_vm.qmp('migrate-set-capabilities', + capabilities=3D[{'capability': 'events', 'state': True}]) + iotests.log(source_vm.qmp('migrate', uri=3D'unix:{0}'.format(migration= _sock_path))) + + while True: + event =3D source_vm.event_wait('MIGRATION') + iotests.log(event, filters=3D[iotests.filter_qmp_event]) + if event['data']['status'] in ('completed', 'failed'): + break --=20 2.13.5