test: add and modify tests for coverage

Author: EscapedGibbon

src/geometry/__tests__/getPerspectiveWarp.test.ts

@@ -46,16 +46,15 @@ describe('warping tests', () => {
 describe('openCV comparison', () => {
   test('nearest interpolation plants', () => {
     const image = testUtils.load('various/plants.png');
-
     const openCvResult = testUtils.load(
       'opencv/test_perspective_warp_plants_nearest.png',
     );
 
     const points = [
-      { column: 166.5, row: 195 },
       { column: 858.5, row: 9 },
       { column: 911.5, row: 786 },
       { column: 154.5, row: 611 },
+      { column: 166.5, row: 195 },
     ];
     const matrix = getPerspectiveWarp(points, {
       width: 1080,
@@ -81,17 +80,17 @@ describe('openCV comparison', () => {
     expect(result.height).toEqual(openCvResult.height);
     expect(croppedPiece).toEqual(croppedPieceOpenCv);
   });
+
   test('nearest interpolation card', () => {
     const image = testUtils.load('various/card.png');
-
     const openCvResult = testUtils.load(
       'opencv/test_perspective_warp_card_nearest.png',
     );
     const points = [
-      { column: 55, row: 140 },
-      { column: 680, row: 38 },
       { column: 840, row: 340 },
       { column: 145, row: 460 },
+      { column: 55, row: 140 },
+      { column: 680, row: 38 },
     ];
     const matrix = getPerspectiveWarp(points, {
       width: 700,
@@ -121,16 +120,15 @@ describe('openCV comparison', () => {
   });
   test('nearest interpolation plants', () => {
     const image = testUtils.load('various/plants.png');
-
     const openCvResult = testUtils.load(
       'opencv/test_perspective_warp_plants_linear.png',
     );
 
     const points = [
       { column: 166.5, row: 195 },
-      { column: 858.5, row: 9 },
-      { column: 911.5, row: 786 },
       { column: 154.5, row: 611 },
+      { column: 911.5, row: 786 },
+      { column: 858.5, row: 9 },
     ];
     const matrix = getPerspectiveWarp(points, {
       width: 1080,
@@ -145,3 +143,13 @@ describe('openCV comparison', () => {
     expect(result.height).toEqual(openCvResult.height);
   });
 });
+
+describe('error testing', () => {
+  test("should throw if there aren't 4 points", () => {
+    expect(() => {
+      getPerspectiveWarp([{ column: 1, row: 1 }]);
+    }).toThrow(
+      'The array pts must have four elements, which are the four corners. Currently, pts have 1 elements',
+    );
+  });
+});

src/geometry/getPerspectiveWarp.ts

@@ -86,7 +86,7 @@ export default function getPerspectiveWarp(
 }
 
 /**
- * Sorts 4 points in order =>[top-left,top-right,bottom-right,bottom-left].
+ * Sorts 4 points in order =>[top-left,top-right,bottom-right,bottom-left]. Input points must be in clockwise or counter-clockwise order.
  * @param pts - Array of 4 points.
  * @returns Sorted array of 4 points.
  */
@@ -137,7 +137,6 @@ function order4Points(pts: Point[]) {
       br = pts[(indexMinX + 3) % 4];
     }
   }
-
   return [tl, tr, br, bl];
 }
 /**