@machinemetrics/io-adapter-lib 2.32.0

package/test/config/mtconnectAdapter.test.js

@@ -0,0 +1,124 @@
+'use strict';
+
+const _ = require('lodash');
+const expect = require('chai').expect;
+const ConfigError = require('../../lib/config/configError');
+const testUtils = require('../util/testUtils');
+
+describe('MTConnect Adapter config tests', function () {
+  let config;
+  let complexConfig;
+  let defaultConfig;
+
+  before(async () => {
+    defaultConfig = await testUtils.loadConfig('device/mtconnect-adapter-default.yml');
+    config = await testUtils.loadConfig('device/mtconnect-adapter-keys.yaml');
+    complexConfig = await testUtils.loadConfig('device/mtconnect-complex-keys.yaml');
+  });
+
+  it('loads minimal config with defaults', async function () {
+    expect(defaultConfig.device.host).to.eq('machine.local');
+    expect(defaultConfig.device.port).to.eq(7878);
+    expect(defaultConfig.device.mtconnectPassthrough).to.eq(true);
+    expect(defaultConfig.device.allowKeyPatterns).to.deep.eq([]);
+    expect(defaultConfig.device.denyKeyPatterns).to.deep.eq([]);
+    expect(defaultConfig.device.keys).to.deep.eq([]);
+    expect(defaultConfig.device.sourceKeys).to.deep.eq([]);
+  });
+
+  it('reads declare-keys', async function () {
+    expect(_.keys(config.device.keys)).to.deep.eq(['key1', 'key12']);
+  });
+
+  it('handles allow-keys patterns', async function () {
+    testPatternSet(config.device.allowKeyPatterns);
+  });
+
+  it('handles deny-keys patterns', async function () {
+    testPatternSet(config.device.denyKeyPatterns);
+  });
+
+  it('loaded expression service', async function () {
+    expect(config.expressionService.definedNames()).to.deep.eq(['key1', 'key12', 'device-connected']);
+    expect(config.expressionService.definedNames('device')).to.deep.eq(['key1', 'key12']);
+
+    expect(complexConfig.expressionService.definedNames()).to.deep.eq(['key1', 'alias2', 'alias3', 'alias4', 'alias5', 'key6', 'aliasdup', 'device-connected']);
+  });
+
+  it('calculates source keys', async function () {
+    expect(_.keys(complexConfig.device.keys)).to.deep.eq(['key1', 'alias2', 'alias3', 'alias4', 'alias5', 'key6', 'aliasdup']);
+    expect(complexConfig.device.sourceKeys).to.deep.eq(['key1', 'key2', 'key3', 'key4', 'key5', 'key6']);
+  });
+
+  it('creates aliases', async function () {
+    expect(_.keys(complexConfig.device.aliasMap)).to.deep.eq(['key1', 'key2', 'key3', 'key4', 'key5', 'key6']);
+
+    expect(complexConfig.device.aliasMap.key1).to.deep.eq([]);
+    expect(complexConfig.device.aliasMap.key2).to.deep.eq(['alias2']);
+    expect(complexConfig.device.aliasMap.key3).to.deep.eq(['alias3', 'aliasdup']);
+    expect(complexConfig.device.aliasMap.key4).to.deep.eq(['alias4']);
+    expect(complexConfig.device.aliasMap.key5).to.deep.eq(['alias5']);
+    expect(complexConfig.device.aliasMap.key6).to.deep.eq([]);
+  });
+
+  it('sets key types', async function () {
+    expect(complexConfig.device.keys.key1.type).to.eq('value');
+    expect(complexConfig.device.keys.alias2.type).to.eq('value');
+    expect(complexConfig.device.keys.alias3.type).to.eq('value');
+    expect(complexConfig.device.keys.alias4.type).to.eq('value');
+    expect(complexConfig.device.keys.alias5.type).to.eq('condition');
+    expect(complexConfig.device.keys.key6.type).to.eq('condition');
+  });
+
+  it('throws error for duplicate declare-keys', async function () {
+    try {
+      await testUtils.loadConfig('device/mtconnect-duplicate-declare-keys.yaml');
+      expect.fail('Configuration with duplicate declare-keys should have thrown an error');
+    } catch (err) {
+      expect(err).to.be.instanceof(ConfigError);
+      expect(err.attribute).to.eq('declare-keys');
+      expect(err.message).to.include('duplicate key names found: key1');
+    }
+  });
+
+  it('throws error for duplicate allow-keys', async function () {
+    try {
+      await testUtils.loadConfig('device/mtconnect-duplicate-allow-keys.yaml');
+      expect.fail('Configuration with duplicate allow-keys should have thrown an error');
+    } catch (err) {
+      expect(err).to.be.instanceof(ConfigError);
+      expect(err.attribute).to.eq('allow-keys');
+      expect(err.message).to.include('duplicate entries found: system');
+    }
+  });
+
+  it('throws error for duplicate deny-keys', async function () {
+    try {
+      await testUtils.loadConfig('device/mtconnect-duplicate-deny-keys.yaml');
+      expect.fail('Configuration with duplicate deny-keys should have thrown an error');
+    } catch (err) {
+      expect(err).to.be.instanceof(ConfigError);
+      expect(err.attribute).to.eq('deny-keys');
+      expect(err.message).to.include('duplicate entries found: system');
+    }
+  });
+});
+
+function testPatternSet(set) {
+  expect(set.length).to.eq(5);
+  expect(set[0].test('system')).to.eq(true);
+  expect(set[0].test('system1')).to.eq(false);
+  expect(set[1].test('block')).to.eq(true);
+  expect(set[1].test('block12')).to.eq(true);
+  expect(set[1].test('Block12')).to.eq(false);
+  expect(set[1].test('xblock12')).to.eq(false);
+  expect(set[2].test('dim1x2')).to.eq(true);
+  expect(set[2].test('dim1y2')).to.eq(false);
+  expect(set[3].test('xpos')).to.eq(true);
+  expect(set[3].test('XPos')).to.eq(false);
+  expect(set[3].test('ypos2')).to.eq(true);
+  expect(set[3].test('wpos')).to.eq(false);
+  expect(set[3].test('xpos1a')).to.eq(false);
+  expect(set[4].test('xpos')).to.eq(true);
+  expect(set[4].test('XPos')).to.eq(true);
+}

