commit de3e423178d6263ded7cf55d98778c829034ae34 · pyrox.dev/nixpkgs

+13

nixos/doc/manual/development/writing-nixos-tests.section.md

···

       332
        
           '';

     

       333
        
       ```

     

       334
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       335
        
       ## Failing tests early {#ssec-failing-tests-early}

     

       336
        
       

     

       337
        
       To fail tests early when certain invariables are no longer met (instead of waiting for the build to time out), the decorator `polling_condition` is provided. For example, if we are testing a program `foo` that should not quit after being started, we might write the following:

···

       332
        
           '';

     

       333
        
       ```

     

       334
        
       

     

       335
       +
       Similarly, the type checking of test scripts can be disabled in the following

     

       336
       +
       way:

     

       337
       +
       

     

       338
       +
       ```nix

     

       339
       +
       import ./make-test-python.nix {

     

       340
       +
         skipTypeCheck = true;

     

       341
       +
         nodes.machine =

     

       342
       +
           { config, pkgs, ... }:

     

       343
       +
           { configuration…

     

       344
       +
           };

     

       345
       +
       }

     

       346
       +
       ```

     

       347
       +
       

     

       348
        
       ## Failing tests early {#ssec-failing-tests-early}

     

       349
        
       

     

       350
        
       To fail tests early when certain invariables are no longer met (instead of waiting for the build to time out), the decorator `polling_condition` is provided. For example, if we are testing a program `foo` that should not quit after being started, we might write the following:

+13

nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml

···

       590
        
             # fmt: on

     

       591
        
           '';

     

       592
        
       </programlisting>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       593
        
         </section>

     

       594
        
         <section xml:id="ssec-failing-tests-early">

     

       595
        
           <title>Failing tests early</title>

···

       590
        
             # fmt: on

     

       591
        
           '';

     

       592
        
       </programlisting>

     

       593
       +
           <para>

     

       594
       +
             Similarly, the type checking of test scripts can be disabled in

     

       595
       +
             the following way:

     

       596
       +
           </para>

     

       597
       +
           <programlisting language="bash">

     

       598
       +
       import ./make-test-python.nix {

     

       599
       +
         skipTypeCheck = true;

     

       600
       +
         nodes.machine =

     

       601
       +
           { config, pkgs, ... }:

     

       602
       +
           { configuration…

     

       603
       +
           };

     

       604
       +
       }

     

       605
       +
       </programlisting>

     

       606
        
         </section>

     

       607
        
         <section xml:id="ssec-failing-tests-early">

     

       608
        
           <title>Failing tests early</title>

nixos/lib/test-driver/default.nix

···

       25
        
         checkPhase = ''

     

       26
        
           mypy --disallow-untyped-defs \

     

       27
        
                 --no-implicit-optional \

     

       0
        
       
     

       0
        
       
     

       28
        
                 --ignore-missing-imports ${src}/test_driver

     

       29
        
           pylint --errors-only --enable=unused-import ${src}/test_driver

     

       30
        
           black --check --diff ${src}/test_driver

···

       25
        
         checkPhase = ''

     

       26
        
           mypy --disallow-untyped-defs \

     

       27
        
                 --no-implicit-optional \

     

       28
       +
                 --pretty \

     

       29
       +
                 --no-color-output \

     

       30
        
                 --ignore-missing-imports ${src}/test_driver

     

       31
        
           pylint --errors-only --enable=unused-import ${src}/test_driver

     

       32
        
           black --check --diff ${src}/test_driver

nixos/lib/test-driver/test_driver/py.typed

This is a binary file and will not be displayed.

+42

nixos/lib/test-script-prepend.py

