mirror of
https://github.com/appium/appium.git
synced 2026-02-12 12:59:38 -06:00
402 lines
12 KiB
JavaScript
402 lines
12 KiB
JavaScript
"use strict";
|
|
|
|
var logger = require('./server/logger.js').get('appium')
|
|
, fs = require('fs')
|
|
, ncp = require('ncp').ncp
|
|
, request = require('request')
|
|
, _ = require('underscore')
|
|
, path = require('path')
|
|
, rimraf = require('rimraf')
|
|
, exec = require('child_process').exec
|
|
, util = require('util')
|
|
, os = require('os').type()
|
|
, tempdir = require('./tempdir')
|
|
, AdmZip = require('adm-zip');
|
|
|
|
|
|
exports.downloadFile = function(fileUrl, cb) {
|
|
// We will be downloading the files to a directory, so make sure it's there
|
|
// This step is not required if you have manually created the directory
|
|
tempdir.open({prefix: 'appium-app', suffix: '.zip'}, function(err, info) {
|
|
var file = fs.createWriteStream(info.path);
|
|
request(fileUrl).pipe(file).on('close', function() {
|
|
logger.info(fileUrl + ' downloaded to ' + info.path);
|
|
cb(info.path);
|
|
});
|
|
});
|
|
};
|
|
|
|
exports.copyLocalZip = function(localZipPath, cb) {
|
|
logger.info("Copying local zip to tmp dir");
|
|
fs.stat(localZipPath, function(err) {
|
|
if (err) return cb(err);
|
|
tempdir.open({prefix: 'appium-app', suffix: '.zip'}, function(err, info) {
|
|
var infile = fs.createReadStream(localZipPath);
|
|
var outfile = fs.createWriteStream(info.path);
|
|
infile.pipe(outfile).on('close', function() {
|
|
logger.info(localZipPath + ' copied to ' + info.path);
|
|
cb(null, info.path);
|
|
});
|
|
});
|
|
});
|
|
};
|
|
|
|
exports.unzipFile = function(zipPath, cb) {
|
|
logger.info("Unzipping " + zipPath);
|
|
exports.testZipArchive(zipPath, function(err, valid) {
|
|
if (valid) {
|
|
if (exports.isWindows()) {
|
|
var zip = new AdmZip(zipPath);
|
|
zip.extractAllTo(path.dirname(zipPath), true);
|
|
logger.info("Unzip successful");
|
|
cb(null,null);
|
|
} else {
|
|
var execOpts = {cwd: path.dirname(zipPath), maxBuffer: 524288};
|
|
exec('unzip -o ' + zipPath, execOpts, function(err, stderr, stdout) {
|
|
if (!err) {
|
|
logger.info("Unzip successful");
|
|
cb(null, stderr);
|
|
} else {
|
|
logger.error("Unzip threw error " + err);
|
|
logger.error("Stderr: " + stderr);
|
|
logger.error("Stdout: " + stdout);
|
|
cb("Archive could not be unzipped, check appium logs.", null);
|
|
}
|
|
});
|
|
}
|
|
} else {
|
|
cb(err, null);
|
|
}
|
|
});
|
|
};
|
|
|
|
exports.testZipArchive = function(zipPath, cb) {
|
|
logger.info("Testing zip archive: " + zipPath);
|
|
if (exports.isWindows()) {
|
|
if (fs.existsSync(zipPath)) {
|
|
logger.info("Zip archive tested clean");
|
|
cb(null, true);
|
|
} else {
|
|
cb("Zip archive was not found.", false);
|
|
}
|
|
} else {
|
|
var execOpts = {cwd: path.dirname(zipPath)};
|
|
exec("unzip -tq " + zipPath, execOpts, function(err, stderr, stdout) {
|
|
if (!err) {
|
|
if(/No errors detected/.exec(stderr)) {
|
|
logger.info("Zip archive tested clean");
|
|
cb(null, true);
|
|
} else {
|
|
logger.error("Zip file " + zipPath + " was not valid");
|
|
logger.error("Stderr: " + stderr);
|
|
logger.error("Stdout: " + stdout);
|
|
cb("Zip archive did not test successfully, check appium server logs " +
|
|
"for output", false);
|
|
}
|
|
} else {
|
|
logger.error("Test zip archive threw error " + err);
|
|
logger.error("Stderr: " + stderr);
|
|
logger.error("Stdout: " + stdout);
|
|
cb("Error testing zip archive, are you sure this is a zip file? " + err, null);
|
|
}
|
|
});
|
|
}
|
|
};
|
|
|
|
exports.unzipApp = function(zipPath, appExt, cb) {
|
|
exec("find " + path.dirname(zipPath) + " -type d -name '*" + appExt + "' | xargs rm -rf " + path.dirname(zipPath) +
|
|
"/Payload*", function(error, stdout, stderr){
|
|
if (!error) {
|
|
exports.unzipFile(zipPath, function(err, output) {
|
|
if (!err) {
|
|
var reg = new RegExp("(?:inflating|extracting): (.+" + appExt + ")/?");
|
|
var match = reg.exec(output);
|
|
if (match) {
|
|
var appPath = path.resolve(path.dirname(zipPath), match[1]);
|
|
cb(null, appPath);
|
|
} else {
|
|
cb("App zip unzipped OK, but we couldn't find a .app bundle in it. " +
|
|
"Make sure your archive contains the .app package and nothing else",
|
|
null);
|
|
}
|
|
} else {
|
|
cb(err, null);
|
|
}
|
|
});
|
|
} else {
|
|
cb(error, null);
|
|
}
|
|
});
|
|
};
|
|
|
|
exports.checkBuiltInApp = function(appName, version, cb) {
|
|
logger.info("Looking for built in app " + appName);
|
|
exports.getBuiltInAppDir(version, function(err, appDir) {
|
|
if (err) {
|
|
cb(err);
|
|
} else {
|
|
var appPath = path.resolve(appDir, appName + ".app");
|
|
fs.stat(appPath, function(err, s) {
|
|
if (err) {
|
|
cb(err);
|
|
} else if (!s.isDirectory()) {
|
|
cb("App package was not a directory", appPath);
|
|
} else {
|
|
logger.info("Got app, trying to copy " + appPath + " to tmp dir");
|
|
exports.copyBuiltInApp(appPath, appName, cb);
|
|
}
|
|
});
|
|
}
|
|
});
|
|
};
|
|
|
|
exports.checkSafari = function(version, cb) {
|
|
exports.checkBuiltInApp("MobileSafari", version, cb);
|
|
};
|
|
|
|
exports.checkPreferencesApp = function(version, cb) {
|
|
exports.checkBuiltInApp("Preferences", version, cb);
|
|
};
|
|
|
|
exports.getBuiltInAppDir = function(version, cb) {
|
|
exports.getXcodeFolder(function(err, xcodeDir) {
|
|
if (err) return cb(err);
|
|
|
|
var appDir = path.resolve(xcodeDir, "Platforms/iPhoneSimulator.platform/" +
|
|
"Developer/SDKs/iPhoneSimulator" + version +
|
|
".sdk/Applications/");
|
|
fs.stat(appDir, function(err, s) {
|
|
if (err) {
|
|
cb(err);
|
|
} else if (!s.isDirectory()) {
|
|
cb("Could not load built in applications directory");
|
|
} else {
|
|
cb(null, appDir);
|
|
}
|
|
});
|
|
});
|
|
};
|
|
|
|
exports.copyBuiltInApp = function(appPath, appName, cb) {
|
|
var newAppDir = path.resolve(exports.getTempPath(), 'Appium-' + appName + '.app');
|
|
ncp(appPath, newAppDir, function(err) {
|
|
if (err) {
|
|
cb(err);
|
|
} else {
|
|
logger.info("Copied " + appName + " to " + newAppDir);
|
|
cb(null, newAppDir);
|
|
}
|
|
});
|
|
};
|
|
|
|
exports.cleanSafari = function(safariVer, cb) {
|
|
var baseDir = "Library/Application Support/iPhone Simulator/" +
|
|
safariVer + "/Library/";
|
|
exports.getUser(function(err, user) {
|
|
if (err) {
|
|
logger.error(err);
|
|
cb(err);
|
|
} else {
|
|
var baseSupportDir = path.resolve("/Users", user, baseDir);
|
|
fs.stat(baseSupportDir, function(err) {
|
|
if (err) {
|
|
logger.info(err.message);
|
|
var p = process.env.HOME + '/' + baseDir;
|
|
if(!fs.existsSync(p)) {
|
|
return cb(new Error("Could not find support directory for mobile safari, does " +
|
|
"it exist at " + baseDir + " or " + p + "?"));
|
|
} else {
|
|
baseSupportDir = p;
|
|
}
|
|
}
|
|
var toDeletes = [
|
|
'Caches/Snapshots/com.apple.mobilesafari'
|
|
, 'Caches/com.apple.mobilesafari/Cache.db*'
|
|
, 'Caches/com.apple.WebAppCache/*.db'
|
|
, 'Safari/*.plist'
|
|
, 'WebKit/LocalStorage/*.*'
|
|
, 'Library/WebKit/GeolocationSites.plist'
|
|
, 'Cookies/*.binarycookies'
|
|
];
|
|
var deletes = 0;
|
|
var errToRet = null;
|
|
var finish = function(err) {
|
|
deletes++;
|
|
if (err) {
|
|
errToRet = err;
|
|
}
|
|
if (deletes === toDeletes.length) {
|
|
cb(errToRet);
|
|
}
|
|
};
|
|
_.each(toDeletes, function(del) {
|
|
var toDelete = path.resolve(baseSupportDir, del);
|
|
toDelete = toDelete.replace(/ /g, "\\ ");
|
|
logger.info("Deleting " + toDelete);
|
|
var cmd = "rm -rf " + toDelete;
|
|
exec(cmd, function(err) {
|
|
finish(err);
|
|
});
|
|
});
|
|
});
|
|
}
|
|
});
|
|
};
|
|
|
|
exports.getUser = function(cb) {
|
|
logger.info("Determining current user");
|
|
exec("whoami", { maxBuffer: 524288 }, function(err, stdout) {
|
|
if (err) {
|
|
logger.error(err);
|
|
cb(err);
|
|
} else {
|
|
logger.info("User is " + stdout.trim());
|
|
cb(null, stdout.trim());
|
|
}
|
|
});
|
|
};
|
|
|
|
exports.delay = function(secs) {
|
|
var date = new Date();
|
|
var curDate = null;
|
|
do { curDate = new Date(); }
|
|
while(curDate-date < (secs * 1000.0));
|
|
};
|
|
|
|
var pad0 = function(x) {
|
|
if (x.toString().length == 1) {
|
|
x = '0' + x;
|
|
}
|
|
return x;
|
|
};
|
|
|
|
exports.escapeSpecialChars = function(str, quoteEscape) {
|
|
if (typeof str !== "string") {
|
|
return str;
|
|
}
|
|
if (typeof quoteEscape === "undefined") {
|
|
quoteEscape = false;
|
|
}
|
|
str = str
|
|
.replace(/[\\]/g, '\\\\')
|
|
.replace(/[\/]/g, '\\/')
|
|
.replace(/[\b]/g, '\\b')
|
|
.replace(/[\f]/g, '\\f')
|
|
.replace(/[\n]/g, '\\n')
|
|
.replace(/[\r]/g, '\\r')
|
|
.replace(/[\t]/g, '\\t')
|
|
.replace(/[\"]/g, '\\"')
|
|
.replace(/\\'/g, "\\'");
|
|
if (quoteEscape) {
|
|
var re = new RegExp(quoteEscape, "g");
|
|
str = str.replace(re, "\\" + quoteEscape);
|
|
}
|
|
return str;
|
|
};
|
|
|
|
exports.parseWebCookies = function(cookieStr) {
|
|
var cookies = [];
|
|
var splits = cookieStr.trim().split(";");
|
|
_.each(splits, function(split) {
|
|
split = split.trim();
|
|
if (split !== "") {
|
|
split = split.split("=");
|
|
cookies.push({
|
|
name: decodeURIComponent(split[0])
|
|
, value: decodeURIComponent(split[1])
|
|
});
|
|
}
|
|
});
|
|
return cookies;
|
|
};
|
|
|
|
exports.rotateImage = function(imgPath, deg, cb) {
|
|
logger.info("Rotating image " + imgPath + " " + deg + " degrees");
|
|
var scriptPath = path.resolve(__dirname, "devices/ios/uiauto/Rotate.applescript");
|
|
var cmd = "osascript " + scriptPath + " " + JSON.stringify(imgPath) +
|
|
" " + deg;
|
|
exec(cmd, { maxBuffer: 524288 }, function(err, stdout) {
|
|
if (err) return cb(err);
|
|
console.log(stdout);
|
|
cb(null);
|
|
});
|
|
};
|
|
|
|
exports.isWindows = function() {
|
|
return os === 'Windows_NT';
|
|
};
|
|
|
|
exports.getTempPath = function () {
|
|
return exports.isWindows() ? "C:\\Windows\\Temp" : "/tmp";
|
|
};
|
|
|
|
exports.getGitRev = function(cb) {
|
|
var cwd = path.resolve(__dirname, "..");
|
|
exec("git rev-parse HEAD", {cwd: cwd, maxBuffer: 524288}, function(err, stdout) {
|
|
if (err) return cb(err);
|
|
cb(null, stdout.trim());
|
|
});
|
|
};
|
|
|
|
exports.getAndroidPlatform = function(cb) {
|
|
var androidHome = process.env.ANDROID_HOME;
|
|
if (typeof androidHome !== "string") {
|
|
logger.error("ANDROID_HOME was not exported!");
|
|
return null;
|
|
}
|
|
|
|
var locs = ['android-4.2', 'android-17', 'android-4.3', 'android-18'];
|
|
var res = null;
|
|
_.each(locs, function(loc) {
|
|
var platforms = path.resolve(androidHome , 'platforms')
|
|
, platform = loc;
|
|
if (fs.existsSync(path.resolve(platforms, platform))) {
|
|
res = [platform, path.resolve(platforms, platform)];
|
|
}
|
|
});
|
|
return res;
|
|
};
|
|
|
|
exports.getXcodeFolder = function(cb) {
|
|
exec('xcode-select --print-path', { maxBuffer: 524288, timeout: 3000 }, function(err, stdout, stderr) {
|
|
if (!err) {
|
|
var xcodeFolderPath = stdout.replace("\n", "");
|
|
if (fs.existsSync(xcodeFolderPath)) {
|
|
cb(null, xcodeFolderPath);
|
|
} else {
|
|
logger.error(xcodeFolderPath + "does not exist.");
|
|
cb(new Error("xcode-select could not find xcode"), null);
|
|
}
|
|
} else {
|
|
logger.error("xcode-select threw error " + err);
|
|
logger.error("Stderr: " + stderr);
|
|
logger.error("Stdout: " + stdout);
|
|
cb(new Error("xcode-select threw an error"), null);
|
|
}
|
|
});
|
|
};
|
|
|
|
exports.getXcodeVersion = function(cb) {
|
|
exports.getXcodeFolder(function(err, xcodePath) {
|
|
if (err !== null) {
|
|
cb(err, null);
|
|
} else {
|
|
var xcodebuildPath = path.resolve(xcodePath, "usr/bin/xcodebuild");
|
|
if (!fs.existsSync(xcodebuildPath)) {
|
|
cb(new Error("Could not get Xcode version: " + xcodebuildPath + " does not exist on disk."), null);
|
|
} else {
|
|
exec(JSON.stringify(xcodebuildPath) + ' -version', { maxBuffer: 524288, timeout: 3000 }, function(err, stdout) {
|
|
var versionPattern = /\d\.\d\.*\d*/;
|
|
var match = versionPattern.exec(stdout);
|
|
if (match === null) {
|
|
cb(new Error("Could not parse Xcode version"), null);
|
|
} else {
|
|
var versionNumber = match[0];
|
|
cb(null, versionNumber);
|
|
}
|
|
});
|
|
}
|
|
}
|
|
});
|
|
};
|