iotagent-node-lib 2.19.0 → 2.22.0

package/test/unit/ngsiv2/examples/contextRequests/updateContextMultientityPlugin17.json

@@ -0,0 +1,27 @@
+{
+  "actionType": "update",
+  "entities": [
+    {
+      "id": "ws9b",
+      "type": "WeatherStation",
+      "pressure": {
+        "type": "Hgmm",
+        "value": "52"
+      }
+    },
+    {
+      "humidity": {
+        "type": "Percentage",
+        "value": "12",
+        "metadata": {
+          "unitCode": {
+            "type": "Text",
+            "value": "Hgmm"
+          }
+        }
+      },
+      "type": "Higrometer",
+      "id": "ws9b"
+    }
+  ]
+}

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

@@ -319,7 +319,7 @@ const iotAgentConfig = {
                     expression: "{coordinates: [lon,lat], type: 'Point'}"
                 }
             ],
-            explicitAttrs: '[ myattr ]'
+            explicitAttrs: "[ 'myattr' ]"
         },
         GPS6: {
             commands: [],
@@ -345,6 +345,30 @@ const iotAgentConfig = {
                 }
             ],
             explicitAttrs: true
+        },
+        GPS7: {
+            commands: [],
+            type: 'GPS',
+            lazy: [],
+            static: [
+                {
+                    name: 'color',
+                    type: 'string',
+                    value: 'blue'
+                }
+            ],
+            active: [
+                {
+                    name: 'price',
+                    type: 'number'
+                },
+                {
+                    name: 'location',
+                    type: 'geo:json',
+                    expression: "{coordinates: [lon,lat], type: 'Point'}"
+                }
+            ],
+            explicitAttrs: '[ ]'
         }
     },
     service: 'smartgondor',
@@ -1180,7 +1204,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/updateContextExpressionPlugin36.json'
                     )
                 )
                 .query({ type: 'GPS' })
@@ -1230,6 +1254,43 @@ 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 but with empty explicitAttrs', 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: 'myattr',
+                type: 'String',
+                value: 'location'
+            },
+            {
+                name: 'TimeInstant',
+                type: 'DateTime',
+                value: '2015-08-05T07:35:01.468+00:00'
+            }
+        ];
+
+        beforeEach(function () {
+            nock.cleanAll();
+        });
+
+        it('should calculate them and remove non-explicitAttrs by jexl expression with context from the payload ', function (done) {
+            iotAgentLib.update('gps1', 'GPS7', '', values, function (error) {
+                should.not.exist(error);
+                done();
+            });
+        });
+    });
 });
 
 describe('Java expression language (JEXL) based transformations plugin - Timestamps', function () {

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

@@ -98,6 +98,18 @@ const iotAgentConfig = {
             lazy: [],
             staticAttributes: [],
             active: []
+        },
+        RobotExp: {
+            commands: [
+                {
+                    name: 'positionExp',
+                    type: 'Array',
+                    expression: '[22]'
+                }
+            ],
+            lazy: [],
+            staticAttributes: [],
+            active: []
         }
     },
     deviceRegistry: {
@@ -122,6 +134,14 @@ const device3 = {
     subservice: 'gardens',
     polling: true
 };
+const device4 = {
+    id: 'r2d4',
+    type: 'RobotExp',
+    service: 'smartgondor',
+    subservice: 'gardens',
+    polling: true,
+    expressionLanguage: 'jexl'
+};
 
 describe('NGSI-v2 - Polling commands', function () {
     beforeEach(function (done) {
@@ -386,3 +406,134 @@ describe('NGSI-v2 - Polling commands', function () {
         });
     });
 });
+
+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')
+            .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',
+            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')
+                .matchHeader('fiware-service', 'smartgondor')
+                .matchHeader('fiware-servicepath', 'gardens')
+                .patch(
+                    '/v2/entities/RobotExp:r2d4/attrs?type=RobotExp',
+                    utils.readExampleFile(
+                        './test/unit/ngsiv2/examples/contextRequests/updateContextCommandStatus2.json'
+                    )
+                )
+                .reply(204);
+
+            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();
+                });
+            });
+        });
+    });
+});

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

@@ -215,6 +215,31 @@ const iotAgentConfig = {
                 }
             ]
         },
+        WeatherStation9: {
+            commands: [],
+            type: 'WeatherStation',
+            name: 'ws9b',
+            lazy: [],
+            active: [
+                {
+                    object_id: 'p',
+                    name: 'pressure',
+                    type: 'Hgmm'
+                },
+                {
+                    object_id: 'h',
+                    name: 'humidity',
+                    type: 'Percentage',
+                    entity_type: 'Higrometer',
+                    metadata: {
+                        unitCode: {
+                            type: 'Text',
+                            value: 'Hgmm'
+                        }
+                    }
+                }
+            ]
+        },
         WeatherStation8Jexl: {
             commands: [],
             type: 'WeatherStation',
@@ -581,6 +606,44 @@ describe('NGSI-v2 - Multi-entity plugin', function () {
         });
     });
 
