From nobody Thu Apr 25 21:47:53 2024 Delivered-To: importer@patchew.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=1610567651; cv=none; d=zohomail.com; s=zohoarc; b=FJdhsZCps4PVxgR+5NLYA56+eVqoP5UgyhQRnR2sRmHkBC7lN9AJ0cRYV3lcfPtqD+Iv/ynXc6wD/3Zc1b+Fnwo65Ed2WnSMdryWASWpz8fXu0DN6d+IegCf/luYesJjeuaOdVSII4c10fKx/qR8mrFsIBJLe5gOhLHecr5kvwM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1610567651; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=FNlJGRW9Luc0goqnVUUovBFihpydkylPcLch6qJ33nw=; b=QOQeg8rvrPOhY2BovZ3cjfby9Rijr3j+TVRQHP2/J7exoigW3CzlUh+nhPiuut5D4TTPi7xlZxDfe/IVHjOY7qPEGx5+vL+YEaa/xfWkPLwGSsHrk4V4BxmCIzZnuvs9m2IFrwVZBf3Q7tA0AK+g0D318U1eZRDbaVqPjv+48rc= 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 1610567651103413.73496726810004; Wed, 13 Jan 2021 11:54:11 -0800 (PST) Received: from localhost ([::1]:60198 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kzmDY-0002oU-8T for importer@patchew.org; Wed, 13 Jan 2021 14:54:09 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:46894) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kzmCN-0002Ms-9Y for qemu-devel@nongnu.org; Wed, 13 Jan 2021 14:52:55 -0500 Received: from us-smtp-delivery-124.mimecast.com ([63.128.21.124]:31816) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kzmCK-0005ON-8M for qemu-devel@nongnu.org; Wed, 13 Jan 2021 14:52:54 -0500 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-74-kEsbG-V-Pwe4Qjzuzhk8-A-1; Wed, 13 Jan 2021 14:52:48 -0500 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 42FDB8145E0; Wed, 13 Jan 2021 19:52:47 +0000 (UTC) Received: from wainer-laptop.localdomain.com (ovpn-116-88.gru2.redhat.com [10.97.116.88]) by smtp.corp.redhat.com (Postfix) with ESMTP id 3053C5C239; Wed, 13 Jan 2021 19:52:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1610567570; 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; bh=FNlJGRW9Luc0goqnVUUovBFihpydkylPcLch6qJ33nw=; b=Jr0xzHnGewrUUSfeieFvB9xrYuj0oC2Ws8Tn6NgbcnySbXFW25hu7H4hTvYiI/Lw4xlQMk yYlk7a4sP8VnW9c5P2OTbLqmCvrGKgg2YC+ODRLYygxy6avhgNhdqRE9ouyn8nBOxcOX8m 5FG9ZhVFzFaN18m6PmlhuxxDZ5uuXp8= X-MC-Unique: kEsbG-V-Pwe4Qjzuzhk8-A-1 From: Wainer dos Santos Moschetta To: qemu-devel@nongnu.org Subject: [PATCH] docs/devel: Explain how acceptance tests can be skipped Date: Wed, 13 Jan 2021 16:52:38 -0300 Message-Id: <20210113195238.140945-1-wainersm@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=wainersm@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable 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=63.128.21.124; envelope-from=wainersm@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -29 X-Spam_score: -3.0 X-Spam_bar: --- X-Spam_report: (-3.0 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.25, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: alex.bennee@linaro.org, thuth@redhat.com, philmd@redhat.com, wrampazz@redhat.com, crosa@redhat.com 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" Documented under the "Acceptance tests using the Avocado Framework" section in testing.rst how environment variables are used to skip tests. Signed-off-by: Wainer dos Santos Moschetta --- CI (success): https://gitlab.com/wainersm/qemu/-/pipelines/241249714 docs/devel/testing.rst | 62 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst index 0aa7a13bba..3cdb458565 100644 --- a/docs/devel/testing.rst +++ b/docs/devel/testing.rst @@ -871,6 +871,68 @@ qemu_bin =20 The exact QEMU binary to be used on QEMUMachine. =20 +Skipping tests +-------------- +The Avocado framework provides Python decorators which allow for easily sk= ip +tests running under certain conditions. For example, on the lack of a bina= ry +on the test system or when the running environment is an CI system. For fu= rther +information about those decorators, please refer to:: + + https://avocado-framework.readthedocs.io/en/latest/guides/writer/chapter= s/writing.html#skipping-tests + +While the conditions for skipping tests are often specifics of each one, t= here +are recurring scenarios identified by the QEMU developers and the use of +environment variables became a kind of standard way to enable/disable test= s. + +It follows a not comprehensive list of those variables. + +AVOCADO_ALLOW_LARGE_STORAGE +~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Tests which are going to fetch or produce assets considered *large* are not +going to run unless that `AVOCADO_ALLOW_LARGE_STORAGE=3D1` is exported on +the environment. + +The definition of *large* is a bit arbitrary here, but it usually means an +asset which occupies at least 1GB of size on disk when uncompressed. + +AVOCADO_ALLOW_UNTRUSTED_CODE +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +There are tests which will boot a kernel image or firmware that can be +considered not safe to run on the developer's workstation, thus they are +skipped by default. The definition of *not safe* is also arbitrary but +usually it means a blob which either its source or build process aren't +public available. + +You should export `AVOCADO_ALLOW_UNTRUSTED_CODE=3D1` on the environment in +order to allow tests which make use of those assets to get running. + +AVOCADO_TIMEOUT_EXPECTED +~~~~~~~~~~~~~~~~~~~~~~~~ +The Avocado framework has a timeout mechanism which interrupt tests to avo= id the +test suite of getting stuck. The timeout value can be set via test paramet= er or +property defined in the test class, for further details:: + + https://avocado-framework.readthedocs.io/en/latest/guides/writer/chapter= s/writing.html#setting-a-test-timeout + +Even though the timeout can be set by the test developer, there are some t= ests +that may not have a well-defined limit of time to finish under certain +conditions. For example, tests that take longer to execute when QEMU is +compiled with debug flags. Therefore, the `AVOCADO_TIMEOUT_EXPECTED` varia= ble +has been used to determine whether those tests should run or not. + +GITLAB_CI +~~~~~~~~~ +A number of tests are flagged to not run on the GitLab CI. Usually because +they proved to the flaky or there are constraints on the CI environment wh= ich +would make them fail. If you encounter a similar situation then use that +variable as shown on the code snippet below to skip the test: + +.. code:: + + @skipIf(os.getenv('GITLAB_CI'), 'Running on GitLab') + def test(self): + do_something() + Uninstalling Avocado -------------------- =20 --=20 2.28.0