iotagent-node-lib 4.9.0 → 4.10.0

package/lib/templates/updateDevice.json

@@ -157,6 +157,10 @@
               "description": "use CB flowControl option",
               "type": "boolean"
           },
+          "cmdMode": {
+              "description": "CB commands mode",
+              "type": "string"
+          },
           "contentType": {
               "description": "Content type",
               "type": "string"
@@ -203,6 +207,10 @@
         "description": "Payload type allowed for measures for this device",
         "type": "string"
     },
+    "useCBflowControl": {
+        "description": "use CB flowControl option",
+        "type": "boolean"
+    },
     "storeLastMeasure": {
       "description": "Store last measure",
       "type": "boolean"
@@ -210,6 +218,10 @@
     "lastMeasure": {
       "description": "last measure",
       "type": "object"
+    },
+    "cmdMode": {
+        "description": "CB commands mode",
+        "type": "string"
     }
   }
 }

package/lib/templates/updateDeviceLax.json

@@ -158,6 +158,10 @@
     "lastMeasure": {
       "description": "last measure",
       "type": "object"
+    },
+    "cmdMode": {
+        "description": "CB commands mode",
+        "type": "string"
     }
   }
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "iotagent-node-lib",
   "license": "AGPL-3.0-only",
   "description": "IoT Agent library to interface with NGSI Context Broker",
