commit a1dfaf51e2400f4698bbd076c56473b0ba6303bf · pyrox.dev/nixpkgs

+3 -2

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

···

       121
        
       ```py

     

       122
        
       machine.start()

     

       123
        
       machine.wait_for_unit("default.target")

     

       124
       -
       if not "Linux" in machine.succeed("uname"):

     

       125
       -
         raise Exception("Wrong OS")

     

       126
        
       ```

     

       127
        
       

     

       128
        
       The first line is technically unnecessary; machines are implicitly started

     
···

       133
        
       ```py

     

       134
        
       start_all()

     

       135
        
       ```

     

       0
        
       
     

       0
        
       
     

       136
        
       

     

       137
        
       If the hostname of a node contains characters that can't be used in a

     

       138
        
       Python variable name, those characters will be replaced with

···

       121
        
       ```py

     

       122
        
       machine.start()

     

       123
        
       machine.wait_for_unit("default.target")

     

       124
       +
       t.assertIn("Linux", machine.succeed("uname"), "Wrong OS")

     

       0
        
       
     

       125
        
       ```

     

       126
        
       

     

       127
        
       The first line is technically unnecessary; machines are implicitly started

     
···

       132
        
       ```py

     

       133
        
       start_all()

     

       134
        
       ```

     

       135
       +
       

     

       136
       +
       Under the variable `t`, all assertions from [`unittest.TestCase`](https://docs.python.org/3/library/unittest.html) are available.

     

       137
        
       

     

       138
        
       If the hostname of a node contains characters that can't be used in a

     

       139
        
       Python variable name, those characters will be replaced with

+37 -1

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

···

       1
        
       import os

     

       2
        
       import re

     

       3
        
       import signal

     

       0
        
       
     

       4
        
       import tempfile

     

       5
        
       import threading

     

       0
        
       
     

       6
        
       from collections.abc import Callable, Iterator

     

       7
        
       from contextlib import AbstractContextManager, contextmanager

     

       8
        
       from pathlib import Path

     

       9
        
       from typing import Any

     

       0
        
       
     

       10
        
       

     

       11
        
       from test_driver.logger import AbstractLogger

     

       12
        
       from test_driver.machine import Machine, NixStartScript, retry

     
···

       36
        
       

     

       37
        
       def pythonize_name(name: str) -> str:

     

       38
        
           return re.sub(r"^[^A-z_]|[^A-z0-9_]", "_", name)

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       39
        
       

     

       40
        
       

     

       41
        
       class Driver:

     
···

       140
        
                   serial_stdout_on=self.serial_stdout_on,

     

       141
        
                   polling_condition=self.polling_condition,

     

       142
        
                   Machine=Machine,  # for typing

     

       0
        
       
     

       143
        
               )

     

       144
        
               machine_symbols = {pythonize_name(m.name): m for m in self.machines}

     

       145
        
               # If there's exactly one machine, make it available under the name

     
···

       163
        
               """Run the test script"""

     

       164
        
               with self.logger.nested("run the VM test script"):

     

       165
        
                   symbols = self.test_symbols()  # call eagerly

     

       166
       -
                   exec(self.tests, symbols, None)

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       167
        
       

     

       168
        
           def run_tests(self) -> None:

     

       169
        
               """Run the test script (for non-interactive test runs)"""

···

       1
        
       import os

     

       2
        
       import re

     

       3
        
       import signal

     

       4
       +
       import sys

     

       5
        
       import tempfile

     

       6
        
       import threading

     

       7
       +
       import traceback

     

       8
        
       from collections.abc import Callable, Iterator

     

       9
        
       from contextlib import AbstractContextManager, contextmanager

     

       10
        
       from pathlib import Path

     

       11
        
       from typing import Any

     

       12
       +
       from unittest import TestCase

     

       13
        
       

     

       14
        
       from test_driver.logger import AbstractLogger

     

       15
        
       from test_driver.machine import Machine, NixStartScript, retry

     
