Factorize Alire stub and make it reusable by any test

Author: eliericha

testsuite/ada_lsp/project_config.alire/.alr_printenv

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

testsuite/ada_lsp/project_config.alire/alr

@@ -38,8 +38,31 @@ def shell(self, *args, **kwargs) -> ProcessResult:
         if self.env.gnatcov:
             kwargs = self.env.gnatcov.decorate_run(self, kwargs)
 
+        kwargs = self.add_alire_stub(kwargs)
+
         return super().shell(*args, **kwargs)
 
+    def add_alire_stub(self, kwargs) -> dict:
+        """Optionally add an Alire stub to the environment used for a e3.os.process.Run
+        call, if the test.yaml sets 'use-alire-stub: True'.
+        """
+        if self.test_env.get("use-alire-stub", False):
+            kwargs = dict(kwargs)
+            env = kwargs.setdefault("env", {})
+            alire_stub = self.alire_stub_path
+            path = env.get("PATH", os.environ["PATH"])
+            env["PATH"] = os.pathsep.join([alire_stub, path])
+
+            # Default to merging the above env with the parent env
+            kwargs.setdefault("ignore_environ", False)
+
+        return kwargs
+
+    @property
+    def alire_stub_path(self):
+        """Path to the Alire stub provided by the testsuite"""
+        return os.path.join(self.env.root_dir, "shared", "alire-stub")
+
     def run_and_log(self, cmd, **kwargs):
         """
         Wrapper around e3.os.process.Run to log processes.
@@ -54,6 +77,8 @@ def run_and_log(self, cmd, **kwargs):
         if self.env.gnatcov:
             kwargs = self.env.gnatcov.decorate_run(self, kwargs)
 
+        kwargs = self.add_alire_stub(kwargs)
+
         process = Run(cmd, **kwargs)
 
         self.result.processes.append(

testsuite/ada_lsp/project_config.alire/test.yaml

@@ -469,6 +469,10 @@ def assertEqual(self, actual: Any, expected: Any) -> None:
         """Raise an AssertionError if actual != expected."""
         assertEqual(actual, expected)
 
+    def assertNotEqual(self, actual: Any, expected: Any) -> None:
+        """Raise an AssertionError if actual == expected."""
+        assertNotEqual(actual, expected)
+
     def assertLocationsList(
         self,
         actual: Sequence[CallHierarchyItem | CallHierarchyIncomingCall],
@@ -905,7 +909,22 @@ def find_ALS_process():
 def assertEqual(actual: Any, expected: Any) -> None:
     """Raise an AssertionError if actual != expected."""
     if actual != expected:
-        msg = f"\n### Actual ###\n{actual}\n### Expected ###\n{expected}"
+        msg = (
+            "Expected actual == expected"
+            f"\n### Actual ###\n{actual}"
+            f"\n### Expected ###\n{expected}"
+        )
+        raise AssertionError(msg)
+
+
+def assertNotEqual(actual: Any, expected: Any) -> None:
+    """Raise an AssertionError if actual == expected."""
+    if actual == expected:
+        msg = (
+            "Expected actual != expected"
+            f"\n### Actual ###\n{actual}"
+            f"\n### Expected ###\n{expected}"
+        )
         raise AssertionError(msg)
 
 

testsuite/drivers/__init__.py

@@ -1,3 +1,4 @@
 title: 'project_config.alire'
+use-alire-stub: True
 control:
     - ['SKIP', 'env.build.os.name not in ("linux")']