Merge branch 'tests' into shiftKey

Author: DCzajkowski

docs/manual-build.md

@@ -28,3 +28,11 @@ For build requirements for your OS look below.
 ## Windows
 - Install: msys2 with autotools, pkg-config, libtool, gcc, clang, glib, C++ Build Tools, cmake
 - `npm run build`
+
+# Testing
+
+iohook uses Jest for automated testing. To execute tests, run `npm run test` in your console.
+
+::: warning
+It is important you don't press any buttons on your keyboard, don't use your mouse nor the scroll wheel. Tests depend on native events fired by the real keyboard and mouse. Interrupting them will cause tests to fail.
+:::

test/specs/keyboard.spec.js

@@ -2,24 +2,46 @@ const ioHook = require('../../index');
 const robot = require('robotjs');
 
 describe('Keyboard events', () => {
-    it('receives the text "Hello World"', (done) => {
-        let currentKey = 0;
+  afterEach(() => {
+    ioHook.stop();
+  });
 
-        const actualCharacters = [];
-        const expectedCharacters = ['H', 'e', 'l', 'l', 'o', ' ', 'W', 'o', 'r', 'l', 'd'];
+  it('receives the text "hello world" on keyup event', (done) => {
+    expect.assertions(44);
 
-        ioHook.on('keydown', (event) => {
-            actualCharacters.push(String.fromCharCode(event.keychar));
+    const chars = [
+      { keycode: 35, value: 'h' },
+      { keycode: 18, value: 'e' },
+      { keycode: 38, value: 'l' },
+      { keycode: 38, value: 'l' },
+      { keycode: 24, value: 'o' },
+      { keycode: 57, value: ' ' },
+      { keycode: 17, value: 'w' },
+      { keycode: 24, value: 'o' },
+      { keycode: 19, value: 'r' },
+      { keycode: 38, value: 'l' },
+      { keycode: 32, value: 'd' }
+    ];
+    let i = 0;
 
-            if (currentKey === expectedCharacters.length) {
-                expect(actualCharacters).toEqual(expectedCharacters);
-            }
+    ioHook.on('keydown', (event) => {
+      expect(event.keycode).toEqual(chars[i].keycode);
+      expect(event.type).toEqual('keydown');
+    });
+    ioHook.on('keyup', (event) => {
+      expect(event.keycode).toEqual(chars[i].keycode);
+      expect(event.type).toEqual('keyup');
 
-            currentKey += 1;
-            done();
-        });
-        ioHook.start();
+      if (i === chars.length - 1) {
+        done();
+      }
 
-        robot.typeString('Hello World');
+      i += 1;
     });
+    ioHook.start();
+
+    for (const char of chars) {
+      robot.keyTap(char.value);
+    }
+  });
 });