Getting Started

Universal Prerequisites

To start with make sure you have a valid Sauce Labs account

Since credentials should never be stored in code that might get added to a version control system, we have decided to require users of Sauce Bindings to store these values in environment variables:

SAUCE_USERNAME='valid.username'

SAUCE_ACCESS_KEY='valid.key'

Here are instructions for setting environment variables on each Operating System:

• Windows 10
• MacOS
• Linux

Language Specific Prerequisites

Java

1. Install Java version 8 or greater
2. Install your favorite Java IDE (we really like IntelliJ and the Community Edition is free).
3. Choose your test runner below, or use the Sauce Bindings directly without test runner support:

JUnit 5

3. Add the following to your .pom file:

<!-- https://mvnrepository.com/artifact/com.saucelabs/saucebindings-junit4/latest -->

<dependency>

<groupId>com.saucelabs</groupId>

<artifactId>saucebindings-junit5</artifactId>

<version>1.0.0</version>

</dependency>

JUnit 4

3. Add the following to your .pom file:

<!-- https://mvnrepository.com/artifact/com.saucelabs/saucebindings-junit4/latest -->

<dependency>

<groupId>com.saucelabs</groupId>

<artifactId>saucebindings-junit4</artifactId>

<version>1.0.1</version>

</dependency>

TestNG

3. Add the following to your .pom file:

<!-- https://mvnrepository.com/artifact/com.saucelabs/saucebindings-testng/latest -->

<dependency>

<groupId>com.saucelabs</groupId>

<artifactId>saucebindings-testng</artifactId>

<version>1.0.0</version>

</dependency>

Direct

3. Add the following to your .pom file:

<!-- https://mvnrepository.com/artifact/com.saucelabs/sauce_bindings/latest -->

<dependency>

<groupId>com.saucelabs</groupId>

<artifactId>sauce_bindings</artifactId>

<version>1.2.0</version>

</dependency>

Python

1. Install the package:

pip install saucebindings

2. Import it into your project

from saucebindings.options import SauceOptions

from saucebindings.session import SauceSession

Ruby

1. Add it to your Gemfile:

gem 'sauce_bindings'

2. Require it in your project:

require 'sauce_bindings'

If you are using Capybara, you must also require this file:

require 'sauce_bindings/capybara_session'

Examples on this site are written to use RSpec, so to execute them you must also add this to your Gemfile:

gem 'rspec'

C#

C# bindings are coming soon...