https://github.com/eonist/testrunner
Simplifies running UI-tests 🏃
https://github.com/eonist/testrunner
automation ios macos quality-assurance swift test-runner uitesting xcode xcuitest
Last synced: 7 months ago
JSON representation
Simplifies running UI-tests 🏃
- Host: GitHub
- URL: https://github.com/eonist/testrunner
- Owner: eonist
- License: mit
- Created: 2019-10-09T08:48:03.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-02T20:49:55.000Z (12 months ago)
- Last Synced: 2025-04-14T10:12:02.074Z (10 months ago)
- Topics: automation, ios, macos, quality-assurance, swift, test-runner, uitesting, xcode, xcuitest
- Language: Swift
- Homepage:
- Size: 1.8 MB
- Stars: 11
- Watchers: 0
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/apple/swift)
[](https://github.com/eonist/TestRunner/actions/workflows/Tests.yml)
[](https://codebeat.co/projects/github-com-eonist-testrunner-master)
# TestRunner 🏃
> Simplifies running UI-tests
## Description:
`TestRunner` is a Swift package that simplifies running UI tests for iOS and macOS. It allows you to create scenes—series of steps—that can be played and receive notifications upon their completion. You can iterate through scenes in sequences, reuse common scenes like `LoginScene` and `LogoutScene`, and operate asynchronously.
## How does it work
TestRunner allows you to:
- Create scenes that you can play and receive notifications upon their completion (asynchronously).
- Iterate through scenes in sequences.
- Reuse common scenes such as `LoginScene` and `LogoutScene`.
- Operate asynchronously.
## Key Concepts:
- **Step**: A single interaction logic, usually encapsulated in an anonymous closure.
- **Scene**: A series of steps.
- **Sequence**: A series of scenes.
## Demo:
Here is a QA Test prototype for debugging a playlist feature:
## Installation
You can install TestRunner using Swift Package Manager. Simply add the following line to your `Package.swift` file:
```swift
.package(url: "https://github.com/eonist/TestRunner.git", from: "1.0.0")
```
Then add `TestRunner` as a dependency for your target:
```swift
.target(
name: "MyTarget",
dependencies: [
"TestRunner",
]
),
```
Alternatively, you can add TestRunner to your project using Xcode. Simply go to `File > Swift Packages > Add Package Dependency` and enter the URL of this repository.
## Example:
```swift
class SearchScene: Scene {
override func run() {
let searchBar = XTElement.findFirst("SearchBar")
searchBar.search("Eminem")
let searchButton = XTElement.findFirst("SearchButton")
searchButton.tap()
onComplete() // Notify that the scene has completed
}
}
// Define the sequence of scenes
let sequence: [SceneKind.Type] = [LoginScene.self, SearchScene.self, LogoutScene.self]
// Initialize the SceneRunner with the sequence
let runner = SceneRunner(sequence: sequence) {
Swift.print("All scenes completed 🏁")
}
runner.app.launch() // Launch the application
runner.iterate() // Start running the scenes
```
**LoginScene example**
```swift
import TestRunner
class LoginScene: Scene {
override func run() async throws {
let app = sceneRunner.app
let usernameField = app.textFields["UsernameField"]
XCTAssertTrue(usernameField.exists, "Username field should exist")
usernameField.tap()
usernameField.typeText("testuser")
let passwordField = app.secureTextFields["PasswordField"]
XCTAssertTrue(passwordField.exists, "Password field should exist")
passwordField.tap()
passwordField.typeText("password")
let loginButton = app.buttons["LoginButton"]
XCTAssertTrue(loginButton.exists, "Login button should exist")
loginButton.tap()
// Wait for the next screen
let homeScreen = app.staticTexts["HomeScreen"]
let exists = await homeScreen.waitForExistence(timeout: 5)
if !exists {
throw NSError(domain: "LoginSceneError", code: -1, userInfo: [
NSLocalizedDescriptionKey: "Failed to navigate to home screen"
])
}
}
}
```
## Dependencies
- [UITestSugar](https://github.com/eonist/UITestSugar): A utility library that simplifies writing UI tests by providing syntactic sugar and helper functions.
> **Note**: Add `UITestSugar` to your `UITesting` target using Xcode's Swift Package Manager, not the main target.
## Resources:
- [Using XCTest and XCTestCase for iOS Tests](https://medium.com/tauk-blog/using-xctest-and-xctestcase-for-ios-tests-28828c829b3): A comprehensive guide on utilizing XCTest and XCTestCase for iOS testing.
- [Using XCTest Extension in a Swift Package](https://dr-rost.medium.com/using-xctest-extension-in-a-swift-package-c954b8ed4d62): An informative post detailing the integration of XCTest extension within a Swift package.
- [Xcode UI Testing Cheat Sheet](https://www.hackingwithswift.com/articles/148/xcode-ui-testing-cheat-sheet): A handy cheat sheet offering quick reference for Xcode UI testing.
### Todo:
- Add example project (See TabNav-project, playlist-project, UITesting-project, or make a new one) 👈👈👈
- Maybe add ideas from AccessRunner project, might have advanced ways of doing things etc 👈
- Maybe use semaphore to make async -> sync ? 👈
- Create a test project in SwiftUI
- Error Handling and Logging in Scene Execution
The Scene class's run method currently uses a placeholder implementation that simply throws a fatal error if not overridden. This could be improved by adding error handling capabilities, which would allow for better debugging and error logging.
- SwiftUI Migration: The AppDelegate in the TestRunnerApp uses UIKit and has a comment suggesting migration to SwiftUI. This could improve maintainability and modernize the codebase.
- Testing Enhancements: The SceneRunner class could include more robust testing features, such as support for launch options to customize the app's launch configuration. This would allow for more flexible and comprehensive testing scenarios.
- SwiftLint Integration: The GitHub Actions workflow mentions an issue with SwiftLint integration. Addressing this could help maintain code quality and consistency across the project.
- UI Testing Enhancements: The UI tests could be expanded to cover more scenarios and utilize the capabilities of UITestSugar more effectively. This would ensure that the UI components work as expected under various conditions.
- Upgrade to swift 6.0 (Might be a bit tricky with TestRunner)
- Introduce Async/Await Support
To better handle asynchronous operations, you can utilize Swift's native concurrency features.
```swift
public protocol SceneKind {
var sceneRunner: SceneRunnerKind { get }
func run() async throws
init(sceneRunner: SceneRunnerKind)
}
open class Scene: SceneKind {
public var sceneRunner: SceneRunnerKind
public required init(sceneRunner: SceneRunnerKind) {
self.sceneRunner = sceneRunner
}
open func run() async throws {
throw NSError(domain: "SceneErrorDomain", code: -1, userInfo: [
NSLocalizedDescriptionKey: "Must be implemented by subclass"
])
}
}
public func iterate() {
Task {
while hasNext() {
let sceneType = next()
let scene = sceneType.init(sceneRunner: self)
await run(scene: scene)
}
complete()
}
}
public func run(scene: SceneKind) async {
do {
try await scene.run()
} catch {
Logger.error("Failed to run scene: \(error.localizedDescription)")
// Handle error accordingly
}
}
public func iterate() {
Task {
while hasNext() {
let sceneType = next()
let scene = sceneType.init(sceneRunner: self)
await run(scene: scene)
}
complete()
}
}
public func run(scene: SceneKind) async {
do {
try await scene.run()
} catch {
Logger.error("Failed to run scene: \(error.localizedDescription)")
// Handle error accordingly
}
}
```