Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pgssoft/automate
Swift framework containing a set of helpful XCTest extensions for writing UI automation tests
https://github.com/pgssoft/automate
automation ios swift-framework uiautomation xctest xcuitest
Last synced: 1 day ago
JSON representation
Swift framework containing a set of helpful XCTest extensions for writing UI automation tests
- Host: GitHub
- URL: https://github.com/pgssoft/automate
- Owner: PGSSoft
- License: mit
- Created: 2016-08-02T12:14:11.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-11-22T09:03:31.000Z (about 1 year ago)
- Last Synced: 2024-04-24T14:15:45.664Z (8 months ago)
- Topics: automation, ios, swift-framework, uiautomation, xctest, xcuitest
- Language: Swift
- Homepage:
- Size: 10.2 MB
- Stars: 285
- Watchers: 20
- Forks: 32
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# AutoMate
`AutoMate` is a Swift framework containing a set of helpful `XCTest` extensions for writing UI automation tests.
It provides strongly typed, extensible wrapper around launch arguments and environment variables, which can be used for language, locale and keyboard type configuration on the device.
With the [`AutoMate-AppBuddy`](https://github.com/PGSSoft/AutoMate-AppBuddy) it can also disable animations in the application and manage events, reminders and contacts.
[](https://swift.org)
[](https://travis-ci.org/PGSSoft/AutoMate)
[](https://cocoapods.org/pods/AutoMate)
[](https://pgssoft.github.io/AutoMate/)
[](https://github.com/Carthage/Carthage)
[](https://github.com/apple/swift-package-manager)
[](https://cocoapods.org/pods/AutoMate)
[](https://github.com/PGSSoft/AutoMate/blob/master/LICENSE)
## Installation
There are three convinient ways to install AutoMate:
* using [CocoaPods](https://cocoapods.org) with Podfile:
```ruby
pod 'AutoMate'
```
* using [Carthage](https://github.com/Carthage/Carthage) and add a line to `Cartfile.private`:
```
github "PGSSoft/AutoMate"
```
`Cartfile.private` should be used because AutoMate framework will be used by UI Tests target only not by the tested application.
* using Swift Package Manager, either via [Xcode](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app) or in `Package.swift`:
```swift
.package(url: "https://github.com/PGSSoft/AutoMate", from: "1.8.0"),
```
## Usage
Full documentation is available at [https://pgssoft.github.io/AutoMate/](https://pgssoft.github.io/AutoMate/).
1. Create a new UI test case class.
2. Import `AutoMate` framework to UI tests files:
```swift
import AutoMate
```
3. Use `TestLauncher` in the `setup()` method to configure application settings and launch the application:
```swift
let app = XCUIApplication()
TestLauncher(options: [
SystemLanguages([.English, .German]),
SystemLocale(language: .English, country: .Canada),
SoftwareKeyboards([.EnglishCanada, .GermanGermany])
]).configure(app).launch()
```
4. Use AutoMate's extensions in your tests. For example:
```swift
func testSomething() {
let app = XCUIApplication()
let button = app.button.element
// helper for waiting until element is visible
waitForVisibleElement(button, timeout: 20)
button.tap()
// isVisible - helper to check that element both exists and is hittable
XCTAssertFalse(button.isVisible)
}
```
## Features (or ToDo)
- [x] Set keyboards
- [x] Set locale
- [x] Set languages
- [x] Custom arguments
- [x] Custom keyboards, locales and languages
- [x] `XCTest` extensions
- [x] Added CoreData launch arguments
- [x] Disable UIView animations (with `AutoMate-AppBuddy`)
- [x] Strong-typed helpers: locators, page object templates (with `AutoMate-Templates`)
- [x] Base XCTestCase template (with `AutoMate-Templates`)
- [x] Most permissions alerts (like: `LocationWhenInUseAlert`, `CalendarAlert`, `PhotosAlert`) (with `AutoMate-ModelGenie`)
- [x] Managing events, reminders and contacts (with `AutoMate-AppBuddy`)
- [x] Companion library for the application (`AutoMate-AppBuddy`)
- [x] Improve launch options type safety
- [x] Smart coordinates
- [x] Check if application is running in UI test environment (with `AutoMate-AppBuddy`)
- [ ] Stubbing network requests
- [ ] Stubbing contacts, events and reminders
- [ ] Taking screenshots
- [ ] Clearing application data
- [ ] Stubbing notifications
## Example application
Repository contains example application under `AutoMateExample` directory.
Structure of the application is simple, but the project contains extensive suite of UI tests to showcase capabilities of the library.
## Development
Full documentation is available at [https://pgssoft.github.io/AutoMate/](https://pgssoft.github.io/AutoMate/).
If you want to provide your custom launch argument or launch environment you have to implement `LaunchOption` protocol or one of its extensions, such as `LaunchArgumentWithSingleValue`:
```swift
enum CustomParameter: String, LaunchArgumentWithSingleValue, LaunchArgumentValue {
var key: String {
return "AppParameter"
}
case value1
case value2
}
```
Then, you can pass it to the `TestBuilder`:
```swift
let launcher = TestLauncher(options: [
CustomParameter.value1
])
```
## Contributing
Bug reports and pull requests are welcome on GitHub at [https://github.com/PGSSoft/AutoMate](https://github.com/PGSSoft/AutoMate).
## License
The project is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
## About
The project maintained by software development agency [PGS Software](https://www.pgs-soft.com).
See our other [open-source projects](https://github.com/PGSSoft) or [contact us](https://www.pgs-soft.com/contact-us) to develop your product.
## Follow us
[](https://twitter.com/intent/tweet?text=https://github.com/PGSSoft/AutoMate)
[](https://twitter.com/pgssoftware)
