contrib/kyua/doc/results-files.mdoc

   1 .\" Copyright 2014 The Kyua Authors.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions are
   6 .\" met:
   7 .\"
   8 .\" * Redistributions of source code must retain the above copyright
   9 .\"   notice, this list of conditions and the following disclaimer.
  10 .\" * Redistributions in binary form must reproduce the above copyright
  11 .\"   notice, this list of conditions and the following disclaimer in the
  12 .\"   documentation and/or other materials provided with the distribution.
  13 .\" * Neither the name of Google Inc. nor the names of its contributors
  14 .\"   may be used to endorse or promote products derived from this software
  15 .\"   without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 .\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 .\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 .\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 Results files contain, as their name implies, the results of the execution of a
  29 test suite.
  30 Each test suite executed by
  31 .Xr kyua-test 1
  32 generates a new results file, and such results files can be loaded later on by
  33 inspection commands such as
  34 .Xr kyua-report 1
  35 to analyze their contents.
  36 .Pp
  37 Results files support identifier-based lookups and also path name lookups.
  38 The differences between the two are described below.
  39 .Pp
  40 The default naming scheme for the results files provides simple support for
  41 identifier-based lookups and historical recording of test suite runs.
  42 Each results file is given an identifier derived from the test suite that
  43 generated it and the time the test suite was run.
  44 Kyua can later look up results files by these fields.
  45 .Pp
  46 The identifier follows this pattern:
  47 .Bd -literal -offset indent
  48 \*(Lttest_suite\*(Gt.\*(LtYYYYMMDD\*(Gt-\*(LtHHMMSS\*(Gt-\*(Ltuuuuuu\*(Gt
  49 .Ed
  50 .Pp
  51 where
  52 .Sq test_suite
  53 is the path to the root of the test suite that was run with all slashes replaced
  54 by underscores and
  55 .Sq YYYYMMDD-HHMMSS-uuuuuu
  56 is a timestamp with microsecond resolution.
  57 .Pp
  58 When using the default naming scheme, results files are stored in the
  59 .Pa ~/.kyua/store/
  60 subdirectory and each file holds a name of the form:
  61 .Bd -literal -offset indent
  62 ~/.kyua/store/results.\*(Ltidentifier\*(Gt.db
  63 .Ed
  64 .Pp
  65 Results files are simple SQLite databases with the schema described in the
  66 .Pa __STOREDIR__/schema_v?.sql
  67 files.
  68 For details on the schema, please refer to the heavily commented SQL file.