Name: ios-rdc-quickstart
Owner: Sauce Labs
Description: How to get started with the iOS Real Device Cloud.
Created: 2015-09-26 04:37:02.0
Updated: 2018-04-19 19:36:39.0
Pushed: 2015-12-16 00:46:25.0
Homepage: null
Size: 2029
Language: Python
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
We're proud to present the new Sauce Labs Real Device Cloud. Now, you can test your apps and websites on actual iOS devices like the iPhone 6.
We can do it because we've hooked real iOS devices up to the cloud, and made them run your tests just like iOS simulators… almost.
To get you started, we've put together some sample tests, with a sample app, that you can try – right now – with your own Sauce Labs account.
Table of Contents
Sauce Labs works with Selenium libraries in any language, but the examples here are (for now) just in Python. So you'll need to be familiar with running scripts on the command line, and have Python 2.x or better installed.
To get these scripts to work, first you'll need a couple of environment variables.
SAUCE_USERNAME should be the
username you use to log into https://saucelabs.com/.
SAUCE_ACCESS_KEY should be the “access key” that Sauce assigned to you. To find it, first log into
your account on the Sauce Labs website.
Type these commands:
rt SAUCE_USERNAME=your_username
rt SAUCE_ACCESS_KEY=your_access_key
You might want to add these lines to your shell's startup profile, which for most people
is in their home directory under .bash_profile.
Type these commands:
SAUCE_USERNAME=your_username
SAUCE_ACCESS_KEY=your_access_key
You might want to add this to your default environment variables.
If you use Sauce already, you almost certainly have this stuff, but in case you are
on a fresh machine: in the shell, enter the directory where you installed these files.
And then, install dependencies with pip install -r requirements.txt.
Log into your account on Sauce Labs. It's not necessary, but it's just interesting to watch the tests progress.
In a shell, enter the directory containing the test files. To run the tests, just type nosetests -vv.
nosetests will find anything that looks like a test and run it. It may take a while before you
see anything, but soon you'll see tests running, in your shell and in the web interface for your account!
Hopefully that worked (if it didn't, see the contact info below) and you're interested in writing your own tests now. Let's have a look at these example tests for clues about how to write your own.
To start, let's look at test_web.py, and see what's happening.
test_web peforms a simple test of a web page, on two different platforms; an iPhone 6 simulator, and
an iPhone 6. The @on_platforms decorator is just a handy way of running the same test on various platforms.
As you can see, the capabilities for a real device are very similar to those for a simulator.
The only difference is that instead of saying "deviceName": "iPhone 6", you use "deviceName": "iPhone 6 Device".
And that's just about it. There isn't much that's different for a web test between platforms.
The one thing to watch out for is that we haven't yet released Sauce Connect for iOS Real Devices. But it's on the way! Check with Sauce Labs for updates.
Pop open the file test_app.py and have a look!
This performs a really simple test on a simple app. The app has two views, and the test just clicks on one button and checks if the view has changed.
You specify a real device in your capabilities just like the web test - "deviceName": "iPhone 6 Device".
You put the app in "app", but there are a few things to watch out for:
Up till now you've probably only been uploading simulator apps to Sauce Labs. But if you run your app on a real iOS device, it has to be compiled and archived specially for one.
We can't go into a full discussion of how to compile iOS apps, but here are some tips to get you started:
You can make a .app directory or an .ipa. (See the Uploading section).
If you are using Apple's development IDE, XCode, you will have to create a “scheme” which archives the application to a file. Then use that as your app file. Here's where to start in Apple's documentation:
If you are building with the command-line tool, xcodebuild, the arguments should include:
-arch armv7 -sdk iphoneos
This StackOverflow post, xcodebuild simulator or device? may also help.
Sauce Labs can accept your app in two formats.
.ipa; or.app directory, whose filename must end in .zip.The big difference from simulator tests is that you have to upload a real device iOS app to
Sauce Storage first. And
then, to test the app you just uploaded, use a sauce-storage: URL as the app property in the capabilities.
For instance, if your app is called your_app.zip, you would upload it to Sauce Storage, and then in the capabilities for
your test you would use app: "sauce-storage:your_app.zip".
Sauce Storage is a convenient place to temporarily store files that your tests will need. Rather than waste time and bandwidth transferring the file over to us for every test, you can just upload it to us once, in a secure, private area.
If you want to upload the app yourself ahead of time, the saucestorage helper library, included here, could be of use. Or,
use a simple shell command with curl. See the Sauce Storage API documentation.
If you write tests in Python, we've made it extra easy with the helpers in this package. sauce_storage_upload("path/to/your_app.zip") will upload
the file and return the correct sauce-storage: URL.
Here's a thing you don't have to worry about, but in case you have questions:
You may already be aware that iOS apps in development won't run on just any device. They need to be “provisioned” for that device, first. But you don't have to do anything special to ensure your apps are “provisioned” for our iOS Devices. We've taken care of all that by re-provisioning your apps for our devices, on the fly.
Long story short: if you can run your app on an iOS real device, so can we.
We're still producing supporting materials for the iOS Real Device Cloud, so if you have any questions contact Chiarng Lin or Neil Manvar.