cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From vladimir-kotikov <...@git.apache.org>
Subject [GitHub] cordova-paramedic pull request #11: Appium tests
Date Wed, 06 Jul 2016 08:39:50 GMT
Github user vladimir-kotikov commented on a diff in the pull request:

    https://github.com/apache/cordova-paramedic/pull/11#discussion_r69693319
  
    --- Diff: lib/appium/AppiumRunner.js ---
    @@ -0,0 +1,483 @@
    +#!/usr/bin/env node
    +
    +/*
    + * 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.
    + */
    +
    +/* jshint node: true */
    +
    +"use strict";
    +
    +var fs               = require("fs");
    +var path             = require("path");
    +var util             = require("./helpers/util");
    +var logger           = require("../utils").logger;
    +var MedicReporter    = require("./helpers/MedicReporter");
    +var wd               = require("wd");
    +var wdHelper         = require("./helpers/wdHelper");
    +var screenshotHelper = require("./helpers/screenshotHelper");
    +var kill             = require("tree-kill");
    +var child_process    = require("child_process");
    +var expectTelnet     = require("expect-telnet");
    +var shell            = require("shelljs");
    +var Jasmine          = require("jasmine");
    +var unorm            = require("unorm");
    +var elementTree      = require("elementtree");
    +var q                = require("q");
    +var jasmineReporters = require("jasmine-reporters");
    +
    +var KILL_SIGNAL = "SIGINT";
    +var SMALL_BUFFER_SIZE = 1024 * 1024;
    +var BIG_BUFFER_SIZE = 50 * 1024 * 1024;
    +var APPIUM_SERVER_PATH = getAppiumServerPath();
    +
    +function AppiumRunner(options) {
    +    this.options = options;
    +    this.findTests();
    +    this.setGlobals();
    +}
    +
    +function getAppiumServerPath() {
    +    return path.resolve(process.cwd(), "cordova-paramedic/node_modules/appium/build/lib/main.js");
    +}
    +
    +function getFullAppPath(appPath) {
    +    var fullPath = appPath;
    +    if (!path.isAbsolute(appPath)) {
    +        fullPath = path.join(__dirname, "../..", appPath);
    +    }
    +    return fullPath;
    +}
    +
    +function getPackagePath(options) {
    +    if (options.sauce) {
    +        return options.sauceAppPath;
    +    }
    +
    +    var fullAppPath = getFullAppPath(options.appPath);
    +
    +    switch (options.platform) {
    +    case "android":
    +        return path.join(fullAppPath, "/platforms/android/build/outputs/apk/android-debug.apk");
    +    case "ios":
    +        var searchDir = options.device ?
    +            path.join(getFullAppPath(options.appPath), "/platforms/ios/build/device/")
:
    +            path.join(getFullAppPath(options.appPath), "/platforms/ios/build/emulator/");
    +        var fileMask = options.device ? "*.ipa" : "*.app";
    +        var files = shell.ls(searchDir + fileMask);
    +        logger.normal("paramedic-appium: Looking for app package in " + searchDir);
    +        if (files && files.length > 0) {
    +            logger.normal("paramedic-appium: Found app package: " + files[0]);
    +            return files[0];
    +        }
    +        throw new Error("Could not find the app package");
    +    }
    +}
    +
    +function getPluginDirs(appPath) {
    +    return shell.ls(path.join(appPath, "/plugins/cordova-plugin-*"));
    +}
    +
    +function getConfigPath(appPath) {
    +    return path.join(appPath, "config.xml");
    +}
    +
    +function parseElementtreeSync(filename) {
    +    var contents = fs.readFileSync(filename, util.DEFAULT_ENCODING);
    +    if (!contents) {
    +        throw new Error("The config file is empty: " + filename);
    +    }
    +    // Skip the Byte Order Mark (BOM)
    +    contents = contents.substring(contents.indexOf("<"));
    +
    +    return new elementTree.ElementTree(elementTree.XML(contents));
    +}
    +
    +function addCspSource(appPath, directive, source) {
    +    var cspInclFile = path.join(appPath, "www/csp-incl.js");
    +    var indexFile = path.join(appPath, "www/index.html");
    +    var cspFile = fs.existsSync(cspInclFile) ? cspInclFile : indexFile;
    +    var cspContent = fs.readFileSync(cspFile, util.DEFAULT_ENCODING);
    +    var cspTagOpening = "<meta http-equiv=\"Content-Security-Policy\" content=\"";
    +    var cspRule = directive + " " + source;
    +    var cspRuleReg = new RegExp(directive + "[^;\"]+" + source.replace("*", "\\*"));
    +
    +    logger.normal("paramedic-appium: Adding CSP source \"" + source + "\" to directive
\"" + directive + "\"");
    +
    +    if (cspContent.match(cspRuleReg)) {
    +        logger.normal("paramedic-appium: It's already there.");
    +    } else if (util.contains(cspContent, directive)) {
    +        // if the directive is there, just add the source to it
    +        cspContent = cspContent.replace(directive, cspRule);
    +        fs.writeFileSync(cspFile, cspContent, util.DEFAULT_ENCODING);
    +    } else if (cspContent.match(/content=".*?default-src.+?"/)) {
    +        // needed directive is not there but there is default-src directive
    +        // creating needed directive and copying default-src sources to it
    +        var defaultSrcReg = /(content=".*?default-src)(.+?);/;
    +        cspContent = cspContent.replace(defaultSrcReg, "$1$2; " + cspRule + "$2;");
    +        fs.writeFileSync(cspFile, cspContent, util.DEFAULT_ENCODING);
    +    } else if (util.contains(cspContent, cspTagOpening)) {
    +        // needed directive is not there and there is no default-src directive
    +        // but the CSP tag is till present
    +        // just adding needed directive to a start of CSP tag content
    +        cspContent = cspContent.replace(cspTagOpening, cspTagOpening + directive + "
" + source + "; ");
    +        fs.writeFileSync(cspFile, cspContent, util.DEFAULT_ENCODING);
    +    } else {
    +        // no CSP tag, skipping
    +        logger.normal("paramedic-appium: WARNING: No CSP tag found.");
    +    }
    +}
    +
    +function setPreference(appPath, preference, value) {
    +    var configFile = getConfigPath(appPath);
    +    var xml = parseElementtreeSync(configFile);
    +    var pref = xml.find("preference[@name=\"" + preference + "\"]");
    +
    +    logger.normal("paramedic-appium: Setting \"" + preference + "\" preference to \""
+ value + "\"");
    +
    +    if (!pref) {
    +        pref = new elementTree.Element("preference");
    +        pref.attrib.name = preference;
    +        xml.getroot().append(pref);
    +    }
    +    pref.attrib.value = value;
    +
    +    // write the changes
    +    fs.writeFileSync(configFile, xml.write({indent: 4}), util.DEFAULT_ENCODING);
    +}
    +
    +function permitAccess(appPath, origin) {
    +    var configFile = getConfigPath(appPath);
    +    var xml = parseElementtreeSync(configFile);
    +    var rule = xml.find("access[@origin=\"" + origin + "\"]");
    +
    +    logger.normal("paramedic-appium: Adding a whitelist 'access' rule for origin: " +
origin);
    +
    +    if (rule) {
    +        logger.normal("paramedic-appium: It is already in place");
    +    } else {
    +        rule = new elementTree.Element("access");
    +        rule.attrib.origin = origin;
    +        xml.getroot().append(rule);
    +        fs.writeFileSync(configFile, xml.write({indent: 4}), util.DEFAULT_ENCODING);
    +    }
    +}
    +
    +function runCommand(command, appPath) {
    +    if (appPath) {
    +        shell.pushd(appPath);
    +    }
    +    shell.exec(command);
    +    if (appPath) {
    +        shell.popd();
    +    }
    +}
    +
    +function isFailFastError(error) {
    +    if (error && error.message) {
    +        return error.message.indexOf("Could not find a connected") > -1 ||
    +            error.message.indexOf("Bad app") > -1;
    +    }
    +    return false;
    +}
    +
    +function killProcess(procObj, killSignal, callback) {
    +    if (procObj && procObj.alive) {
    +        procObj.alive = false;
    +        setTimeout(function () {
    +            kill(procObj.process.pid, killSignal, callback);
    +        }, 1000);
    +    } else {
    +        callback();
    +    }
    +}
    +
    +function installAppiumServer(success, fail) {
    +    logger.normal("paramedic-appium: Installing Appium server...");
    +    shell.pushd(path.join(__dirname, "../.."));
    +    shell.exec("npm install appium", { async: true, silent: !global.VERBOSE }, function
(code, stdout) {
    +        if (code !== 0) {
    +            fail("Couldn't install Appium server:\n" + stdout);
    +        } else {
    +            success();
    +        }
    +    });
    +    shell.popd();
    +}
    +
    +AppiumRunner.prototype.cleanUp = function (callback) {
    +    var self = this;
    +
    +    killProcess(self.appium, KILL_SIGNAL, function () {
    +        killProcess(self.iosProxy, KILL_SIGNAL, function () {
    +            callback();
    +        });
    +    });
    +};
    +
    +AppiumRunner.prototype.startTests = function (callback) {
    +    var jasmine = new Jasmine();
    +    var self = this;
    +
    +    function exitGracefully(e) {
    +        if (!!e) {
    +            logger.normal("paramedic-appium: " + e);
    +        }
    +        logger.normal("paramedic-appium: Uncaught exception! Killing server and exiting
in 2 seconds...");
    +        killProcess(self.appium, KILL_SIGNAL, function () {
    +            killProcess(self.iosProxy, KILL_SIGNAL, function () {
    +                setTimeout(function () {
    +                    callback(e.stack);
    +                }, 2000);
    +            });
    +        });
    +    }
    +
    +    process.on("uncaughtException", function(err) {
    +        exitGracefully(err);
    +    });
    +
    +    logger.normal("paramedic-appium: Running tests from:");
    +    self.options.testPaths.forEach(function (testPath) {
    +        logger.normal("paramedic-appium: " + testPath);
    +    });
    +
    +    jasmine.loadConfig({
    +        spec_dir: "",
    +        spec_files: self.options.testPaths
    +    });
    +
    +    var medicReporter = new MedicReporter(function (results) {
    +        self.cleanUp(callback);
    +    });
    +    // don't use default reporter, it exits the process before
    +    // we would get the chance to kill appium server
    +    //jasmine.configureDefaultReporter({ showColors: false });
    +    jasmine.addReporter(medicReporter);
    +
    +    var outputDir = self.options.output || process.cwd();
    +    var jUnitReporter = new jasmineReporters.JUnitXmlReporter( {savePath: outputDir,
consolidateAll: false });
    +    jasmine.addReporter(jUnitReporter);
    +
    +    try {
    +        // Launch the tests!
    +        jasmine.execute();
    +    } catch (e) {
    +        exitGracefully(e);
    +    }
    +};
    +
    +AppiumRunner.prototype.startIosProxy = function () {
    +    var self = this;
    +    var iosProxyCommand;
    +    self.iosProxy = {
    +        alive: false,
    +        process: null
    +    };
    +
    +    if (this.options.platform === "ios" && this.options.device && this.options.udid)
{
    +        iosProxyCommand = "ios_webkit_debug_proxy -c " + this.options.udid + ":27753";
    +        logger.normal("paramedic-appium: Running:");
    +        logger.normal("paramedic-appium: " + iosProxyCommand);
    +        self.iosProxy.alive = true;
    +        self.iosProxy.process = child_process.exec(iosProxyCommand, { maxBuffer: BIG_BUFFER_SIZE
}, function () {
    +            self.iosProxy.alive = false;
    +            logger.normal("paramedic-appium: iOS proxy process exited.");
    +        });
    +    }
    +};
    +
    +AppiumRunner.prototype.startAppiumServer = function (success, fail) {
    +    var self = this;
    +    var appiumServerCommand;
    +    var additionalArgs = "";
    +    self.appium = {
    +        alive: false,
    +        process: null
    +    };
    +
    +    // compose a command to run the Appium server
    +    switch (self.options.platform) {
    +    case "android":
    +        break;
    +    case "ios":
    +        if (self.options.udid) {
    +            additionalArgs += " --udid " + self.options.udid;
    +        }
    +        break;
    +    default:
    +        throw new Error("Unsupported platform: " + self.options.platform);
    +    }
    +    if (self.options.logFile) {
    +        additionalArgs += " --log " + self.options.logFile;
    +    }
    +
    +    appiumServerCommand = "node " + APPIUM_SERVER_PATH + additionalArgs;
    +
    +    // run the Appium server
    +    logger.normal("paramedic-appium: Running:");
    +    logger.normal("paramedic-appium: " + appiumServerCommand);
    +    self.appium.alive = true;
    +    self.appium.process = child_process.exec(appiumServerCommand, { maxBuffer: BIG_BUFFER_SIZE
}, function (error) {
    +        logger.normal("paramedic-appium: Appium process exited.");
    +        if (self.appium.alive && error) {
    +            logger.normal("paramedic-appium: Error running appium server: " + error);
    +            if (isFailFastError(error)) {
    +                self.cleanUp(fail);
    +            } else {
    +                logger.normal("paramedic-appium: Another instance already running? Will
try to run tests on it.");
    +                success();
    +            }
    +        }
    +        self.appium.alive = false;
    +    });
    +
    +    // Wait for the Appium server to start up
    +    self.appium.process.stdout.on("data", function (data) {
    +        if (data.indexOf("Appium REST http interface listener started") > -1) {
    +            success();
    +        }
    +    });
    +};
    +
    +AppiumRunner.prototype.findTests = function () {
    +    var self = this;
    +
    +    if (!self.options.pluginRepos) {
    +        self.options.pluginRepos = getPluginDirs(self.options.appPath);
    +    }
    +
    +    // looking for the tests
    +    self.options.testPaths = [];
    +    var searchPaths = [];
    +    self.options.pluginRepos.forEach(function (pluginRepo) {
    +        searchPaths.push(path.join(pluginRepo, "appium-tests", self.options.platform));
    +        searchPaths.push(path.join(pluginRepo, "appium-tests", "common"));
    +    });
    +    searchPaths.forEach(function (searchPath) {
    +        if (fs.existsSync(searchPath)) {
    +            logger.normal("paramedic-appium: Found tests in: " + searchPath);
    +            if (path.isAbsolute(searchPath)) {
    +                searchPath = path.relative(process.cwd(), searchPath);
    +            }
    +            self.options.testPaths.push(path.join(searchPath, "*.spec.js"));
    +        }
    +    });
    +};
    +
    +AppiumRunner.prototype.setGlobals = function () {
    +    // setting up the global variables so the tests could use them
    +    global.WD = wd;
    +    global.WD_HELPER = wdHelper;
    +    global.SCREENSHOT_HELPER = screenshotHelper;
    +    global.ET = expectTelnet;
    +    global.SHELL = shell;
    +    global.DEVICE = this.options.device;
    +    global.DEVICE_NAME = this.options.appiumDeviceName;
    +    global.PLATFORM = this.options.platform;
    +    global.PLATFORM_VERSION = this.options.appiumPlatformVersion;
    +    global.SCREENSHOT_PATH = this.options.screenshotPath;
    +    global.UNORM = unorm;
    +    global.UDID = this.options.udid;
    +    global.VERBOSE = this.options.verbose;
    +    global.USE_SAUCE = this.options.sauce;
    +    global.SAUCE_USER = this.options.sauceUser;
    +    global.SAUCE_KEY = this.options.sauceKey;
    +    global.SAUCE_CAPS = this.options.sauceCaps;
    +    global.VERBOSE = this.options.verbose;
    +};
    +
    +AppiumRunner.prototype.prepareApp = function () {
    +    var self = this;
    +    var d = q.defer();
    +    var fullAppPath = getFullAppPath(self.options.appPath);
    +    var deviceString = self.options.device ? " --device" : "";
    +    var buildCommand = "cordova build " + self.options.platform + deviceString;
    +
    +    // remove medic.json and (re)build
    +    shell.rm(path.join(fullAppPath, "www", "medic.json"));
    +    fs.stat(fullAppPath, function (error, stats) {
    +        // check if the app exists
    +        if (error || !stats.isDirectory()) {
    +            d.reject("The app directory doesn't exist: " + fullAppPath);
    +        }
    +
    +        // set properties/CSP rules
    +        if (self.options.platform === "ios") {
    +            setPreference(fullAppPath, "CameraUsesGeolocation", "true");
    +        } else if (self.options.platform === "android") {
    +            setPreference(fullAppPath, "loadUrlTimeoutValue", 60000);
    +        }
    +        addCspSource(fullAppPath, "connect-src", "http://*");
    +        permitAccess(fullAppPath, "*");
    +        runCommand("cordova plugin add cordova-save-image-gallery", fullAppPath);
    --- End diff --
    
    Ah, I see. Could you please add a comment about the purpose of this plugin?
    
    ---
    In reply to: [69585501](https://github.com/apache/cordova-paramedic/pull/11#discussion_r69585501)
[](ancestors = 69585501)


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org


Mime
View raw message