From nobody Fri Apr 4 05:33:06 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; 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=pass(p=quarantine dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1742390427; cv=none; d=zohomail.com; s=zohoarc; b=JHarfGNmC8djhEA74vpE/F0LTLYr/+5m24WGMPCH1SBCMiImhPDRs5+PkZK8DdPgqWSRwa9jfxtI5grJQpPfBlPTgOoi2ozwYrqp5dOyrptdsdmW3OJay6k+LbEQLur5GS2MCvbBwsi90/YyAZI87dZmC9tiNaeOuu7q1nWLmTM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1742390427; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=50BIJkpGtU8kh5NKqRzybyXSHxadiu3JT6r7K12A1H8=; b=a2HUCgsCCZ1twavkmbl3RCgDi2ImT1/hTRbsxav6fNjgQgzXLnLLMimcguViXIMRlUkkKE1J2Op2FkR4PEDKwzLUcuXJzXA4CGpmh2HuLVsaWqBrV5rf5vB32VOHN3CMmZGZVJMQQcyk/vuPLik1joYpVceCACpqvFiEkYbMpII= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; 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=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1742390427154250.69719185375004; Wed, 19 Mar 2025 06:20:27 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tutKZ-0000Gp-5I; Wed, 19 Mar 2025 09:19:35 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tutKW-0000A1-PY for qemu-devel@nongnu.org; Wed, 19 Mar 2025 09:19:32 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tutKU-0007eg-W5 for qemu-devel@nongnu.org; Wed, 19 Mar 2025 09:19:32 -0400 Received: from mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-117-CVERmk6jNbGGLYDYUQei2w-1; Wed, 19 Mar 2025 09:19:27 -0400 Received: from mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.4]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 2676A180AF6B; Wed, 19 Mar 2025 13:19:26 +0000 (UTC) Received: from thuth-p1g4.redhat.com (unknown [10.44.32.212]) by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 657563001D0E; Wed, 19 Mar 2025 13:19:22 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1742390370; 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=50BIJkpGtU8kh5NKqRzybyXSHxadiu3JT6r7K12A1H8=; b=AMXoNuTeExkEcS3+diBOJ+H39eGg5L7hmEGSqj2xpSMSLrYTVRDv6PazZJUfE43PTjoe48 op2qyra59OMWiYJsXoex+Gi1Hc8lhtThYofCxvF+3Oi1p5PsjxogKK4FZlwOkVyx4IaKCo 1zcZ0WeJ+TvdYEWO4peYyRUcosZXO0k= X-MC-Unique: CVERmk6jNbGGLYDYUQei2w-1 X-Mimecast-MFC-AGG-ID: CVERmk6jNbGGLYDYUQei2w_1742390366 From: Thomas Huth To: qemu-devel@nongnu.org Cc: Stefan Hajnoczi , Aditya Gupta , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= Subject: [PULL 6/8] docs/devel/testing/functional: Add a section about logging Date: Wed, 19 Mar 2025 14:18:49 +0100 Message-ID: <20250319131851.148817-7-thuth@redhat.com> In-Reply-To: <20250319131851.148817-1-thuth@redhat.com> References: <20250319131851.148817-1-thuth@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.4 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; Received-SPF: pass client-ip=170.10.129.124; envelope-from=thuth@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -23 X-Spam_score: -2.4 X-Spam_bar: -- X-Spam_report: (-2.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.337, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, 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: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1742390429238019000 From: Thomas Huth We should tell the users where to find the log file. While we're at it, also rename the "Overview" heading to a more accurate "Introduction to writing tests" instead. Reported-by: Aditya Gupta Message-ID: <20250318092021.53719-1-thuth@redhat.com> Reviewed-by: Daniel P. Berrang=C3=A9 Signed-off-by: Thomas Huth --- docs/devel/testing/functional.rst | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/docs/devel/testing/functional.rst b/docs/devel/testing/functio= nal.rst index a9fa45eac1f..9bc973392aa 100644 --- a/docs/devel/testing/functional.rst +++ b/docs/devel/testing/functional.rst @@ -72,8 +72,26 @@ files around on disk by setting ```QEMU_TEST_KEEP_SCRATC= H=3D1``` as an env variable. Any preserved files will be deleted the next time the test is r= un without this variable set. =20 -Overview --------- +Logging +------- + +The framework collects log files for each test in the build directory +in the following subfolder:: + + /tests/functional//../ + +There are usually three log files: + +* ``base.log`` contains the generic logging information that is written + by the calls to the logging functions in the test code (e.g. by calling + the ``self.log.info()`` or ``self.log.debug()`` functions). +* ``console.log`` contains the output of the serial console of the guest. +* ``default.log`` contains the output of QEMU. This file could be named + differently if the test chooses to use a different identifier for + the guest VM (e.g. when the test spins up multiple VMs). + +Introduction to writing tests +----------------------------- =20 The ``tests/functional/qemu_test`` directory provides the ``qemu_test`` Python module, containing the ``qemu_test.QemuSystemTest`` class. --=20 2.48.1