-  "version": "4.9.0",
+  "version": "4.10.0",
   "homepage": "https://github.com/telefonicaid/iotagent-node-lib",
   "keywords": [
     "fiware",
@@ -23,7 +23,7 @@
   },
   "main": "lib/fiware-iotagent-lib",
   "engines": {
-    "node": ">=16"
+    "node": ">=20"
   },
   "scripts": {
     "clean": "rm -rf package-lock.json && rm -rf node_modules && rm -rf coverage",

package/test/unit/general/contextBrokerKeystoneSecurityAccess-test.js

@@ -295,7 +295,7 @@ describe('NGSI-v2 - Secured access to the Context Broker with Keystone', functio
 
         it('subscribe requests use auth header', function (done) {
             iotAgentLib.getDevice('Light1', null, 'smartgondor', 'electricity', function (error, device) {
-                iotAgentLib.subscribe(device, ['dimming'], null, function (error) {
+                iotAgentLib.subscribe(device, ['dimming'], null, 'normalized', function (error) {
                     should.not.exist(error);
 
                     contextBrokerMock.done();
@@ -316,7 +316,7 @@ describe('NGSI-v2 - Secured access to the Context Broker with Keystone', functio
                 });
 
             iotAgentLib.getDevice('Light1', null, 'smartgondor', 'electricity', function (error, device) {
-                iotAgentLib.subscribe(device, ['dimming'], null, function (error) {
+                iotAgentLib.subscribe(device, ['dimming'], null, 'normalized', function (error) {
                     iotAgentLib.unsubscribe(device, '51c0ac9ed714fb3b37d7d5a8', function (error) {
                         contextBrokerMock.done();
                         done();

package/test/unit/memoryRegistry/deviceRegistryMemory_test.js

@@ -243,7 +243,7 @@ describe('NGSI-v2 - In memory device registry', function () {
                 should.exist(device.type);
                 device.name.should.equal('name5');
                 device.type.should.equal('Light5');
-                Object.keys(device).length.should.equal(12);
+                Object.keys(device).length.should.equal(13);
                 done();
             });
         });

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

@@ -309,7 +309,7 @@ describe('NGSI-LD - Secured access to the Context Broker with OAuth2 provider',
 
         it('subscribe requests use auth header', function (done) {
             iotAgentLib.getDevice('Light1', null, 'smartgondor', 'electricity', function (error, device) {
-                iotAgentLib.subscribe(device, ['dimming'], null, function (error) {
+                iotAgentLib.subscribe(device, ['dimming'], null, 'normalized', function (error) {
                     should.not.exist(error);
 
                     contextBrokerMock.done();
@@ -330,7 +330,7 @@ describe('NGSI-LD - Secured access to the Context Broker with OAuth2 provider',
             contextBrokerMock.delete('/ngsi-ld/v1/subscriptions/51c0ac9ed714fb3b37d7d5a8', '').reply(204);
 
             iotAgentLib.getDevice('Light1', null, 'smartgondor', 'electricity', function (error, device) {
-                iotAgentLib.subscribe(device, ['dimming'], null, function (error) {
+                iotAgentLib.subscribe(device, ['dimming'], null, 'normalized', function (error) {
                     iotAgentLib.unsubscribe(device, '51c0ac9ed714fb3b37d7d5a8', function (error) {
                         contextBrokerMock.done();
                         done();

package/test/unit/ngsi-ld/general/https-support-test.js

@@ -214,7 +214,7 @@ describe('NGSI-LD - HTTPS support tests', function () {
 
         it('should send the appropriate request to the Context Broker', function (done) {
             iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
-                iotAgentLib.subscribe(device, ['attr_name'], null, function (error) {
+                iotAgentLib.subscribe(device, ['attr_name'], null, 'normalized', function (error) {
                     should.not.exist(error);
 
                     contextBrokerMock.done();

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

@@ -94,7 +94,7 @@ describe('NGSI-LD - Subscription tests', function () {
     describe('When a client invokes the subscribe() function for device', function () {
         it('should send the appropriate request to the Context Broker', function (done) {
             iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
-                iotAgentLib.subscribe(device, ['attr_name'], null, function (error) {
+                iotAgentLib.subscribe(device, ['attr_name'], null, 'normalized', function (error) {
                     should.not.exist(error);
 
                     contextBrokerMock.done();
@@ -105,7 +105,7 @@ describe('NGSI-LD - Subscription tests', function () {
         });
         it('should store the subscription ID in the Device Registry', function (done) {
             iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
-                iotAgentLib.subscribe(device, ['attr_name'], null, function (error) {
+                iotAgentLib.subscribe(device, ['attr_name'], null, 'normalized', function (error) {
                     iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
                         should.not.exist(error);
                         should.exist(device);
@@ -131,7 +131,7 @@ describe('NGSI-LD - Subscription tests', function () {
 
         it('should delete the subscription from the CB', function (done) {
             iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
-                iotAgentLib.subscribe(device, ['attr_name'], null, function (error) {
+                iotAgentLib.subscribe(device, ['attr_name'], null, 'normalized', function (error) {
                     iotAgentLib.unsubscribe(device, '51c0ac9ed714fb3b37d7d5a8', function (error) {
                         iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
                             contextBrokerMock.done();
@@ -143,7 +143,7 @@ describe('NGSI-LD - Subscription tests', function () {
         });
         it('should remove the id from the subscriptions array', function (done) {
             iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
-                iotAgentLib.subscribe(device, ['attr_name'], null, function (error) {
+                iotAgentLib.subscribe(device, ['attr_name'], null, 'normalized', function (error) {
                     iotAgentLib.unsubscribe(device, '51c0ac9ed714fb3b37d7d5a8', function (error) {
                         iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
                             should.not.exist(error);
@@ -169,7 +169,7 @@ describe('NGSI-LD - Subscription tests', function () {
 
         it('should delete the subscription from the CB', function (done) {
             iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
-                iotAgentLib.subscribe(device, ['attr_name'], null, function (error) {
+                iotAgentLib.subscribe(device, ['attr_name'], null, 'normalized', function (error) {
                     iotAgentLib.unregister(device.id, null, 'smartgondor', '/gardens', function (error) {
                         contextBrokerMock.done();
                         done();
@@ -181,7 +181,7 @@ describe('NGSI-LD - Subscription tests', function () {
     describe('When a new notification comes to the IoTAgent', function () {
         beforeEach(function (done) {
             iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
-                iotAgentLib.subscribe(device, ['attr_name'], null, function (error) {
+                iotAgentLib.subscribe(device, ['attr_name'], null, 'normalized', function (error) {
                     done();
                 });
             });

package/test/unit/ngsiv2/examples/contextAvailabilityRequests/subscribeIoTAgentCommands.json

@@ -0,0 +1,24 @@
+{
+    "description": "Managed by IOTA: Robot:r2d2 Robot position",
+    "subject": {
+        "entities":[
+            {
+                "id":"Robot:r2d2","type":"Robot"
+            }
+        ],
+        "condition": {
+            "attrs":["position"]
+        }
+    },
+    "notification":{
+        "http":{
+            "url":"http://smartgondor.com/notify"
+        },
+        "attrs":["position"],
+        "attrsFormat":"simplifiedNormalized",
+        "onlyChangedAttrs":true
+    }
+}
+
+
+

package/test/unit/ngsiv2/examples/contextAvailabilityRequests/subscribeIoTAgentCommands2.json

@@ -0,0 +1,24 @@
+{
+    "description": "Managed by IOTA: RobotT:r2d3 RobotT position",
+    "subject": {
+        "entities":[
+            {
+                "id":"RobotT:r2d3","type":"RobotT"
+            }
+        ],
+        "condition": {
+            "attrs":["position"]
+        }
+    },
+    "notification":{
+        "http":{
+            "url":"http://smartgondor.com/notify"
+        },
+        "attrs":["position"],
+        "attrsFormat":"simplifiedNormalized",
+        "onlyChangedAttrs":true
+    }
+}
+
+
+

package/test/unit/ngsiv2/examples/contextAvailabilityRequests/subscribeIoTAgentCommands3.json

@@ -0,0 +1,24 @@
+{
+    "description": "Managed by IOTA: RobotT:r2d4 RobotT position",
+    "subject": {
+        "entities":[
+            {
+                "id":"RobotT:r2d4","type":"RobotT"
+            }
+        ],
+        "condition": {
+            "attrs":["position"]
+        }
+    },
+    "notification":{
+        "http":{
+            "url":"http://smartgondor.com/notify"
+        },
+        "attrs":["position"],
+        "attrsFormat":"simplifiedNormalized",
+        "onlyChangedAttrs":true
+    }
+}
+
+
+

package/test/unit/ngsiv2/examples/contextAvailabilityRequests/subscribeIoTAgentCommands4.json

@@ -0,0 +1,24 @@
+{
+    "description": "Managed by IOTA: RobotT:r2d3 RobotT reset",
+    "subject": {
+        "entities":[
+            {
+                "id":"RobotT:r2d3","type":"RobotT"
+            }
+        ],
+        "condition": {
+            "attrs":["reset"]
+        }
+    },
+    "notification":{
+        "http":{
+            "url":"http://smartgondor.com/notify"
+        },
+        "attrs":["reset"],
+        "attrsFormat":"simplifiedNormalized",
+        "onlyChangedAttrs":true
+    }
+}
+
+
+

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

@@ -0,0 +1,5 @@
+{
+    "id":"Robot:r2d2",
+    "type":"Robot",
+    "position":{"type":"command","value":null}
+}

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

@@ -0,0 +1,5 @@
+{
+    "id":"RobotT:r2d3",
+    "type":"RobotT",
+    "position":{"type":"command","value":null}
+}

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

@@ -0,0 +1,7 @@
+{
+    "pressure":{"type":"Hgmm","value":null},
+    "reset": {
+        "type": "command",
+        "value": null
+    }
+}

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

@@ -0,0 +1,5 @@
+{
+    "id":"RobotT:r2d4",
+    "type":"RobotT",
+    "position":{"type":"command","value":null}
+}

package/test/unit/ngsiv2/examples/subscriptionRequests/simpleSubscriptionRequest.json

@@ -1,4 +1,5 @@
 {
+  "description": "Managed by IOTA: FirstMicroLight MicroLights attr_name",
   "subject": {
     "entities": [
       {
@@ -17,6 +18,7 @@
       "url": "http://smartgondor.com/notify"
     },
     "attrs": [],
-    "attrsFormat": "normalized"
+      "attrsFormat": "normalized",
+      "onlyChangedAttrs": true
   }
-}
+}

package/test/unit/ngsiv2/examples/subscriptionRequests/simpleSubscriptionRequest2.json

@@ -1,4 +1,5 @@
 {
+  "description": "Managed by IOTA: light1 Light dimming",
   "subject": {
     "entities": [
       {
@@ -17,6 +18,7 @@
       "url": "http://smartgondor.com/notify"
     },
     "attrs": [],
-    "attrsFormat": "normalized"
+    "attrsFormat": "normalized",
+    "onlyChangedAttrs": true
   }
-}
+}

package/test/unit/ngsiv2/general/contextBrokerOAuthSecurityAccess-test.js

@@ -312,7 +312,7 @@ describe('NGSI-v2 - Secured access to the Context Broker with OAuth2 provider',
 
         it('subscribe requests use auth header', function (done) {
             iotAgentLib.getDevice('Light1', null, 'smartgondor', 'electricity', function (error, device) {
-                iotAgentLib.subscribe(device, ['dimming'], null, function (error) {
+                iotAgentLib.subscribe(device, ['dimming'], null, 'normalized', function (error) {
                     should.not.exist(error);
 
                     contextBrokerMock.done();
@@ -333,7 +333,7 @@ describe('NGSI-v2 - Secured access to the Context Broker with OAuth2 provider',
             contextBrokerMock.delete('/v2/subscriptions/51c0ac9ed714fb3b37d7d5a8', '').reply(204);
 
             iotAgentLib.getDevice('Light1', null, 'smartgondor', 'electricity', function (error, device) {
-                iotAgentLib.subscribe(device, ['dimming'], null, function (error) {
+                iotAgentLib.subscribe(device, ['dimming'], null, 'normalized', function (error) {
                     iotAgentLib.unsubscribe(device, '51c0ac9ed714fb3b37d7d5a8', function (error) {
                         contextBrokerMock.done();
                         done();

package/test/unit/ngsiv2/general/https-support-test.js

@@ -211,7 +211,7 @@ describe('NGSI-v2 - HTTPS support tests', function () {
 
         it('should send the appropriate request to the Context Broker', function (done) {
             iotAgentLib.getDevice('MicroLight1', null, 'smartgondor', '/gardens', function (error, device) {
-                iotAgentLib.subscribe(device, ['attr_name'], null, function (error) {
+                iotAgentLib.subscribe(device, ['attr_name'], null, 'normalized', function (error) {
                     should.not.exist(error);
 
                     contextBrokerMock.done();

package/test/unit/ngsiv2/lazyAndCommands/command-test.js

@@ -31,6 +31,7 @@ const request = utils.request;
 const should = require('should');
 const logger = require('logops');
 const nock = require('nock');
+const async = require('async');
 const mongoUtils = require('../../mongodb/mongoDBUtils');
 
 const timekeeper = require('timekeeper');
@@ -99,18 +100,98 @@ const iotAgentConfig = {
             lazy: [],
             staticAttributes: [],
             active: []
+        },
+        RobotT: {
+            commands: [
+                {
+                    name: 'position',
+                    type: 'Array'
+                }
+            ],
+            lazy: [],
+            staticAttributes: [],
+            active: [],
+            cmdMode: 'notification'
         }
     },
     service: 'smartgondor',
     subservice: 'gardens',
     providerUrl: 'http://smartgondor.com',
-    useCBflowControl: true
+    useCBflowControl: true,
+    cmdMode: 'legacy'
 };
 const device3 = {
     id: 'r2d2',
     type: 'Robot',
     service: 'smartgondor',
-    subservice: 'gardens'
+    subservice: 'gardens',
+    cmdMode: 'legacy'
+};
+
+const device4 = {
+    id: 'r2d2',
+    type: 'Robot',
+    service: 'smartgondor',
+    subservice: 'gardens',
+    cmdMode: 'notification',
+    apikey: null
+};
+
+const device5 = {
+    id: 'r2d3',
+    type: 'RobotT',
+    service: 'smartgondor',
+    subservice: 'gardens',
+    apikey: null,
+    cmdMode: 'notification'
+};
+
+const device5old = {
+    id: 'r2d3',
+    name: 'RobotT:r2d3',
+    type: 'RobotT',
+    service: 'smartgondor',
+    subservice: 'gardens',
+    apikey: null,
+    cmdMode: 'notification',
+    commands: [
+        {
+            name: 'position',
+            type: 'Array'
+        }
+    ],
+    subscriptions: [{ id: '6319a7f5254b05844116584d', triggers: ['position'] }],
+    subscriptionId: '6319a7f5254b05844116584d'
+};
+
+const device5updated = {
+    id: 'r2d3',
+    name: 'RobotT:r2d3',
+    type: 'RobotT',
+    service: 'smartgondor',
+    subservice: 'gardens',
+    apikey: null,
+    active: [
+        {
+            name: 'pressure',
+            type: 'Hgmm'
+        }
+    ],
+    commands: [
+        {
+            name: 'reset',
+            type: 'Array'
+        }
+    ],
+    cmdMode: 'notification'
+};
+
+const device6 = {
+    id: 'r2d4',
+    type: 'RobotT',
+    service: 'smartgondor',
+    subservice: 'gardens',
+    apikey: null
 };
 
 describe('NGSI-v2 - Command functionalities', function () {
@@ -414,3 +495,165 @@ describe('NGSI-v2 - Command functionalities', function () {
         });
     });
 });
+
+describe('NGSI-v2 - Command notification functionalities', 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/subscriptions',
+                utils.readExampleFile(
+                    './test/unit/ngsiv2/examples/contextAvailabilityRequests/subscribeIoTAgentCommands.json'
+                )
+            )
+            .reply(201, null, { Location: '/v2/subscriptions/6319a7f5254b05844116584d' });
+
+        contextBrokerMock
+            .matchHeader('fiware-service', 'smartgondor')
+            .matchHeader('fiware-servicepath', 'gardens')
+            .post(
+                '/v2/entities?options=upsert',
+                utils.readExampleFile('./test/unit/ngsiv2/examples/contextRequests/updateEntity.json')
+            )
+            .reply(204);
+        iotAgentConfig.cmdMode = 'notification';
+        iotAgentLib.activate(iotAgentConfig, done);
+    });
+
+    afterEach(function (done) {
+        iotAgentLib.clearAll(function () {
+            iotAgentLib.deactivate(function () {
+                mongoUtils.cleanDbs(function () {
+                    nock.cleanAll();
+                    iotAgentLib.setDataUpdateHandler();
+                    iotAgentLib.setCommandHandler();
+                    done();
+                });
+            });
+        });
+    });
+
+    describe('When a device with commands by notifications is registered with with commands', function () {
+        it('should subscribe a Context Provider of the commands', function (done) {
+            iotAgentLib.register(device4, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                done();
+            });
+        });
+    });
+});
+
+describe('NGSI-v2 - Command update subscription and notification functionalities', function () {
+    afterEach(function (done) {
+        iotAgentLib.clearAll(function () {
+            iotAgentLib.deactivate(done);
+        });
+    });
+
+    describe('When a device with commands by notifications is registered with with commands and its updated', function () {
+        beforeEach(function (done) {
+            logger.setLevel('FATAL');
+            nock.cleanAll();
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .post(
+                    '/v2/subscriptions',
+                    utils.readExampleFile(
+                        './test/unit/ngsiv2/examples/contextAvailabilityRequests/subscribeIoTAgentCommands2.json'
+                    )
+                )
+                .reply(201, null, { Location: '/v2/subscriptions/6319a7f5254b05844116584d' });
+            contextBrokerMock
+                .matchHeader('fiware-service', 'smartgondor')
+                .matchHeader('fiware-servicepath', 'gardens')
+                .post(
+                    '/v2/entities?options=upsert',
+                    utils.readExampleFile('./test/unit/ngsiv2/examples/contextRequests/updateEntity2.json')
+                )
+                .reply(204);
+
+            contextBrokerMock
+                .post(
+                    '/v2/subscriptions',
+                    utils.readExampleFile(
+                        './test/unit/ngsiv2/examples/contextAvailabilityRequests/subscribeIoTAgentCommands4.json'
+                    )
+                )
+                .reply(201, null, { Location: '/v2/subscriptions/6319a7f5254b05844116584d' });
+            contextBrokerMock
+                .matchHeader('fiware-service', 'smartgondor')
+                .matchHeader('fiware-servicepath', 'gardens')
+                .post(
+                    '/v2/entities/RobotT:r2d3/attrs?type=RobotT',
+                    utils.readExampleFile('./test/unit/ngsiv2/examples/contextRequests/updateEntity2b.json')
+                )
+                .reply(204);
+            contextBrokerMock
+                .matchHeader('fiware-service', 'smartgondor')
+                .matchHeader('fiware-servicepath', 'gardens')
+                .delete('/v2/subscriptions/6319a7f5254b05844116584d')
+                .reply(204, null, { Location: '/v2/subscriptions/6319a7f5254b05844116584d' });
+
+            iotAgentLib.activate(iotAgentConfig, function (error) {
+                async.series([async.apply(iotAgentLib.clearAll), async.apply(iotAgentLib.register, device5)], done);
+            });
+        });
+
+        it('should update subscription in a Context Provider of the commands', function (done) {
+            iotAgentLib.updateRegister(device5updated, device5old, false, function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                done();
+            });
+        });
+    });
+});
+
+describe('NGSI-v2 - Command unsubscribe notification functionalities', function () {
+    afterEach(function (done) {
+        iotAgentLib.clearAll(function () {
+            iotAgentLib.deactivate(done);
+        });
+    });
+
+    describe('When a device with commands by notifications is registered with with commands', function () {
+        beforeEach(function (done) {
+            logger.setLevel('FATAL');
+            nock.cleanAll();
+            contextBrokerMock = nock('http://192.168.1.1:1026')
+                .post(
+                    '/v2/subscriptions',
+                    utils.readExampleFile(
+                        './test/unit/ngsiv2/examples/contextAvailabilityRequests/subscribeIoTAgentCommands3.json'
+                    )
+                )
+                .reply(201, null, { Location: '/v2/subscriptions/6319a7f5254b05844116584d' });
+            contextBrokerMock
+                .matchHeader('fiware-service', 'smartgondor')
+                .matchHeader('fiware-servicepath', 'gardens')
+                .post(
+                    '/v2/entities?options=upsert',
+                    utils.readExampleFile('./test/unit/ngsiv2/examples/contextRequests/updateEntity3.json')
+                )
+                .reply(204);
+            contextBrokerMock
+                .delete('/v2/subscriptions/6319a7f5254b05844116584d')
+                .reply(204, null, { Location: '/v2/subscriptions/6319a7f5254b05844116584d' });
+            iotAgentLib.activate(iotAgentConfig, function (error) {
+                async.series([async.apply(iotAgentLib.clearAll), async.apply(iotAgentLib.register, device6)], done);
+            });
+        });
+
+        it('should unsubscribe a Context Provider of the commands', function (done) {
+            iotAgentLib.unregister(device6.id, null, 'smartgondor', 'gardens', function (error) {
+                should.not.exist(error);
+                contextBrokerMock.done();
+                done();
+            });
+        });
+    });
+});