9171759696

Committed 21 May 2024 08:50AM UTC coverage: 81.86% (-0.05%) from 81.909%

Build # 9171759696

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #637 from telefonicaid/dependabot/pip/test/acceptance/requests-2.32.0

Bump requests from 2.31.0 to 2.32.0 in /test/acceptance

Run Details

1235 of 1626 branches covered (75.95%)

Branch coverage included in aggregate %.

2127 of 2481 relevant lines covered (85.73%)

141.79 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

82.5

/lib/database/model/sthDatabaseNameCodecTool.js

/*
 * Copyright 2016 Telefónica Investigación y Desarrollo, S.A.U
 *
 * This file is part of the Short Time Historic (STH) component
 *
 * STH 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.
 *
 * STH 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 STH.
 * If not, see http://www.gnu.org/licenses/.
 *
 * For those usages not covered by the GNU Affero General Public License
 * please contact with: [german.torodelvalle@telefonica.com]
 */

/* eslint-disable consistent-return */

const ROOT_PATH = require('app-root-path');
const async = require('async');
const sthLogger = require('logops');
const sthConfig = require(ROOT_PATH + '/lib/configuration/sthConfiguration');
const sthDatabase = require(ROOT_PATH + '/lib/database/sthDatabase');
const sthDatabaseNameCodec = require(ROOT_PATH + '/lib/database/model/sthDatabaseNameCodec');
const sthDatabaseNaming = require(ROOT_PATH + '/lib/database/model/sthDatabaseNaming');
const sthErrors = require(ROOT_PATH + '/lib/errors/sthErrors');

let analysisResult = {};

/**
 * Resets the analysis report
 */
function resetAnalysisResult(callback) {
    analysisResult = {};
    return process.nextTick(callback);
}

/**
 * Returns asynchronously the list of databases associated to a STH instance
 * @param  {Object}   connection The database associated to the STH instance
 * @param  {Function} callback   The callback accepting a possible error as its first param and the list of databases
 *                               as the second one
 */
function listDatabases(connection, callback) {
    const adminDB = connection.admin();
    adminDB.listDatabases(callback);
}

/**
 * Filters the databases associated to a STH instance
 * @param {Object}    options      An object including the following properties:
 *                                 - {Boolean} encode     Flag indicating if the request is about a codification
 *                                 process
 *                                 - {Boolean} decode     Flag indicating if the request is about a decodification
 *                                 process
 *                                 - {String}  database   The database name to restrict the analysis to
 *                                 - {String}  collection The collection name to restrict the analysis to
 * @param  {Object}   databaseData The database data
 * @param  {Function} callback     The callback
 */
function databaseFilter(options, databaseData, callback) {
    callback(
        null,
        databaseData.name.indexOf(
            (options.decode ? sthDatabaseNameCodec.decodeDatabaseName(sthConfig.DB_PREFIX) : sthConfig.DB_PREFIX) === 0
        ) &&
            (!options.database || (options.database && options.database === databaseData.name))
    );
}

/**
 * Filters the databases to only consider the ones associated to a STH instance
 * @param {Object}    options       An object including the following properties:
 *                                  - {Boolean} encode     Flag indicating if the request is about a codification
 *                                  process
 *                                  - {Boolean} decode     Flag indicating if the request is about a decodification
 *                                  process
 *                                  - {String}  database   The database name to restrict the analysis to
 *                                  - {String}  collection The collection name to restrict the analysis to
 * @param  {Object}   databasesData Data about the databases to filter
 * @param  {Function} callback      The callback
 */
function filterDatabases(options, databasesData, callback) {
    async.filter(databasesData.databases, async.apply(databaseFilter, options), callback);
}

/**
 * Includes the associated database name to some collection database
 * @param {String}   databaseName   The database name
 * @param {Object}   collectionData The collection database
 * @param {Function} callback       The callback
 */
function addDatabaseName(databaseName, collectionData, callback) {
    collectionData.database = databaseName;
    return callback(null, collectionData);
}

/**
 * Lists the collections in certain databaseName
 * @param  {String}   databaseName The database name
 * @param  {Function} callback     The callback
 */
