Sauce IDE Documentation
What is Sauce IDE?
Sauce Labs extended Selenium IDE to create Sauce IDE in order to combine the simplicity of Selenium RC's cross-browser capabilities and the interactive design of Selenium IDE.
We bridged Selenium IDE and made it an RC client, so you can hit the play button directly from the plugin window and watch the steps turn green one by one as the tests runs in Sauce OnDemand, our own Selenium RC on the cloud service.
Installing Sauce IDE
To get started, install the plugin for firefox from our downloads page and confirming:
After installing the plugin, restart firefox. Now you're ready to rock out with Sauce IDE!
Note
For our initial release we haven't completely separated Sauce IDE from Selenium IDE, so any previous installation of Selenium IDE will be replaced by Sauce IDE with this upgrade. It was merely a result of being strapped for time, and we have no plans to compete with Selenium - one of our top priorities is to allow side-by-side installation of the two.
Using Sauce IDE
If you used Selenium IDE before, you'll feel right at home with Sauce IDE. It's a drop-in replacement, with every Selenium IDE feature available alongside the new capability of running your tests directly in Sauce OnDemand. Let's configure Sauce IDE to get started:
Note If this is your first time with Selenium IDE, you'll want to start by reading the official Selenium documentation.
If you used Selenium IDE before, you will find using Sauce IDE is almost the same. All of Selenium IDE features are available, so you can use Sauce IDE as a drop in replacement.
Configuring Sauce IDE
To start out, signup for a Sauce OnDemand and add a few credits to use the service. Once you've finished with that, open Sauce IDE (in Firefox, click Tools > Sauce IDE). Now let's edit the Sauce OnDemand options to add in your account details, from within the Options panel:
It should end up looking something like this:
- Username
- Your Sauce Labs username
- API Access Key
- Find this on your account page
- Browser
- Pick any browser supported by Sauce Labs to run the test in
- Record Video
- Make sure this is checked to record a video of your test running in Sauce OnDemand
- Max Duration
- Set the maximum time the test should take. If your test runs over time limit, Sauce OnDemand will kill the job.
- User Extensions (URL)
- You can enter a publicly-accessible URL here to point to a Selenium user extensions file. If you have multiple user extensions, just use a JSON array, like ["url/to/ext1.js","url/to/ext2.js"], and each will be loaded into OnDemand for your test.
Now we're ready to go!
Running your first test in Sauce OnDemand
We'll start by recording a test and running it locally to verify that it works. Once you're satisfied with the test, select the preferred browser from the Sauce OnDemand configuration window and hit the "Run on test in Sauce OnDemand" button:
Once the test starts running, you will be redirected to our website, where you will see the current status of your test:
You'll be able to watch as an appropriately configured machine will grab your test and executing steps one by one:
After finishing the test, you'll be redirected to a video recording of it:
Troubleshooting
AndWait commands are not waiting
This is still on the roadmap, so if you find your tests failing because the following steps start before the page finished loading, you will have to add waitForPageToLoad after every AndWait command out there. It's scheduled for a future release however.
Coming in future releases
Our main concern for this first release was to integrate Sauce IDE with our cloud service, but we have a ton of ideas we're working on for it, like allowing Sauce IDE to connect to any remote (or even local!) Selenium RC server (like Sauce RC), so expect new releases regularly. Do you have a feature you feel belongs in Selenium? Any feature you're excited to see? Let us know! We're at the ground-floor for this product, and we'd love to have you involved in guiding its design.