chore(chromium): add chromium to cli and lib (#400)

Most of these methods do not work with Windows and there still needs to
have some tests against the chromium.ts file.

- provide hooks when used in cli and as a node module
- fix update to only have one version of chromium
- add methods to get the binary file from the chromium.config.json
- add clean and status methods

Author: cnishina

lib/cli/index.ts

@@ -18,6 +18,12 @@ const chromedriverLogsOption: yargs.Options = {
   describe: 'File path to chrome logs.',
   type: 'string'
 };
+const CHROMIUM = 'chromium';
+const chromiumOptions: yargs.Options = {
+  describe: 'Download chromium.',
+  default: false,
+  type: 'boolean'
+};
 const DETACH = 'detach';
 const detachOption: yargs.Options = {
   describe: 'Once the selenium server is up and running, return ' +
@@ -68,6 +74,11 @@ const maxVersionsChromedriverOption: yargs.Options = {
   describe: 'The chromedriver max version used only for update.',
   type: 'string'
 };
+const MAX_VERSIONS_CHROMIUM = 'max_versions.chromium';
+const maxVersionsChromiumOptions: yargs.Options = {
+  describe: 'The chromium max version used only for update.',
+  type: 'string'
+};
 const MAX_VERSIONS_GECKODRIVER_ALIAS = 'max_versions.gecko';
 const MAX_VERSIONS_GECKODRIVER = 'max_versions.geckodriver';
 const maxVersionsGeckodriverOption: yargs.Options = {
@@ -214,6 +225,7 @@ yargs
           return yargs.option(OUT_DIR, outDirOption)
               .option(CHROMEDRIVER, chromedriverOption)
               .alias(CHROMEDRIVER_ALIAS, CHROMEDRIVER)
+              .option(CHROMIUM, chromiumOptions)
               .option(GECKODRIVER, geckodriverOption)
               .alias(GECKODRIVER_ALIAS, GECKODRIVER)
               .option(GITHUB_TOKEN, githubTokenOption)
@@ -223,11 +235,13 @@ yargs
               .option(LOG_LEVEL, logLevelOption)
               .option(MAX_VERSIONS_CHROMEDRIVER, maxVersionsChromedriverOption)
               .alias(MAX_VERSIONS_CHROMEDRIVER_ALIAS, MAX_VERSIONS_CHROMEDRIVER)
+              .option(MAX_VERSIONS_CHROMIUM, maxVersionsChromiumOptions)
               .option(MAX_VERSIONS_GECKODRIVER, maxVersionsGeckodriverOption)
               .alias(MAX_VERSIONS_GECKODRIVER_ALIAS, MAX_VERSIONS_GECKODRIVER)
               .option(MAX_VERSIONS_IEDRIVER, maxVersionsIedriverOption)
               .alias(MAX_VERSIONS_IEDRIVER_ALIAS, MAX_VERSIONS_IEDRIVER)
               .option(MAX_VERSIONS_SELENIUM, maxVersionsSeleniumOption)
+              .alias(MAX_VERSIONS_SELENIUM_ALIAS, MAX_VERSIONS_SELENIUM)
               .option(OUT_DIR, outDirOption)
               .option(PROXY, proxyOption)
               .option(SELENIUM, seleniumOption)

lib/cmds/options.ts

@@ -16,7 +16,8 @@ export interface Options {
   githubToken?: string;
 }
 
-export type BrowserDriverName = 'chromedriver'|'geckodriver'|'iedriver';
+export type BrowserDriverName =
+  'chromedriver'|'geckodriver'|'iedriver'|'chromium';
 
 /**
  * Contains information about a browser driver.

lib/cmds/utils.spec-unit.ts

@@ -13,7 +13,7 @@ describe('utils', () => {
       };
       const options = convertArgs2AllOptions(argv);
       expect(options.browserDrivers).toBeTruthy();
-      expect(options.browserDrivers.length).toBe(3);
+      expect(options.browserDrivers.length).toBe(4);
       expect(options.server).toBeTruthy();
       expect(options.server.name).toBe('selenium');
       expect(options.outDir).toBe('foobar_download');

lib/cmds/utils.ts

@@ -7,6 +7,7 @@ import {SeleniumServer, SeleniumServerProviderConfig} from '../provider/selenium
 
 import {BrowserDriver, BrowserDriverName, Options} from './options';
 import {OptionsBinary} from './options_binary';
+import { Chromium } from '../provider/chromium';
 
 /**
  * Converts an options object into an options binary object.
@@ -27,6 +28,8 @@ export function addOptionsBinary(options: Options): OptionsBinary {
     for (const browserDriver of optionsBinary.browserDrivers) {
       if (browserDriver.name === 'chromedriver') {
         browserDriver.binary = new ChromeDriver(providerConfig);
+      } else if (browserDriver.name === 'chromium') {
+        browserDriver.binary = new Chromium(providerConfig);
       } else if (browserDriver.name === 'geckodriver') {
         const geckoProviderConfig = providerConfig;
         geckoProviderConfig.oauthToken = optionsBinary.githubToken;
@@ -57,6 +60,7 @@ export function convertArgs2AllOptions(argv: yargs.Arguments): Options {
   return {
     browserDrivers: [
       {name: 'chromedriver'},
+      {name: 'chromium'},
       {name: 'geckodriver'},
       {name: 'iedriver'}
     ],
@@ -83,6 +87,9 @@ export function convertArgs2Options(argv: yargs.Arguments): Options {
   if (argv['chromedriver'] as boolean) {
     setVersions('chromedriver', argv, options.browserDrivers);
   }
+  if (argv['chromium'] as boolean) {
+    setVersions('chromium', argv, options.browserDrivers);
+  }
   if (argv['geckodriver'] as boolean) {
     setVersions('geckodriver', argv, options.browserDrivers);
   }

lib/index.ts

@@ -13,6 +13,7 @@ export {start} from './cmds/start';
 export {status} from './cmds/status';
 export {update} from './cmds/update';
 export {ChromeDriver} from './provider/chromedriver';
+export {Chromium} from './provider/chromium';
 export {GeckoDriver} from './provider/geckodriver';
 export {IEDriver} from './provider/iedriver';
 export {ProviderConfig, ProviderInterface} from './provider/provider';

lib/provider/chromium.ts

@@ -1,11 +1,14 @@
+import * as childProcess from 'child_process';
 import * as fs from 'fs';
 import * as os from 'os';
 import * as path from 'path';
 import * as semver from 'semver';
+
 import { requestBody, JsonObject, requestBinary } from './utils/http_utils';
-import { getBinaryPathFromConfig, removeFiles, unzipFile } from './utils/file_utils';
+import { changeFilePermissions, generateConfigFile, getBinaryPathFromConfig, removeFiles, unzipFile } from './utils/file_utils';
 import { isExpired } from './utils/file_utils';
 import { OUT_DIR, ProviderClass, ProviderConfig, ProviderInterface } from './provider';
+import rimraf = require('rimraf');
 
 export class Chromium extends ProviderClass implements ProviderInterface {
   cacheFileName = 'chromium-all.json';
@@ -18,6 +21,7 @@ export class Chromium extends ProviderClass implements ProviderInterface {
   osArch = os.arch();
   outDir = OUT_DIR;
   proxy: string = null;
+  maxVersion: string = null;
 
   constructor(config?: ProviderConfig) {
     super();
@@ -28,6 +32,7 @@ export class Chromium extends ProviderClass implements ProviderInterface {
     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.maxVersion = this.setVar('maxVersion', this.maxVersion, config);
   }
 
   private makeDirectory(fileName: string) {
@@ -223,16 +228,69 @@ export class Chromium extends ProviderClass implements ProviderInterface {
         }
       }
     }
-    unzipFile(fileName, this.outDir);
+
+    if (this.osType === 'Linux') {
+      unzipFile(fileName, this.outDir);
+      changeFilePermissions(
+        path.resolve(this.outDir, 'chrome-linux/chrome'), '0755', this.osType);
+    } else if (this.osType === 'Darwin') {
+      spawnProcess('unzip', [fileName, '-d', this.outDir], 'ignore');
+    } else if (this.osType === 'Windows_NT') {
+      unzipFile(fileName, this.outDir);
+    }
   }
 
-  async updateBinary(majorVersion?: string): Promise<void> {    
+  async updateBinary(_: string, majorVersion?: string): Promise<void> {
+    try {
+      this.cleanFiles();
+    } catch (_) {
+      // no-op: best attempt to clean files, there can be only one version.
+    }
     const allJson = await this.downloadAllJson();
     const downloadVersionJson = await this.downloadVersionJson(
       allJson, majorVersion);
     const storageObject = await this.downloadStorageObject(
       downloadVersionJson, majorVersion);
     await this.downloadUrl(storageObject, majorVersion);
+
+    let binaryFolder = (): string => {
+      if (this.osType === 'Linux') {
+        return path.resolve(this.outDir, 'chrome-linux');
+      } else if (this.osType === 'Darwin') {
+        return path.resolve(this.outDir,
+          'chrome-mac/Chromium.app/Contents/MacOS');
+      } else if (this.osType === 'Windows_NT') {
+        return 'fix me';
+      }
+      throw new Error('os does not exist');
+    }
+
+    let binaryRegex = (): RegExp => {
+      if (this.osType === 'Linux') {
+        return /chrome$/g;
+      } else if (this.osType === 'Darwin') {
+        return /Chromium/g;
+      } else if (this.osType === 'Windows_NT') {
+        return /fix-me/g;
+      }
+      throw new Error('os does not exist');
+    };
+
+    let binaryFile = (): string => {
+      if (this.osType === 'Linux') {
+        return path.resolve(this.outDir, 'chrome-linux/chrome');
+      } else if (this.osType === 'Darwin') {
+        return path.resolve(this.outDir,
+          'chrome-mac/Chromium.app/Contents/MacOS/Chromium');
+      } else if (this.osType === 'Windows_NT') {
+        return 'fix me';
+      }
+      throw new Error('os does not exist');
+    }
+    
+    generateConfigFile(binaryFolder(),
+      path.resolve(this.outDir, this.configFileName),
+      binaryRegex(), binaryFile());
   }
 
   getBinaryPath(version?: string): string | null {
@@ -245,11 +303,47 @@ export class Chromium extends ProviderClass implements ProviderInterface {
   }
 
   getStatus(): string | null {
-    return '';
+    try {
+      const existFiles = fs.readdirSync(this.outDir);
+      for (const existFile of existFiles) {
+        if (existFile.match(/chromium\-version\.*/g)) {
+          const regex = /chromium\-version\-(\d+)\.json/g;
+          const exec = regex.exec(existFile);
+          if (exec) {
+            return exec[1]; 
+          }
+        }
+      }
+      return null;
+    } catch (_) {
+      return null;
+    }
   }
 
   cleanFiles(): string {
-    return removeFiles(this.outDir, [/chromium.*/g]);
+    let chromiumPath= '';
+    if (this.osType === 'Darwin') {
+      chromiumPath = 'chrome-mac/';
+    } else if (this.osType === 'Linux') {
+      chromiumPath = 'chrome-linux/';
+    } else if (this.osType === 'Windows_NT') {
+      chromiumPath = 'chrome-win/';
+    }
+    
+    rimraf.sync(path.resolve(this.outDir, chromiumPath));
+    const files = removeFiles(this.outDir, [/chromium.*/g]);
+    try {
+      const fileList = files.split('\n');
+      if (files.length === 0) {
+        // No files listed to clean.
+        return '';
+      }
+      fileList.push(chromiumPath);
+      return (fileList.sort()).join('\n');
+    } catch (_) {
+      // If files returns null, catch split error.
+      return '';
+    }
   }
 }
 
@@ -275,4 +369,21 @@ export function osHelper(ostype: string, osarch: string): string {
     }
   }
   return null;
+}
+
+/**
+ * A command line to run. Example 'npm start', the task='npm' and the
+ * opt_arg=['start']
+ * @param task The task string.
+ * @param optArg Optional task args.
+ * @param optIo Optional io arg. By default, it should log to console.
+ * @returns The child process.
+ */
+export function spawnProcess(task: string, optArg?: string[], optIo?: string) {
+  optArg = typeof optArg !== 'undefined' ? optArg : [];
+  let stdio: childProcess.StdioOptions = 'inherit';
+  if (optIo === 'ignore') {
+    stdio = 'ignore';
+  }
+  return childProcess.spawnSync(task, optArg, {stdio});
 }

lib/provider/utils/file_utils.ts

@@ -105,7 +105,6 @@ export function unzipFile(zipFileName: string, dstDir: string): string[] {
   const zip = new AdmZip(zipFileName);
   zip.extractAllTo(dstDir, true);
   for (const fileItem of zipFileList(zipFileName)) {
-    console.log(fileItem);
     fileList.push(path.resolve(dstDir, fileItem));
   }
   return fileList;