function listCollections(databaseName, callback) {
    sthDatabase.client
        .db(databaseName)
        .listCollections()
        .toArray(function(err, collections) {
            if (collections) {
                async.map(collections, async.apply(addDatabaseName, databaseName), callback);
            }
        });
}

/**
 * Filters a collection from its database
 * @param {Object}    options        An object including the following properties:
 *                                   - {Boolean} encode     Flag indicating if the request is about a codification
 *                                   process
 *                                   - {Boolean} decode     Flag indicating if the request is about a decodification
 *                                   process
 *                                   - {String}  database   The database name to restrict the analysis to
 *                                   - {String}  collection The collection name to restrict the analysis to
 * @param  {Object}   collectionData The collection database
 * @param  {Function} callback       The callback
 */
function collectionFilter(options, collectionData, callback) {
    return callback(
        null,
        collectionData.name.indexOf(
            options.decode
                ? sthDatabaseNameCodec.decodeCollectionName(sthConfig.COLLECTION_PREFIX)
                : sthConfig.COLLECTION_PREFIX
        ) === 0 &&
            (!options.collection || (options.collection && options.collection === collectionData.name))
    );
}

/**
 * Filters the collections included in some collections database
 * @param {Object}    options         An object including the following properties:
 *                                    - {Boolean} encode     Flag indicating if the request is about a codification
 *                                    process
 *                                    - {Boolean} decode     Flag indicating if the request is about a decodification
 *                                    process
 *                                    - {String}  database   The database name to restrict the analysis to
 *                                    - {String}  collection The collection name to restrict the analysis to
 * @param  {Object}   collectionsData The collections database
 * @param  {Function} callback        The callback
 */
function filterCollections(options, collectionsData, callback) {
    async.filter(collectionsData, async.apply(collectionFilter, options), callback);
}

/**
 * Analyses a collection from its associated data
 * @param {Object}    options        An object including the following properties:
 *                                   - {Boolean} encode     Flag indicating if the request is about a codification
 *                                   process
 *                                   - {Boolean} decode     Flag indicating if the request is about a decodification
 *                                   process
 *                                   - {String}  database   The database name to restrict the analysis to
 *                                   - {String}  collection The collection name to restrict the analysis to
 * @param  {Object}   collectionData The collection data
 * @param  {Function} callback       The callback
 */
function analyseCollection(options, collectionData, callback) {
    analysisResult[collectionData.database].collections = analysisResult[collectionData.database].collections || {};
    analysisResult[collectionData.database].collections[collectionData.name] = {
        name: options.encode
            ? sthDatabaseNameCodec.encodeCollectionName(collectionData.name)
            : sthDatabaseNameCodec.decodeCollectionName(collectionData.name)
    };
    process.nextTick(callback);
}

/**
 * Effectively analyses a group of collection from its associated data
 * @param {Object}    options         An object including the following properties:
 *                                    - {Boolean} encode     Flag indicating if the request is about a codification
 *                                    process
 *                                    - {Boolean} decode     Flag indicating if the request is about a decodification
 *                                    process
 *                                    - {String}  database   The database name to restrict the analysis to
 *                                    - {String}  collection The collection name to restrict the analysis to
 * @param  {Object}   collectionsData The collections database
 * @param  {Function} callback        The callback
 */
function doAnalyseCollections(options, collectionsData, callback) {
    async.each(collectionsData, async.apply(analyseCollection, options), callback);
}

/**
 * Analyses the collections in certain database
 * @param {Object}    options      An object including the following properties:
 *                                 - {Boolean} encode     Flag indicating if the request is about a codification
 *                                 process
 *                                 - {Boolean} decode     Flag indicating if the request is about a decodification
 *                                 process
 *                                 - {String}  database   The database name to restrict the analysis to
 *                                 - {String}  collection The collection name to restrict the analysis to
 * @param  {String}   databaseName The database name
 * @param  {Function} callback     The callback
 */
function analyseCollections(options, databaseName, callback) {
    async.seq(
        async.apply(listCollections, databaseName),
        async.apply(filterCollections, options),
        async.apply(doAnalyseCollections, options)
    )(callback);
}

