Feature/307/default imagereader imagewriter (#308)

* (#307) Add jimp dependencz

* (#307) Implement image reader

* (#307) Implement image writer

* (#307) Test data

* (#307) Register both providers

* (#307) Stick to BGR color format when loading images

* (#307) Expose imagereader and imagewriter through utility functions

* (#307) Updated tests to verify calls to Jimp

* (#307) Mock jimp in testcases using the pluginRegistry to avoid ReferenceErrors

* (#307) Mock jimp in e2e testcases to avoid ReferenceErrors

Author: s1hofmann

e2e/plugin-test/keyboard.class.e2e.spec.ts

@@ -1,6 +1,8 @@
 import { jestMatchers, Key, keyboard, screen } from "@nut-tree/nut-js";
 import "@nut-tree/template-matcher";
 
+jest.mock('jimp', () => {});
+
 jest.setTimeout(30000);
 expect.extend(jestMatchers);
 

index.ts

@@ -50,6 +50,9 @@ const assert = new AssertClass(screen);
 const {straightTo, up, down, left, right} = createMovementApi(nativeActions, lineHelper);
 const {getWindows, getActiveWindow} = createWindowApi(nativeActions);
 
+const loadImage = providerRegistry.getImageReader().load;
+const saveImage = providerRegistry.getImageWriter().store;
+
 export {
     clipboard,
     keyboard,
@@ -63,4 +66,6 @@ export {
     right,
     getWindows,
     getActiveWindow,
+    loadImage,
+    saveImage
 };

lib/adapter/native.adapter.class.spec.ts

@@ -12,6 +12,7 @@ jest.mock("../provider/native/clipboardy-clipboard.class");
 jest.mock("../provider/native/libnut-mouse.class");
 jest.mock("../provider/native/libnut-keyboard.class");
 jest.mock("../provider/native/libnut-window.class");
+jest.mock('jimp', () => {});
 
 let clipboardMock: ClipboardAction;
 let keyboardMock: KeyboardAction;

lib/adapter/vision.adapter.class.spec.ts

@@ -6,6 +6,7 @@ import {VisionAdapter} from "./vision.adapter.class";
 import providerRegistry from "../provider/provider-registry.class";
 import {MatchResult} from "../match-result.class";
 
+jest.mock('jimp', () => {});
 jest.mock("../provider/native/libnut-screen.class");
 
 const finderMock = {

lib/assert.class.spec.ts

@@ -4,6 +4,7 @@ import {Region} from "./region.class";
 import {ScreenClass} from "./screen.class";
 import providerRegistry from "./provider/provider-registry.class";
 
+jest.mock('jimp', () => {});
 jest.mock("./adapter/native.adapter.class");
 jest.mock("./adapter/vision.adapter.class");
 jest.mock("./screen.class");

lib/clipboard.class.spec.ts

@@ -2,6 +2,7 @@ import {NativeAdapter} from "./adapter/native.adapter.class";
 import {ClipboardClass} from "./clipboard.class";
 import providerRegistry from "./provider/provider-registry.class";
 
+jest.mock('jimp', () => {});
 jest.mock("./adapter/native.adapter.class");
 
 beforeEach(() => {

lib/expect/matchers/toBeAt.function.e2e.spec.ts

@@ -2,6 +2,8 @@ import { mouse } from "../../../index";
 import { Point } from "../../point.class";
 import { toBeAt } from "./toBeAt.function";
 
+jest.mock('jimp', () => {});
+
 const targetPoint = new Point(100, 100);
 
 describe(".toBeAt", () => {

lib/expect/matchers/toBeIn.function.e2e.spec.ts

@@ -3,6 +3,8 @@ import { Point } from "../../point.class";
 import { Region } from "../../region.class";
 import { toBeIn } from "./toBeIn.function";
 
+jest.mock('jimp', () => {});
+
 const targetPoint = new Point(400, 400);
 
 describe(".toBeIn", () => {

lib/provider/io/__mocks__/calculator.png

@@ -0,0 +1,59 @@
+import ImageReader from "./jimp-image-reader.class";
+import {join} from "path";
+import Jimp from "jimp";
+
+jest.mock('gifwrap', () => {});
+jest.mock('jimp', () => {
+    class JimpMock {
+        bitmap = {
+            width: 100,
+            height: 100,
+            data: Buffer.from([]),
+        }
+        hasAlpha = () => false
+        static read = jest.fn(() => Promise.resolve(new JimpMock()))
+    }
+
+    return ({
+        __esModule: true,
+        default: JimpMock
+    })
+});
+
+afterEach(() => jest.resetAllMocks());
+
+describe('Jimp image reader', () => {
+    it('should return an Image object', async () => {
+        // GIVEN
+        const inputPath = join(__dirname, "__mocks__", "calculator.png");
+        const scanMock = jest.fn();
+        Jimp.prototype.scan = scanMock;
+        const SUT = new ImageReader();
+
+        // WHEN
+        await SUT.load(inputPath);
+
+        // THEN
+        expect(scanMock).toHaveBeenCalledTimes(1);
+        expect(Jimp.read).toBeCalledTimes(1);
+        expect(Jimp.read).toBeCalledWith(inputPath);
+    });
+
+    it('should reject on loading failures', async () => {
+        // GIVEN
+        const inputPath = "/some/path/to/file";
+        const expectedError = "Error during load";
+        const SUT = new ImageReader();
+        Jimp.read = jest.fn(() => {
+            throw new Error(expectedError);
+        })
+
+        // WHEN
+        try {
+            await SUT.load(inputPath);
+        } catch (err) {
+            // THEN
+            expect(err).toStrictEqual(Error(expectedError));
+        }
+    });
+});