iotagent-node-lib 4.7.0 → 4.9.0

package/test/unit/ngsi-ld/lazyAndCommands/command-test.js

@@ -1187,7 +1187,7 @@ describe('NGSI-LD - Command functionalities', function () {
         });
 
         it('should update its value and status in the Context Broker', function (done) {
-            iotAgentLib.setCommandResult('r2d2', 'Robot', '', 'position', '[72, 368, 1]', 'FINISHED', function (error) {
+            iotAgentLib.setCommandResult('r2d2', 'Robot', '', 'position', [72, 368, 1], 'FINISHED', function (error) {
                 should.not.exist(error);
                 statusAttributeMock.done();
                 done();

package/test/unit/ngsi-ld/lazyAndCommands/lazy-devices-test.js

@@ -226,7 +226,7 @@ describe('NGSI-LD - IoT Agent Lazy Devices', function () {
         it('should call the device handler for each of the contexts');
     });
 
-    describe('When a context query arrives to the IoT Agent', function () {
+    describe('When a context query arrives to the IoT Agent using retrieveEntity', function () {
         const options = {
             url:
                 'http://localhost:' +
@@ -294,6 +294,76 @@ describe('NGSI-LD - IoT Agent Lazy Devices', function () {
         });
     });
 
+    describe('When a context query arrives to the IoT Agent using queryEntities', function () {
+        const options = {
+            url:
+                'http://localhost:' +
+                iotAgentConfig.server.port +
+                '/ngsi-ld/v1/entities/?id=urn:ngsi-ld:Light:light1&attrs=dimming',
+            method: 'GET',
+            headers: {
+                'fiware-service': 'smartgondor',
+                'fiware-servicepath': 'gardens'
+            }
+        };
+        const sensorData = [
+            {
+                id: 'Light:light1',
+                type: 'Light',
+                dimming: {
+                    type: 'Percentage',
+                    value: 19
+                }
+            }
+        ];
+
+        beforeEach(function (done) {
+            nock.cleanAll();
+
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .matchHeader('fiware-service', 'smartgondor')
+                .post(
+                    '/ngsi-ld/v1/csourceRegistrations/',
+                    utils.readExampleFile(
+                        './test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerIoTAgent1.json'
+                    )
+                )
+                .reply(201, null, { Location: '/ngsi-ld/v1/csourceRegistrations/6319a7f5254b05844116584d' });
+
+            contextBrokerMock
+                .matchHeader('fiware-service', 'smartgondor')
+                .post('/ngsi-ld/v1/entityOperations/upsert/')
+                .reply(204);
+
+            async.series([apply(iotAgentLib.activate, iotAgentConfig), apply(iotAgentLib.register, device1)], done);
+        });
+
+        it('should return the information querying the underlying devices', function (done) {
+            const expectedResponse = [
+                utils.readExampleFile(
+                    './test/unit/ngsi-ld/examples/contextProviderResponses/queryInformationResponse.json'
+                )
+            ];
+
+            iotAgentLib.setDataUpdateHandler(function (id, type, service, subservice, attributes, callback) {
+                callback(null);
+            });
+
+            iotAgentLib.setDataQueryHandler(function (id, type, service, subservice, attributes, callback) {
+                id.should.equal('urn:ngsi-ld:' + device1.type + ':' + device1.id);
+                type.should.equal(device1.type);
+                attributes[0].should.equal('dimming');
+                callback(null, sensorData[0]);
+            });
+
+            request(options, function (error, response, body) {
+                should.not.exist(error);
+                body.should.eql(expectedResponse);
+                done();
+            });
+        });
+    });
+
     describe('When a context query arrives to the IoT Agent and no handler is set', function () {
         const options = {
             url:

package/test/unit/ngsi-ld/ngsiService/attributeTypes-test.js

@@ -0,0 +1,293 @@
+/*
+ * Copyright 2022 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 utils = require('../../../tools/utils');
+const request = utils.request;
+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: 'ld',
+        jsonLdContext: 'http://context.json-ld'
+    },
+    server: {
+        port: 4041,
+        host: 'localhost'
+    },
+    types: {
+        Light: {
+            commands: [],
+            type: 'Light',
+            active: [
+                {
+                    name: 'name',
+                    type: 'LanguageProperty'
+                },
+                {
+                    name: 'locatedIn',
+                    type: 'Relationship'
+                },
+                {
+                    name: 'lightValues',
+                    type: 'ListProperty'
+                },
+                {
+                    name: 'placedIn',
+                    type: 'ListRelationship'
+                },
+                {
+                    name: 'categories',
+                    type: 'VocabProperty'
+                },
+                {
+                    name: 'config',
+                    type: 'JsonProperty'
+                }
+            ]
+        }
+    },
+    service: 'smartgondor',
+    subservice: 'gardens',
+    providerUrl: 'http://smartgondor.com'
+};
+
+describe('NGSI-LD: Attribute types test', function () {
+    beforeEach(function () {
+        logger.setLevel('FATAL');
+    });
+
+    afterEach(function (done) {
+        iotAgentLib.deactivate(done);
+    });
+
+    describe('When the IoT Agent receives new exonym from a device name with LanguageProperty type and a JSON object', function () {
+        const values = [
+            {
+                name: 'name',
+                type: 'LanguageProperty',
+                value: {
+                    el: 'Κωνσταντινούπολις',
+                    en: 'Constantinople',
+                    tr: 'İstanbul'
+                }
+            }
+        ];
+
+        beforeEach(function (done) {
+            nock.cleanAll();
+
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .matchHeader('fiware-service', 'smartgondor')
+                .post(
+                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
+                    utils.readExampleFile(
+                        './test/unit/ngsi-ld/examples/contextRequests/updateContextLanguageProperty.json'
+                    )
+                )
+                .reply(204);
+
+            iotAgentLib.activate(iotAgentConfig, done);
+        });
+
+        it('should change the LanguageMap of the corresponding attribute in the context broker', function (done) {
+            iotAgentLib.update('light1', 'Light', '', values, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                done();
+            });
+        });
+    });
+
+    describe('When the IoT Agent receives new list from a device  with ListProperty type', function () {
+        const values = [
+            {
+                name: 'lightValues',
+                type: 'ListProperty',
+                value: [0, 1]
+            }
+        ];
+
+        beforeEach(function (done) {
+            nock.cleanAll();
+
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .matchHeader('fiware-service', 'smartgondor')
+                .post(
+                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
+                    utils.readExampleFile('./test/unit/ngsi-ld/examples/contextRequests/updateContextListProperty.json')
+                )
+                .reply(204);
+
+            iotAgentLib.activate(iotAgentConfig, done);
+        });
+
+        it('should change the listValue of the corresponding attribute in the context broker', function (done) {
+            iotAgentLib.update('light1', 'Light', '', values, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                done();
+            });
+        });
+    });
+
+    describe('When the IoT Agent receives new list from a device with ListRelationship type', function () {
+        const values = [
+            {
+                name: 'placedIn',
+                type: 'ListRelationship',
+                value: ['unr:ngsi-ld:xxx', 'unr:ngsi-ld:yyyy']
+            }
+        ];
+
+        beforeEach(function (done) {
+            nock.cleanAll();
+
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .matchHeader('fiware-service', 'smartgondor')
+                .post(
+                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
+                    utils.readExampleFile(
+                        './test/unit/ngsi-ld/examples/contextRequests/updateContextListRelationship.json'
+                    )
+                )
+                .reply(204);
+
+            iotAgentLib.activate(iotAgentConfig, done);
+        });
+
+        it('should change the listObject of the corresponding attribute in the context broker', function (done) {
+            iotAgentLib.update('light1', 'Light', '', values, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                done();
+            });
+        });
+    });
+
+    describe('When the IoT Agent receives new list from a device with JsonProperty type', function () {
+        const values = [
+            {
+                name: 'config',
+                type: 'JsonProperty',
+                value: { foo: 'bar' }
+            }
+        ];
+
+        beforeEach(function (done) {
+            nock.cleanAll();
+
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .matchHeader('fiware-service', 'smartgondor')
+                .post(
+                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
+                    utils.readExampleFile('./test/unit/ngsi-ld/examples/contextRequests/updateContextJsonProperty.json')
+                )
+                .reply(204);
+
+            iotAgentLib.activate(iotAgentConfig, done);
+        });
+
+        it('should change the json of the corresponding attribute in the context broker', function (done) {
+            iotAgentLib.update('light1', 'Light', '', values, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                done();
+            });
+        });
+    });
+
+    describe('When the IoT Agent receives new list from a device with VocabProperty type', function () {
+        const values = [
+            {
+                name: 'category',
+                type: 'VocabProperty',
+                value: 'actuator'
+            }
+        ];
+
+        beforeEach(function (done) {
+            nock.cleanAll();
+
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .matchHeader('fiware-service', 'smartgondor')
+                .post(
+                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
+                    utils.readExampleFile(
+                        './test/unit/ngsi-ld/examples/contextRequests/updateContextVocabProperty.json'
+                    )
+                )
+                .reply(204);
+
+            iotAgentLib.activate(iotAgentConfig, done);
+        });
+
+        it('should change the vocab of the corresponding attribute in the context broker', function (done) {
+            iotAgentLib.update('light1', 'Light', '', values, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                done();
+            });
+        });
+    });
+
+    describe('When the IoT Agent receives new urn from a device with Relationship type', function () {
+        const values = [
+            {
+                name: 'locatedIn',
+                type: 'Relationship',
+                value: 'urn:ngsi-ld:XXX'
+            }
+        ];
+
+        beforeEach(function (done) {
+            nock.cleanAll();
+
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .matchHeader('fiware-service', 'smartgondor')
+                .post(
+                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
+                    utils.readExampleFile('./test/unit/ngsi-ld/examples/contextRequests/updateContextRelationship.json')
+                )
+                .reply(204);
+
+            iotAgentLib.activate(iotAgentConfig, done);
+        });
+
+        it('should change the vocab of the corresponding attribute in the context broker', function (done) {
+            iotAgentLib.update('light1', 'Light', '', values, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                done();
+            });
+        });
+    });
+});

package/test/unit/ngsi-ld/ngsiService/unsupported-endpoints-test.js

@@ -108,16 +108,6 @@ describe('NGSI-LD - Unsupported Endpoints', function () {
     });
 
     describe('When accessing an Unsupported Endpoint', function () {
-        it('GET /entities should return a valid NSGI-LD error message', function (done) {
-            const options = {
-                url: 'http://localhost:' + iotAgentConfig.server.port + '/ngsi-ld/v1/entities',
-                method: 'GET'
-            };
-            request(options, function (error, response, body) {
-                response.statusCode.should.equal(501);
-                done();
-            });
-        });
         it('POST /entities should return a valid NSGI-LD error message', function (done) {
             const options = {
                 url: 'http://localhost:' + iotAgentConfig.server.port + '/ngsi-ld/v1/entities',

package/test/unit/ngsi-ld/ngsiService/value-types-test.js

@@ -0,0 +1,221 @@
+/*
+ * 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, seehttp://www.gnu.org/licenses/.
+ *
+ * For those usages not covered by the GNU Affero General Public License
+ * please contact with::[contacto@tid.es]
+ *
+ * Developed by: Federico M. Facca - Martel Innovate
+ */
+
+/* jshint camelcase: false */
+
+const iotAgentLib = require('../../../../lib/fiware-iotagent-lib');
+const utils = require('../../../tools/utils');
+const should = require('should');
+const nock = require('nock');
+let contextBrokerMock;
+const iotAgentConfig = {
+    logLevel: 'FATAL',
+    contextBroker: {
+        host: '192.168.1.1',
+        port: '1026',
+        ngsiVersion: 'ld',
+        jsonLdContext: 'http://context.json-ld'
+    },
+    server: {
+        port: 4041,
+        ldSupport: {
+            dataType: 'valueType'
+        }
+    },
+    types: {
+        Light: {
+            commands: [],
+            type: 'Light',
+            lazy: [],
+            active: [
+                {
+                    object_id: 'p',
+                    name: 'pressure',
+                    type: 'Number'
+                },
+                {
+                    object_id: 'e',
+                    name: 'consumption',
+                    type: 'Number'
+                },
+                {
+                    object_id: 'a',
+                    name: 'alive',
+                    type: 'Property'
+                },
+                {
+                    object_id: 'u',
+                    name: 'updated',
+                    type: 'Boolean'
+                },
+                {
+                    object_id: 'm',
+                    name: 'manufacturer',
+                    type: 'Object'
+                },
+                {
+                    object_id: 'r',
+                    name: 'revisions',
+                    type: 'Array'
+                },
+                {
+                    object_id: 'd',
+                    name: 'date',
+                    type: 'Date'
+                },
+                {
+                    object_id: 't',
+                    name: 'time',
+                    type: 'Time'
+                },
+                {
+                    object_id: 'dt',
+                    name: 'datetime',
+                    type: 'DateTime'
+                }
+            ]
+        }
+    },
+    service: 'smartgondor',
+    subservice: 'gardens',
+    providerUrl: 'http://smartgondor.com',
+    deviceRegistrationDuration: 'P1M'
+};
+
+describe('NGSI-LD: Value Type', function () {
+    // Case: Expression which results is sent as a new attribute
+    const values = [
+        {
+            name: 'e',
+            type: 'Number',
+            value: 1
+        },
+        {
+            name: 'a',
+            type: 'Property',
+            value: 'foo'
+        },
+        {
+            name: 'u',
+            type: 'Boolean',
+            value: false
+        },
+        {
+            name: 'm',
+            type: 'Object',
+            value: '{"hello": "world"}'
+        },
+        {
+            name: 'r',
+            type: 'Array',
+            value: '[1,2]'
+        },
+        {
+            name: 'd',
+            type: 'Date',
+            value: '2025-07-18'
+        },
+        {
+            name: 't',
+            type: 'Time',
+            value: '14:22:11Z'
+        },
+        {
+            name: 'dt',
+            type: 'Datetime',
+            value: '2025-07-18T14:22:11Z'
+        }
+    ];
+
+    describe('When valueType is set to valueType', function () {
+        beforeEach(function (done) {
+            nock.cleanAll();
+
+            iotAgentConfig.contextBroker.valueType = 'valueType';
+            iotAgentLib.activate(iotAgentConfig, function () {
+                iotAgentLib.clearAll(function () {
+                    done();
+                });
+            });
+
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .matchHeader('fiware-service', 'smartgondor')
+                .matchHeader('fiware-servicepath', 'gardens')
+                .post(
+                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
+                    utils.readExampleFile('./test/unit/ngsi-ld/examples/contextRequests/updateContextValueType1.json')
+                )
+                .reply(204);
+        });
+
+        afterEach(function (done) {
+            iotAgentLib.clearAll(function () {
+                iotAgentLib.deactivate(done);
+            });
+        });
+
+        it('should add valueType to the payload', function (done) {
+            iotAgentLib.update('ws1', 'Light', '', values, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                done();
+            });
+        });
+    });
+    describe('When valueType is set to @type', function () {
+        beforeEach(function (done) {
+            iotAgentConfig.server.ldSupport.dataType = '@type';
+            iotAgentLib.activate(iotAgentConfig, function () {
+                iotAgentLib.clearAll(function () {
+                    done();
+                });
+            });
+            nock.cleanAll();
+
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .matchHeader('fiware-service', 'smartgondor')
+                .matchHeader('fiware-servicepath', 'gardens')
+                .post(
+                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
+                    utils.readExampleFile('./test/unit/ngsi-ld/examples/contextRequests/updateContextValueType2.json')
+                )
+                .reply(204);
+        });
+
+        afterEach(function (done) {
+            iotAgentLib.clearAll(function () {
+                iotAgentLib.deactivate(done);
+            });
+        });
+
+        it('should add @type to the payload', function (done) {
+            iotAgentLib.update('ws1', 'Light', '', values, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                done();
+            });
+        });
+    });
+});

package/test/unit/ngsi-ld/examples/contextRequests/updateContextAutocast1.json

@@ -1,11 +0,0 @@
-[
-    {
-        "@context": "http://context.json-ld",
-        "id": "urn:ngsi-ld:Light:light1",
-        "pressure": {
-            "type": "Property",
-            "value": 23
-        },
-        "type": "Light"
-    }
-]

package/test/unit/ngsi-ld/examples/contextRequests/updateContextAutocast10.json

@@ -1,14 +0,0 @@
-[
-    {
-        "@context": "http://context.json-ld",
-        "date": {
-            "type": "Property",
-            "value": {
-                "@type": "Date",
-                "@value": "2016-04-30"
-            }
-        },
-        "id": "urn:ngsi-ld:Light:light1",
-        "type": "Light"
-    }
-]

package/test/unit/ngsi-ld/examples/contextRequests/updateContextAutocast2.json

@@ -1,11 +0,0 @@
-[
-    {
-        "@context": "http://context.json-ld",
-        "id": "urn:ngsi-ld:Light:light1",
-        "temperature": {
-            "type": "Property",
-            "value": 14.4
-        },
-        "type": "Light"
-    }
-]

package/test/unit/ngsi-ld/examples/contextRequests/updateContextAutocast3.json

@@ -1,11 +0,0 @@
-[
-    {
-        "@context": "http://context.json-ld",
-        "id": "urn:ngsi-ld:Light:light1",
-        "status": {
-            "type": "Property",
-            "value": true
-        },
-        "type": "Light"
-    }
-]

package/test/unit/ngsi-ld/examples/contextRequests/updateContextAutocast4.json

@@ -1,11 +0,0 @@
-[
-    {
-        "@context": "http://context.json-ld",
-        "id": "urn:ngsi-ld:Light:light1",
-        "status": {
-            "type": "Property",
-            "value": false
-        },
-        "type": "Light"
-    }
-]