iotagent-node-lib 2.24.0 → 2.26.0

package/test/unit/ngsi-ld/examples/contextAvailabilityRequests/updateIoTAgent1.json

@@ -1,6 +1,12 @@
 {
     "@context": "http://context.json-ld",
     "endpoint": "http://smartgondor.com",
+    "contextSourceInfo":[
+      {
+        "key": "jsonldContext",
+        "value": "http://context.json-ld"
+      }
+    ],
     "information": [
         {
             "entities": [
@@ -9,10 +15,14 @@
                     "type": "Light"
                 }
             ],
-            "properties": [
+            "propertyNames": [
                 "pressure"
             ]
         }
     ],
+    "mode": "exclusive",
+    "operations": [
+        "retrieveOps"
+    ],
     "type": "ContextSourceRegistration"
 }

package/test/unit/ngsi-ld/examples/contextAvailabilityRequests/updateIoTAgent2.json

@@ -1,6 +1,12 @@
 {
     "@context": "http://context.json-ld",
     "endpoint": "http://smartgondor.com",
+    "contextSourceInfo":[
+      {
+        "key": "jsonldContext",
+        "value": "http://context.json-ld"
+      }
+    ],
     "information": [
         {
             "entities": [
@@ -9,11 +15,16 @@
                     "type": "TheLightType"
                 }
             ],
-            "properties": [
+            "propertyNames": [
                 "luminance",
                 "commandAttr"
             ]
         }
     ],
+    "mode": "exclusive",
+    "operations" : [
+        "retrieveOps",
+        "updateOps"
+    ],
     "type": "ContextSourceRegistration"
 }

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

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

package/test/unit/ngsi-ld/expressions/jexlBasedTransformations-test.js

@@ -321,11 +321,25 @@ describe('NGSI-LD: JEXL', function () {
             }
         ];
 
-        it('should apply the expression before sending the values', function (done) {
+        beforeEach(function () {
+            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/updateContextExpressionPlugin30.json'
+                    )
+                )
+                .reply(204);
+        });
+
+        it('should ignore the expression before sending the values', function (done) {
             iotAgentLib.update('light1', 'LightError', '', values, function (error) {
-                should.exist(error);
-                error.name.should.equal('INVALID_EXPRESSION');
-                error.code.should.equal(400);
+                should.not.exist(error);
+                contextBrokerMock.done();
                 done();
             });
         });

package/test/unit/ngsi-ld/general/deviceService-test.js

