iotagent-node-lib 4.0.1 → 4.1.0

package/.github/workflows/ci.yml

@@ -45,7 +45,7 @@ jobs:
     runs-on: ubuntu-latest
     services:
       mongodb:
-        image: mongo:4.2
+        image: mongo:6.0
         ports:
         - 27017:27017
     strategy:
@@ -72,7 +72,7 @@ jobs:
     needs: unit-test
     services:
       mongodb:
-        image: mongo:4.2
+        image: mongo:6.0
         ports:
         - 27017:27017
     steps:

package/CHANGES_NEXT_RELEASE

@@ -0,0 +1 @@
+

package/doc/api.md

@@ -450,7 +450,7 @@ propagated to NGSI interface (note that in this case the value of `explicitAttrs
 that looks likes a JSON). This is necessary when same attribute names are used within multiple entities. Only static
 attributes included in that array will be propagated to NGSI interface.
 
-Note that in the previous case show above, when selecting the object_id (with `{object_id:'active_id'}`), the attribute 
+Note that in the previous case show above, when selecting the object_id (with `{object_id:'active_id'}`), the attribute
 must be defined. In other words, it would not work if the attribute with the corresponding `object_id`, is not defined.
 
 Case 5:
@@ -1217,6 +1217,8 @@ Config group is represented by a JSON object with the following fields:
 | `defaultEntityNameConjunction` | ✓        | string         |            | optional string value to set default conjunction string used to compose a default `entity_name` when is not provided at device provisioning time.                                                                                                                         |
 | `autoprovision`                | ✓        | bool           | ✓?         | optional boolean: If `false`, autoprovisioned devices (i.e. devices that are not created with an explicit provision operation but when the first measure arrives) are not allowed in this group. Default (in the case of omitting the field) is `true`.                   |
 | `payloadType`                  | ✓        | string         |            | optional string value used to switch between **IoTAgent**, **NGSI-v2** and **NGSI-LD** measure payloads types. Possible values are: `iotagent`, `ngsiv2` or `ngsild`. The default is `iotagent`.                                                                          |
+| `transport`                    | ✓        | `string`       |            | Transport protocol used by the group of devices to send updates, for the IoT Agents with multiple transport protocols.                                                                                                                                                    |
+| `endpoint`                     | ✓        | `string`       |            | Endpoint where the group of device is going to receive commands, if any.                                                                                                                                                                                                  |
 
 ### Config group operations
 

package/docker/Mosquitto/Dockerfile

@@ -1,4 +1,4 @@
-ARG  IMAGE_TAG=12.1-slim
+ARG  IMAGE_TAG=12.4-slim
 FROM debian:${IMAGE_TAG}
 
 ARG CLEAN_DEV_TOOLS

package/docker-compose-dev.yml

@@ -3,6 +3,6 @@ version: '3'
 services:
 
   mongo:
-    image: mongo:4.4
+    image: mongo:6.0.12
     ports:
       - "27017:27017"

package/lib/fiware-iotagent-lib.js

@@ -308,6 +308,7 @@ exports.getDeviceByName = deviceService.getDeviceByName;
 exports.getDeviceByNameAndType = deviceService.getDeviceByNameAndType;
 exports.getDevicesByAttribute = deviceService.getDevicesByAttribute;
 exports.mergeDeviceWithConfiguration = deviceService.mergeDeviceWithConfiguration;
+exports.findOrCreate = deviceService.findOrCreate;
 exports.retrieveDevice = deviceService.retrieveDevice;
 exports.getConfiguration = groupConfig.get;
 exports.getConfigurationSilently = groupConfig.getSilently;

package/lib/model/Group.js

@@ -45,6 +45,8 @@ const Group = new Schema({
     url: String,
     resource: String,
     apikey: String,
+    endpoint: String,
+    transport: String,
     type: String,
     service: { type: String, lowercase: true },
     subservice: String,

package/lib/services/common/iotManagerService.js

@@ -61,7 +61,9 @@ function register(callback) {
             defaultEntityNameConjunction: service.defaultEntityNameConjunction,
             ngsiVersion: service.ngsiVersion,
             entityNameExp: service.entityNameExp,
-            payloadType: service.payloadType
+            payloadType: service.payloadType,
+            endpoint: service.endpoint,
+            transport: service.transport
         };
     }
 

package/lib/services/devices/deviceRegistryMongoDB.js

@@ -309,6 +309,7 @@ function update(device, callback) {
             data.internalAttributes = device.internalAttributes;
             data.commands = device.commands;
             data.endpoint = device.endpoint;
+            data.transport = device.transport;
             data.polling = device.polling;
             data.name = device.name;
             data.type = device.type;

package/lib/services/devices/deviceService.js

@@ -352,7 +352,7 @@ function registerDevice(deviceObj, callback) {
                     deviceObj.subservice = deviceData.subservice;
                     deviceObj.type = deviceData.type;
                     deviceObj.staticAttributes = deviceObj.staticAttributes ? deviceObj.staticAttributes : [];
-                    deviceObj.commands = deviceObj.commands ? deviceObj.commands : [];
+                    deviceObj.commands = deviceData.commands ? deviceData.commands : [];
                     deviceObj.lazy = deviceObj.lazy ? deviceObj.lazy : [];
                     if ('apikey' in deviceData && deviceData.apikey !== undefined) {
                         deviceObj.apikey = deviceData.apikey;
@@ -677,7 +677,7 @@ function retrieveDevice(deviceId, apiKey, callback) {
     } else {
         async.waterfall(
             [
-                apply(groupService.get, config.getConfig().defaultResource || '', apiKey),
+                apply(groupService.getSilently, config.getConfig().defaultResource || '', apiKey),
                 apply(findOrCreate, deviceId, apiKey),
                 apply(
                     mergeDeviceWithConfiguration,
@@ -704,5 +704,6 @@ exports.unregister = intoTrans(context, unregisterDevice);
 exports.clearRegistry = intoTrans(context, checkRegistry)(clearRegistry);
 exports.retrieveDevice = intoTrans(context, checkRegistry)(retrieveDevice);
 exports.mergeDeviceWithConfiguration = mergeDeviceWithConfiguration;
+exports.findOrCreate = findOrCreate;
 exports.findConfigurationGroup = findConfigurationGroup;
 exports.init = init;

package/lib/services/devices/devices-NGSI-v2.js

@@ -273,7 +273,12 @@ function updateRegisterDeviceNgsi2(deviceObj, entityInfoUpdated, callback) {
             if ('payloadType' in newDevice && newDevice.payloadType !== undefined) {
                 oldDevice.payloadType = newDevice.payloadType;
             }
-            oldDevice.endpoint = newDevice.endpoint || oldDevice.endpoint;
+            if ('endpoint' in newDevice && newDevice.endpoint !== undefined) {
+                oldDevice.endpoint = newDevice.endpoint;
+            }
+            if ('transport' in newDevice && newDevice.transport !== undefined) {
+                oldDevice.transport = newDevice.transport;
+            }
 
             callback(null, oldDevice);
         } else {

package/lib/services/groups/groupRegistryMemory.js

@@ -61,7 +61,7 @@ function createGroup(group, callback) {
 
         logger.debug(
             context,
-            'Storing device group for service [%s] and subservice [%s]',
+            'Storing device group id %s for service [%s] and subservice [%s]',
             storeGroup._id,
             storeGroup.service,
             storeGroup.subservice
@@ -144,6 +144,7 @@ function find(service, subservice, callback) {
     }
 
     if (result.length > 0) {
+        logger.debug(context, 'groups found  %j', result);
         return callback(null, {
             count: result.length,
             services: result
@@ -169,7 +170,7 @@ function findBy(fields) {
         /* eslint-disable-next-line prefer-rest-params */
         const callback = arguments[i];
 
-        logger.debug(context, 'Looking for device params %j', fields);
+        logger.debug(context, 'Looking for group with params %j', fields);
 
         for (const p in registeredGroups) {
             if (registeredGroups.hasOwnProperty(p)) {
@@ -189,6 +190,7 @@ function findBy(fields) {
         }
 
         if (result) {
+            logger.debug(context, 'group found  %j', result);
             callback(null, result);
         } else {
             callback(new errors.DeviceGroupNotFound('n/a', 'n/a'));
@@ -211,6 +213,7 @@ function getSingleGroup(resource, apikey, callback) {
     }
 
     if (result) {
+        logger.debug(context, 'single group found %j', result);
         callback(null, result);
     } else {
         callback(new errors.DeviceGroupNotFound(resource, apikey));
@@ -228,6 +231,7 @@ function getSingleGroupType(type, callback) {
     }
 
     if (result) {
+        logger.debug(context, 'single group type found %j', result);
         callback(null, result);
     } else {
         callback(new errors.DeviceGroupNotFound(type));
@@ -243,7 +247,7 @@ function update(id, body, callback) {
                 groupToModify[i] = body[i];
             }
         }
-
+        logger.debug(context, 'groupd to update %j', groupToModify);
         callback(null, groupToModify);
     } else {
         callback(new errors.DeviceGroupNotFound(id));
@@ -262,8 +266,8 @@ exports.list = intoTrans(context, listGroups);
 exports.init = intoTrans(context, init);
 exports.find = intoTrans(context, find);
 exports.findBy = intoTrans(context, findBy);
-exports.findType = intoTrans(context, findBy(['service', 'subservice', 'type']));
-exports.findTypeSilently = intoTrans(context, findBy(['service', 'subservice', 'type']));
+exports.findType = intoTrans(context, findBy(['service', 'subservice', 'type', 'apikey']));
+exports.findTypeSilently = intoTrans(context, findBy(['service', 'subservice', 'type', 'apikey']));
 exports.findSilently = intoTrans(context, findBy(['service', 'subservice']));
 exports.get = intoTrans(context, getSingleGroup);
 exports.getSilently = intoTrans(context, getSingleGroup);

package/lib/services/groups/groupRegistryMongoDB.js

@@ -41,6 +41,8 @@ const attributeList = [
     'resource',
     'apikey',
     'type',
+    'endpoint',
+    'transport',
     'service',
     'subservice',
     'description',

package/lib/templates/createDevice.json

@@ -32,6 +32,10 @@
             "description": "Protocol the device is using to communicate with the platform",
             "type": "string"
           },
+          "endpoint": {
+            "description": "Endpoint for the commands targeting this device",
+            "type": "string"
+          },
           "transport": {
             "description": "Transport protocol used by the platform to communicate with the device",
             "type": "string"

package/lib/templates/createDeviceLax.json

@@ -32,6 +32,10 @@
             "description": "Protocol the device is using to communicate with the platform",
             "type": "string"
           },
+          "endpoint": {
+              "description": "Endpoint for the commands targeting this device",
+              "type": "string"
+          },
           "transport": {
             "description": "Transport protocol used by the platform to communicate with the device",
             "type": "string"

package/lib/templates/deviceGroup.json

@@ -20,6 +20,14 @@
             "type": "string",
             "required": true
           },
+          "endpoint": {
+              "description": "Endpoint for the commands targeting this group",
+              "type": "string"
+          },
+          "transport": {
+            "description": "Transport protocol used by the platform to communicate with the device",
+            "type": "string"
+          },
           "token": {
             "description": "token",
             "type": "string"

package/lib/templates/updateDevice.json

@@ -33,6 +33,10 @@
       "description": "Endpoint for the commands targeting this device",
       "type": "string"
     },
+    "transport": {
+        "description": "Transport protocol used by the platform to communicate with the device",
+        "type": "string"
+    },
     "lazy": {
       "description": "list of lazy attributes of the devices",
       "type": "array",

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.0.1",
+  "version": "4.1.0",
   "homepage": "https://github.com/telefonicaid/iotagent-node-lib",
   "keywords": [
     "fiware",

package/test/functional/README.md

@@ -30,10 +30,10 @@ test cases are automatically generated. Each test case is defined as an object w
     -   `json`: The JSON object that defines the group
     -   `headers`: The headers to send to the provisioning API. This should contain the `fiware-service` and
         `fiware-servicepath` headers.
-    -   `skip`: optional. If set to `true`, the test case (`describe`) will be skipped. This is useful to skip test
-        cases that are not supported by the agent. It can also have a string value `"lib"`. This will skip the test case
-        only if the is executed in the IoTA Node lib repo. This is useful to skip test cases that are not supported by
-        the lib (I.E: all tests related to the transport).
+    -   `skip`: optional. Allow to skip test cases (at `describe` level). It allows diferent values: `false` (default, meaning that the test is not skipped in any circustance),
+        `true` (meaning the test is always skipped), `"lib"` (meaning the test has to be skipped when running it in IoTA Node lib repo) and
+        `"json"` (meaning the test has to be skipped when running it in IOTA JSON repo). The latter alternatives are useful to skip test cases that are not supported by
+        the lib (I.E: all tests related to the transport) or by the IOTA. Combinations (e.g `"lib,json"`) and negation (e.g. `"!lib"`) are also supported.
 -   `should`: The array of test cases to execute. Each test case is defined as an object with the following elements:
     -   `transport`: The transport to use to send the measure. This can be `HTTP` or `MQTT`. It uses `HTTP` by default
         or if the `transport` element is not defined. See the "Advanced features" section for more information.

package/test/functional/functional-tests-runner.js

@@ -88,7 +88,7 @@ describe('FUNCTIONAL TESTS AUTO', function () {
 
             testCase.should.forEach((should) => {
                 it(should.shouldName, async function () {
-                    if (testCase.skip && testUtils.checkSkip(testCase.skip, 'lib')) {
+                    if (should.skip && testUtils.checkSkip(should.skip, 'lib')) {
                         this.skip();
                     }
                     // Skip the test if the transport is specified (IoTA Lib does not support any transport)

package/test/functional/testCases.js

@@ -1476,6 +1476,65 @@ const testCases = [
             }
         ]
     },
+    // 0200 - COMMANDS TESTS
+    {
+        describeName: '0200 - Simple group with commands',
+        provision: {
+            url: 'http://localhost:' + config.iota.server.port + '/iot/services',
+            method: 'POST',
+            json: {
+                services: [
+                    {
+                        resource: '/iot/json',
+                        apikey: globalEnv.apikey,
+                        entity_type: globalEnv.entity_type,
+                        commands: [
+                            {
+                                name: 'cmd1',
+                                type: 'command'
+                            }
+                        ],
+                        endpoint: 'http://myendpoint.com',
+                        transport: 'http',
+                        lazy: [],
+                        attributes: [],
+                        static_attributes: []
+                    }
+                ]
+            },
+            headers: {
+                'fiware-service': globalEnv.service,
+                'fiware-servicepath': globalEnv.servicePath
+            }
+        },
+        should: [
+            {
+                shouldName:
+                    'A - WHEN sending not provisioned object_ids (measures) through http IT should store commands into Context Broker',
+                type: 'single',
+                skip: '!lib', // there is not CB registration mock
+                measure: {
+                    url: 'http://localhost:' + config.http.port + '/iot/json',
+                    method: 'POST',
+                    qs: {
+                        i: globalEnv.deviceId,
+                        k: globalEnv.apikey
+                    },
+                    json: {
+                        b: 10
+                    }
+                },
+                expectation: {
+                    id: globalEnv.entity_name,
+                    type: globalEnv.entity_type,
+                    b: {
+                        value: 10,
+                        type: 'string'
+                    }
+                }
+            }
+        ]
+    },
     // 0300 - STATIC ATTRIBUTES TESTS
     {
         describeName:
@@ -2424,6 +2483,7 @@ const testCases = [
             {
                 shouldName: 'C - WHEN sending only b IT should store only [{object_id:b}] attrs into Context Broker',
                 type: 'single',
+                skip: '!lib', // FIXME: https://github.com/telefonicaid/iotagent-json/issues/782
                 measure: {
                     url: 'http://localhost:' + config.http.port + '/iot/json',
                     method: 'POST',
@@ -2450,6 +2510,7 @@ const testCases = [
                 shouldName:
                     'D - WHEN no sending any defined case IT should store [static_a,static_b] attrs into Context Broker',
                 type: 'single',
+                skip: '!lib', // FIXME: https://github.com/telefonicaid/iotagent-json/issues/782
                 measure: {
                     url: 'http://localhost:' + config.http.port + '/iot/json',
                     method: 'POST',

package/test/functional/testUtils.js

@@ -139,6 +139,8 @@ function groupToIoTAConfigType(group, service, subservice) {
                 type.type = group.entity_type;
             } else if (key === 'static_attributes') {
                 type.staticAttributes = group.static_attributes;
+            } else if (key === 'commands') {
+                type.commands = group.commands;
             } else if (key !== 'resource') {
                 type[key] = group[key];
             }

package/test/unit/ngsiv2/provisioning/device-group-api-test.js

@@ -61,6 +61,8 @@ const optionsCreation = {
                 entity_type: 'SensorMachine',
                 trust: '8970A9078A803H3BL98PINEQRW8342HBAMS',
                 cbHost: 'http://unexistentHost:1026',
+                transport: 'HTTP',
+                endpoint: 'http://myendpoint.com',
                 commands: [
                     {
                         name: 'wheel1',
@@ -136,6 +138,8 @@ const optionsUpdate = {
     json: {
         trust: '8970A9078A803H3BL98PINEQRW8342HBAMS',
         cbHost: 'http://anotherUnexistentHost:1026',
+        transport: 'MQTT',
+        endpoint: 'http://yourendpoint.com',
         commands: [
             {
                 name: 'wheel1',
@@ -217,6 +221,8 @@ describe('NGSI-v2 - Device Group Configuration API', function () {
                 request(optionsList, function (error, response, body) {
                     body.count.should.equal(1);
                     body.services[0].apikey.should.equal('801230BJKL23Y9090DSFL123HJK09H324HV8732');
+                    body.services[0].transport.should.equal('HTTP');
+                    body.services[0].endpoint.should.equal('http://myendpoint.com');
                     done();
                 });
             });
@@ -664,6 +670,8 @@ describe('NGSI-v2 - Device Group Configuration API', function () {
                         ) {
                             body.services[i].cbHost.should.equal('http://anotherUnexistentHost:1026');
                             body.services[i].static_attributes.length.should.equal(1);
+                            body.services[i].endpoint = 'http://yourendpoint.com';
+                            body.services[i].transport = 'MQTT';
                             found = true;
                         }
                     }