cylon/spec/lib/robot.spec.js

"use strict";

var Driver = source('driver'),
    Adaptor = source('adaptor'),
    Robot = source("robot"),
    Utils = source('utils');

describe("Robot", function() {
  var work, extraFunction, robot;

  beforeEach(function() {
    work = spy();
    extraFunction = spy();

    robot = new Robot({
      name: "Robby",
      work: work,

      extraFunction: extraFunction,
      extraValue: "Hello World",

      master: { master: true }
    });
  });

  describe("constructor", function() {
    describe("name", function() {
      context("if provided", function() {
        it("is set to the passed value", function() {
          expect(robot.name).to.be.eql("Robby")
        });
      });

      context("if not provided", function() {
        beforeEach(function() {
          stub(Robot, 'randomName').returns("New Robot");
        });

        afterEach(function() {
          Robot.randomName.restore();
        });

        it("is set to a random name", function() {
          var bot = new Robot({});
          expect(bot.name).to.be.eql("New Robot");
        });
      });
    });

    it("sets @master to the passed Master object", function() {
      expect(robot.master).to.be.eql({ master: true });
    });

    it("sets @connections to an empty object by default", function() {
      expect(robot.connections).to.be.eql({});
    });

    it("sets @devices to an empty object by default", function() {
      expect(robot.devices).to.be.eql({});
    });

    it("sets @work to the passed work function", function() {
      expect(robot.work).to.be.eql(work);
    });

    it("sets other obj params as values on the robot", function() {
      expect(robot.extraFunction).to.be.eql(extraFunction);
      expect(robot.extraValue).to.be.eql("Hello World");
    });

    context("if there are devices but no connections", function() {
      it('throws an error', function() {
        var fn = function() {
          return new Robot({
            name: 'BrokenBot',
            device: { name: 'ping', driver: 'ping' }
          });
        };

        expect(fn).to.throw(Error, "No connections specified");
      });
    });

    context("if no commands are provided", function() {
      var robot;

      beforeEach(function() {
        robot = new Robot({
          name: 'NewBot',
          otherThings: { more: 'details' },
          sayHello: function() { return "Hello!" }
        });
      });

      it("sets #commands to the additionally provided functions", function() {
        expect(robot.commands).to.be.eql({ sayHello: robot.sayHello });
      });
    });

    context("if a commands function is provided", function() {
      var robot;

      beforeEach(function() {
        robot = new Robot({
          name: 'NewBot',

          sayHello: function() { return this.name + " says hello" },

          commands: function() {
            return {
              say_hello: this.sayHello
            }
          }
        });
      });

      it("sets #commands to the returned object", function() {
        expect(robot.commands.say_hello).to.be.eql(robot.sayHello);
      });

      context("if the function doesn't return an object", function() {
        var fn;
        beforeEach(function() {
          fn = function() {
            new Robot({
              name: 'NewBot',

              commands: function() {
                return [];
              }
            });
          }
        });

        it("throws an error", function() {
          expect(fn).to.throw(Error, "#commands function must return an object");
        });
      })
    });

    context("if a commands object is provided", function() {
      var robot;

      beforeEach(function() {
        robot = new Robot({
          name: 'NewBot',

          sayHello: function() { return this.name + " says hello" },

          commands: {
           say_hello: function() {}
          }
        });
      });

      it("sets #commands to the provided object", function() {
        expect(robot.commands.say_hello).to.be.a('function');
      });
    });

    context("arbitrary arguments", function() {
      beforeEach(function() {
        robot = new Robot({
          name: 'NewBot',

          hiThere: 'hi there',

          sayHi: function() {
            return 'hi';
          },

          start: "start"
        })
      });

      it("passes them through if they don't conflict with built-ins", function() {
        expect(robot.hiThere).to.be.eql("hi there");
        expect(robot.sayHi()).to.be.eql("hi");
      });

      it("doesn't work if they conflict with built-in properties", function() {
        expect(robot.start).to.be.a('function');
      });
    });
  });

  describe("all work and no play", function() {
    var play = spy();

    var playBot = new Robot({
      play: play
    });

    it('makes Jack a dull boy', function() {
      expect(playBot.work).to.be.eql(play);
    })
  });

  describe("#toJSON", function() {
    var bot = new Robot({
      connection: { name: 'loopback', adaptor: 'loopback' },
      device: { name: 'ping', driver: 'ping' }
    });

    var json = bot.toJSON();

    it("returns an object", function() {
      expect(json).to.be.a('object');
    });

    it("contains the robot's name", function() {
      expect(json.name).to.eql(bot.name);
    });

    it("contains the robot's commands", function() {
      expect(json.commands).to.eql(Object.keys(bot.commands));
    });

    it("contains the robot's devices", function() {
      expect(json.devices).to.eql([bot.devices.ping.toJSON()]);
    });

    it("contains the robot's connections", function() {
      expect(json.connections).to.eql([bot.connections.loopback.toJSON()]);
    });
  });

  describe("#connection", function() {
    var opts, bot;

    beforeEach(function() {
      bot = new Robot();
      opts = { adaptor: 'loopback' };
    });

    it("creates and adds a new Connection", function() {
      expect(bot.connections.loopback).to.be.eql(undefined);
      bot.connection('loopback', opts);
      expect(bot.connections.loopback).to.be.an.instanceOf(Adaptor);
    })

    it("sets @robot on the Connection to be the Robot initializing it", function() {
      bot.connection('loopback', opts);
      expect(bot.connections.loopback.robot).to.be.eql(bot);
    })

    it("avoids name collisions", function() {
      bot.connection('loopback', opts);
      bot.connection('loopback', opts);
      expect(Object.keys(bot.connections)).to.be.eql(['loopback', 'loopback-1']);
    });
  });

  describe("initConnections", function() {
    var bot;

    beforeEach(function() {
      bot = new Robot();
    });

    context("when not passed anything", function() {
      it("does not modify the bot's connections", function() {
        bot.initConnections({});
        expect(bot.connections).to.be.eql({});
      });
    });

    context("when passed a connection object", function() {
      it("instantiates a new connection with the provided object", function() {
        var connection = { name: 'loopback', adaptor: 'loopback' };
        bot.initConnections({ connection: connection });
        expect(bot.connections['loopback']).to.be.instanceOf(Adaptor);
      });
    });

    context("when passed an array of connection objects", function() {
      it("instantiates a new connection with each of the provided objects", function() {
        var connections = [{ name: 'loopback', adaptor: 'loopback' }]
        bot.initConnections({ connections: connections });
        expect(bot.connections['loopback']).to.be.instanceOf(Adaptor);
      });

      it("avoids name collisions", function() {
        var opts = {
          connections: [
            { name: 'loopback', adaptor: 'loopback' },
            { name: 'loopback', adaptor: 'loopback' }
          ]
        };

        bot.initConnections(opts);

        var keys = Object.keys(bot.connections);
        expect(keys).to.be.eql(["loopback", "loopback-1"]);
      });
    });
  });

  describe("#device", function() {
    var opts, bot;

    beforeEach(function() {
      bot = new Robot();
      opts = { driver: 'ping' };
    });

    it("creates and adds a new Device", function() {
      expect(bot.devices.ping).to.be.eql(undefined);
      bot.device('ping', opts);
      expect(bot.devices.ping).to.be.an.instanceOf(Driver);
    })

    it("sets @robot on the Device to be the Robot initializing it", function() {
      bot.device('ping', opts);
      expect(bot.devices.ping.robot).to.be.eql(bot);
    })

    it("avoids name collisions", function() {
      bot.device('ping', opts);
      bot.device('ping', opts);
      expect(Object.keys(bot.devices)).to.be.eql(['ping', 'ping-1']);
    });
  });

  describe("initDevices", function() {
    var bot;

    beforeEach(function() {
      bot = new Robot({
        connection: { name: 'loopback', adaptor: 'loopback' }
      });
    });

    context("when not passed anything", function() {
      it("does not modify the bot's devices", function() {
        bot.initDevices({});
        expect(bot.devices).to.be.eql({});
      });
    });

    context("when passed a device object", function() {
      it("instantiates a new driver with the provided object", function() {
        var device = { name: 'ping', driver: 'ping' };
        bot.initDevices({ device: device });
        expect(bot.devices['ping']).to.be.instanceOf(Driver);
      });
    });

    context("when passed an array of device objects", function() {
      it("instantiates a new driver with each of the provided objects", function() {
        var devices = [{ name: 'ping', driver: 'ping' }]
        bot.initDevices({ devices: devices});

        expect(bot.devices['ping']).to.be.instanceOf(Driver);
      });

      it("avoids name collisions collisions", function() {
        bot.initDevices({
          devices: [
            { name: 'ping', driver: 'ping' },
            { name: 'ping', driver: 'ping' }
          ]
        });

        var keys = Object.keys(bot.devices);
        expect(keys).to.be.eql(["ping", "ping-1"]);
      });
    });
  });

  describe("#start", function() {
    beforeEach(function() {
      stub(robot, 'startConnections').callsArg(0);
      stub(robot, 'startDevices').callsArg(0);
      stub(robot, 'emit').returns(null);

      robot.start();
    });

    afterEach(function() {
      robot.startConnections.restore();
      robot.startDevices.restore();
      robot.emit.restore();
    });

    it("starts the robot's connections", function() {
      expect(robot.startConnections).to.be.called;
    });

    it("starts the robot's devices", function() {
      expect(robot.startDevices).to.be.called;
    });

    it("starts the robot's work", function() {
      expect(robot.work).to.be.called;
    });

    it("emits the 'ready' event", function() {
      expect(robot.emit).to.be.calledWith("ready", robot)
    });

    it("returns the robot", function() {
      expect(robot.start()).to.be.eql(robot);
    });
  });

  describe("#startConnections", function() {
    var bot;

    beforeEach(function() {
      bot = new Robot({
        connections: {
          alpha: { adaptor: 'loopback' },
          bravo: { adaptor: 'loopback' }
        }
      });

      stub(bot.connections.alpha, 'connect').returns(true);
      stub(bot.connections.bravo, 'connect').returns(true);
    });

    it("runs #connect on each connection", function() {
      bot.startConnections();

      expect(bot.connections.alpha.connect).to.be.called;
      expect(bot.connections.bravo.connect).to.be.called;
    });
  });

  describe("#startDevices", function() {
    var bot;

    beforeEach(function() {
      bot = new Robot({
        connection: { name: 'loopback', adaptor: 'loopback' },
        devices: {
          alpha: { driver: 'ping' },
          bravo: { driver: 'ping' }
        }
      });

      stub(bot.devices.alpha, 'start').returns(true);
      stub(bot.devices.bravo, 'start').returns(true);
    });

    it("runs #start on each device", function() {
      bot.startDevices();

      expect(bot.devices.alpha.start).to.be.called;
      expect(bot.devices.bravo.start).to.be.called;
    });
  });

  describe("#halt", function() {
    var bot, device, connection;

    beforeEach(function() {
      bot = new Robot({
        device: { name: 'ping', driver: 'ping' },
        connection: { name: 'loopback', adaptor: 'loopback' }
      });

      device = bot.devices.ping;
      connection = bot.connections.loopback;

      stub(device, 'halt').yields(true);
      stub(connection, 'disconnect').yields(true);
    });

    afterEach(function() {
      device.halt.restore();
      connection.disconnect.restore();
    });

    it("calls #halt on all devices and connections", function() {
      bot.halt();

      expect(device.halt).to.be.called;
      expect(connection.disconnect).to.be.called;
    });
  });

  describe("#toString", function() {
    it("returns basic information about the robot", function() {
      expect(robot.toString()).to.be.eql("[Robot name='Robby']");
    });
  });
});