google

google/EarlGrey

:tea: iOS UI Automation Test Framework

View on GitHub Website / Demo Back to listing

5.7kstars 737forks 49contributors Objective-C

README.md

Deprecation: EarlGrey 1.0 is deprecated in favor of EarlGrey 2.0 which integrates it with XCUITest. Please look at the [earlgrey2](https://github.com/google/EarlGrey/tree/earlgrey2) branch. EarlGrey 1.0 is not being maintained internally with iOS 13.

# EarlGrey
[![Apache License](https://img.shields.io/badge/license-Apache%202-lightgrey.svg?style=flat)](https://github.com/google/EarlGrey/blob/master/LICENSE)
[![CC-BY 4.0 License](https://img.shields.io/badge/license-CC%20BY%204.0-lightgrey.svg)](https://github.com/google/EarlGrey/blob/master/LICENSE)
[![Build Status](https://travis-ci.org/google/EarlGrey.svg?branch=master)](https://travis-ci.org/google/EarlGrey)
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
[![CocoaPods](https://img.shields.io/cocoapods/v/EarlGrey.svg?maxAge=2592000)](https://cocoapods.org/pods/EarlGrey)
[![Gem Version](https://badge.fury.io/rb/earlgrey.svg)](https://rubygems.org/gems/earlgrey)

**For EarlGrey 2, please go to [earlgrey2 branch](https://github.com/google/EarlGrey/tree/earlgrey2).**

EarlGrey is a native iOS UI automation test framework that enables you to write
clear, concise tests.

With the EarlGrey framework, you have access to enhanced synchronization
features. EarlGrey automatically synchronizes with the UI, network requests,
and various queues; but still allows you to manually implement customized
timings, if needed.

EarlGrey’s synchronization features help to ensure that the UI is in a steady
state before actions are performed. This greatly increases test stability and
makes tests highly repeatable.

EarlGrey works in conjunction with the XCTest framework and integrates with
Xcode’s Test Navigator so you can run tests directly from Xcode or the command
line (using xcodebuild).

## Getting Started

The EarlGrey documentation for users is located in the
[EarlGrey/docs](https://github.com/google/EarlGrey/tree/master/docs) folder.
To get started, review the EarlGrey features, check for backward compatibility,
and then install/run EarlGrey with your test target. After everything is
configured, take a look at the EarlGrey API and start writing your own tests.

* [Features](https://github.com/google/EarlGrey/tree/master/docs/features.md)
  * [Backward Compatibility](https://github.com/google/EarlGrey/tree/master/docs/backward-compatibility.md)
  * [Install and Run](https://github.com/google/EarlGrey/tree/master/docs/install-and-run.md)
  * [API](https://github.com/google/EarlGrey/tree/master/docs/api.md)
  * [Cheat Sheet](https://github.com/google/EarlGrey/tree/master/docs/cheatsheet/cheatsheet.png)

## Getting Help

If you need help, several resources are available. First check the [FAQ](https://github.com/google/EarlGrey/tree/master/docs/faq.md).
If you have more questions after reading the FAQ, see [Known Issues](https://github.com/google/EarlGrey/tree/master/docs/known-issues.md).
You can bring more specific issues to our attention by asking them on
[stackoverflow.com](http://stackoverflow.com/) using the [#earlgrey tag](http://stackoverflow.com/questions/tagged/earlgrey).
You can also start new discussions with us on our [Google group](https://groups.google.com/forum/#!forum/earlgrey-discuss)
or request to join our [slack channel](https://googleoss.slack.com/messages/earlgrey).

* [FAQ - Frequently Asked Questions](https://github.com/google/EarlGrey/tree/master/docs/faq.md)
  * [IFAQ - Infrequently Asked Questions](https://github.com/google/EarlGrey/tree/master/docs/ifaq.md)
  * [Known Issues](https://github.com/google/EarlGrey/tree/master/docs/known-issues.md)
  * [Stack Overflow](http://stackoverflow.com/questions/tagged/earlgrey)
  * [Slack](https://googleoss.slack.com/messages/earlgrey)
  * [Google Group](https://groups.google.com/forum/#!forum/earlgrey-discuss)

## Analytics

To prioritize and improve EarlGrey, the framework collects usage data and
uploads it to Google Analytics. More specifically, the framework collects the
**MD5 hash** of *Bundle ID*,  *Test Class Names* and *Test Method Names*. This
information allows us to measure the volume of usage. For more detailed
information about our analytics collection, please peruse the
[GREYAnalytics.m](https://github.com/google/EarlGrey/tree/master/EarlGrey/Common/GREYAnalytics.m)
file which contains the implementation details. If they wish, users can choose
to opt out by disabling the Analytics config setting in their test’s
`- (void)setUp` method:

In Objective-C:

```objc
// Disable analytics.
[[GREYConfiguration sharedInstance] setValue:@(NO) forConfigKey:kGREYConfigKeyAnalyticsEnabled];
```

In Swift:

```swift
// Disable analytics.
GREYConfiguration.sharedInstance().setValue(false, forConfigKey: kGREYConfigKeyAnalyticsEnabled)
```

## For Contributors

Please make sure you’ve followed the guidelines in
[CONTRIBUTING.md](https://github.com/google/EarlGrey/tree/master/CONTRIBUTING.md) before making any contributions.

### Setup an EarlGrey Project

1. Clone the EarlGrey repository from GitHub:

git clone https://github.com/google/EarlGrey.git

2. After you have cloned the EarlGrey repository, download all the dependencies
using [**setup-earlgrey.sh**](https://github.com/google/EarlGrey/tree/master/Scripts/setup-earlgrey.sh).
  3. After the script completes successfully, open `EarlGrey.xcodeproj` and ensure that all
the targets build.
  4. You can now use `EarlGrey.xcodeproj` to make changes to the framework.

### Add and Run Tests

#### Unit Tests

To add unit tests for EarlGrey, use `UnitTests.xcodeproj` located at
`Tests/UnitTests`. To run all unit tests, select the **UnitTests** Scheme and press Cmd+U.

#### Functional Tests

To add functional tests for EarlGrey, use the `FunctionalTests.xcodeproj` located
at `Tests/FunctionalTests`. To run all functional tests, select the **FunctionalTests** Scheme and press Cmd+U.

Repository info

Default branch: master
Latest version: 2.2.2
Created: 05/02/2016
Last activity: 05/11/2026
License: Apache-2.0
Open issues: 265
Watchers: 222

Topics

automation earlgrey ios ios-automation ios-development ios-device ios-test test-framework testing-tools ui-automated-tests

Contributors

tirodkar

247 contributions

khandpur

173 contributions

sid-github

93 contributions

bootstraponline

52 contributions

sskhandp

48 contributions