/**
 * Analyses database data to generate the encoding/decoding report for this database
 * @param {Object}    options      An object including the following properties:
 *                                 - {Boolean} encode     Flag indicating if the request is about a codification
 *                                 process
 *                                 - {Boolean} decode     Flag indicating if the request is about a decodification
 *                                 process
 *                                 - {String}  database   The database name to restrict the analysis to
 *                                 - {String}  collection The collection name to restrict the analysis to
 * @param  {Object}   databaseData The database data
 * @param  {Function} callback     The callback
 */
function analyseDatabase(options, databaseData, callback) {
    analysisResult[databaseData.name] = {
        name: options.encode
            ? sthDatabaseNameCodec.encodeDatabaseName(databaseData.name)
            : sthDatabaseNameCodec.decodeDatabaseName(databaseData.name)
    };
    analyseCollections(options, databaseData.name, callback);
}

/**
 * Analyses a group of database data to generate a new encoding/decoding report
 * @param {Object}    options       An object including the following properties:
 *                                  - {Boolean} encode     Flag indicating if the request is about a codification
 *                                  process
 *                                  - {Boolean} decode     Flag indicating if the request is about a decodification
 *                                  process
 *                                  - {String}  database   The database name to restrict the analysis to
 *                                  - {String}  collection The collection name to restrict the analysis to
 * @param  {Object}   databasesData The databases data
 * @param  {Function} callback      The callback
 */
function analyseDatabases(options, databasesData, callback) {
    async.each(databasesData, async.apply(analyseDatabase, options), callback);
}

/**
 * Removes from the encoding analysis information about collections and databases whose names do not change after the
 * encoding or decoding
 * @param  {Function} callback The callback
 */
function cleanAnalysis(callback) {
    const databaseNames = Object.getOwnPropertyNames(analysisResult);
    databaseNames.forEach(function(databaseName) {
        if (analysisResult[databaseName].collections) {
            const collectionNames = Object.getOwnPropertyNames(analysisResult[databaseName].collections);
            collectionNames.forEach(function(collectionName) {
                if (collectionName === analysisResult[databaseName].collections[collectionName].name) {
                    delete analysisResult[databaseName].collections[collectionName];
                }
            });
            if (Object.keys(analysisResult[databaseName].collections).length === 0) {
                delete analysisResult[databaseName].collections;
                if (databaseName === analysisResult[databaseName].name) {
                    delete analysisResult[databaseName];
                }
            }
        } else if (databaseName === analysisResult[databaseName].name) {
            delete analysisResult[databaseName];
        }
    });
    process.nextTick(callback.bind(null, null, analysisResult));
}

/**
 * Shows the codification report
 * @param {Object}   options  An object including the following properties:
 *                            - {Boolean} encode     Flag indicating if the request is about a codification process
 *                            - {Boolean} decode     Flag indicating if the request is about a decodification process
 *                            - {String}  database   The database name to restrict the analysis to
 *                            - {String}  collection The collection name to restrict the analysis to
 * @param {Function} callback A callback function accepting a possible error as the first parameter and the result
 *                            returned by the last function of the sequence
 */
function getEncodingAnalysis(options, callback) {
    if (!options.encode && !options.decode) {
        return process.nextTick(
            callback.bind(
                null,
                new sthErrors.MandatoryOptionNotFound(
                    'Either the -e (--encode) or the -d (--decode) options are mandatory'
                )
            )
        );
    }
    if (options.collection && !options.database) {
        return process.nextTick(
            callback.bind(
                null,
                new sthErrors.MandatoryOptionNotFound(
                    'The -b (--database) option is mandatory if the -c (--collection) option is set'
                )
            )
        );
    }
    async.seq(
        resetAnalysisResult,
        sthDatabase.connect.bind(null, {
            authentication: sthConfig.DB_AUTHENTICATION,
            dbURI: sthConfig.DB_URI,
            replicaSet: sthConfig.REPLICA_SET,
            database: sthDatabaseNaming.getDatabaseName(sthConfig.DEFAULT_SERVICE),
            poolSize: sthConfig.POOL_SIZE,
            authSource: sthConfig.DB_AUTH_SOURCE
        }),
        listDatabases,
        async.apply(filterDatabases, options),
        async.apply(analyseDatabases, options),
        cleanAnalysis
    )(callback);
}

