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 it can also disable animations in the application and manage events, reminders and contacts.
Installation
There are three convinient ways to install AutoMate:
-
using CocoaPods with Podfile:
pod 'AutoMate'
-
using Carthage and add a line to
Cartfile.private:github "PGSSoft/AutoMate"Cartfile.privateshould 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 or in
Package.swift:.package(url: "https://github.com/PGSSoft/AutoMate", from: "1.8.0"),
Usage
Full documentation is available at https://pgssoft.github.io/AutoMate/.
-
Create a new UI test case class.
-
Import
AutoMateframework to UI tests files:import AutoMate
-
Use
TestLauncherin thesetup()method to configure application settings and launch the application:let app = XCUIApplication() TestLauncher(options: [ SystemLanguages([.English, .German]), SystemLocale(language: .English, country: .Canada), SoftwareKeyboards([.EnglishCanada, .GermanGermany]) ]).configure(app).launch()
-
Use AutoMate's extensions in your tests. For example:
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)
- Set keyboards
- Set locale
- Set languages
- Custom arguments
- Custom keyboards, locales and languages
-
XCTestextensions - Added CoreData launch arguments
- Disable UIView animations (with
AutoMate-AppBuddy) - Strong-typed helpers: locators, page object templates (with
AutoMate-Templates) - Base XCTestCase template (with
AutoMate-Templates) - Most permissions alerts (like:
LocationWhenInUseAlert,CalendarAlert,PhotosAlert) (withAutoMate-ModelGenie) - Managing events, reminders and contacts (with
AutoMate-AppBuddy) - Companion library for the application (
AutoMate-AppBuddy) - Improve launch options type safety
- Smart coordinates
- 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/.
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:
enum CustomParameter: String, LaunchArgumentWithSingleValue, LaunchArgumentValue {
var key: String {
return "AppParameter"
}
case value1
case value2
}
Then, you can pass it to the TestBuilder:
let launcher = TestLauncher(options: [
CustomParameter.value1
])
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/PGSSoft/AutoMate.
License
The project is available as open source under the terms of the MIT License.
About
The project maintained by software development agency PGS Software. See our other open-source projects or contact us to develop your product.
Follow us
2 Sep 25, 2022
11 Dec 17, 2022
5.5k Dec 30, 2022
6 Oct 23, 2022
1k Jan 4, 2023
57 Jan 1, 2023
0 Jan 3, 2022
3 Nov 7, 2022
118 Oct 17, 2022
22 Dec 1, 2022
8 Oct 11, 2021
8 Sep 24, 2022
544 Dec 30, 2022
0 Oct 22, 2021
22 Jan 3, 2023
317 Nov 22, 2022
565 Nov 16, 2022
3.1k Jan 3, 2023