Merge branch 'topic/ci-win' into 'master'

Add CIs on Windows

See merge request eng/ide/ada_language_server!1839

Author: eliericha

.gitlab-ci.plan

@@ -1,7 +1,7 @@
 def build_(qualifier={}):
     with defaults(qualifier=qualifier):
         anod_build("als")
-        anod_build("vscode-extension")
+        anod_build("vscode-extension", qualifier={"mono-plat": True})
 
 
 def test_als_(qualifier={}):
@@ -19,10 +19,10 @@ def test_als_cov_(qualifier={}):
 
 
 def test_vscode_extension_(qualifier={}):
-    with defaults(qualifier=qualifier):
-        # Install the component built in the preceding CI build job
-        anod_install("vscode-extension")
-        anod_test("vscode-extension", qualifier=qualifier | {"coverage": True})
+    component_qual = qualifier | {"mono-plat": True}
+    # Install the component built in the preceding CI build job
+    anod_install("vscode-extension", qualifier=component_qual)
+    anod_test("vscode-extension", qualifier=component_qual | {"coverage": True})
 
 
 def build_test_gs_(qualifier={}):
@@ -62,14 +62,29 @@ def build_test_gs_edge():
 
 
 def test_integration_testsuite():
-    # The two components below have been built by the build job of the CI
+    # These two components have been built by the build job of the CI, install them.
     anod_install("als")
-    anod_install("vscode-extension")
-    # Install gps component to avoid it getting rebuilt. We are only interested in
-    # vscode tests in the integration-testsuite, not gps.
-    anod_install("gps")
+    anod_install("vscode-extension", qualifier={"mono-plat": True})
+
+    # For the following components, we'd like to install with latest=True to be
+    # resilient to failures in nightly builds.
+    #
+    # We need to do this instead of running the whole plan with --latest because
+    # currently --latest bypasses the local offline Cathod component cache and prevents
+    # installing components built in the same CI pipeline.
+    for dep in (
+        # Install gps component to avoid it getting rebuilt. Here we are only interested
+        # in vscode tests in the integration-testsuite, not gps.
+        "gps",
+        "gnat",
+        "gnatdas",
+        "gnatsas",
+        "spark2014",
+    ):
+        anod_install(dep, latest=True)
+
     # Run the subset of integration-testsuite that uses VS Code
     anod_test(
         "integration-testsuite",
-        qualifier={"run-tools": "vscode", "cleanup-mode": "none"},
+        qualifier={"run-tools": "vscode", "cleanup-mode": "none", "mono-plat": True},
     )

.gitlab-ci.yml

@@ -21,6 +21,10 @@ include:
       cpus: 16
       disk: 80
       image: systemgtk
+      windows: true
+      windows-cpus: 8
+      # 8GB of memory leads to heap exhaustion during compilation. We need more.
+      windows-mem: 16
       save-component: true
 
   # Testing of the ALS
@@ -30,6 +34,7 @@ include:
       anod-args: run test_als_$ACI_TRACK
       image: systemgtk
       disk: 80
+      windows: true
 
   # Testing of the ALS with coverage
   - component: $CI_SERVER_FQDN/eng/gitlab-templates/test@~latest
@@ -50,6 +55,7 @@ include:
       job-name: vscode-extension
       anod-args: run test_vscode_extension_$ACI_TRACK
       image: systemgtk
+      windows: true
 
   # Integration testsuite
   - component: $CI_SERVER_FQDN/eng/gitlab-templates/test@~latest
@@ -62,6 +68,7 @@ include:
       image: systemgtk
       cpus: 4
       disk: 80
+      windows: true
       rules:
         # Does not work on edge
         - if: $CI_PIPELINE_SOURCE == 'merge_request_event' && $CI_TARGET_BRANCH_NAME != 'edge'
@@ -75,6 +82,7 @@ include:
       image: systemgtk
       disk: 80
       stage: optional
+      windows: true
       rules:
         - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
           when: manual
@@ -180,3 +188,13 @@ vscode-extension:linux:
     paths:
       - anod-logs/
       - coverage/cobertura-coverage.xml
+
+als:windows:
+  variables:
+    # In GitLab CI tests timeout more often on Windows, so we multiply
+    # testsuite timeouts by the following factor
+    ALS_WAIT_FACTOR: "2"
+
+vscode-extension:windows:
+  variables:
+    MOCHA_TIMEOUT: "30000"

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ repos:
     hooks:
       - id: flake8
         types: [file]
-        files: \.(py|anod|plan)$
+        files: \.(py)$
         additional_dependencies:
           - flake8-bugbear
           - flake8-builtins
