Get a Java WebDriver instance changing no line of your test code.

System properties prefixed with 'capabilities.' will be automatically processed as DesiredCapabilities. Among other things, it helps you to launch any test on popular cloud services like BrowserStack, or Saucelabs, or to spin up a local browser whilst you're coding your tests.

GiveMeADriver is open source, released under the terms of

Setup & Basic Usage

In order to use GiveMeADriver, add the following dependency to your Maven project:

<dependency>
  <groupId>io.github.isgarlo</groupId>
  <artifactId>givemeadriver</artifactId>
  <version>1.1</version>
</dependency>

Once the dependency is set, just pass the parameters to your test runner making sure all of them are prefixed by capabilities. :

-Dcapabilities.remote=https://USERNAME:AUTH_KEY@hub-cloud.browserstack.com/wd/hub
-Dcapabilities.os=windows
-Dcapabilities.os_version=7
-Dcapabilities.browser=firefox
-Dcapabilities.browser_version=48.0
-Dcapabilities.resolution=1680x1050

Then, simply get your WebDriver instance:

@Test
public void test() {
  WebDriver driver = GiveMeADriver.create();
}

Capabilities setup

Additionally, some capabilities can be refered by their aliases:

For a complete list of capabilities of the main cloud services take a look to the following links:

• https://www.browserstack.com/automate/capabilities
• https://wiki.saucelabs.com/display/DOCS/Test+Configuration+Options
• https://testingbot.com/support/other/test-options

Other commands

// get the current WebDriver instance
GiveMeADriver.current();
// close the current WebDriver instance. No need to call it if capabilities.autoclose=true
GiveMeADriver.close();

Examples

1. Create a local driver: Firefox with driver binary 0.19.1

   public class LocalDriverTest {
   
   WebDriver driver;
   
   @Before
   public void setup() {
   // setting capabilities programmatically
   System.setProperty("capabilities.browser", "firefox");
   System.setProperty("capabilities.driverVersion", "0.19.1");
   driver = GiveMeADriver.create();
   }
   
   @Test
   public void myTest() {
   // use the driver here or
   // get it by GiveMeADriver.current();
   }
   
   @After
   public void tearDown() {
   // no need to driver.quit(); nor GiveMeADriver.close();
   // if capabilities.autoclose=true
   }
   }

   Notice that capabilities.remote has not been set. A local Firefox browser will be open. Currently, the local supported browsers are: chrome, firefox, opera, safari, ie, edge, phantomjs, htmlunit.

2. Create a local driver: Chrome with latest binaries.

   public class LocalDriverTest {
   
   @Test
   public void createLocalDriver() {
   GiveMeADriver.create();
   }
   }

3. Create a remote driver: Chrome 62 in BrowserStack.

   public class RemoteDriverTest {
   
   @Test
   public void createRemoteDriver() {
   System.setProperty("capabilities.remote", 
     "https://USERNAME:AUTH_KEY@hub-cloud.browserstack.com/wd/hub");
   System.setProperty("capabilities.browser", "chrome");
   System.setProperty("capabilities.browser_version", "62");
   GiveMeADriver.create();
   }
   }

4. Create a local mobile emulator: iPhone 6.

   public class LocalDriverTest {
   
   @Test
   public void createLocalDriver() {
   System.setProperty("capabilities.device", "iPhone 6");
   GiveMeADriver.create();
   }
   }

5. Create a custom local mobile emulator: Generic Apple device at 1024x1366

   public class LocalDriverTest {
   
   @Test
   public void createLocalDriver() {
   System.setProperty("capabilities.userAgent", 
       "Mozilla/5.0 (iPhone; CPU iPhone OS 10_3 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) CriOS/56.0.2924.75 Mobile/14E5239e Safari/602.1");
   System.setProperty("capabilities.viewportSize", "1024x1366");
   System.setProperty("capabilities.pixelRatio", "2.0");
   GiveMeADriver.create();
   }
   }

6. Create a headless local driver: Chrome with latest binaries.

   public class LocalDriverTest {
   
   @Test
   public void createLocalDriver() {
   System.setProperty("capabilities.browser", "chrome");
   System.setProperty("capabilities.headless", "true");
   GiveMeADriver.create();
   }
   }