Skip to content

Latest commit

 

History

History
182 lines (125 loc) · 7.26 KB

README.md

File metadata and controls

182 lines (125 loc) · 7.26 KB
Raw

Learn SauceLabs Sauce Test Status contributions welcome Join the chat at https://gitter.im/docdis/javascript-best-practice

No Prior Experience Necessary!

Why?

Giving the people using your web/mobile app a great experience is the key to happiness.
If you fail to find (and fix) the bugs in your project, because you did not test it in the target devices/browsers, everyone will be sad ... so take 20 mins to learn about SauceLabs Today!

Who?

Everyone writing web or mobile applications should be testing.

What?

SauceLabs.com lets you Test your Node/Web/Mobile apps in ALL the Browsers!

saucelabs homepage features

If you have never heard of SauceLabs, or need a refresher,
take a couple of minutes to read their list of features: saucelabs.com/features

How?

Signup - No Credit Card Required

First thing you will need to do is signup for the service. Its free. (You will only be asked )

https://saucelabs.com/signup/trial

register for saucelabs

"On Boarding"

Once you have registered, you will be taken to the "on boarding" page: https://saucelabs.com/docs/onboarding
Chose Automated.

click on automated tests

Next you will see a few programming language options

1. Select JS

select javascript

2. Copy the CURL Command

Copy the CURL command that is displayed (into your clipboard)

Imgur

3. Paste & Run the CURL Command in your Terminal

Paste the CURL command you just copied in the previous step into a Terminal window and press the enter key to run the test:

curl command results

4. View the Results in the Browser

Once you have run the command in your terminal, you can view the results in the browser.
visit: saucelabs.com/account
You should expect to see a list of the tests that have been run:

list of past tests

Click on one of the tests to view the result. e.g:

Imgur

5. Watch the Video of the test you just ran!

watch the video of your test

Explanation

Ensure you understand the command you just ran in the terminal:

curl -X POST https://saucelabs.com/rest/v1/USERNAME/js-tests
-u USERNAME:SAUCELABS-UNIQUE-KEY
-d platforms='[["Windows 8", "internet explorer", "10"], ["OS X 10.8", "safari", "6"]]'
-d url="https://saucelabs.com/test_helpers/front_tests/index.html"
-d framework=jasmine
-d name=sauce-sample-test
  • curl -X POST https://saucelabs.com/rest/v1/USERNAME/js-tests - send a POST request to this REST endpoint specifying the JS Test we want to run.
  • -u USERNAME:SAUCELABS-UNIQUE-KEY - authenticate with your Username and SauceLabs Key
  • -d platforms='[["Windows 8", "internet explorer", "10"], ["OS X 10.8", "safari", "6"]]' - specify which Operating System and Browser Version you want to run your test in.
  • -d url="https://saucelabs.com/test_helpers/front_tests/index.html" - url you want SauceLabs to test.
  • -d framework=jasmine - the testing framework you want to run for this test
  • -d name=sauce-sample-test - name of the test you are running (any string is valid)

Notes:

  • While the JS tutorial on SauceLabs instructs you to setup Karma and use Mocha,
    these are by no means the only options for tools.
  • Other (front-end) JavaScript testing frameworks are supported: including QUnit, Mocha, Jasmine and YUI.
  • It is not immediately obvious in the docs, but in addition to these existing frameworks,
    you can also write custom tests: https://docs.saucelabs.com/reference/rest-api/#js-unit-testing

Conclusion

That's it! Now you know how to run a Cross-Browser Test on SauceLabs!

Sauce Test Status

Performing SauceLab tests with a React app

  • Install zuul by running npm i zuul --save-dev. Zuul allows you to host your tests on a port and communicate your test results with SauceLabs. It uses localtunnel.me to look after tunnels for you so you don't have to bother!
  • After creating a SauceLabs account, create a file called .zuulrc in your HOME directory on your computer. Everyone running the tests from their local machine will need to do this individually. If you use atom, you can do this with the nifty shortcut: atom ~/.zuulrc. In the file, save the following details:
sauce_username: myusername
sauce_key: XXX
  • Then create a .zuul.yml file in the ROOT directory of your project with the following format:
ui: tape
browsers:
  - name: chrome
    version: 27
  - name: ie
    version: 9..latest
  • Note: You can add as many browsers as you want! If you want to see a list of all of the available browsers on zuul then type the follow into your terminal.
node_modules/.bin/zuul --list-available-browsers
  • You're almost ready to run your SauceLabs tests! If you're using ES6 then you will need to bundle up your test files using webpack or browserify and babel.
  • Run the following in your command line in the same directory as your two files:
node_modules/.bin/zuul --local 8080 --ui tape -- public/testBundle.js

(Change 'tape' to 'mocha-qunit' or whatever your testing framework is)

  • Now logon to Saucelabs to watch your tests' progress on a whole range of browsers!
  • More info on Saucelabs testing with Zuul can be found here

What's Next?

  • Explore the other features SauceLabs has to offer: saucelabs.com/features
  • Star this repo/tutorial (on GitHub!) to show others you liked it!
  • Tweet us if you want a more advanced tutorial!

Background

Node.js Module

SauceLabs recommends: https://github.com/holidayextras/node-saucelabs
(hasn't been updated in a while, but has no dependencies so should be fine)

Saucelabs Browsers

The full list of available platforms and browsers is: https://saucelabs.com/platforms/
An example configuration file: http://git.io/vfAMY