From patchwork Tue Nov 11 20:23:44 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 40617 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-ee0-f70.google.com (mail-ee0-f70.google.com [74.125.83.70]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 8B09D205DF for ; Tue, 11 Nov 2014 20:24:10 +0000 (UTC) Received: by mail-ee0-f70.google.com with SMTP id b57sf7287364eek.9 for ; Tue, 11 Nov 2014 12:24:09 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:date:message-id :mime-version:subject:precedence:list-id:list-unsubscribe :list-archive:list-post:list-help:list-subscribe:errors-to:sender :x-original-sender:x-original-authentication-results:mailing-list :content-type:content-transfer-encoding; bh=/7xBULcLvpKKFakLXYKy2JvzoGHGrUxrp8Sa8TSbzn8=; b=EwXxf1Zwx6kBWi/JBLuZuKF5g85Wy7fLWid3IazbqoARWBhiapWgH0wNGleBuyC9gc fohs5ASujGV3z8lXb0LlvWsNLfe47a8/UjiXwdjEyb+PG6SbbvtSs4Ern43AoFpkLye9 oMX0h6d+sYx25auHPm9hGuIa5bvJOzVpazXemS4o2m8OLGpziUgL5nQCLlVCWvElos8O eAPxokXONqxKSuCxB5p2qxfPmjV4X10c+iSKntzfzRNbf2c3MFeBY3iY4d+yERExJKtm Zl/M/7ufZoVFPPO2fiA6esYiNgZStmtRjEna7DFuWWuRVFvHA3KqE3VVZUB1SyPB9zmp u/LQ== X-Gm-Message-State: ALoCoQlfg7DGwQUmq2LL293MyEQNOfyb5/4SjDWRZGg15aq/+HWd93mhXn4M+/+MXySLnCfKkvNz X-Received: by 10.112.151.38 with SMTP id un6mr3057562lbb.0.1415737449684; Tue, 11 Nov 2014 12:24:09 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.29.135 with SMTP id k7ls538269lah.78.gmail; Tue, 11 Nov 2014 12:24:09 -0800 (PST) X-Received: by 10.152.36.33 with SMTP id n1mr38096053laj.6.1415737449365; Tue, 11 Nov 2014 12:24:09 -0800 (PST) Received: from mail-la0-f49.google.com (mail-la0-f49.google.com. [209.85.215.49]) by mx.google.com with ESMTPS id f7si6510063laa.106.2014.11.11.12.24.09 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 11 Nov 2014 12:24:09 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.49 as permitted sender) client-ip=209.85.215.49; Received: by mail-la0-f49.google.com with SMTP id ge10so9937497lab.8 for ; Tue, 11 Nov 2014 12:24:09 -0800 (PST) X-Received: by 10.152.116.102 with SMTP id jv6mr18294923lab.40.1415737449190; Tue, 11 Nov 2014 12:24:09 -0800 (PST) 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.184.201 with SMTP id ew9csp321148lbc; Tue, 11 Nov 2014 12:24:07 -0800 (PST) X-Received: by 10.140.48.233 with SMTP id o96mr53051013qga.47.1415737447053; Tue, 11 Nov 2014 12:24:07 -0800 (PST) Received: from ip-10-35-177-41.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id f18si16970485qaa.59.2014.11.11.12.24.05 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 11 Nov 2014 12:24:07 -0800 (PST) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-35-177-41.ec2.internal) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XoHyt-0003f1-T3; Tue, 11 Nov 2014 20:24:03 +0000 Received: from mail-qg0-f51.google.com ([209.85.192.51]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XoHyn-0003ew-Bw for lng-odp@lists.linaro.org; Tue, 11 Nov 2014 20:23:57 +0000 Received: by mail-qg0-f51.google.com with SMTP id j5so7939598qga.10 for ; Tue, 11 Nov 2014 12:23:52 -0800 (PST) X-Received: by 10.140.20.38 with SMTP id 35mr52554438qgi.29.1415737432146; Tue, 11 Nov 2014 12:23:52 -0800 (PST) Received: from fedora1.holmesfamily.ws ([98.221.136.245]) by mx.google.com with ESMTPSA id k6sm19172051qaz.41.2014.11.11.12.23.51 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 11 Nov 2014 12:23:51 -0800 (PST) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Tue, 11 Nov 2014 15:23:44 -0500 Message-Id: <1415737424-16023-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.1.0 MIME-Version: 1.0 X-Topics: patch Subject: [lng-odp] [PATCH] Add testing.dox X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , Errors-To: lng-odp-bounces@lists.linaro.org Sender: lng-odp-bounces@lists.linaro.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: mike.holmes@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.215.49 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: Mike Holmes --- testing.dox | 313 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 313 insertions(+) create mode 100644 testing.dox diff --git a/testing.dox b/testing.dox new file mode 100644 index 0000000..5248e04 --- /dev/null +++ b/testing.dox @@ -0,0 +1,313 @@ +/* Copyright (c) 2014, Linaro Limited + * All rights reserved + * + * SPDX-License-Identifier BSD-3-Clause + */ + +/** + +@page testing Testing, Verification & Validation + +@tableofcontents + +@sectiooverview Overview +The goals for ODP API testing are: + - Ensure that all platform implementations operate identically from the perspective of the application, except for optional APIs or optional features of an API + - Ensure that a given API performs to the specification defined in the published ODP Architecture & API document in source code control. + - Catch differences in the API definition between the version of the test suite and the implementation + - GCOV or similar tool be used to ensure complete coverage of the API, note that the implementation may have less coverage than 100% but the API must be covered 100%. +Both branch and line coverage will be reported. + - New APIs are considered delivered when there is a test suite to compliment the API definition. + - Framework should be very light and configurable. + - Provide a mechanism to publish compliance to a released API version + +There are three elements to the overall test strategy. + +- @ref compliance +The simplest is the ODP Compliance test suite, this is updated with every commit that adds or modifies an ODP API. +It is intended to be very lightweight and is implemented using CUnit for the APIs, with simple scripting for the documentation. + +- @ref functional +Functional tests that attempt to perform some more in depth processing which has its output verified, for example encrypt and then decrypt a packet, checking that the result matches the input (similar to LTP). +These may require external equipment. + +- @ref benchmarking +Provides no pass fail indication but instead returns a metric on the performance of some portion of the implementation of the API + +@section logical_groups Test suite API groups + +The following logical areas for the API need to be addressed for the 1.0 release cycle. +The API logical groups will be used in the test directory structure and in defining the unit test suites +to gather the tests in to groups of related functionality. + +API logical group | Headers + :--------------- | :--- +Buffer | odp_buffer.h odp_buffer_pool.h +Packet | odp_packet_flags.h odp_packet.h +Classificatio | odp_classification.h +Crypt | odp_crypto.h +IP | not defined +Pkti | not defined +Queue | odp_queue.h +Schedule | odp_schedule.h odp_coremask.h +Shared Memor | odp_shared_memory.h +Synchronizers / Barriers | odp_rwlock.h odp_sync.h odp_atomic.h odp_barrier.h odp_spinlock.h odp_ticketlock.h +Thread | odp_thread.h +Timer | odp_timer.h +Syste | odp_time.h odp_perf.h +Logging / Abor | odp_version.h odp_debug.h odp_system_info.h +Initializatio | odp_init.h + +@section directory Directory structure + +Test contains all the tests that must be passed for a given revision of the API to be declared compliant. +The tests cover: + - the unit tests + - documentation tests + - functional & benchmark tests + +@verbatim +test +. +├── functional + ├── + ├── / +├ +├── documentation + ├── +├ +└── cunit + ├── + ├── / + +@endverbatim + +@section compliance ODP-Compliance test suite +Because this suite is extended with every API extension it needs to be very light weight. +This suite would be run by any new platform attempting to be API compliant, it will try to pass in the obvious combinations of arguments that arise from reading the API definition. +For example a unit test is of the following form. + +@code +/* a is in the range 0 to 10 +returns a *2 or -1 if a is out of range */ +int foo (unsigned int a) +@endcode + +Tests for foo arguments would be + - a=-check that return = -1 + - a=check that return = 0 + - a=check that return = 10 + - a=1check that return = 20 + - a=11 check that return = -1 + +The frame work to support generating these test cases is CUnit which provides batch and interactive operation. +Unit test cases do not use any external equipment. + +@section cunit CUnit +CUnit http://cunit.sourceforge.net/doc/index.html is a system for writing, administering, and running unit tests in C. +It is built as a static library which is linked with the user's testing code. +CUnit uses a simple framework for building test structures, and provides a rich set of assertions for testing common data types. +In addition, several different interfaces are provided for running tests and reporting results. +These include automated interfaces for code-controlled testing and reporting, as well as interactive interfaces allowing the user to run tests and view results dynamically. + +@subsection structure Structure +CUnit is a combination of a platform-independent framework with various user interfaces. +The core framework provides basic support for managing a test registry, suites, and test cases. +The user interfaces facilitate interaction with the framework to run tests and view results. +CUnit is organized like a conventional unit testing framework: + +@verbatim + Test Registry + | + ------------------------------ + | | + Suite '1' . . . . Suite 'N' + | | + --------------- --------------- + | | | | + Test '11' ... Test '1M' Test 'N1' ... Test 'NM' +@endverbatim + +Individual test cases are packaged into suites, which are registered with the active test registry. +Suites can have setup and tear down functions which are automatically called before and after running the suite's tests. +All suites/tests in the registry may be run using a single function call, or selected suites or tests can be run. + +@subsection general_usage General Usage + - A typical sequence of steps for using the CUnit framework is: + - Write functions for tests (and suite init/cleanup if necessary). + - Initialize the test registry - CU_initialize_registry() + - Add suites to the test registry - CU_add_suite() + - Add tests to the suites - CU_add_test() + - Run tests using an appropriate interface, e.g. CU_console_run_tests + - Cleanup the test registry - CU_cleanup_registry + +@code +/* Copyright (c) 2014, Linaro Limited + * All rights reserved. + * + * SPDX-License-Identifier BSD-3-Clause + */ + +#include "odp.h" +#include "CUnit/Basic.h" + +#define DEFAULT_MSG_POOL_SIZE (4*1024*1024) +#define DEFAULT_MSG_SIZE (8) + +static void test_odp_init_global(void) +{ + + int status; + status = odp_init_global(); + CU_ASSERT (status == 0) ; +} + +static int init(void) +{ + printf("ODP version:%s\n",odp_version_api_str()); + return 0; +} + + +int main(void) +{ + CU_pSuite pSuite = NULL; + /* initialize the CUnit test registry */ + if (CUE_SUCCESS != CU_initialize_registry()) + return CU_get_error(); + /* add a suite to the registry */ + pSuite = CU_add_suite("odp_init", init, NULL); + if (NULL == pSuite) { + CU_cleanup_registry(); + return CU_get_error(); + } + /* add the tests to the suite */ + if (NULL == CU_ADD_TEST(pSuite, test_odp_init_global)) { + CU_cleanup_registry(); + return CU_get_error(); + } + /* Run all tests using the CUnit Basic interface */ + CU_basic_set_mode(CU_BRM_VERBOSE); + CU_basic_run_tests(); + CU_cleanup_registry(); + return CU_get_error(); +} +@endcode + +@subsection results Normal results + +@code + CUnit - A unit testing framework for C - Version 2.1-2 + http://cunit.sourceforge.net/ + +ODP version:0.0.1 + +Suite: odp_init + Test: test_odp_init_global ... +Buffer pool init global + pool_entry_s siz 192 + pool_entry_t siz 192 + odp_buffer_hdr_t size 120 + +Queue init ... done +Queue init global + struct queue_entry_s size 192 + queue_entry_t siz 192 + +Schedule init ... done +Timer init ...done +passed + +Run Summary Type Total Ran Passed Failed Inactive + suites 1 1 n/a 0 0 + tests 1 1 1 0 0 + asserts 1 1 1 0 n/a +@endcode + + +@subsection compliance_xml Compliance results (XML) +The CUnit results may also be gathered in XML format, this format may be use to submit an implementations CUnit test case completion for inclusion on the ODP website as compliant to a given release. + +~~~{.xml} +. +. +. +. + . + . + . + . + odp initialization . + . + . + test_odp_init_global . + . + . + . + . + + . + . + Suites . + 1 . + 1 . + - NA - . + 0 . + 0 . + . + . + Test Cases . + 1 . + 1 . + 1 . + 0 . + 0 . + . + . + Assertions . + 1 . + 1 . + 1 . + 0 . + n/a . + . + . + File Generated By CUnit v2.1-2 - Thu Oct 23 15:02:46 2014 + . + +~~~ + +@section functional Functional tests + +These tests are generally more elaborate with a goal of proving a complex functionality. +@verbatim +test +. +├── functional + ├── + ├── / +@endverbatim + - There is no framework for these tests and they generally take command line arguments to modify their behaviour. + - These tests do provide a pass fail indication. + - These tests may require network interfaces and external equipment. + +@section benchmarking Benchmarks + +Benchmarks are currently also stored with the functional tests, this may be re assessed depending on the test volume. +@verbatim +test +. +├── functional + ├── + ├── / +@endverbatim + - These tests are generally more elaborate with a goal of quantifying the capacity of a complex functionality. + - There is no framework for these benchmarks and they generally take command line arguments to modify their behaviour. + - They do not provide a pass fail indication. + +@section test_versioning Test versioning relationship to ODP and versioning + +For ODP to declare for example the 1.0 tag in its git repository it must have passed the corresponding test suit. +When ODP API v3.0 is released it will be validated against the test suite version tagged ODP v3.0 +It is possible that a version of the ODP API is released and that the test suite used has a flaw, in this case the test suite will be re released as v3.0-1 +*/