{"id":2013887,"url":"http://patchwork.ozlabs.org/api/patches/2013887/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20241121154218.1423005-3-berrange@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":"<20241121154218.1423005-3-berrange@redhat.com>","list_archive_url":null,"date":"2024-11-21T15:42:02","name":"[v2,02/18] tests/functional: automatically clean up scratch files after tests","commit_ref":null,"pull_url":null,"state":"new","archived":false,"hash":"a7123ea35e43c4be2301439846125dfd1e38a4f9","submitter":{"id":2694,"url":"http://patchwork.ozlabs.org/api/people/2694/?format=json","name":"Daniel P. Berrangé","email":"berrange@redhat.com"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20241121154218.1423005-3-berrange@redhat.com/mbox/","series":[{"id":433720,"url":"http://patchwork.ozlabs.org/api/series/433720/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/list/?series=433720","date":"2024-11-21T15:42:05","name":"test/functional: improve functional test debugging & fix tuxrun","version":2,"mbox":"http://patchwork.ozlabs.org/series/433720/mbox/"}],"comments":"http://patchwork.ozlabs.org/api/patches/2013887/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/2013887/checks/","tags":{},"related":[],"headers":{"Return-Path":"","X-Original-To":"incoming@patchwork.ozlabs.org","Delivered-To":"patchwork-incoming@legolas.ozlabs.org","Authentication-Results":["legolas.ozlabs.org;\n\tdkim=pass (1024-bit key;\n unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256\n header.s=mimecast20190719 header.b=Ce3tmH53;\n\tdkim-atps=neutral","legolas.ozlabs.org;\n spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org\n (client-ip=209.51.188.17; helo=lists.gnu.org;\n envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org;\n receiver=patchwork.ozlabs.org)"],"Received":["from lists.gnu.org (lists.gnu.org [209.51.188.17])\n\t(using TLSv1.2 with cipher ECDHE-ECDSA-AES256-GCM-SHA384 (256/256 bits))\n\t(No client certificate requested)\n\tby legolas.ozlabs.org (Postfix) with ESMTPS id 4XvMwN5BMxz1xyG\n\tfor ; Fri, 22 Nov 2024 02:44:04 +1100 (AEDT)","from localhost ([::1] helo=lists1p.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.90_1)\n\t(envelope-from )\n\tid 1tE9KT-0008MA-LS; Thu, 21 Nov 2024 10:42:49 -0500","from eggs.gnu.org ([2001:470:142:3::10])\n by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)\n (Exim 4.90_1) (envelope-from )\n id 1tE9KS-0008M0-Kc\n for qemu-devel@nongnu.org; Thu, 21 Nov 2024 10:42:48 -0500","from us-smtp-delivery-124.mimecast.com ([170.10.133.124])\n by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)\n (Exim 4.90_1) (envelope-from )\n id 1tE9KR-0000iI-2a\n for qemu-devel@nongnu.org; Thu, 21 Nov 2024 10:42:48 -0500","from mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com\n (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by\n relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3,\n cipher=TLS_AES_256_GCM_SHA384) id us-mta-88-lDdkqxyIOxuPxpOaUDDWcA-1; Thu,\n 21 Nov 2024 10:42:44 -0500","from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com\n (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15])\n (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest\n SHA256)\n (No client certificate requested)\n by mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS\n id 6CECD19540F2; Thu, 21 Nov 2024 15:42:43 +0000 (UTC)","from toolbox.redhat.com (unknown [10.42.28.5])\n by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP\n id 8970D195607C; Thu, 21 Nov 2024 15:42:35 +0000 (UTC)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n s=mimecast20190719; t=1732203766;\n h=from:from:reply-to:subject:subject:date:date:message-id:message-id:\n to:to:cc:cc:mime-version:mime-version:content-type:content-type:\n content-transfer-encoding:content-transfer-encoding:\n in-reply-to:in-reply-to:references:references;\n bh=jMkCy4MQl2qLOgRMp/s9Ejjza/xczcztT7nl6dT9KCs=;\n b=Ce3tmH53909xHc9vSkadAXccSrD8293/60RpN3ucaK5Nhy1lxYwADoNhS6e4otw49F/vQM\n 15Tz0MoUhDZ+4q5K75HbCt4N6DErwjyE9yboQoQt2F6tCQSlnB/bnMTgOC46IQByYnLp1n\n E3Ulp2ntf4Bl+IY9aNRXvLuFGuBZl9I=","X-MC-Unique":"lDdkqxyIOxuPxpOaUDDWcA-1","X-Mimecast-MFC-AGG-ID":"lDdkqxyIOxuPxpOaUDDWcA","From":"=?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= ","To":"qemu-devel@nongnu.org","Cc":"Thomas Huth , Ani Sinha ,\n\t=?utf-8?q?Alex_Benn=C3=A9e?= ,\n Peter Maydell , =?utf-8?q?Philippe_Mathieu-Daud?=\n\t=?utf-8?q?=C3=A9?= ,\n =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= ","Subject":"[PATCH v2 02/18] tests/functional: automatically clean up scratch\n files after tests","Date":"Thu, 21 Nov 2024 15:42:02 +0000","Message-ID":"<20241121154218.1423005-3-berrange@redhat.com>","In-Reply-To":"<20241121154218.1423005-1-berrange@redhat.com>","References":"<20241121154218.1423005-1-berrange@redhat.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=UTF-8","Content-Transfer-Encoding":"8bit","X-Scanned-By":"MIMEDefang 3.0 on 10.30.177.15","Received-SPF":"pass client-ip=170.10.133.124;\n envelope-from=berrange@redhat.com;\n helo=us-smtp-delivery-124.mimecast.com","X-Spam_score_int":"-21","X-Spam_score":"-2.2","X-Spam_bar":"--","X-Spam_report":"(-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.14,\n DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,\n RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001,\n RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001,\n SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no","X-Spam_action":"no action","X-BeenThere":"qemu-devel@nongnu.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n ","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n ","Errors-To":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org","Sender":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org"},"content":"The build/tests/functional subdirectories are consuming huge amounts\nof disk space.\n\nSplit the location for scratch files into a 'scratch' sub-directory,\nseparate from log files, and delete it upon completion of each test.\nThe new env variable QEMU_TEST_KEEP_SCRATCH can be set to preserve\nthis scratch dir for debugging access if required.\n\nReviewed-by: Alex Bennée \nSigned-off-by: Daniel P. Berrangé \n---\n docs/devel/testing/functional.rst | 6 ++++++\n tests/functional/qemu_test/testcase.py | 14 +++++++++-----\n 2 files changed, 15 insertions(+), 5 deletions(-)","diff":"diff --git a/docs/devel/testing/functional.rst b/docs/devel/testing/functional.rst\nindex bf6f1bb81e..6b5d0c5b98 100644\n--- a/docs/devel/testing/functional.rst\n+++ b/docs/devel/testing/functional.rst\n@@ -65,6 +65,12 @@ to the QEMU binary that should be used for the test, for example::\n $ export QEMU_TEST_QEMU_BINARY=$PWD/qemu-system-x86_64\n $ python3 ../tests/functional/test_file.py\n \n+The test framework will automatically purge any scratch files created during\n+the tests. If needing to debug a failed test, it is possible to keep these\n+files around on disk by setting ```QEMU_TEST_KEEP_SCRATCH=1``` as an env\n+variable. Any preserved files will be deleted the next time the test is run\n+without this variable set.\n+\n Overview\n --------\n \ndiff --git a/tests/functional/qemu_test/testcase.py b/tests/functional/qemu_test/testcase.py\nindex 411978b5ef..b9418e2ac0 100644\n--- a/tests/functional/qemu_test/testcase.py\n+++ b/tests/functional/qemu_test/testcase.py\n@@ -13,8 +13,9 @@\n \n import logging\n import os\n-import subprocess\n import pycotap\n+import shutil\n+import subprocess\n import sys\n import unittest\n import uuid\n@@ -40,11 +41,12 @@ def setUp(self, bin_prefix):\n self.assertIsNotNone(self.qemu_bin, 'QEMU_TEST_QEMU_BINARY must be set')\n self.arch = self.qemu_bin.split('-')[-1]\n \n- self.workdir = os.path.join(BUILD_DIR, 'tests/functional', self.arch,\n- self.id())\n+ self.outputdir = os.path.join(BUILD_DIR, 'tests', 'functional',\n+ self.arch, self.id())\n+ self.workdir = os.path.join(self.outputdir, 'scratch')\n os.makedirs(self.workdir, exist_ok=True)\n \n- self.logdir = self.workdir\n+ self.logdir = self.outputdir\n self.log_filename = os.path.join(self.logdir, 'base.log')\n self.log = logging.getLogger('qemu-test')\n self.log.setLevel(logging.DEBUG)\n@@ -56,6 +58,8 @@ def setUp(self, bin_prefix):\n self.log.addHandler(self._log_fh)\n \n def tearDown(self):\n+ if \"QEMU_TEST_KEEP_SCRATCH\" not in os.environ:\n+ shutil.rmtree(self.workdir)\n self.log.removeHandler(self._log_fh)\n \n def main():\n@@ -108,7 +112,7 @@ def setUp(self):\n \n console_log = logging.getLogger('console')\n console_log.setLevel(logging.DEBUG)\n- self.console_log_name = os.path.join(self.workdir, 'console.log')\n+ self.console_log_name = os.path.join(self.logdir, 'console.log')\n self._console_log_fh = logging.FileHandler(self.console_log_name,\n mode='w')\n self._console_log_fh.setLevel(logging.DEBUG)\n","prefixes":["v2","02/18"]}