+    describe('When an update comes for a multientity measurement based on entity_type', function () {
+        const values = [
+            {
+                name: 'p',
+                type: 'centigrades',
+                value: '52'
+            },
+            {
+                name: 'h',
+                type: 'Percentage',
+                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/updateContextMultientityPlugin17.json'
+                    )
+                )
+                .reply(204);
+        });
+
+        it('should send two context elements, one for each entity', function (done) {
+            iotAgentLib.update('ws9b', 'WeatherStation9', '', values, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                done();
+            });
+        });
+    });
+
     describe('When an update comes for a multientity measurement with same attribute name', function () {
         const values = [
             {

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

@@ -705,6 +705,66 @@ describe('NGSI-v2 - Device provisioning API: Provision devices', function () {
         }
     );
 
+    describe('When a device provisioning request arrives to the IoTA and entityNameExp was configured at group level', function () {
+        const options = {
+            url: 'http://localhost:' + iotAgentConfig.server.port + '/iot/devices',
+            method: 'POST',
+            json: utils.readExampleFile('./test/unit/examples/deviceProvisioningRequests/provisionMinimumDevice4.json'),
+            headers: {
+                'fiware-service': 'smartgondor',
+                'fiware-servicepath': '/gardens'
+            }
+        };
+        const groupCreation = {
+            url: 'http://localhost:4041/iot/services',
+            method: 'POST',
+            json: {
+                services: [
+                    {
+                        resource: '/Thing',
+                        apikey: '801230BJKL23Y9090DSFL123HJK09H324HV8732',
+                        /*jshint camelcase: false */
+                        entity_type: 'MicroLights',
+                        entityNameExp: 'EntityNameByExp',
+                        cbroker: 'http://192.168.1.1:1026'
+                    }
+                ]
+            },
+            headers: {
+                'fiware-service': 'smartgondor',
+                'fiware-servicepath': '/gardens'
+            }
+        };
+
+        beforeEach(function (done) {
+            nock.cleanAll();
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .matchHeader('fiware-service', 'smartgondor')
+                .matchHeader('fiware-servicepath', '/gardens')
+                .post(
+                    '/v2/entities?options=upsert',
+                    utils.readExampleFile(
+                        './test/unit/ngsiv2/examples/contextRequests/createMinimumProvisionedDevice4.json'
+                    )
+                )
+                .reply(204);
+
+            done();
+        });
+
+        it('should store the entity name defined by expression', function (done) {
+            request(groupCreation, function (error, response, body) {
+                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');
+                        done();
+                    });
+                });
+            });
+        });
+    });
+
     describe(
         'When a device provisioning request with static attributes arrives to the IoTA' +
             ' and same static attribute is also configured at group level',

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

@@ -484,10 +484,11 @@ describe('NGSI-v2 - Device provisioning API: Update provisioned devices', functi
 
         it('should provision the explicitAttrs attribute appropriately', function (done) {
             request(optionsUpdate, function (error, response, body) {
+                should.not.exist(error);
+                response.statusCode.should.equal(204);
                 request(optionsGetDevice, function (error, response, body) {
                     should.not.exist(error);
                     response.statusCode.should.equal(200);
-
                     body.explicitAttrs.should.equal(false);
                     done();
                 });

package/bin/agentConsole.js

@@ -1,257 +0,0 @@
-#!/usr/bin/env node
-
-/*
- * Copyright 2014 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]
- */
-
-/* eslint-disable no-unused-vars */
-/* eslint-disable no-console */
-
-const readline = require('readline');
-const iotAgentLib = require('../lib/fiware-iotagent-lib');
-const commandUtils = require('command-shell-lib');
-let config = require('../config');
-const logger = require('logops');
-const async = require('async');
-const separator = '\n\n\t';
-
-const commands = {
-    start: {
-        parameters: [],
-        description: '\tStart the IoT Agent',
-        handler: startApp
-    },
-    stop: {
-        parameters: [],
-        description: '\tStop the IoT Agent',
-        handler: stopApp
-    },
-    register: {
-        parameters: ['id', 'type'],
-        description:
-            '\tRegister a new device in the IoT Agent. The attributes to register will be extracted from the\n' +
-            '\ttype configuration',
-        handler: registerDevice
-    },
-    unregister: {
-        parameters: ['id', 'type'],
-        description: '\tUnregister the selected device',
-        handler: unregisterDevice
-    },
-    showConfig: {
-        parameters: [],
-        description: '\tShow the current configuration file',
-        handler: showConfig
-    },
-    config: {
-        parameters: ['newConfig'],
-        description: '\tChange the configuration file to a new one',
-        handler: changeConfig
-    },
-    updatevalue: {
-        parameters: ['deviceId', 'deviceType', 'attributes'],
-        description:
-            '\tUpdate a device value in the Context Broker. The attributes should be triads with the following\n' +
-            '\tformat: "name/type/value" sepparated by commas.',
-        handler: updateDeviceValue
-    },
-    listdevices: {
-        parameters: [],
-        description: '\tList all the devices that have been registered in this IoT Agent session\n',
-        handler: listDevices
-    }
-};
-
-function handleError(message) {
-    return function (error) {
-        if (error) {
-            console.log('\n\\033[31mERROR:\\033[0m %s', error.message);
-        } else {
-            console.log(message);
-        }
-
-        commandUtils.prompt();
-    };
-}
-
-function listDevices() {
-    iotAgentLib.listDevices(config.service, config.subservice, function (error, devices) {
-        if (error) {
-            console.log('\n\\033[31mERROR:\\033[0m %s', error.message);
-        } else {
-            const keys = Object.keys(devices);
-
-            for (let i = 0; i < keys.length; i++) {
-                console.log('\n\n%s\n', JSON.stringify(devices[keys[i]], null, 4));
-            }
-
-            commandUtils.prompt();
-        }
-    });
-}
-
-function extractAttributes(attributeString, callback) {
-    const attributes = attributeString.split(',');
-    const attributesResult = [];
-
-    for (let i = 0; i < attributes.length; i++) {
-        const fields = attributes[i].split('/');
-        const attribute = {
-            name: fields[0],
-            type: fields[1]
-        };
-
-        if (fields[2]) {
-            attribute.value = fields[2];
-        }
-
-        attributesResult.push(attribute);
-    }
-
-    callback(null, attributesResult);
-}
-
-function showConfig() {
-    console.log('Current configuration file:\n\n%s', JSON.stringify(config, null, 4));
-}
-
-function changeConfig(command) {
-    config = require(command[0]);
-}
-
-function writeHandler(id, type, attributes, callback) {
-    console.log(
-        '\n\nFake WRITE handler for update in entity [%s] with type [%s]\n%s\n',
-        id,
-        type,
-        JSON.stringify(attributes, null, 4)
-    );
-
-    callback(null, {
-        id,
-        type,
-        attributes
-    });
-}
-
-function readHandler(id, type, attributes, callback) {
-    console.log(
-        '\n\nFake READ handler for update in entity [%s] with type [%s]\n%s\n',
-        id,
-        type,
-        JSON.stringify(attributes, null, 4)
-    );
-
-    const sensorData = {
-        id,
-        isPattern: false,
-        type,
-        attributes: [
-            {
-                name: 'luminance',
-                type: 'lumens',
-                value: 19
-            }
-        ]
-    };
-
-    callback(null, sensorData);
-}
-
-function startApp(command) {
-    iotAgentLib.setDataUpdateHandler(writeHandler);
-    iotAgentLib.setCommandHandler(writeHandler);
-    iotAgentLib.setDataQueryHandler(readHandler);
-    iotAgentLib.activate(config, handleError('Application started'));
-}
-
-function stopApp(command) {
-    iotAgentLib.deactivate(handleError('Application stopped'));
-}
-
-function exitAgent(command) {
-    process.exit(0);
-}
-
-function registerDevice(command) {
-    const device = {
-        id: command[0],
-        type: command[1]
-    };
-
-    console.log('Registering device');
-    iotAgentLib.register(device, handleError('Device registered in the Context Broker'));
-}
-
-function unregisterDevice(command) {
-    console.log('Unregistering device');
-    iotAgentLib.unregister(command[0], handleError('Device unregistered'));
-}
-
-function updateDeviceValue(command) {
-    iotAgentLib.getDevice(command[0], function (error, device) {
-        if (device) {
-            extractAttributes(command[2], function (error, attributes) {
-                iotAgentLib.update(
-                    device.name,
-                    device.type,
-                    '',
-                    attributes,
-                    device,
-                    handleError('Device value updated')
-                );
-            });
-        } else {
-            async.waterfall(
-                [
-                    async.apply(extractAttributes, command[2]),
-                    async.apply(iotAgentLib.update, command[0], command[1], '')
-                ],
-                handleError('Device value updated')
-            );
-        }
-    });
-}
-
-function queryHandler(id, type, attributes, callback) {
-    console.log('Handling query for [%s] of type [%s]:\n%s', JSON.stringify(attributes));
-
-    callback(null, {
-        type,
-        isPattern: false,
-        id,
-        attributes: []
-    });
-}
-
-function updateHandler(id, type, attributes, callback) {
-    console.log('Update message received for device with id [%s] and type [%s]', id, type);
-
-    callback(null, {
-        type,
-        isPattern: false,
-        id,
-        attributes: []
-    });
-}
-
-commandUtils.initialize(commands, 'IoTAgent> ');