webdriver-manager-replacement
Version:
webdriver-manager-replacement
281 lines • 9.91 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const fs = require("fs");
const os = require("os");
const path = require("path");
const provider_1 = require("./provider");
const cloud_storage_xml_1 = require("./utils/cloud_storage_xml");
const file_utils_1 = require("./utils/file_utils");
const http_utils_1 = require("./utils/http_utils");
const version_list_1 = require("./utils/version_list");
class ChromeDriver extends provider_1.ProviderClass {
constructor(config) {
super();
this.cacheFileName = 'chromedriver.xml';
this.configFileName = 'chromedriver.config.json';
this.ignoreSSL = false;
this.osType = os.type();
this.osArch = os.arch();
this.outDir = provider_1.OUT_DIR;
this.proxy = null;
this.requestUrl = 'https://chromedriver.storage.googleapis.com/';
this.seleniumFlag = '-Dwebdriver.chrome.driver';
this.version = null;
this.maxVersion = null;
this.cacheFileName = this.setVar('cacheFileName', this.cacheFileName, config);
this.configFileName = this.setVar('configFileName', this.configFileName, config);
this.ignoreSSL = this.setVar('ignoreSSL', this.ignoreSSL, config);
this.osArch = this.setVar('osArch', this.osArch, config);
this.osType = this.setVar('osType', this.osType, config);
this.outDir = this.setVar('outDir', this.outDir, config);
this.proxy = this.setVar('proxy', this.proxy, config);
this.requestUrl = this.setVar('requestUrl', this.requestUrl, config);
this.version = this.setVar('version', this.version, config);
this.maxVersion = this.setVar('maxVersion', this.maxVersion, config);
}
/**
* Should update the cache and download, find the version to download,
* then download that binary.
* @param version Optional to provide the version number or latest.
* @param maxVersion Optional to provide the max version.
*/
async updateBinary(version, maxVersion) {
if (!version) {
version = this.version;
}
if (!maxVersion) {
maxVersion = this.maxVersion;
}
await cloud_storage_xml_1.updateXml(this.requestUrl, {
fileName: path.resolve(this.outDir, this.cacheFileName),
ignoreSSL: this.ignoreSSL,
proxy: this.proxy
});
const versionList = cloud_storage_xml_1.convertXmlToVersionList(path.resolve(this.outDir, this.cacheFileName), '.zip', versionParser, semanticVersionParser);
const versionObj = version_list_1.getVersion(versionList, osHelper(this.osType, this.osArch), formatVersion(version), maxVersion);
const chromeDriverUrl = this.requestUrl + versionObj.url;
const chromeDriverZip = path.resolve(this.outDir, versionObj.name);
// We should check the zip file size if it exists. The size will
// be used to either make the request, or quit the request if the file
// size matches.
let fileSize = 0;
try {
fileSize = fs.statSync(chromeDriverZip).size;
}
catch (err) {
}
await http_utils_1.requestBinary(chromeDriverUrl, {
fileName: chromeDriverZip,
fileSize,
ignoreSSL: this.ignoreSSL,
proxy: this.proxy
});
// Unzip and rename all the files (a grand total of 1) and set the
// permissions.
const fileList = file_utils_1.zipFileList(chromeDriverZip);
const fileItem = path.resolve(this.outDir, fileList[0]);
file_utils_1.unzipFile(chromeDriverZip, this.outDir);
const renamedFileName = file_utils_1.renameFileWithVersion(fileItem, '_' + versionObj.version);
file_utils_1.changeFilePermissions(renamedFileName, '0755', this.osType);
file_utils_1.generateConfigFile(this.outDir, path.resolve(this.outDir, this.configFileName), matchBinaries(this.osType), renamedFileName);
return Promise.resolve();
}
/**
* Gets the binary file path.
* @param version Optional to provide the version number or latest.
*/
getBinaryPath(version) {
try {
const configFilePath = path.resolve(this.outDir, this.configFileName);
return file_utils_1.getBinaryPathFromConfig(configFilePath, version);
}
catch (_) {
return null;
}
}
/**
* Gets a comma delimited list of versions downloaded. Also has the "latest"
* downloaded noted.
*/
getStatus() {
try {
const configFilePath = path.resolve(this.outDir, this.configFileName);
const configJson = JSON.parse(fs.readFileSync(configFilePath).toString());
const versions = [];
for (const binaryPath of configJson['all']) {
let version = '';
let regex = /.*chromedriver_(\d+.\d+.*)/g;
if (this.osType === 'Windows_NT') {
regex = /.*chromedriver_(\d+.\d+.*).exe/g;
}
try {
const exec = regex.exec(binaryPath);
if (exec && exec[1]) {
version = exec[1];
}
}
catch (_) {
}
if (configJson['last'] === binaryPath) {
version += ' (latest)';
}
versions.push(version);
}
return versions.join(', ');
}
catch (_) {
return null;
}
}
/**
* Get a line delimited list of files removed.
*/
cleanFiles() {
return file_utils_1.removeFiles(this.outDir, [/chromedriver.*/g]);
}
}
exports.ChromeDriver = ChromeDriver;
/**
* Helps translate the os type and arch to the download name associated
* with composing the download link.
* @param ostype The operating stystem type.
* @param osarch The chip architecture.
* @returns The download name associated with composing the download link.
*/
function osHelper(ostype, osarch) {
if (ostype === 'Darwin') {
return 'mac';
}
else if (ostype === 'Windows_NT') {
if (osarch === 'x64') {
return 'win32';
}
else if (osarch === 'x32') {
return 'win32';
}
}
else if (ostype === 'Linux') {
if (osarch === 'x64') {
return 'linux64';
}
else if (osarch === 'x32') {
return null;
}
}
return null;
}
exports.osHelper = osHelper;
/**
* Captures the version name which includes the semantic version and extra
* metadata. So an example for 12.34/chromedriver_linux64.zip,
* the version is 12.34.
*
* The new version is 70.0.3538.16/chromedriver_linux64.zip. This will return
* 70.0.3538.16.
* @param xmlKey The xml key including the partial url.
*/
function versionParser(xmlKey) {
const newRegex = /([0-9]*\.[0-9]*\.[0-9]*\.[0-9]*)\/chromedriver_.*\.zip/g;
try {
const exec = newRegex.exec(xmlKey);
if (exec) {
return exec[1];
}
}
catch (_) {
}
const oldRegex = /([0-9]*\.[0-9]*)\/chromedriver_.*\.zip/g;
try {
const exec = oldRegex.exec(xmlKey);
if (exec) {
return exec[1];
}
}
catch (_) {
}
return null;
}
exports.versionParser = versionParser;
/**
* Captures the version name which includes the semantic version and extra
* metadata. So an example for 12.34/chromedriver_linux64.zip,
* the version is 12.34.0.
*
* The new version is 70.0.3538.16/chromedriver_linux64.zip. This will return
* 70.0.3538.
* @param xmlKey The xml key including the partial url.
*/
function semanticVersionParser(xmlKey) {
const newRegex = /([0-9]*\.[0-9]*\.[0-9]*).[0-9]*\/chromedriver_.*\.zip/g;
try {
const exec = newRegex.exec(xmlKey);
if (exec) {
return exec[1];
}
}
catch (_) {
}
const oldRegex = /([0-9]*\.[0-9]*)\/chromedriver_.*\.zip/g;
try {
const exec = oldRegex.exec(xmlKey);
if (exec) {
return exec[1] + '.0';
}
}
catch (_) {
}
return null;
}
exports.semanticVersionParser = semanticVersionParser;
/**
* Matches the installed binaries depending on the operating system.
* @param ostype The operating stystem type.
*/
function matchBinaries(ostype) {
if (ostype === 'Darwin' || ostype === 'Linux') {
return /chromedriver_\d+.\d+.*/g;
}
else if (ostype === 'Windows_NT') {
return /chromedriver_\d+.\d+.*.exe/g;
}
return null;
}
exports.matchBinaries = matchBinaries;
/**
* Specifically to chromedriver, when downloading a version, the version
* you give webdriver-manager is not in the same as the output from the
* semanticVersionParser. So getting the version to the versionList will not
* be just a dictionary look up versionList[version]. The version will have
* to be formatted.
*
* Example:
* 2.44 will return with the formatted semantic version 2.44.0
* 70.0.1.1 will return with the formatted semantic version 70.0.1
*
* @param version The actual version.
*/
function formatVersion(version) {
const newRegex = /([0-9]*\.[0-9]*\.[0-9]*).[0-9]*/g;
try {
const exec = newRegex.exec(version);
if (exec) {
return exec[1];
}
}
catch (_) {
// no-op: if exec[1] is not reachable, move to the next regex.
}
const oldRegex = /([0-9]*\.[0-9]*)/g;
try {
const exec = oldRegex.exec(version);
if (exec) {
return exec[1] + '.0';
}
}
catch (_) {
// no-op: if exec[1] is not reachable, move on to return null.
}
return null;
}
exports.formatVersion = formatVersion;
//# sourceMappingURL=chromedriver.js.map