Skip to main content

Automated Testing on Mac - test GUI applications written in Cocoa by using Apple's Accessibility API

Project description

Introduction

We are pleased to introduce the first Python library to fully enable GUI testing of Mac applications via the Apple Accessibility API. This library was created out of desperation. Existing tools such as using appscript to send messages to accessibility objects are painful to write and slow to use. ATOMac has direct access to the API. It’s fast and easy to use to write tests.

Getting started

ATOMac requires a system running OS X and Xcode installed. It has been tested extensively on 10.6, 10.7, and 10.8. 10.5 may work. If you experience issues with ATOMac on a particular version of OS X, please open a ticket in the issue tracker.

Systemwide accessibility must be enabled. Check the checkbox: System Preferences > Universal Access > Enable access for assistive devices. Failure to enable this will result in ErrorAPIDisabled exceptions during some module usage.

Installation should be as simple as running the following command line, which will download, build and install ATOMac:

$ sudo easy_install atomac

Usage

Once the atomac module is installed, you should be able to use it to launch an application:

>>> import atomac
>>> atomac.launchAppByBundleId('com.apple.Automator')

This should launch Automator. Next, get a reference to the UI Element for the application itself:

>>> automator = atomac.getAppRefByBundleId('com.apple.Automator')
>>> automator
<pyatom.AXClasses.NativeUIElement AXApplication u'Automator'>

Now, we can find objects in the accessibility hierarchy:

>>> window = automator.windows()[0]
>>> window.AXTitle
u'Untitled'
>>> sheet = window.sheets()[0]

Note that we retrieved an accessibility attribute from the Window object - AXTitle. ATOMac supports reading and writing of most attributes. Using Xcode’s included accessibility inspector can provide a quick way to find these attributes.

There is a shortcut for getting the sheet object which bypasses accessing it through the Window object - ATOMac can search all objects in the hierarchy:

>>> sheet = automator.sheetsR()[0]

There are search methods for most types of accessibility objects. Each search method, such as windows, has a corresponding recursive search function, such as windowsR. The recursive search finds items that aren’t just direct children, but children of children. These search methods can be given terms to identify specific elements. Note that * and ? can be used as wildcard match characters in all ATOMac search methods:

>>> close = sheet.buttons('Close')[0]

ATOMac has a method to search for UI Elements that match any number of criteria. The criteria are accessibility attributes:

>>> close = sheet.findFirst(AXRole='AXButton', AXTitle='Close')

FindFirst and FindFirstR return the first item found to match the criteria or None. FindAll and FindAllR return a list of all items that match the criteria or an empty list.

Objects are fairly versatile. You can get a list of supported attributes and actions on an object:

>>> close.getAttributes()
[u'AXRole', u'AXRoleDescription', u'AXHelp', u'AXEnabled', u'AXFocused',
u'AXParent', u'AXWindow', u'AXTopLevelUIElement', u'AXPosition', u'AXSize',
u'AXTitle']
>>> close.AXTitle
u'Close'
>>> close.getActions()
[u'Press']

Performing an action is as natural as:

>>> close.Press()

Any action can be triggered this way.

LDTP

Starting with version 1.0.0, ATOMac now includes compatibility with LDTP, a cross platform automation library. This allows testers to write a single script that will automate test cases on Linux, Windows, and now Mac OS X. Information and documentation on LDTP can be found at the LDTP home page.

LDTP operation is virtually identical to the operation on Linux. The import mechanism is slightly different, since it is shipped with ATOMac. Cross platform scripts executing on the System Under Test should import the LDTP client as follows:

try:
    import ldtp
except ImportError:
    import atomac.ldtp as ldtp

In the future, the LDTP client may be broken out into a separate platform independent module to ameliorate this issue.

Like the Linux platform, the LDTP daemon may be run on the SUT, enabling client/server testing by executing ‘ldtp’ at a shell prompt. See the LDTP documentation for more details on client/server operation.

Todo and contributing

Although ATOMac is fully functional and drives hundreds of automated test cases at VMware, we have a to-do list to make the project even better.

  • Formatting - this code is not currently PEP-8 compliant.

  • Better mouse handling - for example, a method to smoothly drag from one UI Element to another.

  • Cleanup the search methods - We could use currying to define all the search methods in AXClasses in a cleaner way.

Feel free to submit pull requests against the project on Github. If you’re interested in developing ATOMac itself, sign up to the pyatom-dev mailing list.

See also

License

ATOMac is released under the GNU General Public License. See COPYING.txt for more details.

Authors

James Tatum <jtatum@gmail.com>, Andrew Wu, Jesse Mendonca, Ken Song, Nagappan Alagappan, Yingjun Li, Alexey Kostyrin

And other contributors listed in the CHANGELOG file. Thank you so much!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyatomac-2.0.5.tar.gz (87.8 kB view details)

Uploaded Source

Built Distributions

pyatomac-2.0.5-cp36-cp36m-macosx_10_6_intel.whl (114.2 kB view details)

Uploaded CPython 3.6mmacOS 10.6+ Intel (x86-64, i386)

pyatomac-2.0.5-cp27-cp27m-macosx_10_13_x86_64.whl (102.9 kB view details)

Uploaded CPython 2.7mmacOS 10.13+ x86-64

File details

Details for the file pyatomac-2.0.5.tar.gz.

File metadata

  • Download URL: pyatomac-2.0.5.tar.gz
  • Upload date:
  • Size: 87.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pyatomac-2.0.5.tar.gz
Algorithm Hash digest
SHA256 8e5d76fc57bfb8486c9567d9560eff1b8c4a906f5611908ba2c66875f3188d86
MD5 35d8a04d01e2912fd5b4ff3c8c32f473
BLAKE2b-256 8aad08feb6af9ce54d46a1f32adc7ce9016e6cd190633ff683f437e3633bae00

See more details on using hashes here.

File details

Details for the file pyatomac-2.0.5-cp36-cp36m-macosx_10_6_intel.whl.

File metadata

File hashes

Hashes for pyatomac-2.0.5-cp36-cp36m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 dfbe8ecbe529c30be6f28c09d66060c4c03cd3833ddcf6f08ab740e2780fb7fb
MD5 d5852736e2e5d805314efc924a0fe6a9
BLAKE2b-256 172a91689d7104cae2234c2e051bbb46d8a5cee024500879ec54fa34bd6d0d3f

See more details on using hashes here.

File details

Details for the file pyatomac-2.0.5-cp27-cp27m-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for pyatomac-2.0.5-cp27-cp27m-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 b78fdd172e8915625e90e5c206dcbc8557e3b13425202070a31b113470fce2cc
MD5 96c182d87e6f5c8e4b7f0d25a5200f4b
BLAKE2b-256 ad1df6a707265c582bfa95bbad4900672490c762d99e49d2247cb5bdd688938f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page