Revert "Use a variable on the stack to not have a temporary in the call"
[ACE_TAO.git] / ACE / tests / README
blob15b1a525f9b9369ced10dd56bb5b74c4442ecdce
3 This directory contains a battery of "one-button" regression tests
4 that exercise many capabilities of ACE on the numerous platforms upon
5 which it runs.  In addition to providing an automated regression
6 testing facility, these tests also show how to program many of the ACE
7 features.  Building and running the tests is straightforward:
9 1. Build all the tests in ACE_ROOT/tests, e.g., by running mwc.pl on
10    the tests.mwc file and then using whatever build process you've
11    selected to compile all the tests.
13 2. You then need to run all the tests, e.g., by running the perl script
15    $ACE_ROOT/tests/run_test.pl
17    Naturally, make sure that you've installed perl first!
19 3. If everything works then you should see something like this:
21 ./run_test.pl
22 auto_run_tests: tests/ACE_Test
24 auto_run_tests_finished: tests/ACE_Test  Time:1s Result:0
25 auto_run_tests: tests/Aio_Platform_Test
27 auto_run_tests_finished: tests/Aio_Platform_Test  Time:1s Result:0
28 auto_run_tests: tests/Arg_Shifter_Test
30 auto_run_tests_finished: tests/Arg_Shifter_Test  Time:1s Result:0
31 auto_run_tests: tests/ARGV_Test
33 auto_run_tests_finished: tests/ARGV_Test  Time:2s Result:0
34 auto_run_tests: tests/Array_Map_Test
36 auto_run_tests_finished: tests/Array_Map_Test  Time:1s Result:0
37 auto_run_tests: tests/Atomic_Op_Test
39 auto_run_tests_finished: tests/Atomic_Op_Test  Time:9s Result:0
40 auto_run_tests: tests/Auto_Event_Test
42 ....
44 4. By default, all the output from the tests will be stored in separate
45    files in the ./log/ (or .\log\) directory.  You can override
46    this, however, by setting the ACE_TEST_DIR environment variable to
47    another prefix.
48 ________________________________________
50 Please follow these directions when adding a new test to
51 $ACE_ROOT/tests:
53 1.  Use appropriate ACE_START_TEST and ACE_END_TEST macros in main ()
55 2.  Add new project entry to the tests.mpc file.
57 3.  Add test to run_test.lst.
58 ________________________________________
60 The tests have been run on a wide range of platforms (e.g., UNIX,
61 VxWorks, LynxOS, Windows NT/2000/95/98/etc.) and they all work
62 with the following exceptions:
64 1. UPIPE_Test and SPIPE_Test on Windows 95: these tests don't run on
65    Windows 95 since Windows 95 does not support the server side
66    functionality of accepting connections from clients using named pipes.
68 2. Proactor_Test (to be added) on Windows 95: this test does not run on
69    Windows 95 since Windows 95 does not support I/O completion ports.
71 3. Of the tests (believed) relevant to the single threaded port to pSOSim,
72    Sigset_Ops_Test, Sock_Connector_Test, Priority_Reactor_Test,
73    Process_Strategy_Test, and Service_Config_Test are still failing.
74    These are being debugged and will either be corrected or, if there
75    are unsupported features in these tests, removed from the test suite for
76    pSOSim.
78 Notes:
80 1. Each test creates a log file and writes it to the ./log/
81    directory. The default log directory can be changed in the test_config.h
82    file.
84 2. Each log file contains a time stamp of when the test began and also
85    a time stamp indicating when the test ended. If the ending time stamp
86    is missing, you can assume that the test did not succeed.
88 3. None of the tests require any command line parameters. This is in
89    accordance with the keeping the test-suite a "one-button" test. If
90    any of the tests require any variable parameters these are
91    specified in test_config.h.
93 4. Time_Service_Test executes the Time Server and Clerk components as
94    two processes and so the executable "main" need to be present in
95    the netsvcs/servers directory.  Be sure you build
96    $ACE_ROOT/netsvcs/lib/ and $ACE_ROOT/netsvcs/servers before running
97    this test.  These components rely on config files. Two sample
98    config files are also present in the test-suite, namely
99    UNIXserver.conf and UNIXclerk.conf (and for Win32, Win32server.conf
100    and Win32clerk.conf).
102 If you have any questions/suggestions, please open an issue or discussion
103 at https://github.com/DOCGroup/ACE_TAO.