package/test/config/mtconnectHaas.test.js

@@ -0,0 +1,15 @@
+'use strict';
+
+const expect = require('chai').expect;
+const testUtils = require('../util/testUtils');
+
+describe('MTConnect Haas config tests', function () {
+  let config;
+  before(async () => {
+    config = await testUtils.loadConfig('device/mtconnect-haas-default.yml');
+  });
+
+  it('Sets port 8082 as the default port if not specified', async function () {
+    expect(config.device.endpoint).to.eq('http://localhost:8082/');
+  });
+});

package/test/config/null.test.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const expect = require('chai').expect;
+const testUtils = require('../util/testUtils');
+
+describe('Null (Local) config tests', function () {
+  let defaultConfig;
+  before(async () => {
+    defaultConfig = await testUtils.loadConfig('device/null-default.yml');
+  });
+
+  it('reads default config', async function () {
+    expect(defaultConfig.device.keys).to.deep.eq([]);
+    expect(defaultConfig.device.sourceKeys).to.deep.eq([]);
+  });
+});

package/test/config/opcua.test.js

@@ -0,0 +1,97 @@
+'use strict';
+
+const _ = require('lodash');
+const expect = require('chai').expect;
+const testUtils = require('../util/testUtils');
+
+describe('OPC-UA config tests', function () {
+  let config;
+  let defaultConfig;
+  before(async () => {
+    defaultConfig = await testUtils.loadConfig('device/opcua-default.yml');
+    config = await testUtils.loadConfig('device/opcua-std.yml');
+  });
+
+  it('loads minimal config with defaults', async function () {
+    expect(defaultConfig.device.securityMode).to.eq('None');
+    expect(defaultConfig.device.securityPolicy).to.eq('None');
+    expect(defaultConfig.device.readMode).to.eq('subscription');
+    expect(defaultConfig.device.forceReadOnConnect).to.eq(false);
+    expect(defaultConfig.device.scanInterval).to.eq(1000);
+    expect(defaultConfig.device.tags).to.deep.eq({});
+    expect(defaultConfig.device.username).to.eq(undefined);
+    expect(defaultConfig.device.password).to.eq(undefined);
+    expect(defaultConfig.device.userCertificatePath).to.eq(undefined);
+    expect(defaultConfig.device.userPrivateKeyPath).to.eq(undefined);
+    expect(defaultConfig.device.conditionKey).to.eq(undefined);
+  });
+
+  it('reads tags', async function () {
+    expect(_.keys(config.device.tags)).to.deep.eq(['fan-speed', 'pump-speed', 'some-date', 'pressure']);
+  });
+
+  it('loaded expression service', async function () {
+    const deviceNames = ['fan-speed', 'pump-speed', 'some-date', 'pressure'];
+    const allNames = [...deviceNames, 'device-connected'];
+    expect(config.expressionService.definedNames()).to.deep.eq(allNames);
+    expect(config.expressionService.definedNames('device')).to.deep.eq(deviceNames);
+
+    expect(config.expressionService.referencedNames()).to.deep.eq(['fan-speed', 'pump-speed']);
+    expect(config.expressionService.referencedNames('device')).to.deep.eq(['fan-speed', 'pump-speed']);
+  });
+
+  it('catches bad tag definition (bad path syntax)', async function () {
+    try {
+      await testUtils.loadConfig('device/opcua-bad-tag.yml');
+      throw new Error('Malformed tag accepted');
+    } catch (err) {
+      expect(err.section).to.deep.eq(['tags']);
+      expect(err.attribute).to.eq('fan-speed');
+      expect(err.message.indexOf('Malformed tag definition')).to.eq(0);
+    }
+  });
+
+  it('catches bad tag definition (missing path)', async function () {
+    try {
+      await testUtils.loadConfig('device/opcua-bad-tag2.yml');
+      throw new Error('Malformed tag accepted');
+    } catch (err) {
+      expect(err.section).to.deep.eq(['tags', 'fan-speed']);
+      expect(err.message.indexOf('no path specified')).to.eq(0);
+    }
+  });
+
+  it('accepts valid node id paths', async function () {
+    expect(config.device.checkTagPath({ path: 'ns=2;i=10853' })).to.eq('ns=2;i=10853');
+    expect(config.device.checkTagPath({ path: 'ns=2;s=someIdentifier' })).to.eq('ns=2;s=someIdentifier');
+    expect(config.device.checkTagPath({ path: 'ns=2;g=BAEAF004-1E43-4A06-9EF0-E52010D5CD10' })).to.eq('ns=2;g=BAEAF004-1E43-4A06-9EF0-E52010D5CD10');
+    expect(config.device.checkTagPath({ path: 'ns=2;b=AP8=' })).to.eq('ns=2;b=AP8=');
+    expect(config.device.checkTagPath({ path: 'i=10853' })).to.eq('i=10853');
+    expect(config.device.checkTagPath({ path: 's=someIdentifier' })).to.eq('s=someIdentifier');
+    expect(config.device.checkTagPath({ path: 'g=BAEAF004-1E43-4A06-9EF0-E52010D5CD10' })).to.eq('g=BAEAF004-1E43-4A06-9EF0-E52010D5CD10');
+    expect(config.device.checkTagPath({ path: 'b=AP8=' })).to.eq('b=AP8=');
+  });
+
+  it('accepts valid indexes', async function () {
+    expect(config.device.checkIndex({ index: '5' })).to.include({ start: 5, end: 5 });
+    expect(config.device.checkIndex({ index: '5:8' })).to.include({ start: 5, end: 8 });
+    expect(config.device.checkIndex({ })).to.equal(null);
+  });
+
+  it('rejects invalid node id paths', async function () {
+    const testPath = (path) => {
+      try {
+        config.device.checkTagPath({ path });
+        throw new Error('Malformed tag accepted');
+      } catch (err) {
+        expect(err.message).to.not.eq('Malformed tag accepted');
+      }
+    };
+
+    testPath('ns=2; i=10853');
+    testPath('ns=2;i=abcd');
+    testPath('ns=2;j=10853');
+    testPath('10853');
+    testPath('nsu=http://test.org/UA/Data/;i=10853');
+  });
+});