···

       39
        
       

     

       40
        
       def pythonize_name(name: str) -> str:

     

       41
        
           return re.sub(r"^[^A-z_]|[^A-z0-9_]", "_", name)

     

       42
       +
       

     

       43
       +
       

     

       44
       +
       class NixOSAssertionError(AssertionError):

     

       45
       +
           pass

     

       46
       +
       

     

       47
       +
       

     

       48
       +
       class Tester(TestCase):

     

       49
       +
           failureException = NixOSAssertionError

     

       50
        
       

     

       51
        
       

     

       52
        
       class Driver:

     
···

       151
        
                   serial_stdout_on=self.serial_stdout_on,

     

       152
        
                   polling_condition=self.polling_condition,

     

       153
        
                   Machine=Machine,  # for typing

     

       154
       +
                   t=Tester(),

     

       155
        
               )

     

       156
        
               machine_symbols = {pythonize_name(m.name): m for m in self.machines}

     

       157
        
               # If there's exactly one machine, make it available under the name

     
···

       175
        
               """Run the test script"""

     

       176
        
               with self.logger.nested("run the VM test script"):

     

       177
        
                   symbols = self.test_symbols()  # call eagerly

     

       178
       +
                   try:

     

       179
       +
                       exec(self.tests, symbols, None)

     

       180
       +
                   except NixOSAssertionError:

     

       181
       +
                       exc_type, exc, tb = sys.exc_info()

     

       182
       +
                       filtered = [

     

       183
       +
                           frame

     

       184
       +
                           for frame in traceback.extract_tb(tb)

     

       185
       +
                           if frame.filename == "<string>"

     

       186
       +
                       ]

     

       187
       +
       

     

       188
       +
                       self.logger.log_test_error("Traceback (most recent call last):")

     

       189
       +
                       code = self.tests.splitlines()

     

       190
       +
                       for frame, line in zip(filtered, traceback.format_list(filtered)):

     

       191
       +
                           self.logger.log_test_error(line.rstrip())

     

       192
       +
                           if lineno := frame.lineno:

     

       193
       +
                               self.logger.log_test_error(

     

       194
       +
                                   f"    {code[lineno - 1].strip()}",

     

       195
       +
                               )

     

       196
       +
       

     

       197
       +
                       self.logger.log_test_error("") # blank line for readability

     

       198
       +
                       exc_prefix = exc_type.__name__ if exc_type is not None else "Error"

     

       199
       +
                       for line in f"{exc_prefix}: {exc}".splitlines():

     

       200
       +
                           self.logger.log_test_error(line)

     

       201
       +
       

     

       202
       +
                       sys.exit(1)

     

       203
        
       

     

       204
        
           def run_tests(self) -> None:

     

       205
        
               """Run the test script (for non-interactive test runs)"""

+19

nixos/lib/test-driver/src/test_driver/logger.py

···

       45
        
               pass

     

       46
        
       

     

       47
        
           @abstractmethod

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       48
        
           def log_serial(self, message: str, machine: str) -> None:

     

       49
        
               pass

     

       50
        
       

     
···

       97
        
               self.tests[self.currentSubtest].stderr += args[0] + os.linesep

     

       98
        
               self.tests[self.currentSubtest].failure = True

     

       99
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       100
        
           def log_serial(self, message: str, machine: str) -> None:

     

       101
        
               if not self._print_serial_logs:

     

       102
        
                   return

     
···

       156
        
               for logger in self.logger_list:

     

       157
        
                   logger.warning(*args, **kwargs)

     

       158
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       159
        
           def error(self, *args, **kwargs) -> None:  # type: ignore

     

       160
        
               for logger in self.logger_list:

     

       161
        
                   logger.error(*args, **kwargs)

     
···

       222
        
       

     

       223
        
               self._eprint(Style.DIM + f"{machine} # {message}" + Style.RESET_ALL)

     

       224
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       225
        
       

     

       226
        
       class XMLLogger(AbstractLogger):

     

       227
        
           def __init__(self, outfile: str) -> None:

     
