{"id":810171,"url":"http://patchwork.ozlabs.org/api/patches/810171/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20170905132908.30931-2-stefanha@redhat.com/","project":{"id":14,"url":"http://patchwork.ozlabs.org/api/projects/14/?format=json","name":"QEMU Development","link_name":"qemu-devel","list_id":"qemu-devel.nongnu.org","list_email":"qemu-devel@nongnu.org","web_url":"","scm_url":"","webscm_url":"","list_archive_url":"","list_archive_url_format":"","commit_url_format":""},"msgid":"<20170905132908.30931-2-stefanha@redhat.com>","list_archive_url":null,"date":"2017-09-05T13:29:05","name":"[PULL,1/4] qemu.py: make VM() a context manager","commit_ref":null,"pull_url":null,"state":"new","archived":false,"hash":"aa9b22e8bd4e8ab7ec6d2ca4cb103d5f16170fc1","submitter":{"id":17227,"url":"http://patchwork.ozlabs.org/api/people/17227/?format=json","name":"Stefan Hajnoczi","email":"stefanha@redhat.com"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20170905132908.30931-2-stefanha@redhat.com/mbox/","series":[{"id":1584,"url":"http://patchwork.ozlabs.org/api/series/1584/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/list/?series=1584","date":"2017-09-05T13:29:04","name":"[PULL,1/4] qemu.py: make VM() a context manager","version":1,"mbox":"http://patchwork.ozlabs.org/series/1584/mbox/"}],"comments":"http://patchwork.ozlabs.org/api/patches/810171/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/810171/checks/","tags":{},"related":[],"headers":{"Return-Path":"<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>","X-Original-To":"incoming@patchwork.ozlabs.org","Delivered-To":"patchwork-incoming@bilbo.ozlabs.org","Authentication-Results":["ozlabs.org;\n\tspf=pass (mailfrom) smtp.mailfrom=nongnu.org\n\t(client-ip=2001:4830:134:3::11; helo=lists.gnu.org;\n\tenvelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org;\n\treceiver=<UNKNOWN>)","ext-mx06.extmail.prod.ext.phx2.redhat.com;\n\tdmarc=none (p=none dis=none) header.from=redhat.com","ext-mx06.extmail.prod.ext.phx2.redhat.com;\n\tspf=fail smtp.mailfrom=stefanha@redhat.com"],"Received":["from lists.gnu.org (lists.gnu.org [IPv6:2001:4830:134:3::11])\n\t(using TLSv1 with cipher AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby ozlabs.org (Postfix) with ESMTPS id 3xmndb4XMZz9t2S\n\tfor <incoming@patchwork.ozlabs.org>;\n\tTue,  5 Sep 2017 23:30:11 +1000 (AEST)","from localhost ([::1]:58948 helo=lists.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.71) (envelope-from\n\t<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>)\n\tid 1dpDvd-0000nz-KV\n\tfor incoming@patchwork.ozlabs.org; Tue, 05 Sep 2017 09:30:09 -0400","from eggs.gnu.org ([2001:4830:134:3::10]:51265)\n\tby lists.gnu.org with esmtp (Exim 4.71)\n\t(envelope-from <stefanha@redhat.com>) id 1dpDus-0000jQ-L7\n\tfor qemu-devel@nongnu.org; Tue, 05 Sep 2017 09:29:27 -0400","from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)\n\t(envelope-from <stefanha@redhat.com>) id 1dpDun-0003rA-SE\n\tfor qemu-devel@nongnu.org; Tue, 05 Sep 2017 09:29:22 -0400","from mx1.redhat.com ([209.132.183.28]:55656)\n\tby eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)\n\t(Exim 4.71) (envelope-from <stefanha@redhat.com>) id 1dpDun-0003qB-MG\n\tfor qemu-devel@nongnu.org; Tue, 05 Sep 2017 09:29:17 -0400","from smtp.corp.redhat.com\n\t(int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16])\n\t(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby mx1.redhat.com (Postfix) with ESMTPS id 84101267C5;\n\tTue,  5 Sep 2017 13:29:16 +0000 (UTC)","from localhost (ovpn-117-180.ams2.redhat.com [10.36.117.180])\n\tby smtp.corp.redhat.com (Postfix) with ESMTP id 6BF726A0A5;\n\tTue,  5 Sep 2017 13:29:13 +0000 (UTC)"],"DMARC-Filter":"OpenDMARC Filter v1.3.2 mx1.redhat.com 84101267C5","From":"Stefan Hajnoczi <stefanha@redhat.com>","To":"<qemu-devel@nongnu.org>","Date":"Tue,  5 Sep 2017 14:29:05 +0100","Message-Id":"<20170905132908.30931-2-stefanha@redhat.com>","In-Reply-To":"<20170905132908.30931-1-stefanha@redhat.com>","References":"<20170905132908.30931-1-stefanha@redhat.com>","X-Scanned-By":"MIMEDefang 2.79 on 10.5.11.16","X-Greylist":"Sender IP whitelisted, not delayed by milter-greylist-4.5.16\n\t(mx1.redhat.com [10.5.110.30]);\n\tTue, 05 Sep 2017 13:29:16 +0000 (UTC)","X-detected-operating-system":"by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic]\n\t[fuzzy]","X-Received-From":"209.132.183.28","Subject":"[Qemu-devel] [PULL 1/4] qemu.py: make VM() a context manager","X-BeenThere":"qemu-devel@nongnu.org","X-Mailman-Version":"2.1.21","Precedence":"list","List-Id":"<qemu-devel.nongnu.org>","List-Unsubscribe":"<https://lists.nongnu.org/mailman/options/qemu-devel>,\n\t<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>","List-Archive":"<http://lists.nongnu.org/archive/html/qemu-devel/>","List-Post":"<mailto:qemu-devel@nongnu.org>","List-Help":"<mailto:qemu-devel-request@nongnu.org?subject=help>","List-Subscribe":"<https://lists.nongnu.org/mailman/listinfo/qemu-devel>,\n\t<mailto:qemu-devel-request@nongnu.org?subject=subscribe>","Cc":"Peter Maydell <peter.maydell@linaro.org>,\n\tEduardo Habkost <ehabkost@redhat.com>,\n\tStefan Hajnoczi <stefanha@redhat.com>","Errors-To":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org","Sender":"\"Qemu-devel\"\n\t<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>"},"content":"There are a number of ways to ensure that the QEMU process is shut down\nwhen the test ends, including atexit.register(), try: finally:, or\nunittest.teardown() methods.  All of these require extra code and the\nprogrammer must remember to add vm.shutdown().\n\nA nice solution is context managers:\n\n  with VM(binary) as vm:\n      ...\n  # vm is guaranteed to be shut down here\n\nCc: Eduardo Habkost <ehabkost@redhat.com>\nSigned-off-by: Stefan Hajnoczi <stefanha@redhat.com>\nReviewed-by: Eduardo Habkost <ehabkost@redhat.com>\nMessage-id: 20170824072202.26818-2-stefanha@redhat.com\nSigned-off-by: Stefan Hajnoczi <stefanha@redhat.com>\n---\n scripts/qemu.py | 16 +++++++++++++++-\n 1 file changed, 15 insertions(+), 1 deletion(-)","diff":"diff --git a/scripts/qemu.py b/scripts/qemu.py\nindex 880e3e8219..4d8ee10943 100644\n--- a/scripts/qemu.py\n+++ b/scripts/qemu.py\n@@ -21,7 +21,14 @@ import qmp.qmp\n \n \n class QEMUMachine(object):\n-    '''A QEMU VM'''\n+    '''A QEMU VM\n+\n+    Use this object as a context manager to ensure the QEMU process terminates::\n+\n+        with VM(binary) as vm:\n+            ...\n+        # vm is guaranteed to be shut down here\n+    '''\n \n     def __init__(self, binary, args=[], wrapper=[], name=None, test_dir=\"/var/tmp\",\n                  monitor_address=None, socket_scm_helper=None, debug=False):\n@@ -40,6 +47,13 @@ class QEMUMachine(object):\n         self._socket_scm_helper = socket_scm_helper\n         self._debug = debug\n \n+    def __enter__(self):\n+        return self\n+\n+    def __exit__(self, exc_type, exc_val, exc_tb):\n+        self.shutdown()\n+        return False\n+\n     # This can be used to add an unused monitor instance.\n     def add_monitor_telnet(self, ip, port):\n         args = 'tcp:%s:%d,server,nowait,telnet' % (ip, port)\n","prefixes":["PULL","1/4"]}