Add a separate test driver for python

Add support for valgrind.
Add support for --debug.

Fixup LSP.__init__ to launch tasks only once all attributes
have been declared.

Author: setton

testsuite/ada_lsp/called_by/test.yaml

@@ -1 +1,2 @@
 title: 'called_by'
+driver: python

testsuite/ada_lsp/called_by_dispatching/test.yaml

@@ -1 +1,2 @@
 title: 'called_by_dispatching'
+driver: python

testsuite/ada_lsp/logs_cycling/test.yaml

@@ -1 +1,2 @@
 title: 'logs_cycling'
+driver: python

testsuite/drivers/basic.py

@@ -29,36 +29,16 @@ def run(self, previous_values, slot):
 
         status = TestStatus.PASS
 
-        # If there is a "test.py", evaluate it
-        if os.path.exists(os.path.join(wd, "test.py")):
-            # Load test.py as a module
-            python_file = os.path.join(wd, "test.py")
-            spec = importlib.util.spec_from_file_location("module.name", python_file)
-            module = importlib.util.module_from_spec(spec)
-            spec.loader.exec_module(module)
-
-            # Look for functions with the decorator @simple_test and run them
-            errors = [
-                f"no function with @simple_test or @complex_test found in {python_file}"
-            ]
-
-            for _, obj in inspect.getmembers(module):
-                if inspect.isfunction(obj) and (
-                    hasattr(obj, "simple_test") or hasattr(obj, "complex_test")
-                ):
-                    errors = obj(wd)
-
-            if len(errors) > 0:
-                self.result.log = "\n".join(errors)
-                status = TestStatus.FAIL
-
-            self.result.set_status(status)
+        # Safety check, make sure we're not inavertently using the wrong
+        # driver.
+        json_files = glob.glob(os.path.join(wd, "*.json"))
+        if not json_files:
+            self.result.out = "No JSON files found in %s" % wd
+            self.result.set_status(TestStatus.FAIL)
             self.push_result()
-
-            # Stop processing, do not look for .json files
             return
 
-        for json in glob.glob(os.path.join(wd, "*.json")):
+        for json in json_files:
             cmd = [self.env.tester_run, json]
             if self.env.options.format:
                 cmd.append("--format=%s" % self.env.options.format)

testsuite/drivers/lsp_python_driver.py

@@ -64,14 +64,34 @@
 #        # and the initialize/initialized/didChangeConfiguration requests
 #        # have been sent by the framework.
 
-RLIMIT_SECONDS = 10.0
+
+# Global configuration options
+# Time limit for the test globally
+RLIMIT_SECONDS = 60.0
+# Timeout for a response to a request
+RESPONSE_TIMEOUT = 2.0
+DEBUG_MODE = False
+
+
+def set_debug_mode(mode : bool = True):
+    """Set the debug mode."""
+    global DEBUG_MODE
+    DEBUG_MODE = mode
+
+
+def set_wait_factor(factor : float):
+    """Set the wait factor."""
+    global RLIMIT_SECONDS
+    global RESPONSE_TIMEOUT
+    RLIMIT_SECONDS = RLIMIT_SECONDS * factor
+    RESPONSE_TIMEOUT = RESPONSE_TIMEOUT * factor
 
 
 class LSP(object):
 
     def __init__(
         self,
-        cl: str | list[str] = "ada_language_server",
+        cl: str | list[str] | None = "ada_language_server",
         working_dir: str = ".",
         env: dict | None = None
     ):
