2007-02-06 22:25:36 +01:00
|
|
|
|
<chapter xmlns="http://docbook.org/ns/docbook"
|
|
|
|
|
xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
|
|
|
|
|
|
|
|
<title>Development</title>
|
|
|
|
|
|
2013-10-31 20:52:40 +01:00
|
|
|
|
<para>This chapter describes how you can modify and extend
|
2007-02-06 22:25:36 +01:00
|
|
|
|
NixOS.</para>
|
|
|
|
|
|
|
|
|
|
|
2012-05-14 05:59:38 +02:00
|
|
|
|
<!--===============================================================-->
|
|
|
|
|
|
|
|
|
|
<section>
|
|
|
|
|
|
2013-10-31 20:52:40 +01:00
|
|
|
|
<title>Getting the sources</title>
|
2012-05-14 05:59:38 +02:00
|
|
|
|
|
|
|
|
|
<para>By default, NixOS’s <command>nixos-rebuild</command> command
|
|
|
|
|
uses the NixOS and Nixpkgs sources provided by the
|
|
|
|
|
<literal>nixos-unstable</literal> channel (kept in
|
|
|
|
|
<filename>/nix/var/nix/profiles/per-user/root/channels/nixos</filename>).
|
|
|
|
|
To modify NixOS, however, you should check out the latest sources from
|
2013-08-06 18:22:20 +02:00
|
|
|
|
Git. This is done using the following command:
|
2012-05-14 05:59:38 +02:00
|
|
|
|
|
|
|
|
|
<screen>
|
2012-05-14 06:12:43 +02:00
|
|
|
|
$ nixos-checkout <replaceable>/my/sources</replaceable>
|
2012-05-14 05:59:38 +02:00
|
|
|
|
</screen>
|
|
|
|
|
|
2013-08-06 18:22:20 +02:00
|
|
|
|
or
|
|
|
|
|
|
|
|
|
|
<screen>
|
|
|
|
|
$ mkdir -p <replaceable>/my/sources</replaceable>
|
|
|
|
|
$ cd <replaceable>/my/sources</replaceable>
|
|
|
|
|
$ nix-env -i git
|
|
|
|
|
$ git clone git://github.com/NixOS/nixpkgs.git
|
|
|
|
|
</screen>
|
|
|
|
|
|
2012-05-14 05:59:38 +02:00
|
|
|
|
This will check out the latest NixOS sources to
|
2013-10-31 20:52:40 +01:00
|
|
|
|
<filename><replaceable>/my/sources</replaceable>/nixpkgs/nixos</filename>
|
|
|
|
|
and the Nixpkgs sources to
|
2012-05-14 06:12:43 +02:00
|
|
|
|
<filename><replaceable>/my/sources</replaceable>/nixpkgs</filename>.
|
2013-10-31 20:52:40 +01:00
|
|
|
|
(The NixOS source tree lives in a subdirectory of the Nixpkgs
|
|
|
|
|
repository.) If you want to rebuild your system using your (modified)
|
|
|
|
|
sources, you need to tell <command>nixos-rebuild</command> about them
|
|
|
|
|
using the <option>-I</option> flag:
|
2012-05-14 05:59:38 +02:00
|
|
|
|
|
|
|
|
|
<screen>
|
2013-10-30 11:02:55 +01:00
|
|
|
|
$ nixos-rebuild switch -I nixpkgs=<replaceable>/my/sources</replaceable>/nixpkgs
|
2012-05-14 05:59:38 +02:00
|
|
|
|
</screen>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
2013-10-31 20:52:40 +01:00
|
|
|
|
<para>If you want <command>nix-env</command> to use the expressions in
|
|
|
|
|
<replaceable>/my/sources</replaceable>, use <command>nix-env -f
|
|
|
|
|
<replaceable>/my/sources</replaceable>/nixpkgs</command>, or change
|
|
|
|
|
the default by adding a symlink in
|
2013-08-11 09:42:03 +02:00
|
|
|
|
<filename>~/.nix-defexpr</filename>:
|
|
|
|
|
|
|
|
|
|
<screen>
|
|
|
|
|
$ ln -s <replaceable>/my/sources</replaceable>/nixpkgs ~/.nix-defexpr/nixpkgs
|
|
|
|
|
</screen>
|
|
|
|
|
|
2013-10-31 20:52:40 +01:00
|
|
|
|
You may want to delete the symlink
|
|
|
|
|
<filename>~/.nix-defexpr/channels_root</filename> to prevent root’s
|
|
|
|
|
NixOS channel from clashing with your own tree.</para>
|
2013-08-11 09:42:03 +02:00
|
|
|
|
|
2013-10-31 20:52:40 +01:00
|
|
|
|
<!-- FIXME: not sure what this means.
|
2013-08-11 09:42:03 +02:00
|
|
|
|
<para>You should not pass the base directory
|
|
|
|
|
<filename><replaceable>/my/sources</replaceable></filename>
|
|
|
|
|
to <command>nix-env</command>, as it will break after interpreting expressions
|
|
|
|
|
in <filename>nixos/</filename> as packages.</para>
|
2013-10-31 20:52:40 +01:00
|
|
|
|
-->
|
2013-08-11 09:42:03 +02:00
|
|
|
|
|
2012-05-14 05:59:38 +02:00
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
2011-05-01 12:24:37 +02:00
|
|
|
|
<!--===============================================================-->
|
|
|
|
|
|
2009-01-25 16:49:27 +01:00
|
|
|
|
<section>
|
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<title>Writing NixOS modules</title>
|
|
|
|
|
|
|
|
|
|
<para>NixOS has a modular system for declarative configuration. This
|
|
|
|
|
system combines multiple <emphasis>modules</emphasis> to produce the
|
|
|
|
|
full system configuration. One of the modules that constitute the
|
|
|
|
|
configuration is <filename>/etc/nixos/configuration.nix</filename>.
|
|
|
|
|
Most of the others live in the <link
|
|
|
|
|
xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/modules"><filename>nixos/modules</filename></link>
|
|
|
|
|
subdirectory of the Nixpkgs tree.</para>
|
|
|
|
|
|
|
|
|
|
<para>Each NixOS module is a file that handles one logical aspect of
|
|
|
|
|
the configuration, such as a specific kind of hardware, a service, or
|
|
|
|
|
network settings. A module configuration does not have to handle
|
|
|
|
|
everything from scratch; it can use the functionality provided by
|
|
|
|
|
other modules for its implementation. Thus a module can
|
|
|
|
|
<emphasis>declare</emphasis> options that can be used by other
|
|
|
|
|
modules, and conversely can <emphasis>define</emphasis> options
|
|
|
|
|
provided by other modules in its own implementation. For example, the
|
|
|
|
|
module <link
|
|
|
|
|
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/security/pam.nix"><filename>pam.nix</filename></link>
|
|
|
|
|
declares the option <option>security.pam.services</option> that allows
|
|
|
|
|
other modules (e.g. <link
|
|
|
|
|
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/networking/ssh/sshd.nix"><filename>sshd.nix</filename></link>)
|
|
|
|
|
to define PAM services; and it defines the option
|
|
|
|
|
<option>environment.etc</option> (declared by <link
|
|
|
|
|
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/system/etc/etc.nix"><filename>etc.nix</filename></link>)
|
|
|
|
|
to cause files to be created in
|
|
|
|
|
<filename>/etc/pam.d</filename>.</para>
|
|
|
|
|
|
|
|
|
|
<para xml:id="para-module-syn">In <xref
|
|
|
|
|
linkend="sec-configuration-syntax"/>, we saw the following structure
|
|
|
|
|
of NixOS modules:
|
|
|
|
|
|
|
|
|
|
<programlisting>
|
|
|
|
|
{ config, pkgs, ... }:
|
|
|
|
|
|
|
|
|
|
{ <replaceable>option definitions</replaceable>
|
|
|
|
|
}
|
|
|
|
|
</programlisting>
|
|
|
|
|
|
|
|
|
|
This is actually an <emphasis>abbreviated</emphasis> form of module
|
|
|
|
|
that only defines options, but does not declare any. The structure of
|
|
|
|
|
full NixOS modules is shown in <xref linkend='ex-module-syntax' />.</para>
|
|
|
|
|
|
|
|
|
|
<example xml:id='ex-module-syntax'><title>Structure of NixOS modules</title>
|
2011-05-01 12:24:37 +02:00
|
|
|
|
<programlisting>
|
2012-05-14 05:59:38 +02:00
|
|
|
|
{ config, pkgs, ... }: <co xml:id='module-syntax-1' />
|
2009-01-25 16:49:27 +01:00
|
|
|
|
|
2011-05-01 12:24:37 +02:00
|
|
|
|
{
|
2012-05-14 05:59:38 +02:00
|
|
|
|
imports =
|
2013-10-31 23:01:07 +01:00
|
|
|
|
[ <replaceable>paths of other modules</replaceable> <co xml:id='module-syntax-2' />
|
2012-05-14 05:59:38 +02:00
|
|
|
|
];
|
2009-01-25 16:49:27 +01:00
|
|
|
|
|
2011-05-01 12:24:37 +02:00
|
|
|
|
options = {
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<replaceable>option declarations</replaceable> <co xml:id='module-syntax-3' />
|
2011-05-01 12:24:37 +02:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
config = {
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<replaceable>option definitions</replaceable> <co xml:id='module-syntax-4' />
|
2011-05-01 12:24:37 +02:00
|
|
|
|
};
|
|
|
|
|
}</programlisting>
|
|
|
|
|
</example>
|
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<para>The meaning of each part is as follows.
|
2011-05-01 12:24:37 +02:00
|
|
|
|
|
|
|
|
|
<calloutlist>
|
|
|
|
|
<callout arearefs='module-syntax-1'>
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<para>This line makes the current Nix expression a function. The
|
|
|
|
|
variable <varname>pkgs</varname> contains Nixpkgs, while
|
|
|
|
|
<varname>config</varname> contains the full system configuration.
|
|
|
|
|
This line can be omitted if there is no reference to
|
|
|
|
|
<varname>pkgs</varname> and <varname>config</varname> inside the
|
|
|
|
|
module.</para>
|
2011-05-01 12:24:37 +02:00
|
|
|
|
</callout>
|
|
|
|
|
|
|
|
|
|
<callout arearefs='module-syntax-2'>
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<para>This list enumerates the paths to other NixOS modules that
|
|
|
|
|
should be included in the evaluation of the system configuration.
|
|
|
|
|
A default set of modules is defined in the file
|
|
|
|
|
<filename>modules/module-list.nix</filename>. These don't need to
|
|
|
|
|
be added in the import list.</para>
|
2011-05-01 12:24:37 +02:00
|
|
|
|
</callout>
|
|
|
|
|
|
|
|
|
|
<callout arearefs='module-syntax-3'>
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<para>The attribute <varname>options</varname> is a nested set of
|
|
|
|
|
<emphasis>option declarations</emphasis> (described below).</para>
|
2011-05-01 12:24:37 +02:00
|
|
|
|
</callout>
|
|
|
|
|
|
|
|
|
|
<callout arearefs='module-syntax-4'>
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<para>The attribute <varname>config</varname> is a nested set of
|
|
|
|
|
<emphasis>option definitions</emphasis> (also described
|
|
|
|
|
below).</para>
|
2011-05-01 12:24:37 +02:00
|
|
|
|
</callout>
|
|
|
|
|
</calloutlist>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<para><xref linkend='locate-example' /> shows a module that handles
|
|
|
|
|
the regular update of the “locate” database, an index of all files in
|
|
|
|
|
the file system. This module declares two options that can be defined
|
|
|
|
|
by other modules (typically the user’s
|
|
|
|
|
<filename>configuration.nix</filename>):
|
|
|
|
|
<option>services.locate.enable</option> (whether the database should
|
|
|
|
|
be updated) and <option>services.locate.period</option> (when the
|
|
|
|
|
update should be done). It implements its functionality by defining
|
|
|
|
|
two options declared by other modules:
|
|
|
|
|
<option>systemd.services</option> (the set of all systemd services)
|
|
|
|
|
and <option>services.cron.systemCronJobs</option> (the list of
|
|
|
|
|
commands to be executed periodically by <command>cron</command>).</para>
|
|
|
|
|
|
|
|
|
|
<example xml:id='locate-example'><title>NixOS module for the “locate” service</title>
|
2009-01-25 16:49:27 +01:00
|
|
|
|
<programlisting>
|
2012-05-14 05:59:38 +02:00
|
|
|
|
{ config, pkgs, ... }:
|
2009-01-25 16:49:27 +01:00
|
|
|
|
|
2011-05-01 12:24:37 +02:00
|
|
|
|
with pkgs.lib;
|
2009-01-25 16:49:27 +01:00
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
let locatedb = "/var/cache/locatedb"; in
|
2009-01-25 16:49:27 +01:00
|
|
|
|
|
2009-09-14 00:13:19 +02:00
|
|
|
|
{
|
2011-05-01 12:24:37 +02:00
|
|
|
|
options = {
|
2013-10-31 23:01:07 +01:00
|
|
|
|
|
2009-09-14 00:13:19 +02:00
|
|
|
|
services.locate = {
|
2013-10-31 23:01:07 +01:00
|
|
|
|
|
2009-09-14 00:13:19 +02:00
|
|
|
|
enable = mkOption {
|
2013-10-31 23:01:07 +01:00
|
|
|
|
type = types.bool;
|
2009-09-14 00:13:19 +02:00
|
|
|
|
default = false;
|
|
|
|
|
description = ''
|
|
|
|
|
If enabled, NixOS will periodically update the database of
|
|
|
|
|
files used by the <command>locate</command> command.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
period = mkOption {
|
2013-10-30 11:02:04 +01:00
|
|
|
|
type = types.str;
|
2013-10-31 23:01:07 +01:00
|
|
|
|
default = "15 02 * * *";
|
2009-09-14 00:13:19 +02:00
|
|
|
|
description = ''
|
|
|
|
|
This option defines (in the format used by cron) when the
|
2013-10-31 23:01:07 +01:00
|
|
|
|
locate database is updated. The default is to update at
|
|
|
|
|
02:15 at night every day.
|
2009-09-14 00:13:19 +02:00
|
|
|
|
'';
|
|
|
|
|
};
|
2013-10-31 23:01:07 +01:00
|
|
|
|
|
2009-09-14 00:13:19 +02:00
|
|
|
|
};
|
2013-10-31 23:01:07 +01:00
|
|
|
|
|
2009-09-14 00:13:19 +02:00
|
|
|
|
};
|
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
config = {
|
|
|
|
|
|
|
|
|
|
systemd.services.update-locatedb =
|
|
|
|
|
{ description = "Update Locate Database";
|
|
|
|
|
path = [ pkgs.su ];
|
|
|
|
|
script =
|
|
|
|
|
''
|
|
|
|
|
mkdir -m 0755 -p $(dirname ${locatedb})
|
|
|
|
|
exec updatedb --localuser=nobody --output=${locatedb} --prunepaths='/tmp /var/tmp /media /run'
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
services.cron.systemCronJobs = optional config.services.locate.enable
|
|
|
|
|
"${config.services.locate.period} root ${config.systemd.package}/bin/systemctl start update-locatedb.service";
|
|
|
|
|
|
2009-01-25 16:49:27 +01:00
|
|
|
|
};
|
|
|
|
|
}</programlisting>
|
|
|
|
|
</example>
|
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<section><title>Option declarations</title>
|
|
|
|
|
|
|
|
|
|
<para>An option declaration specifies the name, type and description
|
|
|
|
|
of a NixOS configuration option. It is illegal to define an option
|
|
|
|
|
that hasn’t been declared in any module. A option declaration
|
|
|
|
|
generally looks like this:
|
|
|
|
|
|
|
|
|
|
<programlisting>
|
|
|
|
|
options = {
|
|
|
|
|
<replaceable>name</replaceable> = mkOption {
|
|
|
|
|
type = <replaceable>type specification</replaceable>;
|
|
|
|
|
default = <replaceable>default value</replaceable>;
|
|
|
|
|
example = <replaceable>example value</replaceable>;
|
|
|
|
|
description = "<replaceable>Description for use in the NixOS manual.</replaceable>";
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
</programlisting>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>The function <varname>mkOption</varname> accepts the following arguments.
|
|
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>type</varname></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>The type of the option (see below). It may be omitted,
|
|
|
|
|
but that’s not advisable since it may lead to errors that are
|
|
|
|
|
hard to diagnose.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>default</varname></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>The default value used if no value is defined by any
|
|
|
|
|
module. A default is not required; in that case, if the option
|
|
|
|
|
value is ever used, an error will be thrown.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>example</varname></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>An example value that will be shown in the NixOS manual.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>description</varname></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>A textual description of the option, in DocBook format,
|
|
|
|
|
that will be included in the NixOS manual.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
</variablelist>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>Here is a non-exhaustive list of option types:
|
|
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>types.bool</varname></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>A Boolean.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>types.int</varname></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>An integer.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>types.str</varname></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>A string.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>types.lines</varname></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>A string. If there are multiple definitions, they are
|
|
|
|
|
concatenated, with newline characters in between.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>types.path</varname></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>A path, defined as anything that, when coerced to a
|
|
|
|
|
string, starts with a slash. This includes derivations.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>types.listOf</varname> <replaceable>t</replaceable></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>A list of elements of type <replaceable>t</replaceable>
|
|
|
|
|
(e.g., <literal>types.listOf types.str</literal> is a list of
|
|
|
|
|
strings). Multiple definitions are concatenated together.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>types.attrsOf</varname> <replaceable>t</replaceable></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>A set of elements of type <replaceable>t</replaceable>
|
|
|
|
|
(e.g., <literal>types.attrsOf types.int</literal> is a set of
|
|
|
|
|
name/value pairs, the values being integers).</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>types.nullOr</varname> <replaceable>t</replaceable></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>Either the value <literal>null</literal> or something of
|
|
|
|
|
type <replaceable>t</replaceable>.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
</variablelist>
|
|
|
|
|
|
|
|
|
|
You can also create new types using the function
|
|
|
|
|
<varname>mkOptionType</varname>. See
|
|
|
|
|
<filename>lib/types.nix</filename> in Nixpkgs for details.</para>
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section><title>Option definitions</title>
|
|
|
|
|
|
|
|
|
|
<para>Option definitions are generally straight-forward bindings of values to option names, like
|
|
|
|
|
|
|
|
|
|
<programlisting>
|
|
|
|
|
config = {
|
|
|
|
|
services.httpd.enable = true;
|
|
|
|
|
};
|
|
|
|
|
</programlisting>
|
|
|
|
|
|
|
|
|
|
However, sometimes you need to wrap an option definition or set of
|
|
|
|
|
option definitions in a <emphasis>property</emphasis> to achieve
|
|
|
|
|
certain effects:</para>
|
|
|
|
|
|
|
|
|
|
<simplesect><title>Delaying conditionals</title>
|
|
|
|
|
|
|
|
|
|
<para>If a set of option definitions is conditional on the value of
|
|
|
|
|
another option, you may need to use <varname>mkIf</varname>.
|
|
|
|
|
Consider, for instance:
|
|
|
|
|
|
|
|
|
|
<programlisting>
|
|
|
|
|
config = if config.services.httpd.enable then {
|
|
|
|
|
environment.systemPackages = [ <replaceable>...</replaceable> ];
|
|
|
|
|
<replaceable>...</replaceable>
|
|
|
|
|
} else {};
|
|
|
|
|
</programlisting>
|
|
|
|
|
|
|
|
|
|
This definition will cause Nix to fail with an “infinite recursion”
|
|
|
|
|
error. Why? Because the value of
|
|
|
|
|
<option>config.services.httpd.enable</option> depends on the value
|
|
|
|
|
being constructed here. After all, you could also write the clearly
|
|
|
|
|
circular and contradictory:
|
|
|
|
|
<programlisting>
|
|
|
|
|
config = if config.services.httpd.enable then {
|
|
|
|
|
services.httpd.enable = false;
|
|
|
|
|
} else {
|
|
|
|
|
services.httpd.enable = true;
|
|
|
|
|
};
|
|
|
|
|
</programlisting>
|
|
|
|
|
|
|
|
|
|
The solution is to write:
|
|
|
|
|
|
|
|
|
|
<programlisting>
|
|
|
|
|
config = mkIf config.services.httpd.enable {
|
|
|
|
|
environment.systemPackages = [ <replaceable>...</replaceable> ];
|
|
|
|
|
<replaceable>...</replaceable>
|
|
|
|
|
};
|
|
|
|
|
</programlisting>
|
|
|
|
|
|
|
|
|
|
The special function <varname>mkIf</varname> causes the evaluation of
|
|
|
|
|
the conditional to be “pushed down” into the individual definitions,
|
|
|
|
|
as if you had written:
|
|
|
|
|
|
|
|
|
|
<programlisting>
|
|
|
|
|
config = {
|
|
|
|
|
environment.systemPackages = if config.services.httpd.enable then [ <replaceable>...</replaceable> ] else [];
|
|
|
|
|
<replaceable>...</replaceable>
|
|
|
|
|
};
|
|
|
|
|
</programlisting>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
</simplesect>
|
|
|
|
|
|
|
|
|
|
<simplesect><title>Setting priorities</title>
|
|
|
|
|
|
|
|
|
|
<para>A module can override the definitions of an option in other
|
|
|
|
|
modules by setting a <emphasis>priority</emphasis>. All option
|
|
|
|
|
definitions that do not have the lowest priority value are discarded.
|
|
|
|
|
By default, option definitions have priority 1000. You can specify an
|
|
|
|
|
explicit priority by using <varname>mkOverride</varname>, e.g.
|
|
|
|
|
|
|
|
|
|
<programlisting>
|
|
|
|
|
services.openssh.enable = mkOverride 10 false;
|
|
|
|
|
</programlisting>
|
|
|
|
|
|
|
|
|
|
This definition causes all other definitions with priorities above 10
|
|
|
|
|
to be discarded. The function <varname>mkForce</varname> is
|
|
|
|
|
equal to <varname>mkOverride 50</varname>.</para>
|
|
|
|
|
|
|
|
|
|
</simplesect>
|
|
|
|
|
|
|
|
|
|
<simplesect><title>Merging configurations</title>
|
|
|
|
|
|
|
|
|
|
<para>In conjunction with <literal>mkIf</literal>, it is sometimes
|
|
|
|
|
useful for a module to return multiple sets of option definitions, to
|
|
|
|
|
be merged together as if they were declared in separate modules. This
|
|
|
|
|
can be done using <varname>mkMerge</varname>:
|
|
|
|
|
|
|
|
|
|
<programlisting>
|
|
|
|
|
config = mkMerge
|
|
|
|
|
[ # Unconditional stuff.
|
|
|
|
|
{ environment.systemPackages = [ <replaceable>...</replaceable> ];
|
|
|
|
|
}
|
|
|
|
|
# Conditional stuff.
|
|
|
|
|
(mkIf config.services.bla.enable {
|
|
|
|
|
environment.systemPackages = [ <replaceable>...</replaceable> ];
|
|
|
|
|
})
|
|
|
|
|
];
|
|
|
|
|
</programlisting>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
</simplesect>
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section><title>Important options</title>
|
|
|
|
|
|
|
|
|
|
<para>NixOS has many options, but some are of particular importance to
|
|
|
|
|
module writers.</para>
|
|
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>etc.environment</option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>This set defines files in <filename>/etc</filename>. A
|
|
|
|
|
typical use is:
|
|
|
|
|
<programlisting>
|
|
|
|
|
environment.etc."os-release".text =
|
|
|
|
|
''
|
|
|
|
|
NAME=NixOS
|
|
|
|
|
<replaceable>...</replaceable>
|
|
|
|
|
'';
|
|
|
|
|
</programlisting>
|
|
|
|
|
which causes a file named <filename>/etc/os-release</filename>
|
|
|
|
|
to be created with the given contents.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>system.activationScripts</option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>A set of shell script fragments that must be executed
|
|
|
|
|
whenever the configuration is activated (i.e., at boot time, or
|
|
|
|
|
after running <command>nixos-rebuild switch</command>). For instance,
|
|
|
|
|
<programlisting>
|
|
|
|
|
system.activationScripts.media =
|
|
|
|
|
''
|
|
|
|
|
mkdir -m 0755 -p /media
|
|
|
|
|
'';
|
|
|
|
|
</programlisting>
|
|
|
|
|
causes the directory <filename>/media</filename> to be created.
|
|
|
|
|
Activation scripts must be idempotent. They should not start
|
|
|
|
|
background processes such as daemons; use
|
|
|
|
|
<option>systemd.services</option> for that.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>systemd.services</option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>This is the set of systemd services. Example:
|
|
|
|
|
<programlisting>
|
|
|
|
|
systemd.services.dhcpcd =
|
|
|
|
|
{ description = "DHCP Client";
|
|
|
|
|
wantedBy = [ "multi-user.target" ];
|
|
|
|
|
after = [ "systemd-udev-settle.service" ];
|
|
|
|
|
path = [ dhcpcd pkgs.nettools pkgs.openresolv ];
|
|
|
|
|
serviceConfig =
|
|
|
|
|
{ Type = "forking";
|
|
|
|
|
PIDFile = "/run/dhcpcd.pid";
|
|
|
|
|
ExecStart = "${dhcpcd}/sbin/dhcpcd --config ${dhcpcdConf}";
|
|
|
|
|
Restart = "always";
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
</programlisting>
|
|
|
|
|
which creates the systemd unit
|
|
|
|
|
<literal>dhcpcd.service</literal>. The option
|
|
|
|
|
<option>wantedBy</option> determined which other units pull this
|
|
|
|
|
one in; <literal>multi-user.target</literal> is the default
|
|
|
|
|
target of the system, so <literal>dhcpcd.service</literal> will
|
|
|
|
|
always be started. The option
|
|
|
|
|
<option>serviceConfig.ExecStart</option> provides the main
|
|
|
|
|
command for the service; it’s also possible to provide pre-start
|
|
|
|
|
actions, stop scripts, and so on.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>users.extraUsers</option></term>
|
|
|
|
|
<term><option>users.extraGroups</option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>If your service requires special UIDs or GIDs, you can
|
|
|
|
|
define them with these options. See <xref
|
|
|
|
|
linkend="sec-user-management"/> for details.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
</variablelist>
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
|
2009-01-25 16:49:27 +01:00
|
|
|
|
|
2011-05-01 12:24:37 +02:00
|
|
|
|
</section>
|
2009-01-25 16:49:27 +01:00
|
|
|
|
|
|
|
|
|
|
2011-05-01 12:24:37 +02:00
|
|
|
|
<!--===============================================================-->
|
2009-01-25 16:49:27 +01:00
|
|
|
|
|
2007-02-06 22:25:36 +01:00
|
|
|
|
<section>
|
|
|
|
|
|
|
|
|
|
<title>Building specific parts of NixOS</title>
|
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<para>With the command <command>nix-build</command>, you can build
|
|
|
|
|
specific parts of your NixOS configuration. This is done as follows:
|
2007-02-06 22:25:36 +01:00
|
|
|
|
|
|
|
|
|
<screen>
|
2013-10-31 23:01:07 +01:00
|
|
|
|
$ cd <replaceable>/path/to/nixpkgs/nixos</replaceable>
|
|
|
|
|
$ nix-build -A config.<replaceable>option</replaceable></screen>
|
2007-02-06 22:25:36 +01:00
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
where <replaceable>option</replaceable> is a NixOS option with type
|
|
|
|
|
“derivation” (i.e. something that can be built). Attributes of
|
|
|
|
|
interest include:
|
2008-02-08 23:43:59 +01:00
|
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<term><varname>system.build.toplevel</varname></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>The top-level option that builds the entire NixOS system.
|
|
|
|
|
Everything else in your configuration is indirectly pulled in by
|
|
|
|
|
this option. This is what <command>nixos-rebuild</command>
|
|
|
|
|
builds and what <filename>/run/current-system</filename> points
|
|
|
|
|
to afterwards.</para>
|
|
|
|
|
|
|
|
|
|
<para>A shortcut to build this is:
|
|
|
|
|
|
|
|
|
|
<screen>
|
|
|
|
|
$ nix-build -A system</screen>
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
2008-02-08 23:43:59 +01:00
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<term><varname>system.build.manual.manual</varname></term>
|
|
|
|
|
<listitem><para>The NixOS manual.</para></listitem>
|
2008-02-08 23:43:59 +01:00
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<term><varname>system.build.etc</varname></term>
|
|
|
|
|
<listitem><para>A tree of symlinks that form the static parts of
|
|
|
|
|
<filename>/etc</filename>.</para></listitem>
|
2008-02-08 23:43:59 +01:00
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>system.build.initialRamdisk</varname></term>
|
|
|
|
|
<term><varname>system.build.kernel</varname></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>The initial ramdisk and kernel of the system. This allows
|
|
|
|
|
a quick way to test whether the kernel and the initial ramdisk
|
|
|
|
|
boot correctly, by using QEMU’s <option>-kernel</option> and
|
|
|
|
|
<option>-initrd</option> options:
|
|
|
|
|
|
|
|
|
|
<screen>
|
|
|
|
|
$ nix-build -A config.system.build.initialRamdisk -o initrd
|
|
|
|
|
$ nix-build -A config.system.build.kernel -o kernel
|
|
|
|
|
$ qemu-system-x86_64 -kernel ./kernel/bzImage -initrd ./initrd/initrd -hda /dev/null
|
|
|
|
|
</screen>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>system.build.nixos-rebuild</varname></term>
|
|
|
|
|
<term><varname>system.build.nixos-install</varname></term>
|
|
|
|
|
<term><varname>system.build.nixos-generate-config</varname></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>These build the corresponding NixOS commands.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
</variablelist>
|
2008-02-08 23:43:59 +01:00
|
|
|
|
|
2009-10-05 15:17:45 +02:00
|
|
|
|
</para>
|
2008-02-08 23:43:59 +01:00
|
|
|
|
|
2009-09-14 00:13:19 +02:00
|
|
|
|
</section>
|
2008-02-08 23:43:59 +01:00
|
|
|
|
|
2009-09-14 00:13:19 +02:00
|
|
|
|
|
2011-05-01 12:24:37 +02:00
|
|
|
|
<!--===============================================================-->
|
|
|
|
|
|
2009-09-14 00:13:19 +02:00
|
|
|
|
<section>
|
|
|
|
|
|
|
|
|
|
<title>Building your own NixOS CD</title>
|
|
|
|
|
|
|
|
|
|
<para>Building a NixOS CD is as easy as configuring your own computer. The
|
|
|
|
|
idea is to use another module which will replace
|
|
|
|
|
your <filename>configuration.nix</filename> to configure the system that
|
2013-08-10 23:07:13 +02:00
|
|
|
|
would be installed on the CD.</para>
|
2009-09-14 00:13:19 +02:00
|
|
|
|
|
|
|
|
|
<para>Default CD/DVD configurations are available
|
|
|
|
|
inside <filename>nixos/modules/installer/cd-dvd</filename>. To build them
|
2009-09-14 08:56:00 +02:00
|
|
|
|
you have to set <envar>NIXOS_CONFIG</envar> before
|
2009-09-14 00:13:19 +02:00
|
|
|
|
running <command>nix-build</command> to build the ISO.
|
|
|
|
|
|
|
|
|
|
<screen>
|
2013-10-31 23:01:07 +01:00
|
|
|
|
$ nix-build -A config.system.build.isoImage -I nixos-config=modules/installer/cd-dvd/installation-cd-minimal.nix</screen>
|
2008-02-08 23:43:59 +01:00
|
|
|
|
|
|
|
|
|
</para>
|
2007-02-06 22:25:36 +01:00
|
|
|
|
|
2009-09-14 00:13:19 +02:00
|
|
|
|
<para>Before burning your CD/DVD, you can check the content of the image by mounting anywhere like
|
|
|
|
|
suggested by the following command:
|
2007-02-06 22:25:36 +01:00
|
|
|
|
|
2009-09-14 00:13:19 +02:00
|
|
|
|
<screen>
|
|
|
|
|
$ mount -o loop -t iso9660 ./result/iso/cd.iso /mnt/iso</screen>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
</section>
|
2007-02-06 22:25:36 +01:00
|
|
|
|
|
2012-04-24 17:14:26 +02:00
|
|
|
|
|
|
|
|
|
<!--===============================================================-->
|
|
|
|
|
|
2007-02-06 22:25:36 +01:00
|
|
|
|
<section>
|
|
|
|
|
|
|
|
|
|
<title>Testing the installer</title>
|
|
|
|
|
|
2013-08-21 16:44:14 +02:00
|
|
|
|
<para>Building, burning, and
|
2013-08-06 17:03:50 +02:00
|
|
|
|
booting from an installation CD is rather
|
2007-02-06 22:25:36 +01:00
|
|
|
|
tedious, so here is a quick way to see if the installer works
|
|
|
|
|
properly:
|
|
|
|
|
|
|
|
|
|
<screen>
|
2013-10-31 23:01:07 +01:00
|
|
|
|
$ nix-build -A config.system.build.nixos-install
|
2007-02-06 22:25:36 +01:00
|
|
|
|
$ dd if=/dev/zero of=diskimage seek=2G count=0 bs=1
|
|
|
|
|
$ yes | mke2fs -j diskimage
|
|
|
|
|
$ mount -o loop diskimage /mnt
|
|
|
|
|
$ ./result/bin/nixos-install</screen>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
2013-08-06 17:03:50 +02:00
|
|
|
|
|
2011-05-01 12:24:37 +02:00
|
|
|
|
<!--===============================================================-->
|
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<section><title>Whole-system testing using virtual machines</title>
|
2011-03-08 21:55:43 +01:00
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<para>Complete NixOS GNU/Linux systems can be tested in virtual
|
|
|
|
|
machines (VMs). This makes it possible to test a system upgrade or
|
|
|
|
|
configuration change before rebooting into it, using the
|
|
|
|
|
<command>nixos-rebuild build-vm</command> or <command>nixos-rebuild
|
|
|
|
|
build-vm-with-bootloader</command> command.</para>
|
2011-03-08 21:55:43 +01:00
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<!-- The following is adapted from
|
|
|
|
|
http://wiki.nixos.org/wiki/NixOS_VM_tests, by Eelco Dolstra. -->
|
|
|
|
|
<para>The <filename>tests/</filename> directory in the NixOS source
|
|
|
|
|
tree contains several <emphasis>whole-system unit tests</emphasis>.
|
|
|
|
|
These tests can be run<footnote><para>NixOS tests can be run both from
|
|
|
|
|
NixOS and from a non-NixOS GNU/Linux distribution, provided the Nix
|
|
|
|
|
package manager is installed.</para></footnote> from the NixOS source
|
|
|
|
|
tree as follows:
|
2011-03-08 21:55:43 +01:00
|
|
|
|
|
2012-05-14 05:59:38 +02:00
|
|
|
|
<screen>
|
|
|
|
|
$ nix-build tests/ -A nfs.test
|
|
|
|
|
</screen>
|
2011-03-08 21:55:43 +01:00
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
This performs an automated test of the NFS client and server
|
|
|
|
|
functionality in the Linux kernel, including file locking semantics
|
|
|
|
|
(e.g., whether locks are maintained across server crashes). It will
|
|
|
|
|
first build or download all the dependencies of the test (e.g., all
|
|
|
|
|
packages needed to run a NixOS VM). The test is defined in <link
|
|
|
|
|
xlink:href="https://nixos.org/repos/nix/nixos/trunk/tests/nfs.nix">
|
|
|
|
|
<filename>tests/nfs.nix</filename></link>. If the test succeeds,
|
|
|
|
|
<command>nix-build</command> will place a symlink
|
|
|
|
|
<filename>./result</filename> in the current directory pointing at the
|
|
|
|
|
location in the Nix store of the test results (e.g., screenshots, test
|
|
|
|
|
reports, and so on). In particular, a pretty-printed log of the test
|
|
|
|
|
is written to <filename>log.html</filename>, which can be viewed using
|
|
|
|
|
a web browser like this:
|
2011-03-08 21:55:43 +01:00
|
|
|
|
|
2012-05-14 05:59:38 +02:00
|
|
|
|
<screen>
|
2013-10-09 15:33:23 +02:00
|
|
|
|
$ firefox result/log.html
|
2012-05-14 05:59:38 +02:00
|
|
|
|
</screen>
|
2013-10-31 23:01:07 +01:00
|
|
|
|
</para>
|
2011-03-08 21:55:43 +01:00
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<para>It is also possible to run the test environment interactively,
|
|
|
|
|
allowing you to experiment with the VMs. For example:
|
2011-03-08 21:55:43 +01:00
|
|
|
|
|
2012-05-14 05:59:38 +02:00
|
|
|
|
<screen>
|
|
|
|
|
$ nix-build tests/ -A nfs.driver
|
|
|
|
|
$ ./result/bin/nixos-run-vms
|
|
|
|
|
</screen>
|
2011-03-08 21:55:43 +01:00
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
The script <command>nixos-run-vms</command> starts the three virtual
|
|
|
|
|
machines defined in the NFS test using QEMU/KVM. The root file system
|
|
|
|
|
of the VMs is created on the fly and kept across VM restarts in
|
|
|
|
|
<filename>./</filename><varname>hostname</varname><filename>.qcow2</filename>.</para>
|
2011-03-08 21:55:43 +01:00
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
<para>Finally, the test itself can be run interactively. This is
|
|
|
|
|
particularly useful when developing or debugging a test:
|
2011-03-08 21:55:43 +01:00
|
|
|
|
|
2012-05-14 05:59:38 +02:00
|
|
|
|
<screen>
|
|
|
|
|
$ nix-build tests/ -A nfs.driver
|
|
|
|
|
$ ./result/bin/nixos-test-driver
|
|
|
|
|
starting VDE switch for network 1
|
|
|
|
|
>
|
|
|
|
|
</screen>
|
2011-03-08 21:55:43 +01:00
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
Perl statements can now be typed in to start or manipulate the VMs:
|
2011-03-08 21:55:43 +01:00
|
|
|
|
|
2012-05-14 05:59:38 +02:00
|
|
|
|
<screen>
|
|
|
|
|
> startAll;
|
|
|
|
|
(the VMs start booting)
|
|
|
|
|
> $server->waitForJob("nfs-kernel-nfsd");
|
|
|
|
|
> $client1->succeed("flock -x /data/lock -c 'sleep 100000' &");
|
|
|
|
|
> $client2->fail("flock -n -s /data/lock true");
|
|
|
|
|
> $client1->shutdown;
|
|
|
|
|
(this releases client1's lock)
|
|
|
|
|
> $client2->succeed("flock -n -s /data/lock true");
|
|
|
|
|
</screen>
|
2011-03-08 21:55:43 +01:00
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
The function <command>testScript</command> executes the entire test
|
|
|
|
|
script and drops you back into the test driver command line upon its
|
|
|
|
|
completion. This allows you to inspect the state of the VMs after the
|
|
|
|
|
test (e.g. to debug the test script).</para>
|
|
|
|
|
|
|
|
|
|
<para>This and other tests are continuously run on <link
|
|
|
|
|
xlink:href="http://hydra.nixos.org/jobset/nixos/trunk">the Hydra
|
|
|
|
|
instance at <literal>nixos.org</literal></link>, which allows
|
|
|
|
|
developers to be notified of any regressions introduced by a NixOS or
|
|
|
|
|
Nixpkgs change.</para>
|
|
|
|
|
|
|
|
|
|
<para>The actual Nix programming interface to VM testing is in NixOS,
|
|
|
|
|
under <link
|
|
|
|
|
xlink:href="https://nixos.org/repos/nix/nixos/trunk/lib/testing.nix">
|
|
|
|
|
<filename>lib/testing.nix</filename></link>. This file defines a
|
|
|
|
|
function which takes an attribute set containing a
|
|
|
|
|
<literal>nixpkgs</literal> attribute (the path to a Nixpkgs checkout),
|
|
|
|
|
and a <literal>system</literal> attribute (the system type). It
|
|
|
|
|
returns an attribute set containing several utility functions, among
|
|
|
|
|
which the main entry point is <literal>makeTest</literal>.
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>The <literal>makeTest</literal> function takes a function
|
|
|
|
|
similar to that found in <link
|
|
|
|
|
xlink:href="https://nixos.org/repos/nix/nixos/trunk/tests/nfs.nix">
|
|
|
|
|
<filename>tests/nfs.nix</filename></link> (discussed above). It
|
|
|
|
|
returns an attribute set containing (among others):
|
|
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>test</varname></term>
|
|
|
|
|
<listitem><para>A derivation containing the test log as an HTML
|
|
|
|
|
file, as seen above, suitable for presentation in the Hydra
|
|
|
|
|
continuous build system.</para></listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>report</varname></term>
|
|
|
|
|
<listitem><para>A derivation containing a code coverage report, with
|
|
|
|
|
meta-data suitable for Hydra.</para></listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><varname>driver</varname></term>
|
|
|
|
|
<listitem><para>A derivation containing scripts to run the VM test or
|
|
|
|
|
interact with the VM network interactively, as seen above.</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
</variablelist>
|
|
|
|
|
|
|
|
|
|
</para>
|
2011-06-15 16:12:45 +02:00
|
|
|
|
|
2011-03-08 21:55:43 +01:00
|
|
|
|
</section>
|
2008-08-26 14:48:27 +02:00
|
|
|
|
|
2013-10-31 23:01:07 +01:00
|
|
|
|
|
2007-02-06 22:25:36 +01:00
|
|
|
|
</chapter>
|