iotagent-node-lib 2.19.0 → 2.22.0

package/lib/command/migration.js

@@ -1,176 +0,0 @@
-/*
- * Copyright 2016 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-prototype-builtins */
-
-const async = require('async');
-const logger = require('logops');
-const apply = async.apply;
-const MongoClient = require('mongodb').MongoClient;
-const serviceTranslation = {
-    apikey: 'apikey',
-    token: 'trust',
-    cbroker: 'cbHost',
-    entity_type: 'type',
-    resource: 'resource',
-    service: 'service',
-    service_path: 'subservice',
-    attributes: 'attributes',
-    static_attributes: 'staticAttributes'
-};
-const deviceTranslation = {
-    device_id: 'id',
-    entity_name: 'name',
-    entity_type: 'type',
-    endpoint: 'endpoint',
-    timezone: 'timezone',
-    service: 'service',
-    service_path: 'subservice',
-    protocol: 'protocol',
-    attributes: 'active',
-    static_attributes: 'staticAttributes',
-    commands: 'commands',
-    registration_id: 'registrationId'
-};
-const context = {
-    op: 'IoTAgentNGSI.MigrationTool'
-};
-
-function connectToDb(dbConfig, dbName, callback) {
-    const url = 'mongodb://' + dbConfig.host + ':' + (dbConfig.port || 27017) + '/' + dbName;
-
-    MongoClient.connect(url, { useNewUrlParser: true }, callback);
-}
-
-function generateCollectionTranslator(translationKey) {
-    function translateItem(item, innerCb) {
-        const translatedItem = {};
-
-        for (const i in item) {
-            if (item.hasOwnProperty(i) && translationKey[i]) {
-                translatedItem[translationKey[i]] = item[i];
-            } else if (i !== '_id') {
-                logger.warn(context, 'Attribute [%s] was not found for item translation', i);
-            }
-        }
-
-        innerCb(null, translatedItem);
-    }
-
-    return function translateCollection(docs, innerCb) {
-        async.map(docs, translateItem, innerCb);
-    };
-}
-
-function migrate(dbConfig, originDb, targetDb, service, subservice, callback) {
-    function saveToTargetDb(db, collection, docs, innerCb) {
-        if (docs.length > 0) {
-            db.db()
-                .collection(collection)
-                /* eslint-disable-next-line  no-unused-vars */
-                .insertMany(docs, function (error, inserts) {
-                    innerCb(error);
-                });
-        } else {
-            innerCb();
-        }
-    }
-
-    function setDefaultName(item, innerCb) {
-        if (!item.name || item.name === '') {
-            item.name = item.type + ':' + item.id;
-        }
-
-        innerCb(null, item);
-    }
-
-    function applyDefaultName(docs, innerCb) {
-        async.map(docs, setDefaultName, innerCb);
-    }
-
-    function translateProtocol(item, innerCb) {
-        if (item.protocol && dbConfig.protocols && dbConfig.protocols[item.protocol]) {
-            item.protocol = dbConfig.protocols[item.protocol];
-        }
-
-        innerCb(null, item);
-    }
-
-    function applyProtocolTranslations(docs, innerCb) {
-        async.map(docs, translateProtocol, innerCb);
-    }
-
-    function getCollection(db, name, service, subservice, innerCb) {
-        const query = {};
-
-        if (service) {
-            query.service = service;
-        }
-
-        if (subservice) {
-            query.service_path = subservice;
-        }
-
-        db.db().collection(name).find(query).toArray(innerCb);
-    }
-
-    function closeDb(db, innerCb) {
-        /* eslint-disable-next-line  no-unused-vars */
-        db.close(function (error) {
-            innerCb();
-        });
-    }
-
-    function startMigration(dbResults, innerCb) {
-        const originDb = dbResults[0];
-        const targetDb = dbResults[1];
-
-        async.waterfall(
-            [
-                apply(getCollection, originDb, 'SERVICE', service, subservice),
-                generateCollectionTranslator(serviceTranslation),
-                apply(saveToTargetDb, targetDb, 'groups'),
-                apply(getCollection, originDb, 'DEVICE', service, subservice),
-                generateCollectionTranslator(deviceTranslation),
-                applyDefaultName,
-                applyProtocolTranslations,
-                apply(saveToTargetDb, targetDb, 'devices'),
-                apply(closeDb, originDb),
-                apply(closeDb, targetDb)
-            ],
-            function (error) {
-                innerCb(error);
-            }
-        );
-    }
-
-    async.waterfall(
-        [
-            apply(async.series, [apply(connectToDb, dbConfig, originDb), apply(connectToDb, dbConfig, targetDb)]),
-            startMigration
-        ],
-        callback
-    );
-}
-
-exports.migrate = migrate;

