xref: /illumos-gate/usr/src/test/util-tests/doc/README (revision d48be21240dfd051b689384ce2b23479d757f2d8)
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
17Utils Unit Test Suite README
18
191. What the Utils Unit Test Suite tests
202. Building and installing the Utils Unit Test Suite
213. Running the Utils Unit Test Suite
224. Test results
23
24--------------------------------------------------------------------------------
25
261. What the Utils Unit Test Suite tests
27
28The Utils unit test suite is for testing standard shell / POSIX utilities.
29For example utilities such as "printf" are tested.
30
312. Building and installing the Utils Unit Test Suite
32
33The Utils Unit Test Suite runs under the testrunner framework (which can be
34installed as pkg:/system/test/testrunner). To build both the Utils Unit Test
35Suite and the testrunner without running a full nightly:
36
37	build_machine$ bldenv [-d] <your_env_file>
38	build_machine$ cd $SRC/test
39	build_machine$ dmake install
40	build_machine$ cd $SRC/pkg
41	build_machine$ dmake install
42
43Then set the publisher on the test machine to point to your repository and
44install the Utils Unit Test Suite.
45
46	test_machine# pkg install pkg:/system/test/utiltest
47
48Note, the framework will be installed automatically, as the Utils Unit Test
49Suite depends on it.
50
513. Running the Utils Unit Test Suite
52
53The pre-requisites for running the OS Unit Test Suite are:
54	- Any user may perform these tests.
55
56Once the pre-requisites are satisfied, simply run the ostest script:
57
58	test_machine$ /opt/util-tests/bin/utiltest
59
604. Test results
61
62While the OS Unit Test Suite is running, one informational line is printed at
63the end of each test, and a results summary is printed at the end of the run.
64The results summary includes the location of the complete logs, which is of the
65form /var/tmp/test_results/<ISO 8601 date>.
66