aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStuart Haslam <stuart.haslam@linaro.org>2015-10-14 10:28:20 +0100
committerMaxim Uvarov <maxim.uvarov@linaro.org>2015-10-15 12:51:27 +0300
commitb575e753595284de911a1b7da18db7eaf08d429a (patch)
tree494e21020c3af32b6530fdb9506c928804467cb8
parent2143920e6a98a88f9a1e2c31d7dca052dadd2a9d (diff)
validation: update READMEHEADmaster
Remove information that's now duplicated in the Implementers' Guide and instead just refer to it. Signed-off-by: Stuart Haslam <stuart.haslam@linaro.org> Reviewed-by: Christophe Milard <christophe.milard@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
-rw-r--r--test/validation/README55
1 files changed, 20 insertions, 35 deletions
diff --git a/test/validation/README b/test/validation/README
index 2d0c258..1baebaa 100644
--- a/test/validation/README
+++ b/test/validation/README
@@ -4,47 +4,32 @@ All rights reserved.
SPDX-License-Identifier: BSD-3-Clause
-To add tests in here, please observe the following rules:
+To add tests in here, please observe the rules listed below. This list
+is a brief overview, for a more detailed explanation of the test
+framework refer to the ODP Implementers' Guide, which can built as
+follows:
-1. Tests should be placed in the directory of the module they belong to.
+ ./configure --enable-user-guides
+ make
+Output will be in doc/output/. If this fails, check the documentation
+section of the DEPENDENCIES file.
-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/<platform>/test*)
-
-
-3. If a new ODP API module is created, please update the Makefile.am and
- the odptest.h file
+Rules for all tests under this tree:
+1. Tests must be placed in the directory of the module they belong to.
-4. Respect the following name convention for the names exported in the library:
+2. Tests must be platform agnostic, i.e.
- * Tests, i.e. functions which are used in CUNIT test suites are named:
- *<Module>_test_*
+ - should be written in plain C only.
+ - may only use C standard library functions, CUnit functions and of
+ course ODP functions
+ - should be expected to pass on all ODP implementations
- * Test arrays, i.e. arrays of CU_TestInfo, listing the test functions
- belonging to a suite, are called:
- <Module>_suite[_*]
- where the possible suffix can be used if many suites are declared.
-
- * CUNIT suite init and termination functions are called:
- <Module>_suite[_*]_init() and <Module>_suite[_*]_term()
- respectively.
-
- * Suite arrays, i.e. arrays of CU_SuiteInfo used in executables are called:
- <Module>_suites[_*]
- where the possible suffix identifies the executable using it, if many.
+ Tests that do not follow these rules should be placed in the platform
+ specific test area (currently platform/<platform>/test/).
- * Main executable function(s), are called:
- <Module>_main[_*]*
- where the possible suffix identifies the executable using it
+3. If a new ODP API module is created, please update the Makefile.am.
- * Init/term function for the whole executable are called:
- <Module>_init
- <Module>_term
+4. Symbols exported from test libraries must respect the naming
+ convention detailed in the ODP Implementers' Guide.