iotagent-node-lib 4.5.0 → 4.7.0

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

@@ -76,7 +76,8 @@ const iotAgentConfig = {
     },
     service: 'smartgondor',
     subservice: 'gardens',
-    providerUrl: 'http://smartgondor.com'
+    providerUrl: 'http://smartgondor.com',
+    useCBflowControl: true
 };
 const device1 = {
     id: 'light1',
@@ -215,7 +216,7 @@ describe('NGSI-v2 - IoT Agent Device Registration', function () {
             contextBrokerMock
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', 'gardens')
-                .post('/v2/entities?options=upsert')
+                .post('/v2/entities?options=upsert,flowControl')
                 .reply(204);
 
             iotAgentLib.activate(iotAgentConfig, function (error) {
@@ -321,7 +322,7 @@ describe('NGSI-v2 - IoT Agent Device Registration', 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.post('/v2/entities?options=upsert').reply(204);
+            contextBrokerMock.post('/v2/entities?options=upsert,flowControl').reply(204);
 
             contextBrokerMock = nock('http://192.168.1.1:1026')
                 .post('/v2/registrations')
@@ -330,7 +331,7 @@ describe('NGSI-v2 - IoT Agent Device Registration', 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.post('/v2/entities?options=upsert').reply(204);
+            contextBrokerMock.post('/v2/entities?options=upsert,flowControl').reply(204);
 
             contextBrokerMock.delete('/v2/registrations/6319a7f5254b05844116584d', '').reply(500);
 

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

@@ -48,7 +48,8 @@ const iotAgentConfig = {
     types: {},
     service: 'smartgondor',
     subservice: 'gardens',
-    providerUrl: 'http://smartgondor.com'
+    providerUrl: 'http://smartgondor.com',
+    useCBflowControl: true
 };
 
 describe('NGSI-v2 - Device provisioning API: List provisioned devices', function () {
@@ -96,7 +97,7 @@ describe('NGSI-v2 - Device provisioning API: List provisioned devices', 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.post('/v2/entities?options=upsert').reply(204);
+            contextBrokerMock.post('/v2/entities?options=upsert,flowControl').reply(204);
 
             contextBrokerMock
                 .post('/v2/registrations')
@@ -105,7 +106,7 @@ describe('NGSI-v2 - Device provisioning API: List provisioned devices', 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.post('/v2/entities?options=upsert').reply(204);
+            contextBrokerMock.post('/v2/entities?options=upsert,flowControl').reply(204);
 
             contextBrokerMock
                 .post('/v2/registrations')
@@ -114,7 +115,7 @@ describe('NGSI-v2 - Device provisioning API: List provisioned devices', 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.post('/v2/entities?options=upsert').reply(204);
+            contextBrokerMock.post('/v2/entities?options=upsert,flowControl').reply(204);
 
             async.series(
                 [
@@ -183,11 +184,9 @@ describe('NGSI-v2 - Device provisioning API: List provisioned devices', function
                 should.exist(body.devices[2].attributes[0].entity_name);
                 should.exist(body.devices[2].attributes[0].entity_type);
                 should.exist(body.devices[2].attributes[1].expression);
-                should.exist(body.devices[2].attributes[2].reverse);
                 body.devices[2].attributes[0].entity_name.should.equal('Higro2000');
                 body.devices[2].attributes[0].entity_type.should.equal('Higrometer');
                 body.devices[2].attributes[1].expression.should.equal('${@humidity * 20}');
-                body.devices[2].attributes[2].reverse.length.should.equal(2);
                 done();
             });
         });
@@ -242,11 +241,9 @@ describe('NGSI-v2 - Device provisioning API: List provisioned devices', function
                 should.exist(body.attributes[0].entity_name);
                 should.exist(body.attributes[0].entity_type);
                 should.exist(body.attributes[1].expression);
-                should.exist(body.attributes[2].reverse);
                 body.attributes[0].entity_name.should.equal('Higro2000');
                 body.attributes[0].entity_type.should.equal('Higrometer');
                 body.attributes[1].expression.should.equal('${@humidity * 20}');
-                body.attributes[2].reverse.length.should.equal(2);
                 done();
             });
         });
@@ -312,7 +309,7 @@ describe('NGSI-v2 - Device provisioning API: List provisioned devices', 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.post('/v2/entities?options=upsert').times(10).reply(204);
+            contextBrokerMock.post('/v2/entities?options=upsert,flowControl').times(10).reply(204);
 
             iotAgentLib.clearAll(function () {
                 async.times(10, createDeviceRequest, function (error, results) {

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

@@ -84,7 +84,7 @@ describe('NGSI-v2 - Device provisioning API: Provision devices', function () {
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
                 .post(
-                    '/v2/entities?options=upsert',
+                    '/v2/entities?options=upsert,flowControl',
                     utils.readExampleFile(
                         './test/unit/ngsiv2/examples/contextRequests/createProvisionedDeviceMultientity.json'
                     )

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

@@ -48,7 +48,8 @@ const iotAgentConfig = {
     types: {},
     service: 'smartgondor',
     subservice: 'gardens',
-    providerUrl: 'http://smartgondor.com'
+    providerUrl: 'http://smartgondor.com',
+    useCBflowControl: true
 };
 
 describe('NGSI-v2 - Device provisioning API: Remove provisioned devices', function () {
@@ -97,7 +98,7 @@ describe('NGSI-v2 - Device provisioning API: Remove provisioned devices', functi
             contextBrokerMock
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
-                .post('/v2/entities?options=upsert')
+                .post('/v2/entities?options=upsert,flowControl')
                 .reply(204);
 
             const nockBody2 = utils.readExampleFile(
@@ -115,7 +116,7 @@ describe('NGSI-v2 - Device provisioning API: Remove provisioned devices', functi
             contextBrokerMock
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
-                .post('/v2/entities?options=upsert')
+                .post('/v2/entities?options=upsert,flowControl')
                 .reply(204);
 
             contextBrokerMock
@@ -130,7 +131,7 @@ describe('NGSI-v2 - Device provisioning API: Remove provisioned devices', functi
             contextBrokerMock
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
-                .post('/v2/entities?options=upsert')
+                .post('/v2/entities?options=upsert,flowControl')
                 .reply(204);
 
             async.series(

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

@@ -48,7 +48,8 @@ const iotAgentConfig = {
     types: {},
     service: 'smartgondor',
     subservice: 'gardens',
-    providerUrl: 'http://smartgondor.com'
+    providerUrl: 'http://smartgondor.com',
+    useCBflowControl: true
 };
 
 describe('NGSI-v2 - Device provisioning API: Update provisioned devices', function () {
@@ -107,7 +108,7 @@ describe('NGSI-v2 - Device provisioning API: Update provisioned devices', functi
             contextBrokerMock
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
-                .post('/v2/entities?options=upsert')
+                .post('/v2/entities?options=upsert,flowControl')
                 .reply(204);
 
             const nockBody2 = utils.readExampleFile(
@@ -126,7 +127,7 @@ describe('NGSI-v2 - Device provisioning API: Update provisioned devices', functi
             contextBrokerMock
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
-                .post('/v2/entities?options=upsert')
+                .post('/v2/entities?options=upsert,flowControl')
                 .reply(204);
 
             // FIXME: When https://github.com/telefonicaid/fiware-orion/issues/3007 is merged into master branch,
@@ -181,7 +182,7 @@ describe('NGSI-v2 - Device provisioning API: Update provisioned devices', functi
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
                 .post(
-                    '/v2/entities?options=upsert',
+                    '/v2/entities?options=upsert,flowControl',
                     utils.readExampleFile('./test/unit/ngsiv2/examples/contextRequests/updateProvisionDevice.json')
                 )
                 .reply(204);
@@ -374,7 +375,7 @@ describe('NGSI-v2 - Device provisioning API: Update provisioned devices', functi
             contextBrokerMock = nock('http://192.168.1.1:1026')
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
-                .post('/v2/entities?options=upsert')
+                .post('/v2/entities?options=upsert,flowControl')
                 .reply(204);
 
             contextBrokerMock
@@ -442,7 +443,7 @@ describe('NGSI-v2 - Device provisioning API: Update provisioned devices', functi
             contextBrokerMock = nock('http://192.168.1.1:1026')
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
-                .post('/v2/entities?options=upsert')
+                .post('/v2/entities?options=upsert,flowControl')
                 .reply(204);
 
             contextBrokerMock
@@ -504,7 +505,7 @@ describe('NGSI-v2 - Device provisioning API: Update provisioned devices', functi
             contextBrokerMock = nock('http://192.168.1.1:1026')
                 .matchHeader('fiware-service', 'smartgondor')
                 .matchHeader('fiware-servicepath', '/gardens')
-                .post('/v2/entities?options=upsert')
+                .post('/v2/entities?options=upsert,flowControl')
                 .reply(204);
 
             async.series([iotAgentLib.clearAll, async.apply(request, provisioning4Options)], done);

package/test/unit/statsRegistry/openmetrics-test.js

@@ -0,0 +1,167 @@
+/*
+ * Copyright 2024 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::daniel.moranjimenez@telefonica.com
+ */
+
+/* eslint-disable no-unused-vars */
+
+const statsRegistry = require('../../../lib/services/stats/statsRegistry');
+const should = require('should');
+
+describe('statsRegistry - openmetrics endpoint', function () {
+
+    const testCases = [
+        {
+            description: 'Should accept standard openmetrics 0.0.1 header',
+            accept: 'application/openmetrics-text; version=0.0.1; charset=utf-8',
+            contentType: {
+                mediaType: 'application/openmetrics-text',
+                version: '0.0.1',
+                charset: 'utf-8'
+            }
+        },
+        {
+            description: 'Should accept standard openmetrics 1.0.0 header',
+            accept: 'application/openmetrics-text; version=1.0.0; charset=utf-8',
+            contentType: {
+                mediaType: 'application/openmetrics-text',
+                version: '1.0.0',
+                charset: 'utf-8'
+            }
+        },
+        {
+            description: 'Should accept openmetrics with no version',
+            accept: 'application/openmetrics-text',
+            contentType: {
+                mediaType: 'application/openmetrics-text',
+                version: '1.0.0',
+                charset: 'utf-8'
+            }
+        },
+        {
+            description: 'Should accept text/plain header with version',
+            accept: 'text/plain; version=0.0.4',
+            contentType: {
+                mediaType: 'text/plain',
+                version: '0.0.4',
+                charset: 'utf-8'
+            }
+        },
+        {
+            description: 'Should accept wildcard header',
+            accept: '*/*',
+            contentType: {
+                mediaType: 'text/plain',
+                version: '0.0.4',
+                charset: 'utf-8'
+            }
+        },
+        {
+            description: 'Should accept both openmetrics and text/plain, prefer openmetrics',
+            accept: 'application/openmetrics-text; version=0.0.1; charset=utf-8,text/plain;version=0.0.4',
+            contentType: {
+                mediaType: 'application/openmetrics-text',
+                version: '0.0.1',
+                charset: 'utf-8'
+            }
+        },
+        {
+            description: 'Should accept both text/plain and openmetrics, prefer openmetrics',
+            accept: 'text/plain,application/openmetrics-text; version=0.0.1; charset=utf-8',
+            contentType: {
+                mediaType: 'application/openmetrics-text',
+                version: '0.0.1',
+                charset: 'utf-8'
+            }
+        },
+        {
+            description: 'Should accept both openmetrics and text/plain, prefer text if preference set',
+            accept: 'application/openmetrics-text; version=0.0.1; charset=utf-8;q=0.5,text/plain;q=0.7',
+            contentType: {
+                mediaType: 'text/plain',
+                version: '0.0.4',
+                charset: 'utf-8'
+            }
+        },
+        {
+            description: 'Should match version to content-type',
+            accept: 'application/openmetrics-text; version=0.0.1; charset=utf-8, text/plain;version=1.0.0',
+            contentType: {
+                mediaType: 'application/openmetrics-text',
+                version: '0.0.1',
+                charset: 'utf-8'
+            }
+        },
+        {
+            description: 'Should set default q to 1.0',
+            accept: 'application/openmetrics-text; version=0.0.1; q=0.5,text/plain;version=0.0.4',
+            contentType: {
+                mediaType: 'text/plain',
+                version: '0.0.4',
+                charset: 'utf-8'
+            }
+        },
+        {
+            description: 'Should accept mixture of content-types and q',
+            accept: 'application/openmetrics-text; version=0.0.1,text/plain;version=0.0.4;q=0.5,*/*;q=0.1',
+            contentType: {
+                mediaType: 'application/openmetrics-text',
+                version: '0.0.1',
+                charset: 'utf-8'
+            }
+        },
+        {
+            description: 'Should reject Invalid charset',
+            accept: '*/*; charset=utf-16',
+            contentType: null
+        },
+        {
+            description: 'Should reject Invalid openmetrics version',
+            accept: 'application/openmetrics-text; version=0.0.5',
+            contentType: null
+        },
+        {
+            description: 'Should reject Invalid text/plain',
+            accept: 'text/plain; version=0.0.2',
+            contentType: null
+        }
+    ]
+
+    for (const testCase of testCases) {
+        describe(testCase.description, function () {
+            const result = statsRegistry.matchContentType(testCase.accept);
+            if (testCase.contentType) {
+                it('should match', function (done) {
+                    should.exist(result);
+                    result.mediaType.should.equal(testCase.contentType.mediaType);
+                    result.version.should.equal(testCase.contentType.version);
+                    result.charset.should.equal(testCase.contentType.charset);
+                    done();
+                });
+            } else {
+                it('should not match', function (done) {
+                    should.not.exist(result);
+                    done();
+                });
+            }
+        });
+    }
+});

package/lib/templates/queryContext.json

@@ -1,25 +0,0 @@
-{
-  "properties": {
-    "entities": {
-      "description": "The objects the request is applied to.",
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "type": {
-            "type": "string",
-            "required": true
-          },
-          "isPattern": {
-            "type": "string"
-          },
-          "id": {
-            "type": "string",
-            "required": true
-          }
-        }
-      },
-      "required": true
-    }
-  }
-}

package/test/unit/examples/deviceProvisioningRequests/provisionBidirectionalDevice.json

@@ -1,35 +0,0 @@
-{
-  "devices": [
-    {
-      "device_id": "Light1",
-      "protocol": "GENERIC_PROTO",
-      "entity_name": "TheFirstLight",
-      "entity_type": "TheLightType",
-      "timezone": "America/Santiago",
-      "endpoint": "http://fakedEndpoint:1234",
-      "transport": "MQTT",
-      "attributes": [
-        {
-          "name":"location",
-          "type":"geo:point",
-          "expression": "latitude,longitude",
-          "reverse": [
-            {
-              "object_id":"latitude",
-              "type": "Number",
-              "expression": "location | split(', ')[1] | parsefloat()"
-            },
-            {
-              "object_id":"longitude",
-              "type": "Number",
-              "expression": "location | split(', ')[0] | parsefloat()"
-            }
-          ]
-        }
-      ],
-      "lazy": [],
-      "static_attributes": [],
-      "commands": []
-    }
-  ]
-}

package/test/unit/examples/deviceProvisioningRequests/provisionDeviceBidirectionalGroup.json

@@ -1,17 +0,0 @@
-{
-  "devices": [
-    {
-      "device_id": "Light1",
-      "protocol": "GENERIC_PROTO",
-      "entity_name": "TheFirstLight",
-      "entity_type": "TheLightType",
-      "timezone": "America/Santiago",
-      "endpoint": "http://fakedEndpoint:1234",
-      "transport": "MQTT",
-      "attributes": [],
-      "lazy": [],
-      "static_attributes": [],
-      "commands": []
-    }
-  ]
-}

package/test/unit/examples/groupProvisioningRequests/bidirectionalGroup.json

@@ -1,31 +0,0 @@
-{
-  "services": [
-    {
-      "resource": "/deviceTest",
-      "apikey": "801230BJKL23Y9090DSFL123HJK09H324HV8732",
-      "entity_type": "TheLightType",
-      "commands": [],
-      "lazy": [],
-      "attributes": [
-        {
-          "name":"location",
-          "type":"geo:point",
-          "expression": "${latitude}, ${longitude}",
-          "reverse": [
-            {
-              "object_id":"latitude",
-              "type": "Number",
-              "expression": "location | split(', ')[1] | parsefloat()"
-            },
-            {
-              "object_id":"longitude",
-              "type": "Number",
-              "expression": "location | split(', ')[0] | parsefloat()"
-            }
-          ]
-        }
-      ],
-      "static_attributes": []
-    }
-  ]
-}

package/test/unit/general/statistics-persistence_test.js

@@ -1,121 +0,0 @@
-/*
- * Copyright 2014 Telefonica Investigación y Desarrollo, S.A.U
- *
- * This file is part of fiware-iotagent-lib
- *
- * fiware-iotagent-lib is free software: you can redistribute it and/or
- * modify it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the License,
- * or (at your option) any later version.
- *
- * fiware-iotagent-lib is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- * See the GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public
- * License along with fiware-iotagent-lib.
- * If not, see http://www.gnu.org/licenses/.
- *
- * For those usages not covered by the GNU Affero General Public License
- * please contact with::[contacto@tid.es]
- */
-
-/* eslint-disable no-unused-vars */
-
-const statsService = require('../../../lib/services/stats/statsRegistry');
-const commonConfig = require('../../../lib/commonConfig');
-const iotAgentLib = require('../../../lib/fiware-iotagent-lib');
-const should = require('should');
-const async = require('async');
-const mongoUtils = require('../mongodb/mongoDBUtils');
-const iotAgentConfig = {
-    logLevel: 'FATAL',
-    contextBroker: {
-        host: '192.168.1.1',
-        port: '1026'
-    },
-    server: {
-        port: 4041,
-        host: 'localhost',
-        baseRoot: '/'
-    },
-    stats: {
-        interval: 50,
-        persistence: true
-    },
-    mongodb: {
-        host: 'localhost',
-        port: '27017',
-        db: 'iotagent'
-    },
-    types: {},
-    service: 'smartgondor',
-    subservice: 'gardens',
-    providerUrl: 'http://smartgondor.com',
-    deviceRegistrationDuration: 'P1M'
-};
-let iotAgentDb;
-let oldConfig;
-
-describe('Statistics persistence service', function () {
-    function insertDummy(n, callback) {
-        iotAgentDb.collection('tests').insertOne({ test: 'test' }, function () {
-            callback();
-        });
-    }
-
-    beforeEach(function (done) {
-        oldConfig = commonConfig.getConfig();
-
-        iotAgentLib.activate(iotAgentConfig, function (error) {
-            statsService.globalLoad({}, function () {
-                iotAgentDb = require('../../../lib/model/dbConn').db;
-
-                async.times(10, insertDummy, function () {
-                    done();
-                });
-            });
-        });
-    });
-
-    afterEach(function (done) {
-        iotAgentLib.deactivate(function (error) {
-            commonConfig.setConfig(oldConfig);
-            statsService.globalLoad({}, function () {
-                mongoUtils.cleanDbs(done);
-            });
-        });
-    });
-
-    describe('When a periodic persitence action is set', function () {
-        beforeEach(function (done) {
-            statsService.globalLoad(
-                {
-                    stat1: 10
-                },
-                function () {
-                    statsService.add('stat1', 5, done);
-                }
-            );
-        });
-
-        it('should store all the records in the database', function (done) {
-            statsService.addTimerAction(statsService.mongodbPersistence, function () {
-                setTimeout(function () {
-                    statsService.clearTimers(function () {
-                        iotAgentDb
-                            .collection('kpis')
-                            .find({})
-                            .toArray(function (err, docs) {
-                                should.not.exist(err);
-                                should.exist(docs);
-                                docs.length.should.be.above(2);
-                                done();
-                            });
-                    });
-                }, 200);
-            });
-        });
-    });
-});

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

@@ -1,17 +0,0 @@
-[
-    {
-        "@context": "http://context.json-ld",
-        "id": "urn:ngsi-ld:TheLightType:TheFirstLight",
-        "location": {
-            "type": "GeoProperty",
-            "value": {
-                "coordinates": [
-                    0,
-                    0
-                ],
-                "type": "Point"
-            }
-        },
-        "type": "TheLightType"
-    }
-]

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

@@ -1,12 +0,0 @@
-[
-    {
-        "@context": "http://context.json-ld",
-        "id": "urn:ngsi-ld:Light:light1",
-        "type": "Light",
-        "state": {
-            "type": "Property",
-            "value": true,
-            "observedAt": "2016-05-30T16:25:22.304Z"
-        }
-    }
-]

package/test/unit/ngsi-ld/examples/subscriptionRequests/bidirectionalNotification.json

@@ -1,13 +0,0 @@
-{
-    "data": [
-        {
-            "id": "TheFirstLight",
-            "location": {
-                "type": "geo:point",
-                "value": "12.4, -9.6"
-            },
-            "type": "TheLightType"
-        }
-    ],
-    "subscriptionId": "51c0ac9ed714fb3b37d7d5a8"
-}