From patchwork Fri Jul 31 19:56:44 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Christophe Milard X-Patchwork-Id: 51794 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f197.google.com (mail-wi0-f197.google.com [209.85.212.197]) by patches.linaro.org (Postfix) with ESMTPS id 045AF22D9C for ; Fri, 31 Jul 2015 19:57:29 +0000 (UTC) Received: by wicmm11 with SMTP id mm11sf11469538wic.3 for ; Fri, 31 Jul 2015 12:57:28 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:delivered-to:from:to:date :message-id:cc:subject:precedence:list-id:list-unsubscribe :list-archive:list-post:list-help:list-subscribe:mime-version :content-type:content-transfer-encoding:errors-to:sender :x-original-sender:x-original-authentication-results:mailing-list; bh=/jBkTBFXUo/qOrSINcR+UAjKKHXzg70BwEjjr6GnYrQ=; b=hkUn7eJ/242EysZa98WiycwXD4W/cHFfdDNwYqcxkCRZly3cbVGeRAO3/zRNXesk6j OfBOHBFrxiW5ruRDuJsqOEIBDi8GMlff3OrldS8pZPLebTRtMYLtzuLYVwiC7Nv0Bb1A SM9xD61ntupU4Bws1G+zt6Z6JhhOMI3suxbvR9Qfwviwg0K3rr6wOlUNExQd8rZu5/TV d1w/rUQDqbeS+NuvP03c6eToogKea1VSBiWgRM6cZszBNtl0Ca4+8RqZZrUkIdZDd465 mqj/xzpzGlhXv83t4hYXXRkPvb6hNaDRrD0AkOKE3nCsRwLugSWKOhDqa86cIymd3X+Q sjPg== X-Gm-Message-State: ALoCoQlqWiZS20kJ7VK7PYKAsPt7GS9lLtRwLbiu/pcRDEJyTWeGkD/8ovbNBrUITHma+ImNbUgz X-Received: by 10.180.186.36 with SMTP id fh4mr1562036wic.7.1438372648348; Fri, 31 Jul 2015 12:57:28 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.44.169 with SMTP id f9ls361455lam.93.gmail; Fri, 31 Jul 2015 12:57:28 -0700 (PDT) X-Received: by 10.152.36.41 with SMTP id n9mr5002458laj.79.1438372648134; Fri, 31 Jul 2015 12:57:28 -0700 (PDT) Received: from mail-lb0-f170.google.com (mail-lb0-f170.google.com. [209.85.217.170]) by mx.google.com with ESMTPS id tn10si4781986lbb.38.2015.07.31.12.57.28 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 31 Jul 2015 12:57:28 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.170 as permitted sender) client-ip=209.85.217.170; Received: by lblf12 with SMTP id f12so52368509lbl.2 for ; Fri, 31 Jul 2015 12:57:28 -0700 (PDT) X-Received: by 10.152.120.135 with SMTP id lc7mr4926915lab.41.1438372647997; Fri, 31 Jul 2015 12:57:27 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.7.198 with SMTP id l6csp577379lba; Fri, 31 Jul 2015 12:57:27 -0700 (PDT) X-Received: by 10.55.42.231 with SMTP id q100mr7201749qkq.52.1438372646571; Fri, 31 Jul 2015 12:57:26 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id q42si7463014qkh.117.2015.07.31.12.57.25; Fri, 31 Jul 2015 12:57:26 -0700 (PDT) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Received: by lists.linaro.org (Postfix, from userid 109) id 539756214B; Fri, 31 Jul 2015 19:57:25 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252.ec2.internal X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from ip-10-142-244-252.ec2.internal (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id E3CED62148; Fri, 31 Jul 2015 19:57:13 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 4C54D62148; Fri, 31 Jul 2015 19:57:07 +0000 (UTC) Received: from mail-lb0-f179.google.com (mail-lb0-f179.google.com [209.85.217.179]) by lists.linaro.org (Postfix) with ESMTPS id 7D961620FE for ; Fri, 31 Jul 2015 19:57:01 +0000 (UTC) Received: by lbbyj8 with SMTP id yj8so52161649lbb.0 for ; Fri, 31 Jul 2015 12:57:00 -0700 (PDT) X-Received: by 10.152.22.4 with SMTP id z4mr5027616lae.81.1438372620111; Fri, 31 Jul 2015 12:57:00 -0700 (PDT) Received: from localhost.localdomain (c-83-233-90-46.cust.bredband2.com. [83.233.90.46]) by smtp.gmail.com with ESMTPSA id g5sm1131495laf.33.2015.07.31.12.56.58 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 31 Jul 2015 12:56:58 -0700 (PDT) From: Christophe Milard To: anders.roxell@linaro.org, mike.holmes@linaro.org, stuart.haslam@linaro.org, maxim.uvarov@linaro.org Date: Fri, 31 Jul 2015 21:56:44 +0200 Message-Id: <1438372604-24408-1-git-send-email-christophe.milard@linaro.org> X-Mailer: git-send-email 2.1.0 X-Topics: patch Cc: lng-odp@lists.linaro.org Subject: [lng-odp] [PATCH] validation: update README files X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: christophe.milard@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.170 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 Signed-off-by: Christophe Milard Reviewed-by: Stuart Haslam --- test/README | 8 +------- test/validation/README | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+), 7 deletions(-) create mode 100644 test/validation/README diff --git a/test/README b/test/README index 64bf03b..857c366 100644 --- a/test/README +++ b/test/README @@ -6,8 +6,7 @@ SPDX-License-Identifier: BSD-3-Clause Files in test/validation directory are intended to be terse checks that help ensure that the ODP API Implementations all perform identically and to specification. Tests inside the validation directory shall be platform -independent. However, they may need platform dependent environment -configuration. +independent. To run valgrind on the executables do: $ ./bootstrap @@ -15,8 +14,3 @@ $ ./configure --enable-test-vald --enable-valgrind $ cd test/validation $ make check-valgrind -Some tests scripts, like pktio require ODP_PLATFORM variable to be exported to load -platform specific env files. 'make check' defines that variable automatically, -and package will put all required files at the same place as tests binaries. But if -you run tests manually from odp source code then you need it to be defined, like: -export ODP_PLATFROM=linux-generic. diff --git a/test/validation/README b/test/validation/README new file mode 100644 index 0000000..2d0c258 --- /dev/null +++ b/test/validation/README @@ -0,0 +1,50 @@ +Copyright (c) 2015, Linaro Limited +All rights reserved. + +SPDX-License-Identifier: BSD-3-Clause + + +To add tests in here, please observe the following rules: + +1. Tests should be placed in the directory of the module they belong to. + + +2. Test under test/validation/... should be platform agnostic, i.e. + -they should be written in plain C only + -they may only used Clib functions, C_UNIT functions and of course ODP + functions. + -they should be expected to pass on all ODP implementation + + Tests that do not follow these rules should be placed in the platform + specific test area (currently platform//test*) + + +3. If a new ODP API module is created, please update the Makefile.am and + the odptest.h file + + +4. Respect the following name convention for the names exported in the library: + + * Tests, i.e. functions which are used in CUNIT test suites are named: + *_test_* + + * Test arrays, i.e. arrays of CU_TestInfo, listing the test functions + belonging to a suite, are called: + _suite[_*] + where the possible suffix can be used if many suites are declared. + + * CUNIT suite init and termination functions are called: + _suite[_*]_init() and _suite[_*]_term() + respectively. + + * Suite arrays, i.e. arrays of CU_SuiteInfo used in executables are called: + _suites[_*] + where the possible suffix identifies the executable using it, if many. + + * Main executable function(s), are called: + _main[_*]* + where the possible suffix identifies the executable using it + + * Init/term function for the whole executable are called: + _init + _term