xref: /illumos-gate/usr/src/test/libc-tests/doc/README (revision 2d08521bd15501c8370ba2153b9cca4f094979d0)
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.
29
302. Building and installing this Unit Test Suite
31
32This Test Suite runs under the testrunner framework (which can be installed
33as pkg:/system/test/testrunner). To build both this Unit Test Suite and the
34testrunner without running a full nightly:
35
36	build_machine$ bldenv [-d] <your_env_file>
37	build_machine$ cd $SRC/test
38	build_machine$ dmake install
39	build_machine$ cd $SRC/pkg
40	build_machine$ dmake install
41
42Then set the publisher on the test machine to point to your repository and
43install the Utils Unit Test Suite.
44
45	test_machine# pkg install pkg:/system/test/libctest
46
47Note, the framework will be installed automatically, as this test suite
48depends on it.
49
50Additionally some text locales are required, specifically, en_US.UTF-8,
51de_DE.UTF-8, ja_JP.UTF-8, and ru_RU.UTF-8.  Again, these are listed as
52dependencies and will be automatically installed.
53
543. Running this Unit Test Suite
55
56The pre-requisites for running the this Unit Test Suite are:
57	- Any user may perform these tests.
58	- The en_US.UTF-8, ja_JP.UTF-8, de_DE.UTF-8, and ru_RU.UTF-8 locales
59          must be installed.
60
61Once the pre-requisites are satisfied, simply run the ostest script:
62
63	test_machine$ /opt/util-tests/bin/libctest
64
654. Test results
66
67While the Unit Test Suite is running, one informational line is printed at
68the end of each test, and a results summary is printed at the end of the run.
69The results summary includes the location of the complete logs, which is of the
70form /var/tmp/test_results/<ISO 8601 date>.
71