Merge branch 'topic/e3-testsuite-vscode' into 'master'

Implement e3-testsuite integration in VS Code

See merge request eng/ide/ada_language_server!2038

Author: eliericha

.gitlab-ci.yml

@@ -86,6 +86,7 @@ include:
       cpus: 4
       disk: 80
       windows: true
+      windows-cpus: 4
       rules:
         # integration-testsuite cannot work with edge builds
         - if: $CI_PIPELINE_SOURCE == 'merge_request_event' && $CI_TARGET_BRANCH_NAME == 'edge'

CHANGELOG.md

@@ -9,6 +9,7 @@ section below it for the last release. -->
 * `Go to Definition` now jumps respectively on the `begin`, `private` and `body` keywords
   for subprograms, packages and tasks when clicking on the `is` keyword following their declarations
 * New refactoring: [Delete Entity](https://github.com/AdaCore/ada_language_server/blob/master/doc/refactoring_tools.md#delete-entity)
+* Provide an integration of the [e3-testsuite](https://github.com/AdaCore/e3-testsuite) framework with the VS Code testing UI
 
 ## 26.0.202507021
 

integration/vscode/ada/.vscode-test.mjs

@@ -51,6 +51,7 @@ const testsuites = [
     'dot-als-json',
     'status_bar',
     'aggregate_projects',
+    'e3-testsuite',
 ];
 
 export default defineConfig(

integration/vscode/ada/media/e3_notify_vscode.py

@@ -0,0 +1,53 @@
+"""
+The purpose of this module is to report e3-testsuite events to the Ada & SPARK VS Code
+extension.
+
+It provides a callback to be used with the e3-testsuite notification system via the
+--notify-events CLI argument. See the documentation of the
+`e3.testsuite.event_notifications` module for more information about that system.
+
+Upon receiving e3-testsuite events, the callback prints them to stdout, as JSON objects
+of a specific structure expected by the Ada & SPARK VS Code extension. That structure is
+defined by the `TestsuiteNotification` type in `e3TestsuiteNotifications.ts`.
+"""
+
+import json
+import os
+import sys
+from typing import Literal, NotRequired, TypedDict
+
+from e3.testsuite import Testsuite
+from e3.testsuite import event_notifications as EN
+from e3.testsuite.event_notifications import TestNotification
+
+NotificationType = Literal["queue", "start", "result", "end"]
+
+
+class Event(TypedDict):
+    kind: NotificationType
+    testName: str
+    resultPath: NotRequired[str]
+
+
+def callback(e: TestNotification):
+    if isinstance(e, EN.TestQueueNotification):
+        v = Event(kind="queue", testName=e.test_name)
+    elif isinstance(e, EN.TestStartNotification):
+        v = Event(kind="start", testName=e.test_name)
+    elif isinstance(e, EN.TestResultNotification):
+        v = Event(
+            kind="result", testName=e.test_name, resultPath=e.yaml_result_filename
+        )
+    elif isinstance(e, EN.TestEndNotification):
+        v = Event(kind="end", testName=e.test_name)
+    else:
+        v = None
+
+    if v is not None:
+        json.dump(v, sys.stdout)
+        sys.stdout.write(os.linesep)
+        sys.stdout.flush()
+
+
+def init_callback(ts: Testsuite):
+    return callback

integration/vscode/ada/package-lock.json

@@ -22,6 +22,8 @@
         "workspaceContains:*.ad[bs]",
         "workspaceContains:*/*.ad[bs]",
         "workspaceContains:alire.toml",
+        "workspaceContains:testsuite.py",
+        "workspaceContains:*/testsuite.py",
         "onDebugDynamicConfigurations:ada"
     ],
     "main": "./out/src/extension",
@@ -710,6 +712,26 @@
                         "description": "Enable experimental features still in development."
                     }
                 }
+            },
+            {
+                "title": "e3-testsuite",
+                "properties": {
+                    "e3-testsuite.testsuitePath": {
+                        "type": "string",
+                        "description": "Path to testsuite.py",
+                        "default": "testsuite.py"
+                    },
+                    "e3-testsuite.python": {
+                        "type": "string",
+                        "description": "Path to python interpreter, useful when you want to use a specific venv",
+                        "default": "python"
+                    },
+                    "e3-testsuite.args": {
+                        "type": "array",
+                        "description": "Command line arguments to pass to testsuite.py when running tests",
+                        "default": []
+                    }
+                }
             }
         ],
         "jsonValidation": [
@@ -1465,6 +1487,8 @@
         "@types/node": "^18.0.0",
         "@types/react": "^19.0.10",
         "@types/react-dom": "^19.0.4",
+        "@types/split2": "^4.2.3",
+        "@types/tmp": "^0.2.6",
         "@types/vscode": "~1.88.0",
         "@types/vscode-webview": "^1.57.5",
         "@types/ws": "^8.0.0",
@@ -1532,8 +1556,11 @@
         "process": "0.11.10",
         "react": "^19.0.0",
         "react-dom": "^19.0.0",
+        "split2": "^4.2.0",
+        "tmp": "^0.2.3",
         "vscode-languageclient": "9.0.1",
         "winston": "3.14.2",
-        "ws": "^8.18.0"
+        "ws": "^8.18.0",
+        "yaml": "^2.8.0"
     }
 }