Health Check
Table of Contents
Overview
The following repository: https://github.com/saucelabs-training/demo-java, allows you to quickly run simple automated tests in order to validate your Java test environment with your saucelabs.com account credentials. Below are the steps to configure your test environment and run a simple automated test.
For Demonstration Purposes Only!
Disclaimer:
The code in these scripts is provided on an "AS-IS" basis without warranty of any kind, either express or implied, including without limitation any implied warranties of condition, uninterrupted use, merchantability, fitness for a particular purpose, or non-infringement. These scripts are provided for educational and demonstration purposes only, and should not be used in production. Issues regarding these scripts should be submitted through GitHub. These scripts are maintained by the Technical Services team at Sauce Labs.
Some examples in this repository, such as
appium-example,parallel-testing, andheadless, may require a different account tier beyond free trial. Please contact the Sauce Labs Sales Team for support and information.
Solution Outline
The repository has several demonstration scripts that fit various use cases, such as:
If you just wish to get up and running quickly with Sauce Labs, please follow the instructions below.
Prerequisites
In order to run this demo on your local machine, you must download, install, and configure the prerequisite software.
Use a Pre-built Workspace.
If you want to skip the prerequisite setup, you can try this demo in a cloud-based IDE hosted by gitopd.io
After the session launches, navigate to the terminal and use the following commands to export your Sauce Labs credentials:
eval $(gp env -e SAUCE_USERNAME=******) eval $(gp env -e SAUCE_ACCESS_KEY=******)
Note: If you start a new session or terminal in gitpod you have to re-apply environment variables. For more information consult the gitpod documentation.
eval $(gp env -e)
Run a Maven test:
mvn test -Dtest=Module2TestNGTest -pl on-boarding-modules/testng
Sauce Labs Test Setup
Import the Project
- Create a directory on your machine.
- Clone this repository into said directory.
$ git clone https://github.com/saucelabs-training/demo-java.git
- Import the project into your IntelliJ (or IDE of your choice) as a Maven Project.
- Click through the prompts, and confirm when it asks to Import from Sources
- Choose the demo-java directory as the root directory of the project.
Set Your Sauce Labs Credentials
-
Copy your Sauce Labs username and accessKey in the User Settings section of the Sauce Labs Dashboard.
-
Open a Terminal window (command prompt for Windows) and set your Sauce Labs Environment variables:
Mac OSX:
$ export SAUCE_USERNAME="username" $ export SAUCE_ACCESS_KEY="accessKey"
Windows:
> set SAUCE_USERNAME="username" > set SAUCE_ACCESS_KEY="accessKey"
To set an environment variables permanently in Windows, you must append it to the
PATHvariable.Go to Control Panel > System > Windows version > Advanced System Settings > Environment Variables > System Variables > Edit > New
Then set the "Name" and "Value" for each variable
-
Test the environment variables
Mac OSX:
$ echo $SAUCE_USERNAME $ echo $SAUCE_ACCESS_KEY
***WARNING FOR UNIX USERS!***: If you have problems setting your environment variables, run the following commands in your terminal:
$ launchctl setenv SAUCE_USERNAME $SAUCE_USERNAME $ launchctl setenv SAUCE_ACCESS_KEY $SAUCE_ACCESS_KEY
Windows:
> echo %SAUCE_USERNAME% > echo %SAUCE_ACCESS_KEY%
Run a Maven Test
-
Run the following command to update any package dependencies:
$ mvn dependency:resolve
-
Then run the following command to compile your test code:
$ mvn test-compile
-
Finally, run the following test to see if you've properly configured the test environment:
$ mvn test -Dtest=Module2TestNGTest -pl on-boarding-modules/testng
If you wish to run a specific test/sub-module in this emusim_testng use the following command:
# for running a specific test: mvn test -Dtest=testname # for running a specific sub-module mvn test -pl subproject/
Health Check
Table of Contents
Overview
The following repository: https://github.com/saucelabs-training/demo-python, allows you to quickly run simple automated tests in order to validate your Python test environment with your saucelabs.com account credentials. Below are the steps to configure your test environment and run a simple automated test.
For Demonstration Purposes Only!
Disclaimer
The code in these scripts is provided on an "AS-IS" basis without warranty of any kind, either express or implied, including without limitation any implied warranties of condition, uninterrupted use, merchantability, fitness for a particular purpose, or non-infringement. These scripts are provided for educational and demonstration purposes only, and should not be used in production. Issues regarding these scripts should be submitted through GitHub. These scripts are maintained by the Technical Services team at Sauce Labs.
Some examples in this repository, such as
appium-examplesandheadless-examples, may require a different account tier beyond free trial. Please contact the Sauce Labs Sales Team for support and information.
Solution Outline
- Tests that can help you quickly and easily get started with Sauce Labs
- Tests that use the Headless feature of Sauce Labs (not included with basic tier or free trial customers)
- Mobile Examples using Appium on Sauce Labs
Prerequisites
Before attempting an automated test, ensure you've installed the following software:
Use a Pre-built Workspace
If you want to skip the prerequisite setup, you can try this demo in a cloud-based IDE hosted by gitopd.io
After the session launches, navigate to the terminal and use the following commands to export your Sauce Labs credentials:
eval $(gp env -e SAUCE_USERNAME=******) eval $(gp env -e SAUCE_ACCESS_KEY=******)
Note: If you start a new session or terminal in gitpod you have to re-apply environment variables. For more information consult the gitpod documentation.eval $(gp env -e)
Install dependencies and run a python test:
pip install -r requirements.txt && / python on-boarding-modules/python-examples/test_module2.py
Sauce Labs Test Setup
-
Navigate to the root project directory and use
pipto install the latest Selenium library for use in the script:$ pip install -r requirements.txt
-
Run the Test Script
In order to run the test on www.saucelabs.com, change the values of the
SAUCE_USERNAMEandSAUCE_ACCESS_KEYvariables in the test script to your Sauce Username and Sauce Access Key values. To retrieve this information, login to your saucelabs.com account and navigate to User Settings;-
Run the following command to test your python script:
$ python on-boarding-modules/python-examples/test_module2.py
-
You may also use 'Run Configurations' in your IDE. For directions on how to setup Run/Debug Configurations refer to your IDE Documentation:
-
-
Visit the saucelabs.com automated build page and select the build
Onboarding Sample App - Pythonto see the following test case:
Health Check
Table of Contents
Overview
The following repository: https://github.com/saucelabs-training/demo-js, allows you to quickly run simple automated tests in order to validate your NodeJS test environment with your saucelabs.com account credentials. Below are the steps to configure your test environment and run a simple automated test.
For Demonstration Purposes Only!
Disclaimer
The code in these scripts is provided on an "AS-IS" basis without warranty of any kind, either express or implied, including without limitation any implied warranties of condition, uninterrupted use, merchantability, fitness for a particular purpose, or non-infringement. These scripts are provided for educational and demonstration purposes only, and should not be used in production. Issues regarding these scripts should be submitted through GitHub. These scripts are maintained by the Technical Services team at Sauce Labs.
Some examples in this repository, such as
appium-examplesandheadless-examples, may require a different account tier beyond free trial. Please contact the Sauce Labs Sales Team for support and information.
Solution Outline
- Tests that can help you quickly and easily get started with Sauce Labs
- W3C examples using Sauce Labs
- Tests that use the Headless feature of Sauce Labs (not included with basic tier or free trial customers)
- Mobile Examples using Appium on Sauce Labs
Prerequisites
In order to run this demo on your local machine, you must download, install, and configure the prerequisite software.
Use a Pre-built Workspace
If you want to skip the prerequisite setup, you can try this demo in a cloud-based IDE hosted by gitopd.io
After the session launches, navigate to the terminal and use the following commands to export your Sauce Labs credentials:
$ eval $(gp env -e SAUCE_USERNAME=******) $ eval $(gp env -e SAUCE_ACCESS_KEY=******)
Note: If you start a new session or terminal in gitpod you have to re-apply environment variables. For more information consult the gitpod documentation.$ eval $(gp env -e)
Navigate to the desired test directory, for example:
$ cd mocha-chai-tests
Resolve the package dependencies and then run the test:
$ npm install && npm test
Sauce Labs Test Setup
This example script follows the best practice of using environment variables in place of hardcoded authentication credentials. Once you've been able to successfully run the instant test with hardcoded credentials, you can use this test to make sure that you've correctly set up your environment variables for authentication.
-
Clone the Repository and set your Sauce Labs Credentials:
git clone https://github.com/saucelabs-training/demo-js.git export SAUCE_USERNAME=******** export SAUCE_ACCESS_KEY=*******
-
Navigate to the desired directory (e.g.):
cd mocha-chai-tests
-
Resolve Dependencies (via
package.json)npm install
-
Run the Test
npm test
You should see the following output in the console:
> demo-js@0.0.1 test /path/to/demo-js > node on-boarding-modules/node-examples/module2-test.js Test Passed!
-
Visit the saucelabs.com automated build page and select the build
Onboarding Sample App - NodeJSto see the following test case:
If you want to get up and running with Sauce Labs but don't have any Selenium test scripts, you can use the ones in this topic to see how how it works. All you need to do is add your Sauce Labs username and password, and then run the script from the local machine where you have your Selenium environment set up. When the script runs, it will connect to Sauce Labs using your authentication credentials, launch the browser set in the test script, load the Sauce Labs demo website, and then close the browser and quit the test.
After running the test, you can log into the Sauce Labs web interface to see the test listed on your dashboard, and view information about the test, including video, by clicking on the test name to view the Test Details page.
If you want to experiment with the sample script further, try using the Platform Configurator to change the Desired Capabilities of the test, or substitute the URL of the web app you want to test for the sauce.demo URL.
Example Only
The code in this topic is presented as an example only, since your tests and testing environments may require specialized scripting. This information should be taken only as an illustration of how you could set up your tests with Sauce Labs, and is not directly supported by Sauce.
Prerequisites
- You should have a Sauce Labs account
- You should have a Selenium environment with the C# bindings set up on a local machine where you'll launch your tests. If you need help with setting this up, check out the ReadMe in the C# sample script repository on GitHub.
- You should review the Best Practices for Running Tests
Instant Test
Download this script from the GitHub repo to your local machine, provide the information for SAUCE_USERNAME and SAUCE_ACCESS_CODE as indicated in the script, and then save and run the script. If you log in to saucelabs.com before you run the script, you'll be able to watch the script's progress as it executes.
To find your Sauce Labs access key:
- Sign in to https://saucelabs.com with the username you set up when you created your account.
You will use this same username in your test script. - To find your access key:
- Click your name in the Account Profile menu in the upper-right corner.
- Click User Settings.
- Scroll down to Access Key and click Show.
- Enter the password you use to sign in to Sauce Labs to view the access key.
- Click the Copy icon.
IP Ranges and Data Center Endpoints
Sauce Labs has data centers in both the US and EU. You can access Sauce Labs services from either location by providing the appropriate URL endpoints, and whitelisting their associated IP ranges.
- Status Page for the US Data Center: https://status.saucelabs.com
- Status Page for the EU Data Center: http://status.eu-central-1.saucelabs.com/
- Status Page for the US Data Center (Headless): https://status.us-east-1.saucelabs.com/
Instant Test with Environment Variables
This example script follows the best practice of using environment variables in place of hardcoded authentication credentials. Once you've been able to successfully run the instant test with hardcoded credentials, you can use this test to make sure that you've correctly set up your environment variables for authentication.
Instant Test with Best Practices and Sauce Labs Reporting
This example script illustrates the use of several best practices in test design, and will report Pass/Fail status to the Sauce Labs dashboard.
Running Local Tests
Developing websites/apps within your local network is secure and efficient. The drawback to this method is that local assets are not publicly-accessible on the Internet, so the browsers/devices in the Sauce Labs cloud can't load and test your app. The solution is to use Sauce Connect. Sauce Connect is a proxy server that creates a secure tunnel connection between the Sauce Labs virtual machine that runs your test and your local network. You can also use Sauce Connect to test applications and websites that are located within your corporate firewall. Sauce Connect is not required to run tests on Sauce Labs, only in situations where the application or website you want to test is not publicly accessible.
Running Tests in Parallel
Now that you’re running tests on Sauce, you may wonder how you can run your tests faster. One way to increase speed is by running tests in parallel across multiple virtual machines.
You can run your tests in parallel at two levels, and you can run your tests in parallel across multiple browsers. For example, if you have 10 tests and want to run on five browsers, this would be parallelism of five. You can also run tests across browsers and each test in parallel. Using our previous example this would be more like 50 parallel tests. Doing this requires that your tests are written in a way that they do not collide with one another, as described in our Best Practice topics avoiding external test dependencies and avoiding dependencies between tests.
Check out Using Frameworks to Run Tests in Parallel for more information, and examples of framework setups for Java, Python, and other programming languages.
For more information, check out the example scripts in our GitHub repo.
Health Check
Table of Contents
Overview
The following repository: https://github.com/saucelabs-training/demo-ruby, allows you to quickly run simple automated tests in order to validate your Ruby test environment with your saucelabs.com account credentials. Below are the steps to configure your test environment and run a simple automated test.
For Demonstration Purposes Only!
Disclaimer:
The code in these scripts is provided on an "AS-IS" basis without warranty of any kind, either express or implied, including without limitation any implied warranties of condition, uninterrupted use, merchantability, fitness for a particular purpose, or non-infringement. These scripts are provided for educational and demonstration purposes only, and should not be used in production. Issues regarding these scripts should be submitted through GitHub. These scripts are maintained by the Technical Services team at Sauce Labs.
Some examples in this repository, such as
appium-examplesandheadless-examples, may require a different account tier beyond free trial. Please contact the Sauce Labs Sales Team for support and information.
Solution Outline
In order to complete these exercises you must complete the following prerequisite installation and configuration steps:
Prerequisites
Before attempting an automated test, ensure you've installed the following software:
Use a Pre-built Workspace
If you want to skip the prerequisite setup, you can try this demo in a cloud-based IDE hosted by gitopd.io
After the session launches, navigate to the terminal and use the following commands to export your Sauce Labs credentials:
eval $(gp env -e SAUCE_USERNAME=******) eval $(gp env -e SAUCE_ACCESS_KEY=******)
Note: If you start a new session or terminal in gitpod you have to re-apply environment variables. For more information consult the gitpod documentation.eval $(gp env -e)
Install dependencies and run a ruby test:
gem install bundler && / bundle install --path .bundle && / bundle exec rspec
Sauce Labs Test Setup
-
Execute the
bundleCommand:-
Use the following to install the required
gems:$ bundle install --path .bundle
-
-
Run the Test Scripts
-
In order to run the tests on www.saucelabs.com, you need to export your Sauce Labs account credentials as environment variables, or hard code (not recommended) the values of
SAUCE_USERNAMEandSAUCE_ACCESS_KEYin each script. For example:https://SAUCE_USERNAME:SAUCE_ACCESS_KEY@ondemand.saucelabs.com:443/wd/hub'
-
Run the following command to have
rspecsearch and execute 'specs' in your project directories:$ bundle exec rspec
-
You may also use 'Run Configurations' in your IDE. For directions on how to setup Run/Debug Configurations refer to Documentation:
-
With Sauce Labs you can run automated tests of your web apps against a wide variety of device/operating system/browser combinations. This topic provides you with the information and code examples you need to get your PHP tests up and running with Sauce.
Example Only
The code in this topic is presented as an example only, since your tests and testing environments may require specialized scripting. This information should be taken only as an illustration of how you could set up your tests with Sauce Labs, and is not directly supported by Sauce.
Prerequisites
Before you get started, you should review the Best Practices for Running Tests.
You need to have these components installed to set up testing on Sauce with PHP:
- You must have PHP set up on your system before you start testing.
Mac OS X comes with PHP installed, as long as you're running version 5.3 or higher, you're ready to go! If you're a Windows user, you can find instructions for setting up PHP on Windows at PHP.net. - Windows users must also enable the PHP curl library and OpenSSL support to get the best performance from your PHP setup.
For more information, see Installing Extensions for Windows on the php.net website as well as these setup topics: - If you want to set up your tests to use a PHP framework, you can check out our repository of testing framework examples in our GitHub repo.
Quick Start
You can set up any PHP test you've already written to run on Sauce, regardless of the testing framework it uses. All you need to do is change the test from running locally, to running on the Sauce cloud by defining the sauce URL, your authentication credentials, and a set of desired capabilities for the test.
This example shows how you could edit the existing test to run on Sauce. You can use the Platform Configurator to specify the desired capabilities for any browser/platform combination you want.
You can also clone this script directly from our GitHub repo.
<?php
// Setup: $ php composer.phar require facebook/webdriver
require_once('vendor/autoload.php');
use Facebook\WebDriver\Remote\RemoteWebDriver;
use Facebook\WebDriver\WebDriverBy;
$web_driver = RemoteWebDriver::create(
"https://YOUR_SAUCE_USERNAME:YOUR_SAUCE_ACCESS_KEY@ondemand.saucelabs.com:443/wd/hub",
array("platform"=>"Windows 7", "browserName"=>"chrome", "version"=>"40")
);
$web_driver->get("https://saucelabs.com/test/guinea-pig");
/*
Test actions here...
*/
$web_driver->quit();
?>
Running Local Tests
Developing websites/apps within your local network is secure and efficient. The drawback to this method is that local assets are not publicly-accessible on the Internet, so the browsers/devices in the Sauce Labs cloud can't load and test your app. The solution is to use Sauce Connect. Sauce Connect is a proxy server that creates a secure tunnel connection between the Sauce Labs virtual machine that runs your test and your local network. You can also use Sauce Connect to test applications and websites that are located within your corporate firewall. Sauce Connect is not required to run tests on Sauce Labs, only in situations where the application or website you want to test is not publicly accessible.
Running Tests in Parallel
Now that you’re running tests on Sauce, you may wonder how you can run your tests faster. One way to increase speed is by running tests in parallel across multiple virtual machines.
You can run your tests in parallel at two levels, and you can run your tests in parallel across multiple browsers. For example, if you have 10 tests and want to run on five browsers, this would be parallelism of five. You can also run tests across browsers and each test in parallel. Using our previous example this would be more like 50 parallel tests. Doing this requires that your tests are written in a way that they do not collide with one another, as described in our Best Practice topics avoiding external test dependencies and avoiding dependencies between tests.
Check out Using Frameworks to Run Tests in Parallel for more information, and examples of framework setups for Java, Python, and other programming languages.
For more information, check out the example scripts in our GitHub repo.
Reporting Test Results
Sausage includes a number of features that make it easier for Sauce to report on your test results.
By default, Sauce Labs doesn't know how to display the name of your test. Sausage comes up with a good name (TestClass::testFunction) and reports it with your test so it's easy to find on your dashboard. Similarly, Sauce has no way to know if a particular test passed or failed. Sausage catches any failed assertions and reports the status of the test to Sauce after it's complete. Upon test failure Sausage will generate an authorized link to the failed job report on the Sauce Labs website, to facilitate reporting to people who need to know the details of the test. The job remains private (unless you change the status yourself), but others can follow the link without needing to log in with your credentials. See the topic Building Links to Test Results for more information.
You should also follow our recommended best practice of adding build numbers, tags, and other identifying information to your tests so you can easily find and manage them in your test results and archives pages, and associate tests with build numbers in your continuous integration pipeline.
Got questions?
As these scripts are not maintained by Sauce support, the best way to get help help – and help us improve – is to submit an issue on GitHub.
Overview
Content Tools