device_spec.js

/* eslint-disable no-param-reassign */
/* eslint-disable no-unused-vars */
const helper = require('node-red-node-test-helper');
const configNode = require('../../nodes/config.js');
const deviceNode = require('../../nodes/device.js');

describe('Hubitat Device Node', () => {
  const defaultConfigNode = {
    id: 'n0',
    type: 'hubitat config',
    name: 'test config name',
    usetls: false,
    host: 'localhost',
    port: 10234,
    token: '1234-abcd',
    appId: 1,
    nodeRedServer: 'localhost',
    webhookPath: '/hubitat/webhook',
  };
  const defaultDeviceNode = {
    id: 'n1',
    type: 'hubitat device',
    name: 'test device name',
    server: 'n0',
    deviceId: '42',
    attribute: 'testAttribute',
    sendEvent: true,
  };

  afterEach(() => {
    helper.unload();
  });

  it('should be loaded', (done) => {
    const flow = [defaultDeviceNode];
    helper.load(deviceNode, flow, () => {
      const n1 = helper.getNode('n1');
      try {
        n1.should.have.property('name', 'test device name');
        n1.should.have.property('deviceId', '42');
        n1.should.have.property('sendEvent', true);
        n1.should.have.property('attribute', 'testAttribute');
        done();
      } catch (err) {
        done(err);
      }
    });
  });
  it('should send event when event received', (done) => {
    const flow = [
      defaultConfigNode,
      { ...defaultDeviceNode, wires: [['n2']] },
      { id: 'n2', type: 'helper' },
    ];
    const hubitatEvent = {
      deviceId: '42',
      name: 'testAttribute',
      value: 'new-value',
    };
    helper.load([deviceNode, configNode], flow, () => {
      const n1 = helper.getNode('n1');
      const n2 = helper.getNode('n2');
      n1.currentAttributes = { testAttribute: { name: 'testAttribute', value: 'old-value', deviceId: '42' } };
      n2.on('input', (msg) => {
        try {
          msg.should.have.property('payload', { ...hubitatEvent, currentValue: hubitatEvent.value });
          done();
        } catch (err) {
          done(err);
        }
      });
      n1.hubitat.hubitatEvent.emit('device.42', hubitatEvent);
    });
  });
  it('should send event with extra properties when event received', (done) => {
    const flow = [
      defaultConfigNode,
      { ...defaultDeviceNode, wires: [['n2']] },
      { id: 'n2', type: 'helper' },
    ];
    const hubitatEvent = {
      deviceId: '42',
      name: 'testAttribute',
      value: 'new-value',
      dataType: 'overriden attribute',
      extra: 'extra-arg',
    };
    helper.load([deviceNode, configNode], flow, () => {
      const n1 = helper.getNode('n1');
      const n2 = helper.getNode('n2');
      n1.currentAttributes = {
        testAttribute: {
          name: 'testAttribute', value: 'old-value', deviceId: '42', dataType: 'STRING',
        },
      };
      n2.on('input', (msg) => {
        try {
          msg.should.have.property('payload', {
            deviceId: '42',
            name: 'testAttribute',
            value: 'new-value',
            currentValue: 'new-value',
            dataType: 'STRING',
            extra: 'extra-arg',
          });
          done();
        } catch (err) {
          done(err);
        }
      });
      n1.hubitat.hubitatEvent.emit('device.42', hubitatEvent);
    });
  });
  it('should not send event when event received with wrong deviceId', (done) => {
    const flow = [
      defaultConfigNode,
      { ...defaultDeviceNode, wires: [['n2']] },
      { id: 'n2', type: 'helper' },
    ];
    const hubitatEvent = {
      deviceId: '999',
      name: 'testAttribute',
      value: 'new-value',
    };
    helper.load([deviceNode, configNode], flow, () => {
      const n1 = helper.getNode('n1');
      const n2 = helper.getNode('n2');
      n1.currentAttributes = { testAttribute: { name: 'testAttribute', value: 'old-value' } };
      let inError = false;
      n2.on('input', (msg) => {
        inError = true;
      });
      n1.hubitat.hubitatEvent.emit('device.999', hubitatEvent);
      setTimeout(() => {
        if (inError) {
          done(new Error('device receive wrong event'));
        } else {
          try {
            n1.should.have.property('currentAttributes', { testAttribute: { name: 'testAttribute', value: 'old-value' } });
            done();
          } catch (err) {
            done(err);
          }
        }
      }, 20);
    });
  });
  it('should use dot shape icon when send event', (done) => {
    const flow = [{ ...defaultDeviceNode, sendEvent: true }];
    helper.load(deviceNode, flow, () => {
      const n1 = helper.getNode('n1');
      try {
        n1.should.have.property('shape', 'dot');
        done();
      } catch (err) {
        done(err);
      }
    });
  });
  it('should use ring shape icon when send event', (done) => {
    const flow = [{ ...defaultDeviceNode, sendEvent: false }];
    helper.load(deviceNode, flow, () => {
      const n1 = helper.getNode('n1');
      try {
        n1.should.have.property('shape', 'ring');
        done();
      } catch (err) {
        done(err);
      }
    });
  });
  it('should send all atributes when not specified', (done) => {
    const flow = [
      defaultConfigNode,
      { ...defaultDeviceNode, attribute: '', wires: [['n2']] },
      { id: 'n2', type: 'helper' },
    ];
    helper.load([deviceNode, configNode], flow, () => {
      const n1 = helper.getNode('n1');
      const n2 = helper.getNode('n2');
      n1.currentAttributes = { testAttribute: { name: 'testAttribute', value: 'old-value' } };
      n2.on('input', (msg) => {
        try {
          msg.should.have.property('payload', { ...n1.currentAttributes });
          done();
        } catch (err) {
          done(err);
        }
      });
      n1.receive({});
    });
  });
  it('should not link the internal properties to the output message', (done) => {
    const flow = [
      defaultConfigNode,
      { ...defaultDeviceNode, wires: [['n2']] },
      { id: 'n2', type: 'helper' },
    ];
    helper.load([deviceNode, configNode], flow, () => {
      const n1 = helper.getNode('n1');
      const n2 = helper.getNode('n2');
      n1.currentAttributes = { testAttribute: { name: 'testAttribute', value: 'value' } };
      n2.on('input', (msg) => {
        try {
          // eslint-disable-next-line no-param-reassign
          msg.payload.value = 'update value in another node';
          n1.currentAttributes.should.containEql({ testAttribute: { name: 'testAttribute', value: 'value' } });
          done();
        } catch (err) {
          done(err);
        }
      });
      n1.receive({});
    });
  });
  it('should not link the internal properties to the output message when event received', (done) => {
    const flow = [
      defaultConfigNode,
      { ...defaultDeviceNode, wires: [['n2']] },
      { id: 'n2', type: 'helper' },
    ];
    const hubitatEvent = {
      deviceId: '42',
      name: 'testAttribute',
      value: 'new-value',
    };
    helper.load([deviceNode, configNode], flow, () => {
      const n1 = helper.getNode('n1');
      const n2 = helper.getNode('n2');
      n1.currentAttributes = { testAttribute: { value: 'old-value' } };
      n2.on('input', (msg) => {
        try {
          n1.currentAttributes.testAttribute.should.have.property('value', 'new-value');
          msg.payload.value = 'overwrite-value';
          n1.currentAttributes.testAttribute.should.have.property('value', 'new-value');
          done();
        } catch (err) {
          done(err);
        }
      });
      n1.hubitat.hubitatEvent.emit('device.42', hubitatEvent);
    });
  });
  it('should cast event dataType NUMBER to integer', (done) => {
    const flow = [
      defaultConfigNode,
      { ...defaultDeviceNode, wires: [['n2']] },
      { id: 'n2', type: 'helper' },
    ];
    const hubitatEvent = { name: 'testAttribute', value: '-2.5' };
    helper.load([deviceNode, configNode], flow, () => {
      const n1 = helper.getNode('n1');
      const n2 = helper.getNode('n2');
      n1.currentAttributes = { testAttribute: { value: 1, dataType: 'NUMBER' } };
      n2.on('input', (msg) => {
        try {
          msg.payload.should.have.property('value', -2.5);
          done();
        } catch (err) {
          done(err);
        }
      });
      n1.hubitat.hubitatEvent.emit('device.42', hubitatEvent);
    });
  });
  it('should cast event dataType BOOL to boolean', (done) => {
    const flow = [
      defaultConfigNode,
      { ...defaultDeviceNode, wires: [['n2']] },
      { id: 'n2', type: 'helper' },
    ];
    const hubitatEvent = { name: 'testAttribute', value: 'true' };
    helper.load([deviceNode, configNode], flow, () => {
      const n1 = helper.getNode('n1');
      const n2 = helper.getNode('n2');
      n1.currentAttributes = { testAttribute: { value: false, dataType: 'BOOL' } };
      n2.on('input', (msg) => {
        try {
          msg.payload.should.have.property('value', true);
          done();
        } catch (err) {
          done(err);
        }
      });
      n1.hubitat.hubitatEvent.emit('device.42', hubitatEvent);
    });
  });
  it('should cast event dataType VECTOR3 to object', (done) => {
    const flow = [
      defaultConfigNode,
      { ...defaultDeviceNode, wires: [['n2']] },
      { id: 'n2', type: 'helper' },
    ];
    const hubitatEvent = { name: 'testAttribute', value: '[x:2,y:-4,z:1.5]' };
    helper.load([deviceNode, configNode], flow, () => {
      const n1 = helper.getNode('n1');
      const n2 = helper.getNode('n2');
      n1.currentAttributes = { testAttribute: { value: { x: -9, y: 1, z: -2 }, dataType: 'VECTOR3' } };

      n2.on('input', (msg) => {
        try {
          msg.payload.should.have.property('value', { x: 2, y: -4, z: 1.5 });
          done();
        } catch (err) {
          done(err);
        }
      });
      n1.hubitat.hubitatEvent.emit('device.42', hubitatEvent);
    });
  });
  it('should cast event dataType UNDEFINED to string', (done) => {
    const flow = [
      defaultConfigNode,
      { ...defaultDeviceNode, wires: [['n2']] },
      { id: 'n2', type: 'helper' },
    ];
    const hubitatEvent = { name: 'testAttribute', value: 'string' };
    helper.load([deviceNode, configNode], flow, () => {
      const n1 = helper.getNode('n1');
      const n2 = helper.getNode('n2');
      n1.currentAttributes = { testAttribute: { value: 'undefined', dataType: 'UNDEFINED' } };

      n2.on('input', (msg) => {
        try {
          msg.payload.should.have.property('value', 'string');
          done();
        } catch (err) {
          done(err);
        }
      });
      n1.hubitat.hubitatEvent.emit('device.42', hubitatEvent);
    });
  });
});