iotagent-node-lib 3.0.0 → 3.2.0

package/test/unit/ngsiv2/plugins/custom-plugin_test.js

@@ -0,0 +1,151 @@
+/*
+ * Copyright 2015 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::daniel.moranjimenez@telefonica.com
+ *
+ * Modified by: Daniel Calvo - ATOS Research & Innovation
+ */
+
+const iotAgentLib = require('../../../../lib/fiware-iotagent-lib');
+const should = require('should');
+const logger = require('logops');
+const nock = require('nock');
+let contextBrokerMock;
+const iotAgentConfig = {
+    contextBroker: {
+        host: '192.168.1.1',
+        port: '1026',
+        ngsiVersion: 'v2'
+    },
+    server: {
+        port: 4041
+    },
+    types: {
+        Light: {
+            commands: [],
+            type: 'Light',
+            lazy: [
+                {
+                    name: 'temperature',
+                    type: 'centigrades'
+                }
+            ],
+            active: [
+                {
+                    name: 'pressure',
+                    type: 'Hgmm'
+                }
+            ]
+        }
+    },
+    service: 'smartgondor',
+    subservice: 'gardens',
+    providerUrl: 'http://smartgondor.com'
+};
+
+describe('NGSI-v2 - Custom plugin', function () {
+    let updateInvoked = false;
+    let queryInvoked = false;
+
+    function updatePlugin(entity, typeInformation, callback) {
+        updateInvoked = true;
+        return callback(null, entity, typeInformation);
+    }
+    function queryPlugin(entity, typeInformation, callback) {
+        queryInvoked = true;
+        return callback(null, entity, typeInformation);
+    }
+    beforeEach(function (done) {
+        logger.setLevel('FATAL');
+
+        iotAgentLib.activate(iotAgentConfig, function () {
+            iotAgentLib.clearAll(function () {
+                iotAgentLib.addUpdateMiddleware(updatePlugin);
+                iotAgentLib.addQueryMiddleware(queryPlugin);
+                done();
+            });
+        });
+    });
+
+    afterEach(function (done) {
+        iotAgentLib.clearAll(function () {
+            iotAgentLib.deactivate(done);
+            updateInvoked = false;
+            queryInvoked = false;
+        });
+    });
+    describe('When an update occurs', function () {
+        const values = [
+            {
+                name: 'state',
+                type: 'Boolean',
+                value: 'true'
+            },
+            {
+                name: 'dimming',
+                type: 'Number',
+                value: 23
+            }
+        ];
+
+        beforeEach(function () {
+            nock.cleanAll();
+
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .matchHeader('fiware-service', 'smartgondor')
+                .matchHeader('fiware-servicepath', 'gardens')
+                .patch('/v2/entities/light1/attrs')
+                .query({ type: 'Light' })
+                .reply(204);
+        });
+
+        it('should invoke the plugin', function (done) {
+            iotAgentLib.update('light1', 'Light', '', values, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                updateInvoked.should.equal(true);
+                done();
+            });
+        });
+    });
+    describe('When an query occurs', function () {
+        beforeEach(function () {
+            nock.cleanAll();
+
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .matchHeader('fiware-service', 'smartgondor')
+                .matchHeader('fiware-servicepath', 'gardens')
+                .get('/v2/entities/light1/attrs')
+                .query({ type: 'Light', attrs: 'state,dimming' })
+                .reply(200, { state: 'good', dimming: '23' });
+        });
+
+        it('should invoke the plugin', function (done) {
+            const attributes = ['state', 'dimming'];
+            iotAgentLib.query('light1', 'Light', '', attributes, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                should.not.exist(error);
+                queryInvoked.should.equal(true);
+                done();
+            });
+        });
+    });
+});

package/test/unit/ngsiv2/plugins/multientity-plugin_test.js

@@ -41,7 +41,8 @@ const iotAgentConfig = {
         ngsiVersion: 'v2'
     },
     server: {
-        port: 4041
+        port: 4041,
+        host: 'localhost'
     },
     types: {
         WeatherStation: {
@@ -101,7 +102,7 @@ const iotAgentConfig = {
                     object_id: 'h',
                     name: 'humidity',
                     type: 'Percentage',
-                    entity_name: 'Station Number ${@sn * 10}'
+                    entity_name: '"Station Number "+sn*10'
                 }
             ]
         },
@@ -114,13 +115,13 @@ const iotAgentConfig = {
                     object_id: 'p',
                     name: 'pressure',
                     type: 'Hgmm',
-                    entity_name: 'Station Number ${@sn * 10}'
+                    entity_name: '"Station Number "+sn*10'
                 },
                 {
                     object_id: 'h',
                     name: 'humidity',
                     type: 'Percentage',
-                    entity_name: 'Station Number ${@sn * 10}'
+                    entity_name: '"Station Number "+sn*10'
                 }
             ]
         },
