commit f39b1ead2a5fba63be7cd77dd70c00c09d7f6aba · pyrox.dev/nixpkgs

nixos/doc/manual/development/development.xml

···

       15
       15
        
       <xi:include href="writing-modules.xml" />

     

       16
       16
        
       <xi:include href="building-parts.xml" />

     

       17
       17
        
       <xi:include href="building-nixos.xml" />

     

       18
       18
       +
       <xi:include href="nixos-tests.xml" />

     

       18
       19
        
       <xi:include href="testing-installer.xml" />

     

       19
       20
        
       

     

       20
       21
        
       </part>

+2 -1

nixos/doc/manual/development/nixos-tests.xml

···

       15
       15
        
       

     

       16
       16
        
       <xi:include href="writing-nixos-tests.xml" />

     

       17
       17
        
       <xi:include href="running-nixos-tests.xml" />

     

       18
       18
       +
       <xi:include href="running-nixos-tests-interactively.xml" />

     

       18
       19
        
       

     

       19
       19
       -
       </chapter>
     

       20
       20
       +
       </chapter>

+43

nixos/doc/manual/development/running-nixos-tests-interactively.xml

···

       1
       1
       +
       <section xmlns="http://docbook.org/ns/docbook"

     

       2
       2
       +
               xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       +
               xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       4
       +
               version="5.0"

     

       5
       5
       +
               xml:id="sec-running-nixos-tests">

     

       6
       6
       +
       <title>Running Tests interactively</title>

     

       7
       7
       +
       

     

       8
       8
       +
       <para>The test itself can be run interactively.  This is

     

       9
       9
       +
       particularly useful when developing or debugging a test:

     

       10
       10
       +
       

     

       11
       11
       +
       <screen>

     

       12
       12
       +
       $ nix-build nixos/tests/login.nix -A driver

     

       13
       13
       +
       $ ./result/bin/nixos-test-driver

     

       14
       14
       +
       starting VDE switch for network 1

     

       15
       15
       +
       &gt;

     

       16
       16
       +
       </screen>

     

       17
       17
       +
       

     

       18
       18
       +
       You can then take any Perl statement, e.g.

     

       19
       19
       +
       

     

       20
       20
       +
       <screen>

     

       21
       21
       +
       &gt; startAll

     

       22
       22
       +
       &gt; testScript

     

       23
       23
       +
       &gt; $machine->succeed("touch /tmp/foo")

     

       24
       24
       +
       </screen>

     

       25
       25
       +
       

     

       26
       26
       +
       The function <command>testScript</command> executes the entire test

     

       27
       27
       +
       script and drops you back into the test driver command line upon its

     

       28
       28
       +
       completion.  This allows you to inspect the state of the VMs after the

     

       29
       29
       +
       test (e.g. to debug the test script).</para>

     

       30
       30
       +
       

     

       31
       31
       +
       <para>To just start and experiment with the VMs, run:

     

       32
       32
       +
       

     

       33
       33
       +
       <screen>

     

       34
       34
       +
       $ nix-build nixos/tests/login.nix -A driver

     

       35
       35
       +
       $ ./result/bin/nixos-run-vms

     

       36
       36
       +
       </screen>

     

       37
       37
       +
       

     

       38
       38
       +
       The script <command>nixos-run-vms</command> starts the virtual

     

       39
       39
       +
       machines defined by test.  The root file system of the VMs is created

     

       40
       40
       +
       on the fly and kept across VM restarts in

     

       41
       41
       +
       <filename>./</filename><varname>hostname</varname><filename>.qcow2</filename>.</para>

     

       42
       42
       +
       

     

       43
       43
       +
       </section>

+1 -39

nixos/doc/manual/development/running-nixos-tests.xml

···

       2
       2
        
               xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
        
               xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       4
        
               version="5.0"

     

       5
       5
       -
               xml:id="sec-running-nixos-tests">

     

       5
       5
       +
               xml:id="sec-running-nixos-tests-interactively">

     

       6
       6
        
       

     

       7
       7
        
       <title>Running Tests</title>

     

       8
       8
        
       

     
···

       38
       38
        
       </screen>

     

       39
       39
        
       

     

       40
       40
        
       </para>

     

       41
       41
       -
       

     

       42
       42
       -
       <title>Running Tests interactively</title>

     

       43
       43
       -
       

     

       44
       44
       -
       <para>The test itself can be run interactively.  This is

     

       45
       45
       -
       particularly useful when developing or debugging a test:

     

       46
       46
       -
       

     

       47
       47
       -
       <screen>

     

       48
       48
       -
       $ nix-build nixos/tests/login.nix -A driver

     

       49
       49
       -
       $ ./result/bin/nixos-test-driver

     

       50
       50
       -
       starting VDE switch for network 1

     

       51
       51
       -
       &gt;

     

       52
       52
       -
       </screen>

     

       53
       53
       -
       

     

       54
       54
       -
       You can then take any Perl statement, e.g.

     

       55
       55
       -
       

     

       56
       56
       -
       <screen>

     

       57
       57
       -
       &gt; startAll

     

       58
       58
       -
       &gt; testScript

     

       59
       59
       -
       &gt; $machine->succeed("touch /tmp/foo")

     

       60
       60
       -
       </screen>

     

       61
       61
       -
       

     

       62
       62
       -
       The function <command>testScript</command> executes the entire test

     

       63
       63
       -
       script and drops you back into the test driver command line upon its

     

       64
       64
       -
       completion.  This allows you to inspect the state of the VMs after the

     

       65
       65
       -
       test (e.g. to debug the test script).</para>

     

       66
       66
       -
       

     

       67
       67
       -
       <para>To just start and experiment with the VMs, run:

     

       68
       68
       -
       

     

       69
       69
       -
       <screen>

     

       70
       70
       -
       $ nix-build nixos/tests/login.nix -A driver

     

       71
       71
       -
       $ ./result/bin/nixos-run-vms

     

       72
       72
       -
       </screen>

     

       73
       73
       -
       

     

       74
       74
       -
       The script <command>nixos-run-vms</command> starts the virtual

     

       75
       75
       -
       machines defined by test.  The root file system of the VMs is created

     

       76
       76
       -
       on the fly and kept across VM restarts in

     

       77
       77
       -
       <filename>./</filename><varname>hostname</varname><filename>.qcow2</filename>.</para>

     

       78
       78
       -
       

     

       79
       41
        
       </section>