xref: /titanic_41/usr/src/test/libc-tests/doc/README (revision 62c3776affc53153ce74e14a6e7ce91950c28102)
1*62c3776aSGarrett D'Amore#
2*62c3776aSGarrett D'Amore# This file and its contents are supplied under the terms of the
3*62c3776aSGarrett D'Amore# Common Development and Distribution License ("CDDL"), version 1.0.
4*62c3776aSGarrett D'Amore# You may only use this file in accordance with the terms of version
5*62c3776aSGarrett D'Amore# 1.0 of the CDDL.
6*62c3776aSGarrett D'Amore#
7*62c3776aSGarrett D'Amore# A full copy of the text of the CDDL should have accompanied this
8*62c3776aSGarrett D'Amore# source.  A copy of the CDDL is also available via the Internet at
9*62c3776aSGarrett D'Amore# http://www.illumos.org/license/CDDL.
10*62c3776aSGarrett D'Amore#
11*62c3776aSGarrett D'Amore
12*62c3776aSGarrett D'Amore#
13*62c3776aSGarrett D'Amore# Copyright 2014 Garrett D'Amore <garrett@damore.org>
14*62c3776aSGarrett D'Amore# Copyright (c) 2012 by Delphix. All rights reserved.
15*62c3776aSGarrett D'Amore#
16*62c3776aSGarrett D'Amore
17*62c3776aSGarrett D'Amorelibc Unit Test Suite README
18*62c3776aSGarrett D'Amore
19*62c3776aSGarrett D'Amore1. What this Unit Test Suite tests
20*62c3776aSGarrett D'Amore2. Building and installing this Unit Test Suite
21*62c3776aSGarrett D'Amore3. Running this Unit Test Suite
22*62c3776aSGarrett D'Amore4. Test results
23*62c3776aSGarrett D'Amore
24*62c3776aSGarrett D'Amore--------------------------------------------------------------------------------
25*62c3776aSGarrett D'Amore
26*62c3776aSGarrett D'Amore1. What this Unit Test Suite tests
27*62c3776aSGarrett D'Amore
28*62c3776aSGarrett D'AmoreThis Unit Test Suite is for testing various libc interfaces.
29*62c3776aSGarrett D'Amore
30*62c3776aSGarrett D'Amore2. Building and installing this Unit Test Suite
31*62c3776aSGarrett D'Amore
32*62c3776aSGarrett D'AmoreThis Test Suite runs under the testrunner framework (which can be installed
33*62c3776aSGarrett D'Amoreas pkg:/system/test/testrunner). To build both this Unit Test Suite and the
34*62c3776aSGarrett D'Amoretestrunner without running a full nightly:
35*62c3776aSGarrett D'Amore
36*62c3776aSGarrett D'Amore	build_machine$ bldenv [-d] <your_env_file>
37*62c3776aSGarrett D'Amore	build_machine$ cd $SRC/test
38*62c3776aSGarrett D'Amore	build_machine$ dmake install
39*62c3776aSGarrett D'Amore	build_machine$ cd $SRC/pkg
40*62c3776aSGarrett D'Amore	build_machine$ dmake install
41*62c3776aSGarrett D'Amore
42*62c3776aSGarrett D'AmoreThen set the publisher on the test machine to point to your repository and
43*62c3776aSGarrett D'Amoreinstall the Utils Unit Test Suite.
44*62c3776aSGarrett D'Amore
45*62c3776aSGarrett D'Amore	test_machine# pkg install pkg:/system/test/libctest
46*62c3776aSGarrett D'Amore
47*62c3776aSGarrett D'AmoreNote, the framework will be installed automatically, as this test suite
48*62c3776aSGarrett D'Amoredepends on it.
49*62c3776aSGarrett D'Amore
50*62c3776aSGarrett D'AmoreAdditionally some text locales are required, specifically, en_US.UTF-8,
51*62c3776aSGarrett D'Amorede_DE.UTF-8, ja_JP.UTF-8, and ru_RU.UTF-8.  Again, these are listed as
52*62c3776aSGarrett D'Amoredependencies and will be automatically installed.
53*62c3776aSGarrett D'Amore
54*62c3776aSGarrett D'Amore3. Running this Unit Test Suite
55*62c3776aSGarrett D'Amore
56*62c3776aSGarrett D'AmoreThe pre-requisites for running the this Unit Test Suite are:
57*62c3776aSGarrett D'Amore	- Any user may perform these tests.
58*62c3776aSGarrett D'Amore	- The en_US.UTF-8, ja_JP.UTF-8, de_DE.UTF-8, and ru_RU.UTF-8 locales
59*62c3776aSGarrett D'Amore          must be installed.
60*62c3776aSGarrett D'Amore
61*62c3776aSGarrett D'AmoreOnce the pre-requisites are satisfied, simply run the ostest script:
62*62c3776aSGarrett D'Amore
63*62c3776aSGarrett D'Amore	test_machine$ /opt/util-tests/bin/libctest
64*62c3776aSGarrett D'Amore
65*62c3776aSGarrett D'Amore4. Test results
66*62c3776aSGarrett D'Amore
67*62c3776aSGarrett D'AmoreWhile the Unit Test Suite is running, one informational line is printed at
68*62c3776aSGarrett D'Amorethe end of each test, and a results summary is printed at the end of the run.
69*62c3776aSGarrett D'AmoreThe results summary includes the location of the complete logs, which is of the
70*62c3776aSGarrett D'Amoreform /var/tmp/test_results/<ISO 8601 date>.
71