bkp7 / schema-js-api

test/fullsignalk.js

/* global describe, it */
const chai = require('chai')
const dirtyChai = require('dirty-chai')
chai.use(dirtyChai)
chai.should()
chai.use(require('../dist/').chaiModule)

const FullSignalK = require('../dist/fullsignalk')
const skApi = require('../dist/index.js')

var deltaA = {
  'updates': [{
    'source': {
      'label': 'n2kFromFile',
      'type': 'NMEA2000',
      'pgn': 129038,
      'src': '43'
    },
    'timestamp': '2014-08-15T19:03:21.532Z',
    'values': [{
      'path': 'navigation.speedOverGround',
      'value': 7.09
    }, {
      'path': 'navigation.courseOverGroundTrue',
      'value': 4.8171
    }, {
      'path': 'navigation.position',
      'value': {
        'longitude': 25.4398883,
        'latitude': 59.969895
      }
    }]
  }],
  'context': 'vessels.urn:mrn:imo:mmsi:200000000'
}

describe('FullSignalK', function () {
  describe('validations', function () {
    it('.validSignalK passes valid signalK', function () {
      var validSk = {
        'vessels': {
          'urn:mrn:imo:mmsi:200000000': {
            'mmsi': '200000000'}},
        'version': '1.0.0',
        'self': 'urn:mrn:imo:mmsi:200000000'}

      validSk.should.be.validSignalK()
    })
    it('.validSignalK fails invalid signalK', function () {
      var invalidSk = {
        'vessels': {
          'urn:mrn:imo:mmXX:200000000': {
            'mmsi': '200000000'}},
        'version': '1.0.0',
        'self': 'urn:mrn:imo:mmsi:200000000'}

      invalidSk.should.not.be.validSignalK()
    })
    it('.validSignalKDelta passes valid delta', function () {
      var validDelta = {
        'context': 'bar',
        'updates': [{
          'source': {
            'label': '',
            'type': 'NMEA0183',
            'sentence': 'GLL',
            'talker': 'II'
          },
          'timestamp': '2013-10-08T15:47:28.263Z',
          'values': [{'path': 'a.b.c', 'value': 1234}]
        }]
      }
      validDelta.should.be.validSignalKDelta()
    })
  })
  // TODO add full set of validation tests in here

  it('deltaToFull with object value should produce valid SignalK', function () {
    var full = skApi.deltaToFull(deltaA)
    console.log(JSON.stringify(full))
    full.vessels['urn:mrn:imo:mmsi:200000000'].navigation.position.value.should.have.property('longitude')
    full.vessels['urn:mrn:imo:mmsi:200000000'].navigation.position.should.have.property('$source')
    full.should.be.validSignalK()
  })

  it('addDelta with object value should produce full tree leaf without the .value', function () {
    var fullSignalK = new FullSignalK()
    fullSignalK.addDelta(deltaA)
    fullSignalK.retrieve().vessels['urn:mrn:imo:mmsi:200000000'].navigation.position.value.should.have.property('longitude')
    fullSignalK.retrieve().vessels['urn:mrn:imo:mmsi:200000000'].navigation.position.should.have.property('$source')
  })

  it('Two deltas from different sources results in values structure', function () {
    var delta = {
      'updates': [{
        'source': {
          'label': 'n2kFromFile',
          'type': 'NMEA2000',
          'pgn': 129038,
          'src': '43'
        },
        'timestamp': '2014-08-15T19:03:21.532Z',
        'values': [{
          'path': 'navigation.speedOverGround',
          'value': 7.09
        }]
      }],
      'context': 'vessels.foo'
    }
    var fullSignalK = new FullSignalK()
    fullSignalK.addDelta(delta)
    delta.updates[0].source.src = 48
    delta.updates[0].values[0].value = 8
    fullSignalK.addDelta(delta)
    fullSignalK.retrieve().vessels.foo.navigation.speedOverGround.should.have.property('value', 8)
    fullSignalK.retrieve().vessels.foo.navigation.speedOverGround.should.have.property('$source')
    fullSignalK.retrieve().vessels.foo.navigation.speedOverGround.values['n2kFromFile.43'].should.have.property('value', 7.09)
    fullSignalK.retrieve().vessels.foo.navigation.speedOverGround.values['n2kFromFile.48'].should.have.property('value', 8)
  })

  it('AIS delta produces valid Signal K', function () {
    this.timeout(4000) // first use of schema validation may have to download schemas so increase timeout from 2 to 4 seconds
    var aisDelta = {
      'updates': [{
        'source': {
          'label': 'N2K-1',
          'type': 'NMEA2000',
          'pgn': 129038,
          'src': '43'
        },
        'timestamp': '2014-08-15T19:00:15.402Z',
        'values': [{
          'path': 'navigation.speedOverGround',
          'value': 14.81
        }, {
          'path': 'navigation.courseOverGroundTrue',
          'value': 3.4889
        }, {
          'path': 'navigation.position',
          'value': {
            'longitude': 24.8142433,
            'latitude': 59.865655
          }
        }]
      }],
      'context': 'vessels.urn:mrn:imo:mmsi:276780000'
    }
    var fullSignalK = new FullSignalK('urn:mrn:imo:mmsi:276799999', 'mmsi')
    fullSignalK.addDelta(aisDelta)
    fullSignalK.retrieve().should.be.validSignalK()
  })

  it('Delta with empty path sets content under root', function () {
    var msg = {
      'updates': [{
        'source': {
          'label': 'n2kFromFile',
          'type': 'NMEA2000',
          'pgn': 129794,
          'src': '43'
        },
        'timestamp': '2014-08-15T19:02:31.507Z',
        'values': [{
          'path': '',
          'value': {
            'name': 'WRANGO'
          }
        }]
      }],
      'context': 'vessels.urn:mrn:imo:mmsi:276810000'
    }
    var fullSignalK = new FullSignalK()
    fullSignalK.addDelta(msg)
    var vessel = fullSignalK.retrieve().vessels['urn:mrn:imo:mmsi:276810000']
    vessel.should.have.property('name', 'WRANGO')
    vessel.should.not.have.property('$source')
    vessel.should.not.have.property('timestamp')
    vessel.should.not.have.property('pgn')
  })

  it('Delta with instance produces proper sources hierarchy', function () {
    var msg = {
      'updates': [{
        'source': {
          'label': 'N2K',
          'type': 'NMEA2000',
          'pgn': 130312,
          'src': '36',
          'instance': '0'
        },
        'timestamp': '2015-01-15T16:15:19.628Z',
        'values': [{
          'path': 'environment.water.temperature',
          'value': 15.2
        }]
      }],
      'context': 'vessels.urn:mrn:imo:mmsi:200000000'
    }
    var fullSignalK = new FullSignalK()
    fullSignalK.addDelta(msg)
    var full = fullSignalK.retrieve()
    var vessel = full.vessels['urn:mrn:imo:mmsi:200000000']
    vessel.environment.water.temperature.should.have.property('value', 15.2)
    full.sources.should.have.property('N2K')
    full.sources['N2K'].should.have.property('36')
    full.sources['N2K']['36'].should.have.property('0')
  })

  it('Delta with $source produces sources hierarchy and correct $source reference', function () {
    var msg = {
      'context': 'vessels.urn:mrn:imo:mmsi:200000000',
      'updates': [{
        '$source': '1W.0316013faeff',
        'values': [{
          'path': 'propulsion.engine1.temperature',
          'value': 301.837
        }]
      }]
    }

    var fullSignalK = new FullSignalK('urn:mrn:imo:mmsi:200000000')
    fullSignalK.addDelta(msg)
    var full = fullSignalK.retrieve()
    full.sources.should.have.property('1W')
    full.sources['1W'].should.have.property('0316013faeff')
    var vessel = full.vessels['urn:mrn:imo:mmsi:200000000']
    vessel.propulsion.engine1.temperature.should.have.property('$source', '1W.0316013faeff')
    // full.should.be.validSignalK
    // TODO make this work!
  })

  it('MMSI self is set correctly in full tree', function () {
    var fullSignalK = new FullSignalK('urn:mrn:imo:mmsi:200000000', null, {})
    fullSignalK.retrieve().self.should.equal('vessels.urn:mrn:imo:mmsi:200000000')
  })

  it('UUID self is set correctly in full tree', function () {
    var fullSignalK = new FullSignalK('urn:mrn:signalk:uuid:00000000-0000-4000-800000000000', null, {})
    fullSignalK.retrieve().self.should.equal('vessels.urn:mrn:signalk:uuid:00000000-0000-4000-800000000000')
  })

  // bulk testing all variant inputs valid and not to check initialisatino works as it should
  var ids = [
    {
      types: ['', 'nonesense', 'a.b', {}, [], 5],
      id: 'http://something.com',
      expect: {group: ['vessels', 'vessels', 'vessels', 'vessels', 'vessels', 'vessels'], idType: 'url', idValue: 'http://something.com'}
    }, {
      types: ['vessels', 'aton', 'sar', 'aircraft', 'vessel'],
      id: 'urn:mrn:signalk:uuid:00000000-0000-4000-800000000000',
      expect: {group: [null, null, null, null, null]}
    }, {
      types: ['vessels', 'aton', 'sar', 'aircraft', 'vessel'], // the types to test - '' and vessel should default to vessels
      id: 'http://something.com',
      expect: {group: ['vessels', 'aton', 'sar', 'aircraft', 'vessels'], idType: 'url', idValue: 'http://something.com'}
    }, {
      types: ['vessels', 'aton', 'sar', 'aircraft', 'vessel'],
      id: 'https://aurl.com/something#w=3',
      expect: {group: ['vessels', 'aton', 'sar', 'aircraft', 'vessels'], idField: 'url', idFieldValue: 'https://aurl.com/something#w=3'}
    }, {
      types: ['vessels', 'aton', 'sar', 'aircraft', 'vessel'],
      id: 'mailto:myname@my.url.co.uk',
      expect: {group: ['vessels', 'aton', 'sar', 'aircraft', 'vessels'], idField: 'url', idFieldValue: 'mailto:myname@my.url.co.uk'}
    }, {
      types: ['vessels', 'aton', 'sar', 'aircraft', 'vessel'],
      id: 'tel: +11 (0) 1111 111 111',
      expect: {group: ['vessels', 'aton', 'sar', 'aircraft', 'vessels'], idField: 'url', idFieldValue: 'tel: +11 (0) 1111 111 111'}
    }, {
      types: ['vessels', 'aton', 'sar', 'aircraft', 'vessel'],
      id: 'urn:mrn:signalk:uuid:00000000-0000-4000-800000000000',
      expect: {group: ['vessels', 'aton', 'sar', 'aircraft', 'vessels'], idField: 'uuid', idFieldValue: 'urn:mrn:signalk:uuid:00000000-0000-4000-800000000000'}
    }, {
      types: ['vessels', 'vessel'],
      id: 'urn:mrn:imo:mmsi:200000000',
      expect: {group: ['vessels', 'vessels'], idField: 'mmsi', idFieldValue: '200000000'}
    }, {
      types: ['aircraft'],
      id: 'urn:mrn:imo:mmsi:100000000',
      expect: {group: ['aircraft'], idField: 'mmsi', idFieldValue: '100000000'}
    }, {
      types: ['sar'],
      id: 'urn:mrn:imo:mmsi:970000000',
      expect: {group: ['sar'], idField: 'mmsi', idFieldValue: '970000000'}
    }, {
      types: ['aton'],
      id: 'urn:mrn:imo:mmsi:990000000',
      expect: {group: ['aton'], idField: 'mmsi', idFieldValue: '990000000'}
    }
  ]

  var id
  for (var i = 0; i < ids.length; i++) {
    id = ids[i]
    for (var t = 0; t < id.types.length; t++) {
      var thisId = id
      var thisType = id.types[t]
      var thisGroup = id.expect.group[t]
      var sk = new skApi.FullSignalK(thisId.id, thisType)
      it('Initialisation with id: ' + thisId.id + ' and type: ' + thisType, function () {
        sk.retrieve()[thisGroup][thisId.id][thisId.expect.idField].should.equal(thisId.expect.idFieldValue)

The variable thisGroup is changed as part of the for loop for example by id.expect.group.t on line 297. Only the value of the last iteration will be visible in this function if it is called after the loop.

The variable thisId is changed as part of the for loop for example by id on line 295. Only the value of the last iteration will be visible in this function if it is called after the loop.

The variable sk is changed as part of the for loop for example by new skApi.FullSignalK(thisId.id, thisType) on line 298. Only the value of the last iteration will be visible in this function if it is called after the loop.

      })
      it('... and is valid full Signal K', function () {
        sk.retrieve().should.be.validSignalK()

The variable sk is changed as part of the for loop for example by new skApi.FullSignalK(thisId.id, thisType) on line 298. Only the value of the last iteration will be visible in this function if it is called after the loop.

      })
    }
  }
/*
  it('Initialisation with id: "nonesense" and type: "vessel" should produce {}', function () {
    var sk = new skApi.FullSignalK("nonesense", "vessel")
    sk.retrieve().should.deep.equal({})
  })

  it('Initialisation with id: "urn:mrn:imo:mmsi:230099999" and type: "V3553L" should produce {}', function () {
    var sk = new skApi.FullSignalK("urn:mrn:imo:mmsi:230099999", "V3553L")
    sk.retrieve().should.deep.equal({})
  })

  it('Initialisation with id: "" and type: "vessel" should produce {}', function () {
    var sk = new skApi.FullSignalK("", "vessel")
    sk.retrieve().should.deep.equal({})
  })

  it('Initialisation with id: "" and type: "vessel" should produce {}', function () {
    var sk = new skApi.FullSignalK("urn:mrn:imo:mmsi:230099999", "V3553L")
    sk.retrieve().should.deep.equal({})
  })

  it('Initialisation with id: "urn:mrn:imo:mmsi:230099999" and type: "aton" should produce {} (incorrect mmsi number zone)', function () {
    var sk = new skApi.FullSignalK("urn:mrn:imo:mmsi:230099999", "aton")
    sk.retrieve().should.deep.equal({})
  })

  it('Initialisation with id: "ftp:my.site.co.uk" and type: "vessel" should produce {} (invalid id)', function () {
    var sk = new skApi.FullSignalK("ftp:my.site.co.uk", "vessel")
    sk.retrieve().should.deep.equal({})
  })
*/
})