@dawee/avrgirl-arduino/tests/avrgirl-arduino.spec.js

A NodeJS library for flashing compiled sketch files to Arduino microcontroller boards.

var test = require('tape');
var proxyquire = require('proxyquire');

var sinon = require('sinon');

// proxyquired connection module
// var Connection = proxyquire.noCallThru().load('../lib/connection', {SerialPort: mockSerial});
var Connection = proxyquire.noCallThru().load('../lib/connection', { serialport: {
  list: function(callback) {
    callback(null, [
      { comName: '/dev/cu.sierravsp', manufacturer: '', serialNumber: '',
        pnpId: '', locationId: '', vendorId: '', productId: '' },
      { comName: '/dev/cu.Bluetooth-Incoming-Port', manufacturer: '',
        serialNumber: '', pnpId: '', locationId: '', vendorId: '',
        productId: '' },
      { comName: '/dev/cu.usbmodem1421', manufacturer: 'Arduino (www.arduino.cc)',
        serialNumber: '55432333038351F03170', pnpId: '', locationId: '0x14200000',
        vendorId: '0x2341', productId: '0x0043' }
    ]);
  },

  SerialPort: require('./helpers/mockSerial').SerialPort
} });

// module to test
var Avrgirl = proxyquire('../avrgirl-arduino', { Connection: Connection });

// default options
var DEF_OPTS2 = {
  board: 'uno'
};

test('[ AVRGIRL-ARDUINO ] method presence', function(t) {
  var a = new Avrgirl(DEF_OPTS2);
  function isFn(name) {
    return typeof a[name] === 'function';
  }

  var methods = [
    'flash',
    '_validateBoard',
    'listPorts',
  ];
  for (var i = 0; i < methods.length; i += 1) {
    t.ok(isFn(methods[i]), methods[i]);
    if (i === (methods.length - 1)) {
      t.end();
    }
  }
});

test('[ AVRGIRL-ARDUINO ] new creation', function(t) {
  t.plan(3);

  var a = new Avrgirl(DEF_OPTS2);
  t.ok(a.connection, 'connection was established');
  t.ok(a.options.board.baud, 'board was established');
  t.ok(a.protocol.chip, 'protocol was established');
});

test('[ AVRGIRL-ARDUINO ] ::_validateBoard (GOOD)', function(t) {
  t.plan(1);

  var a = new Avrgirl(DEF_OPTS2);
  a._validateBoard(function(error) {
    t.error(error, 'no error');
  });
});

test('[ AVRGIRL-ARDUINO ] ::_validateBoard (NO BOARD)', function(t) {
  t.plan(1);

  var a = new Avrgirl({ board: 'bacon' });
  a._validateBoard(function(error) {
    t.ok(error, 'error returned');
  });
});

test('[ AVRGIRL-ARDUINO ] ::_validateBoard (NO PROTOCOL)', function(t) {
  t.plan(1);

  var a = new Avrgirl(DEF_OPTS2);
  a.protocol = 'bacon';
  a._validateBoard(function(error) {
    t.ok(error, 'error returned');
  });
});

test('[ AVRGIRL-ARDUINO ] ::_validateBoard (NO PORT & PRO-MINI)', function(t) {
  t.plan(1);

  var a = new Avrgirl({ board: 'pro-mini' });
  a._validateBoard(function(error) {
    t.ok(error, 'error returned');
  });
});

test('[ AVRGIRL-ARDUINO ] ::listPorts', function(t) {
  t.plan(3);
  Avrgirl.listPorts(function(error, ports) {
    t.ok(ports.length, 'got a list of ports');
    t.ok(ports[2]._standardPid, 'added _standardPid property');
    t.error(error, 'no error on listing');
  });
});

test('[ AVRGIRL-ARDUINO ] ::listPorts (prototype)', function(t) {
  t.plan(3);
  var a = new Avrgirl(DEF_OPTS2);
  a.listPorts(function(error, ports) {
    t.ok(ports.length, 'got a list of ports');
    t.ok(ports[2]._standardPid, 'added _standardPid property');
    t.error(error, 'no error on listing');
  });
});

  test('[ AVRGIRL-ARDUINO ] ::flash (shallow)', function(t) {
    t.plan(4);
    var a = new Avrgirl(DEF_OPTS2);
    var spyInit = sinon.stub(a.connection, '_init').callsFake(function(callback) {return callback(null);});

    var spyUpload = sinon.stub(a.protocol, '_upload').callsFake(function(file, callback) {
      return callback(null);
    });

    var spyValidate = sinon.spy(a, '_validateBoard');

    a.flash(__dirname + '/../junk/hex/uno/Blink.cpp.hex', function(error) {
    t.ok(spyValidate.calledOnce, 'validated board');
    t.ok(spyInit.calledOnce, 'connection init');
    t.ok(spyUpload.calledOnce, 'upload to board attempt');
    t.error(error, 'no error');
  });
});