···

       259
        
               self.log(*args, **kwargs)

     

       260
        
       

     

       261
        
           def error(self, *args, **kwargs) -> None:  # type: ignore

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       262
        
               self.log(*args, **kwargs)

     

       263
        
       

     

       264
        
           def log(self, message: str, attributes: dict[str, str] = {}) -> None:

···

       45
        
               pass

     

       46
        
       

     

       47
        
           @abstractmethod

     

       48
       +
           def log_test_error(self, *args, **kwargs) -> None:  # type:ignore

     

       49
       +
               pass

     

       50
       +
       

     

       51
       +
           @abstractmethod

     

       52
        
           def log_serial(self, message: str, machine: str) -> None:

     

       53
        
               pass

     

       54
        
       

     
···

       101
        
               self.tests[self.currentSubtest].stderr += args[0] + os.linesep

     

       102
        
               self.tests[self.currentSubtest].failure = True

     

       103
        
       

     

       104
       +
           def log_test_error(self, *args, **kwargs) -> None:  # type: ignore

     

       105
       +
               self.error(*args, **kwargs)

     

       106
       +
       

     

       107
        
           def log_serial(self, message: str, machine: str) -> None:

     

       108
        
               if not self._print_serial_logs:

     

       109
        
                   return

     
···

       163
        
               for logger in self.logger_list:

     

       164
        
                   logger.warning(*args, **kwargs)

     

       165
        
       

     

       166
       +
           def log_test_error(self, *args, **kwargs) -> None:  # type: ignore

     

       167
       +
               for logger in self.logger_list:

     

       168
       +
                   logger.log_test_error(*args, **kwargs)

     

       169
       +
       

     

       170
        
           def error(self, *args, **kwargs) -> None:  # type: ignore

     

       171
        
               for logger in self.logger_list:

     

       172
        
                   logger.error(*args, **kwargs)

     
···

       233
        
       

     

       234
        
               self._eprint(Style.DIM + f"{machine} # {message}" + Style.RESET_ALL)

     

       235
        
       

     

       236
       +
           def log_test_error(self, *args, **kwargs) -> None:  # type: ignore

     

       237
       +
               prefix = Fore.RED + "!!! " + Style.RESET_ALL

     

       238
       +
               # NOTE: using `warning` instead of `error` to ensure it does not exit after printing the first log

     

       239
       +
               self.warning(f"{prefix}{args[0]}", *args[1:], **kwargs)

     

       240
       +
       

     

       241
        
       

     

       242
        
       class XMLLogger(AbstractLogger):

     

       243
        
           def __init__(self, outfile: str) -> None:

     
···

       275
        
               self.log(*args, **kwargs)

     

       276
        
       

     

       277
        
           def error(self, *args, **kwargs) -> None:  # type: ignore

     

       278
       +
               self.log(*args, **kwargs)

     

       279
       +
       

     

       280
       +
           def log_test_error(self, *args, **kwargs) -> None:  # type: ignore

     

       281
        
               self.log(*args, **kwargs)

     

       282
        
       

     

       283
        
           def log(self, message: str, attributes: dict[str, str] = {}) -> None:

nixos/lib/test-script-prepend.py

···

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

     

       9
        
       from typing_extensions import Protocol

     

       10
        
       from pathlib import Path

     

       0
        
       
     

       11
        
       

     

       12
        
       

     

       13
        
       class RetryProtocol(Protocol):

     
···

       51
        
       serial_stdout_off: Callable[[], None]

     

       52
        
       serial_stdout_on: Callable[[], None]

     

       53
        
       polling_condition: PollingConditionProtocol

     

       0

···

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

     

       9
        
       from typing_extensions import Protocol

     

       10
        
       from pathlib import Path

     

       11
       +
       from unittest import TestCase

     

       12
        
       

     

       13
        
       

     

       14
        
       class RetryProtocol(Protocol):

     
···

       52
        
       serial_stdout_off: Callable[[], None]

     

       53
        
       serial_stdout_on: Callable[[], None]

     

       54
        
       polling_condition: PollingConditionProtocol

     

       55
       +
       t: TestCase