property based testing for the win

catching all my bugs...

Author: josharian

packages/common/src/testUtil/mockEditor.test.ts

@@ -43,17 +43,33 @@ suite("mockEditor", () => {
           "plaintext",
           contents,
         );
+        let tot: number = 0;
+        for (let lineno = 0; lineno < doc.lineCount; lineno++) {
+          const line = doc.lineAt(lineno);
+          tot += line.rangeIncludingLineBreak.end.character;
+          assert.equal(line.lineNumber, lineno);
+          assert.equal(line.range.start.line, lineno);
+          assert.equal(line.range.end.line, lineno);
+          assert.equal(line.rangeIncludingLineBreak.start.line, lineno);
+          assert.equal(line.rangeIncludingLineBreak.end.line, lineno);
+          assert.equal(
+            line.rangeIncludingLineBreak.end.character,
+            line.text.length,
+          );
+          assert.equal(
+            line.rangeIncludingLineBreak.end.character,
+            line.range.end.character,
+          );
+        }
+        assert.equal(tot, contents.length);
+
         for (let i = 0; i < contents.length; i++) {
           const pos = doc.positionAt(i);
           // positions must be within the range of a line
-          if (pos.character > doc.lineAt(pos.line).range.end.character) {
-            return false;
-          }
+          assert.ok(pos.character <= doc.lineAt(pos.line).range.end.character);
           const offset = doc.offsetAt(pos);
           // positionAt and offsetAt are inverses
-          if (offset !== i) {
-            return false;
-          }
+          assert.equal(offset, i);
           return true;
         }
       }),

packages/common/src/testUtil/mockEditor.ts

@@ -16,23 +16,24 @@ import {
 export class MockTextLine implements TextLine {
   readonly lineNumber: number;
   readonly text: string;
-  private eol: string;
   readonly range: Range;
   readonly rangeIncludingLineBreak: Range;
   readonly firstNonWhitespaceCharacterIndex: number;
   readonly lastNonWhitespaceCharacterIndex: number;
   readonly isEmptyOrWhitespace: boolean;
 
-  constructor(lineNumber: number, text: string, eol: string) {
+  constructor(lineNumber: number, text: string) {
     if (lineNumber < 0) {
       throw new Error("lineNumber must be non-negative");
     }
     this.lineNumber = lineNumber;
-    this.text = text;
-    if (eol !== "\n" && eol !== "\r\n") {
-      throw new Error("eol must be \\n or \\r\\n");
+    // capture any trailing \r\n or \n as eol (possibly neither is present)
+    const eol = text.match(/(\r?\n)$/)?.[1] ?? "";
+    if (eol.length > 0) {
+      this.text = text.slice(0, -eol.length);
+    } else {
+      this.text = text;
     }
-    this.eol = eol;
     this.range = new Range(
       this.lineNumber,
       0,
@@ -43,7 +44,7 @@ export class MockTextLine implements TextLine {
       this.lineNumber,
       0,
       this.lineNumber,
-      this.text.length + this.eol.length,
+      this.text.length + eol.length,
     );
     const first = this.text.search(/\S/);
     this.firstNonWhitespaceCharacterIndex =
@@ -74,17 +75,21 @@ export class MockTextDocument implements TextDocument {
       throw new Error("InMemoryTextDocument does not support CRLF (yet?)");
     }
     this.contents = contents;
-    const rawLines = contents.split("\n");
+    const rawLines: string[] = contents.match(/[^\n]*\n|[^\n]+/g) ?? [];
     this.lines = rawLines.map((line, i) => {
-      return new MockTextLine(i, line, "\n");
+      return new MockTextLine(i, line);
     });
-    const lastLineRange = this.lines[this.lines.length - 1].range;
-    this.range = new Range(
-      0,
-      0,
-      lastLineRange.end.line,
-      lastLineRange.end.character,
-    );
+    if (this.lines.length === 0) {
+      this.range = new Range(0, 0, 0, 0);
+    } else {
+      const lastLineRange = this.lines[this.lines.length - 1].range;
+      this.range = new Range(
+        0,
+        0,
+        lastLineRange.end.line,
+        lastLineRange.end.character,
+      );
+    }
     this.eol = "LF";
   }