Add command to load an existing GNATcoverage XML report

Author: eliericha

integration/vscode/ada/package.json

@@ -850,6 +850,10 @@
                 "command": "ada.spark.tasks.proveLine",
                 "title": "spark: Prove line (task wrapper)",
                 "when": "editorLangId == ada && editorTextFocus"
+            },
+            {
+                "command": "ada.loadGnatCovXMLReport",
+                "title": "ada: GNATcoverage - Load an existing XML coverage report"
             }
         ],
         "keybindings": [

integration/vscode/ada/src/commands.ts

@@ -25,6 +25,7 @@ import {
     getBuildAndRunTaskName,
 } from './taskProviders';
 import { createHelloWorldProject, walkthroughStartDebugging } from './walkthrough';
+import { loadGnatCoverageReport } from './gnattest';
 
 /**
  * Identifier for a hidden command used for building and running a project main.
@@ -171,6 +172,10 @@ export function registerCommands(context: vscode.ExtensionContext, clients: Exte
         vscode.commands.registerCommand(CMD_SPARK_PROVE_SUBP, sparkProveSubprogram),
     );
 
+    context.subscriptions.push(
+        commands.registerCommand('ada.loadGnatCovXMLReport', loadGnatCovXMLReport),
+    );
+
     registerTaskWrappers(context);
 }
 
@@ -936,3 +941,24 @@ async function sparkProveSubprogram(
      */
     return await vscode.tasks.executeTask(resolvedTask);
 }
+async function loadGnatCovXMLReport() {
+    const selection = await vscode.window.showOpenDialog({
+        canSelectFiles: true,
+        canSelectFolders: false,
+        canSelectMany: false,
+        filters: {
+            'index.xml': ['xml'],
+        },
+        title: "Select a 'index.xml' GNATcoverage report to load",
+    });
+
+    if (selection && selection.length > 0 && selection[0]) {
+        const path = selection[0].fsPath;
+        if (!path.endsWith('index.xml')) {
+            throw Error(
+                `The selected file must be 'index.xml'. Instead, the selected file was: ${path}`,
+            );
+        }
+        await loadGnatCoverageReport(path);
+    }
+}

integration/vscode/ada/src/gnatcov.ts

@@ -70,7 +70,12 @@ type scope_metric_type = {
 };
 type metric_type = {
     '@_kind': metric_kind_type;
-    '@_count': number;
+
+    /**
+     *  should be 'number' but we don't want to ask the XML parser to parse
+     *  numbers
+     */
+    '@_count': string;
     '@_ratio': number;
 };
 type metric_kind_type =

integration/vscode/ada/src/gnattest.ts

@@ -26,6 +26,12 @@ export let controller: vscode.TestController;
 export let testRunProfile: vscode.TestRunProfile;
 export let testCoverageProfile: vscode.TestRunProfile;
 
+/**
+ * This test controller is not used for actually running tests. It is merely
+ * used for loading an existing GNATcoverage report obtained outside VS Code.
+ */
+let fileLoadController: vscode.TestController;
+
 /**
  * Types definition for the Gnattest XML file structure. The types match the XML
  * generated by src/test-mapping.adb in the libadalang-tools repository. However
@@ -131,6 +137,15 @@ export function initializeTesting(context: vscode.ExtensionContext): vscode.Test
 
     configureTestExecution(controller);
 
+    /**
+     * Initialize the controller responsible for loading existing GNATcov
+     * reports on demand.
+     */
+    fileLoadController = vscode.tests.createTestController(
+        'gnatcoverage-report-loader',
+        'GNATcoverage Report Loader',
+    );
+
     return controller;
 }
 
