iotagent-node-lib 3.1.0 → 3.2.0

package/test/unit/ngsiv2/expressions/jexlBasedTransformations-test.js

@@ -39,7 +39,6 @@ const iotAgentConfig = {
         port: '1026',
         ngsiVersion: 'v2'
     },
-    defaultExpressionLanguage: 'jexl',
     server: {
         port: 4041,
         host: 'localhost'
@@ -126,7 +125,7 @@ const iotAgentConfig = {
                 {
                     name: 'weather',
                     type: 'Summary',
-                    expression: '"Humidity " + (humidity / 2) + " and pressure " + (pressure * 20)'
+                    expression: '"Humidity " + (humidity / 2) + " and pressure " + (p * 20)'
                 },
                 {
                     object_id: 'a',
@@ -250,6 +249,24 @@ const iotAgentConfig = {
             ],
             explicitAttrs: true
         },
+        GPS2b: {
+            commands: [],
+            type: 'GPS',
+            lazy: [],
+            active: [
+                {
+                    name: 'location',
+                    type: 'geo:json',
+                    expression: "{coordinates: [lon,lat], type: 'Point'}"
+                },
+                {
+                    name: 'temperature',
+                    type: 'Number',
+                    expression: 't * 10'
+                }
+            ],
+            explicitAttrs: true
+        },
         GPS3: {
             commands: [],
             type: 'GPS',
@@ -321,8 +338,31 @@ const iotAgentConfig = {
                 }
             ],
             explicitAttrs: "theLocation ? ['mylocation'] :  []"
-            // #1267 this is not working:
-            //explicitAttrs: "theLocation ? [{object_id: 'theLocation'}] :  []"
+        },
+        GPS5b: {
+            commands: [],
+            type: 'GPS',
+            lazy: [],
+            static: [
+                {
+                    name: 'lat',
+                    type: 'string',
+                    value: '52'
+                }
+            ],
+            active: [
+                {
+                    name: 'price',
+                    type: 'number'
+                },
+                {
+                    object_id: 'theLocation',
+                    name: 'mylocation',
+                    type: 'geo:json',
+                    expression: "{coordinates: [lon,lat], type: 'Point'}"
+                }
+            ],
+            explicitAttrs: "theLocation ? [{object_id: 'theLocation'}] : []"
         },
         GPS6: {
             commands: [],
@@ -388,7 +428,6 @@ const iotAgentConfigTS = {
         port: '1026',
         ngsiVersion: 'v2'
     },
-    defaultExpressionLanguage: 'jexl',
     server: {
         port: 4041,
         host: 'localhost'
@@ -406,6 +445,57 @@ const iotAgentConfigTS = {
                 }
             ],
             explicitAttrs: true
+        },
+        WaterTank: {
+            commands: [],
+            type: 'WaterTank',
+            lazy: [],
+            active: [
+                {
+                    object_id: 'cnt2',
+                    name: 'contA',
+                    type: 'Number'
+                },
+                {
+                    object_id: 'cnt3',
+                    name: 'contB',
+                    type: 'Number'
+                },
+                {
+                    object_id: 'false2',
+                    name: 'waterLeavingTanks',
+                    type: 'Number',
+                    expression: 'cnt2*0.1',
+                    entity_name: 'PA_A_0001',
+                    entity_type: 'WaterTank'
+                },
+                {
+                    object_id: 'false3',
+                    name: 'waterLeavingTanks',
+                    type: 'Number',
+                    expression: 'cnt3*0.1',
+                    entity_name: 'PA_B_0001',
+                    entity_type: 'WaterTank'
+                },
+                {
+                    object_id: 'foostatus2',
+                    name: 'status',
+                    type: 'Text',
+                    expression: 'status',
+                    entity_name: 'PA_A_0001',
+                    entity_type: 'WaterTank'
+                },
+                {
+                    object_id: 'foostatus3',
+                    name: 'status',
+                    type: 'Text',
+                    expression: 'status',
+                    entity_name: 'PA_B_0001',
+                    entity_type: 'WaterTank'
+                }
+            ],
+            explicitAttrs:
+                "contA&&contB?['TimeInstant','contA',{object_id:'false2'},'contB',{object_id:'false3'},'status']:contA?['TimeInstant','contA',{object_id:'false2'},{object_id:'foostatus2'}]:contB?['TimeInstant','contB',{object_id:'false3'},{object_id:'foostatus3'}]:[]"
         }
     },
     timestamp: true,
