Prepare for release

Author: gjsjohnmurray

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.0.0 (23-Jul-2025)
+* Use [Test Coverage Tool](https://openexchange.intersystems.com/package/Test-Coverage-Tool) to present coverage information (#24)
+
 ## 0.2.3 (13-Nov-2024)
 * Add manual refresh to test trees, and automatic refresh when client setting changes (#20)
 * Fix overprompting during authentication.

README.md

@@ -1,6 +1,10 @@
 # InterSystems Testing Manager
 
-This preview extension uses VS Code's [Testing API](https://code.visualstudio.com/api/extension-guides/testing) to discover, run and debug unit test classes built with the [%UnitTest testing framework](https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=TUNT_WhatIsPercentUnitTest) of the InterSystems IRIS platforms, plus Caché-based predecessors supporting the `/api/atelier` REST service.
+> **New in Version 2.0 - Test Coverage**
+> 
+> The v2.0 release has been entered into the [InterSystems Developer Tools Contest 2025](https://openexchange.intersystems.com/contest/42). Please support it with your vote between 28th July and 3rd August.
+
+This extension uses VS Code's [Testing API](https://code.visualstudio.com/api/extension-guides/testing) to discover, run and debug unit test classes built with the [%UnitTest testing framework](https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=TUNT_WhatIsPercentUnitTest) of the InterSystems IRIS platforms, plus Caché-based predecessors supporting the `/api/atelier` REST service.
 
 It augments the ObjectScript, InterSystems Language Server and Server Manager extensions, which are elements of the [InterSystems ObjectScript Extension Pack](https://marketplace.visualstudio.com/items?itemName=intersystems-community.objectscript-pack).
 
@@ -34,6 +38,8 @@ In order to support topologies in which client-side-managed test classes have to
     ```
 > If you previously used the `%UnitTest` framework in a namespace, be aware that you are probably replacing an existing value. Consider taking a note of that in case you need to revert.
 
+3. If you want to gather and display test coverage data, set up [Test Coverage Tool](https://openexchange.intersystems.com/package/Test-Coverage-Tool) in the namespace(s) where your tests will execute.
+
 ## Workspace Preparations
 
 For a workspace using client-side editing, test classes are by default sought in `.cls` files under the `internal/testing/unit_tests` subfolder, using the conventional layout of one additional subfolder per package-name element. If your test classes are located elsewhere, use the `intersystems.testingManager.client.relativeTestRoot` setting to point there.
@@ -50,7 +56,7 @@ A subfolder is shown for each root folder of your workspace, which may be a mult
 
 At the level of an individual test class the final expansion shows a leaf for each `TestXXX` method.
 
-Hovering over any level of a tests tree will reveal action buttons that run all the tests from this level down. The 'Run' button does so without stopping at any breakpoints, in contrast to the 'Debug' button. At class or method level a 'Go to Test' button opens the class code and positions the cursor appropriately. At higher levels this button navigates to Explorer View.
+Hovering over any level of a tests tree will reveal action buttons that run all the tests from this level down. The 'Run Test' button does so without stopping at any breakpoints, in contrast to the 'Debug Test' button. At class or method level a 'Go to Test' button opens the class code and positions the cursor appropriately. At higher levels this button navigates to Explorer View.
 
 When a test class is open in an editor tab it displays icons in the gutter at the top of the class and at the start of each test method. These show the outcome of the most recent run, if any, and can be clicked to perform testing operations.
 
@@ -59,6 +65,9 @@ The `...` menu of the Testing panel in Test Explorer includes several useful com
 ## Debugging Tests
 After opening a test class, click in the gutter to set a VS Code breakpoint in the normal manner. Then launch the test-run with the Debug option on the context menu of the testing icons in the gutter.
 
+## Obtaining Test Coverage Information
+Use the 'Run with Coverage' option to submit your tests to [Test Coverage Tool](https://openexchange.intersystems.com/package/Test-Coverage-Tool). When the run finishes the 'TEST COVERAGE' view will appear, usually below the 'TEST EXPLORER'. Use this to discover what proportion of executable code lines were covered by the most recent coverage run. Open sources to see color markers on line numbers showing covered (green) and not covered (red) lines. Learn more in the [VS Code documentation](https://code.visualstudio.com/docs/debugtest/testing#_test-coverage).
+
 ## Recent Testing History
 
 The %UnitTest framework persists results of runs in server-side tables. The 'Recent History' root folder lets you explore the most recent ten sets of results for each server and namespace the workspace uses.

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "testingmanager",
   "displayName": "InterSystems Testing Manager",
-  "version": "0.2.4-SNAPSHOT",
+  "version": "2.0.0-SNAPSHOT",
   "preview": true,
   "publisher": "intersystems-community",
   "description": "Manage testing on InterSystems servers.",

package.json

@@ -36,7 +36,7 @@ export async function commonRunTestsHandler(controller: vscode.TestController, r
 
   if (coverageRequest && !queue.length) {
     // No tests to run, but coverage requested
-    vscode.window.showErrorMessage("Coverage support not available on target environment(s).", { modal: true });
+    vscode.window.showErrorMessage("[Test Coverage Tool](https://openexchange.intersystems.com/package/Test-Coverage-Tool) not found.", );
     return;
   }
 

src/commonRunTestsHandler.ts

@@ -285,7 +285,7 @@ export function replaceRootItems(controller: vscode.TestController, schemes?: st
             if (!rootMap.has(key)) {
                 const item: OurTestItem = controller.createTestItem(key, key, folder.uri);
                 item.canResolveChildren = true;
-                item.supportsCoverage = true; // TODO - check target namespace supports coverage
+                item.supportsCoverage = false;
                 rootMap.set(key, item);
             }
         }

src/historyExplorer.ts

@@ -75,15 +75,7 @@ async function resolveItemChildren(item: OurTestItem) {
         if (localTestController.items.size > 0) {
             localTestController.createRunProfile('Run Local Tests', vscode.TestRunProfileKind.Run, runTestsHandler, true);
             localTestController.createRunProfile('Debug Local Tests', vscode.TestRunProfileKind.Debug, runTestsHandler);
-            let supportsCoverage = false;
-            localTestController.items.forEach((item: OurTestItem) => {
-                if (item.supportsCoverage) {
-                    supportsCoverage = true;
-                };
-            });
-            if (supportsCoverage) {
-                localTestController.createRunProfile('Run Local Tests with Coverage', vscode.TestRunProfileKind.Coverage, runTestsHandler);
-            }
+            localTestController.createRunProfile('Run Local Tests with Coverage', vscode.TestRunProfileKind.Coverage, runTestsHandler);
         }
     }
 }

src/localTests.ts

@@ -93,21 +93,27 @@ export class OurFileCoverage extends vscode.FileCoverage {
       serverSpec,
       { apiVersion: 1, namespace, path: "/action/query" },
       {
-        query: "SELECT element_key Line, LineToMethodMap Method FROM TestCoverage_Data.CodeUnit_LineToMethodMap WHERE CodeUnit = ? ORDER BY Line",
+        query: "SELECT element_key StartLine, LineToMethodMap Method FROM TestCoverage_Data.CodeUnit_LineToMethodMap WHERE CodeUnit = ? ORDER BY StartLine",
         parameters: [this.codeUnit],
       },
     );
     if (response) {
+      let previousMethod = "";
+      let previousStartLine = 0;
       response?.data?.result?.content?.forEach(element => {
-        logger.debug(`getFileCoverageResults element: ${JSON.stringify(element)}`);
-        if (element.Executable == '0') {
-          logger.debug(`Skipping non-executable line: ${JSON.stringify(element)}`);
-          return;
+        if (previousMethod && previousStartLine) {
+          const start = new vscode.Position(Number(previousStartLine) - 1, 0);
+          const end = new vscode.Position(Number(element.StartLine) - 2, Number.MAX_VALUE);
+          detailedCoverage.push(new vscode.DeclarationCoverage(previousMethod, true, new vscode.Range(start, end)));
         }
-        const range = new vscode.Range(new vscode.Position(Number(element.LineNumber) - 1, 0), new vscode.Position(Number(element.LineNumber) - 1, Number.MAX_VALUE));
-        const statementCoverage = new vscode.StatementCoverage(element.Covered == '1', range);
-        //detailedCoverage.push(statementCoverage);
+        previousMethod = element.Method;
+        previousStartLine = Number(element.StartLine);
       });
+      if (previousMethod && previousStartLine) {
+        const start = new vscode.Position(Number(previousStartLine) - 1, 0);
+        const end = new vscode.Position(Number.MAX_VALUE, Number.MAX_VALUE);
+        detailedCoverage.push(new vscode.DeclarationCoverage(previousMethod, true, new vscode.Range(start, end)));
+      }
     }
     return detailedCoverage;
   }

src/ourFileCoverage.ts

@@ -36,14 +36,22 @@ export async function supportsCoverage(folder: vscode.WorkspaceFolder): Promise<
     return false; // No server spec means we can't check coverage support
   }
   logger.debug(`Checking coverage support for namespace: ${namespace}`);
-  const response = await makeRESTRequest(
+  let response = await makeRESTRequest(
     "HEAD",
     serverSpec,
     { apiVersion: 1, namespace, path: "/doc/TestCoverage.Data.CodeUnit.cls" }
   );
   if (response?.status !== 200) {
     return false;
   }
+  response = await makeRESTRequest(
+    "HEAD",
+    serverSpec,
+    { apiVersion: 1, namespace, path: "/doc/TestCoverage.UI.VSCodeUtils.cls" }
+  );
+  if (response?.status === 200) {
+    return true;
+  }
 
   return await createSQLUtilFunctions(serverSpec, namespace);
 }
@@ -52,7 +60,7 @@ async function createSQLUtilFunctions(serverSpec: IServerSpec, namespace: string
   logger.debug(`Creating SQL Util functions for namespace: ${namespace}`);
 
   const functionDDL = `
-CREATE OR REPLACE FUNCTION fnVSCodeInt8Bitstring(
+CREATE FUNCTION fnVSCodeInt8Bitstring(
   bitstring VARCHAR(32767)
 )
   FOR TestCoverage.UI.VSCodeUtils