From nobody Sun May 5 09:22:08 2024 Delivered-To: importer@patchew.org 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+importer=patchew.org@nongnu.org; helo=lists.gnu.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+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1584419770; cv=none; d=zohomail.com; s=zohoarc; b=IjwFQhepK5HnltjtXbEMCAzGQAwlNW0nJu8QZjIB71nRSp8ateB5mp7pQJOlU/OovZULn2Fy2iKkRfNPlSPOcMG1vvL3971MgDFArUWft5oXmCg2186ok/ILCsZ/F7OdmuHMd/y3ORsR5AX5dMmJUjls5S6AosC3Zi4FUzkPJ+Y= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1584419770; 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=W4nQG6lLHWsGZ1BSm01dCR2W4JXXj904nPobUtOWXgM=; b=PwNtsr72IMYJgAgcdqkScmq6qLhDFKfs1TUbxavPHFQ4usAd2ZlhZwn8DugVg2Z0WiZCHtYeTwnIBdUseq0MJ/xyPAwycRjdx5XNBue1KzPa9WWnM4CtTAlex6Rv/k6yJ86wfT45pXc7CPXbxLneosh7025grJ498tTbw149UHw= 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+importer=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 1584419770465772.6088781220164; Mon, 16 Mar 2020 21:36:10 -0700 (PDT) Received: from localhost ([::1]:52452 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jE3xZ-0005v1-Ad for importer@patchew.org; Tue, 17 Mar 2020 00:36:09 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49234) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jE3wG-0004Ap-Cu for qemu-devel@nongnu.org; Tue, 17 Mar 2020 00:34:49 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1jE3wF-0007XH-0N for qemu-devel@nongnu.org; Tue, 17 Mar 2020 00:34:48 -0400 Received: from us-smtp-delivery-74.mimecast.com ([216.205.24.74]:30989) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1jE3wE-0007TR-Sp for qemu-devel@nongnu.org; Tue, 17 Mar 2020 00:34:46 -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-395-GYH0UQTFNPWUmm1EUoP0lA-1; Tue, 17 Mar 2020 00:34:40 -0400 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id D5DEF800D4E; Tue, 17 Mar 2020 04:34:39 +0000 (UTC) Received: from probe.redhat.com (ovpn-112-191.rdu2.redhat.com [10.10.112.191]) by smtp.corp.redhat.com (Postfix) with ESMTP id 08FB55C1B2; Tue, 17 Mar 2020 04:34:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1584419686; 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=W4nQG6lLHWsGZ1BSm01dCR2W4JXXj904nPobUtOWXgM=; b=WOCq50aWhasoj+DNB6luBYUQtUDTGuwYT+X4m33T4b/rKcPkZAQ4LcWpkft9D8DBgD/Z4U /0Y6psU5ti6abTGVBPKu87ZXtVxjYaL16GLkFmidpqBVf7rvNe+5qwhgmUoGTODQqdyl0X xA0NucKps7d3TAScePhmsxLsQ12D34Y= X-MC-Unique: GYH0UQTFNPWUmm1EUoP0lA-1 From: John Snow To: qemu-devel@nongnu.org Subject: [PATCH v3 1/3] qmp.py: change event_wait to use a dict Date: Tue, 17 Mar 2020 00:34:35 -0400 Message-Id: <20200317043437.19464-2-jsnow@redhat.com> In-Reply-To: <20200317043437.19464-1-jsnow@redhat.com> References: <20200317043437.19464-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 216.205.24.74 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 , Eduardo Habkost , qemu-block@nongnu.org, Max Reitz , Cleber Rosa , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" It's easier to work with than a list of tuples, because we can check the keys for membership. Signed-off-by: John Snow --- python/qemu/machine.py | 10 +++++----- tests/qemu-iotests/040 | 12 ++++++------ tests/qemu-iotests/260 | 5 +++-- tests/qemu-iotests/iotests.py | 16 ++++++++-------- 4 files changed, 22 insertions(+), 21 deletions(-) diff --git a/python/qemu/machine.py b/python/qemu/machine.py index 183d8f3d38..748de5f322 100644 --- a/python/qemu/machine.py +++ b/python/qemu/machine.py @@ -476,21 +476,21 @@ def event_wait(self, name, timeout=3D60.0, match=3DNo= ne): timeout: QEMUMonitorProtocol.pull_event timeout parameter. match: Optional match criteria. See event_match for details. """ - return self.events_wait([(name, match)], timeout) + return self.events_wait({name: match}, timeout) =20 def events_wait(self, events, timeout=3D60.0): """ events_wait waits for and returns a named event from QMP with a ti= meout. =20 - events: a sequence of (name, match_criteria) tuples. + events: a mapping containing {name: match_criteria}. The match criteria are optional and may be None. See event_match for details. timeout: QEMUMonitorProtocol.pull_event timeout parameter. """ def _match(event): - for name, match in events: - if event['event'] =3D=3D name and self.event_match(event, = match): - return True + name =3D event['event'] + if name in events: + return self.event_match(event, events[name]) return False =20 # Search cached events diff --git a/tests/qemu-iotests/040 b/tests/qemu-iotests/040 index 32c82b4ec6..90b59081ff 100755 --- a/tests/qemu-iotests/040 +++ b/tests/qemu-iotests/040 @@ -485,12 +485,12 @@ class TestErrorHandling(iotests.QMPTestCase): =20 def run_job(self, expected_events, error_pauses_job=3DFalse): match_device =3D {'data': {'device': 'job0'}} - events =3D [ - ('BLOCK_JOB_COMPLETED', match_device), - ('BLOCK_JOB_CANCELLED', match_device), - ('BLOCK_JOB_ERROR', match_device), - ('BLOCK_JOB_READY', match_device), - ] + events =3D { + 'BLOCK_JOB_COMPLETED': match_device, + 'BLOCK_JOB_CANCELLED': match_device, + 'BLOCK_JOB_ERROR': match_device, + 'BLOCK_JOB_READY': match_device, + } =20 completed =3D False log =3D [] diff --git a/tests/qemu-iotests/260 b/tests/qemu-iotests/260 index 804a7addb9..729f031122 100755 --- a/tests/qemu-iotests/260 +++ b/tests/qemu-iotests/260 @@ -67,8 +67,9 @@ def test(persistent, restart): =20 vm.qmp_log('block-commit', device=3D'drive0', top=3Dtop, filters=3D[iotests.filter_qmp_testfiles]) - ev =3D vm.events_wait((('BLOCK_JOB_READY', None), - ('BLOCK_JOB_COMPLETED', None))) + ev =3D vm.events_wait({ + 'BLOCK_JOB_READY': None, + 'BLOCK_JOB_COMPLETED': None }) log(filter_qmp_event(ev)) if (ev['event'] =3D=3D 'BLOCK_JOB_COMPLETED'): vm.shutdown() diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py index 9304066471..bc96f1ce27 100644 --- a/tests/qemu-iotests/iotests.py +++ b/tests/qemu-iotests/iotests.py @@ -617,14 +617,14 @@ def run_job(self, job, auto_finalize=3DTrue, auto_dis= miss=3DFalse, """ match_device =3D {'data': {'device': job}} match_id =3D {'data': {'id': job}} - events =3D [ - ('BLOCK_JOB_COMPLETED', match_device), - ('BLOCK_JOB_CANCELLED', match_device), - ('BLOCK_JOB_ERROR', match_device), - ('BLOCK_JOB_READY', match_device), - ('BLOCK_JOB_PENDING', match_id), - ('JOB_STATUS_CHANGE', match_id) - ] + events =3D { + 'BLOCK_JOB_COMPLETED': match_device, + 'BLOCK_JOB_CANCELLED': match_device, + 'BLOCK_JOB_ERROR': match_device, + 'BLOCK_JOB_READY': match_device, + 'BLOCK_JOB_PENDING': match_id, + 'JOB_STATUS_CHANGE': match_id, + } error =3D None while True: ev =3D filter_qmp_event(self.events_wait(events, timeout=3Dwai= t)) --=20 2.21.1 From nobody Sun May 5 09:22:08 2024 Delivered-To: importer@patchew.org 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+importer=patchew.org@nongnu.org; helo=lists.gnu.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+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1584419851; cv=none; d=zohomail.com; s=zohoarc; b=bD2WoAuhiP9xI1bbTHq24pvBLupeeY7Vo+bPyFNFmIL5iZMiDma80HKb7eX5JezTJXqjsmH19QAaufWjbk1BBevW6wDO68792Ge2w9EhNblnJhqqCoo7dabmXc6FUFCOd2t57tjXcxDjxner+SXac3lxrsKpktZWHMhX+RrRO3s= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1584419851; 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=sbfdr7eJLcQnf7EPbN0Eb/Jd4sdivrpEDCSyNv06Rx0=; b=SqHmt09fl6iGbtgMH0eWYuFMaOi43TJASgO2tt0vw0nE+iIAdTO8zEAzaZBMMHzncBf1Kvf18rl0pCupbUUzZ6bwlb02xvIYC0KjsNQ3QRryFrY/Ab2KieFu3dVxXmlLOYtZL1hT3PNorGYXfh+8YgUzmPpOJlQ9BD+G9udPc/Q= 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+importer=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 1584419851305921.9005257714161; Mon, 16 Mar 2020 21:37:31 -0700 (PDT) Received: from localhost ([::1]:52474 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jE3ys-0007eo-0J for importer@patchew.org; Tue, 17 Mar 2020 00:37:30 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49213) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jE3wF-0004A7-6j for qemu-devel@nongnu.org; Tue, 17 Mar 2020 00:34:49 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1jE3wC-0007Jo-W1 for qemu-devel@nongnu.org; Tue, 17 Mar 2020 00:34:47 -0400 Received: from us-smtp-delivery-74.mimecast.com ([216.205.24.74]:32977) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1jE3wC-0007G1-KC for qemu-devel@nongnu.org; Tue, 17 Mar 2020 00:34:44 -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-267-RKQH52TMPCyK23yjLBMqMg-1; Tue, 17 Mar 2020 00:34:42 -0400 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id F388613F8; Tue, 17 Mar 2020 04:34:40 +0000 (UTC) Received: from probe.redhat.com (ovpn-112-191.rdu2.redhat.com [10.10.112.191]) by smtp.corp.redhat.com (Postfix) with ESMTP id 07BCF5C1B2; Tue, 17 Mar 2020 04:34:39 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1584419683; 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=sbfdr7eJLcQnf7EPbN0Eb/Jd4sdivrpEDCSyNv06Rx0=; b=JDbtmc1HA14ZahPYRZSTeh0NM5FwOn/+pw/PZOt52t7mpmS2Sy8r8TtlMvqFyMI2Ly976H q0remhpqHklbyRWXU5325/BCzsq2krElihYRAlBSOy9oNY43O/6OmQvRwCed6SGqzOWCND i4XFoZLI/mD3gBsoiLENuY9cewcezI4= X-MC-Unique: RKQH52TMPCyK23yjLBMqMg-1 From: John Snow To: qemu-devel@nongnu.org Subject: [PATCH v3 2/3] iotests: add JobRunner class Date: Tue, 17 Mar 2020 00:34:36 -0400 Message-Id: <20200317043437.19464-3-jsnow@redhat.com> In-Reply-To: <20200317043437.19464-1-jsnow@redhat.com> References: <20200317043437.19464-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 216.205.24.74 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 , Eduardo Habkost , qemu-block@nongnu.org, Max Reitz , Cleber Rosa , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" The idea is that instead of increasing the arguments to job_run all the time, create a more general-purpose job runner that can be subclassed to do interesting things with. pylint note: the 'callbacks' option guards against unused warning arguments in functions designated as callbacks. It does not currently guard against "no-self-use" though; hence a once-off ignore. mypy note: QapiEvent is only a weak alias; it's fully interchangable with the type it's declared as. In the future, we may wish to tighten these types. For now, this communicates the rough shape of the type and (more importantly) the intent. Signed-off-by: John Snow --- tests/qemu-iotests/155 | 15 ++- tests/qemu-iotests/255 | 9 +- tests/qemu-iotests/257 | 54 +++++---- tests/qemu-iotests/iotests.py | 201 +++++++++++++++++++++++++--------- tests/qemu-iotests/pylintrc | 11 ++ 5 files changed, 213 insertions(+), 77 deletions(-) diff --git a/tests/qemu-iotests/155 b/tests/qemu-iotests/155 index cb371d4649..e2a013e774 100755 --- a/tests/qemu-iotests/155 +++ b/tests/qemu-iotests/155 @@ -163,6 +163,16 @@ class BaseClass(iotests.QMPTestCase): self.assert_qmp_absent(node, 'image/backing-image') =20 =20 +class MirrorJob(iotests.JobRunner): + def __init__(self, *args, test, **kwargs): + super().__init__(*args, **kwargs) + self.test =3D test + + def on_pending(self, event): + self.test.openBacking() + super().on_pending(event) + + # Class variables for controlling its behavior: # # cmd: Mirroring command to execute, either drive-mirror or blockdev-mirror @@ -188,8 +198,9 @@ class MirrorBaseClass(BaseClass): =20 self.assert_qmp(result, 'return', {}) =20 - self.vm.run_job('mirror-job', auto_finalize=3DFalse, - pre_finalize=3Dself.openBacking, auto_dismiss=3DTr= ue) + job =3D MirrorJob(self.vm, 'mirror-job', test=3Dself, + auto_finalize=3DFalse, auto_dismiss=3DTrue) + job.run() =20 def testFull(self): self.runMirror('full') diff --git a/tests/qemu-iotests/255 b/tests/qemu-iotests/255 index 8f08f741da..e66cdfd672 100755 --- a/tests/qemu-iotests/255 +++ b/tests/qemu-iotests/255 @@ -71,8 +71,13 @@ with iotests.FilePath('t.qcow2') as disk_path, \ result =3D vm.qmp_log('block-commit', job_id=3D'job0', auto_finalize= =3DFalse, device=3D'overlay', top_node=3D'mid') =20 - vm.run_job('job0', auto_finalize=3DFalse, pre_finalize=3Dstart_request= s, - auto_dismiss=3DTrue) + class TestJobRunner(iotests.JobRunner): + def on_pending(self, event): + start_requests() + super().on_pending(event) + + runner =3D TestJobRunner(vm, 'job0', auto_finalize=3DFalse, auto_dismi= ss=3DTrue) + runner.run() =20 vm.shutdown() =20 diff --git a/tests/qemu-iotests/257 b/tests/qemu-iotests/257 index 004a433b8b..95341c330f 100755 --- a/tests/qemu-iotests/257 +++ b/tests/qemu-iotests/257 @@ -352,30 +352,40 @@ def test_bitmap_sync(bsync_mode, msync_mode=3D'bitmap= ', failure=3DNone): job =3D backup(drive0, 1, bsync1, msync_mode, bitmap=3D"bitmap0", bitmap_mode=3Dbsync_mode) =20 - def _callback(): - """Issue writes while the job is open to test bitmap divergenc= e.""" - # Note: when `failure` is 'intermediate', this isn't called. - log('') - bitmaps =3D perform_writes(drive0, 2, filter_node_name=3D'back= up-top') - # Named bitmap (static, should be unchanged) - ebitmap.compare(vm.get_bitmap(drive0.node, 'bitmap0', - bitmaps=3Dbitmaps)) - # Anonymous bitmap (dynamic, shows new writes) - anonymous =3D EmulatedBitmap() - anonymous.dirty_group(2) - anonymous.compare(vm.get_bitmap(drive0.node, '', recording=3DT= rue, - bitmaps=3Dbitmaps)) =20 - # Simulate the order in which this will happen: - # group 1 gets cleared first, then group two gets written. - if ((bsync_mode =3D=3D 'on-success' and not failure) or - (bsync_mode =3D=3D 'always')): - ebitmap.clear() - ebitmap.dirty_group(2) + class TestJobRunner(iotests.JobRunner): + def on_pending(self, event): + """ + Issue writes while the job is open to test bitmap divergen= ce. + """ + + # Note: when `failure` is 'intermediate', this isn't calle= d. + log('') + bitmaps =3D perform_writes(drive0, 2, + filter_node_name=3D'backup-top') + # Named bitmap (static, should be unchanged) + ebitmap.compare(vm.get_bitmap(drive0.node, 'bitmap0', + bitmaps=3Dbitmaps)) + # Anonymous bitmap (dynamic, shows new writes) + anonymous =3D EmulatedBitmap() + anonymous.dirty_group(2) + anonymous.compare(vm.get_bitmap(drive0.node, '', recording= =3DTrue, + bitmaps=3Dbitmaps)) + + # Simulate the order in which this will happen: + # group 1 gets cleared first, then group two gets written. + if ((bsync_mode =3D=3D 'on-success' and not failure) or + (bsync_mode =3D=3D 'always')): + ebitmap.clear() + ebitmap.dirty_group(2) + + super().on_pending(event) + + + runner =3D TestJobRunner(vm, job, cancel=3D(failure =3D=3D 'simula= ted'), + auto_finalize=3DFalse, auto_dismiss=3DTrue) + runner.run() =20 - vm.run_job(job, auto_dismiss=3DTrue, auto_finalize=3DFalse, - pre_finalize=3D_callback, - cancel=3D(failure =3D=3D 'simulated')) bitmaps =3D vm.query_bitmaps() log({'bitmaps': bitmaps}, indent=3D2) log('') diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py index bc96f1ce27..67c3de380a 100644 --- a/tests/qemu-iotests/iotests.py +++ b/tests/qemu-iotests/iotests.py @@ -29,7 +29,7 @@ import atexit import io from collections import OrderedDict -from typing import Collection +from typing import Any, Collection, Dict, Optional =20 # pylint: disable=3Dimport-error, wrong-import-position sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'pytho= n')) @@ -37,6 +37,9 @@ =20 assert sys.version_info >=3D (3, 6) =20 +# Type aliases +QapiEvent =3D Dict[str, Any] + # Use this logger for logging messages directly from the iotests module logger =3D logging.getLogger('qemu.iotests') logger.addHandler(logging.NullHandler()) @@ -476,6 +479,141 @@ def remote_filename(path): else: raise Exception("Protocol %s not supported" % (imgproto)) =20 + +class JobRunner: + """ + JobRunner offers a job-lifetime management framework. + + It can be used as-is for a no-frills run-to-completion module, + or subclassed to gain access to per-event callbacks for + customizable behavior. + + :param vm: The VM the job is running on + :param job: Job ID of a recently created job + :param cancel: When true, cancels the job prior to finalization. + :param auto_finalize: True if the job was configured to finalize itsel= f. + :param auto_dismiss: True if the job will dismiss itself post-finaliza= tion. + """ + def __init__(self, + vm: 'VM', + job: str, + cancel: bool =3D False, + auto_finalize: bool =3D True, + auto_dismiss: bool =3D False): + self._vm =3D vm + self._id =3D job + self.cancel =3D cancel + + self._auto_finalize =3D auto_finalize + self._auto_dismiss =3D auto_dismiss + self._exited =3D False + self._error: Optional[str] =3D None + + match_device =3D {'data': {'device': self._id}} + match_id =3D {'data': {'id': self._id}} + + # Listen for these events with these parameters: + self._events =3D { + 'BLOCK_JOB_COMPLETED': match_device, + 'BLOCK_JOB_CANCELLED': match_device, + 'BLOCK_JOB_ERROR': match_device, + 'BLOCK_JOB_READY': match_device, + 'BLOCK_JOB_PENDING': match_id, + 'JOB_STATUS_CHANGE': match_id + } + + self._dispatch =3D { + 'created': self.on_create, + 'running': self.on_run, + 'paused': self.on_pause, + 'ready': self.on_ready, + 'standby': self.on_standby, + 'waiting': self.on_waiting, + 'pending': self.on_pending, + 'aborting': self.on_abort, + 'concluded': self.on_conclude, + 'null': self.on_null, + } + + # These are Job state change callbacks. + # Subclass and override these for custom workflows. + + def on_create(self, event: QapiEvent) -> None: + pass + + def on_run(self, event: QapiEvent) -> None: + pass + + def on_pause(self, event: QapiEvent) -> None: + pass + + def on_ready(self, event: QapiEvent) -> None: + self._vm.qmp_log('job-complete', id=3Dself._id) + + def on_standby(self, event: QapiEvent) -> None: + pass + + def on_waiting(self, event: QapiEvent) -> None: + pass + + def on_pending(self, event: QapiEvent) -> None: + if self._auto_finalize: + return + + if self.cancel: + self._vm.qmp_log('job-cancel', id=3Dself._id) + else: + self._vm.qmp_log('job-finalize', id=3Dself._id) + + def on_abort(self, event: QapiEvent) -> None: + result =3D self._vm.qmp('query-jobs') + for j in result['return']: + if j['id'] =3D=3D self._id: + self._error =3D j['error'] + log('Job failed: %s' % (j['error'])) + + def on_conclude(self, event: QapiEvent) -> None: + if self._auto_dismiss: + return + + self._vm.qmp_log('job-dismiss', id=3Dself._id) + + def on_null(self, event: QapiEvent) -> None: + self._exited =3D True + + # Macro events -- QAPI events. + # These are callbacks for individual top-level events. + + def on_change(self, event: QapiEvent) -> None: + status =3D event['data']['status'] + assert status in self._dispatch + self._dispatch[status](event) + + def on_block_job_event(self, event: QapiEvent) -> None: + # pylint: disable=3Dno-self-use + log(event) + + def event(self, event: QapiEvent) -> None: + assert event['event'] in self._events.keys() + if event['event'] =3D=3D 'JOB_STATUS_CHANGE': + self.on_change(event) + else: + self.on_block_job_event(event) + + def run(self, wait: float =3D 60.0) -> Optional[str]: + """ + Run the event loop for this job. + + :param wait: Timeout in seconds specifying how long to wait + for an event. Defaults to 60.0. + :return: Error string on failure, Nothing on success. + """ + while not self._exited: + raw_event =3D self._vm.events_wait(self._events, timeout=3Dwai= t) + self.event(filter_qmp_event(raw_event)) + return self._error + + class VM(qtest.QEMUQtestMachine): '''A QEMU VM''' =20 @@ -597,60 +735,21 @@ def qmp_log(self, cmd, filters=3D(), indent=3DNone, *= *kwargs): log(result, filters, indent=3Dindent) return result =20 - # Returns None on success, and an error string on failure - def run_job(self, job, auto_finalize=3DTrue, auto_dismiss=3DFalse, - pre_finalize=3DNone, cancel=3DFalse, wait=3D60.0): + def run_job(self, job, **kwargs) -> Optional[str]: """ run_job moves a job from creation through to dismissal. =20 - :param job: String. ID of recently-launched job - :param auto_finalize: Bool. True if the job was launched with - auto_finalize. Defaults to True. - :param auto_dismiss: Bool. True if the job was launched with - auto_dismiss=3DTrue. Defaults to False. - :param pre_finalize: Callback. A callable that takes no arguments = to be - invoked prior to issuing job-finalize, if any. - :param cancel: Bool. When true, cancels the job after the pre_fina= lize - callback. - :param wait: Float. Timeout value specifying how long to wait for = any - event, in seconds. Defaults to 60.0. + :param job: Job ID of a recently created job. + :param kwargs: See JobRunner.__init__() and JobRunner.run(). + + :return: Error string on failure, Nothing on success. """ - match_device =3D {'data': {'device': job}} - match_id =3D {'data': {'id': job}} - events =3D { - 'BLOCK_JOB_COMPLETED': match_device, - 'BLOCK_JOB_CANCELLED': match_device, - 'BLOCK_JOB_ERROR': match_device, - 'BLOCK_JOB_READY': match_device, - 'BLOCK_JOB_PENDING': match_id, - 'JOB_STATUS_CHANGE': match_id, - } - error =3D None - while True: - ev =3D filter_qmp_event(self.events_wait(events, timeout=3Dwai= t)) - if ev['event'] !=3D 'JOB_STATUS_CHANGE': - log(ev) - continue - status =3D ev['data']['status'] - if status =3D=3D 'aborting': - result =3D self.qmp('query-jobs') - for j in result['return']: - if j['id'] =3D=3D job: - error =3D j['error'] - log('Job failed: %s' % (j['error'])) - elif status =3D=3D 'ready': - self.qmp_log('job-complete', id=3Djob) - elif status =3D=3D 'pending' and not auto_finalize: - if pre_finalize: - pre_finalize() - if cancel: - self.qmp_log('job-cancel', id=3Djob) - else: - self.qmp_log('job-finalize', id=3Djob) - elif status =3D=3D 'concluded' and not auto_dismiss: - self.qmp_log('job-dismiss', id=3Djob) - elif status =3D=3D 'null': - return error + if 'wait' in kwargs: + run_kwargs =3D {'wait': kwargs.pop('wait')} + else: + run_kwargs =3D {} + job_runner =3D JobRunner(self, job, **kwargs) + return job_runner.run(**run_kwargs) =20 # Returns None on success, and an error string on failure def blockdev_create(self, options, job_id=3D'job0', filters=3DNone): diff --git a/tests/qemu-iotests/pylintrc b/tests/qemu-iotests/pylintrc index 8d02f00607..6dae97d916 100644 --- a/tests/qemu-iotests/pylintrc +++ b/tests/qemu-iotests/pylintrc @@ -17,9 +17,20 @@ disable=3Dinvalid-name, too-many-locals, too-many-branches, too-many-public-methods, + too-many-instance-attributes, # These are temporary, and should be removed: missing-docstring, =20 + +[VARIABLES] + +# List of strings which can identify a callback function by name. A callba= ck +# name must start or end with one of those strings. +callbacks=3Dcb_, + _cb, + on_, + + [FORMAT] =20 # Maximum number of characters on a single line. --=20 2.21.1 From nobody Sun May 5 09:22:08 2024 Delivered-To: importer@patchew.org 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+importer=patchew.org@nongnu.org; helo=lists.gnu.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+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1584419851; cv=none; d=zohomail.com; s=zohoarc; b=JBevRi0Rd7OmNfpgcopD8+wCb5fD0zlIoFX6UqwCWqY8tOyz7A4nZbEyajBJSOpTM9EmjrAZQ8iQ5VlyiKwdloJjfJ36pBvajCp2/wza0CP+cp6s8+LvqynljxcHlRyBi70ugWuICcqNEQ4U/CZ50R8v6bKXOphh0QAZDH06DeI= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1584419851; 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=orgTszhfV3dEbp+pu5KH9GxYNoUHEki++yMiFhha/vk=; b=IbcjGnDm/UbYlyucZkcYx5sMZTXmZIiR1MpvCwnf0Q1LlyKhhHcHBkuiDluaL41arhd9medUB8q3p5/5HcQ/OtrAE5ekFkMJSE4cbJiUAwHCQzq4Nf3UvgV5B/kSHlDBxng3o6uKo5Hn3fxCdss3zj2YuUD/rJyFd5Au+cOPZKE= 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+importer=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 1584419851773540.2677610359452; Mon, 16 Mar 2020 21:37:31 -0700 (PDT) Received: from localhost ([::1]:52476 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jE3ys-0007gn-Lo for importer@patchew.org; Tue, 17 Mar 2020 00:37:30 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49430) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jE3wR-0004f2-Oh for qemu-devel@nongnu.org; Tue, 17 Mar 2020 00:35:00 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1jE3wP-0000je-Fi for qemu-devel@nongnu.org; Tue, 17 Mar 2020 00:34:59 -0400 Received: from us-smtp-delivery-74.mimecast.com ([63.128.21.74]:23968) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1jE3wP-0000f7-B5 for qemu-devel@nongnu.org; Tue, 17 Mar 2020 00:34:57 -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-134-w-MIqttdMTGzjxGeTiLrww-1; Tue, 17 Mar 2020 00:34:44 -0400 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 23F1D8017CC; Tue, 17 Mar 2020 04:34:43 +0000 (UTC) Received: from probe.redhat.com (ovpn-112-191.rdu2.redhat.com [10.10.112.191]) by smtp.corp.redhat.com (Postfix) with ESMTP id 259F35C1BB; Tue, 17 Mar 2020 04:34:41 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1584419697; 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=orgTszhfV3dEbp+pu5KH9GxYNoUHEki++yMiFhha/vk=; b=eZWp6fKERn2FrZX8hkeUXfSuN0SNGGLRH23DkvLiQIttrs2TZIx+pHnAxcK11GjBwOAFl0 1dzcwIMJYy1MJJah1GGFW7zPl2L7z2AkECMWUzJmuVgYcHvoXEy5c4pVNhNjOMTbxPlDdg 8krDW9chpJwF1iYzRBxlr4KhlcP5bNw= X-MC-Unique: w-MIqttdMTGzjxGeTiLrww-1 From: John Snow To: qemu-devel@nongnu.org Subject: [PATCH v3 3/3] iotests: modify test 040 to use JobRunner Date: Tue, 17 Mar 2020 00:34:37 -0400 Message-Id: <20200317043437.19464-4-jsnow@redhat.com> In-Reply-To: <20200317043437.19464-1-jsnow@redhat.com> References: <20200317043437.19464-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 63.128.21.74 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 , Eduardo Habkost , qemu-block@nongnu.org, Max Reitz , Cleber Rosa , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Instead of having somewhat reproduced it for itself. Signed-off-by: John Snow --- tests/qemu-iotests/040 | 51 +++++++++++++++++++++--------------------- 1 file changed, 25 insertions(+), 26 deletions(-) diff --git a/tests/qemu-iotests/040 b/tests/qemu-iotests/040 index 90b59081ff..e2ef3bb812 100755 --- a/tests/qemu-iotests/040 +++ b/tests/qemu-iotests/040 @@ -483,34 +483,33 @@ class TestErrorHandling(iotests.QMPTestCase): file=3D('top-dbg' if top_debug else 'top-file'), backing=3D'mid-fmt') =20 + + class TestJobRunner(iotests.JobRunner): + expected_events =3D ('BLOCK_JOB_COMPLETED', + 'BLOCK_JOB_ERROR', + 'BLOCK_JOB_READY') + + def __init__(self, *args, test, **kwargs): + super().__init__(*args, **kwargs) + self.log =3D [] + self.test =3D test + + def on_pause(self, event): + super().on_pause(event) + result =3D self._vm.qmp('block-job-resume', device=3Dself._id) + self.test.assert_qmp(result, 'return', {}) + + def on_block_job_event(self, event): + if event['event'] not in self.expected_events: + self.test.fail("Unexpected event: %s" % event) + super().on_block_job_event(event) + self.log.append(event) + def run_job(self, expected_events, error_pauses_job=3DFalse): - match_device =3D {'data': {'device': 'job0'}} - events =3D { - 'BLOCK_JOB_COMPLETED': match_device, - 'BLOCK_JOB_CANCELLED': match_device, - 'BLOCK_JOB_ERROR': match_device, - 'BLOCK_JOB_READY': match_device, - } - - completed =3D False - log =3D [] - while not completed: - ev =3D self.vm.events_wait(events, timeout=3D5.0) - if ev['event'] =3D=3D 'BLOCK_JOB_COMPLETED': - completed =3D True - elif ev['event'] =3D=3D 'BLOCK_JOB_ERROR': - if error_pauses_job: - result =3D self.vm.qmp('block-job-resume', device=3D'j= ob0') - self.assert_qmp(result, 'return', {}) - elif ev['event'] =3D=3D 'BLOCK_JOB_READY': - result =3D self.vm.qmp('block-job-complete', device=3D'job= 0') - self.assert_qmp(result, 'return', {}) - else: - self.fail("Unexpected event: %s" % ev) - log.append(iotests.filter_qmp_event(ev)) - + job =3D self.TestJobRunner(self.vm, 'job0', test=3Dself) + job.run() self.maxDiff =3D None - self.assertEqual(expected_events, log) + self.assertEqual(expected_events, job.log) =20 def event_error(self, op, action): return { --=20 2.21.1