@@ -1080,7 +1170,7 @@ describe('Java expression language (JEXL) based transformations plugin', functio
                 .patch(
                     '/v2/entities/gps1/attrs',
                     utils.readExampleFile(
-                        './test/unit/ngsiv2/examples/contextRequests/updateContextExpressionPlugin34.json'
+                        './test/unit/ngsiv2/examples/contextRequests/updateContextExpressionPlugin35.json'
                     )
                 )
                 .query({ type: 'GPS' })
@@ -1096,6 +1186,56 @@ describe('Java expression language (JEXL) based transformations plugin', functio
         });
     });
 
+    describe('When there is an extra measure sent by the device to be removed', function () {
+        // Case: Expression which results is sent as a new attribute
+        const values = [
+            {
+                name: 'lat',
+                type: 'Number',
+                value: 52
+            },
+            {
+                name: 'lon',
+                type: 'Number',
+                value: 13
+            },
+            {
+                name: 'another',
+                type: 'Number',
+                value: 99
+            },
+            {
+                name: 'TimeInstant',
+                type: 'DateTime',
+                value: '2015-08-05T07:35:01.468+00:00'
+            }
+        ];
+
+        beforeEach(function () {
+            nock.cleanAll();
+
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .matchHeader('fiware-service', 'smartgondor')
+                .matchHeader('fiware-servicepath', 'gardens')
+                .patch(
+                    '/v2/entities/gps1/attrs',
+                    utils.readExampleFile(
+                        './test/unit/ngsiv2/examples/contextRequests/updateContextExpressionPlugin41.json'
+                    )
+                )
+                .query({ type: 'GPS' })
+                .reply(204);
+        });
+
+        it('should calculate them and remove non-explicitAttrs from the payload', function (done) {
+            iotAgentLib.update('gps1', 'GPS2b', '', values, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                done();
+            });
+        });
+    });
+
     describe('When there is an extra TimeInstant sent by the device to be removed by string', function () {
         // Case: Expression which results is sent as a new attribute
         const values = [
@@ -1236,6 +1376,46 @@ describe('Java expression language (JEXL) based transformations plugin', functio
         });
     });
 
+    describe('When there is an extra TimeInstant sent by the device to be removed by jexl expression with context defined with object_id', function () {
+        // Case: Expression which results is sent as a new attribute
+        const values = [
+            {
+                name: 'lon',
+                type: 'Number',
+                value: 13
+            },
+            {
+                name: 'TimeInstant',
+                type: 'DateTime',
+                value: '2015-08-05T07:35:01.468+00:00'
+            }
+        ];
+
+        beforeEach(function () {
+            nock.cleanAll();
+
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .matchHeader('fiware-service', 'smartgondor')
+                .matchHeader('fiware-servicepath', 'gardens')
+                .patch(
+                    '/v2/entities/gps1/attrs',
+                    utils.readExampleFile(
+                        './test/unit/ngsiv2/examples/contextRequests/updateContextExpressionPlugin36.json'
+                    )
+                )
+                .query({ type: 'GPS' })
+                .reply(204);
+        });
+
+        it('should calculate them and remove non-explicitAttrs by jexl expression with context from the payload ', function (done) {
+            iotAgentLib.update('gps1', 'GPS5b', '', values, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                done();
+            });
+        });
+    });
+
     describe('When there is an extra TimeInstant sent by the device to be removedb jexl expression using static attrs', function () {
         // Case: Expression which results is sent as a new attribute
         const values = [
@@ -1378,4 +1558,46 @@ describe('Java expression language (JEXL) based transformations plugin - Timesta
             });
         });
     });
+
+    describe('When explicitAttrs is a jexl expression in a multientity case', function () {
+        // Case: Expression which results is sent as a new attribute
+        const values = [
+            {
+                name: 'cnt3',
+                type: 'Number',
+                value: '31450.000'
+            }
+        ];
+
+        beforeEach(function () {
+            const time = new Date(1438760101468); // 2015-08-05T07:35:01.468+00:00
+
+            timekeeper.freeze(time);
+            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/updateContextExpressionPlugin40.json'
+                    )
+                )
+                .reply(204);
+        });
+
+        afterEach(function (done) {
+            timekeeper.reset();
+            done();
+        });
+
+        it('should calculate them and not remove the timestamp from the payload', function (done) {
+            iotAgentLib.update('water1', 'WaterTank', '', values, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                done();
+            });
+        });
+    });
 });

