iotagent-node-lib 4.5.0 → 4.6.0

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.5.0",
+  "version": "4.6.0",
   "homepage": "https://github.com/telefonicaid/iotagent-node-lib",
   "keywords": [
     "fiware",
@@ -44,7 +44,7 @@
   },
   "dependencies": {
     "async": "2.6.4",
-    "body-parser": "~1.20.0",
+    "body-parser": "~1.20.3",
     "express": "~4.19.2",
     "got": "~11.8.5",
     "jexl": "2.3.0",

package/scripts/legacy_expression_tool/README.md

@@ -249,7 +249,6 @@ The script implements expression detection and translation in the following fiel
 
 -   active.expression
 -   active.entity_name
--   active.reverse
 -   attributes.expression
 -   attributes.entity_name
 -   attributes.expression

package/test/functional/README.md

@@ -21,8 +21,10 @@ pattern than the one supported by the test runner).
 Each test case is defined as a JSON object in the `testCases.js` file. This file is loaded by the test suite and the
 test cases are automatically generated. Each test case is defined as an object with the following elements:
 
--   `describeName`: The name of the `DESCRIBE` test case. This will be used to generate the test case name in the mocha. Note this name is prefixed by a pure number (e.g `0010 - Simple group without attributes`) which specifies the group to which the test belong (usually meaning a feature) or by a number preced by the `#` symbol to refer to an issue number (e.g. `#1234 - Bug foobar`).
-    test suite.
+-   `describeName`: The name of the `DESCRIBE` test case. This will be used to generate the test case name in the mocha.
+    Note this name is prefixed by a pure number (e.g `0010 - Simple group without attributes`) which specifies the group
+    to which the test belong (usually meaning a feature) or by a number preced by the `#` symbol to refer to an issue
+    number (e.g. `#1234 - Bug foobar`). test suite.
 -   `provision`: The JSON object that will be sent to the IoTA JSON provisioning API. This will be used to create the
     group. It contains the following elements:
     -   `url`: The URL of the provisioning API (group)