···

       1
       +
       # This file contains type hints that can be prepended to Nix test scripts so they can be type

     

       2
       +
       # checked.

     

       3
       +
       

     

       4
       +
       from test_driver.driver import Driver

     

       5
       +
       from test_driver.vlan import VLan

     

       6
       +
       from test_driver.machine import Machine

     

       7
       +
       from test_driver.logger import Logger

     

       8
       +
       from typing import Callable, Iterator, ContextManager, Optional, List, Dict, Any, Union

     

       9
       +
       from typing_extensions import Protocol

     

       10
       +
       from pathlib import Path

     

       11
       +
       

     

       12
       +
       

     

       13
       +
       class RetryProtocol(Protocol):

     

       14
       +
           def __call__(self, fn: Callable, timeout: int = 900) -> None:

     

       15
       +
               raise Exception("This is just type information for the Nix test driver")

     

       16
       +
       

     

       17
       +
       

     

       18
       +
       class PollingConditionProtocol(Protocol):

     

       19
       +
           def __call__(

     

       20
       +
               self,

     

       21
       +
               fun_: Optional[Callable] = None,

     

       22
       +
               *,

     

       23
       +
               seconds_interval: float = 2.0,

     

       24
       +
               description: Optional[str] = None,

     

       25
       +
           ) -> Union[Callable[[Callable], ContextManager], ContextManager]:

     

       26
       +
               raise Exception("This is just type information for the Nix test driver")

     

       27
       +
       

     

       28
       +
       

     

       29
       +
       start_all: Callable[[], None]

     

       30
       +
       subtest: Callable[[str], ContextManager[None]]

     

       31
       +
       retry: RetryProtocol

     

       32
       +
       test_script: Callable[[], None]

     

       33
       +
       machines: List[Machine]

     

       34
       +
       vlans: List[VLan]

     

       35
       +
       driver: Driver

     

       36
       +
       log: Logger

     

       37
       +
       create_machine: Callable[[Dict[str, Any]], Machine]

     

       38
       +
       run_tests: Callable[[], None]

     

       39
       +
       join_all: Callable[[], None]

     

       40
       +
       serial_stdout_off: Callable[[], None]

     

       41
       +
       serial_stdout_on: Callable[[], None]

     

       42
       +
       polling_condition: PollingConditionProtocol

+28 -5

nixos/lib/testing-python.nix

···

       50
        
           , qemu_pkg ? pkgs.qemu_test

     

       51
        
           , enableOCR ? false

     

       52
        
           , skipLint ? false

     

       0
        
       
     

       53
        
           , passthru ? {}

     

       54
        
           , interactive ? false

     

       55
        
         }:

     
···

       85
        
       

     

       86
        
             nodeHostNames = let

     

       87
        
               nodesList = map (c: c.config.system.name) (lib.attrValues nodes);

     

       88
       -
             in nodesList ++ lib.optional (lib.length nodesList == 1) "machine";

     

       89
        
       

     

       90
        
             # TODO: This is an implementation error and needs fixing

     

       91
        
             # the testing famework cannot legitimately restrict hostnames further

     
···

       100
        
               then testScript { inherit nodes; }

     

       101
        
               else testScript;

     

       102
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       103
        
           in

     

       104
        
           if lib.length invalidNodeNames > 0 then

     

       105
        
             throw ''

     
···

       113
        
           else lib.warnIf skipLint "Linting is disabled" (runCommand testDriverName

     

       114
        
             {

     

       115
        
               inherit testName;

     

       116
       -
               nativeBuildInputs = [ makeWrapper ];

     

       117
        
               testScript = testScript';

     

       118
        
               preferLocalBuild = true;

     

       119
        
               passthru = passthru // {

     
···

       125
        
               mkdir -p $out/bin

     

       126
        
       

     

       127
        
               vmStartScripts=($(for i in ${toString vms}; do echo $i/bin/run-*-vm; done))

     

       128
       -
               echo -n "$testScript" > $out/test-script

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       129
        
               ln -s ${testDriver}/bin/nixos-test-driver $out/bin/nixos-test-driver

     

       130
        
       

     

       131
        
               ${testDriver}/bin/generate-driver-symbols

     
···

       152
        
           , testScript

     

       153
        
           , enableOCR ? false

     

       154
        
           , name ? "unnamed"

     

       0
        
       
     

       155
        
             # Skip linting (mainly intended for faster dev cycles)

     

       156
        
           , skipLint ? false

     

       157
        
           , passthru ? {}

     
···

       213
        
                 );

     

       214
        
       

     

       215
        
             driver = setupDriverForTest {

     

       216
       -
               inherit testScript enableOCR skipLint passthru;

     

       217
        
               testName = name;

     

       218
        
               qemu_pkg = pkgs.qemu_test;

     

       219
        
               nodes = mkNodes pkgs.qemu_test;

     

       220
        
             };

     

       221
        
             driverInteractive = setupDriverForTest {

     

       222
       -
               inherit testScript enableOCR skipLint passthru;

     

       223
        
               testName = name;

     

       224
        
               qemu_pkg = pkgs.qemu;

     

       225
        
               nodes = mkNodes pkgs.qemu;

···

       50
        
           , qemu_pkg ? pkgs.qemu_test

     

       51
        
           , enableOCR ? false

     

       52
        
           , skipLint ? false

     

       53
       +
           , skipTypeCheck ? false

     

       54
        
           , passthru ? {}

     

       55
        
           , interactive ? false

     

       56
        
         }:

     
···

       86
        
       

     

       87
        
             nodeHostNames = let

     

       88
        
               nodesList = map (c: c.config.system.name) (lib.attrValues nodes);

     

       89
       +
             in nodesList ++ lib.optional (lib.length nodesList == 1 && !lib.elem "machine" nodesList) "machine";

     

       90
        
       

     

       91
        
             # TODO: This is an implementation error and needs fixing

     

       92
        
             # the testing famework cannot legitimately restrict hostnames further

     
···

       101
        
               then testScript { inherit nodes; }

     

       102
        
               else testScript;

     

       103
        
       

     

       104
       +
             uniqueVlans = lib.unique (builtins.concatLists vlans);

     

       105
       +
             vlanNames = map (i: "vlan${toString i}: VLan;") uniqueVlans;

     

       106
       +
             machineNames = map (name: "${name}: Machine;") nodeHostNames;

     

       107
        
           in

     

       108
        
           if lib.length invalidNodeNames > 0 then

     

       109
        
             throw ''

     
···

       117
        
           else lib.warnIf skipLint "Linting is disabled" (runCommand testDriverName

     

       118
        
             {

     

       119
        
               inherit testName;

     

       120
       +
               nativeBuildInputs = [ makeWrapper mypy ];

     

       121
        
               testScript = testScript';

     

       122
        
               preferLocalBuild = true;

     

       123
        
               passthru = passthru // {

     
···

       129
        
               mkdir -p $out/bin

     

       130
        
       

     

       131
        
               vmStartScripts=($(for i in ${toString vms}; do echo $i/bin/run-*-vm; done))

     

       132
       +
       

     

       133
       +
               ${lib.optionalString (!skipTypeCheck) ''

     

       134
       +
                 # prepend type hints so the test script can be type checked with mypy

     

       135
       +
                 cat "${./test-script-prepend.py}" >> testScriptWithTypes

     

       136
       +
                 echo "${builtins.toString machineNames}" >> testScriptWithTypes

     

       137
       +
                 echo "${builtins.toString vlanNames}" >> testScriptWithTypes

     

       138
       +
                 echo -n "$testScript" >> testScriptWithTypes

     

       139
       +
       

     

       140
       +
                 # set pythonpath so mypy knows where to find the imports. this requires the py.typed file.

     

       141
       +
                 export PYTHONPATH='${./test-driver}'

     

       142
       +
                 mypy  --no-implicit-optional \

     

       143
       +
                       --pretty \

     

       144
       +
                       --no-color-output \

     

       145
       +
                       testScriptWithTypes

     

       146
       +
                 unset PYTHONPATH

     

       147
       +
               ''}

     

       148
       +
       

     

       149
       +
               echo -n "$testScript" >> $out/test-script

     

       150
       +
       

     

       151
        
               ln -s ${testDriver}/bin/nixos-test-driver $out/bin/nixos-test-driver

     

       152
        
       

     

       153
        
               ${testDriver}/bin/generate-driver-symbols

     
···

       174
        
           , testScript

     

       175
        
           , enableOCR ? false

     

       176
        
           , name ? "unnamed"

     

       177
       +
           , skipTypeCheck ? false

     

       178
        
             # Skip linting (mainly intended for faster dev cycles)

     

       179
        
           , skipLint ? false

     

       180
        
           , passthru ? {}

     
···

       236
        
                 );

     

       237
        
       

     

       238
        
             driver = setupDriverForTest {

     

       239
       +
               inherit testScript enableOCR skipTypeCheck skipLint passthru;

     

       240
        
               testName = name;

     

       241
        
               qemu_pkg = pkgs.qemu_test;

     

       242
        
               nodes = mkNodes pkgs.qemu_test;

     

       243
        
             };

     

       244
        
             driverInteractive = setupDriverForTest {

     

       245
       +
               inherit testScript enableOCR skipTypeCheck skipLint passthru;

     

       246
        
               testName = name;

     

       247
        
               qemu_pkg = pkgs.qemu;

     

       248
        
               nodes = mkNodes pkgs.qemu;