Refactor tests

README.md

@@ -87,9 +87,10 @@ Tests can be run with
 npm test
 ```
 
-The test suite is several hundred images that can be found in the [test-data/](./test-data/images) folder.
+Besides unit tests the test suite contains several hundred images that can be found in the [/tests/end-to-end/](./tests/end-to-end/) folder.
 
-Not all the images can be read. In general changes should hope to increase the number of images that read. However due to the nature of computer vision some changes may cause images that pass to start to fail and visa versa. To update the expected outcomes run `npm run-script generate-test-data`. These outcomes can be evaluated in the context of a PR to determine if a change improves or harms the overall ability of the library to read QR codes.
+Not all the images can be read. In general changes should hope to increase the number of images that read. However due to the nature of computer vision some changes may cause images that pass to start to fail and visa versa. To update the expected outcomes run `npm run-script generate-test-data`. These outcomes can be evaluated in the context of a PR to determine if a change improves or harms the overall ability of the library to read QR codes. A summary of which are passing
+and failing can be found at [/tests/end-to-end/report.json](./tests/end-to-end/report.json)
 
 After testing any changes, you can compile the production version by running
 ```

src/decoder/test.ts

@@ -0,0 +1,54 @@
+import { loadBinarized } from "../../tests/helpers";
+import { decode } from "./decoder";
+
+describe("decode", () => {
+  it("decodes a numeric code", async () => {
+    const data = await loadBinarized("./src/decoder/test-data/numeric.png");
+    expect(decode(data)).toEqual({
+      text: "123456789",
+      bytes: [49, 50, 51, 52, 53, 54, 55, 56, 57],
+      chunks: [{ type: "numeric", text: "123456789" }],
+    });
+  });
+
+  it("decodes an alphanumeric code", async () => {
+    const data = await loadBinarized("./src/decoder/test-data/alphanumeric.png");
+    expect(decode(data)).toEqual({
+      text: "ABCD1234",
+      bytes: [65, 66, 67, 68, 49, 50, 51, 52],
+      chunks: [{ type: "alphanumeric", text: "ABCD1234" }],
+    });
+  });
+
+  it("decodes a byte code", async () => {
+    const data = await loadBinarized("./src/decoder/test-data/byte.png");
+    expect(decode(data)).toEqual({
+      text: "Test",
+      bytes: [84, 101, 115, 116],
+      chunks: [{ type: "byte", bytes: [84, 101, 115, 116], text: "Test" }],
+    });
+  });
+
+  it("decodes a kanji code", async () => {
+    const data = await loadBinarized("./src/decoder/test-data/kanji.png");
+    expect(decode(data)).toEqual({
+      text: "テスト",
+      bytes: [131, 101, 131, 88, 131, 103],
+      chunks: [{ type: "kanji", bytes: [131, 101, 131, 88, 131, 103], text: "テスト" }],
+    });
+  });
+
+  it("decodes a mixed code", async () => {
+    const data = await loadBinarized("./src/decoder/test-data/mixed.png");
+    expect(decode(data)).toEqual({
+      text: "123456789ABCD1234Testテスト",
+      bytes: [49, 50, 51, 52, 53, 54, 55, 56, 57, 65, 66, 67, 68, 49, 50, 51, 52, 84, 101, 115, 116, 131, 101, 131, 88, 131, 103],
+      chunks: [
+        { type: "numeric", text: "123456789" },
+        { type: "alphanumeric", text: "ABCD1234" },
+        { type: "byte", bytes: [84, 101, 115, 116], text: "Test" },
+        { type: "kanji", bytes: [131, 101, 131, 88, 131, 103], text: "テスト" },
+      ],
+    });
+  });
+});

src/extractor/test.ts

@@ -1,20 +1,44 @@
-import tests from "../../test-data";
 import { loadBinarized } from "../../tests/helpers";
 import { BitMatrix } from "../BitMatrix";
 import { extract } from "./";
 
