Create a test to check for early project loading

Author: eliericha

testsuite/ada_lsp/early_project_load/prj.gpr

@@ -0,0 +1,5 @@
+project Prj is
+   package Gnattest is
+      for Harness_Dir use "myharness";
+   end Gnattest;
+end Prj;

testsuite/ada_lsp/early_project_load/test.py

@@ -0,0 +1,21 @@
+"""
+The goal of this test is to check that the ALS loads the project early in the session,
+such that immediately after the initialization sequence, it is possible to inspect
+project attributes without opening any Ada sources or sending a configuration change to
+force a project load.
+"""
+
+from drivers.pylsp import ALSLanguageClient, test
+
+
+@test(
+    # Sending initializationOptions should cause the ALS to load a project early,
+    # when handling the `initialized` notification. So we give an empty settings
+    # dictionary to force the sending of initializationOptions.
+    als_settings={}
+)
+async def t1(lsp: ALSLanguageClient):
+    # Query a project attribute
+    result = await lsp.getProjectAttributeValue("harness_dir", "gnattest")
+
+    lsp.assertEqual(result, "myharness")

testsuite/ada_lsp/early_project_load/test.yaml

@@ -0,0 +1 @@
+driver: pylsp

testsuite/drivers/pylsp.py

@@ -485,6 +485,27 @@ async def sleep(self, seconds: float) -> None:
         wait_factor: int = int(os.environ.get("ALS_WAIT_FACTOR", "1"))
         await asyncio.sleep(seconds * wait_factor)
 
+    async def getProjectAttributeValue(
+        self, attribute: str, pkg: str = "", index: str = ""
+    ) -> str | list[str]:
+        """Send a workspace/executeCommand request with command
+        'als-get-project-attribute-value' to retrieve an attribute of the loaded
+        project.
+        """
+        result = await self.workspace_execute_command_async(
+            ExecuteCommandParams(
+                command="als-get-project-attribute-value",
+                arguments=[{"attribute": attribute, "pkg": pkg, "index": index}],
+            )
+        )
+
+        assert isinstance(result, str) or (
+            isinstance(result, list)
+            and all(lambda x: isinstance(x, str) for x in result)
+        ), f"Unexpected type of result: {result}"
+
+        return result
+
 
 def als_client_factory() -> ALSLanguageClient:
     """This function is an ugly copy-paste of pytest_lsp.make_test_lsp_client. It is
@@ -634,7 +655,7 @@ def test(
     """
 
     async def async_wrapper(
-        func: Callable[[ALSLanguageClient], Awaitable[object]]
+        func: Callable[[ALSLanguageClient], Awaitable[object]],
     ) -> None:
         als = os.environ.get("ALS", "ada_language_server")
         command = [als]