lib/PluginsManager.js

/**
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
*/

const path = require('path');
const fs = require('fs');
const { logger, exec, utilities } = require('./utils');
const { PluginInfoProvider } = require('cordova-common');
const Server = require('./LocalServer');

class PluginsManager {
    constructor (appRoot, storedCWD, config) {
        this.appRoot = appRoot;
        this.storedCWD = storedCWD;
        this.config = config;
    }

    installPlugins (plugins) {
        for (let n = 0; n < plugins.length; n++) {
            this.installSinglePlugin(plugins[n]);
        }
    }

    installTestsForExistingPlugins () {
        const installedPlugins = new PluginInfoProvider().getAllWithinSearchPath(path.join(this.appRoot, 'plugins'));

        installedPlugins.forEach((plugin) => {
            // there is test plugin available
            if (fs.existsSync(path.join(plugin.dir, 'tests', 'plugin.xml'))) {
                let additionalArgs = '';

                // special handling for cordova-plugin-file-transfer
                if (plugin.id.indexOf('cordova-plugin-file-transfer') >= 0) {
                    if (this.config.getFileTransferServer()) {
                        // user specified a file transfer server address, so using it
                        additionalArgs += ' --variable FILETRANSFER_SERVER_ADDRESS=' + this.config.getFileTransferServer();
                    } else {
                        // no server address specified, starting a local server
                        const server = new Server(0, this.config.getExternalServerUrl());
                        const fileServerUrl = server.getConnectionAddress(this.config.getPlatformId()) + ':5000';
                        additionalArgs += ' --variable FILETRANSFER_SERVER_ADDRESS=' + fileServerUrl;
                    }
                }

                this.installSinglePlugin(path.join(plugin.dir, 'tests') + additionalArgs);
            }
        });

        // this will list installed plugins and their versions
        this.showPluginsVersions();
    }

    installSinglePlugin (plugin) {
        let pluginPath = plugin;
        let args = '';

        // separate plugin name from args
        const argsIndex = plugin.indexOf(' --');
        if (argsIndex > 0) {
            pluginPath = plugin.substring(0, argsIndex);
            args = plugin.substring(argsIndex);
        }

        if (fs.existsSync(path.resolve(this.storedCWD, pluginPath))) {
            plugin = path.resolve(this.storedCWD, pluginPath) + args;
        }

        plugin += utilities.PARAMEDIC_COMMON_CLI_ARGS + utilities.PARAMEDIC_PLUGIN_ADD_ARGS;
        logger.normal('cordova-paramedic: installing plugin ' + plugin);

        const plugAddCmd = exec(this.config.getCli() + ' plugin add ' + plugin);
        if (plugAddCmd.code !== 0) {
            logger.error('Failed to install plugin : ' + plugin);
            throw new Error('Failed to install plugin : ' + plugin);
        }
    }

    showPluginsVersions () {
        logger.normal('cordova-paramedic: versions of installed plugins: ');
        exec(this.config.getCli() + ' plugins' + utilities.PARAMEDIC_COMMON_CLI_ARGS);
    }
}

module.exports = PluginsManager;