@@ -30,17 +32,19 @@ 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. 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.
+    -   `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.
     -   `shouldName`: The name of the `IT` test case. This will be used to generate the test case name in the mocha test
         suite.
-    -   `type`: The type of the test case. This can be `single`, `multimeasure` or `multientity`. See the "Advanced features" section
-        for more information.
+    -   `type`: The type of the test case. This can be `single`, `multimeasure` or `multientity`. See the "Advanced
+        features" section for more information.
     -   `measure`: The JSON object that will be sent to the IoTA JSON measure API. This will be used to send the
         measure. It contains the following elements:
         -   `url`: The URL of the measure API (group)
@@ -64,10 +68,10 @@ test cases are automatically generated. Each test case is defined as an object w
 {
     describeName: 'Basic group provision with attributes',
     provision: {
-        url: 'http://localhost:' + config.iota.server.port + '/iot/services',
+        url: 'http://localhost:' + config.iota.server.port + '/iot/groups',
         method: 'POST',
         json: {
-            services: [
+            groups: [
                 {
                     resource: '/iot/json',
                     apikey: '123456',
@@ -199,11 +203,11 @@ as a batch operation (see the following example).
 
 #### Multimeasures
 
-It is also supported to test cases in which is sent more than one measure. To do so, you need to set add to the test case 
-the parameter `should.type` to the value `'multimeasure'`.
+It is also supported to test cases in which is sent more than one measure. To do so, you need to set add to the test
+case the parameter `should.type` to the value `'multimeasure'`.
 
-You must define the measure as multimeasure. This is done by defining the `measure` JSON element as an array of
-objects. I.E:
+You must define the measure as multimeasure. This is done by defining the `measure` JSON element as an array of objects.
+I.E:
 
 ```javascript
 measure: {
@@ -276,8 +280,8 @@ expectation: {
 }
 ```
 
-Then, a batch request would be sent to the Context Broker containing the different measures. More information about
-how the IoT Agent send multimeasures to the Context Broker [here](/doc/api.md#multimeasure-support).
+Then, a batch request would be sent to the Context Broker containing the different measures. More information about how
+the IoT Agent send multimeasures to the Context Broker [here](/doc/api.md#multimeasure-support).
 
 #### Transport
 
@@ -332,7 +336,8 @@ the expectation as an empty object. I.E:
     ...
 ```
 
-Note that this means the CB *must not* receive any payload. In other words, if the CB would receive any payload, the test will fail.
+Note that this means the CB _must not_ receive any payload. In other words, if the CB would receive any payload, the
+test will fail.
 
 ### Debugging automated tests
 

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

@@ -63,12 +63,17 @@ describe('FUNCTIONAL TESTS AUTO', function () {
                 if (testCase.loglevel) {
                     logger.setLevel(testCase.loglevel);
                 }
-                let type = testUtils.groupToIoTAConfigType(
+                let confType = testUtils.groupToIoTAConfigType(
                     testCase.provision.json.services[0],
-                    testCase.provision.headers.fiwareService,
-                    testCase.provision.headers.fiwareServicepath
+                    testCase.provision.headers['fiware-service'],
+                    testCase.provision.headers['fiware-servicepath']
                 );
-                config.iota.types[type.name] = type.type;
+                // Inject device id into config as real typeInformation
+                if (testCase.should[0] && testCase.should[0].measure.qs.i) {
+                    confType.type['id'] = testCase.should[0].measure.qs.i;
+                }
+                config.iota.types[confType.name] = confType.type;
+
                 iotAgentLib.activate(config.iota, function (error) {
                     done(error);
                 });

package/test/functional/functional-tests.js

@@ -115,8 +115,8 @@ describe('FUNCTIONAL TESTS', function () {
         beforeEach(function (done) {
             let type = testUtils.groupToIoTAConfigType(
                 provision.json.services[0],
-                provision.headers.fiwareService,
-                provision.headers.fiwareServicepath
+                provision.headers['fiware-service'],
+                provision.headers['fiware-servicepath']
             );
             config.iota.types[type.name] = type.type;
             iotAgentLib.activate(config.iota, function (error) {
@@ -214,8 +214,8 @@ describe('FUNCTIONAL TESTS', function () {
         beforeEach(function (done) {
             let type = testUtils.groupToIoTAConfigType(
                 provision.json.services[0],
-                provision.headers.fiwareService,
-                provision.headers.fiwareServicepath
+                provision.headers['fiware-service'],
+                provision.headers['fiware-servicepath']
             );
             config.iota.types[type.name] = type.type;
             iotAgentLib.activate(config.iota, function (error) {

package/test/functional/testCases.js

@@ -513,6 +513,84 @@ const testCases = [
             }
         ]
     },
+    {
+        describeName: '0021b - Simple group with active attributes with special names in object_id',
+        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: [],
+                        lazy: [],
+                        attributes: [
+                            {
+                                object_id: 'a',
+                                name: 'attr_a',
+                                type: 'Boolean',
+                                metadata: {
+                                    accuracy: {
+                                        value: 0.8,
+                                        type: 'Float'
+                                    }
+                                }
+                            },
+                            {
+                                object_id: '.1.0.0.1',
+                                name: 'psBatteryVoltage',
+                                type: 'Number'
+                            }
+                        ],
+                        static_attributes: []
+                    }
+                ]
+            },
+            headers: {
+                'fiware-service': globalEnv.service,
+                'fiware-servicepath': globalEnv.servicePath
+            }
+        },
+        should: [
+            {
+                shouldName:
+                    'A - WHEN sending defined object_ids with special format names (measures) through http IT should send measures to Context Broker preserving value types, name mappings and metadatas',
+                type: 'single',
+                measure: {
+                    url: 'http://localhost:' + config.http.port + '/iot/json',
+                    method: 'POST',
+                    qs: {
+                        i: globalEnv.deviceId,
+                        k: globalEnv.apikey
+                    },
+                    json: {
+                        a: false,
+                        '.1.0.0.1': 23.5
+                    }
+                },
+                expectation: {
+                    id: globalEnv.entity_name,
+                    type: globalEnv.entity_type,
+                    attr_a: {
+                        value: false,
+                        type: 'Boolean',
+                        metadata: {
+                            accuracy: {
+                                value: 0.8,
+                                type: 'Float'
+                            }
+                        }
+                    },
+                    psBatteryVoltage: {
+                        type: 'Number',
+                        value: 23.5
+                    }
+                }
+            }
+        ]
+    },
     {
         describeName: '0022 - Simple group with active attributes and multimeasures',
         provision: {
@@ -1690,7 +1768,6 @@ const testCases = [
     },
     {
         describeName: '0170 - Simple group with active attribute + JEXL expression referencing context attributes',
-        skip: 'lib', // Explanation in #1523
         provision: {
             url: 'http://localhost:' + config.iota.server.port + '/iot/services',
             method: 'POST',
@@ -1750,9 +1827,101 @@ const testCases = [
             }
         ]
     },
+    {
+        describeName:
+            '0175 - Simple group with active attribute + JEXL expression referencing metadata context attributes',
+        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: [],
+                        lazy: [],
+                        static_attributes: [
+                            {
+                                name: 'st_attr1',
+                                type: 'Number',
+                                value: 1.5,
+                                metadata: {
+                                    coef1: {
+                                        value: 0.8,
+                                        type: 'Float'
+                                    }
+                                }
+                            },
+                            {
+                                name: 'st_attr',
+                                type: 'Number',
+                                value: 1.5,
+                                metadata: {
+                                    coef: {
+                                        value: 0.8,
+                                        type: 'Float'
+                                    }
+                                }
+                            },
+                            {
+                                name: 'st_attr2',
+                                type: 'Number',
+                                value: 1.5,
+                                metadata: {
+                                    coef2: {
+                                        value: 0.8,
+                                        type: 'Float'
+                                    }
+                                }
+                            }
+                        ],
+                        attributes: [
+                            {
+                                object_id: 'a',
+                                name: 'attr_a',
+                                type: 'Number',
+                                expression: 'a*st_attr*metadata.st_attr.coef'
+                            }
+                        ],
+                        explicitAttrs: "['attr_a']"
+                    }
+                ]
+            },
+            headers: {
+                'fiware-service': globalEnv.service,
+                'fiware-servicepath': globalEnv.servicePath
+            }
+        },
+        should: [
+            {
+                shouldName:
+                    'A - WHEN sending a value (number) through http IT should apply the expression using the context attributes value and send to Context Broker the value "39.60" ',
+                type: 'single',
+                measure: {
+                    url: 'http://localhost:' + config.http.port + '/iot/json',
+                    method: 'POST',
+                    qs: {
+                        i: globalEnv.deviceId,
+                        k: globalEnv.apikey
+                    },
+                    json: {
+                        a: 33
+                    }
+                },
+                expectation: {
+                    id: globalEnv.entity_name,
+                    type: globalEnv.entity_type,
+                    attr_a: {
+                        value: 39.6,
+                        type: 'Number'
+                    }
+                }
+            }
+        ]
+    },
     {
         describeName: '0180 - Simple group with active attributes + JEXL multiples expressions at same time',
-        skip: 'lib', // Explanation in #1523
         provision: {
             url: 'http://localhost:' + config.iota.server.port + '/iot/services',
             method: 'POST',
@@ -4125,7 +4294,7 @@ const testCases = [
                                 type: 'Number',
                                 entity_name: 'TestType:TestDevice2',
                                 entity_type: 'TestType',
-                                expression: 'type+":"+(t*2*static_a)' // Only type is used as JEXL context attr due to #1523
+                                expression: 'type+":"+(t*2*static_a)'
                             }
                         ],
                         static_attributes: [
@@ -4211,7 +4380,7 @@ const testCases = [
                                 object_id: 't',
                                 name: 'temperature',
                                 type: 'Number',
-                                entity_name: 'type+":"+(t*2*static_a)', // Only type is used as JEXL context attr due to #1523
+                                entity_name: 'type+":"+(t*2*static_a)',
                                 entity_type: 'TestType'
                             }
                         ],
@@ -4483,6 +4652,78 @@ const testCases = [
                 }
             }
         ]
+    },
+    // 0900 - JEXL FUNCTION TESTS
+    {
+        describeName: '0900 - JEXL function - valuePicker and valuePickerMulti',
+        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,
+                        explicitAttrs: true,
+                        commands: [],
+                        lazy: [],
+                        attributes: [
+                            {
+                                object_id: 'single',
+                                name: 'single',
+                                type: 'Number',
+                                expression: '{alarm1:alarm1,alarm2:alarm2,alarm3:alarm3}|valuePicker(true)'
+                            },
+                            {
+                                object_id: 'multi',
+                                name: 'multi',
+                                type: 'Number',
+                                expression: "a|valuePickerMulti([true,1,'on','nok'])"
+                            }
+                        ],
+                        static_attributes: []
+                    }
+                ]
+            },
+            headers: {
+                'fiware-service': globalEnv.service,
+                'fiware-servicepath': globalEnv.servicePath
+            }
+        },
+        should: [
+            {
+                shouldName:
+                    'A - WHEN sending a boolean value (true) through http IT should send to Context Broker the value 3 ',
+                type: 'single',
+                measure: {
+                    url: 'http://localhost:' + config.http.port + '/iot/json',
+                    method: 'POST',
+                    qs: {
+                        i: globalEnv.deviceId,
+                        k: globalEnv.apikey
+                    },
+                    json: {
+                        a: { n1: true, n2: 1, n3: 'on', n4: 'nok', n5: 'ok', n6: true, n7: false, n8: 0 },
+                        alarm1: true,
+                        alarm2: false,
+                        alarm3: true
+                    }
+                },
+                expectation: {
+                    id: globalEnv.entity_name,
+                    type: globalEnv.entity_type,
+                    single: {
+                        value: ['alarm1', 'alarm3'],
+                        type: 'Number'
+                    },
+                    multi: {
+                        value: ['n1', 'n2', 'n3', 'n4', 'n6'],
+                        type: 'Number'
+                    }
+                }
+            }
+        ]
     }
 ];
 

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

@@ -25,19 +25,7 @@
         {
           "name":"location",
           "type":"geo:point",
-          "expression": "${latitude}, ${longitude}",
-          "reverse": [
-            {
-              "object_id":"latitude",
-              "type": "string",
-              "expression": "${trim(substr(@location, indexOf(@location, \",\") + 1, length(@location)))}"
-            },
-            {
-              "object_id":"longitude",
-              "type": "string",
-              "expression": "${trim(substr(@location, 0, indexOf(@location, \",\")))}"
-            }
-          ]
+          "expression": "${latitude}, ${longitude}"
         }
       ],
       "static_attributes": [],

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

