add coverage support

package.json

@@ -33,7 +33,7 @@
   },
   "homepage": "https://github.com/mesonbuild/vscode-meson/blob/master/README.md",
   "engines": {
-    "vscode": "^1.75.0"
+    "vscode": "^1.88.0"
   },
   "categories": [
     "Programming Languages"
@@ -572,7 +572,7 @@
   "devDependencies": {
     "@types/adm-zip": "^0.5.1",
     "@types/node": "^16.11.7",
-    "@types/vscode": "^1.75.0",
+    "@types/vscode": "^1.88.0",
     "@types/which": "^3.0.0",
     "husky": "^8.0.3",
     "lint-staged": "^14.0.1",
@@ -583,6 +583,9 @@
   },
   "dependencies": {
     "adm-zip": "^0.5.10",
+    "domhandler": "^5.0.3",
+    "domutils": "^3.2.2",
+    "htmlparser2": "^10.0.0",
     "vscode-cpptools": "^6.1.0",
     "vscode-languageclient": "^9.0.1",
     "which": "^4.0.0"

src/coverage.ts

@@ -0,0 +1,148 @@
+import * as htmlparser2 from "htmlparser2";
+import * as domutils from "domutils";
+import * as domhandler from "domhandler";
+import * as vscode from "vscode";
+import * as fs from "fs/promises";
+import * as path from "path";
+import { exec } from "./utils";
+import { workspaceState } from "./extension";
+
+class MyFileCoverage extends vscode.FileCoverage {
+  lineDetails: vscode.StatementCoverage[];
+
+  constructor(
+    detailedCoverage: vscode.StatementCoverage[],
+    uri: vscode.Uri,
+    statementCoverage: vscode.TestCoverageCount,
+    branchCoverage?: vscode.TestCoverageCount,
+    declarationCoverage?: vscode.TestCoverageCount,
+  ) {
+    super(uri, statementCoverage, branchCoverage, declarationCoverage);
+    this.lineDetails = detailedCoverage;
+  }
+}
+
+export async function loadDetailedCoverage(
+  _testRun: vscode.TestRun,
+  fileCoverage: vscode.FileCoverage,
+  _token: vscode.CancellationToken,
+): Promise<vscode.StatementCoverage[]> {
+  return fileCoverage instanceof MyFileCoverage ? fileCoverage.lineDetails : [];
+}
+
+/**
+ * Read coverage data generated during test execution.
+ * @param buildDir Meson build directory
+ * @returns `FileCoverage[]` to be added to be used with `run.addCoverage()`
+ */
+export async function getCoverage(buildDir: string): Promise<vscode.FileCoverage[]> {
+  await exec("ninja", ["-C", buildDir, "coverage-xml"]);
+  return parseXml(await fs.readFile(path.join(buildDir, "meson-logs", "coverage.xml"), "utf-8"));
+}
+
+/**
+ * Parses a Cobertura xml file as generated by gcovr.
+ * The schema is documented at
+ * https://github.com/cobertura/cobertura/blob/master/cobertura/src/site/htdocs/xml/coverage-04.dtd
+ * @param xml Contents of the Cobertura report
+ * @returns `FileCoverage[]` to be added to be used with `run.addCoverage()`
+ */
+function parseXml(xml: string): vscode.FileCoverage[] {
+  const ret: vscode.FileCoverage[] = [];
+
+  const sourceDir = workspaceState.get<string>("mesonbuild.sourceDir")!;
+
+  const dom = htmlparser2.parseDocument(xml, { xmlMode: true });
+  const packages = domutils.findOne(
+    (node) => {
+      return node.name == "packages";
+    },
+    dom,
+    true,
+  )!;
+  for (const pkg of packages.childNodes) {
+    // The Cobertura format was designed for Java,
+    // accordingly it considers classes the highest form of abstraction.
+    // However, gcovr just creates one "class" per covered file, and fills it with line data.
+    for (const cls of domutils.findOne((node) => node.name == "classes", pkg as domhandler.Element)!.childNodes) {
+      const classElem = cls as domhandler.Element;
+      const filePath = path.join(sourceDir, classElem.attribs["filename"]);
+      const lineDetails: vscode.StatementCoverage[] = [];
+
+      let coveredBranches = 0;
+      let totalBranches = 0;
+      let coveredLines = 0;
+      let totalLines = 0;
+
+      for (const line of domutils.findOne((node) => node.name == "lines", cls as domhandler.Element)!.childNodes) {
+        totalLines++;
+        const val = processLine(line as domhandler.Element);
+        coveredLines += val.lineCovered ? 1 : 0;
+        lineDetails.push(...val.lineDetails);
+        coveredBranches += val.coveredBranches;
+        totalBranches += val.totalBranches;
+      }
+
+      const lineData = new vscode.TestCoverageCount(coveredLines, totalLines);
+      const branchData = new vscode.TestCoverageCount(coveredBranches, totalBranches);
+      ret.push(new MyFileCoverage(lineDetails, vscode.Uri.file(filePath), lineData, branchData));
+    }
+  }
+  return ret;
+}
+
+function processLine(line: domhandler.Element): {
+  lineCovered: boolean;
+  lineDetails: vscode.StatementCoverage[];
+  coveredBranches: number;
+  totalBranches: number;
+} {
+  const hits = parseInt(line.attribs["hits"]);
+  const lineNo = parseInt(line.attribs["number"]);
+  // Position is 0-indexed
+  const position = new vscode.Position(lineNo - 1, 0);
+
+  const lineCovered = hits > 0;
+  const lineDetails: vscode.StatementCoverage[] = [];
+  let coveredBranches = 0;
+  let totalBranches = 0;
+
+  if (line.attribs["branch"] == "true") {
+    const val = processBranch(line, position);
+    coveredBranches = val.coveredBranches;
+    totalBranches = val.totalBranches;
+    lineDetails.push(new vscode.StatementCoverage(hits, position, val.branchCoverage));
+  } else {
+    lineDetails.push(new vscode.StatementCoverage(hits, position));
+  }
+
+  return { lineCovered, lineDetails, coveredBranches, totalBranches };
+}
+
+function processBranch(
+  line: domhandler.Element,
+  position: vscode.Position,
+): {
+  branchCoverage: vscode.BranchCoverage[];
+  coveredBranches: number;
+  totalBranches: number;
+} {
+  const branchCoverage: vscode.BranchCoverage[] = [];
+  // format is "50% (1/2)"
+  const conditionStr = line.attribs["condition-coverage"];
+  const match = RegExp(/\d+% \((\d+)\/(\d+)\)/).exec(conditionStr)!;
+
+  const coveredBranches = parseInt(match[1]);
+  const totalBranches = parseInt(match[2]);
+
+  // The gcov report does not specify which branches were missed,
+  // so the best we can do is report whether a branch site was
+  // fully, partially, or not at all covered
+  if (coveredBranches > 0) {
+    branchCoverage.push(new vscode.BranchCoverage(true, position));
+  }
+  if (coveredBranches < totalBranches) {
+    branchCoverage.push(new vscode.BranchCoverage(false, position));
+  }
+  return { branchCoverage, coveredBranches, totalBranches };
+}

src/extension.ts

@@ -16,7 +16,8 @@ import {
 } from "./utils";
 import { MesonDebugConfigurationProvider, DebuggerType } from "./debug/index";
 import { CpptoolsProvider, registerCppToolsProvider } from "./cpptoolsconfigprovider";
-import { testDebugHandler, testRunHandler, regenerateTests } from "./tests";
+import { testDebugHandler, testRunHandler, regenerateTests, testCoverageHandler } from "./tests";
+import { loadDetailedCoverage } from "./coverage";
 import { activateLinters } from "./linters";
 import { activateFormatters } from "./formatters";
 import { SettingsKey, TaskQuickPickItem } from "./types";
@@ -118,6 +119,12 @@ export async function activate(ctx: vscode.ExtensionContext) {
     (request, token) => testRunHandler(controller, request, token),
     true,
   );
+  controller.createRunProfile(
+    "Meson coverage",
+    vscode.TestRunProfileKind.Coverage,
+    (request, token) => testCoverageHandler(controller, request, token),
+    true,
+  ).loadDetailedCoverage = loadDetailedCoverage;
   ctx.subscriptions.push(controller);
 
   let mesonTasks: Thenable<vscode.Task[]> | null = null;

src/tests.ts

@@ -2,8 +2,9 @@ import * as os from "os";
 import * as vscode from "vscode";
 import { ExecResult, exec, extensionConfiguration, getTargetName } from "./utils";
 import { Target, Targets, Test, Tests, DebugEnvironmentConfiguration } from "./types";
-import { getMesonTests, getMesonTargets } from "./introspection";
+import { getMesonTests, getMesonTargets, getMesonBuildOptions } from "./introspection";
 import { workspaceState } from "./extension";
+import { getCoverage } from "./coverage";
 
 // This is far from complete, but should suffice for the
 // "test is made of a single executable is made of a single source file" usecase.
@@ -105,6 +106,7 @@ export async function testRunHandler(
   controller: vscode.TestController,
   request: vscode.TestRunRequest,
   token: vscode.CancellationToken,
+  coverage: boolean = false,
 ) {
   const run = controller.createTestRun(request, undefined, false);
   const parallelTests: vscode.TestItem[] = [];
@@ -113,6 +115,14 @@ export async function testRunHandler(
   const buildDir = workspaceState.get<string>("mesonbuild.buildDir")!;
   const mesonTests = await getMesonTests(buildDir);
 
+  if (coverage) {
+    // Existing files should be cleaned so that with
+    // tests = A, B
+    // runTest(A); runTest(B);
+    // the coverage results of B won't include the results of A
+    await exec("ninja", ["-C", buildDir, "clean-gcda"]);
+  }
+
   // Look up the meson test for a given vscode test,
   // put it in the parallel or sequential queue,
   // and tell vscode about the enqueued test.
@@ -199,9 +209,30 @@ export async function testRunHandler(
     await dispatchTest(test);
   }
 
+  if (coverage) {
+    for (const fileCoverage of await getCoverage(buildDir)) {
+      run.addCoverage(fileCoverage);
+    }
+  }
+
   run.end();
 }
 
+export async function testCoverageHandler(
+  controller: vscode.TestController,
+  request: vscode.TestRunRequest,
+  token: vscode.CancellationToken,
+) {
+  const buildDir = workspaceState.get<string>("mesonbuild.buildDir")!;
+  const hasCoverage = (await getMesonBuildOptions(buildDir)).find((option) => option.name == "b_coverage")
+    ?.value as boolean;
+  if (!hasCoverage) {
+    vscode.window.showErrorMessage("Coverage was not enabled. Reconfigure with -Db_coverage=true");
+    return;
+  }
+  return testRunHandler(controller, request, token, true);
+}
+
 export async function testDebugHandler(
   controller: vscode.TestController,
   request: vscode.TestRunRequest,

yarn.lock

@@ -42,10 +42,10 @@
   resolved "https://registry.yarnpkg.com/@types/node/-/node-16.18.105.tgz#7147176852774ec4d6dd626803888adf6b999feb"
   integrity sha512-w2d0Z9yMk07uH3+Cx0N8lqFyi3yjXZxlbYappPj+AsOlT02OyxyiuNoNHdGt6EuiSm8Wtgp2YV7vWg+GMFrvFA==
 
-"@types/vscode@^1.75.0":
-  version "1.92.0"
-  resolved "https://registry.yarnpkg.com/@types/vscode/-/vscode-1.92.0.tgz#b4d6bc180e7206defe643a1a5f38a1367947d418"
-  integrity sha512-DcZoCj17RXlzB4XJ7IfKdPTcTGDLYvTOcTNkvtjXWF+K2TlKzHHkBEXNWQRpBIXixNEUgx39cQeTFunY0E2msw==
+"@types/vscode@^1.88.0":
+  version "1.99.1"
+  resolved "https://registry.yarnpkg.com/@types/vscode/-/vscode-1.99.1.tgz#bde6e2d9ccbe0493fded98ad639bf2671b8ec9ee"
+  integrity sha512-cQlqxHZ040ta6ovZXnXRxs3fJiTmlurkIWOfZVcLSZPcm9J4ikFpXuB7gihofGn5ng+kDVma5EmJIclfk0trPQ==
 
 "@types/which@^3.0.0":
   version "3.0.4"
@@ -151,6 +151,36 @@ dir-glob@^3.0.1:
   dependencies:
     path-type "^4.0.0"
 
+dom-serializer@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/dom-serializer/-/dom-serializer-2.0.0.tgz#e41b802e1eedf9f6cae183ce5e622d789d7d8e53"
+  integrity sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==
+  dependencies:
+    domelementtype "^2.3.0"
+    domhandler "^5.0.2"
+    entities "^4.2.0"
+
+domelementtype@^2.3.0:
+  version "2.3.0"
+  resolved "https://registry.yarnpkg.com/domelementtype/-/domelementtype-2.3.0.tgz#5c45e8e869952626331d7aab326d01daf65d589d"
+  integrity sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw==
+
+domhandler@^5.0.2, domhandler@^5.0.3:
+  version "5.0.3"
+  resolved "https://registry.yarnpkg.com/domhandler/-/domhandler-5.0.3.tgz#cc385f7f751f1d1fc650c21374804254538c7d31"
+  integrity sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==
+  dependencies:
+    domelementtype "^2.3.0"
+
+domutils@^3.2.1, domutils@^3.2.2:
+  version "3.2.2"
+  resolved "https://registry.yarnpkg.com/domutils/-/domutils-3.2.2.tgz#edbfe2b668b0c1d97c24baf0f1062b132221bc78"
+  integrity sha512-6kZKyUajlDuqlHKVX1w7gyslj9MPIXzIFiz/rGu35uC1wMi+kMhQwGhl4lt9unC9Vb9INnY9Z3/ZA3+FhASLaw==
+  dependencies:
+    dom-serializer "^2.0.0"
+    domelementtype "^2.3.0"
+    domhandler "^5.0.3"
+
 eastasianwidth@^0.2.0:
   version "0.2.0"
   resolved "https://registry.yarnpkg.com/eastasianwidth/-/eastasianwidth-0.2.0.tgz#696ce2ec0aa0e6ea93a397ffcf24aa7840c827cb"
@@ -161,6 +191,16 @@ emoji-regex@^9.2.2:
   resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-9.2.2.tgz#840c8803b0d8047f4ff0cf963176b32d4ef3ed72"
   integrity sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==
 
+entities@^4.2.0:
+  version "4.5.0"
+  resolved "https://registry.yarnpkg.com/entities/-/entities-4.5.0.tgz#5d268ea5e7113ec74c4d033b79ea5a35a488fb48"
+  integrity sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==
+
+entities@^6.0.0:
+  version "6.0.0"
+  resolved "https://registry.yarnpkg.com/entities/-/entities-6.0.0.tgz#09c9e29cb79b0a6459a9b9db9efb418ac5bb8e51"
+  integrity sha512-aKstq2TDOndCn4diEyp9Uq/Flu2i1GlLkc6XIDQSDMuaFE3OPW5OphLCyQ5SpSJZTb4reN+kTcYru5yIfXoRPw==
+
 entities@~3.0.1:
   version "3.0.1"
   resolved "https://registry.yarnpkg.com/entities/-/entities-3.0.1.tgz#2b887ca62585e96db3903482d336c1006c3001d4"
@@ -234,6 +274,16 @@ globby@13.2.2:
     merge2 "^1.4.1"
     slash "^4.0.0"
 
+htmlparser2@^10.0.0:
+  version "10.0.0"
+  resolved "https://registry.yarnpkg.com/htmlparser2/-/htmlparser2-10.0.0.tgz#77ad249037b66bf8cc99c6e286ef73b83aeb621d"
+  integrity sha512-TwAZM+zE5Tq3lrEHvOlvwgj1XLWQCtaaibSN11Q+gGBAS7Y1uZSWwXXRe4iF6OXnaq1riyQAPFOBtYc77Mxq0g==
+  dependencies:
+    domelementtype "^2.3.0"
+    domhandler "^5.0.3"
+    domutils "^3.2.1"
+    entities "^6.0.0"
+
 human-signals@^4.3.0:
   version "4.3.1"
   resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-4.3.1.tgz#ab7f811e851fca97ffbd2c1fe9a958964de321b2"