iotagent-node-lib
Version:
IoT Agent library to interface with NGSI Context Broker
452 lines (420 loc) • 15.7 kB
JavaScript
/*
* Copyright 2024 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, see http://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 _ = require('underscore');
const utils = require('../../tools/utils');
const request = utils.request;
const async = require('async');
const should = require('should');
const iotAgentConfig = {
logLevel: 'FATAL',
contextBroker: {
host: '192.168.1.1',
port: '1026'
},
server: {
name: 'testAgent',
port: 4041,
host: 'localhost',
baseRoot: '/'
},
types: {},
deviceRegistry: {
type: 'mongodb'
},
mongodb: {
uri: 'mongodb://localhost:27017/iotagent'
},
service: 'smartgondor',
subservice: 'gardens',
providerUrl: 'http://smartgondor.com',
deviceRegistrationDuration: 'P1M',
healthCheck: true
};
const mongo = require('mongodb').MongoClient;
const mongoUtils = require('./mongoDBUtils');
const optionsCreation = {
url: 'http://localhost:4041/iot/groups',
method: 'POST',
json: {
groups: [
{
resource: '/deviceTest',
apikey: '801230BJKL23Y9090DSFL123HJK09H324HV8732',
entity_type: 'Light',
trust: '8970A9078A803H3BL98PINEQRW8342HBAMS',
cbHost: 'http://unexistentHost:1026',
commands: [
{
name: 'wheel1',
type: 'Wheel'
}
],
lazy: [
{
name: 'luminescence',
type: 'Lumens'
}
],
attributes: [
{
name: 'status',
type: 'Boolean'
}
],
internal_attributes: [
{
customField: 'customValue'
}
]
}
]
},
headers: {
'fiware-service': 'testservice',
'fiware-servicepath': '/testingPath'
}
};
const optionsDelete = {
url: 'http://localhost:4041/iot/groups',
method: 'DELETE',
json: {},
headers: {
'fiware-service': 'testservice',
'fiware-servicepath': '/testingPath'
},
qs: {
resource: '/deviceTest',
apikey: '801230BJKL23Y9090DSFL123HJK09H324HV8732'
}
};
const optionsList = {
url: 'http://localhost:4041/iot/groups',
method: 'GET',
json: {},
headers: {
'fiware-service': 'testservice',
'fiware-servicepath': '/*'
}
};
const optionsUpdate = {
url: 'http://localhost:4041/iot/groups',
method: 'PUT',
json: {
apikey: '801230BJKL23Y9090DSFL123HJK09H324HV8732',
trust: '8970A9078A803H3BL98PINEQRW8342HBAMS',
cbHost: 'http://anotherUnexistentHost:1026',
commands: [
{
name: 'wheel1',
type: 'Wheel'
}
],
lazy: [
{
name: 'luminescence',
type: 'Lumens'
}
],
attributes: [
{
name: 'status',
type: 'Boolean'
}
],
static_attributes: [
{
name: 'bootstrapServer',
type: 'Address',
value: '127.0.0.1'
}
]
},
headers: {
'fiware-service': 'testservice',
'fiware-servicepath': '/testingPath'
},
qs: {
resource: '/deviceTest',
apikey: '801230BJKL23Y9090DSFL123HJK09H324HV8732'
}
};
const optionsGet = {
url: 'http://localhost:4041/iot/groups',
method: 'GET',
json: {},
headers: {
'fiware-service': 'testservice',
'fiware-servicepath': '/testingPath'
}
};
let iotAgentDb;
describe('MongoDB Group Registry test', function () {
beforeEach(function (done) {
mongoUtils.cleanDbs(function () {
iotAgentLib.activate(iotAgentConfig, function () {
mongo.connect('mongodb://localhost:27017/iotagent', { useNewUrlParser: true }, function (err, db) {
iotAgentDb = db;
done();
});
});
});
});
afterEach(function (done) {
iotAgentLib.deactivate(function () {
iotAgentDb.close(function (error) {
mongoUtils.cleanDbs(done);
});
});
});
describe('When a new device group creation request arrives', function () {
it('should store it in the DB', function (done) {
request(optionsCreation, function (error, response, body) {
iotAgentDb
.db()
.collection('groups')
.find({})
.toArray(function (err, docs) {
should.not.exist(err);
should.exist(docs);
should.exist(docs.length);
docs.length.should.equal(1);
should.exist(docs[0].type);
should.exist(docs[0].internalAttributes);
should.exist(docs[0].attributes);
should.exist(docs[0].apikey);
docs[0].type.should.equal('Light');
docs[0].apikey.should.equal('801230BJKL23Y9090DSFL123HJK09H324HV8732');
docs[0].internalAttributes.length.should.equal(1);
docs[0].internalAttributes[0].customField.should.equal('customValue');
docs[0].attributes.length.should.equal(1);
docs[0].attributes[0].name.should.equal('status');
done();
});
});
});
it('should store the service information from the headers into the DB', function (done) {
request(optionsCreation, function (error, response, body) {
iotAgentDb
.db()
.collection('groups')
.find({})
.toArray(function (err, docs) {
should.not.exist(err);
should.exist(docs[0].service);
should.exist(docs[0].subservice);
docs[0].service.should.equal('testservice');
docs[0].subservice.should.equal('/testingPath');
done();
});
});
});
});
describe('When a new device group creation request arrives with an existant (apikey, resource) pair', function () {
it('should return a DUPLICATE_GROUP error', function (done) {
request(optionsCreation, function (error, response, body) {
request(optionsCreation, function (error, response, body) {
response.statusCode.should.equal(409);
body.name.should.equal('DUPLICATE_GROUP');
done();
});
});
});
});
describe('When a device group removal request arrives', function () {
beforeEach(function (done) {
request(optionsCreation, done);
});
it('should remove it from the database', function (done) {
request(optionsDelete, function (error, response, body) {
iotAgentDb
.db()
.collection('groups')
.find({})
.toArray(function (err, docs) {
should.not.exist(err);
should.exist(docs);
should.exist(docs.length);
docs.length.should.equal(0);
done();
});
});
});
it('should return a 204 OK statusCode', function (done) {
request(optionsDelete, function (error, response, body) {
response.statusCode.should.equal(204);
done();
});
});
});
describe('When a device group update request arrives', function () {
beforeEach(function (done) {
request(optionsCreation, done);
});
it('should update the values in the database', function (done) {
request(optionsUpdate, function (error, response, body) {
iotAgentDb
.db()
.collection('groups')
.find({})
.toArray(function (err, docs) {
should.not.exist(err);
should.exist(docs);
should.exist(docs[0].cbHost);
docs[0].cbHost.should.equal('http://anotherUnexistentHost:1026');
should.exist(docs[0].staticAttributes);
docs[0].staticAttributes.length.should.equal(1);
done();
});
});
});
});
describe('When a multiple device group creation arrives', function () {
const optionsMultipleCreation = _.clone(optionsCreation);
beforeEach(function (done) {
optionsMultipleCreation.json = utils.readExampleFile(
'./test/unit/examples/groupProvisioningRequests/multipleConfigGroupsCreation.json'
);
done();
});
it('should create the values in the database', function (done) {
request(optionsMultipleCreation, function (error, response, body) {
iotAgentDb
.db()
.collection('groups')
.find({})
.toArray(function (err, docs) {
should.not.exist(err);
should.exist(docs);
docs.length.should.equal(2);
done();
});
});
});
});
describe('When a device group listing request arrives', function () {
beforeEach(function (done) {
const optionsCreation1 = _.clone(optionsCreation);
const optionsCreation2 = _.clone(optionsCreation);
const optionsCreation3 = _.clone(optionsCreation);
optionsCreation2.json = { groups: [] };
optionsCreation3.json = { groups: [] };
optionsCreation2.json.groups[0] = _.clone(optionsCreation.json.groups[0]);
optionsCreation3.json.groups[0] = _.clone(optionsCreation.json.groups[0]);
optionsCreation2.json.groups[0].apikey = 'qwertyuiop';
optionsCreation3.json.groups[0].apikey = 'lkjhgfds';
async.series(
[
async.apply(request, optionsCreation1),
async.apply(request, optionsCreation2),
async.apply(request, optionsCreation3)
],
done
);
});
it('should return all the configured device groups from the database', function (done) {
request(optionsList, function (error, response, body) {
body.count.should.equal(3);
done();
});
});
});
describe('When a device group listing arrives with a limit', function () {
const optionsConstrained = {
url: 'http://localhost:4041/iot/groups',
method: 'GET',
qs: {
limit: 3,
offset: 2
},
json: {},
headers: {
'fiware-service': 'testservice',
'fiware-servicepath': '/*'
}
};
beforeEach(function (done) {
const optionsCreationList = [];
const creationFns = [];
for (let i = 0; i < 10; i++) {
optionsCreationList[i] = _.clone(optionsCreation);
optionsCreationList[i].json = { groups: [] };
optionsCreationList[i].json.groups[0] = _.clone(optionsCreation.json.groups[0]);
optionsCreationList[i].json.groups[0].apikey = 'qwertyuiop' + i;
creationFns.push(async.apply(request, optionsCreationList[i]));
}
async.series(creationFns, done);
});
it('should return the appropriate count of groups', function (done) {
request(optionsConstrained, function (error, response, body) {
body.count.should.equal(10);
done();
});
});
});
describe('When a device info request arrives', function () {
beforeEach(function (done) {
async.series([async.apply(request, optionsCreation)], done);
});
it('should return all the configured device groups from the database', function (done) {
request(optionsGet, function (error, response, body) {
should.exist(body);
should.exist(body.count);
body.count.should.equal(1);
should.exist(body.groups);
should.exist(body.groups.length);
body.groups.length.should.equal(1);
body.groups[0].service.should.equal('testservice');
done();
});
});
});
describe('When a device info request arrives and multiple groups have been created', function () {
beforeEach(function (done) {
const optionsCreationList = [];
const creationFns = [];
for (let i = 0; i < 10; i++) {
optionsCreationList[i] = _.clone(optionsCreation);
optionsCreationList[i].json = { groups: [] };
optionsCreationList[i].json.groups[0] = _.clone(optionsCreation.json.groups[0]);
optionsCreationList[i].json.groups[0].apikey = 'qwertyuiop' + i;
creationFns.push(async.apply(request, optionsCreationList[i]));
}
async.series(creationFns, done);
});
it('should return all the configured device groups from the database', function (done) {
request(optionsGet, function (error, response, body) {
should.exist(body);
should.exist(body.count);
body.count.should.equal(10);
should.exist(body.groups);
should.exist(body.groups.length);
body.groups.length.should.equal(10);
done();
});
});
});
});