@@ -0,0 +1,44 @@
+{
+  "groups": [
+    {
+      "resource": "/deviceTest",
+      "apikey": "801230BJKL23Y9090DSFL123HJK09H324HV8732",
+      "entity_type": "Light",
+      "trust": "8970A9078A803H3BL98PINEQRW8342HBAMS",
+      "cbHost": "http://unexistentHost:1026",
+      "commands": [
+        {
+          "name": "wheel1",
+          "type": "Wheel"
+        }
+      ],
+      "lazy": [
+        {
+          "name": "luminescence",
+          "type": "Lumens"
+        }
+      ],
+      "attributes": [
+        {
+          "name": "status",
+          "type": "Boolean"
+        }
+      ]
+    },
+    {
+      "resource": "/deviceTest",
+      "apikey": "23HJK3Y9090DSFL173209HV8801232",
+      "entity_type": "Termometer",
+      "trust": "BL9803H3QRW8342HBAMS8A8",
+      "cbHost": "http://unexistentHost:1026",
+      "commands": [
+        {
+          "name": "temperature",
+          "type": "degrees"
+        }
+      ],
+      "lazy": [],
+      "attributes": []
+    }
+  ]
+}

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

@@ -0,0 +1,35 @@
+{
+  "groups": [
+    {
+      "resource": "/deviceDuplicateGroup",
+      "apikey": "JK09H3L12K09H3L123HJK0732L123HJK38K09H3",
+      "entity_type": "CommandMachinery",
+      "trust": "8970A9078A803H3BL98PINEQRW8342HBAMS",
+      "commands": [
+        {
+          "name": "wheel1",
+          "type": "Wheel"
+        }
+      ],
+      "lazy": [
+        {
+          "name": "luminescence",
+          "type": "Lumens"
+        }
+      ],
+      "attributes": [
+        {
+          "name": "status",
+          "type": "Boolean"
+        }
+      ],
+      "static_attributes": [
+        {
+          "name": "bootstrapServer",
+          "type": "Address",
+          "value": "127.0.0.1"
+        }
+      ]
+    }
+  ]
+}

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