@@ -16,7 +16,7 @@ repos:
     hooks:
       - id: black
         types_or: [file]
-        files: \.(py|plan)$
+        files: \.(py)$
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.8.0
     hooks:

integration/vscode/ada/test/general/helpers.test.ts

@@ -290,7 +290,7 @@ suite('parallelize', function () {
                  * overall the computation shouldn't take more than the
                  * time needed to process one data item (with a margin).
                  */
-                const margin = singleWorkDurationMs * 0.2;
+                const margin = singleWorkDurationMs * 0.4;
                 /**
                  * When processing 4 items with 3 threads, the first parallel
                  * batch processes 3 items and a second batch processes 1 item.
@@ -303,7 +303,7 @@ suite('parallelize', function () {
                 assert.ok(
                     duration < expectedTotalWorkDuration,
                     `The computation took ${duration}ms when we expected` +
-                        ` no more than ${expectedTotalWorkDuration}`,
+                        ` no more than ${expectedTotalWorkDuration}ms`,
                 );
             }
         });

integration/vscode/ada/test/general/tasks.test.ts

@@ -26,7 +26,8 @@ import {
 import { runTaskAndGetResult } from '../../src/taskProviders';
 
 suite('Task Providers', function () {
-    this.timeout('15s');
+    // Set timeout to 15 seconds unless already configured to more
+    this.timeout(Math.max(this.timeout(), 15000));
 
     let projectPath: string;
 

testsuite/ada_lsp/config_file/test.py

@@ -23,13 +23,19 @@
 subprocess.check_call(["gprconfig", "--batch", "--config=Ada,,light,,GNAT"])
 
 
-@test()
+@test(
+    als_settings={
+        # Disable indexing to avoid wasting computation resources and risking test
+        # timeouts
+        "enableIndexing": False
+    },
+    timeout=30,
+)
 async def do_testing(lsp: ALSLanguageClient) -> None:
     # Set configuration file
     lsp.didChangeConfig(
         {"projectFile": URI("main.gpr"), "gprConfigurationFile": URI("default.cgpr")}
     )
-    await lsp.awaitIndexingEnd()
 
     # Send a didOpen for main.adb
     open_params, main_adb_uri = didOpenTextDocumentParams("main.adb")
@@ -49,7 +55,6 @@ async def do_testing(lsp: ALSLanguageClient) -> None:
     lsp.didChangeConfig(
         {"projectFile": "main1.gpr", "gprConfigurationFile": "default.cgpr"}
     )
-    await lsp.awaitIndexingEnd()
 
     # Send a didOpen for main.adb
     open_params, main_adb_uri = didOpenTextDocumentParams("main.adb")

testsuite/ada_lsp/configuration_warning_null_setting/test.py

@@ -3,7 +3,6 @@
 not when resetting it using a null value for a setting.
 """
 
-import asyncio
 from drivers.pylsp import (
     ALSLanguageClient,
     assertEqual,
@@ -18,7 +17,14 @@
 ]
 
 
-@test()
+@test(
+    als_settings={
+        # Disable indexing to avoid wasting computation resources and risking test
+        # timeouts
+        "enableIndexing": False
+    },
+    timeout=30,
+)
 async def main(lsp: ALSLanguageClient) -> None:
     # There is no config file
     lsp.didOpenVirtual()
@@ -36,7 +42,7 @@ async def main(lsp: ALSLanguageClient) -> None:
     )
 
     # Wait for didChangeConfig to be handled
-    await asyncio.sleep(2)
+    await lsp.sleep(2)
 
     total_log_msg = len(lsp.log_messages)
     total_show_msg = len(lsp.messages)
@@ -47,7 +53,7 @@ async def main(lsp: ALSLanguageClient) -> None:
     lsp.didChangeConfig({"logThreshold": None, "insertWithClauses": None})
 
     # Wait for didChangeConfig to be handled
-    await asyncio.sleep(2)
+    await lsp.sleep(2)
 
     # Check that no messages were sent after using None/null as the value for
     # a setting

testsuite/ada_lsp/initial_memory_footprint/test.py

@@ -45,7 +45,8 @@ async def check_memory_footprint(
             "--tracefile",
             "./traces_with_runtime_indexing.cfg",
         ]
-    )
+    ),
+    timeout=30,
 )
 async def test_with_indexing(lsp: ALSLanguageClient) -> None:
     await check_memory_footprint(

testsuite/drivers/pylsp.py

@@ -100,6 +100,7 @@ def run(self) -> None:
             env = {
                 "ALS": self.env.als,
                 "ALS_HOME": self.env.als_home,
+                "ALS_WAIT_FACTOR": str(self.env.wait_factor),
                 "PYTHONPATH": os.path.dirname(os.path.dirname(__file__)),
             }
 
@@ -118,14 +119,16 @@ def run(self) -> None:
                 if r.status != 0:
                     raise TestAbortWithFailure("non-zero status code")
             else:
+                # Usually we specify a timeout here, however a test file may
+                # contain multiple tests. So instead we apply a timeout to each
+                # test in async_wrapper()
                 p: ProcessResult = self.shell(
                     cmd,
                     # Start the test process directly in the test work dir. This way
                     # tests can simply assume that the current dir is the test work dir.
                     cwd=str(wd),
                     env=env,
                     ignore_environ=False,
-                    timeout=15,  # seconds
                     stdin=None,
                 )
 
@@ -477,6 +480,11 @@ def assertLocationsList(
         """
         assertLocationsList(actual, expected)
 
+    async def sleep(self, seconds: float) -> None:
+        """Wait for the given amount of seconds multiplied by ALS_WAIT_FACTOR."""
+        wait_factor: int = int(os.environ.get("ALS_WAIT_FACTOR", "1"))
+        await asyncio.sleep(seconds * wait_factor)
+
 
 def als_client_factory() -> ALSLanguageClient:
     """This function is an ugly copy-paste of pytest_lsp.make_test_lsp_client. It is
@@ -591,6 +599,8 @@ def test(
     initialize: bool = True,
     shutdown: bool = True,
     assert_no_lsp_errors: bool = True,
+    als_settings: ALSSettings | None = None,
+    timeout=15,
 ) -> Callable:
     """A decorator to mark a function as a test entry point. The function must receive a
     single parameter of type LanguageClient.
@@ -618,6 +628,9 @@ def test(
     of the test function.
     :param assert_no_lsp_errors: automatically assert that no LSP log message of level
     error were received after the end of the test function.
+    :param als_settings: ALS settings to send as 'initializationOptions' with the
+    'initialize' request. Only applicable if initialize=True (which is the default).
+    :param timeout: test timeout in seconds
     """
 
     async def async_wrapper(
@@ -642,13 +655,22 @@ async def async_wrapper(
                         # ALS doesn't support the newer workspaceFolders property so we
                         # have to use the older rootURI property.
                         root_uri=URI(os.getcwd()),
+                        initialization_options=(
+                            {"ada": als_settings} if als_settings is not None else None
+                        ),
                     )
                 )
 
             LOG.info("Running test function: %s", func.__name__)
 
-            # Run the test
-            await func(client)
+            actual_timeout = timeout
+            if "ALS_WAIT_FACTOR" in os.environ:
+                factor = int(os.environ["ALS_WAIT_FACTOR"])
+                actual_timeout *= factor
+
+            # Run the test with a timeout
+            async with asyncio.timeout(actual_timeout):
+                await func(client)
 
             if assert_no_lsp_errors:
                 # Assert the absence of Error LSP log messages

testsuite/testsuite.py

@@ -3,8 +3,8 @@
 import datetime
 import logging
 import os
+from shutil import which
 import sys
-from distutils.spawn import find_executable
 
 from drivers.basic import JsonTestDriver
 from drivers.gnatcov import GNATcov
@@ -80,23 +80,22 @@ def lookup_program(self, *args):
             return path + ".exe"
 
         # Otherwise, look for the requested program name in the PATH.
-        #
-        # TODO (S710-005): for some reason, on Windows we need to strip the
-        # ".exe" suffix for the tester-run program to be able to spawn ALS.
-        result = find_executable(os.path.basename(path))
+        result = which(os.path.basename(path))
         if result is None:
             raise RuntimeError(
                 "Could not find executable for {}".format(os.path.basename(path))
             )
-        return result[: -len(".exe")] if result.endswith(".exe") else result
+        # TODO (S710-005): for some reason, on Windows we need to strip the
+        # ".exe" suffix for the tester-run program to be able to spawn ALS.
+        return result[: -len(".exe")] if result.lower().endswith(".exe") else result
 
     def set_up(self):
         # Root directory for the "ada_language_server" repository
         self.env.repo_base = os.path.abspath(
             os.path.join(os.path.dirname(__file__), "..")
         )
 
-        self.env.wait_factor = 1
+        self.env.wait_factor = int(os.environ.get("ALS_WAIT_FACTOR", "1"))
 
         # Absolute paths to programs that test drivers can use
         if self.env.options.valgrind_memcheck: