xref: /illumos-gate/usr/src/test/libc-tests/doc/README (revision 804635d7)
1#
2# This file and its contents are supplied under the terms of the
3# Common Development and Distribution License ("CDDL"), version 1.0.
4# You may only use this file in accordance with the terms of version
5# 1.0 of the CDDL.
6#
7# A full copy of the text of the CDDL should have accompanied this
8# source.  A copy of the CDDL is also available via the Internet at
9# http://www.illumos.org/license/CDDL.
10#
11
12#
13# Copyright 2014 Garrett D'Amore <garrett@damore.org>
14# Copyright (c) 2012 by Delphix. All rights reserved.
15#
16
17libc Unit Test Suite README
18
191. What this Unit Test Suite tests
202. Building and installing this Unit Test Suite
213. Running this Unit Test Suite
224. Test results
23
24--------------------------------------------------------------------------------
25
261. What this Unit Test Suite tests
27
28This Unit Test Suite is for testing various libc interfaces.  The suite
29will test both 32 and 64 bit versions, provided that your kernel supports
30both.
31
322. Building and installing this Unit Test Suite
33
34This Test Suite runs under the testrunner framework (which can be installed
35as pkg:/system/test/testrunner). To build both this Unit Test Suite and the
36testrunner without running a full nightly:
37
38	build_machine$ bldenv [-d] <your_env_file>
39	build_machine$ cd $SRC/test
40	build_machine$ dmake install
41	build_machine$ cd $SRC/pkg
42	build_machine$ dmake install
43
44Then set the publisher on the test machine to point to your repository and
45install the Utils Unit Test Suite.
46
47	test_machine# pkg install pkg:/system/test/libctest
48
49Note, the framework will be installed automatically, as this test suite
50depends on it.
51
52Additionally some text locales are required, specifically, ar_AE.UTF-8,
53de_DE.UTF-8, en_US.UTF-8, ja_JP.UTF-8, and ru_RU.UTF-8.  Again, these are
54listed as dependencies and will be automatically installed.
55
563. Running this Unit Test Suite
57
58The pre-requisites for running the this Unit Test Suite are:
59	- Any user may perform these tests.
60	- The ar_AE.UTF-8, de_DE.UTF-8, en_US.UTF-8, en_GB.ISO8859-15,
61	  ja_JP.UTF-8, and ru_RU.UTF-8 locales must be installed.
62
63Once the pre-requisites are satisfied, simply run the libctest script:
64
65	test_machine$ /opt/libc-tests/bin/libctest
66
674. Test results
68
69While the Unit Test Suite is running, one informational line is printed at
70the end of each test, and a results summary is printed at the end of the run.
71The results summary includes the location of the complete logs, which is of the
72form /var/tmp/test_results/<ISO 8601 date>.
73