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

Make e3-testsuite integration automatically use common locations

See merge request eng/ide/ada_language_server!2102

Author: eliericha

integration/vscode/ada/package.json

@@ -718,8 +718,7 @@
                 "properties": {
                     "e3-testsuite.testsuitePath": {
                         "type": "string",
-                        "description": "Path to testsuite.py",
-                        "default": "testsuite.py"
+                        "description": "Path to testsuite.py"
                     },
                     "e3-testsuite.python": {
                         "type": "string",

integration/vscode/ada/src/e3Testsuite.ts

@@ -82,19 +82,19 @@ export function activateE3TestsuiteIntegration(context: vscode.ExtensionContext)
 
     const testData: Map<vscode.TestItem, TestInfo> = new Map();
 
+    const ts: Testsuite = getTestsuite();
     let rootItem: vscode.TestItem;
+
     controller.refreshHandler = async function () {
         controller.items.replace([]);
         testData.clear();
 
-        const ts: Testsuite = getTestsuite();
-
         if (!existsSync(ts.uri.fsPath)) {
             return;
         }
 
         rootItem = this.createTestItem(
-            getRootItemId(),
+            getRootItemId(ts),
             vscode.workspace.asRelativePath(ts.uri),
             ts.uri,
         );
@@ -179,8 +179,6 @@ export function activateE3TestsuiteIntegration(context: vscode.ExtensionContext)
         request: vscode.TestRunRequest,
         token: vscode.CancellationToken,
     ): Promise<void> => {
-        const ts = getTestsuite();
-
         const enableEventSystem: boolean =
             vscode.workspace.getConfiguration('e3-testsuite').get('enableEventSystem') ?? true;
 
@@ -193,7 +191,7 @@ export function activateE3TestsuiteIntegration(context: vscode.ExtensionContext)
         }
 
         function onlyRootSelected(rq: vscode.TestRunRequest) {
-            return rq.include?.length === 1 && rq.include[0].id === getRootItemId();
+            return rq.include?.length === 1 && rq.include[0].id === getRootItemId(ts);
         }
 
         if (request.include && !onlyRootSelected(request)) {
@@ -536,7 +534,7 @@ export function activateE3TestsuiteIntegration(context: vscode.ExtensionContext)
         reportResult(run, result.status, targetItem, messages);
     }
 
-    if (existsSync(getTestsuite().uri.fsPath)) {
+    if (existsSync(ts.uri.fsPath)) {
         void vscode.window.withProgress(
             {
                 location: vscode.ProgressLocation.Notification,
@@ -551,13 +549,47 @@ export function activateE3TestsuiteIntegration(context: vscode.ExtensionContext)
     }
 }
 
-function getRootItemId(): string {
-    return getTestsuite().uri.toString();
+function getRootItemId(ts: Testsuite): string {
+    return ts.uri.toString();
 }
 
-function getTestsuite() {
+/**
+ * Retrieves the testsuite configuration for the current workspace.
+ *
+ * This function determines the testsuite path by first checking the user's configuration.
+ * If no path is configured, it automatically searches through predefined candidate locations
+ * and uses the first existing file. It also retrieves the Python executable configuration.
+ *
+ * @returns {Testsuite} An object containing the testsuite URI and Python executable path
+ *
+ * @remarks
+ * The function searches for testsuite files in the following order:
+ * 1. 'testsuite.py' in the workspace root
+ * 2. 'testsuite/testsuite.py' relative to workspace root
+ *
+ * If no testsuite file is found, it defaults to the first candidate path.
+ * The Python executable defaults to 'python' if not configured.
+ *
+ * @throws Will throw an error if no workspace folders are available
+ */
+export function getTestsuite() {
+    const wsPath = vscode.workspace.workspaceFolders![0].uri.fsPath;
+
     const config = vscode.workspace.getConfiguration('e3-testsuite');
-    const tsPath = config.get<string>('testsuitePath') ?? 'testsuite.py';
+    const configuredPath = config.get<string>('testsuitePath');
+
+    let tsPath;
+    if (configuredPath) {
+        tsPath = configuredPath;
+    } else {
+        /**
+         * Automatically look through candidates and return the first one that exists.
+         */
+        const candidates = ['testsuite.py', path.join('testsuite', 'testsuite.py')];
+        tsPath =
+            candidates.map((p) => path.join(wsPath, p)).find((p) => existsSync(p)) ?? candidates[0];
+    }
+
     const python = config.get<string>('python') ?? 'python';
 
     const tsAbsUri: vscode.Uri = path.isAbsolute(tsPath)

integration/vscode/ada/test/e3-testsuite/e3_testsuite.test.ts

@@ -14,6 +14,7 @@ import {
 import { CancellationTokenSource } from 'vscode-languageclient';
 import * as e3 from '../../src/e3Testsuite';
 import { activate } from '../utils';
+import fs from 'fs';
 
 /**
  * Interface for capturing test execution results
@@ -514,6 +515,62 @@ suite('e3-testsuite', function () {
             await config.update('args', originalArgs, false);
         }
     });
+
+    test('Auto-detect testsuite.py path', function () {
+        const config = workspace.getConfiguration('e3-testsuite');
+        const originalPath = config.get<string>('testsuitePath');
+
+        try {
+            // Clear any configured path to test auto-detection
+            config.update('testsuitePath', undefined, false);
+
+            const detectedPath = e3.getTestsuite().uri.fsPath;
+            const expectedPath = path.join(
+                workspace.workspaceFolders![0].uri.fsPath,
+                'testsuite.py',
+            );
+
+            assert.strictEqual(
+                detectedPath,
+                expectedPath,
+                `Auto-detected path '${detectedPath}' does not match expected '${expectedPath}'`,
+            );
+
+            // Test with testsuite.py in a subdirectory
+            const originalTestsuitePath = path.join(
+                workspace.workspaceFolders![0].uri.fsPath,
+                'testsuite.py',
+            );
+            const subDirPath = path.join(workspace.workspaceFolders![0].uri.fsPath, 'testsuite');
+            const movedTestsuitePath = path.join(subDirPath, 'testsuite.py');
+
+            // Create subdirectory and move testsuite.py
+            fs.mkdirSync(subDirPath, { recursive: true });
+            fs.renameSync(originalTestsuitePath, movedTestsuitePath);
+
+            try {
+                const detectedPathInSubdir = e3.getTestsuite().uri.fsPath;
+                assert.strictEqual(
+                    detectedPathInSubdir,
+                    movedTestsuitePath,
+                    `Auto-detected path '${detectedPathInSubdir}' does not match ` +
+                        `expected '${movedTestsuitePath}'`,
+                );
+            } finally {
+                // Move testsuite.py back to original location
+                fs.renameSync(movedTestsuitePath, originalTestsuitePath);
+                // Clean up the subdirectory if it's empty
+                try {
+                    fs.rmdirSync(subDirPath);
+                } catch {
+                    // Ignore if directory is not empty or doesn't exist
+                }
+            }
+        } finally {
+            // Restore original configuration
+            config.update('testsuitePath', originalPath, false);
+        }
+    });
 });
 
 interface TestResultItem {