From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.1 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,NICE_REPLY_A,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_SANE_1 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id F1789C433DB for ; Tue, 26 Jan 2021 17:47:35 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 656B52228A for ; Tue, 26 Jan 2021 17:47:35 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 656B52228A Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:52396 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1l4SRC-0002L0-D4 for qemu-devel@archiver.kernel.org; Tue, 26 Jan 2021 12:47:34 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:42814) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1l4SOy-0001Bb-0J for qemu-devel@nongnu.org; Tue, 26 Jan 2021 12:45:17 -0500 Received: from us-smtp-delivery-124.mimecast.com ([63.128.21.124]:28311) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1l4SOs-00016m-Si for qemu-devel@nongnu.org; Tue, 26 Jan 2021 12:45:14 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1611683108; 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=KY3VpP5vTo2Wy8FTufO1a9MbxUOwsGD0O6ZVsqmnVXI=; b=KcUz9vooPiXvpDnogJfU2nIzkb/RwZyqCM8DdNe5/ct51vEs1mZLkO1s5/DUl7PVE2VFvi MWjIqtv0vH5JurRwlXsqW89igv6lOKOPFAt/1VMWfuKTYCb7TMaRLg/WlwtkXPlvdyvHYK 96nvpjOdg7+CByll2cG4gA3MFLB7en8= 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-214-2VJJABGSPYawgWE1cGJ8Xw-1; Tue, 26 Jan 2021 12:45:06 -0500 X-MC-Unique: 2VJJABGSPYawgWE1cGJ8Xw-1 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 4B2E115722; Tue, 26 Jan 2021 17:45:05 +0000 (UTC) Received: from thuth.remote.csb (ovpn-112-182.ams2.redhat.com [10.36.112.182]) by smtp.corp.redhat.com (Postfix) with ESMTP id A3F1019C46; Tue, 26 Jan 2021 17:45:00 +0000 (UTC) Subject: Re: [PATCH v2] docs/devel: Explain how acceptance tests can be skipped To: Wainer dos Santos Moschetta , qemu-devel@nongnu.org References: <20210115210022.417996-1-wainersm@redhat.com> From: Thomas Huth Message-ID: Date: Tue, 26 Jan 2021 18:44:59 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.6.1 MIME-Version: 1.0 In-Reply-To: <20210115210022.417996-1-wainersm@redhat.com> X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=thuth@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit Received-SPF: pass client-ip=63.128.21.124; envelope-from=thuth@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -30 X-Spam_score: -3.1 X-Spam_bar: --- X-Spam_report: (-3.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.255, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, NICE_REPLY_A=-0.001, 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: philmd@redhat.com, alex.bennee@linaro.org, wrampazz@redhat.com, crosa@redhat.com Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" On 15/01/2021 22.00, Wainer dos Santos Moschetta wrote: > 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 > --- > v2: > - Made the changes Thomas pointed out. > > docs/devel/testing.rst | 62 ++++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 62 insertions(+) > > diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst > index 0aa7a13bba..9f8b77c8ec 100644 > --- a/docs/devel/testing.rst > +++ b/docs/devel/testing.rst > @@ -871,6 +871,68 @@ qemu_bin > > The exact QEMU binary to be used on QEMUMachine. > > +Skipping tests > +-------------- > +The Avocado framework provides Python decorators which allow for easily skip > +tests running under certain conditions. For example, on the lack of a binary > +on the test system or when the running environment is a CI system. For further > +information about those decorators, please refer to:: > + > + https://avocado-framework.readthedocs.io/en/latest/guides/writer/chapters/writing.html#skipping-tests > + > +While the conditions for skipping tests are often specifics of each one, there > +are recurring scenarios identified by the QEMU developers and the use of > +environment variables became a kind of standard way to enable/disable tests. > + > +Here is a list of the most used 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=1` 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=1` on the environment in > +order to allow tests which make use of those kind of assets. > + > +AVOCADO_TIMEOUT_EXPECTED > +~~~~~~~~~~~~~~~~~~~~~~~~ > +The Avocado framework has a timeout mechanism which interrupts tests to avoid the > +test suite of getting stuck. The timeout value can be set via test parameter or > +property defined in the test class, for further details:: > + > + https://avocado-framework.readthedocs.io/en/latest/guides/writer/chapters/writing.html#setting-a-test-timeout > + > +Even though the timeout can be set by the test developer, there are some tests > +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` variable > +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 which > +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() Reviewed-by: Thomas Huth I can take this trough my testing branch.