chore(bin): binaries separated from webdriver-manager with unit tests

Author: cnishina

.clang-format

@@ -0,0 +1,3 @@
+Language:        JavaScript
+BasedOnStyle:    Google
+ColumnLimit:     100

.gitignore

@@ -0,0 +1,4 @@
+built/
+node_modules/
+selenium/
+typings/

README.md

@@ -1 +1,67 @@
-# webdriver-manager
+# webdriver-manager
+
+### Setup
+
+```
+npm install
+```
+
+### Testing
+
+```
+gulp test
+```
+
+### Running webdriver
+```
+node built/lib/webdriver.js <command>
+```
+
+```
+Usage:webdriver-manager <command> [options]
+
+Commands:
+  clean   removes all downloaded driver files from the out_dir
+  start   start up the selenium server
+  status   list the current available drivers
+  update   install or update selected binaries
+
+Options:
+  --out_dir               Location to output/expect                          [default: /src/webdriver-manager/selenium]
+  --seleniumPort          Optional port for the selenium standalone server
+  --versions_standalone   Optional seleniuim standalone server version       [default: 2.52.0]
+  --versions_chrome       Optional chrome driver version                     [default: 2.21]
+  --ignore_ssl            Ignore SSL certificates
+  --proxy                 Proxy to use for the install or update command
+  --alternate_cnd         Alternate CDN to binaries
+  --standalone            Install or update selenium standalone              [default: true]
+  --chrome                Install or update chromedriver                     [default: true]
+```
+
+### Running a specific command
+
+running update
+```
+node built/lib/cmds/update.js update-run
+```
+
+help update
+```
+node built/lib/cmds/update.js update-help
+```
+
+```
+Usage:        update-run [options]
+              update-help
+Description:  install or update selected binaries
+
+Options:
+  --out_dir               Location to output/expect                        [default: /src/webdriver-manager/selenium]
+  --ignore_ssl            Ignore SSL certificates
+  --proxy                 Proxy to use for the install or update command
+  --alternate_cnd         Alternate CDN to binaries
+  --standalone            Install or update selenium standalone            [default: true]
+  --chrome                Install or update chromedriver                   [default: true]
+  --versions_standalone   Optional seleniuim standalone server version     [default: 2.52.0]
+  --versions_chrome       Optional chrome driver version                   [default: 2.21]
+  ```

config.json

@@ -0,0 +1,13 @@
+{
+  "webdriverVersions": {
+    "selenium": "2.52.0",
+    "chromedriver": "2.21",
+    "iedriver": "2.52.0"
+  },
+  "cdnUrls": {
+    "selenium": "https://selenium-release.storage.googleapis.com/",
+    "chromedriver": "https://chromedriver.storage.googleapis.com/",
+    "iedriver": "https://selenium-release.storage.googleapis.com/"
+  }
+
+}

gulpfile.js

@@ -0,0 +1,60 @@
+'use strict';
+
+var gulp = require('gulp');
+var clangFormat = require('clang-format');
+var gulpFormat = require('gulp-clang-format');
+var runSequence = require('run-sequence');
+var spawn = require('child_process').spawn;
+
+var runSpawn = function(done, task, opt_arg) {
+  opt_arg = typeof opt_arg !== 'undefined' ? opt_arg : [];
+  var child = spawn(task, opt_arg, {stdio: 'inherit'});
+  var running = false;
+  child.on('close', function() {
+    if (!running) {
+      running = true;
+      done();
+    }
+  });
+  child.on('error', function() {
+    if (!running) {
+      console.error('gulp encountered a child error');
+      running = true;
+      done();
+    }
+  });
+};
+
+gulp.task('copy', function() {
+  return gulp.src(['config.json', 'package.json'])
+      .pipe(gulp.dest('built/'));
+});
+
+gulp.task('clang', function() {
+  return gulp.src(['src/**/*.ts'])
+      .pipe(gulpFormat.checkFormat('file', clangFormat))
+      .on('warning', function(e) {
+    console.log(e);
+  });
+});
+
+gulp.task('typings', function(done) {
+  runSpawn(done, 'node', ['node_modules/typings/dist/bin.js', 'install']);
+});
+
+gulp.task('tsc', function(done) {
+  runSpawn(done, 'node', ['node_modules/typescript/bin/tsc']);
+});
+
+gulp.task('prepublish', function(done) {
+  runSequence(['typings', 'clang'], 'tsc', 'copy', done);
+});
+
+gulp.task('default',['prepublish']);
+gulp.task('build',['prepublish']);
+
+gulp.task('test', ['build'], function(done) {
+  var opt_arg = [];
+  opt_arg.push('node_modules/jasmine/bin/jasmine.js');
+  runSpawn(done, 'node', opt_arg);
+});

lib/binaries/binary.ts