@@ -196,21 +197,21 @@ const iotAgentConfig = {
                 {
                     object_id: 'v1',
                     name: 'vol',
-                    expression: '${@v1*100}',
+                    expression: 'v1*100',
                     type: 'Number',
                     entity_name: 'WeatherStation1'
                 },
                 {
                     object_id: 'v2',
                     name: 'vol',
-                    expression: '${@v2*100}',
+                    expression: 'v2*100',
                     type: 'Number',
                     entity_name: 'WeatherStation2'
                 },
                 {
                     object_id: 'v',
                     name: 'vol',
-                    expression: '${@v*100}',
+                    expression: 'v*100',
                     type: 'Number'
                 }
             ]
@@ -243,7 +244,6 @@ const iotAgentConfig = {
         WeatherStation8Jexl: {
             commands: [],
             type: 'WeatherStation',
-            expressionLanguage: 'jexl',
             lazy: [],
             active: [
                 {
@@ -271,7 +271,6 @@ const iotAgentConfig = {
         WeatherStation9Jexl: {
             commands: [],
             type: 'WeatherStation',
-            expressionLanguage: 'jexl',
             lazy: [],
             static: [
                 {
@@ -363,7 +362,6 @@ const iotAgentConfig = {
         WrongStation: {
             commands: [],
             type: 'WrongStation',
-            expressionLanguage: 'jexl',
             lazy: [],
             active: [
                 {
@@ -455,7 +453,6 @@ const iotAgentConfig = {
         SharedIds3: {
             commands: [],
             type: 'ShareStation',
-            expressionLanguage: 'jexl',
             lazy: [],
             active: [
                 {
@@ -509,6 +506,42 @@ const iotAgentConfig = {
             ],
             explicitAttrs: true
         },
+        GPS1: {
+            commands: [],
+            expressionLanguage: 'jexl',
+            type: 'GPS',
+            lazy: [],
+            active: [
+                {
+                    name: 'explicit',
+                    type: 'number',
+                    object_id: 'z'
+                },
+                {
+                    name: 'expectedAtt',
+                    type: 'number',
+                    expression: 'z+1'
+                },
+                {
+                    name: 'nonexpectedAtt',
+                    type: 'number',
+                    expression: 'w+1'
+                },
+                {
+                    name: 'explicit',
+                    type: 'number',
+                    entity_name: 'SO5',
+                    object_id: 'x'
+                },
+                {
+                    name: 'explicit',
+                    type: 'number',
+                    entity_name: 'SO6',
+                    object_id: 'y'
+                }
+            ],
+            explicitAttrs: true
+        },
         GPS2: {
             commands: [],
             type: 'GPS',
@@ -558,8 +591,7 @@ const iotAgentConfig = {
                     name: 'pressure',
                     type: 'Number'
                 }
-            ],
-            expressionLanguage: 'jexl'
+            ]
         }
     },
     service: 'smartgondor',
@@ -1243,6 +1275,48 @@ describe('NGSI-v2 - Multi-entity plugin', function () {
         });
     });
 
+    describe('When an update comes for a multientity measurement explicitAttrs for several entities', function () {
+        const values = [
+            {
+                name: 'x',
+                type: 'Number',
+                value: 52
+            },
+            {
+                name: 'y',
+                type: 'Number',
+                value: 13
+            },
+            {
+                name: 'z',
+                type: 'Number',
+                value: 12
+            }
+        ];
+
+        beforeEach(function () {
+            nock.cleanAll();
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .matchHeader('fiware-service', 'smartgondor')
+                .matchHeader('fiware-servicepath', 'gardens')
+                .post(
+                    '/v2/op/update',
+                    utils.readExampleFile(
+                        './test/unit/ngsiv2/examples/contextRequests/updateContextMultientityPlugin25.json'
+                    )
+                )
+                .reply(204);
+        });
+
+        it('should remove hidden attrs from the value', function (done) {
+            iotAgentLib.update('gps1', 'GPS1', '', values, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                done();
+            });
+        });
+    });
+
     describe('When an update comes for a multientity measurement explicitAttrs as jexl for one entity', function () {
         const values = [
             {

package/test/unit/ngsiv2/plugins/timestamp-processing-plugin_test.js

@@ -36,7 +36,8 @@ const iotAgentConfig = {
         ngsiVersion: 'v2'
     },
     server: {
-        port: 4041
+        port: 4041,
+        host: 'localhost'
     },
     types: {
         Light: {

package/test/unit/ngsiv2/provisioning/device-group-api-test.js

@@ -41,6 +41,7 @@ const iotAgentConfig = {
     server: {
         name: 'testAgent',
         port: 4041,
+        host: 'localhost',
         baseRoot: '/'
     },
     types: {},

package/test/unit/ngsiv2/provisioning/device-group-utils-test.js

@@ -56,6 +56,7 @@ const iotAgentConfig = {
     },
     server: {
         port: 4041,
+        host: 'localhost',
         baseRoot: '/'
     },
     types: {

package/test/unit/ngsiv2/provisioning/device-provisioning-api_test.js

@@ -42,6 +42,7 @@ const iotAgentConfig = {
     },
     server: {
         port: 4041,
+        host: 'localhost',
         baseRoot: '/'
     },
     types: {},
@@ -725,8 +726,16 @@ describe('NGSI-v2 - Device provisioning API: Provision devices', function () {
                         apikey: '801230BJKL23Y9090DSFL123HJK09H324HV8732',
                         /*jshint camelcase: false */
                         entity_type: 'MicroLights',
-                        entityNameExp: 'EntityNameByExp',
-                        cbHost: 'http://192.168.1.1:1026'
+                        entityNameExp: "id + '__' + suffix_st",
+                        expressionLanguage: 'jexl',
+                        cbHost: 'http://192.168.1.1:1026',
+                        static_attributes: [
+                            {
+                                name: 'suffix_st',
+                                type: 'Text',
+                                value: 'SUFFIX'
+                            }
+                        ]
                     }
                 ]
             },
@@ -757,7 +766,7 @@ describe('NGSI-v2 - Device provisioning API: Provision devices', function () {
                 request(options, function (error, response, body) {
                     iotAgentLib.listDevices('smartgondor', '/gardens', function (error, results) {
                         should.exist(results.devices[0].name);
-                        results.devices[0].name.should.equal('EntityNameByExp');
+                        results.devices[0].name.should.equal('MicroLight1__SUFFIX');
                         done();
                     });
                 });

package/test/unit/ngsiv2/provisioning/device-registration_test.js

@@ -40,7 +40,8 @@ const iotAgentConfig = {
         ngsiVersion: 'v2'
     },
     server: {
-        port: 4041
+        port: 4041,
+        host: 'localhost'
     },
     types: {
         Light: {

package/test/unit/ngsiv2/provisioning/device-update-registration_test.js

@@ -39,7 +39,8 @@ const iotAgentConfig = {
         ngsiVersion: 'v2'
     },
     server: {
-        port: 4041
+        port: 4041,
+        host: 'localhost'
     },
     types: {
         Light: {
@@ -268,17 +269,19 @@ describe('NGSI-v2 - IoT Agent Device Update Registration', function () {
         });
         it('should store the new values in the registry', function (done) {
             iotAgentLib.updateRegister(deviceCommandUpdated, false, function (error, data) {
-                iotAgentLib.getDevice(deviceCommandUpdated.id, 'smartgondor', 'gardens', function (
-                    error,
-                    deviceResult
-                ) {
-                    should.not.exist(error);
-                    should.exist(deviceResult);
-                    deviceResult.internalId.should.equal(deviceUpdated.internalId);
-                    deviceResult.commands[0].name.should.equal('move');
-                    deviceResult.active[0].name.should.equal('temperature');
-                    done();
-                });
+                iotAgentLib.getDevice(
+                    deviceCommandUpdated.id,
+                    'smartgondor',
+                    'gardens',
+                    function (error, deviceResult) {
+                        should.not.exist(error);
+                        should.exist(deviceResult);
+                        deviceResult.internalId.should.equal(deviceUpdated.internalId);
+                        deviceResult.commands[0].name.should.equal('move');
+                        deviceResult.active[0].name.should.equal('temperature');
+                        done();
+                    }
+                );
             });
         });
     });

package/test/unit/ngsiv2/provisioning/listProvisionedDevices-test.js

@@ -42,6 +42,7 @@ const iotAgentConfig = {
     },
     server: {
         port: 4041,
+        host: 'localhost',
         baseRoot: '/'
     },
     types: {},

package/test/unit/ngsiv2/provisioning/provisionDeviceMultientity-test.js

@@ -41,6 +41,7 @@ const iotAgentConfig = {
     },
     server: {
         port: 4041,
+        host: 'localhost',
         baseRoot: '/'
     },
     types: {},

package/test/unit/ngsiv2/provisioning/removeProvisionedDevice-test.js

@@ -42,6 +42,7 @@ const iotAgentConfig = {
     },
     server: {
         port: 4041,
+        host: 'localhost',
         baseRoot: '/'
     },
     types: {},

package/test/unit/ngsiv2/provisioning/singleConfigurationMode-test.js

@@ -41,6 +41,7 @@ const iotAgentConfig = {
     },
     server: {
         port: 4041,
+        host: 'localhost',
         baseRoot: '/'
     },
     types: {},

package/test/unit/ngsiv2/provisioning/updateProvisionedDevices-test.js

@@ -42,6 +42,7 @@ const iotAgentConfig = {
     },
     server: {
         port: 4041,
+        host: 'localhost',
         baseRoot: '/'
     },
     types: {},

package/test/unit/plugins/capture-configuration-inPlugins_test.js

@@ -35,7 +35,8 @@ const iotAgentConfig = {
         port: '1026'
     },
     server: {
-        port: 4041
+        port: 4041,
+        host: 'localhost'
     },
     types: {
         Light: {

package/test/unit/plugins/capture-provision-inPlugins_test.js

@@ -37,7 +37,8 @@ const iotAgentConfig = {
         port: '1026'
     },
     server: {
-        port: 4041
+        port: 4041,
+        host: 'localhost'
     },
     types: {
         Light: {