iotagent-node-lib 3.0.0 → 3.2.0

package/test/unit/ngsi-ld/expressions/expressionBasedTransformations-test.js

@@ -1,881 +0,0 @@
-/*
- * Copyright 2020 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]
- *
- * Modified by: Jason Fox - FIWARE Foundation
- */
-
-/* eslint-disable no-unused-vars */
-
-const iotAgentLib = require('../../../../lib/fiware-iotagent-lib');
-const utils = require('../../../tools/utils');
-const should = require('should');
-const logger = require('logops');
-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
-    },
-    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: 'None'
-                },
-                {
-                    object_id: 'u',
-                    name: 'updated',
-                    type: 'Boolean'
-                },
-                {
-                    object_id: 'm',
-                    name: 'manufacturer',
-                    type: 'Object'
-                },
-                {
-                    object_id: 'r',
-                    name: 'revisions',
-                    type: 'Array'
-                },
-                {
-                    object_id: 'x',
-                    name: 'consumption_x',
-                    type: 'Number',
-                    expression: '${@pressure * 20}'
-                }
-            ]
-        },
-        LightError: {
-            commands: [],
-            type: 'Light',
-            lazy: [],
-            active: [
-                {
-                    object_id: 'p',
-                    name: 'pressure',
-                    type: 'Number',
-                    expression: '${@pressure * / 20}'
-                }
-            ]
-        },
-        WeatherStation: {
-            commands: [],
-            type: 'WeatherStation',
-            lazy: [],
-            active: [
-                {
-                    object_id: 'p',
-                    name: 'pressure',
-                    type: 'Number',
-                    expression: '${@pressure * 20}'
-                },
-                {
-                    object_id: 'e',
-                    name: 'consumption',
-                    type: 'Number',
-                    expression: '${@consumption * 20}'
-                },
-                {
-                    object_id: 'h',
-                    name: 'humidity',
-                    type: 'Percentage'
-                },
-                {
-                    name: 'weather',
-                    type: 'Summary',
-                    expression: 'Humidity ${@humidity / 2} and pressure ${@pressure * 20}'
-                },
-                {
-                    object_id: 'a',
-                    name: 'alive',
-                    type: 'None',
-                    expression: '${@alive *  20}'
-                },
-                {
-                    object_id: 'u',
-                    name: 'updated',
-                    type: 'Boolean',
-                    expression: '${@updated *  20}'
-                }
-            ]
-        },
-        WeatherStationMultiple: {
-            commands: [],
-            type: 'WeatherStation',
-            lazy: [],
-            active: [
-                {
-                    object_id: 'p',
-                    name: 'pressure',
-                    type: 'Number',
-                    expression: '${trim(@pressure)}'
-                },
-                {
-                    object_id: 'p25',
-                    name: 'pressure25',
-                    type: 'Number'
-                },
-                {
-                    object_id: 'e',
-                    name: 'consumption',
-                    type: 'Number',
-                    expression: '${trim(@consumption)}'
-                },
-                {
-                    object_id: 'h',
-                    name: 'humidity12',
-                    type: 'Percentage'
-                },
-                {
-                    name: 'weather',
-                    type: 'Summary',
-                    expression: 'Humidity ${@humidity12 / 2} and pressure ${@pressure25 * 20}'
-                },
-                {
-                    object_id: 'a',
-                    name: 'alive',
-                    type: 'None',
-                    expression: '${trim(@alive)}'
-                },
-                {
-                    object_id: 'u',
-                    name: 'updated',
-                    type: 'Boolean',
-                    expression: '${trim(@updated)}'
-                }
-            ]
-        }
-    },
-    service: 'smartgondor',
-    subservice: 'gardens',
-    providerUrl: 'http://smartgondor.com'
-};
-
-describe('NGSI-LD - Expression-based transformations plugin', function () {
-    beforeEach(function (done) {
-        logger.setLevel('FATAL');
-
-        iotAgentLib.activate(iotAgentConfig, function () {
-            iotAgentLib.clearAll(function () {
-                done();
-            });
-        });
-    });
-
-    afterEach(function (done) {
-        iotAgentLib.clearAll(function () {
-            iotAgentLib.deactivate(done);
-        });
-    });
-
-    describe('When an update comes for expressions with syntax errors', function () {
-        // Case: Update for an attribute with bad expression
-        const values = [
-            {
-                name: 'p',
-                type: 'centigrades',
-                value: '52'
-            }
-        ];
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('light1', 'LightError', '', values, function (error) {
-                should.exist(error);
-                error.name.should.equal('INVALID_EXPRESSION');
-                error.code.should.equal(400);
-                done();
-            });
-        });
-    });
-
-    describe('When there are expression attributes that are just calculated (not sent by the device)', function () {
-        // Case: Expression which results is sent as a new attribute
-        const values = [
-            {
-                name: 'p',
-                type: 'Number',
-                value: 52
-            },
-            {
-                name: 'h',
-                type: 'Percentage',
-                value: '12'
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin2.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should calculate them and add them to the payload', function (done) {
-            iotAgentLib.update('ws1', 'WeatherStation', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When an expression with multiple variables with numbers arrive', function () {
-        // Case: Update for integer and string attributes with expression
-
-        const values = [
-            {
-                name: 'p25',
-                type: 'Number',
-                value: 52
-            },
-            {
-                name: 'h',
-                type: 'percentage',
-                value: '12'
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin4.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should calculate it and add it to the payload', function (done) {
-            iotAgentLib.update('ws1', 'WeatherStationMultiple', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When an update comes for attributes without expressions and type integer', function () {
-        // Case: Update for an integer attribute without expression
-        const values = [
-            {
-                name: 'e',
-                type: 'Number',
-                value: 52
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin11.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('light1', 'Light', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When an update comes for attributes with numeric expressions and type integer', function () {
-        // Case: Update for an integer attribute with arithmetic expression
-        const values = [
-            {
-                name: 'p',
-                type: 'Number',
-                value: 52
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin1.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('ws1', 'WeatherStation', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When an update comes for attributes with string expression and type integer', function () {
-        // Case: Update for an integer attribute with string expression
-        const values = [
-            {
-                name: 'e',
-                type: 'Number',
-                value: 52
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin18.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('ws1', 'WeatherStationMultiple', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When an update comes for attributes without expressions and type float', function () {
-        // Case: Update for a Float attribute without expressions
-
-        const values = [
-            {
-                name: 'e',
-                type: 'Number',
-                value: 0.44
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin3.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('light1', 'Light', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When an update comes for attributes with numeric expressions and type float', function () {
-        // Case: Update for a Float attribute with arithmetic expression
-
-        const values = [
-            {
-                name: 'e',
-                type: 'Number',
-                value: 0.44
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin8.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('ws1', 'WeatherStation', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When an update comes for attributes with string expressions and type float', function () {
-        // Case: Update for a Float attribute with string expression
-
-        const values = [
-            {
-                name: 'e',
-                type: 'Number',
-                value: 0.44
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin19.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('ws1', 'WeatherStationMultiple', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When an update comes for attributes without expressions and NULL type', function () {
-        // Case: Update for a Null attribute without expression
-
-        const values = [
-            {
-                name: 'a',
-                type: 'None',
-                value: null
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin5.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('light1', 'Light', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When an update comes for attributes with numeric expressions and NULL type', function () {
-        // Case: Update for a Null attribute with arithmetic expression
-
-        const values = [
-            {
-                name: 'a',
-                type: 'None',
-                value: null
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin16.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('ws1', 'WeatherStation', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When an update comes for attributes with string expressions and NULL type', function () {
-        // Case: Update for a Null attribute with string expression
-
-        const values = [
-            {
-                name: 'a',
-                type: 'None',
-                value: null
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin17.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('ws1', 'WeatherStationMultiple', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When an update comes for attributes without expressions and Boolean type', function () {
-        // Case: Update for a Boolean attribute without expression
-
-        const values = [
-            {
-                name: 'u',
-                type: 'Boolean',
-                value: true
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin9.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('light1', 'Light', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When an update comes for attributes with numeric expressions and Boolean type', function () {
-        // Case: Update for a Boolean attribute with arithmetic expression
-
-        const values = [
-            {
-                name: 'u',
-                type: 'Boolean',
-                value: true
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin10.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('ws1', 'WeatherStation', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When an update comes for attributes with string expressions and Boolean type', function () {
-        // Case: Update for a Boolean attribute with string expression
-        const values = [
-            {
-                name: 'u',
-                type: 'Boolean',
-                value: true
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin15.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('ws1', 'WeatherStationMultiple', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When an update comes for attributes without expressions and Object type', function () {
-        // Case: Update for a JSON document attribute without expression
-        const values = [
-            {
-                name: 'm',
-                type: 'Object',
-                value: { name: 'Manufacturer1', VAT: 'U12345678' }
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin6.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('light1', 'Light', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When an update comes for attributes without expressions and Array type', function () {
-        // Case: Update for a JSON array attribute without expression
-
-        const values = [
-            {
-                name: 'r',
-                type: 'Array',
-                value: ['v0.1', 'v0.2', 'v0.3']
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin7.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('light1', 'Light', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When there are expressions including other attributes and they are not updated', function () {
-        const values = [
-            {
-                name: 'x',
-                type: 'Number',
-                value: 0.44
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin12.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('light1', 'Light', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When there are expressions including other attributes and they are updated', function () {
-        const values = [
-            {
-                name: 'p',
-                type: 'Number',
-                value: 10
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin13.json'
-                    )
-                )
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('light1', 'Light', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-
-    describe('When there are expressions including other attributes and they are updated (overriding situation)', function () {
-        const values = [
-            {
-                name: 'x',
-                type: 'Number',
-                value: 0.44
-            },
-            {
-                name: 'p',
-                type: 'Number',
-                value: 10
-            }
-        ];
-
-        beforeEach(function () {
-            nock.cleanAll();
-
-            contextBrokerMock = nock('http://192.168.1.1:1026')
-                .matchHeader('fiware-service', 'smartgondor')
-                .post(
-                    '/ngsi-ld/v1/entityOperations/upsert/?options=update',
-                    utils.readExampleFile(
-                        './test/unit/ngsi-ld/examples/contextRequests/updateContextExpressionPlugin14.json'
-                    )
-                )
-
-                .reply(204);
-        });
-
-        it('should apply the expression before sending the values', function (done) {
-            iotAgentLib.update('light1', 'Light', '', values, function (error) {
-                should.not.exist(error);
-                contextBrokerMock.done();
-                done();
-            });
-        });
-    });
-});