Merge pull request #42 from nut-tree/develop

release v0.1.0-beta.0

.travis.yml

@@ -6,9 +6,6 @@ node_js:
   - "lts/dubnium"
 cache: npm
 
-notifications:
-  webhooks: https://outlook.office.com/webhook/b6e4942d-6066-4001-8ba1-428598f3ae13@eb86a0ab-5bd0-4070-b04f-b7bf90ca02c5/TravisCI/ad6b89add60a4d4c8d1a06aa4ee424e8/d6c06c79-667d-43b9-92b6-0e9687d93d0f
-
 addons:
   sonarcloud:
     organization: "nut-tree"

index.e2e.spec.ts

@@ -0,0 +1,50 @@
+import { assert, Key, keyboard, Location, mouse, movement, screen } from "./index";
+
+const openXfceMenu = async () => {
+  const menu = await screen.find("menu.png");
+  await mouse.move(await movement.straightTo(Location.centerOf(menu)));
+  await mouse.leftClick();
+  await mouse.leftClick();
+};
+
+const run = async (cmd: string) => {
+  await keyboard.type(Key.LeftAlt, Key.F2);
+  await keyboard.type(cmd);
+  await keyboard.type(Key.Enter);
+};
+
+const calculate = async () => {
+  const plus = await screen.find("plus.png");
+  await mouse.move(await movement.straightTo(Location.centerOf(plus)));
+  await mouse.leftClick();
+  const one = await screen.find("one.png");
+  await mouse.move(await movement.straightTo(Location.centerOf(one)));
+  await mouse.leftClick();
+  const zero = await screen.find("zero.png");
+  await mouse.move(await movement.straightTo(Location.centerOf(zero)));
+  await mouse.leftClick();
+  await mouse.leftClick();
+  await keyboard.type(Key.Enter);
+};
+
+const close = async () => {
+  const x = await screen.find("close.png");
+  await mouse.move(await movement.straightTo(Location.centerOf(x)));
+  await mouse.leftClick();
+};
+
+describe("E2E demo", () => {
+  it("should run without throwing", async () => {
+    jest.setTimeout(30000);
+    screen.config.resourceDirectory = "./e2e/assets";
+    await assert.isVisible("mouse.png");
+    await assert.isVisible("desktop.png");
+    await openXfceMenu();
+    await run("gnome-calculator");
+    await assert.isVisible("calculator.png");
+    await keyboard.type("525");
+    await calculate();
+    await assert.isVisible("result.png");
+    await close();
+  });
+});

index.ts

@@ -25,7 +25,7 @@ const clipboard = new Clipboard(nativeActions);
 const keyboard = new Keyboard(nativeActions);
 const mouse = new Mouse(nativeActions);
 const movement = new Movement(nativeActions, new LineHelper());
-const screen = new Screen(screenActions, nativeActions);
+const screen = new Screen(screenActions);
 const assert = new Assert(screen);
 
 export { clipboard, keyboard, mouse, movement, screen, assert };

jest.config.js

@@ -1,14 +1,17 @@
 module.exports = {
     preset: "ts-jest",
     testEnvironment: "node",
-    roots: ["lib"],
     collectCoverageFrom: [
         "index.ts",
         "lib/**/*.ts",
         "!lib/**/*.spec.ts",
         "!<rootDir>/node_modules/",
         "!<rootDir>/path/to/dir/"
     ],
+    testPathIgnorePatterns: [
+      "/node_modules/",
+      "/dist/"
+    ],
     testMatch: process.env.E2E_TEST ?
         [ "**/__tests__/?(e2e)/**/*.[jt]s?(x)", "**/?(*.)?(e2e.)+(spec|test).[jt]s?(x)" ] :
         [ "**/__tests__/!(e2e)/**/*.[jt]s?(x)", "**/!(*.e2e.*)+(spec|test).[jt]s?(x)" ]

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

@@ -4,55 +4,19 @@ import { Point } from "../point.class";
 import { ClipboardAction } from "../provider/native/clipboardy-clipboard-action.class";
 import { KeyboardAction } from "../provider/native/robotjs-keyboard-action.class";
 import { MouseAction } from "../provider/native/robotjs-mouse-action.class";
-import { ScreenAction } from "../provider/native/robotjs-screen-action.class";
-import { Region } from "../region.class";
 import { NativeAdapter } from "./native.adapter.class";
 
 jest.mock("../provider/native/clipboardy-clipboard-action.class");
 jest.mock("../provider/native/robotjs-mouse-action.class");
 jest.mock("../provider/native/robotjs-keyboard-action.class");
-jest.mock("../provider/native/robotjs-screen-action.class");
-
-describe("Native adapter class", () => {
-  it("should delegate calls to grabScreen", () => {
-    // GIVEN
-    const clipboardMock = new ClipboardAction();
-    const keyboardMock = new KeyboardAction();
-    const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
-
-    // WHEN
-    SUT.grabScreen();
-
-    // THEN
-    expect(screenMock.grabScreen).toBeCalledTimes(1);
-  });
-
-  it("should delegate calls to grabScreenRegion", () => {
-    // GIVEN
-    const clipboardMock = new ClipboardAction();
-    const keyboardMock = new KeyboardAction();
-    const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
-    const screenRegion = new Region(0, 0, 100, 100);
-
-    // WHEN
-    SUT.grabScreenRegion(screenRegion);
-
-    // THEN
-    expect(screenMock.grabScreenRegion).toBeCalledTimes(1);
-    expect(screenMock.grabScreenRegion).toBeCalledWith(screenRegion);
-  });
 
+describe("NativeAdapter class", () => {
   it("should delegate calls to setMouseDelay", () => {
     // GIVEN
     const clipboardMock = new ClipboardAction();
     const keyboardMock = new KeyboardAction();
     const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
+    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock);
     const delay = 5;
 
     // WHEN
@@ -68,8 +32,7 @@ describe("Native adapter class", () => {
     const clipboardMock = new ClipboardAction();
     const keyboardMock = new KeyboardAction();
     const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
+    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock);
     const newPosition = new Point(10, 10);
 
     // WHEN
@@ -85,8 +48,7 @@ describe("Native adapter class", () => {
     const clipboardMock = new ClipboardAction();
     const keyboardMock = new KeyboardAction();
     const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
+    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock);
 
     // WHEN
     SUT.currentMousePosition();
@@ -95,58 +57,12 @@ describe("Native adapter class", () => {
     expect(mouseMock.currentMousePosition).toBeCalledTimes(1);
   });
 
-  it("should delegate calls to screenWidth", () => {
-    // GIVEN
-    const clipboardMock = new ClipboardAction();
-    const keyboardMock = new KeyboardAction();
-    const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
-
-    // WHEN
-    SUT.screenWidth();
-
-    // THEN
-    expect(screenMock.screenWidth).toBeCalledTimes(1);
-  });
-
-  it("should delegate calls to screenHeight", () => {
-    // GIVEN
-    const clipboardMock = new ClipboardAction();
-    const keyboardMock = new KeyboardAction();
-    const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
-
-    // WHEN
-    SUT.screenHeight();
-
-    // THEN
-    expect(screenMock.screenHeight).toBeCalledTimes(1);
-  });
-
-  it("should delegate calls to screenSize", () => {
-    // GIVEN
-    const clipboardMock = new ClipboardAction();
-    const keyboardMock = new KeyboardAction();
-    const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
-
-    // WHEN
-    SUT.screenSize();
-
-    // THEN
-    expect(screenMock.screenSize).toBeCalledTimes(1);
-  });
-
   it("should delegate calls to leftClick", () => {
     // GIVEN
     const clipboardMock = new ClipboardAction();
     const keyboardMock = new KeyboardAction();
     const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
+    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock);
 
     // WHEN
     SUT.leftClick();
@@ -160,8 +76,7 @@ describe("Native adapter class", () => {
     const clipboardMock = new ClipboardAction();
     const keyboardMock = new KeyboardAction();
     const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
+    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock);
 
     // WHEN
     SUT.rightClick();
@@ -175,8 +90,7 @@ describe("Native adapter class", () => {
     const clipboardMock = new ClipboardAction();
     const keyboardMock = new KeyboardAction();
     const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
+    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock);
 
     // WHEN
     SUT.middleClick();
@@ -190,8 +104,7 @@ describe("Native adapter class", () => {
     const clipboardMock = new ClipboardAction();
     const keyboardMock = new KeyboardAction();
     const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
+    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock);
     const buttonToPress = Button.LEFT;
 
     // WHEN
@@ -207,8 +120,7 @@ describe("Native adapter class", () => {
     const clipboardMock = new ClipboardAction();
     const keyboardMock = new KeyboardAction();
     const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
+    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock);
     const buttonToRelease = Button.LEFT;
 
     // WHEN
@@ -224,8 +136,7 @@ describe("Native adapter class", () => {
     const clipboardMock = new ClipboardAction();
     const keyboardMock = new KeyboardAction();
     const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
+    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock);
     const keyToPress = Key.A;
 
     // WHEN
@@ -241,8 +152,7 @@ describe("Native adapter class", () => {
     const clipboardMock = new ClipboardAction();
     const keyboardMock = new KeyboardAction();
     const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
+    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock);
     const keyToRelease = Key.A;
 
     // WHEN
@@ -258,8 +168,7 @@ describe("Native adapter class", () => {
     const clipboardMock = new ClipboardAction();
     const keyboardMock = new KeyboardAction();
     const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
+    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock);
     const keyToClick = Key.A;
 
     // WHEN
@@ -275,8 +184,7 @@ describe("Native adapter class", () => {
     const clipboardMock = new ClipboardAction();
     const keyboardMock = new KeyboardAction();
     const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
+    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock);
     const stringToType = "testString";
 
     // WHEN
@@ -292,8 +200,7 @@ describe("Native adapter class", () => {
     const clipboardMock = new ClipboardAction();
     const keyboardMock = new KeyboardAction();
     const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
+    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock);
     const stringToCopy = "testString";
 
     // WHEN
@@ -309,8 +216,7 @@ describe("Native adapter class", () => {
     const clipboardMock = new ClipboardAction();
     const keyboardMock = new KeyboardAction();
     const mouseMock = new MouseAction();
-    const screenMock = new ScreenAction();
-    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock, screenMock);
+    const SUT = new NativeAdapter(clipboardMock, keyboardMock, mouseMock);
 
     // WHEN
     SUT.paste();