@@ -137,7 +137,7 @@ const groupCreation = {
                 apikey: '801230BJKL23Y9090DSFL123HJK09H324HV8732',
                 entity_type: 'TheLightType',
                 trust: '8970A9078A803H3BL98PINEQRW8342HBAMS',
-                cbHost: 'http://unexistentHost:1026',
+                cbHost: 'http://192.168.1.1:1026',
                 commands: [],
                 lazy: [],
                 attributes: [
@@ -187,17 +187,17 @@ describe('NGSI-LD - Device Service: utils', function () {
             // This mock does not check the payload since the aim of the test is not to verify
             // device provisioning functionality. Appropriate verification is done in tests under
             // provisioning folder
-            contextBrokerMock = nock('http://unexistenthost:1026')
+            contextBrokerMock = nock('http://192.168.1.1:1026')
                 .matchHeader('fiware-service', 'testservice')
                 .post('/ngsi-ld/v1/entityOperations/upsert/')
                 .reply(204);
 
-            async.series([request.bind(request, groupCreation), request.bind(request, deviceCreation)], function (
-                error,
-                results
-            ) {
-                done();
-            });
+            async.series(
+                [request.bind(request, groupCreation), request.bind(request, deviceCreation)],
+                function (error, results) {
+                    done();
+                }
+            );
         });
 
         it('should return the existing device', function (done) {
@@ -216,7 +216,7 @@ describe('NGSI-LD - Device Service: utils', function () {
             // This mock does not check the payload since the aim of the test is not to verify
             // device provisioning functionality. Appropriate verification is done in tests under
             // provisioning folder
-            contextBrokerMock = nock('http://unexistenthost:1026')
+            contextBrokerMock = nock('http://192.168.1.1:1026')
                 .matchHeader('fiware-service', 'testservice')
                 .post('/ngsi-ld/v1/entityOperations/upsert/')
                 .reply(204);
@@ -227,32 +227,34 @@ describe('NGSI-LD - Device Service: utils', function () {
         });
 
         it('should register the device and return it', function (done) {
-            iotAgentLib.retrieveDevice('UNEXISTENT_DEV', '801230BJKL23Y9090DSFL123HJK09H324HV8732', function (
-                error,
-                device
-            ) {
-                should.not.exist(error);
-                should.exist(device);
+            iotAgentLib.retrieveDevice(
+                'UNEXISTENT_DEV',
+                '801230BJKL23Y9090DSFL123HJK09H324HV8732',
+                function (error, device) {
+                    should.not.exist(error);
+                    should.exist(device);
 
-                device.id.should.equal('UNEXISTENT_DEV');
-                should.exist(device.protocol);
-                device.protocol.should.equal('MQTT_UL');
-                done();
-            });
+                    device.id.should.equal('UNEXISTENT_DEV');
+                    should.exist(device.protocol);
+                    device.protocol.should.equal('MQTT_UL');
+                    done();
+                }
+            );
         });
     });
 
     describe('When an unexisting device tries to be retrieved for an unexisting APIKey', function () {
         it('should raise an error', function (done) {
-            iotAgentLib.retrieveDevice('UNEXISTENT_DEV_AND_GROUP', 'H2332Y909DSF3H346yh20JK092', function (
-                error,
-                device
-            ) {
-                should.exist(error);
-                error.name.should.equal('DEVICE_GROUP_NOT_FOUND');
-                should.not.exist(device);
-                done();
-            });
+            iotAgentLib.retrieveDevice(
+                'UNEXISTENT_DEV_AND_GROUP',
+                'H2332Y909DSF3H346yh20JK092',
+                function (error, device) {
+                    should.exist(error);
+                    error.name.should.equal('DEVICE_GROUP_NOT_FOUND');
+                    should.not.exist(device);
+                    done();
+                }
+            );
         });
     });
 });

package/test/unit/ngsi-ld/general/startup-test.js

@@ -66,7 +66,7 @@ describe('NGSI-LD - Startup tests', function () {
         beforeEach(function () {
             process.env.IOTA_CB_HOST = 'cbhost';
             process.env.IOTA_CB_PORT = '1111';
-            process.env.IOTA_CB_NGSI_VERSION = 'v2';
+            process.env.IOTA_CB_NGSI_VERSION = 'ld';
             process.env.IOTA_NORTH_HOST = 'localhost';
             process.env.IOTA_NORTH_PORT = '2222';
             process.env.IOTA_PROVIDER_URL = 'provider:3333';
@@ -83,6 +83,11 @@ describe('NGSI-LD - Startup tests', function () {
             process.env.IOTA_MONGO_DB = 'themongodb';
             process.env.IOTA_MONGO_REPLICASET = 'customReplica';
             process.env.IOTA_DEFAULT_RESOURCE = '/iot/custom';
+            process.env.IOTA_JSON_LD_CONTEXT = 'http://context.jsonld';
+            process.env.IOTA_FALLBACK_TENANT = 'openiot';
+            process.env.IOTA_FALLBACK_PATH = 'smartgondor';
+            process.env.IOTA_LD_SUPPORT_NULL = 'false';
+            process.env.IOTA_LD_SUPPORT_DATASET_ID = 'false';
 
             nock.cleanAll();
 
@@ -114,6 +119,11 @@ describe('NGSI-LD - Startup tests', function () {
             delete process.env.IOTA_MONGO_DB;
             delete process.env.IOTA_MONGO_REPLICASET;
             delete process.env.IOTA_DEFAULT_RESOURCE;
+            delete process.env.IOTA_JSON_LD_CONTEXT;
+            delete process.env.IOTA_FALLBACK_TENANT;
+            delete process.env.IOTA_FALLBACK_PATH;
+            delete process.env.IOTA_LD_SUPPORT_NULL;
+            delete process.env.IOTA_LD_SUPPORT_DATASET_ID;
         });
 
         afterEach(function (done) {
@@ -123,7 +133,12 @@ describe('NGSI-LD - Startup tests', function () {
         it('should load the correct configuration parameters', function (done) {
             iotAgentLib.activate(iotAgentConfig, function (error) {
                 config.getConfig().contextBroker.url.should.equal('http://cbhost:1111');
-                config.getConfig().contextBroker.ngsiVersion.should.equal('v2');
+                config.getConfig().contextBroker.ngsiVersion.should.equal('ld');
+                config.getConfig().contextBroker.jsonLdContext.should.equal('http://context.jsonld');
+                config.getConfig().contextBroker.fallbackTenant.should.equal( 'openiot');
+                config.getConfig().contextBroker.fallbackPath.should.equal('smartgondor');
+                config.getConfig().server.ldSupport.null.should.equal(false);
+                config.getConfig().server.ldSupport.datasetId.should.equal(false);
                 config.getConfig().server.host.should.equal('localhost');
                 config.getConfig().server.port.should.equal('2222');
                 config.getConfig().providerUrl.should.equal('provider:3333');

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

@@ -184,7 +184,6 @@ describe('NGSI-LD - Command functionalities', function () {
         };
 
         beforeEach(function (done) {
-            logger.setLevel('ERROR');
             iotAgentLib.register(device3, function (error) {
                 done();
             });
@@ -287,7 +286,6 @@ describe('NGSI-LD - Command functionalities', function () {
         };
 
         beforeEach(function (done) {
-            logger.setLevel('ERROR');
             iotAgentLib.register(device3, function (error) {
                 done();
             });
@@ -368,7 +366,7 @@ describe('NGSI-LD - Command functionalities', function () {
     describe('When a sequential command with datasetId updates via PATCH  /attrs/attr-name arrives to the IoT Agent', function () {
         const options = {
             url: 'http://localhost:' + iotAgentConfig.server.port + '/ngsi-ld/v1/entities/urn:ngsi-ld:Robot:r2d2/attrs',
-            method: 'PUT',
+            method: 'PATCH',
             json: {
                 position: [
                     {
@@ -390,7 +388,6 @@ describe('NGSI-LD - Command functionalities', function () {
         };
 
         beforeEach(function (done) {
-            logger.setLevel('ERROR');
             iotAgentLib.register(device3, function (error) {
                 done();
             });
@@ -496,7 +493,6 @@ describe('NGSI-LD - Command functionalities', function () {
         };
 
         beforeEach(function (done) {
-            logger.setLevel('ERROR');
             iotAgentLib.register(device3, function (error) {
                 done();
             });
@@ -594,7 +590,6 @@ describe('NGSI-LD - Command functionalities', function () {
         };
 
         beforeEach(function (done) {
-            logger.setLevel('ERROR');
             iotAgentLib.register(device3, function (error) {
                 done();
             });
@@ -691,7 +686,6 @@ describe('NGSI-LD - Command functionalities', function () {
         };
 
         beforeEach(function (done) {
-            logger.setLevel('ERROR');
             iotAgentLib.register(device3, function (error) {
                 done();
             });
@@ -794,7 +788,6 @@ describe('NGSI-LD - Command functionalities', function () {
         };
 
         beforeEach(function (done) {
-            logger.setLevel('ERROR');
             iotAgentLib.register(device3, function (error) {
                 done();
             });
@@ -902,7 +895,6 @@ describe('NGSI-LD - Command functionalities', function () {
         };
 
         beforeEach(function (done) {
-            logger.setLevel('ERROR');
             iotAgentLib.register(device3, function (error) {
                 done();
             });
@@ -1006,7 +998,6 @@ describe('NGSI-LD - Command functionalities', function () {
         };
 
         beforeEach(function (done) {
-            logger.setLevel('ERROR');
             iotAgentLib.register(device3, function (error) {
                 done();
             });
@@ -1104,7 +1095,6 @@ describe('NGSI-LD - Command functionalities', function () {
         };
 
         beforeEach(function (done) {
-            logger.setLevel('ERROR');
             iotAgentLib.register(device3, function (error) {
                 done();
             });
@@ -1246,7 +1236,6 @@ describe('NGSI-LD - Command functionalities', function () {
         };
 
         beforeEach(function (done) {
-            logger.setLevel('ERROR');
             iotAgentLib.register(device3, function (error) {
                 done();
             });

package/test/unit/ngsi-ld/lazyAndCommands/merge-patch-test.js

@@ -0,0 +1,249 @@
+/*
+ * Copyright 2020 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]
+ *
+ * Modified by: Jason Fox - FIWARE Foundation
+ */
+
+/* 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');
+const mongoUtils = require('../../mongodb/mongoDBUtils');
+
+const timekeeper = require('timekeeper');
+let contextBrokerMock;
+let statusAttributeMock;
+const iotAgentConfig = {
+    contextBroker: {
+        host: '192.168.1.1',
+        port: '1026',
+        ngsiVersion: 'ld',
+        jsonLdContext: 'http://context.json-ld'
+    },
+    server: {
+        port: 4041,
+        ldSupport: {
+            null: true,
+            datasetId: false,
+            merge: true
+        }
+    },
+    types: {
+        Robot: {
+            internalAttributes:[],
+            commands:[
+                {
+                    name: 'position',
+                    object_id: 'pos',
+                    type: 'Object'
+                },
+                {
+                    name: 'orientation',
+                    type: 'Object'
+                }
+            ],
+            lazy: [
+                {
+                    name: 'batteryLevel',
+                    type: 'Object'
+                }
+            ],
+            staticAttributes: [],
+            active: []
+        }
+    },
+    service: 'smartgondor',
+    providerUrl: 'http://smartgondor.com'
+};
+const device3 = {
+    id: 'r2d2',
+    type: 'Robot',
+    service: 'smartgondor'
+};
+
+describe('NGSI-LD - Merge-Patch functionalities', function () {
+    beforeEach(function (done) {
+        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')
+            .post(
+                '/ngsi-ld/v1/csourceRegistrations/',
+                utils.readExampleFile(
+                    './test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerIoTAgentCommandsAndLazy.json'
+                )
+            )
+            .reply(201, null, { Location: '/ngsi-ld/v1/csourceRegistrations/6319a7f5254b05844116584d' });
+
+        contextBrokerMock
+            .matchHeader('fiware-service', 'smartgondor')
+            .post('/ngsi-ld/v1/entityOperations/upsert/')
+            .reply(204);
+
+        iotAgentLib.activate(iotAgentConfig, done);
+    });
+
+    afterEach(function (done) {
+        timekeeper.reset();
+        delete device3.registrationId;
+        iotAgentLib.clearAll(function () {
+            iotAgentLib.deactivate(function () {
+                mongoUtils.cleanDbs(function () {
+                    nock.cleanAll();
+                    iotAgentLib.setDataUpdateHandler();
+                    iotAgentLib.setCommandHandler();
+                    done();
+                });
+            });
+        });
+    });
+
+    describe('When a merge-patch PATCH  arrives to the IoT Agent as Context Provider', function () {
+        const options = {
+            url:
+                'http://localhost:' +
+                iotAgentConfig.server.port +
+                '/ngsi-ld/v1/entities/urn:ngsi-ld:Robot:r2d2',
+            method: 'PATCH',
+            json: {
+                "position": {
+                    "type": "Property",
+                    "value": {
+                        "moveTo" : [12,34],
+                        "observedAt": "urn:ngsi-ld:null",
+                        "precision": {
+                            "value": 0.95,
+                            "unitCode": "C62"
+                        } 
+                    } 
+                },
+                "orientation" : "urn:ngsi-ld:null"
+            },
+            headers: {
+                'fiware-service': 'smartgondor',
+                'content-type': 'application/ld+json'
+            }
+        };
+
+        beforeEach(function (done) {
+            iotAgentLib.register(device3, function (error) {
+                done();
+            });
+        });
+
+        it('should call the client handler once', function (done) {
+            let handlerCalled = 0;
+
+            iotAgentLib.setMergePatchHandler(function (id, type, service, subservice, attributes, callback) {
+                id.should.equal('urn:ngsi-ld:' + device3.type + ':' + device3.id);
+                type.should.equal(device3.type);
+                attributes[0].name.should.equal('position');
+                attributes[1].name.should.equal('orientation');
+                should.equal(attributes[1].value, null);
+                handlerCalled++;
+                callback(null, {
+                    id,
+                    type,
+                    attributes: [
+                        {
+                            name: 'position',
+                            type: 'Array',
+                            value: '[28, -104, 23]'
+                        }
+                    ]
+                });
+            });
+
+            request(options, function (error, response, body) {
+                should.not.exist(error);
+                response.statusCode.should.equal(200);
+                handlerCalled.should.equal(1);
+                done();
+            });
+        });
+    });
+
+
+    xdescribe('When a partial update PATCH with an NGSI-LD Null arrives to the IoT Agent as Context Provider', function () {
+        const options = {
+            url:
+                'http://localhost:' +
+                iotAgentConfig.server.port +
+                '/ngsi-ld/v1/entities/urn:ngsi-ld:Robot:r2d2/attrs/position',
+            method: 'PATCH',
+            json: {
+                "type": "Property",
+                "value": "urn:ngsi-ld:null"
+            },
+            headers: {
+                'fiware-service': 'smartgondor',
+                'content-type': 'application/ld+json'
+            }
+        };
+
+        beforeEach(function (done) {
+            logger.setLevel('FATAL');
+            iotAgentLib.register(device3, function (error) {
+                done();
+            });
+        });
+
+        it('should call the client handler once', function (done) {
+            let handlerCalled = 0;
+
+            iotAgentLib.setCommandHandler(function (id, type, service, subservice, attributes, callback) {
+                id.should.equal('urn:ngsi-ld:' + device3.type + ':' + device3.id);
+                type.should.equal(device3.type);
+                attributes[0].name.should.equal('position');
+                should.equal(attributes[0].value, null);
+                handlerCalled++;
+                callback(null, {
+                    id,
+                    type,
+                    attributes: [
+                        {
+                            name: 'position',
+                            type: 'Array',
+                            value: null
+                        }
+                    ]
+                });
+            });
+
+            request(options, function (error, response, body) {
+                console.error(error)
+                should.not.exist(error);
+
+
+                response.statusCode.should.equal(204);
+                handlerCalled.should.equal(1);
+                done();
+            });
+        });
+    });
+});