-describe("extract", () => {
-  tests.forEach((t) => {
-    it(t.name, async () => {
-      const binarizedImage = await loadBinarized(t.binarizedPath);
-      const expectedOutput = t.extractedPath ? await loadBinarized(t.extractedPath) : null;
-      let output: BitMatrix = null;
-      try {
-        output = extract(binarizedImage, t.location).matrix;
-      } catch (e) {
-        // error
+function matricCompare(a: BitMatrix, b: BitMatrix) {
+  if (!(a.height === b.height && a.width === b.width)) {
+    return false;
+  }
+  for (let x = 0; x < a.width; x++) {
+    for (let y = 0; y < a.height; y++) {
+      if (a.get(x, y) !== b.get(x, y)) {
+        return false;
       }
-      expect(output).toEqual(expectedOutput);
+    }
+  }
+  return true;
+}
+
+describe("extract", () => {
+  it("is a no-op when applied to an already extracted code", async () => {
+    const data = await loadBinarized("./src/extractor/test-data/output.png");
+    const extracted = extract(data, {
+      topLeft: { x: 3.5, y: 3.5 },
+      bottomLeft: { x: 3.5, y: 21.5 },
+      topRight: { x: 21.5, y: 3.5 },
+      alignmentPattern: { x: 18.5, y: 18.5 },
+      dimension: 25,
+    });
+    expect(matricCompare(extracted.matrix, data)).toBeTruthy();
+  });
+
+  it("extracts a distorted QR code", async () => {
+    const input = await loadBinarized("./src/extractor/test-data/input.png");
+    const expected = await loadBinarized("./src/extractor/test-data/output.png");
+    const extracted = extract(input, {
+      topLeft: { x: 56, y: 94 },
+      bottomLeft: { x: 88, y: 268 },
+      topRight: { x: 275, y: 175 },
+      alignmentPattern: { x: 197, y: 315 },
+      dimension: 25,
     });
+    expect(matricCompare(extracted.matrix, expected)).toBeTruthy();
   });
 });

src/locator/test.ts

@@ -1,18 +1,65 @@
-import tests from "../../test-data";
 import {loadBinarized} from "../../tests/helpers";
 import {locate} from "./";
 
 describe("locate", () => {
-  tests.forEach((t) => {
-    it(t.name, async () => {
-      const binarizedImage = await loadBinarized(t.binarizedPath);
-      const output = locate(binarizedImage);
-      expect(output).toEqual(t.location);
-    });
-  });
-
   it("handles images with missing finder patterns", async () => {
     const binarized = await loadBinarized("./src/locator/test-data/missing-finder-patterns.png");
     expect(() => locate(binarized)).not.toThrow();
+    expect(locate(binarized)).toEqual(null);
+  });
+
+  it('locates a "perfect" image', async () => {
+    const binarized = await loadBinarized("./src/locator/test-data/perfect.png");
+    expect(locate(binarized)).toEqual({
+      alignmentPattern: {x: 170.5, y: 170.5},
+      bottomLeft: {x: 3.5, y: 173.5},
+      dimension: 177,
+      topLeft: {x: 3.5, y: 3.5},
+      topRight: {x: 173.5, y: 3.5},
+    });
+  });
+
+  it("locates a QR in a real world image", async () => {
+    const binarized = await loadBinarized("./src/locator/test-data/real-world.png");
+    expect(locate(binarized)).toEqual({
+      alignmentPattern: { x: 264.25, y: 177 },
+      bottomLeft: { x: 195.5, y: 191.5 },
+      dimension: 33,
+      topLeft: { x: 191.75, y: 113.5 },
+      topRight: { x: 270.75, y: 107.5 },
+    });
+  });
+
+  it("locates a small QR code in real world photo", async () => {
+    const binarized = await loadBinarized("./src/locator/test-data/small-photo.png");
+    expect(locate(binarized)).toEqual({
+      alignmentPattern: { x: 103, y: 147.5 },
+      bottomLeft: { x: 73.5, y: 152 },
+      dimension: 29,
+      topLeft: { x: 74, y: 117.5 },
+      topRight: { x: 108, y: 118 },
+    });
+  });
+
+  it("locates a extremely distored QR code", async () => {
+    const binarized = await loadBinarized("./src/locator/test-data/distorted-extreme.png");
+    expect(locate(binarized)).toEqual({
+      alignmentPattern: { x: 164.5, y: 39 },
+      bottomLeft: { x: 221.5, y: 18.5 },
+      dimension: 25,
+      topLeft: { x: 180.5, y: 101 },
+      topRight: { x: 122.75, y: 105 },
+    });
+  });
+
+  it("locates a damaged QR code and guesses the finder pattern location", async () => {
+    const binarized = await loadBinarized("./src/locator/test-data/damaged.png");
+    expect(locate(binarized)).toEqual({
+      alignmentPattern: { x: 219.75, y: 221 },
+      bottomLeft: { x: 81.5, y: 215.5 },
+      dimension: 29,
+      topLeft: { x: 82, y: 75.5 },
+      topRight: { x: 221.75, y: 76 },
+    });
   });
 });