Initial pass at tests

.gitignore

@@ -1,4 +1,6 @@
 node_modules/
 dist/
+coverage/
 .vscode/
 *.tgz
+.DS_Store

.npmignore

@@ -1,17 +1,5 @@
-boostmovehub.ts
-consts.ts
-duplotrainbase.ts
-hub.ts
-index.ts
-lpf2hub.ts
-port.ts
-poweredup.ts
-puphub.ts
-pupremote.ts
-package-lock.json
-tsconfig.json
-tslint.json
-utils.ts
-wedo2smarthub.ts
+src/
 .vscode/
 examples/
+coverage/
+.DS_Store

jest.config.js

@@ -0,0 +1,20 @@
+module.exports = {
+    preset: "ts-jest",
+    testEnvironment: "node",
+    collectCoverage: true,
+    roots: [
+      "<rootDir>/src"
+    ],
+    transform: {
+        "^.+\\.tsx?$": "ts-jest"
+    },
+    testRegex: "(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$",
+    moduleFileExtensions: [
+        "ts",
+        "tsx",
+        "js",
+        "jsx",
+        "json",
+        "node"
+    ]
+};

package.json

@@ -1,40 +1,44 @@
 {
-  "name": "node-poweredup",
-  "version": "2.1.0",
-  "description": "A Javascript module to interface with LEGO Powered UP components.",
-  "homepage": "https://github.com/nathankellenicki/node-poweredup/",
-  "main": "dist/node/index-node.js",
-  "types": "dist/node/index-node.d.ts",
-  "scripts": {
-    "build:node": "tslint -c tslint.json \"./src/*.ts\" && tsc",
-    "build:browser": "tslint -c tslint.json \"./src/*.ts\" && webpack --mode=production",
-    "build:all": "tslint -c tslint.json \"./src/*.ts\" && tsc && webpack --mode=production",
-    "docs": "jsdoc -d docs -c jsdoc.conf.json -t ./node_modules/ink-docstrap/template -R README.md dist/node/consts.js dist/node/poweredup-node.js dist/node/lpf2hub.js dist/node/wedo2smarthub.js dist/node/boostmovehub.js dist/node/puphub.js dist/node/pupremote.js dist/node/duplotrainbase.js dist/node/hub.js dist/node/consts.js",
-    "all": "npm run build:all && npm run docs",
-    "prepublishOnly": "npm run build:node"
-  },
-  "author": "Nathan Kellenicki <nathan@kellenicki.com>",
-  "license": "MIT",
-  "dependencies": {
-    "debug": "^4.1.1",
-    "noble": "1.9.1",
-    "noble-mac": "git+https://github.com/Timeular/noble-mac.git#af4418e"
-  },
-  "devDependencies": {
-    "@types/debug": "0.0.31",
-    "@types/noble": "0.0.38",
-    "@types/node": "^10.12.21",
-    "@types/web-bluetooth": "0.0.4",
-    "ink-docstrap": "^1.3.2",
-    "jsdoc": "^3.5.5",
-    "jsdoc-to-markdown": "^4.0.1",
-    "ts-loader": "^5.3.3",
-    "tslint": "^5.12.1",
-    "typescript": "^3.3.1",
-    "webpack": "^4.29.2",
-    "webpack-cli": "^3.2.3"
-  },
-  "resolutions": {
-    "xpc-connection": "sandeepmistry/node-xpc-connection#pull/26/head"
-  }
+    "name": "node-poweredup",
+    "version": "2.1.0",
+    "description": "A Javascript module to interface with LEGO Powered UP components.",
+    "homepage": "https://github.com/nathankellenicki/node-poweredup/",
+    "main": "dist/node/index-node.js",
+    "types": "dist/node/index-node.d.ts",
+    "scripts": {
+        "test": "jest",
+        "build:node": "tslint -c tslint.json \"./src/*.ts\" && tsc",
+        "build:browser": "tslint -c tslint.json \"./src/*.ts\" && webpack --mode=production",
+        "build:all": "tslint -c tslint.json \"./src/*.ts\" && tsc && webpack --mode=production",
+        "docs": "jsdoc -d docs -c jsdoc.conf.json -t ./node_modules/ink-docstrap/template -R README.md dist/node/consts.js dist/node/poweredup-node.js dist/node/lpf2hub.js dist/node/wedo2smarthub.js dist/node/boostmovehub.js dist/node/puphub.js dist/node/pupremote.js dist/node/duplotrainbase.js dist/node/hub.js dist/node/consts.js",
+        "all": "npm run test && npm run build:all && npm run docs",
+        "prepublishOnly": "npm run build:node"
+    },
+    "author": "Nathan Kellenicki <nathan@kellenicki.com>",
+    "license": "MIT",
+    "dependencies": {
+        "debug": "^4.1.1",
+        "noble": "1.9.1",
+        "noble-mac": "git+https://github.com/Timeular/noble-mac.git#af4418e"
+    },
+    "devDependencies": {
+        "@types/debug": "0.0.31",
+        "@types/jest": "^24.0.11",
+        "@types/noble": "0.0.38",
+        "@types/node": "^10.12.21",
+        "@types/web-bluetooth": "0.0.4",
+        "ink-docstrap": "^1.3.2",
+        "jest": "^24.7.1",
+        "jsdoc": "^3.5.5",
+        "jsdoc-to-markdown": "^4.0.1",
+        "ts-jest": "^24.0.1",
+        "ts-loader": "^5.3.3",
+        "tslint": "^5.12.1",
+        "typescript": "^3.3.1",
+        "webpack": "^4.29.2",
+        "webpack-cli": "^3.2.3"
+    },
+    "resolutions": {
+        "xpc-connection": "sandeepmistry/node-xpc-connection#pull/26/head"
+    }
 }

src/__tests__/puphub.test.ts

@@ -0,0 +1,64 @@
+import * as Consts from "../consts";
+import { PUPHub } from "../puphub";
+import { TestDevice } from "../testdevice";
+
+const device = new TestDevice()
+const hub = new PUPHub(device);
+
+
+beforeAll((done) => {
+    device.on("discoverComplete", async () => {
+        await hub.connect();
+        device.clearOutbox();
+        done();
+    });
+});
+
+
+afterAll(async (done) => {
+    await hub.disconnect();
+    done();
+});
+
+
+test("Set motor speed", async (done) => {
+    hub.setMotorSpeed("A", 52);
+    expect(await device.readFromOutbox()).toEqual(Buffer.from([0x0a, 0x00, 0x81, 0x00, 0x11, 0x60, 0x00, 0x34, 0x00, 0x00]));
+    done();
+});
+
+
+test("Set motor speed for specific amount of time", async (done) => {
+    hub.setMotorSpeed("A", 52, 3000);
+    expect(await device.readFromOutbox()).toEqual(Buffer.from([0x0a, 0x00, 0x81, 0x00, 0x11, 0x60, 0x00, 0x34, 0x00, 0x00]));
+    expect(await device.readFromOutbox()).toEqual(Buffer.from([0x0a, 0x00, 0x81, 0x00, 0x11, 0x60, 0x00, 0x00, 0x00, 0x00]));
+    done();
+});
+
+
+test("Brake a motor", async (done) => {
+    hub.brakeMotor("A");
+    expect(await device.readFromOutbox()).toEqual(Buffer.from([0x0a, 0x00, 0x81, 0x00, 0x11, 0x60, 0x00, 0x7f, 0x00, 0x00]));
+    done();
+});
+
+
+test("Attempt to set two speeds on a port that only accepts one", async (done) => {
+    expect(() => hub.setMotorSpeed("A", [52, 32])).toThrow("Port A can only accept a single speed");
+    done();
+});
+
+
+test("Set light brightness", async (done) => {
+    hub.setLightBrightness("B", 74);
+    expect(await device.readFromOutbox()).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x01, 0x11, 0x51, 0x00, 0x4a]));
+    done();
+});
+
+
+test("Set light brightness for specific amount of time", async (done) => {
+    hub.setLightBrightness("B", 74, 2000);
+    expect(await device.readFromOutbox()).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x01, 0x11, 0x51, 0x00, 0x4a]));
+    expect(await device.readFromOutbox()).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x01, 0x11, 0x51, 0x00, 0x00]));
+    done();
+});

src/__tests__/pupremote.test.ts

@@ -0,0 +1,45 @@
+import * as Consts from "../consts";
+import { PUPRemote } from "../pupremote";
+import { TestDevice } from "../testdevice";
+
+const device = new TestDevice()
+const remote = new PUPRemote(device);
+
+
+beforeAll((done) => {
+    device.on("discoverComplete", async () => {
+        await remote.connect();
+        device.clearOutbox();
+        done();
+    });
+});
+
+
+afterAll(async (done) => {
+    await remote.disconnect();
+    done();
+});
+
+
+test("Set LED color to BLUE via discrete value", async (done) => {
+    remote.setLEDColor(Consts.Color.BLUE);
+    expect(await device.readFromOutbox()).toEqual(Buffer.from([0x0a, 0x00, 0x41, 0x34, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00]));
+    expect(await device.readFromOutbox()).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x34, 0x11, 0x51, 0x00, 0x03]));
+    done();
+});
+
+
+test("Turn off LED", async (done) => {
+    remote.setLEDColor(false);
+    expect(await device.readFromOutbox()).toEqual(Buffer.from([0x0a, 0x00, 0x41, 0x34, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00]));
+    expect(await device.readFromOutbox()).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x34, 0x11, 0x51, 0x00, 0x00]));
+    done();
+});
+
+
+test("Set LED color to 127, 32, 233 via RGB values", async (done) => {
+    remote.setLEDRGB(127, 32, 233);
+    expect(await device.readFromOutbox()).toEqual(Buffer.from([0x0a, 0x00, 0x41, 0x34, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00]));
+    expect(await device.readFromOutbox()).toEqual(Buffer.from([0x0a, 0x00, 0x81, 0x34, 0x11, 0x51, 0x01, 0x7f, 0x20, 0xe9]));
+    done();
+});

src/testdevice.ts

@@ -0,0 +1,127 @@
+import Debug = require("debug");
+import { EventEmitter } from "events";
+import { IBLEDevice } from "./interfaces";
+const debug = Debug("testdevice");
+
+
+export class TestDevice extends EventEmitter implements IBLEDevice {
+
+    private _uuid: string;
+    private _name: string = "";
+
+    private _listeners: {[uuid: string]: any} = {};
+    private _characteristics: {[uuid: string]: any} = {};
+
+    private _queue: Promise<any> = Promise.resolve();
+    private _mailbox: Buffer[] = [];
+    private _outbox: Buffer[] = [];
+    private _outboxCallback: (() => void) | null = null;
+
+    private _connected: boolean = false;
+    private _connecting: boolean = false;
+
+
+    constructor () {
+        super();
+        this._uuid = "test-device";
+        this._name = "Test Device";
+        setTimeout(() => {
+            this.emit("discoverComplete");
+        }, 2000);
+    }
+
+
+    public get uuid () {
+        return this._uuid;
+    }
+
+
+    public get name () {
+        return this._name;
+    }
+
+
+    public get connecting () {
+        return this._connecting;
+    }
+
+
+    public get connected () {
+        return this._connected;
+    }
+
+
+    public connect () {
+        return new Promise((resolve, reject) => {
+            this._connected = true;
+            return resolve();
+        });
+    }
+
+
+    public disconnect () {
+        return new Promise((resolve, reject) => {
+            return resolve();
+        });
+    }
+
+
+    public discoverCharacteristicsForService (uuid: string) {
+        return new Promise((resolve, reject) => {
+            return resolve();
+        });
+    }
+
+
+    public subscribeToCharacteristic (uuid: string, callback: (data: Buffer) => void) {
+        return;
+    }
+
+
+    public addToCharacteristicMailbox (uuid: string, data: Buffer) {
+        this._mailbox.push(data);
+    }
+
+
+    public readFromCharacteristic (uuid: string, callback: (err: string | null, data: Buffer | null) => void) {
+        callback(null, Buffer.alloc(0));
+    }
+
+
+    public writeToCharacteristic (uuid: string, data: Buffer, callback?: () => void) {
+        this._outbox.push(data);
+        if (this._outboxCallback) {
+            this._outboxCallback();
+            this._outboxCallback = null;
+        }
+        if (callback) {
+            callback();
+        }
+    }
+
+
+    public readFromOutbox () {
+        return new Promise((resolve, reject) => {
+            if (this._outbox.length >= 1) {
+                return resolve(this._outbox.shift());
+            } else {
+                this._outboxCallback = () => {
+                    return resolve(this._outbox.shift());
+                };
+            }
+        });
+    }
+
+
+    public clearOutbox () {
+        this._outbox = [];
+        this._outboxCallback = null;
+    }
+
+
+    private _sanitizeUUID (uuid: string) {
+        return uuid.replace(/-/g, "");
+    }
+
+
+}

tsconfig.json

@@ -1,59 +1,59 @@
 {
-  "compilerOptions": {
-    /* Basic Options */
-    "target": "es2017",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
-    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
-    // "lib": [],                             /* Specify library files to be included in the compilation. */
-    // "allowJs": true,                       /* Allow javascript files to be compiled. */
-    // "checkJs": true,                       /* Report errors in .js files. */
-    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    "declaration": true,                   /* Generates corresponding '.d.ts' file. */
-    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    "sourceMap": true,                     /* Generates corresponding '.map' file. */
-    // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    "outDir": "./dist/node",                        /* Redirect output structure to the directory. */
-    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true,                     /* Enable project compilation */
-    // "removeComments": true,                /* Do not emit comments to output. */
-    // "noEmit": true,                        /* Do not emit outputs. */
-    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+    "compilerOptions": {
+        /* Basic Options */
+        "target": "es2017",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
+        "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+        // "lib": [],                             /* Specify library files to be included in the compilation. */
+        // "allowJs": true,                       /* Allow javascript files to be compiled. */
+        // "checkJs": true,                       /* Report errors in .js files. */
+        // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+        "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+        // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+        "sourceMap": true,                     /* Generates corresponding '.map' file. */
+        // "outFile": "./",                       /* Concatenate and emit output to single file. */
+        "outDir": "./dist/node",                        /* Redirect output structure to the directory. */
+        "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+        // "composite": true,                     /* Enable project compilation */
+        // "removeComments": true,                /* Do not emit comments to output. */
+        // "noEmit": true,                        /* Do not emit outputs. */
+        // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+        // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+        // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
 
-    /* Strict Type-Checking Options */
-    "strict": true,                           /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,              /* Enable strict null checks. */
-    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
-    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+        /* Strict Type-Checking Options */
+        "strict": true,                           /* Enable all strict type-checking options. */
+        // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+        // "strictNullChecks": true,              /* Enable strict null checks. */
+        // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+        // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+        // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+        // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
 
-    /* Additional Checks */
-    // "noUnusedLocals": true,                /* Report errors on unused locals. */
-    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+        /* Additional Checks */
+        // "noUnusedLocals": true,                /* Report errors on unused locals. */
+        // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+        // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+        // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
 
-    /* Module Resolution Options */
-    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                       /* List of folders to include type definitions from. */
-    // "types": [],                           /* Type declaration files to be included in compilation. */
-    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+        /* Module Resolution Options */
+        // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+        // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+        // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+        // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+        // "typeRoots": [],                       /* List of folders to include type definitions from. */
+        // "types": [],                           /* Type declaration files to be included in compilation. */
+        // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+        "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+        // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
 
-    /* Source Map Options */
-    // "sourceRoot": "./",                    /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "./",                       /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+        /* Source Map Options */
+        // "sourceRoot": "./",                    /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+        // "mapRoot": "./",                       /* Specify the location where debugger should locate map files instead of generated locations. */
+        // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+        // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
 
-    /* Experimental Options */
-    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
-  }
+        /* Experimental Options */
+        // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+        // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+    }
 }