package/test/config-tests.js

@@ -0,0 +1,102 @@
+'use strict';
+
+/* eslint-disable no-unused-vars */
+
+const _ = require('lodash');
+const expect = require('chai').expect;
+const ConfigError = require('../lib/config/configError');
+const testUtils = require('./util/testUtils');
+
+describe('Config tests', function () {
+  it('loads a minimum U3 config', async function () {
+    const config = await testUtils.loadConfig('min-config-u3.yaml');
+    expect(config.configVersion).to.eq(1);
+    expect(config.engineVersion).to.eq(1);
+    expect(config.deviceName).to.eq('labjack-u3');
+    expect(config.port).to.eq(8001);
+
+    expect(config.device.scanInterval).to.eq(0.002);
+    expect(_.size(config.device.pins)).to.eq(34);
+  });
+
+  it('loads a minimum T4 config', async function () {
+    const config = await testUtils.loadConfig('min-config-t4.yaml');
+    expect(config.configVersion).to.eq(1);
+    expect(config.engineVersion).to.eq(1);
+    expect(config.deviceName).to.eq('labjack-t4');
+    expect(config.port).to.eq(8001);
+
+    expect(config.device.host).to.eq('192.168.1.100');
+    expect(config.device.scanInterval).to.eq(0.002);
+    expect(_.size(config.device.pins)).to.eq(34);
+  });
+
+  it('fails to load missing device', async function () {
+    try {
+      const config = await testUtils.loadConfig('missing-device.yaml');
+      expect.fail();
+    } catch (err) {
+      expect(err).to.be.instanceof(ConfigError);
+    }
+  });
+
+  it('load handles injection option (object)', async function () {
+    const inject = {
+      device: 'labjack-t4',
+      'mtconnect-port': 8002,
+    };
+    const config = await testUtils.loadConfig('device/modbus-partial.yml', { inject });
+
+    expect(config.deviceName).to.eq('modbus-tcp'); // config file takes precedence
+    expect(config.port).to.eq(8002);
+  });
+
+  it('load handles injection option (string)', async function () {
+    const inject = 'device: labjack-t4\nmtconnect-port: 8002\n';
+    const config = await testUtils.loadConfig('device/modbus-partial.yml', { inject });
+
+    expect(config.deviceName).to.eq('modbus-tcp'); // config file takes precedence
+    expect(config.port).to.eq(8002);
+  });
+
+  it('dump returns preserved yaml', async function () {
+    const inject = 'version: 1\ndevice: modbus-tcp\nhost: localhost\nmtconnect-port: 8002\n';
+    const config = await testUtils.loadConfig('dump-test.yml', { inject });
+
+    const expectedOutput = `version: 2
+# registers
+registers:
+  test: # test register
+    address: 30001
+    type: uint16
+
+# output
+data-items:
+  test:
+    value: "test"
+device: modbus-tcp
+host: localhost
+mtconnect-port: 8002
+`;
+
+    expect(config.dumpYaml()).to.eq(expectedOutput);
+  });
+
+  it('parse error', async function () {
+    try {
+      await testUtils.loadConfig('parse-error1.yml');
+      throw new Error('Document parsed without error');
+    } catch (err) {
+      expect(err.message.indexOf('YAML Error (lines 6 - 8): Nested mappings')).to.eq(0);
+    }
+  });
+
+  it('parse error', async function () {
+    try {
+      await testUtils.loadConfig('parse-error2.yml');
+      throw new Error('Document parsed without error');
+    } catch (err) {
+      expect(err.message.indexOf('YAML Error (lines 1 - 9): All collection items')).to.eq(0);
+    }
+  });
+});