package/test/unit/general/migration-test.js

@@ -1,257 +0,0 @@
-/*
- * Copyright 2016 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 migration = require('../../../lib/command/migration');
-const mongo = require('mongodb').MongoClient;
-const mongoUtils = require('../mongodb/mongoDBUtils');
-const utils = require('../../tools/utils');
-const request = utils.request;
-const logger = require('logops');
-const async = require('async');
-const apply = async.apply;
-const should = require('should');
-const deviceCollection = utils.readExampleFile('./test/unit/examples/mongoCollections/devices.json');
-const configurationCollection = utils.readExampleFile('./test/unit/examples/mongoCollections/configurations.json');
-let originDb;
-let targetDb;
-
-describe('MongoDB migration', function () {
-    beforeEach(function (done) {
-        logger.setLevel('FATAL');
-
-        mongo.connect('mongodb://localhost:27017/iotOrigin', { useNewUrlParser: true }, function (err, client) {
-            originDb = client;
-            mongo.connect('mongodb://localhost:27017/iotTarget', { useNewUrlParser: true }, function (err, client) {
-                targetDb = client;
-                async.series(
-                    [
-                        apply(mongoUtils.populate, 'localhost', 'iotOrigin', deviceCollection, 'DEVICE'),
-                        apply(mongoUtils.populate, 'localhost', 'iotOrigin', configurationCollection, 'SERVICE')
-                    ],
-                    done
-                );
-            });
-        });
-    });
-
-    afterEach(function (done) {
-        mongoUtils.cleanDb('localhost', 'iotTarget', function (error) {
-            mongoUtils.cleanDb('localhost', 'iotOrigin', function (error) {
-                originDb.close(function (error) {
-                    targetDb.close(function (error) {
-                        done();
-                    });
-                });
-            });
-        });
-    });
-
-    describe('When the full migration command is executed for two databases', function () {
-        const config = {
-            host: 'localhost',
-            port: '27017'
-        };
-
-        it('should migrate all the services', function (done) {
-            migration.migrate(config, 'iotOrigin', 'iotTarget', null, null, function () {
-                targetDb
-                    .db()
-                    .collection('groups')
-                    .find({})
-                    .toArray(function (err, docs) {
-                        should.not.exist(err);
-                        docs.length.should.equal(3);
-                        done();
-                    });
-            });
-        });
-        it('should migrate all the devices', function (done) {
-            migration.migrate(config, 'iotOrigin', 'iotTarget', null, null, function () {
-                targetDb
-                    .db()
-                    .collection('devices')
-                    .find({})
-                    .toArray(function (err, docs) {
-                        should.not.exist(err);
-                        docs.length.should.equal(4);
-                        done();
-                    });
-            });
-        });
-        it('should migrate all the fields for each device', function (done) {
-            migration.migrate(config, 'iotOrigin', 'iotTarget', null, null, function () {
-                targetDb
-                    .db()
-                    .collection('groups')
-                    .find({
-                        service: 'dumb_mordor'
-                    })
-                    .toArray(function (err, docs) {
-                        should.not.exist(err);
-                        docs.length.should.equal(1);
-                        should.exist(docs[0].apikey);
-                        should.exist(docs[0].cbHost);
-                        should.exist(docs[0].resource);
-                        should.exist(docs[0].service);
-                        should.exist(docs[0].subservice);
-                        should.exist(docs[0].type);
-                        should.exist(docs[0].staticAttributes);
-                        done();
-                    });
-            });
-        });
-        it('should migrate all the fields for each service', function (done) {
-            migration.migrate(config, 'iotOrigin', 'iotTarget', null, null, function () {
-                targetDb
-                    .db()
-                    .collection('devices')
-                    .find({
-                        id: 'gk20'
-                    })
-                    .toArray(function (err, docs) {
-                        should.not.exist(err);
-                        docs.length.should.equal(1);
-                        should.exist(docs[0].id);
-                        should.exist(docs[0].name);
-                        should.exist(docs[0].protocol);
-                        should.exist(docs[0].service);
-                        should.exist(docs[0].subservice);
-                        should.exist(docs[0].type);
-                        should.exist(docs[0].active);
-                        should.exist(docs[0].staticAttributes);
-                        docs[0].id = 'gk20';
-                        docs[0].name = 'The GK20 Entity';
-                        docs[0].protocol = 'PDI-IoTA-UltraLight';
-                        docs[0].service = 'smart_gondor';
-                        docs[0].subservice = '/gardens';
-                        docs[0].type = 'acme.lights.sensor';
-                        done();
-                    });
-            });
-        });
-    });
-
-    describe('When a service migration command is executed', function () {
-        const config = {
-            host: 'localhost',
-            port: '27017'
-        };
-
-        it("should migrate just the service's  configurations", function (done) {
-            migration.migrate(config, 'iotOrigin', 'iotTarget', 'smart_gondor', null, function () {
-                targetDb
-                    .db()
-                    .collection('groups')
-                    .find({})
-                    .toArray(function (err, docs) {
-                        should.not.exist(err);
-                        docs.length.should.equal(1);
-                        done();
-                    });
-            });
-        });
-        it("should migrate just the service's devices", function (done) {
-            migration.migrate(config, 'iotOrigin', 'iotTarget', 'smart_gondor', null, function () {
-                targetDb
-                    .db()
-                    .collection('devices')
-                    .find({})
-                    .toArray(function (err, docs) {
-                        should.not.exist(err);
-                        docs.length.should.equal(3);
-                        done();
-                    });
-            });
-        });
-    });
-
-    describe('When a device has an empty string in its name', function () {
-        const config = {
-            host: 'localhost',
-            port: '27017'
-        };
-
-        it('should set the name as undefined', function (done) {
-            migration.migrate(config, 'iotOrigin', 'iotTarget', 'dumb_mordor', null, function () {
-                targetDb
-                    .db()
-                    .collection('devices')
-                    .find({})
-                    .toArray(function (err, docs) {
-                        docs.length.should.equal(1);
-                        should.exist(docs[0].name);
-                        docs[0].name.should.equal(docs[0].type + ':' + docs[0].id);
-                        done();
-                    });
-            });
-        });
-    });
-
-    describe('When a subservice migration command is executed', function () {
-        const config = {
-            host: 'localhost',
-            port: '27017'
-        };
-
-        it("should migrate just the subservice's devices", function (done) {
-            migration.migrate(config, 'iotOrigin', 'iotTarget', 'smart_gondor', '/gardens', function () {
-                targetDb
-                    .db()
-                    .collection('devices')
-                    .find({})
-                    .toArray(function (err, docs) {
-                        should.not.exist(err);
-                        docs.length.should.equal(1);
-                        done();
-                    });
-            });
-        });
-    });
-
-    describe('When a subservice migration configuration has a protocol translation table', function () {
-        const config = {
-            host: 'localhost',
-            port: '27017',
-            protocols: {
-                'PDI-IoTA-UltraLight': 'NODE-Ultralight'
-            }
-        };
-
-        it('should change the protocol to the translated one', function (done) {
-            migration.migrate(config, 'iotOrigin', 'iotTarget', 'smart_gondor', '/gardens', function () {
-                targetDb
-                    .db()
-                    .collection('devices')
-                    .find({})
-                    .toArray(function (err, docs) {
-                        should.not.exist(err);
-                        docs.length.should.equal(1);
-                        docs[0].protocol.should.equal('NODE-Ultralight');
-                        done();
-                    });
-            });
-        });
-    });
-});