Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Using UI Automation to automatically generate all screenshots of your iOS app, on different device types, in different locales by running a single command. Hands free.

branch: master
README.md

UI Screen Shooter

This is a set of scripts to demonstrate how to take screen shots for your iOS app for the App Store automatically using UI Automation. It shows how to take screen shots, extract them from the automation results and change the language in the simulator with shell scripts. This saves quite a bit of time since we need to generate screens for the 3.5" display, the 4" display, and both iPhone and iPad if your app is universal--not to mention that you have to do this for every localization you support in the store.

You can see the script run against one of my apps in this video.

Prerequesites

First, you need to get Xcode from the App Store. It's free and comes with (almost) everything you need. Once you have Xcode installed, you need to install the command line tools.

Pre Xcode 5

Choose "Preferences" from the "Xcode" menu. Choose the "Downloads" and choose the "Components" sub tab. You'll see "Command Line Tools" in the list. Click the install button next to it and wait until it finishes setting up.

Xcode 5 and later

You cannot install command line tools through Xcode. Instead, run 'xcode-select --install' in your Terminal, and install command line tools once prompted.

Pull down this repository and change to the directory in the terminal.

Demonstration

To run the demonstration, type ./ui-screen-shooter.sh ~/Desktop/screenshots to tell it where to put the final set of screen shots. After a few minutes, you can open the destination directory and see all the languages, devices types and screen sizes as PNGs.

By default each screenshot is named like so:

en_US/iphone5-portrait-screen1.png
...

Usage

To use UI Screen Shooter, copy the files (except the Hello World sample app) next to your project files. You may need to change the "Release" build configuration to add i386 to the VALID_ARCHITECTURES for this to work. Then play with the script automation/shoot_the_screens.js to simulate the user interaction you want. ((CONTRIBUTORS, PLEASE HELP EXPAND THIS SECTION WITH YOUR INTEGRATION ADVICE.)) After your screen shots are saved, see https://github.com/rhaining/itc-localized-screenshot-uploader about uploading them in batch to iTunes connect.

The directory is the locale identifier, the first part of the filename is the device (iOS-3.5-in, iOS-4-in, iOS-iPad), the second is the device orientation, and the third is an identifier that you choose for each screen shot when you call captureLocalizedScreenshot().

How It Works

ui-screen-shooter.sh triggers a build of the application for the iOS simulator and puts the resulting bundle in /tmp with a custom name so it can find it. Then, the instruments command line tool is invoked which installs the app bundle and then executes automation/shoot_the_screens.js which drives the simulator. shoot_the_screens.js drives the app and calls captureLocalizedScreenshot() to shoot each image after navigating to the right screen.

captureLocalizedScreenshot() is a custom method that checks for the device and whether it's a 4" display or not, deduces the orientation, and generates the screenshot file name along with the user supplied identifier. Once the name is calculated, it calls captureScreenWithName() on the UIATarget which saves the image along with the Instruments trace results in /tmp.

After each time the automation script ends, ui-screen-shooter.sh copies all the screenshots taken for that Instruments trace run and copies them to locale subdirectories in the destination directory. Then it continues on to execute the same automation script again with a new language or an a new device type. Check out the main function in ui-screen-shooter.sh for how this is all set up.

The app build process may be the most difficult part for you if you're trying to integrate this with your project. xcodebuild needs extra details if you're using an explicit workspace or using a beta version of the dev tools. If the app isn't building, see if you can try to get xcodebuild to work yourself and then alter the xcode function in ui-screen-shooter.sh to match your setup.

For More Info

To learn more about UI Automation, check out my collection of resources on cocoamanifest.net.

Contributing

Feel free to fork the project and submit a pull request. If you have any good ideas to make this easier to set up for new users, that would be great!

Thanks

Thanks to all who have submitted pull requests and offered improvements. Special thanks to Ole Begemann for his marvelous post on NSUserDefaults that inspired me to pass the locale information in on the command line rather than what I was doing before by manipulating the simulate preference plist files.

Contact

Questions? Ask!

Jonathan Penn

License

UI Screen Shooter is available under the MIT license. See the LICENSE file for more info.

Something went wrong with that request. Please try again.