iotagent-node-lib
Version:
IoT Agent library to interface with NGSI Context Broker
515 lines (468 loc) • 17.2 kB
JavaScript
/*
* Copyright 2016 Telefonica Investigación y Desarrollo, S.A.U
*
* This file is part of fiware-iotagent-lib
*
* fiware-iotagent-lib is free software: you can redistribute it and/or
* modify it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the License,
* or (at your option) any later version.
*
* fiware-iotagent-lib is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with fiware-iotagent-lib.
* If not, seehttp://www.gnu.org/licenses/.
*
* For those usages not covered by the GNU Affero General Public License
* please contact with::[contacto@tid.es]
*
* Modified by: Daniel Calvo - ATOS Research & Innovation
*/
/* eslint-disable no-unused-vars */
const iotAgentLib = require('../../../../lib/fiware-iotagent-lib');
const utils = require('../../../tools/utils');
const request = utils.request;
const should = require('should');
const logger = require('logops');
const nock = require('nock');
const mongoUtils = require('../../mongodb/mongoDBUtils');
let contextBrokerMock;
let statusAttributeMock;
const iotAgentConfig = {
logLevel: 'FATAL',
contextBroker: {
host: '192.168.1.1',
port: '1026',
ngsiVersion: 'v2'
},
server: {
port: 4041,
host: 'localhost'
},
types: {
Light: {
commands: [],
lazy: [
{
name: 'temperature',
type: 'centigrades'
}
],
active: [
{
name: 'pressure',
type: 'Hgmm'
}
]
},
Termometer: {
commands: [],
lazy: [
{
name: 'temp',
type: 'kelvin'
}
],
active: []
},
Motion: {
commands: [],
lazy: [
{
name: 'moving',
type: 'Boolean'
}
],
staticAttributes: [
{
name: 'location',
type: 'Vector',
value: '(123,523)'
}
],
active: []
},
Robot: {
commands: [
{
name: 'position',
type: 'Array'
}
],
lazy: [],
staticAttributes: [],
active: []
},
RobotExp: {
commands: [
{
name: 'positionExp',
type: 'Array',
expression: '[22]'
}
],
lazy: [],
staticAttributes: [],
active: []
}
},
deviceRegistry: {
type: 'mongodb'
},
mongodb: {
uri: 'mongodb://localhost:27017/iotagent'
},
service: 'smartgondor',
subservice: 'gardens',
providerUrl: 'http://smartgondor.com',
pollingExpiration: 200,
pollingDaemonFrequency: 20,
useCBflowControl: true,
healthCheck: true
};
const device3 = {
id: 'r2d2',
type: 'Robot',
service: 'smartgondor',
subservice: 'gardens',
polling: true
};
const device4 = {
id: 'r2d4',
type: 'RobotExp',
service: 'smartgondor',
subservice: 'gardens',
polling: true
};
describe('NGSI-v2 - Polling commands', function () {
beforeEach(function (done) {
logger.setLevel('FATAL');
nock.cleanAll();
contextBrokerMock = nock('http://192.168.1.1:1026')
.matchHeader('fiware-service', 'smartgondor')
.matchHeader('fiware-servicepath', 'gardens')
.post('/v2/registrations')
.reply(201, null, { Location: '/v2/registrations/6319a7f5254b05844116584d' });
contextBrokerMock
.matchHeader('fiware-service', 'smartgondor')
.matchHeader('fiware-servicepath', 'gardens')
.post('/v2/entities?options=upsert,flowControl')
.reply(204);
iotAgentLib.activate(iotAgentConfig, done);
});
afterEach(function (done) {
delete device3.registrationId;
iotAgentLib.clearAll(function () {
iotAgentLib.deactivate(function () {
mongoUtils.cleanDbs(function () {
nock.cleanAll();
iotAgentLib.setDataUpdateHandler();
iotAgentLib.setCommandHandler();
done();
});
});
});
});
describe('When a command update arrives to the IoT Agent for a device with polling', function () {
const options = {
url: 'http://localhost:' + iotAgentConfig.server.port + '/v2/op/update?options=flowControl',
method: 'POST',
json: {
actionType: 'update',
entities: [
{
id: 'Robot:r2d2',
type: 'Robot',
position: {
type: 'Array',
value: '[28, -104, 23]'
}
}
]
},
headers: {
'fiware-service': 'smartgondor',
'fiware-servicepath': 'gardens'
}
};
beforeEach(function (done) {
statusAttributeMock = nock('http://192.168.1.1:1026');
iotAgentLib.register(device3, function (error) {
done();
});
});
it('should not call the client handler', function (done) {
let handlerCalled = false;
iotAgentLib.setCommandHandler(function (id, type, service, subservice, attributes, callback) {
handlerCalled = true;
callback(null, {
id,
type,
attributes: [
{
name: 'position',
type: 'Array',
value: '[28, -104, 23]'
}
]
});
});
request(options, function (error, response, body) {
should.not.exist(error);
handlerCalled.should.equal(false);
done();
});
});
it('should create the attribute with the "_status" prefix in the Context Broker', function (done) {
iotAgentLib.setCommandHandler(function (id, type, service, subservice, attributes, callback) {
callback(null);
});
request(options, function (error, response, body) {
should.not.exist(error);
statusAttributeMock.done();
done();
});
});
it('should store the commands in the queue', function (done) {
iotAgentLib.setCommandHandler(function (id, type, service, subservice, attributes, callback) {
callback(null);
});
request(options, function (error, response, body) {
iotAgentLib.commandQueue('smartgondor', 'gardens', 'r2d2', function (error, listCommands) {
should.not.exist(error);
listCommands.count.should.equal(1);
listCommands.commands[0].name.should.equal('position');
listCommands.commands[0].type.should.equal('Array');
listCommands.commands[0].value.should.equal('[28, -104, 23]');
done();
});
});
});
});
describe('When a command arrives with multiple values in the value field', function () {
const options = {
url: 'http://localhost:' + iotAgentConfig.server.port + '/v2/op/update?options=flowControl',
method: 'POST',
json: {
actionType: 'update',
entities: [
{
id: 'Robot:r2d2',
type: 'Robot',
position: {
type: 'Array',
value: {
attr1: 12,
attr2: 24
}
}
}
]
},
headers: {
'fiware-service': 'smartgondor',
'fiware-servicepath': 'gardens'
}
};
beforeEach(function (done) {
statusAttributeMock = nock('http://192.168.1.1:1026')
.matchHeader('fiware-service', 'smartgondor')
.matchHeader('fiware-servicepath', 'gardens')
.post(
'/v2/entities?options=upsert,flowControl',
utils.readExampleFile('./test/unit/ngsiv2/examples/contextRequests/updateContextCommandStatus.json')
)
.reply(204);
iotAgentLib.register(device3, function (error) {
done();
});
});
it('should return a 200 OK both in HTTP and in the status code', function (done) {
iotAgentLib.setCommandHandler(function (id, type, service, subservice, attributes, callback) {
callback(null);
});
request(options, function (error, response, body) {
should.not.exist(error);
response.statusCode.should.equal(204);
done();
});
});
});
describe('When a polling command expires', function () {
const options = {
url: 'http://localhost:' + iotAgentConfig.server.port + '/v2/op/update?options=flowControl',
method: 'POST',
json: {
actionType: 'update',
entities: [
{
id: 'Robot:r2d2',
type: 'Robot',
position: {
type: 'Array',
value: '[28, -104, 23]'
}
}
]
},
headers: {
'fiware-service': 'smartgondor',
'fiware-servicepath': 'gardens'
}
};
beforeEach(function (done) {
statusAttributeMock = nock('http://192.168.1.1:1026')
.matchHeader('fiware-service', 'smartgondor')
.matchHeader('fiware-servicepath', 'gardens')
.post(
'/v2/entities?options=upsert,flowControl',
utils.readExampleFile(
'./test/unit/ngsiv2/examples/contextRequests/updateContextCommandExpired.json'
)
)
.reply(204);
iotAgentLib.register(device3, function (error) {
done();
});
});
it('should remove it from the queue', function (done) {
iotAgentLib.setCommandHandler(function (id, type, service, subservice, attributes, callback) {
callback(null);
});
request(options, function (error, response, body) {
setTimeout(function () {
iotAgentLib.commandQueue('smartgondor', 'gardens', 'r2d2', function (error, listCommands) {
should.not.exist(error);
listCommands.count.should.equal(0);
done();
});
}, 300);
});
});
it('should mark it as ERROR in the Context Broker', function (done) {
iotAgentLib.setCommandHandler(function (id, type, service, subservice, attributes, callback) {
callback(null);
});
request(options, function (error, response, body) {
setTimeout(function () {
iotAgentLib.commandQueue('smartgondor', 'gardens', 'r2d2', function (error, listCommands) {
statusAttributeMock.done();
done();
});
}, 300);
});
});
});
});
describe('NGSI-v2 - Polling commands expressions', function () {
beforeEach(function (done) {
logger.setLevel('FATAL');
nock.cleanAll();
contextBrokerMock = nock('http://192.168.1.1:1026')
.matchHeader('fiware-service', 'smartgondor')
.matchHeader('fiware-servicepath', 'gardens')
.post('/v2/registrations')
.reply(201, null, { Location: '/v2/registrations/6319a7f5254b05844116584m' });
contextBrokerMock
.matchHeader('fiware-service', 'smartgondor')
.matchHeader('fiware-servicepath', 'gardens')
.post('/v2/entities?options=upsert,flowControl')
.reply(204);
iotAgentConfig.pollingExpiration = 0;
iotAgentConfig.pollingDaemonFrequency = 0;
iotAgentLib.activate(iotAgentConfig, done);
});
afterEach(function (done) {
delete device4.registrationId;
iotAgentLib.clearAll(function () {
iotAgentLib.deactivate(function () {
mongoUtils.cleanDbs(function () {
nock.cleanAll();
iotAgentLib.setDataUpdateHandler();
iotAgentLib.setCommandHandler();
done();
});
});
});
});
describe('When a command update arrives to the IoT Agent for a device with polling', function () {
const options = {
url: 'http://localhost:' + iotAgentConfig.server.port + '/v2/op/update?options=flowControl',
method: 'POST',
json: {
actionType: 'update',
entities: [
{
id: 'RobotExp:r2d4',
type: 'RobotExp',
positionExp: {
type: 'Array',
value: '[28, -104, 23]'
}
}
]
},
headers: {
'fiware-service': 'smartgondor',
'fiware-servicepath': 'gardens'
}
};
beforeEach(function (done) {
statusAttributeMock = nock('http://192.168.1.1:1026');
iotAgentLib.register(device4, function (error) {
done();
});
});
it('should not call the client handler', function (done) {
let handlerCalled = false;
iotAgentLib.setCommandHandler(function (id, type, service, subservice, attributes, callback) {
handlerCalled = true;
callback(null, {
id,
type,
attributes: [
{
name: 'positionExp',
type: 'Array',
value: '[28, -104, 23]'
}
]
});
});
request(options, function (error, response, body) {
should.not.exist(error);
handlerCalled.should.equal(false);
done();
});
});
it('should create the attribute with the "_status" prefix in the Context Broker', function (done) {
iotAgentLib.setCommandHandler(function (id, type, service, subservice, attributes, callback) {
callback(null);
});
request(options, function (error, response, body) {
should.not.exist(error);
statusAttributeMock.done();
done();
});
});
it('should store the commands in the queue', function (done) {
iotAgentLib.setCommandHandler(function (id, type, service, subservice, attributes, callback) {
callback(null);
});
request(options, function (error, response, body) {
iotAgentLib.commandQueue('smartgondor', 'gardens', 'r2d4', function (error, listCommands) {
should.not.exist(error);
listCommands.count.should.equal(1);
listCommands.commands[0].name.should.equal('positionExp');
listCommands.commands[0].type.should.equal('Array');
listCommands.commands[0].value[0].should.equal(22);
done();
});
});
});
});
});