Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pgssoft/automate-appbuddy
iOS UI automation tests helper framework, designed to work with the AutoMate
https://github.com/pgssoft/automate-appbuddy
automation ios swift-framework uiautomation xctest xcuitest
Last synced: 2 months ago
JSON representation
iOS UI automation tests helper framework, designed to work with the AutoMate
- Host: GitHub
- URL: https://github.com/pgssoft/automate-appbuddy
- Owner: PGSSoft
- License: mit
- Created: 2017-02-24T08:57:30.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-11-22T09:05:28.000Z (about 1 year ago)
- Last Synced: 2024-10-31T16:11:40.026Z (3 months ago)
- Topics: automation, ios, swift-framework, uiautomation, xctest, xcuitest
- Language: Swift
- Homepage:
- Size: 349 KB
- Stars: 31
- Watchers: 9
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# AutoMate AppBuddy
`AppBuddy` is a helper framework for UI automation tests, designed to work with the [`AutoMate`](https://github.com/PGSSoft/AutoMate). It can disable animations in the application and manage events, reminders and contacts.
[](https://swift.org)
[](https://travis-ci.org/PGSSoft/AutoMate-AppBuddy)
[](https://cocoapods.org/pods/AutoMate-AppBuddy)
[](https://pgssoft.github.io/AutoMate-AppBuddy/)
[](https://github.com/Carthage/Carthage)
[](https://cocoapods.org/pods/AutoMate-AppBuddy)
[](https://github.com/PGSSoft/AutoMate-AppBuddy/blob/master/LICENSE)
## Installation
### CocoaPods
The most convenient way to install it is by using [CocoaPods](https://cocoapods.org) with Podfile:
```ruby
pod 'AutoMate-AppBuddy'
```
### Carthage
For Carthage [Carthage](https://github.com/Carthage/Carthage) add a line to `Cartfile.private`:
```
github "PGSSoft/AutoMate-AppBuddy"
```
`Cartfile.private` should be used because AutoMate framework will be used by UI Tests target only not by the tested application.
### Swift Package Manager
You can just add AutoMate AppBuddy package to your project by entering it's repository URL
```
https://github.com/PGSSoft/AutoMate-AppBuddy
```
### Note
`AppBuddy` should be linked with target application, not with the test target.
## Usage
Full documentation is available at [https://pgssoft.github.io/AutoMate-AppBuddy/](https://pgssoft.github.io/AutoMate-AppBuddy/).
1. Duplicate existing application target.
2. Import `AutoMate_AppBuddy` framework to app delegate.
```swift
import AutoMate_AppBuddy
```
3. Setup `LaunchEnvironmentManager` in `application(_:didFinishLaunchingWithOptions:)`.
```swift
let launchEnvironmentManager = LaunchEnvironmentManager()
launchEnvironmentManager.add(handler: defaultEventKitHander, for: .events)
launchEnvironmentManager.add(handler: defaultEventKitHander, for: .reminders)
launchEnvironmentManager.add(handler: defaultContactsHander, for: .contacts)
launchEnvironmentManager.add(handler: defaultIsInUITestHandler, for: .isInUITest)
launchEnvironmentManager.add(handler: AnimationHandler(), for: .animation)
launchEnvironmentManager.setup()
```
## Features (or ToDo)
- [x] Disable UIView animations
- [x] Managing events, reminders and contacts
- [ ] Two way communication
- [ ] Stubbing network requests
- [ ] Stubbing contacts, events and reminders
- [ ] Stubbing notifications
- [ ] Taking screenshots
- [ ] Clearing application data
- [ ] Simulating push notifications
## Example application
[`AutoMate`](https://github.com/PGSSoft/AutoMate) 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-AppBuddy/](https://pgssoft.github.io/AutoMate-AppBuddy/).
If you want to handle your custom launch environments, you have to implement `Handler` protocol, e.g.
```swift
struct CustomHandler: Handler {
func handle(key: String, value: String) {
if value == "production" {
}
}
}
launchEnvironmentManager.add(handler: CustomHandler(), for: "SERVER")
```
## Contributing
Bug reports and pull requests are welcome on GitHub at [https://github.com/PGSSoft/AutoMate-AppBuddy](https://github.com/PGSSoft/AutoMate-AppBuddy).
## 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-AppBuddy)
[](https://twitter.com/pgssoftware)
