Implement uncovered branch highlight

meowbmw · meowbmw · commit 8beed5095a3d · 2025-02-12T17:34:53.000+08:00
diff --git a/assembly/diytest.ts b/assembly/diytest.ts
@@ -0,0 +1,24 @@
+export function mycmp<T>(a: T, b: T): bool {
+    if (a > b) {
+        return true;
+    } else {
+        return false;
+    }
+}
+
+export function instancecmp<T>(a: T, b: T): bool {
+    if (isInteger<T>()) {
+        if (a > b) {
+            return true;
+        } else {
+            return false;
+        }
+    } else if (isFloat<T>()) {
+        if (a > b) {
+            return true;
+        } else {
+            return false;
+        }
+    }
+    return false;
+}
diff --git a/src/generator/html-generator/genCode.ts b/src/generator/html-generator/genCode.ts
@@ -23,10 +23,16 @@ function generateLineCoverage(codes: CodeCoverage[]): string {
   return str.join("\n");
 }
 
-function generateSource(codes: CodeCoverage[]): string {
+function generateSource(codes: CodeCoverage[], result: FileCoverageResult): string {
   const str: string[] = [];
-  for (const code of codes) {
-    str.push(escape(code.source));
+  for (const [index, code] of codes.entries()) {
+    if (result.linesToHighlight.has(index + 1)) {
+      // IMPORTANT! to add "nocode" here to preventing prettify from adding unwanted pln class
+      str.push('<span class="missing-if-branch nocode" title="Branch not taken">!</span>' + escape(code.source));
+    }
+    else {
+      str.push(escape(code.source));
+    }
   }
   return str.join("\n");
 }
@@ -36,7 +42,7 @@ export function generateCodeHtml(relativePathofRoot: string, result: FileCoverag
 
   const lineCoutHtml = generateLineCount(codes.length);
   const lineCov = generateLineCoverage(codes);
-  const lineSource = generateSource(codes);
+  const lineSource = generateSource(codes, result);
 
   return `
 <!DOCTYPE html>
diff --git a/src/interface.ts b/src/interface.ts
@@ -87,11 +87,13 @@ export class FileCoverageResult {
   functionCoverageRate: Rate = new Rate();
   lineCoverageRate: Rate = new Rate();
   sourceUsedCount: CodeCoverage[] = [];
+  linesToHighlight: Set<number> = new Set();
 }
 
 export class FunctionCoverageResult {
   constructor(public functionName: string) {}
   branchCoverageRate: Rate = new Rate();
+  linesToHighlight: Set<number> = new Set();
   lineRange: [number, number] = [Number.MAX_SAFE_INTEGER, Number.MIN_SAFE_INTEGER];
   /**
    * first means lineIndex;
@@ -111,6 +113,7 @@ export class FunctionCoverageResult {
     ];
     result.branchCoverageRate = Rate.summarize(infos.map((info) => info.branchCoverageRate));
     for (const info of infos) {
+      info.linesToHighlight.forEach(line => result.linesToHighlight.add(line));
       for (const [lineIndex, count] of info.sourceUsedCount.entries()) {
         const srcLineUsedCount = result.sourceUsedCount.get(lineIndex);
         result.sourceUsedCount.set(lineIndex, srcLineUsedCount === undefined ? count : srcLineUsedCount + count);
diff --git a/src/parser/singleFileAnalysis.ts b/src/parser/singleFileAnalysis.ts
@@ -19,21 +19,23 @@ export class SingleFileCoverageAnalysis {
       for (let index = startLine - 1; index < endLine; index++) {
         const codeCoverage = this.result.sourceUsedCount[index];
         if (codeCoverage === undefined) {
-          throw new Error(`unknowm error: There is no ${index} Line in file ${this.result.filename}`);
+          throw new Error(`unknown error: There is no ${index} Line in file ${this.result.filename}`);
         }
         codeCoverage.usedCount = 0;
       }
     }
   }
 
   merge(results: FunctionCoverageResult[]) {
+    // SingleFileCoverageAnalysis contains FileCoverageResult
     if (results.length === 0) return;
     for (const functionCovResult of results) {
+      functionCovResult.linesToHighlight.forEach(line => this.result.linesToHighlight.add(line));
       for (const [lineIndex, count] of functionCovResult.sourceUsedCount.entries()) {
         const srcLineUsedCount = this.result.sourceUsedCount[lineIndex - 1];
         if (srcLineUsedCount === undefined) {
           throw new Error(
-            `unknowm error: There is not Line ${lineIndex} in ${JSON.stringify(this.result.sourceUsedCount)}`
+            `unknown error: There is not Line ${lineIndex} in ${JSON.stringify(this.result.sourceUsedCount)}`
           );
         }
         if (srcLineUsedCount.usedCount === CodeCoverage.default) {
diff --git a/src/parser/singleFunctionAnalysis.ts b/src/parser/singleFunctionAnalysis.ts
@@ -6,6 +6,7 @@ type BranchGraph = Map<number, Map<number, boolean>>;
 export class SingleFunctionCoverageAnalysis {
   result: FunctionCoverageResult;
   branchGraph: BranchGraph = new Map();
+  notFullyCoveredBasicBlock: Set<number> = new Set();
   constructor(
     public covInfo: CovInfo,
     name: string
@@ -72,12 +73,28 @@ export class SingleFunctionCoverageAnalysis {
         toNodes.set(second, true);
       }
     }
+    for (const toNodes of this.branchGraph) {
+      let [currentBasicBlock, branchesForThatBasicBlock] = toNodes;
+      for (const isCovered of branchesForThatBasicBlock.values()) {
+        if (!isCovered) {
+          this.notFullyCoveredBasicBlock.add(currentBasicBlock);
+        }
+      }
+    }
     for (const toNodes of this.branchGraph.values()) {
       let used = 0;
       for (const toNode of toNodes.values()) {
         if (toNode) used++;
       }
       this.result.branchCoverageRate.used += used;
     }
+    // console.log(this.notFullyCoveredBasicBlock);
+    for (const block of this.notFullyCoveredBasicBlock) {
+      const lineInfo = this.covInfo.lineInfo.get(block);
+      if (lineInfo !== undefined && lineInfo.size > 0) {
+        this.result.linesToHighlight.add(Math.max(...lineInfo));
+      }
+    }
+    // console.log(this.result.functionName, this.result.lineRange, this.result.linesToHighlight);
   }
 }
diff --git a/tests-as/diytest.test.ts b/tests-as/diytest.test.ts
@@ -0,0 +1,31 @@
+import { describe, endTest, expect, test } from "../assembly";
+import { mycmp, instancecmp } from "../assembly/diytest"
+
+describe("cmp test", () => {
+    // 要考虑到流图可能不同，导致总branch数可能不同，所以计算branch覆盖率只能进行加权平均
+    test("a>b", () => {
+        let a: i32 = 1;
+        let b: i32 = 0;
+        expect(mycmp(a, b)).equal(true);
+    });
+    test("a<b", () => {
+        let a: f32 = 0;
+        let b: f32 = 0.5;
+        expect(mycmp(a, b)).equal(false);
+    });
+});
+
+describe("instance test", () => {
+    test("a>b", () => {
+        let a: i32 = 1;
+        let b: i32 = 0;
+        expect(instancecmp(a, b)).equal(true);
+    });
+    test("a<b", () => {
+        let a: f32 = 0;
+        let b: f32 = 0.5;
+        expect(instancecmp(a, b)).equal(false);
+    });
+});
+
+endTest();
diff --git a/tests-ts/test/parser/__snapshots__/parser.test.ts.snap b/tests-ts/test/parser/__snapshots__/parser.test.ts.snap
@@ -16,6 +16,7 @@ exports[`Parser generateFileCoverage 1`] = `
       "total": 18,
       "used": 9,
     },
+    "linesToHighlight": Set {},
     "sourceUsedCount": [
       CodeCoverage {
         "source": "",
@@ -241,6 +242,7 @@ exports[`Parser generateFileCoverage 1`] = `
       "total": 1,
       "used": 1,
     },
+    "linesToHighlight": Set {},
     "sourceUsedCount": [
       CodeCoverage {
         "source": "",
@@ -466,6 +468,9 @@ exports[`Parser generateFileCoverage 1`] = `
       "total": 13,
       "used": 9,
     },
+    "linesToHighlight": Set {
+      25,
+    },
     "sourceUsedCount": [
       CodeCoverage {
         "source": "",
@@ -691,6 +696,7 @@ exports[`Parser generateFileCoverage 1`] = `
       "total": 2,
       "used": 2,
     },
+    "linesToHighlight": Set {},
     "sourceUsedCount": [
       CodeCoverage {
         "source": "",
@@ -917,6 +923,7 @@ exports[`Parser generateFunctionCoverage 1`] = `
       39,
       39,
     ],
+    "linesToHighlight": Set {},
     "sourceUsedCount": Map {
       39 => 3,
     },
@@ -931,6 +938,7 @@ exports[`Parser generateFunctionCoverage 1`] = `
       16,
       24,
     ],
+    "linesToHighlight": Set {},
     "sourceUsedCount": Map {
       16 => 3,
       17 => 3,
@@ -952,6 +960,7 @@ exports[`Parser generateFunctionCoverage 1`] = `
       45,
       45,
     ],
+    "linesToHighlight": Set {},
     "sourceUsedCount": Map {
       45 => 4,
     },
@@ -966,6 +975,9 @@ exports[`Parser generateFunctionCoverage 1`] = `
       10,
       29,
     ],
+    "linesToHighlight": Set {
+      25,
+    },
     "sourceUsedCount": Map {
       10 => 2,
       11 => 2,
@@ -989,6 +1001,7 @@ exports[`Parser generateFunctionCoverage 1`] = `
       10,
       11,
     ],
+    "linesToHighlight": Set {},
     "sourceUsedCount": Map {
       10 => 2,
       11 => 2,
diff --git a/tests-ts/test/parser/singleFileAnalysis.test.ts b/tests-ts/test/parser/singleFileAnalysis.test.ts
@@ -36,6 +36,7 @@ describe("singleFileAnalysis", () => {
       functionName: "A",
       lineRange: [6, 9],
       branchCoverageRate: rate_A,
+      linesToHighlight: new Set<number>([]),
       sourceUsedCount: new Map([
         [6, 3],
         [7, 0],
@@ -49,6 +50,7 @@ describe("singleFileAnalysis", () => {
       functionName: "B",
       lineRange: [10, 14],
       branchCoverageRate: rate_B,
+      linesToHighlight: new Set<number>([]),
       sourceUsedCount: new Map([
         [10, 2],
         [11, 0],
@@ -73,8 +75,8 @@ describe("singleFileAnalysis", () => {
 
   test("setUnTestedFunction error", () => {
     const analyzer = new SingleFileCoverageAnalysis("main", source);
-    expect(() => analyzer.setUnTestedFunction([[30, 31]])).toThrowError(
-      "unknowm error: There is no 29 Line in file main"
+    expect(() => analyzer.setUnTestedFunction([[30, 31]])).toThrow(
+      "unknown error: There is no 29 Line in file main"
     );
   });
 
@@ -88,12 +90,13 @@ describe("singleFileAnalysis", () => {
       functionName: "A",
       lineRange: [6, 30],
       branchCoverageRate: rate,
+      linesToHighlight: new Set<number>([]),
       sourceUsedCount: new Map([
         [6, 3],
         [7, 0],
         [30, 3],
       ]),
     };
-    expect(() => analyzer.merge([funcResult])).toThrowError();
+    expect(() => analyzer.merge([funcResult])).toThrow();
   });
 });

Original file line number	Diff line number	Diff line change
`@@ -19,21 +19,23 @@ export class SingleFileCoverageAnalysis {`
`19`	`19`	`for (let index = startLine - 1; index < endLine; index++) {`
`20`	`20`	`const codeCoverage = this.result.sourceUsedCount[index];`
`21`	`21`	`if (codeCoverage === undefined) {`
`22`		- throw new Error(`unknowm error: There is no ${index} Line in file ${this.result.filename}`);
	`22`	+ throw new Error(`unknown error: There is no ${index} Line in file ${this.result.filename}`);
`23`	`23`	`}`
`24`	`24`	`codeCoverage.usedCount = 0;`
`25`	`25`	`}`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`merge(results: FunctionCoverageResult[]) {`
	`30`	`+ // SingleFileCoverageAnalysis contains FileCoverageResult`
`30`	`31`	`if (results.length === 0) return;`
`31`	`32`	`for (const functionCovResult of results) {`
	`33`	`+ functionCovResult.linesToHighlight.forEach(line => this.result.linesToHighlight.add(line));`
`32`	`34`	`for (const [lineIndex, count] of functionCovResult.sourceUsedCount.entries()) {`
`33`	`35`	`const srcLineUsedCount = this.result.sourceUsedCount[lineIndex - 1];`
`34`	`36`	`if (srcLineUsedCount === undefined) {`
`35`	`37`	`throw new Error(`
`36`		- `unknowm error: There is not Line ${lineIndex} in ${JSON.stringify(this.result.sourceUsedCount)}`
	`38`	+ `unknown error: There is not Line ${lineIndex} in ${JSON.stringify(this.result.sourceUsedCount)}`
`37`	`39`	`);`
`38`	`40`	`}`
`39`	`41`	`if (srcLineUsedCount.usedCount === CodeCoverage.default) {`