/**
 * Encodes or decodes the name of certain collection in certain databaseName
 * @param {Object}    options        An object including the following properties:
 *                                   - {Boolean} encode     Flag indicating if the request is about a codification
 *                                   process
 *                                   - {Boolean} decode     Flag indicating if the request is about a decodification
 *                                   process
 *                                   - {String}  database   The database name to restrict the analysis to
 *                                   - {String}  collection The collection name to restrict the analysis to
 * @param  {String}   databaseName   The database name
 * @param  {String}   collectionName The collection name
 * @param  {Function} callback       The callback
 */
function encodeOrDecodeCollection(options, databaseName, collectionName, callback) {
    sthLogger.info(
        sthConfig.LOGGING_CONTEXT.DB_LOG,
        // prettier-ignore
        (options.encode ? 'Codification' : 'Decodification') + " of collection '" + collectionName +
            "' of database '" + databaseName + "' started..."
    );

    sthDatabase.client
        .db(databaseName)
        .renameCollection(
            collectionName,
            options.encode
                ? sthDatabaseNameCodec.encodeCollectionName(collectionName)
                : sthDatabaseNameCodec.decodeCollectionName(collectionName),
            function(err) {
                if (err) {
                    return process.nextTick(callback.bind(null, err));
                }
                sthLogger.info(
                    sthConfig.LOGGING_CONTEXT.DB_LOG,
                    // prettier-ignore
                    (options.encode ? 'Codification' : 'Decodification') + " of collection '" + collectionName +
                         "' of database '" + databaseName + "' successfully completed."
                );
                return process.nextTick(callback);
            }
        );
}

/**
 * Copies a database since this is the only way to rename it (the original database is removed afterwards)
 * @param {Object}    options      An object including the following properties:
 *                                 - {Boolean} encode     Flag indicating if the request is about a codification process
 *                                 - {Boolean} decode     Flag indicating if the request is about a decodification
 *                                 process
 *                                 - {String}  database   The database name to restrict the analysis to
 *                                 - {String}  collection The collection name to restrict the analysis to
 * @param  {String}   databaseName The database name
 * @param  {Function} callback     The callback
 */

// Alternative function without copydb command
function copyDatabase(options, databaseName, callback) {
    const adminDB = sthDatabase.connection.admin();
    const listCommand = {
        listCollections: 1,
        nameOnly: true
    };
    var sourceDB = databaseName;
    var targetDB = options.encode
        ? sthDatabaseNameCodec.encodeDatabaseName(databaseName)
        : sthDatabaseNameCodec.decodeDatabaseName(databaseName);

    const db = sthDatabase.client.db(databaseName);
    db.command(listCommand, function onListCollections(err, results) {
        if (err) {
            return process.nextTick(callback.bind(null, err));
        }

        var arrayCollectionRenames = [];
        results.cursor.firstBatch.forEach((collection) => {
            var source = sourceDB + '.' + collection.name;
            var destination = targetDB + '.' + collection.name;

            let collectionData = { source: source, destination: destination, db: adminDB };
            arrayCollectionRenames.push(collectionData);
        });

        async.map(
            arrayCollectionRenames,
            function(element, callback) {
                element.db.command(
                    { renameCollection: element.source, to: element.destination, dropTarget: true },
                    function(err) {
                        callback(err);
                    }
                );
            },
            function(err) {
                if (err) {
                    return process.nextTick(callback.bind(null, err));
                }
                sthLogger.info(
                    sthConfig.LOGGING_CONTEXT.DB_LOG,
                    // prettier-ignore
                    (options.encode ? 'Codification' : 'Decodification') + " of database '" + databaseName +
                        ' successfully completed.'
                );
                process.nextTick(callback);
            }
        );
    });
}