package/test/unit/ngsiv2/lazyAndCommands/polling-commands-test.js

@@ -140,8 +140,7 @@ const device4 = {
     type: 'RobotExp',
     service: 'smartgondor',
     subservice: 'gardens',
-    polling: true,
-    expressionLanguage: 'jexl'
+    polling: true
 };
 
 describe('NGSI-v2 - Polling commands', function () {

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

@@ -246,11 +246,11 @@ describe('NGSI-v2 - Bidirectional data plugin', function () {
                 let longitudeFound = false;
 
                 for (let i = 0; i < values.length; i++) {
-                    if (values[i].name === 'latitude' && values[i].type === 'string' && values[i].value === '-9.6') {
+                    if (values[i].name === 'latitude' && values[i].type === 'Number' && values[i].value === -9.6) {
                         latitudeFound = true;
                     }
 
-                    if (values[i].name === 'longitude' && values[i].type === 'string' && values[i].value === '12.4') {
+                    if (values[i].name === 'longitude' && values[i].type === 'Number' && values[i].value === 12.4) {
                         longitudeFound = true;
                     }
                 }
@@ -357,11 +357,11 @@ describe('NGSI-v2 - Bidirectional data plugin', function () {
                 let longitudeFound = false;
 
                 for (let i = 0; i < values.length; i++) {
-                    if (values[i].name === 'latitude' && values[i].type === 'string' && values[i].value === '-9.6') {
+                    if (values[i].name === 'latitude' && values[i].type === 'Number' && values[i].value === -9.6) {
                         latitudeFound = true;
                     }
 
-                    if (values[i].name === 'longitude' && values[i].type === 'string' && values[i].value === '12.4') {
+                    if (values[i].name === 'longitude' && values[i].type === 'Number' && values[i].value === 12.4) {
                         longitudeFound = true;
                     }
                 }
@@ -503,11 +503,11 @@ describe('NGSI-v2 - Bidirectional data plugin', function () {
                 let longitudeFound = false;
 
                 for (let i = 0; i < values.length; i++) {
-                    if (values[i].name === 'latitude' && values[i].type === 'string' && values[i].value === '-9.6') {
+                    if (values[i].name === 'latitude' && values[i].type === 'Number' && values[i].value === -9.6) {
                         latitudeFound = true;
                     }
 
-                    if (values[i].name === 'longitude' && values[i].type === 'string' && values[i].value === '12.4') {
+                    if (values[i].name === 'longitude' && values[i].type === 'Number' && values[i].value === 12.4) {
                         longitudeFound = true;
                     }
                 }

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

@@ -102,7 +102,7 @@ const iotAgentConfig = {
                     object_id: 'h',
                     name: 'humidity',
                     type: 'Percentage',
-                    entity_name: 'Station Number ${@sn * 10}'
+                    entity_name: '"Station Number "+sn*10'
                 }
             ]
         },
@@ -115,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'
                 }
             ]
         },
@@ -197,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'
                 }
             ]
@@ -244,7 +244,6 @@ const iotAgentConfig = {
         WeatherStation8Jexl: {
             commands: [],
             type: 'WeatherStation',
-            expressionLanguage: 'jexl',
             lazy: [],
             active: [
                 {
@@ -272,7 +271,6 @@ const iotAgentConfig = {
         WeatherStation9Jexl: {
             commands: [],
             type: 'WeatherStation',
-            expressionLanguage: 'jexl',
             lazy: [],
             static: [
                 {
@@ -364,7 +362,6 @@ const iotAgentConfig = {
         WrongStation: {
             commands: [],
             type: 'WrongStation',
-            expressionLanguage: 'jexl',
             lazy: [],
             active: [
                 {
@@ -456,7 +453,6 @@ const iotAgentConfig = {
         SharedIds3: {
             commands: [],
             type: 'ShareStation',
-            expressionLanguage: 'jexl',
             lazy: [],
             active: [
                 {
@@ -510,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',
@@ -559,8 +591,7 @@ const iotAgentConfig = {
                     name: 'pressure',
                     type: 'Number'
                 }
-            ],
-            expressionLanguage: 'jexl'
+            ]
         }
     },
     service: 'smartgondor',
@@ -1244,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 = [
             {