Merge branch 'topic/testsuite-improvements' into 'master'

Testsuite improvements

See merge request eng/ide/ada_language_server!1830

Author: eliericha

.mypy.ini

@@ -0,0 +1,2 @@
+[mypy]
+mypy_path = $MYPY_CONFIG_FILE_DIR/testsuite

.pre-commit-config.yaml

@@ -22,6 +22,24 @@ repos:
     hooks:
       - id: mypy
         files: '\.py$'
-        # exclude: "^tests/.+$"
+        args:
+          # These flags make mypy associate different module names to `test.py`
+          # files from different test directories.
+          - --explicit-package-bases
+          - --namespace-packages
         additional_dependencies:
           - pytest-lsp
+          - e3-testsuite
+          - psutil
+          - types-psutil
+
+  - repo: local
+    hooks:
+      # This hook checks that Python test directories are valid module names so
+      # that mypy will accept to analyse multiple test.py in different
+      # directories.
+      - id: py-filenames
+        name: Python test.py paths
+        entry: Python path components should be valid modules names (e.g. no '.' or whitespace). This is for mypy to accept dealing with test.py files in different directories.
+        language: fail
+        files: 'testsuite.*[^A-Za-z0-9_\/].*test\.py$'

testsuite/drivers/pylsp.py

@@ -82,10 +82,14 @@ def run(self) -> None:
                 str(python_file),
             ]
 
-            for _ in range(0, self.env.main_options.verbose):  # type: ignore
+            assert self.env.main_options
+            for _ in range(0, self.env.main_options.verbose):
                 # Transfer -v arguments to the Python test driver to reflect verbosity
                 cmd += ["-v"]
 
+            if self.env.main_options.debug:
+                cmd.append("--debug")
+
             # Spawn a child Python process to run the test, to avoid lingering file
             # handles which can create issues on Windows when the test work dir is
             # cleaned up after execution.
@@ -95,9 +99,9 @@ def run(self) -> None:
                 "PYTHONPATH": os.path.dirname(os.path.dirname(__file__)),
             }
 
-            assert self.env.main_options
-            if self.env.main_options.debug:
-                cmd.append("--debug")
+            if self.env.main_options.debug or self.env.main_options.verbose:
+                # In this case we use Run directly without piping options to connect the
+                # subprocess directly to the parent I/O.
 
                 LOG.info(f"Run: cd {wd}; {command_line_image(cmd)}")
                 r = Run(

testsuite/drivers/shell.py

@@ -5,10 +5,10 @@
 class ShellTestDriver(ALSTestDriver):
     """
     Run the test.sh test program.
-
     """
 
-    def run(self):
+    def run(self) -> None:
+
         # This takes care of failing the test in case the return code is
         # non-zero
         check_call(
@@ -22,4 +22,5 @@ def run(self):
             # The following makes the child process inherit the parent process's
             # environment, in addition to the above environment.
             ignore_environ=False,
+            timeout=15,  # seconds
         )