package/test/configFiles/conditions.yml

@@ -0,0 +1,37 @@
+version: 2
+device: local
+declare-keys:
+  - key1
+  - key2
+  - key3
+  - key4
+variables:
+  keymod:
+    - source: key2
+    - threshold: 3
+conditions:
+  cond1:
+    - code: A1
+      message: Code A1
+      value:
+        FAULT: key1 > 10
+        WARNING: key1 > 5
+    - code: A2
+      message: Code A2
+      value:
+        FAULT: keymod
+  cond2:
+    - code: B${key3}
+      message: Code B${key3}
+      value:
+        FAULT: key1 > 10
+  cond3:
+    source: key4
+    overrides:
+      - match-code: /X\d+/
+        override-code: E${this}
+        override-message: Extra ${this}
+      - match-message: /.*coolant.*/
+        override-message: ${this} coolant=${key1}
+      - override-code: Y
+        override-message: Z

package/test/configFiles/data-items-legacy.yml

@@ -0,0 +1,24 @@
+version: 2
+device: local
+declare-keys:
+  - key1
+  - key2
+variables:
+  keymod:
+    - source: key2
+    - threshold: 3
+data-items:
+  key1:
+    value: key1
+  key1a:
+    value: key1 + 5
+  key1b:
+    value: key1 + key2
+  key2a:
+    value:
+      ACTIVE: keymod
+      READY: true
+  key2b:
+    value:
+      ACTIVE: key2 > 3
+      READY: true