@@ -82,6 +102,10 @@ def __init__(
 
         if env is not None:
             env = os.environ.copy() | env
+
+        if cl is None:
+            cl = os.environ.get("ALS", "ada_language_server")
+
         # Launch the lsp server, with pipes ready for input/output
         self.process = subprocess.Popen(
             cl,
@@ -106,32 +130,40 @@ def __init__(
         # Launch a task that will receive messages from the LSP server
         # and store them in a queue
         self.task = threading.Thread(target=self.receive_task)
-        self.task.start()
-
         self.k_task = threading.Thread(target=self.kill_task)
-        self.k_task.start()
 
         # Error messages encountered
         self.errors = []
 
         # A list of bytes containing everything we sent to the server
         self.replay = []
 
+        # Start the tasks after all the attributes have been declared
+        self.task.start()
+        self.k_task.start()
+
+        # If we are in debug mode, insert a debug point
+        if DEBUG_MODE:
+            self.debug_here()
+
+
     def kill_task(self):
         while True:
             time.sleep(0.2)
             now = time.time()
 
-            # If we have reached the time limit, kill the process
-            if now > self.kill_me_at:
-                self.errors.append("rlimit time limit reached")
-                self.process.kill()
-                break
+            # If we have reached the time limit, kill the process,
+            # unless we are debugging.
+            if not DEBUG_MODE:
+                if now > self.kill_me_at:
+                    self.errors.append("rlimit time limit reached")
+                    self.process.kill()
+                    break
 
             # If we have received a license to kill, check if it is time
             # to kill the process!
             if self.license_to_kill is not None:
-                if now - self.license_to_kill > 2.0:
+                if now - self.license_to_kill > RESPONSE_TIMEOUT:
                     self.process.kill()
                     break
 
@@ -163,7 +195,7 @@ def receive_task(self):
             time.sleep(0.01)
 
     def send(
-        self, message: LSPMessage, expect_response=True, timeout: float = 2.0
+        self, message: LSPMessage, expect_response=True
     ) -> LSPResponse | None:
         """Send a message to the LSP server.
         If expect_response is True, wait for a response for at most timeout seconds.
@@ -178,7 +210,7 @@ def send(
         start_time = time.time()
 
         if expect_response:
-            while time.time() - start_time <= timeout:
+            while time.time() - start_time <= RESPONSE_TIMEOUT:
                 # Check if there is something in the queue
                 if self.queue.empty():
                     time.sleep(0.1)
@@ -190,7 +222,7 @@ def send(
             return LSPResponse(
                 {
                     "error": f"response to {message.id} ({message.method})"
-                    " not received in {timeout} seconds"
+                    f" not received in {RESPONSE_TIMEOUT} seconds"
                 }
             )
 
@@ -201,7 +233,7 @@ def error(self, message):
     def debug_here(self):
         """Insert a debug point in the test."""
         print("## Debug point reached. Attach with:", file=sys.stderr)
-        print(f"    gdb --pid={self.process.pid}", file=sys.stderr)
+        print(f"    gdb -p {self.process.pid}", file=sys.stderr)
         print("", file=sys.stderr)
         print("## Press Enter to continue", file=sys.stderr)
         input()

testsuite/drivers/lsp_types.py

@@ -78,7 +78,7 @@ def assertField(self, field, expected):
         for f in fields:
             if f not in value:
                 raise ResponseAssertionError(
-                    self._line_info() + f"Field {field} not found"
+                    self._line_info() + f"Field {field} not found in {value}"
                 )
             value = value.get(f)
         if value != expected:

testsuite/drivers/python_driver.py

@@ -7,13 +7,14 @@
 import inspect
 import importlib.util
 
-from drivers.lsp_python_driver import run_simple_test
+from drivers.lsp_python_driver import set_debug_mode, set_wait_factor
 
 
 class PythonTestDriver(ALSTestDriver):
     """Each test should have:
     - a test.yaml containing
           title: '<test name>'
+          driver: python
 
     - a number of test drivers, in .json files.
     """
@@ -28,6 +29,16 @@ def run(self, previous_values, slot):
 
         status = TestStatus.PASS
 
+        os.environ["ALS"] = self.env.als
+        os.environ["ALS_HOME"] = self.env.als_home
+
+        if self.env.main_options.debug:
+            set_debug_mode(True)
+
+        if self.env.wait_factor:
+            set_wait_factor(self.env.wait_factor)
+
+
         # If there is a "test.py", evaluate it
         if os.path.exists(os.path.join(wd, "test.py")):
             # Load test.py as a module