@@ -0,0 +1,36 @@
+{
+  "groups": [
+    {
+      "resource": "/deviceTest",
+      "apikey": "801230BJKL23Y9090DSFL123HJK09H324HV8732",
+      "entity_type": "SensorMachine",
+      "trust": "8970A9078A803H3BL98PINEQRW8342HBAMS",
+      "cbHost": "http://unexistentHost:1026",
+      "commands": [
+        {
+          "name": "wheel1",
+          "type": "Wheel"
+        }
+      ],
+      "lazy": [
+        {
+          "name": "luminescence",
+          "type": "Lumens"
+        }
+      ],
+      "attributes": [
+        {
+          "name": "status",
+          "type": "Boolean"
+        }
+      ],
+      "static_attributes": [
+        {
+          "name": "bootstrapServer",
+          "type": "Address",
+          "value": "127.0.0.1"
+        }
+      ]
+    }
+  ]
+}

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

@@ -0,0 +1,36 @@
+{
+  "groups": [
+    {
+      "resource": "/deviceTest",
+      "apikey": "754KL23Y9090DSFL123HSFL12380KL23Y2",
+      "entity_type": "AnotherMachine",
+      "trust": "8970A9078A803H3BL98PINEQRW8342HBAMS",
+      "cbHost": "http://unexistentHost:1026",
+      "commands": [
+        {
+          "name": "wheel1",
+          "type": "Wheel"
+        }
+      ],
+      "lazy": [
+        {
+          "name": "luminescence",
+          "type": "Lumens"
+        }
+      ],
+      "attributes": [
+        {
+          "name": "status",
+          "type": "Boolean"
+        }
+      ],
+      "static_attributes": [
+        {
+          "name": "bootstrapServer",
+          "type": "Address",
+          "value": "127.0.0.1"
+        }
+      ]
+    }
+  ]
+}