package/test/configFiles/data-items-shorthand.yml

@@ -0,0 +1,14 @@
+version: 2
+device: local
+declare-keys:
+  - key1
+  - key2
+  - key3
+variables:
+  keymod: key2 >= 3
+data-items:
+  - key1
+  - key2: key2
+  - key2a: keymod
+  - key2b: key2 + key3.speed
+  - key3: key3.position

package/test/configFiles/data-items.yml

@@ -0,0 +1,12 @@
+version: 2
+device: local
+declare-keys:
+  - key1
+  - key2
+variables:
+  keymod:
+    - source: key2
+    - threshold: 3
+data-items:
+  - key1
+  - keymod

package/test/configFiles/device/ab-pccc-default.yml

@@ -0,0 +1,3 @@
+version: 2
+device: ab-pccc
+endpoint: 192.168.1.150

package/test/configFiles/device/ab-pccc-full.yml

@@ -0,0 +1,13 @@
+version: 2
+device: ab-pccc
+endpoint: 192.168.1.150:1234
+scan-interval: 0.1
+routing: true
+verbose-device: true
+extra-verbose-device: true
+device-timeout: 10
+slot: 1
+tags:
+  tag1: F7:5
+  tag2: B12:3/5
+  tag3: ST3:1,4

package/test/configFiles/device/adam-6052-default.yml

@@ -0,0 +1,2 @@
+device: adam-6052
+host: 192.168.1.100

package/test/configFiles/device/brother-http-default.yml

@@ -0,0 +1,3 @@
+device: brother-http
+endpoint: 192.168.1.100
+collection-mode: http

package/test/configFiles/device/ethernet-ip-default.yml

@@ -0,0 +1,2 @@
+device: ethernet-ip
+host: 192.168.1.100

package/test/configFiles/device/ifm-iot-default.yml

@@ -0,0 +1,2 @@
+device: iolink-ifm-iot
+endpoint: 192.168.1.100

package/test/configFiles/device/json-http-bad-prop.yml

