tests: Factor out common helper functions to separate Python module.

The test runners have evolved over time and become more and more complex.
In particular `tests/run-tests.py` is rather large now.  The test runners
also duplicate some functionality amongst themselves.

As a start to improving this situation, this commit factors out the helper
functions from `run-tests.py` into a new `test_utils.py` file, and uses
that new module in all test runners.

There should be no functional change here.

Signed-off-by: Damien George <damien@micropython.org>

Author: dpgeorge

tests/run-internalbench.py

@@ -8,9 +8,14 @@
 from glob import glob
 from collections import defaultdict
 
-run_tests_module = __import__("run-tests")
-sys.path.append(run_tests_module.base_path("../tools"))
-import pyboard
+from test_utils import (
+    base_path,
+    pyboard,
+    test_instance_description,
+    test_instance_epilog,
+    test_directory_description,
+    get_test_instance,
+)
 
 if os.name == "nt":
     MICROPYTHON = os.getenv(
@@ -97,10 +102,10 @@ def main():
         formatter_class=argparse.RawDescriptionHelpFormatter,
         description=f"""Run and manage tests for MicroPython.
 
-{run_tests_module.test_instance_description}
-{run_tests_module.test_directory_description}
+{test_instance_description}
+{test_directory_description}
 """,
-        epilog=run_tests_module.test_instance_epilog,
+        epilog=test_instance_epilog,
     )
     cmd_parser.add_argument(
         "-t", "--test-instance", default="unix", help="the MicroPython instance to test"
@@ -124,9 +129,7 @@ def main():
     args = cmd_parser.parse_args()
 
     # Note pyboard support is copied over from run-tests.py, not tests, and likely needs revamping
-    pyb = run_tests_module.get_test_instance(
-        args.test_instance, args.baudrate, args.user, args.password
-    )
+    pyb = get_test_instance(args.test_instance, args.baudrate, args.user, args.password)
 
     if len(args.files) == 0:
         if args.test_dirs:

tests/run-multitests.py

@@ -15,7 +15,13 @@
 import subprocess
 import tempfile
 
-run_tests_module = __import__("run-tests")
+from test_utils import (
+    base_path,
+    pyboard,
+    test_instance_epilog,
+    convert_device_shortcut_to_real_device,
+    create_test_report,
+)
 
 test_dir = os.path.abspath(os.path.dirname(__file__))
 
@@ -24,9 +30,6 @@
     # accidentally importing tests like micropython/const.py
     sys.path.pop(0)
 
-sys.path.insert(0, test_dir + "/../tools")
-import pyboard
-
 if os.name == "nt":
     CPYTHON3 = os.getenv("MICROPY_CPYTHON3", "python3.exe")
     MICROPYTHON = os.path.abspath(
@@ -554,7 +557,7 @@ def main():
     cmd_parser = argparse.ArgumentParser(
         description="Run network tests for MicroPython",
         epilog=(
-            run_tests_module.test_instance_epilog
+            test_instance_epilog
             + "Each instance arg can optionally have custom env provided, eg. <cmd>,ENV=VAR,ENV=VAR...\n"
         ),
         formatter_class=argparse.RawTextHelpFormatter,
@@ -582,7 +585,7 @@ def main():
     cmd_parser.add_argument(
         "-r",
         "--result-dir",
-        default=run_tests_module.base_path("results"),
+        default=base_path("results"),
         help="directory for test results",
     )
     cmd_parser.add_argument("files", nargs="+", help="input test files")
@@ -612,7 +615,7 @@ def main():
             print("unsupported instance string: {}".format(cmd), file=sys.stderr)
             sys.exit(2)
         else:
-            device = run_tests_module.convert_device_shortcut_to_real_device(cmd)
+            device = convert_device_shortcut_to_real_device(cmd)
             instances_test.append(PyInstancePyboard(device))
 
     for _ in range(max_instances - len(instances_test)):
@@ -626,7 +629,7 @@ def main():
                 break
 
             test_results = run_tests(test_files, instances_truth, instances_test_permutation)
-            all_pass &= run_tests_module.create_test_report(cmd_args, test_results)
+            all_pass &= create_test_report(cmd_args, test_results)
 
     finally:
         for i in instances_truth:

tests/run-natmodtests.py

@@ -9,7 +9,13 @@
 import sys
 import argparse
 
-run_tests_module = __import__("run-tests")
+from test_utils import (
+    base_path,
+    pyboard,
+    test_instance_epilog,
+    get_test_instance,
+    create_test_report,
+)
 
 # Paths for host executables
 CPYTHON3 = os.getenv("MICROPY_CPYTHON3", "python3")
@@ -110,7 +116,7 @@ def run_script(self, script):
             output = self.pyb.exec_(script)
             output = output.replace(b"\r\n", b"\n")
             return output, None
-        except run_tests_module.pyboard.PyboardError as er:
+        except pyboard.PyboardError as er:
             return b"", er
 
 
@@ -221,7 +227,7 @@ def main():
 
     cmd_parser = argparse.ArgumentParser(
         description="Run dynamic-native-module tests under MicroPython",
-        epilog=run_tests_module.test_instance_epilog,
+        epilog=test_instance_epilog,
         formatter_class=argparse.RawDescriptionHelpFormatter,
     )
     cmd_parser.add_argument(
@@ -243,7 +249,7 @@ def main():
     cmd_parser.add_argument(
         "-r",
         "--result-dir",
-        default=run_tests_module.base_path("results"),
+        default=base_path("results"),
         help="directory for test results",
     )
     cmd_parser.add_argument("files", nargs="*", help="input test files")
@@ -257,9 +263,7 @@ def main():
 
     target_truth = TargetSubprocess([CPYTHON3])
 
-    target = run_tests_module.get_test_instance(
-        args.test_instance, args.baudrate, args.user, args.password
-    )
+    target = get_test_instance(args.test_instance, args.baudrate, args.user, args.password)
     if target is None:
         # Use the unix port of MicroPython.
         target = TargetSubprocess([MICROPYTHON])
@@ -283,7 +287,7 @@ def main():
 
     os.makedirs(args.result_dir, exist_ok=True)
     test_results = run_tests(target_truth, target, args, target_arch)
-    res = run_tests_module.create_test_report(args, test_results)
+    res = create_test_report(args, test_results)
 
     target.close()
     target_truth.close()

tests/run-perfbench.py

@@ -10,9 +10,13 @@
 import argparse
 from glob import glob
 
-run_tests_module = __import__("run-tests")
-
-prepare_script_for_target = run_tests_module.prepare_script_for_target
+from test_utils import (
+    base_path,
+    pyboard,
+    get_test_instance,
+    prepare_script_for_target,
+    create_test_report,
+)
 
 # Paths for host executables
 if os.name == "nt":
@@ -49,7 +53,7 @@ def run_script_on_target(target, script):
         try:
             target.enter_raw_repl()
             output = target.exec_(script)
-        except run_tests_module.pyboard.PyboardError as er:
+        except pyboard.PyboardError as er:
             err = er
     else:
         # Run local executable
@@ -277,7 +281,7 @@ def main():
     cmd_parser.add_argument(
         "-r",
         "--result-dir",
-        default=run_tests_module.base_path("results"),
+        default=base_path("results"),
         help="directory for test results",
     )
     cmd_parser.add_argument(
@@ -298,9 +302,7 @@ def main():
     M = int(args.M[0])
     n_average = int(args.average)
 
-    target = run_tests_module.get_test_instance(
-        args.test_instance, args.baudrate, args.user, args.password
-    )
+    target = get_test_instance(args.test_instance, args.baudrate, args.user, args.password)
     if target is None:
         # Use the unix port of MicroPython.
         target = [MICROPYTHON, "-X", "emit=" + args.emit]
@@ -328,7 +330,7 @@ def main():
 
     os.makedirs(args.result_dir, exist_ok=True)
     test_results = run_benchmarks(args, target, N, M, n_average, tests)
-    res = run_tests_module.create_test_report(args, test_results)
+    res = create_test_report(args, test_results)
 
     if hasattr(target, "exit_raw_repl"):
         target.exit_raw_repl()