iotagent-node-lib 4.8.0 → 4.10.0

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/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();
+            });
+        });
+    });
+});