/**
 * Encodes or decodes the name of certain database and its collections
 * @param {Object}    options      An object including the following properties:
 *                                 - {Boolean} encode     Flag indicating if the request is about a codification process
 *                                 - {Boolean} decode     Flag indicating if the request is about a decodification
 *                                 process
 *                                 - {String}  database   The database name to restrict the analysis to
 *                                 - {String}  collection The collection name to restrict the analysis to
 * @param  {String}   databaseName The database name
 * @param  {Function} callback     The callback
 */
function encodeOrDecodeDatabase(options, databaseName, callback) {
    sthLogger.info(
        sthConfig.LOGGING_CONTEXT.DB_LOG,
        (options.encode ? 'Codification' : 'Decodification') + " of database '" + databaseName + ' started...'
    );

    let collectionNames;
    if (
        analysisResult[databaseName].collections &&
        Object.getOwnPropertyNames(analysisResult[databaseName].collections).length
    ) {
        collectionNames = Object.getOwnPropertyNames(analysisResult[databaseName].collections);
        async.eachSeries(
            collectionNames,
            async.apply(encodeOrDecodeCollection, options, databaseName),
            function onEncodeOrDecodeCollection(err) {
                if (err) {
                    return process.nextTick(callback.bind(null, err));
                }
                if (databaseName !== analysisResult[databaseName].name) {
                    copyDatabase(options, databaseName, callback);
                } else {
                    sthLogger.info(
                        sthConfig.LOGGING_CONTEXT.DB_LOG,
                        // prettier-ignore
                        (options.encode ? 'Codification' : 'Decodification') + " of database '" + databaseName +
                            ' successfully completed.'
                    );
                    process.nextTick(callback);
                }
            }
        );
    } else if (databaseName !== analysisResult[databaseName].name) {
        copyDatabase(options, databaseName, callback);
    } else {
        sthLogger.info(
            sthConfig.LOGGING_CONTEXT.DB_LOG,
            // prettier-ignore
            (options.encode ? 'Codification' : 'Decodification') + " of database '" + databaseName +
                    ' successfully completed.'
        );
        process.nextTick(callback);
    }
}

/**
 * Effectively encodes or decodes the name of the databases and collections included in certain encoding/decoding
 * analysis
 * @param {Object}    options   An object including the following properties:
 *                              - {Boolean} encode     Flag indicating if the request is about a codification process
 *                              - {Boolean} decode     Flag indicating if the request is about a decodification process
 *                              - {String}  database   The database name to restrict the analysis to
 *                              - {String}  collection The collection name to restrict the analysis to
 * @param  {Object}   analysis The analysis
 * @param  {Function} callback The callback
 */
function doEncodeOrDecode(options, analysis, callback) {
    const databaseNames = Object.getOwnPropertyNames(analysis);
    async.eachSeries(databaseNames, async.apply(encodeOrDecodeDatabase, options), callback);
}

/**
 * Encodes or decodes the names of the databases and the collections included in certain encoding/decoding analysis
 * @param {Object}   options  An object including the following properties:
 *                            - {Boolean} encode     Flag indicating if the request is about a codification process
 *                            - {Boolean} decode     Flag indicating if the request is about a decodification process
 *                            - {String}  database   The database name to restrict the analysis to
 *                            - {String}  collection The collection name to restrict the analysis to
 * @param  {Function} callback The callback
 */
function encodeOrDecode(options, callback) {
    if (!options.encode && !options.decode) {
        return process.nextTick(
            callback.bind(
                null,
                new sthErrors.MandatoryOptionNotFound(
                    'Either the -e (--encode) or the -d (--decode) options are mandatory'
                )
            )
        );
    }
    if (options.collection && !options.database) {
        return process.nextTick(
            callback.bind(
                null,
                new sthErrors.MandatoryOptionNotFound(
                    'The -b (--database) option is mandatory if the -c (--collection) option is set'
                )
            )
        );
    }

    sthLogger.info(
        sthConfig.LOGGING_CONTEXT.DB_LOG,
        (options.encode ? 'Codification' : 'Decodification') + ' process started...'
    );

    async.seq(async.apply(getEncodingAnalysis, options), async.apply(doEncodeOrDecode, options))(callback);
}

module.exports = {
    getEncodingAnalysis,
    encodeOrDecode
};

telefonicaid / fiware-sth-comet / 9171759696

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous