Update of all modules with better tests

.eslintrc

@@ -4,7 +4,7 @@
     "es6": true
   },
   "parserOptions": {
-    "ecmaVersion": 6,
+    "ecmaVersion": 2018,
     "sourceType": "module"
   },
   "rules": {

.github/workflows/build.yml

@@ -27,5 +27,8 @@ jobs:
       - name: Install deps
         run: npm install
 
+      - name: Lint code
+        run: make lint
+
       - name: Run tests
-        run: npm run test
+        run: make tests

.github/workflows/coverage.yml

@@ -0,0 +1,34 @@
+name: Coverage
+on: [pull_request]
+
+jobs:
+  test:
+    name: Build, test, coverage
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+
+      - name: Setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: 10
+
+      - name: Cache node modules
+        uses: actions/cache@v1
+        with:
+          path: node_modules
+          key: build-10-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: build-10-${{ hashFiles('**/package-lock.json') }}
+
+      - name: Install deps
+        run: npm install
+
+      - name: Run tests with coverage
+        run: make test-coverage
+
+      - name: Coverage
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.github_token }}
+

Changelog.md → CHANGELOG.md

@@ -1,4 +1,48 @@
-# Interchange Changelog
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## [2.0.0](https://github.com/ajfisher/nodebots-interchange/compare/v1.2.1...v2.0.0) (2019-12-30)
+
+
+### ⚠ BREAKING CHANGES
+
+* Getting downloader functionality working for github end to end
+* Refactored the download from npm functionality tobe more async and testable
+
+### Features
+
+* added a new test firmware for gh master branch usage ([369a661](https://github.com/ajfisher/nodebots-interchange/commit/369a6613d46f212a20df6e5551dd3d4f7b1d17ae))
+* Added make command to set arduino back to blink ([5dcd1c6](https://github.com/ajfisher/nodebots-interchange/commit/5dcd1c656e85f212a512784caf35b9acc3bc3c20))
+* adding further tests for the interchange code ([e700b35](https://github.com/ajfisher/nodebots-interchange/commit/e700b357eb936ad430af299ce7f78121f6d51999))
+* beginning refactoring of downloader with tests ([901e198](https://github.com/ajfisher/nodebots-interchange/commit/901e198febe057f330a03cc8a397dfa48d36e1cd))
+* new tests added for github downloads and refactoring to suit ([b365b6c](https://github.com/ajfisher/nodebots-interchange/commit/b365b6cec9802d305360cb8b6cd2be86b19dd8ff))
+* refactor out firmware requirement of manifest interpretation and tests to suit ([7d21b95](https://github.com/ajfisher/nodebots-interchange/commit/7d21b9515062df53f02aa6e3f1e9508a8e79b8f6))
+* **test:** Added jest test spec for firmwares ([3dc708e](https://github.com/ajfisher/nodebots-interchange/commit/3dc708e4e4676d2772efbb52ad87109c812cd9a6))
+* **tests:** Added testing structure ([72f5839](https://github.com/ajfisher/nodebots-interchange/commit/72f5839b101e38aefac482ae3cc4fadd1b9c34a8))
+* **tests:** Remove travis for build process ([b4563ee](https://github.com/ajfisher/nodebots-interchange/commit/b4563ee439f155dc757bce087d1843201614d7e7))
+* **tests:** Removed old nodeunit tests ([dae49be](https://github.com/ajfisher/nodebots-interchange/commit/dae49beedcb33cfb068627c7ae474491b114b0d2))
+
+
+### Bug Fixes
+
+* made a test mode variable ([3912786](https://github.com/ajfisher/nodebots-interchange/commit/3912786113139dc5d0fd4a888c546f90313a87a0))
+* Made property on ic client to determine if sp is open and tests to support ([6b0d282](https://github.com/ajfisher/nodebots-interchange/commit/6b0d2821cf317432a76dd8a85d9fb96f98050993))
+* refactor ports command to use promises ([fb14978](https://github.com/ajfisher/nodebots-interchange/commit/fb14978d5c8a84423729b20a9afb61deecfba422))
+* Refactor the firmware listing in cli to be testable and write tests ([a0c23ce](https://github.com/ajfisher/nodebots-interchange/commit/a0c23ceb2a59c4a8d02c4b06b4a7fe49ca7f5c64))
+* refactor to return hexpath in object from npm install ([cfd94ea](https://github.com/ajfisher/nodebots-interchange/commit/cfd94ea9fe446c7b62da3fc989fe2dc771e39229))
+* Refactored the interchange client to be more testable and moved command line formatting to the cli tool ([94a7fc2](https://github.com/ajfisher/nodebots-interchange/commit/94a7fc27fdd56b687c079c8781d37d12641169a3))
+* starting to refactor the interchange lib to use promises and refactor callbacks into await flow ([5cfa2e5](https://github.com/ajfisher/nodebots-interchange/commit/5cfa2e5b04e9adc3899d6ea85087d79141af7702))
+* Tests failed and not picked up in previous commit ([3d23113](https://github.com/ajfisher/nodebots-interchange/commit/3d23113a94b5274477d63ed18a8db1580c1c2895))
+* **tests:** Added tests for temp directory removal ([00712ba](https://github.com/ajfisher/nodebots-interchange/commit/00712ba5e37f63bcf4edb04dd56ccd4f8df42790))
+* update tests and cli to use new refactored ports ([99ad915](https://github.com/ajfisher/nodebots-interchange/commit/99ad9150589858e9958a96fa3d0d9b6abda9ab8e))
+* workflow bugs ([1226fbb](https://github.com/ajfisher/nodebots-interchange/commit/1226fbb9803ba765db0c458c50884f4b26a9942d))
+* workflow issues with coverage generation ([56a68f2](https://github.com/ajfisher/nodebots-interchange/commit/56a68f223c762dc8041aa265fa338114b3bab2dd))
+* **package:** update serialport to version 7.0.1 ([3de8982](https://github.com/ajfisher/nodebots-interchange/commit/3de898294dbf0b72eb33bba53ba7f19ab8b98752))
+
+
+* Getting downloader functionality working for github end to end ([39459bb](https://github.com/ajfisher/nodebots-interchange/commit/39459bb820e1fe8d7e18cd0da89cccc05089ed9f))
+* Refactored the download from npm functionality tobe more async and testable ([4664bcd](https://github.com/ajfisher/nodebots-interchange/commit/4664bcd46c50ed5035808833d8f2eceb21efda92))
 
 ## 1.5.0
 

Makefile

@@ -0,0 +1,27 @@
+help:
+	@echo "blink [board=nano|uno]	Flashes blink to the board."
+	@echo "clean					Clean up any build files etc"
+	@echo "install					Install the appropriate packages etc"
+	@echo "lint						Lint the code"
+	@echo "tests					Run the tests"
+	@echo "test-coverage			Run the tests and build coverage data"
+
+blink:
+	@echo "Wiping board back to blink state"
+	@avrgirl-arduino flash -f node_modules/avrgirl-arduino/junk/hex/$(BOARD)/Blink.cpp.hex -a $(BOARD)
+	@echo "Completed"
+
+clean:
+	rm -rf ./node_modules
+
+install: clean
+	npm install
+
+lint:
+	npm run lint
+
+tests:
+	npm run test
+
+test-coverage:
+	npm run coverage

bin/cli.js

@@ -1,9 +1,11 @@
 #! /usr/bin/env node
 
+const _ = require('lodash');
 const program = require('commander');
 const version = require('../package.json').version;
 const Interchange = require('../lib/interchange');
 const Inquire = require('../lib/inquire');
+
 const interchange = new Interchange();
 
 program
@@ -12,19 +14,53 @@ program
 program.command('list')
   .description('Lists all of the available firmwares')
   .alias('l')
-  .action(interchange.list_devices.bind(interchange));
+  .action(() => {
+    const list = interchange.list_devices();
+    let outstr = '\nFirmwares available for backpacks. (f) denotes a firmata version is available\n\n';
+    list.forEach((fw) => {
+      outstr += ` ${fw.name} ${fw.firmata ? '(f)' : ''}: ${fw.description}\n`;
+    });
+    console.info(outstr);
+  });
 
 program.command('ports')
   .description('Lists all of the attached boards and their ports')
   .alias('p')
   .option('-v, --verbose', 'List with additional information')
-  .action(interchange.list_ports.bind(interchange));
+  .action((opts) => {
+    // get the ports and then list them out.
+    interchange.get_ports()
+      .then((ports) => {
+        if (opts.verbose) {
+          console.info(ports);
+        } else {
+          ports.forEach((port) => {
+            console.info(port.path.cyan);
+          });
+        }
+      })
+      .catch(err => console.log(err));
+  });
 
 program.command('read')
   .description('Read firmware info from port')
   .alias('r')
-  .option('-p, --port', 'Serial port board is attached to')
-  .action(interchange.get_firmware_info.bind(interchange));
+  .option('-p, --port <port>', 'Serial port board is attached to')
+  .action((opts) => {
+    interchange.get_firmware_info(opts.port).then(fw => {
+      // print out all of the info regarding firmware
+      console.info((fw.name + ' backpack firmware').bold);
+      console.info('Version %s Built %s', fw.firmware_version, fw.compile_date);
+      console.info('Creator ID: %s (%s @%s)', fw.creatorID, fw.creator.name, fw.creator.gh);
+      console.info('Device ID: %s (%s)', fw.firmwareID, fw.name);
+      console.info('I2C Address: 0x%s (%s)', fw.i2c_address.toString(16),
+        fw.use_custom_addr ? 'Using custom' : 'Using default');
+      console.info(fw.description);
+    }).catch(err => {
+      console.log(err.message.toString().red);
+      process.exit(1);
+    });
+  });
 
 program.command('install [firmware]')
   .description('Install specified firmware to board')
@@ -35,10 +71,16 @@ program.command('install [firmware]')
   .option('-i, --address <address>', 'Specify I2C address, eg 0x67')
   .option('--interactive', 'Interactive mode will prompt for input')
   .action(function(firmware, opts) {
+    const {board, port, firmata, address} = opts;
+    const options = {board, port, firmata, address};
+
     if (opts.interactive) {
-      const inquire = new Inquire(interchange.install_firmware.bind(interchange));
+      // Wait for the inquirer to initialise then call the prompt
+      new Inquire(interchange.install_firmware.bind(interchange))
+        .then((inquire) => inquire.prompt())
+        .catch(err => { throw err });
     } else {
-      interchange.install_firmware(firmware, opts);
+      interchange.install_firmware(firmware, options);
     }
   });