add opt out flag for type checking

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

@@ -332,6 +332,19 @@ repository):
     '';
 ```
 
+Similarly, the type checking of test scripts can be disabled in the following
+way:
+
+```nix
+import ./make-test-python.nix {
+  skipTypeCheck = true;
+  nodes.machine =
+    { config, pkgs, ... }:
+    { configuration…
+    };
+}
+```
+
 ## Failing tests early {#ssec-failing-tests-early}
 
 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:

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

@@ -589,6 +589,19 @@ import ./make-test-python.nix {
       Python code…
       # fmt: on
     '';
+</programlisting>
+    <para>
+      Similarly, the type checking of test scripts can be disabled in
+      the following way:
+    </para>
+    <programlisting language="bash">
+import ./make-test-python.nix {
+  skipTypeCheck = true;
+  nodes.machine =
+    { config, pkgs, ... }:
+    { configuration…
+    };
+}
 </programlisting>
   </section>
   <section xml:id="ssec-failing-tests-early">

nixos/lib/testing-python.nix

@@ -50,6 +50,7 @@ rec {
     , qemu_pkg ? pkgs.qemu_test
     , enableOCR ? false
     , skipLint ? false
+    , skipTypeCheck ? false
     , passthru ? {}
     , interactive ? false
   }:
@@ -129,19 +130,21 @@ rec {
 
         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
+        ${lib.optionalString (!skipTypeCheck) ''
-        cat "${./test-script-prepend.py}" >> testScriptWithTypes
+          # prepend type hints so the test script can be type checked with mypy
-        echo "${builtins.toString machineNames}" >> testScriptWithTypes
+          cat "${./test-script-prepend.py}" >> testScriptWithTypes
-        echo "${builtins.toString vlanNames}" >> testScriptWithTypes
+          echo "${builtins.toString machineNames}" >> testScriptWithTypes
-        echo -n "$testScript" >> 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.
+          # set pythonpath so mypy knows where to find the imports. this requires the py.typed file.
-        export PYTHONPATH='${./test-driver}'
+          export PYTHONPATH='${./test-driver}'
-        mypy  --no-implicit-optional \
+          mypy  --no-implicit-optional \
-              --pretty \
+                --pretty \
-              --no-color-output \
+                --no-color-output \
-              testScriptWithTypes
+                testScriptWithTypes
-        unset PYTHONPATH
+          unset PYTHONPATH
+        ''}
 
         echo -n "$testScript" >> $out/test-script
 
@@ -171,6 +174,7 @@ rec {
     , testScript
     , enableOCR ? false
     , name ? "unnamed"
+    , skipTypeCheck ? false
       # Skip linting (mainly intended for faster dev cycles)
     , skipLint ? false
     , passthru ? {}
@@ -232,13 +236,13 @@ rec {
           );
 
       driver = setupDriverForTest {
-        inherit testScript enableOCR skipLint passthru;
+        inherit testScript enableOCR skipTypeCheck skipLint passthru;
         testName = name;
         qemu_pkg = pkgs.qemu_test;
         nodes = mkNodes pkgs.qemu_test;
       };
       driverInteractive = setupDriverForTest {
-        inherit testScript enableOCR skipLint passthru;
+        inherit testScript enableOCR skipTypeCheck skipLint passthru;
         testName = name;
         qemu_pkg = pkgs.qemu;
         nodes = mkNodes pkgs.qemu;