xref: /illumos-gate/usr/src/test/elf-tests/doc/README (revision e75b2cb0)
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 (c) 2012 by Delphix. All rights reserved.
14# Copyright 2015 Nexenta Systems, Inc.  All rights reserved.
15#
16
17ELF Software Generation Utilities Unit Test Suite README
18
191. Building and installing the ELF/SGS Unit Test Suite
202. Running the ELF/SGS Unit Test Suite
213. Test results
22
23--------------------------------------------------------------------------------
24
251. Building and installing the ELF/SGS Unit Test Suite
26
27The ELF/SGS Unit Test Suite runs under the testrunner framework (which can be
28installed as pkg:/system/test/testrunner). To build both the ELF/SGS Unit Test Suite
29and the testrunner without running a full nightly:
30
31	build_machine$ bldenv [-d] <your_env_file>
32	build_machine$ cd $SRC/test
33	build_machine$ dmake install
34	build_machine$ cd $SRC/pkg
35	build_machine$ dmake install
36
37Then set the publisher on the test machine to point to your repository and
38install the ELF/SGS Unit Test Suite.
39
40	test_machine# pkg install pkg:/system/test/elftest
41
42Note, the framework will be installed automatically, as the ELF/SGS Unit Test Suite
43depends on it.
44
452. Running the ELF/SGS Unit Test Suite
46
47The pre-requisites for running the ELF/SGS Unit Test Suite are:
48    None
49
50Once the pre-requisites are satisfied, simply run the elftest script:
51
52	test_machine$ /opt/elf-tests/bin/elftest
53
543. Test results
55
56While the ELF/SGS Unit Test Suite is running, one informational line is printed at
57the end of each test, and a results summary is printed at the end of the run.
58The results summary includes the location of the complete logs, which is of the
59form /var/tmp/test_results/<ISO 8601 date>.
60