webdriver-manager

What is webdriver-manager?

The webdriver-manager npm package is a tool for managing WebDriver binaries. It is commonly used to download, update, and start WebDriver binaries for Selenium WebDriver, making it easier to set up and manage the necessary components for running automated browser tests.

What are webdriver-manager's main functionalities?

Download WebDriver binaries

This feature allows you to download the necessary WebDriver binaries for your browser. The `update` method fetches the latest versions of the binaries and stores them locally.

const webdriverManager = require('webdriver-manager');
webdriverManager.update();

Start WebDriver server

This feature starts the WebDriver server, which is necessary for running Selenium WebDriver tests. The `start` method launches the server and makes it ready to accept WebDriver commands.

const webdriverManager = require('webdriver-manager');
webdriverManager.start();

Stop WebDriver server

This feature stops the WebDriver server. The `shutdown` method gracefully stops the server, ensuring that all resources are properly released.

const webdriverManager = require('webdriver-manager');
webdriverManager.shutdown();

Other packages similar to webdriver-manager

selenium-standalone

The selenium-standalone package is similar to webdriver-manager in that it helps manage Selenium WebDriver binaries. It provides commands to install, start, and stop the Selenium server. Compared to webdriver-manager, selenium-standalone offers more flexibility in configuring the Selenium server and supports a wider range of browsers and versions.

chromedriver

The chromedriver package is specifically designed to manage the ChromeDriver binary. It allows you to download, update, and start the ChromeDriver server. While it is more limited in scope compared to webdriver-manager, it is a good choice if you only need to work with Chrome.

geckodriver

The geckodriver package is similar to chromedriver but is focused on managing the GeckoDriver binary for Firefox. It provides functionality to download, update, and start the GeckoDriver server. Like chromedriver, it is more specialized and limited in scope compared to webdriver-manager.

README

Webdriver Manager

Protactor's webdriver-manager as an standalone Node.js module.

Warning: The official protractor webdriver-manager can be found here: https://github.com/angular/protractor/blob/master/bin/webdriver-manager

Changelog

11.0.0

Breaking Change:

• Requires node 6 since node 6 is in long term support. See (node LTS Schedule)[https://github.com/nodejs/LTS#lts-schedule].

Features

• (b5638ef) feat(update): on update, write full binary paths to file (#140)

  • Adding back in curl calls, these were removed on the new Downloader.getFile. Add curl call to reflect proxies.

  • Fix output dir to read from update's options instead of Config

  • Feature will help directConnect users for Protractor. The file will keep track of the last binary version as well as all other binaries downloaded.

  The file will be created in the output directory. By default this is selenium/update-config.json. On clean this file will be removed.

  webdriver-manager update --versions.chrome=2.20 --standalone=false
  --gecko=false
  

  file created:

  {
    "chrome": {
      "last": "/opt/src/webdriver-manager/selenium/chromedriver_2.20",
      "all": ["/opt/src/webdriver-manager/selenium/chromedriver_2.20"]
    }
  }
  

  then the user wants to use 2.25:

  webdriver-manager update --versions.chrome=2.25 --standalone=false
  --gecko=false
  
  

  file created:

  {
    "chrome": {
      "last": "/opt/src/webdriver-manager/selenium/chromedriver_2.25",
      "all": ["/opt/src/webdriver-manager/selenium/chromedriver_2.20",
              "/opt/src/webdriver-manager/selenium/chromedriver_2.25"]
    }
  }
  

• (473ab3e) feat(android): match android arch to os.arch (#164)

  The default was x86-64, but x86 cannot be emulated on ARM. This makes more sense

• (c864c9a) feat(shutdown): do not error if you try to shutdown a server which is already off (#162)

  When scripting, you might want to defensively run a shutdown command. If the shutdown fails because the server is already off, you don't care. If it fails for another reason, you do care. So I made trying to shutdown a server which is already off just a warning. I added a flag in case you want the old behavior though.

• (338fffd) feat(quiet/verbose): add --quiet and --verbose flags to control the level of output (#156)

  I added the --quiet flag for cases like: where currently the start --detach; ./tests.sh; webdriver-manager shutdownselenium server output will get mixed in with other output. I also added the--verboseflag forwebdriver-manager updatein case you *really* wanted to see all the output which gets eaten by using--android-accept-licenses`.

• (91e36a3) feat(android on windows): Support android VMs on windows (#154)

  Closes https://github.com/angular/webdriver-manager/issues/51

• (d533b03) feat(start android): extend the --detach flag to wait for appium/android (#141)

Bug fixes

• (26586f1) fix(start): wait for emulated android to really be ready before signaling (#161)

  Before, we were just waiting for the emulator to be running, rather than waiting for the OS to be booted up and ready to instance chrome. While I was doing that I moved some stuff into lib/utils.ts since I felt like too much of lib/cmds/start.ts was being devoted to this one feature. Also closes https://github.com/angular/webdriver-manager/issues/166

• (a7c6eb5) fix(update/android): 2a1505f broke android

• (3ee3e1a) fix(fs): path.join does not handle absolute paths as desired (#152)

• (deead0f) fix(downloader): destroy the request after receiving the header (#144)

  Otherwise we’ll won’t terminate until the whole file was downloaded, even though we don’t need it.

• (c16bf90) chore(es6): allow to use es6 promises (#160)

  • with node 6 on LTS, we can update the tsconfig to es6
  • update travis tests to use node 6 and 7