@@ -1098,13 +1113,13 @@ class GnatcovFileCoverage extends vscode.FileCoverage {
     /**
      * Report detailed coverage information by loading the file's GNATcov XML report.
      */
-    public async load(token: CancellationToken): Promise<vscode.FileCoverageDetail[]> {
+    public async load(token?: CancellationToken): Promise<vscode.FileCoverageDetail[]> {
         const data = parseGnatcovFileXml(this.sourceFileXmlReport);
         return Promise.resolve(
             data.src_mapping.flatMap((src_mapping) =>
                 src_mapping.src.line
                     .map((line) => {
-                        if (token.isCancellationRequested) {
+                        if (token?.isCancellationRequested) {
                             throw new vscode.CancellationError();
                         }
 
@@ -1173,24 +1188,54 @@ async function addCoverageData(run: vscode.TestRun, covDir: string) {
     const indexPath = path.join(covDir, 'index.xml');
     const data = parseGnatcovIndexXml(indexPath);
 
-    for (const file of data.coverage_report.coverage_summary!.file) {
-        const found = await vscode.workspace.findFiles(`**/${file['@_name']!}`, null, 1);
-        if (found.length == 0) continue;
+    await vscode.window.withProgress(
+        {
+            cancellable: true,
+            location: vscode.ProgressLocation.Notification,
+            title: 'Loading GNATcoverage report',
+        },
+        async (progress, token) => {
+            const array = data.coverage_report.coverage_summary!.file;
+            let done: number = 0;
+            const totalFiles = array.length;
+            for (const file of array) {
+                if (token.isCancellationRequested) {
+                    throw new vscode.CancellationError();
+                }
 
-        const srcUri = found[0];
-        const total = file.metric.find((m) => m['@_kind'] == 'total_lines_of_relevance')![
-            '@_count'
-        ];
-        const covered = file.metric.find((m) => m['@_kind'] == 'fully_covered')!['@_count'];
+                const found = await vscode.workspace.findFiles(`**/${file['@_name']!}`, null, 1);
+                if (found.length == 0) continue;
 
-        const fileReportBasename = data.coverage_report.sources!['xi:include'].find(
-            (inc) => inc['@_href'] == `${file['@_name']!}.xml`,
-        )!['@_href'];
-        const fileReportPath = path.join(covDir, fileReportBasename);
+                const srcUri = found[0];
+                const total = Number.parseInt(
+                    file.metric.find((m) => m['@_kind'] == 'total_lines_of_relevance')!['@_count'],
+                );
+                const covered = Number.parseInt(
+                    file.metric.find((m) => m['@_kind'] == 'fully_covered')!['@_count'],
+                );
 
-        const fileCov = new GnatcovFileCoverage(fileReportPath, srcUri, { covered, total });
-        run.addCoverage(fileCov);
-    }
+                const fileReportBasename = data.coverage_report.sources!['xi:include'].find(
+                    (inc) => inc['@_href'] == `${file['@_name']!}.xml`,
+                )!['@_href'];
+                const fileReportPath = path.join(covDir, fileReportBasename);
+
+                if (covered > total) {
+                    throw Error(
+                        `Got ${covered} covered lines for a` +
+                            ` total of ${total} in ${file['@_name']!}`,
+                    );
+                }
+
+                const fileCov = new GnatcovFileCoverage(fileReportPath, srcUri, { covered, total });
+                run.addCoverage(fileCov);
+
+                progress.report({
+                    message: `${++done} / ${totalFiles} source files`,
+                    increment: (100 * 1) / totalFiles,
+                });
+            }
+        },
+    );
 }
 
 /**
@@ -1217,3 +1262,25 @@ async function loadDetailedCoverage(
 
     return [];
 }
+
+/**
+ * Load an external GNATcoverage XML report in the VS Code UI.
+ *
+ * @param indexXmlPath - path of the index.xml file of a GNATcoverage XML report
+ */
+export async function loadGnatCoverageReport(indexXmlPath: string) {
+    const request = new vscode.TestRunRequest(
+        undefined,
+        undefined,
+        /**
+         * Associate the request with the coverage profile so that it becomes
+         * possible to load detailed coverage data for each file.
+         */
+        testCoverageProfile,
+    );
+    const run = fileLoadController.createTestRun(request, path.basename(indexXmlPath), false);
+
+    const covDir = path.dirname(indexXmlPath);
+    await addCoverageData(run, covDir);
+    run.end();
+}