@@ -0,0 +1,75 @@
+/**
+ * operating system enum
+ */
+export enum OS {
+  Windows_NT,
+  Linux,
+  Darwin
+}
+
+/**
+ * Dictionary to map the binary's id to the binary object
+ */
+export interface BinaryMap<T extends Binary> { [id: string]: T; }
+
+
+/**
+ * The binary object base class
+ */
+export class Binary {
+  static os: Array<OS>;             // the operating systems, the binary can run on
+  static id: string;                // the binaries key identifier
+  static isDefault: boolean;        // to download by default
+  static versionDefault: string;    // a static default version variable
+  static shortName: Array<string>;  // the names used for a binary download
+  name: string;                     // used for logging to console
+  prefixDefault: string;            // start of the file name
+  versionCustom: string;            // version of file
+  suffixDefault: string;            // file type for downloading
+  cdn: string;                      // url protocol and host
+
+  /**
+   * @param ostype The operating system.
+   * @returns The executable file type.
+   */
+  executableSuffix(ostype: string): string {
+    if (ostype == 'Windows_NT') {
+      return '.exe';
+    } else {
+      return '';
+    }
+  }
+
+  /**
+   * @param ostype The operating system.
+   * @returns The file name for the executable.
+   */
+  executableFilename(ostype: string): string {
+    return this.prefix() + this.version() + this.executableSuffix(ostype);
+  }
+
+  prefix(): string { return this.prefixDefault; }
+
+  version(): string { return this.versionCustom; }
+
+  suffix(ostype?: string, arch?: string): string { return this.suffixDefault; }
+
+  filename(ostype?: string, arch?: string): string { return this.prefix() + this.version() + this.suffix(ostype, arch); }
+
+  shortVersion(version: string): string { return version.slice(0, version.lastIndexOf('.')); }
+
+  /**
+   * A base class method that should be overridden.
+   */
+  id(): string { return 'not implemented'; }
+
+  /**
+   * A base class method that should be overridden.
+   */
+  versionDefault(): string { return 'not implemented'; }
+
+  /**
+   * A base class method that should be overridden.
+   */
+  url(ostype?: string, arch?: string): string { return 'not implemented'; }
+}

lib/binaries/chromeDriver.ts

@@ -0,0 +1,48 @@
+import {arch, type} from 'os';
+
+import {Binary, OS} from './binary';
+import {Config} from '../config';
+
+/**
+ * The chrome driver binary.
+ */
+export class ChromeDriver extends Binary {
+  static os = [OS.Windows_NT, OS.Linux, OS.Darwin];
+  static id = 'chrome';
+  static versionDefault = Config.binaryVersions().chrome;
+  static isDefault = true;
+  static shortName = ['chrome'];
+
+  constructor() {
+    super();
+    this.name = 'chromedriver';
+    this.versionCustom = ChromeDriver.versionDefault;
+    this.prefixDefault = 'chromedriver_';
+    this.suffixDefault = '.zip';
+    this.cdn = Config.cdnUrls().chrome;
+  }
+
+  id(): string { return ChromeDriver.id; }
+
+  versionDefault(): string { return ChromeDriver.versionDefault; }
+
+  suffix(ostype: string, arch: string): string {
+    if (ostype === 'Darwin') {
+      return 'mac32' + this.suffixDefault;
+    } else if (ostype === 'Linux') {
+      if (arch === 'x64') {
+        return 'linux64' + this.suffixDefault;
+      } else {
+        return 'linux32' + this.suffixDefault;
+      }
+    } else if (ostype === 'Windows_NT') {
+      return 'win32' + this.suffixDefault;
+    }
+  }
+
+  url(ostype: string, arch: string): string {
+    let urlBase = this.cdn + this.version() + '/';
+    let filename = this.prefix() + this.suffix(ostype, arch);
+    return urlBase + filename;
+  }
+}

lib/binaries/ieDriver.ts

@@ -0,0 +1,46 @@
+import {arch, type} from 'os';
+
+import {Binary, OS} from './binary';
+import {Config} from '../config';
+
+/**
+ * The internet explorer binary.
+ */
+export class IEDriver extends Binary {
+  static os = [OS.Windows_NT];
+  static id = 'ie';
+  static versionDefault = Config.binaryVersions().ie;
+  static isDefault = false;
+  static shortName = ['ie', 'ie32'];
+
+  constructor() {
+    super();
+    this.name = 'IEDriver';
+    this.versionCustom = IEDriver.versionDefault;
+    this.prefixDefault = 'IEDriverServer';
+    this.suffixDefault = '.zip';
+    this.cdn = Config.cdnUrls().ie;
+  }
+
+  id(): string { return IEDriver.id; }
+
+  versionDefault(): string { return IEDriver.versionDefault; }
+
+  version(): string {
+    if (type() == 'Windows_NT') {
+      if (arch() == 'x64') {
+        return '_x64_' + this.versionCustom;
+      } else {
+        return '_Win32_' + this.versionCustom;
+        ;
+      }
+    }
+    return '';
+  }
+
+  url(): string {
+    let urlBase = this.cdn + this.shortVersion(this.version()) + '/';
+    let filename = this.prefix() + this.version() + this.suffix();
+    return urlBase + filename;
+  }
+}

lib/binaries/index.ts

@@ -0,0 +1,4 @@
+export * from './binary';
+export * from './chromeDriver';
+export * from './ieDriver';
+export * from './standAlone';

lib/binaries/standAlone.ts

@@ -0,0 +1,34 @@
+import {Binary, OS} from './binary';
+import {Config} from '../config';
+
+/**
+ * The selenium server jar.
+ */
+export class StandAlone extends Binary {
+  static os = [OS.Windows_NT, OS.Linux, OS.Darwin];
+  static id = 'standalone';
+  static versionDefault = Config.binaryVersions().selenium;
+  static isDefault = true;
+  static shortName = ['standalone'];
+
+  constructor() {
+    super();
+    this.name = 'selenium standalone';
+    this.versionCustom = StandAlone.versionDefault;
+    this.prefixDefault = 'selenium-server-standalone-';
+    this.suffixDefault = '.jar';
+    this.cdn = Config.cdnUrls().selenium;
+  }
+
+  id(): string { return StandAlone.id; }
+
+  versionDefault(): string { return StandAlone.versionDefault; }
+
+  url(): string {
+    let urlBase = this.cdn + this.shortVersion(this.version()) + '/';
+    let filename = this.prefix() + this.version() + this.suffix();
+    return urlBase + filename;
+  }
+
+  executableSuffix(ostype?: string): string { return '.jar'; }
+}