1
2SECTIONS:
31. Open POSIX* Test Suite Overview
42. Design Goals
53. Implementation
64. Developer Docs & Resources
75. How to Contribute
86. Who are you?
97. Disclaimer
10
11
12
131. Open POSIX* Test Suite Overview
14-----------------------------------
15
16The POSIX Test Suite is an open source test suite with the goal of
17performing conformance, functional, and stress testing of the IEEE
181003.1-2001 System Interfaces specification in a manner that is
19agnostic to any given implementation.
20
21While active development and testing is currently happening on Linux,
22our choice of portable tools should make this test suite usable on any
23POSIX operating system.
24
25All code is distributed under the GNU General Public License v2.  A
26copy of this license is contained in the COPYING file.
27
28This document gives a brief overview of the test suite, including its
29design goals, implementation, and how to contribute.  Within these
30sections, we describe where to find more detailed information.
31
322. Design Goals
33----------------
34This project was created with the following design goals:
35- Enable assertion based traceability for conformance testing of POSIX
36  specifications.  We wanted to capture enough data to make deterministic
37  statements about our coverage of the POSIX specification.
38
39- Give the ability to send test case source to bug reports to appropriate
40  open source projects when our test cases revealed bugs in those projects.
41  (Meaning we wanted fairly simple, self-contained test cases which
42  illuminated a single failure.)
43
44- Make it easy for test cases to be contributed.
45
463. Implementation
47------------------
48
49This project will cover conformance, functional, stress, performance,
50and speculative testing.  Conformance, functional, and stress tests are
51the only tests formally documented and enabled by our framework, with our
52focus mainly on conformance; however, the other types of testing will be
53added as the need arises.
54
55For more information on these types of testing, under 'Documenation' see:
56HOWTO_ConformanceTest - info on creation and structure of conformance tests
57HOWTO_Functional-     - info on creation and structure of functional
58  StressTest            and stress tests
59
60For additional information on how to build and run the tests in this
61suite, see Documentation/HOWTO_RunTests.
62
63
644. Developer Docs & Resources
65------------------------------
66
67The following files give developers information on how to write test
68cases for the project (under Documentation):
69HOWTO_Assertions      - describes format of the assertions files used to
70                        map test case descriptions to test cases
71HOWTO_BoundaryTest    - information about testing boundary conditions
72HOWTO_CodingGuidelines- describes coding guidelines for this project
73HOWTO_Coverage        - describes format of COVERAGE.<area> files
74HOWTO_DefinitionsTest - ideas behind testing POSIX header files
75HOWTO_ResultCodes     - standardized return codes for tests
76HOWTO_Tagging         - describes how to tag files for inclusion in a release
77
78For additional information on how to build and run the tests in this
79suite, see HOWTO_RunTests.
80
815. How to Contribute
82---------------------
83
84* Patches welcome!
85
86* When you create a new test, please fill out an assertion description
87  if none is available. Create a simple C [.c] or shell script [.sh]
88  snippet that exploits the assertion and returns 0 or !0
89  [passes/fails].
90
91  Please name the file after the assertion it tests-dash-the number of
92  the test [up to you, we can do the naming for you also].
93
94  The code snippets need to be as simple as possible, for the sake of
95  all. Please start them with a commentary briefly describing how
96  you will test the assertion. The idea is that at the end, we can have
97  automatic tools extracting the data from the XML and source files to
98  generate reports.
99
100
1016. Who are you?
102---------------
103
104We are the ones currently developing this:
105
106julie.n.fleischer REMOVE-THIS AT intel DOT com
107rusty.lynch REMOVE-THIS AT intel DOT com
108geoffrey.r.gustafson REMOVE-THIS AT intel DOT com
109inaky.perez-gonzalez REMOVE-THIS AT intel DOT com
110rolla.n.selbak REMOVE-THIS AT intel DOT com
111majid.awad REMOVE-THIS AT intel DOT com
112salwan.searty REMOVE-THIS AT intel DOT com
113sunyi REMOVE-THIS AT users DOT sourceforge DOT net
114
115Some like to say 'Nih!' from time to time ...
116
117
1187. Disclaimer
119--------------
120The Open POSIX Test Suite is not affiliated with the IEEE or The Open Group.
121
122* POSIX (R) is a registered trademark of the IEEE
123