Merge branch 'topic/als-ts' into 'master'

Migrate to ClassicTestDriver

See merge request eng/ide/ada_language_server!1751

Author: eliericha

.gitlab-ci.yml

@@ -27,7 +27,7 @@ include:
   - component: $CI_SERVER_FQDN/eng/gitlab-templates/test@~latest
     inputs:
       job-name: als-cov
-      anod-args: run test_als_cov_$ACI_TRACK
+      anod-args: run test_als_cov_$ACI_TRACK --latest
       image: systemgtk
       # This job needs to rebuild ALS in coverage mode, so it doesn't need to
       # depend on the build job. The following will get it to run in parallel

testsuite/ada_lsp/F131-024.xrefs.separate_body/test.yaml

@@ -2,5 +2,5 @@ title: 'F131-024.xrefs.separate_body'
 
 # This test is expected to fail until eng/libadalang/libadalang#1409
 # is fixed.
-skip:
+control:
     - ['XFAIL', 'True']

testsuite/ada_lsp/U910-043.client_capabilities.optional/test.yaml

@@ -1,4 +1,4 @@
 title: 'U910-043.client_capabilities.optional'
 # Skip till 3.17 ready
-skip:
+control:
     - ['XFAIL', 'True']

testsuite/ada_lsp/UA28-007.Did_Change_Watched_Files_0/test.yaml

@@ -1,3 +1,3 @@
 title: 'UA28-007.Did_Change_Watched_Files_0'
-skip:
+control:
     - ['SKIP', 'env.build.os.name == "windows"']

testsuite/ada_lsp/UA28-007.Did_Delete_Files_0/test.yaml

@@ -1,3 +1,3 @@
 title: 'UA28-007.Did_Delete_Files_0'
-skip:
+control:
     - ['SKIP', 'env.build.os.name == "windows"']

testsuite/ada_lsp/called_by_dispatching/test.py

@@ -1,10 +1,14 @@
 """test that callHierarchy/incomingCalls works for dispatching calls"""
 
-from drivers.lsp_python_driver import simple_test
-from drivers.lsp_ada_requests import didOpen_from_disk, prepareCallHierarchy, incomingCalls
-from drivers.lsp_types import LSPMessage, URI
 import os
 
+from drivers.lsp_ada_requests import (
+    didOpen_from_disk,
+    incomingCalls,
+    prepareCallHierarchy,
+)
+from drivers.lsp_python_driver import simple_test
+
 
 @simple_test
 def test_called_by(lsp, wd):
@@ -19,7 +23,7 @@ def test_called_by(lsp, wd):
     response = lsp.send(prepareCallHierarchy(main_adb, 7, 4))
 
     # Expect these locations
-    response.assertLocationsList([("root.ads",5)])
+    response.assertLocationsList([("root.ads", 5)])
 
     # Now send the callHierarchy/incomingCalls request
     response = lsp.send(incomingCalls(root_ads, 5, 14))

testsuite/ada_lsp/completion.invisible.runtime/test.yaml

@@ -1,5 +1,5 @@
 title: 'completion.invisible.runtime'
 # Test only on Linux, since runtime source locations can be
 # different depending on the platform
-skip:
+control:
     - ['SKIP', 'env.build.os.name != "linux"']

testsuite/ada_lsp/project_config.alire/test.yaml

@@ -1,3 +1,3 @@
 title: 'project_config.alire'
-skip:
+control:
     - ['SKIP', 'env.build.os.name == "windows"']

testsuite/ada_lsp/project_symlinks/test.yaml

@@ -1,3 +1,3 @@
 title: 'project_symlinks'
-skip:
+control:
     - ['SKIP', 'env.build.os.name == "windows"']

testsuite/drivers/__init__.py

@@ -1,71 +1,34 @@
-import logging
 import os
-import traceback
 
-from e3.fs import sync_tree
 from e3.os.fs import df
 from e3.os.process import Run
-from e3.testsuite.driver import TestDriver
-from e3.testsuite.result import Log, TestStatus
+from e3.testsuite.control import TestControlCreator, YAMLTestControlCreator
+from e3.testsuite.driver.classic import ClassicTestDriver, ProcessResult
+from e3.testsuite.result import Log
 
-from drivers.gnatcov import GNATcov
-
-
-TESTSUITE_ROOT_DIR = os.path.dirname(
-    os.path.dirname(os.path.abspath(__file__)))
+TESTSUITE_ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 
 PACKAGE_ROOT_DIR = os.path.dirname(TESTSUITE_ROOT_DIR)
 
 
-class ALSTestDriver(TestDriver):
+class ALSTestDriver(ClassicTestDriver):
     """Abstract class to share some common facilities."""
 
-    def add_test(self, dag):
-        """
-        Default workflow for testcases.
+    @property
+    def test_control_creator(self) -> TestControlCreator:
+        eval_env = {
+            "env": self.env,
+            "test_env": self.test_env,
+            "disk_space": lambda: df(self.env.working_dir),
+        }
 
-        Subclasses are free to override this if they need anything more
-        complicated.
-        """
-        self.add_fragment(dag, 'prepare')
-        self.add_fragment(dag, 'run', after=['prepare'])
+        return YAMLTestControlCreator(eval_env)
 
-    def prepare(self, previous_values, slot):
-        """
-        Create the working directory to be a copy of the test directory.
-        """
-        sync_tree(self.test_env['test_dir'],
-                  self.test_env['working_dir'])
-
-    def should_skip(self):
-        """Handle of 'skip' in test.yaml.
+    def shell(self, *args, **kwargs) -> ProcessResult:
+        if self.env.gnatcov:
+            kwargs = self.env.gnatcov.decorate_run(self, kwargs)
 
-        If the test should be skipped according to test.yaml, push the result
-        and return True. Otherwise, just return false.
-        """
-        status = None
-        if 'skip' in self.test_env:
-            eval_env = {
-                'env': self.env,
-                'test_env': self.test_env,
-                'disk_space': lambda: df(self.env.working_dir)}
-
-            for candidate_status, expr in self.test_env['skip']:
-                try:
-                    if eval(expr, eval_env):
-                        status = TestStatus[candidate_status]
-                        break
-                except Exception:
-                    logging.error(traceback.format_exc())
-                    status = TestStatus.ERROR
-                    break
-
-        if status is None:
-            return False
-        else:
-            self.result.set_status(status)
-            self.push_result()
-            return True
+        return super().shell(*args, **kwargs)
 
     def run_and_log(self, cmd, **kwargs):
         """
@@ -83,11 +46,14 @@ def run_and_log(self, cmd, **kwargs):
 
         process = Run(cmd, **kwargs)
 
-        self.result.processes.append({
-            'cmd': cmd,
-            'run_args': kwargs,
-            'status': process.status,
-            'output': Log(process.out)})
+        self.result.processes.append(
+            {
+                "cmd": cmd,
+                "run_args": kwargs,
+                "status": process.status,
+                "output": Log(process.out),
+            }
+        )
 
         if "Log:" in process.out:
             output, log = process.out.split("Log:")