1KYUA.CONF(5)                BSD File Formats Manual               KYUA.CONF(5)
2

NAME

4     kyua.conf — Configuration file for the kyua tool
5

SYNOPSIS

7     syntax(int version);
8
9     Variables: architecture, platform, test_suites, unprivileged_user.
10

DESCRIPTION

12     The configuration of Kyua is a simple collection of key/value pairs
13     called configuration variables.  There are configuration variables that
14     have a special meaning to the runtime engine implemented by kyua(1), and
15     there are variables that only have meaning in the context of particular
16     test suites.
17
18     Configuration files are Lua scripts.  In their most basic form, their
19     whole purpose is to assign values to variables, but the user has the
20     freedom to implement any logic he desires to compute such values.
21
22   File versioning
23     Every kyua.conf file starts with a call to syntax(int version).  This
24     call determines the specific schema used by the file so that future back‐
25     wards-incompatible modifications to the file can be introduced.
26
27     Any new kyua.conf file should set version to ‘2’.
28
29   Runtime configuration variables
30     The following variables are internally recognized by kyua(1):
31
32           architecture
33               Name of the system architecture (aka processor type).
34
35           parallelism
36               Maximum number of test cases to execute concurrently.
37
38           platform
39               Name of the system platform (aka machine type).
40
41           unprivileged_user
42               Name or UID of the unprivileged user.
43
44               If set, the given user must exist in the system and his privi‐
45               leges will be used to run test cases that need regular privi‐
46               leges when kyua(1) is executed as root.
47
48   Test-suite configuration variables
49     Each test suite is able to recognize arbitrary configuration variables,
50     and their type and meaning is specific to the test suite.  Because the
51     existence and naming of these variables depends on every test suite, this
52     manual page cannot detail them; please refer to the documentation of the
53     test suite you are working with for more details on this topic.
54
55     Test-suite specific configuration variables are defined inside the
56     test_suites dictionary.  The general syntax is:
57
58           test_suites.<test_suite_name>.<variable_name> = <value>
59
60     where test_suite_name is the name of the test suite, variable_name is the
61     name of the variable to set, and value is a value.  The value can be a
62     string, an integer or a boolean.
63

FILES

65     /usr/share/kyua/examples/kyua.conf
66         Sample configuration file.
67

EXAMPLES

69     The following kyua.conf shows a simple configuration file that overrides
70     a bunch of the built-in kyua(1) configuration variables:
71
72           syntax(2)
73
74           architecture = 'x86_64'
75           platform = 'amd64'
76
77     The following is a more complex example that introduces the definition of
78     per-test suite configuration variables:
79
80           syntax(2)
81
82           -- Assign built-in variables.
83           unprivileged_user = '_tests'
84
85           -- Assign test-suite variables.  All of these must be strings.
86           test_suites.NetBSD.file_systems = 'ffs ext2fs'
87           test_suites.X11.graphics_driver = 'vesa'
88

SEE ALSO

90     kyua(1)
91
92BSD                            February 20, 2015                           BSD
Impressum