feat(selenium-grid): run webdriver-manager as a selenium-grid node (merge against master branch)

README.md

@@ -129,4 +129,4 @@ Options:
   --versions.gecko       The geckodriver version.                       [string]
   --versions.ie          The ie driver version.                         [string]
   --versions.standalone  The selenium server standalone version.        [string]
-```
+```

lib/cli/index.ts

@@ -85,6 +85,11 @@ const standaloneNodeOption: yargs.Options = {
   describe: 'Start the selenium server standalone with role set to "node".',
   type: 'boolean'
 };
+const GRID_NODE = 'gridNode';
+const gridNodeOption: yargs.Options = {
+  describe: 'Start the selenium grid with role set to "node".',
+  type: 'string'
+};
 const VERSIONS_CHROME = 'versions.chrome';
 const versionsChromeOption: yargs.Options = {
   describe: 'The chromedriver version.',
@@ -139,6 +144,7 @@ yargs
               .option(SELENIUM_PORT, seleniumPort)
               .option(STANDALONE, standaloneOption)
               .option(STANDALONE_NODE, standaloneNodeOption)
+              .option(GRID_NODE, gridNodeOption)
               .option(VERSIONS_CHROME, versionsChromeOption)
               .option(VERSIONS_GECKO, versionsGeckoOption)
               .option(VERSIONS_IE, versionsIeOption)

lib/cmds/options.ts

@@ -37,6 +37,8 @@ export interface Server {
   version?: string;
   // Run as role = node option.
   runAsNode?: boolean;
+  // Run as grid node role = hub registration URL path.
+  gridNode?: string;
   // The relative or full path to the chrome logs file.
   chromeLogs?: string;
   // The full path to the edge driver server.

lib/cmds/utils.ts

@@ -42,6 +42,7 @@ export function addOptionsBinary(options: Options): OptionsBinary {
     seleniumProviderConfig.port = optionsBinary.server.port;
     seleniumProviderConfig.runAsDetach = optionsBinary.server.runAsDetach;
     seleniumProviderConfig.runAsNode = optionsBinary.server.runAsNode;
+    seleniumProviderConfig.gridNode = optionsBinary.server.gridNode;
     optionsBinary.server.binary = new SeleniumServer(seleniumProviderConfig);
   }
   return optionsBinary;
@@ -112,10 +113,15 @@ export function convertArgs2Options(argv: yargs.Arguments): Options {
   if (argv.iedriver as boolean) {
     options.browserDrivers.push({name: 'iedriver', version: versionsIe});
   }
+  if (argv.gridNode as string === '') {
+    console.log('Please specify a grid hub URL...');
+    process.exit();
+  }
   if (argv.standalone as boolean) {
     options.server = {};
     options.server.name = 'selenium';
     options.server.runAsNode = argv.standalone_node as boolean;
+    options.server.gridNode = argv.gridNode as string;
     options.server.runAsDetach = argv.detach as boolean;
     options.server.version = versionsStandalone;
     options.server.chromeLogs = argv.chrome_logs as string;

lib/provider/selenium_server.spec-unit.ts

@@ -38,6 +38,8 @@ describe('selenium_server', () => {
       const javaArgs = '-role node ' +
           '-servlet org.openqa.grid.web.servlet.LifecycleServlet ' +
           '-registerCycle 0 -port 4444';
+      const javaGridArgs = '-role node ' +
+          '-hub ';
       const javaArgsPort = '-port 4444';
       it('should use a selenium server with no options', () => {
         spyOn(fs, 'readFileSync').and.returnValue(configBinaries);
@@ -71,6 +73,20 @@ describe('selenium_server', () => {
                 '-Dwebdriver.chrome.driver=path/to/chromedriver ' +
                 '-jar path/to/selenium-server-3.0.jar ' + javaArgs);
       });
+
+      it('should use a selenium server with a grid node option', () => {
+        spyOn(fs, 'readFileSync').and.returnValue(configBinaries);
+        const seleniumServer = new SeleniumServer();
+        seleniumServer.runAsDetach = true;
+        seleniumServer.runAsNode = true;
+        seleniumServer.runAsGrid = true;
+        const cmd = seleniumServer.getCmdStartServer(
+            {'-Dwebdriver.chrome.driver': 'path/to/chromedriver'});
+        expect(cmd.join(' '))
+            .toContain(
+                '-Dwebdriver.chrome.driver=path/to/chromedriver ' +
+                '-jar path/to/selenium-server-3.0.jar ' + javaGridArgs);
+      });
     });
 
     describe('getStatus', () => {

lib/provider/selenium_server.ts

@@ -15,7 +15,9 @@ const log = loglevel.getLogger('webdriver-manager');
 
 export interface SeleniumServerProviderConfig extends ProviderConfig {
   port?: number;
+  gridNode?: string;
   runAsNode?: boolean;
+  runAsGrid?: boolean;
   runAsDetach?: boolean;
 }
 
@@ -27,10 +29,12 @@ export class SeleniumServer implements ProviderInterface {
   osArch = os.arch();
   outDir = OUT_DIR;
   port = 4444;
+  gridNode = '';
   proxy: string = null;
   requestUrl = 'https://selenium-release.storage.googleapis.com/';
   seleniumProcess: childProcess.ChildProcess;
   runAsNode = false;
+  runAsGrid = false;
   runAsDetach = false;
 
   constructor(providerConfig?: SeleniumServerProviderConfig) {
@@ -63,6 +67,10 @@ export class SeleniumServer implements ProviderInterface {
       if (providerConfig.runAsNode) {
         this.runAsNode = providerConfig.runAsNode;
       }
+      if (providerConfig.gridNode) {
+        this.runAsGrid = true;
+        this.gridNode = providerConfig.gridNode;
+      }
       if (providerConfig.runAsDetach) {
         this.runAsDetach = providerConfig.runAsDetach;
         this.runAsNode = true;
@@ -182,7 +190,7 @@ export class SeleniumServer implements ProviderInterface {
     options.push('-jar');
     options.push(jarFile);
 
-    if (this.runAsNode) {
+    if (this.runAsNode && !this.runAsGrid) {
       options.push('-role');
       options.push('node');
 
@@ -192,8 +200,17 @@ export class SeleniumServer implements ProviderInterface {
       options.push('-registerCycle');
       options.push('0');
     }
-    options.push('-port');
-    options.push(this.port.toString());
+    if (this.runAsGrid) {
+      options.push('-role');
+      options.push('node');
+
+      options.push('-hub');
+      options.push(this.gridNode);
+    }
+    if (!this.runAsGrid) {
+      options.push('-port');
+      options.push(this.port.toString());
+    }
 
     return options;
   }
@@ -332,4 +349,4 @@ export function semanticVersionParser(xmlKey: string) {
  */
 export function matchBinaries(): RegExp|null {
   return /selenium-server-standalone-\d+.\d+.\d+.*.jar/g;
-}
+}