nixos/test-driver: Typecheck TestScript

Changed files
+66 -3
nixos
+2
nixos/lib/test-driver/default.nix
···
checkPhase = ''
mypy --disallow-untyped-defs \
--no-implicit-optional \
--ignore-missing-imports ${src}/test_driver
pylint --errors-only --enable=unused-import ${src}/test_driver
black --check --diff ${src}/test_driver
···
checkPhase = ''
mypy --disallow-untyped-defs \
--no-implicit-optional \
+
--pretty \
+
--no-color-output \
--ignore-missing-imports ${src}/test_driver
pylint --errors-only --enable=unused-import ${src}/test_driver
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
···
···
+
# This file contains type hints that can be prepended to Nix test scripts so they can be type
+
# checked.
+
+
from test_driver.driver import Driver
+
from test_driver.vlan import VLan
+
from test_driver.machine import Machine
+
from test_driver.logger import Logger
+
from typing import Callable, Iterator, ContextManager, Optional, List, Dict, Any, Union
+
from typing_extensions import Protocol
+
from pathlib import Path
+
+
+
class RetryProtocol(Protocol):
+
def __call__(self, fn: Callable, timeout: int = 900) -> None:
+
raise Exception("This is just type information for the Nix test driver")
+
+
+
class PollingConditionProtocol(Protocol):
+
def __call__(
+
self,
+
fun_: Optional[Callable] = None,
+
*,
+
seconds_interval: float = 2.0,
+
description: Optional[str] = None,
+
) -> Union[Callable[[Callable], ContextManager], ContextManager]:
+
raise Exception("This is just type information for the Nix test driver")
+
+
+
start_all: Callable[[], None]
+
subtest: Callable[[str], ContextManager[None]]
+
retry: RetryProtocol
+
test_script: Callable[[], None]
+
machines: List[Machine]
+
vlans: List[VLan]
+
driver: Driver
+
log: Logger
+
create_machine: Callable[[Dict[str, Any]], Machine]
+
run_tests: Callable[[], None]
+
join_all: Callable[[], None]
+
serial_stdout_off: Callable[[], None]
+
serial_stdout_on: Callable[[], None]
+
polling_condition: PollingConditionProtocol
+22 -3
nixos/lib/testing-python.nix
···
nodeHostNames = let
nodesList = map (c: c.config.system.name) (lib.attrValues nodes);
-
in nodesList ++ lib.optional (lib.length nodesList == 1) "machine";
# TODO: This is an implementation error and needs fixing
# the testing famework cannot legitimately restrict hostnames further
···
then testScript { inherit nodes; }
else testScript;
in
if lib.length invalidNodeNames > 0 then
throw ''
···
else lib.warnIf skipLint "Linting is disabled" (runCommand testDriverName
{
inherit testName;
-
nativeBuildInputs = [ makeWrapper ];
testScript = testScript';
preferLocalBuild = true;
passthru = passthru // {
···
mkdir -p $out/bin
vmStartScripts=($(for i in ${toString vms}; do echo $i/bin/run-*-vm; done))
-
echo -n "$testScript" > $out/test-script
ln -s ${testDriver}/bin/nixos-test-driver $out/bin/nixos-test-driver
${testDriver}/bin/generate-driver-symbols
···
nodeHostNames = let
nodesList = map (c: c.config.system.name) (lib.attrValues nodes);
+
in nodesList ++ lib.optional (lib.length nodesList == 1 && !lib.elem "machine" nodesList) "machine";
# TODO: This is an implementation error and needs fixing
# the testing famework cannot legitimately restrict hostnames further
···
then testScript { inherit nodes; }
else testScript;
+
uniqueVlans = lib.unique (builtins.concatLists vlans);
+
vlanNames = map (i: "vlan${toString i}: VLan;") uniqueVlans;
+
machineNames = map (name: "${name}: Machine;") nodeHostNames;
in
if lib.length invalidNodeNames > 0 then
throw ''
···
else lib.warnIf skipLint "Linting is disabled" (runCommand testDriverName
{
inherit testName;
+
nativeBuildInputs = [ makeWrapper mypy ];
testScript = testScript';
preferLocalBuild = true;
passthru = passthru // {
···
mkdir -p $out/bin
vmStartScripts=($(for i in ${toString vms}; do echo $i/bin/run-*-vm; done))
+
+
# prepend type hints so the test script can be type checked with mypy
+
cat "${./test-script-prepend.py}" >> testScriptWithTypes
+
echo "${builtins.toString machineNames}" >> testScriptWithTypes
+
echo "${builtins.toString vlanNames}" >> testScriptWithTypes
+
echo -n "$testScript" >> testScriptWithTypes
+
+
# set pythonpath so mypy knows where to find the imports. this requires the py.typed file.
+
export PYTHONPATH='${./test-driver}'
+
mypy --no-implicit-optional \
+
--pretty \
+
--no-color-output \
+
testScriptWithTypes
+
unset PYTHONPATH
+
+
echo -n "$testScript" >> $out/test-script
+
ln -s ${testDriver}/bin/nixos-test-driver $out/bin/nixos-test-driver
${testDriver}/bin/generate-driver-symbols