@@ -0,0 +1,13 @@
+version: 2
+device: json-http
+endpoint: http://localhost:5000
+props:
+  file: file
+  part_number: part_number
+  process_status: 
+    path: 0.processStatus[test=5..test
+    route: /process
+data-items:
+  - file
+  - part_number
+  - process_status

package/test/configFiles/device/json-http-bad-prop2.yml

@@ -0,0 +1,13 @@
+version: 2
+device: json-http
+endpoint: http://localhost:5000
+props:
+  file: file
+  part_number: part_number
+  process_status: 
+    path2: 0.processStatus[test=5..test
+    route: /process
+data-items:
+  - file
+  - part_number
+  - process_status

package/test/configFiles/device/json-http-default.yml

@@ -0,0 +1,3 @@
+version: 2
+device: json-http
+endpoint: http://localhost:5000

package/test/configFiles/device/json-http-std.yml

@@ -0,0 +1,13 @@
+version: 2
+device: json-http
+endpoint: http://localhost:5000
+props:
+  file: file
+  part_number: part_number
+  process_status: 
+    path: test[machineId=test123].processStatus[test=5].test
+    route: /process
+data-items:
+  - file
+  - part_number
+  - process_status

package/test/configFiles/device/labjack-t4-condition-exprs.yaml

@@ -0,0 +1,46 @@
+version: 2
+device: labjack-t4
+host: 192.168.1.100
+mtconnect-port: 8001
+variables:
+  var1:
+    - source: AIN0
+    - threshold: 5
+  var2:
+    - source: AIN0 + AIN1
+    - threshold: 5
+  var3:
+    - source: max(AIN0, AIN2)
+    - threshold: 5
+  var4:
+    - source: AIN0
+    - expression: this and (AIN3 > 2.5)
+  data1:
+    - source: FIO4
+  data2:
+    - state:
+      - ON: var2 and FIO5 > 4
+      - OFF: true
+  alarm-code:
+    - source: 100
+  alarm-message:
+    - state:
+      - TEST-MESSAGE: true
+data-items:
+  - data1
+  - data2
+conditions:
+  shorthand:
+    code: A${alarm-code}
+    message: ${alarm-message}
+    value:
+      WARNING: FIO5 < 3
+  system:
+    - code: A1
+      message: test alarm
+      value:
+        FAULT: FIO6 > 4
+    - code: B${alarm-code}
+      message: B ${alarm-message}
+      value:
+        FAULT: FIO6 < 2

package/test/configFiles/device/labjack-t4-default.yml

@@ -0,0 +1,3 @@
+version: 2
+device: labjack-t4
+host: 192.168.1.100

package/test/configFiles/device/labjack-t4-pins-alt.yaml

@@ -0,0 +1,41 @@
+version: 2
+device: labjack-t4
+host: 192.168.1.100
+mtconnect-port: 8001
+variables:
+  var1:
+    - source: AIN0
+    - threshold: 5
+  var2:
+    - source: AIN0 + AIN1
+    - threshold: 5
+  var3:
+    - source: max(AIN0, AIN2)
+    - threshold: 5
+  var4:
+    - source: AIN0
+    - expression: this and (AIN3 > 2.5)
+  data1:
+    - source: FIO4
+  data2:
+    - state:
+      - ON: var2 and FIO5 > 4
+      - OFF: true
+data-items:
+  - data1
+  - data2
+conditions:
+  shorthand:
+    code: alarm0
+    message: heh
+    value:
+      WARNING: FIO5 < 3
+  system:
+    - code: alarm1
+      message: test alarm
+      value:
+        FAULT: FIO6 > 4
+    - code: alarm2
+      message: other alarm same pin
+      value:
+        FAULT: FIO6 < 2

package/test/configFiles/device/labjack-t4-pins.yaml

@@ -0,0 +1,40 @@
+version: 2
+device: labjack-t4
+host: 192.168.1.100
+mtconnect-port: 8001
+variables:
+  var1:
+    - source: pin-0
+    - threshold: 5
+  var2:
+    - source: pin-0 + pin-1
+    - threshold: 5
+  var3:
+    - source: max(pin-0, pin-2)
+    - threshold: 5
+  var4:
+    - source: pin-0
+    - expression: this and (pin-3 > 2.5)
+data-items:
+  data1:
+    value: pin-4
+  data2:
+    value:
+      ON: var2 and pin-5 > 4
+      OFF: true
+conditions:
+  shorthand:
+    code: alarm0
+    message: heh
+    value:
+      WARNING: pin-5 < 3
+  system:
+    - code: alarm1
+      message: test alarm
+      value:
+        FAULT: pin-6 > 4
+    - code: alarm2
+      message: other alarm same pin
+      value:
+        FAULT: pin-6 < 2
+