usr/src/test/libc-tests/doc/README

   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
  17 libc Unit Test Suite README
  18
  19 1. What this Unit Test Suite tests
  20 2. Building and installing this Unit Test Suite
  21 3. Running this Unit Test Suite
  22 4. Test results
  23
  24 --------------------------------------------------------------------------------
  25
  26 1. What this Unit Test Suite tests
  27
  28 This Unit Test Suite is for testing various libc interfaces.  The suite
  29 will test both 32 and 64 bit versions, provided that your kernel supports
  30 both.
  31
  32 2. Building and installing this Unit Test Suite
  33
  34 This Test Suite runs under the testrunner framework (which can be installed
  35 as pkg:/system/test/testrunner). To build both this Unit Test Suite and the
  36 testrunner 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
  44 Then set the publisher on the test machine to point to your repository and
  45 install the Utils Unit Test Suite.
  46
  47         test_machine# pkg install pkg:/system/test/libctest
  48
  49 Note, the framework will be installed automatically, as this test suite
  50 depends on it.
  51
  52 Additionally some text locales are required, specifically, en_US.UTF-8,
  53 de_DE.UTF-8, ja_JP.UTF-8, and ru_RU.UTF-8.  Again, these are listed as
  54 dependencies and will be automatically installed.
  55
  56 3. Running this Unit Test Suite
  57
  58 The pre-requisites for running the this Unit Test Suite are:
  59         - Any user may perform these tests.
  60         - The en_US.UTF-8, en_GB.ISO8859-15, ja_JP.UTF-8, de_DE.UTF-8, and
  61           ru_RU.UTF-8 locales must be installed.
  62
  63 Once the pre-requisites are satisfied, simply run the libctest script:
  64
  65         test_machine$ /opt/libc-tests/bin/libctest
  66
  67 4. Test results
  68
  69 While the Unit Test Suite is running, one informational line is printed at
  70 the end of each test, and a results summary is printed at the end of the run.
  71 The results summary includes the location of the complete logs, which is of the
  72 form /var/tmp/test_results/<ISO 8601 date>.