Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orchetect/xctestutils
Useful XCTest extensions for Swift
https://github.com/orchetect/xctestutils
ios ios-swift macos macosx swift swiftui test testing tvos watchos xcode xctest xctestcase
Last synced: 2 days ago
JSON representation
Useful XCTest extensions for Swift
- Host: GitHub
- URL: https://github.com/orchetect/xctestutils
- Owner: orchetect
- License: mit
- Created: 2022-02-16T22:05:12.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-27T21:44:59.000Z (over 1 year ago)
- Last Synced: 2024-05-01T16:07:49.935Z (10 months ago)
- Topics: ios, ios-swift, macos, macosx, swift, swiftui, test, testing, tvos, watchos, xcode, xctest, xctestcase
- Language: Swift
- Homepage:
- Size: 41 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# XCTestUtils
[](https://swiftpackageindex.com/orchetect/XCTestUtils) [](https://swiftpackageindex.com/orchetect/XCTestUtils) [](https://developer.apple.com/swift) [](https://github.com/orchetect/XCTestUtils/blob/main/LICENSE)
Useful XCTest utilities and extensions for test targets.
## Overview
Currently, the library provides a small but useful set of XCTest related methods.
## Wait for Expression
Two wait methods are implemented which may be useful in asynchronous testing scenarios where using XCTest expectations is not possible.
These methods allow for the continuous evaluation of an autoclosure expression with a timeout period in seconds. If the wait times out, it triggers a test fail. The evaluation is done every 10 milliseconds by default, but the interfal can be overridden with a custom polling period.
```swift
// wait for expression:
// useful for non-equatability tests or tests where the test value
// is not required to be logged in failure log messages
// (akin to XCTAssertTrue)
wait(for: x > 10, timeout: 1.5)
wait(for: x > 10, timeout: 1.5, "Description of waiter")
// closures can also be used for more complex expressions
wait(for: {
let x = a + b
let y = check ? 5 : 10
return x == y
}, timeout: 1.5)
```
```swift
// wait for equality:
// useful where the test value is required to be logged in failure log messages
// (akin to XCTAssertEqual)
wait(for: x, equals: 10, timeout: 1.5)
wait(for: x, equals: 10, timeout: 1.5, "Description of waiter")
// closures can also be used for more complex expressions
wait(for: {
let x = a + b
return x > 10
}, equals: {
#if os(macOS)
10
#else
15
#endif
}, timeout: 1.5)
```
### General Wait
A generic non-blocking wait method is also provided:
```swift
wait(sec: 1.5) // seconds
```
### UI Testing
A small assortment of throwing wrappers for `XCUIElement` methods are implemented.
`waitForExistence(timeout:) -> Bool` wrapped in a throwing method:
```swift
let okButton = try await app
.buttons["OK"]
.waitForExistence(throwingTimeout: 2.0)
await okButton.click()
```
`waitForNonExistence(timeout:) -> Bool` wrapped in a throwing method:
```swift
let okButton = await app.buttons["OK"].firstMatch
try await okButton.waitForNonExistence(throwingTimeout: 2.0)
```
`wait(for:toEqual:timeout:) -> Bool` wrapped in a throwing method:
```swift
let okButton = await app.staticTexts["Idle"].firstMatch
try await okButton.wait(for: \.label, toEqual: "Active", throwingTimeout: 2.0)
```
## Installation: Swift Package Manager (SPM)
### Dependency within an Application
1. Add the package to your Xcode project's test target(s) using `https://github.com/orchetect/XCTestUtils` as the URL.
2. Import the module in your test files where needed.
```swift
import XCTest
import XCTestUtils
```
### Dependency within a Swift Package
1. Add the dependency in your `Package.swift` file:
```swift
dependencies: [
.package(url: "https://github.com/orchetect/XCTestUtils", from: "1.1.2")
],
```
## Usage
Import the module in test files where needed.
```swift
import XCTest
import XCTestUtils
```
## Documentation
This README serves as basic documentation.
All methods have inline help explaining their purpose and basic usage examples.
## Requirements
Minimum system requirements for testing: Xcode 13 or higher on macOS 11.3 or higher
## Author
Coded by a bunch of 🐹 hamsters in a trenchcoat that calls itself [@orchetect](https://github.com/orchetect).
## License
Licensed under the MIT license. See [LICENSE](https://github.com/orchetect/XCTestUtils/blob/master/LICENSE) for details.
## Contributions
Bug fixes and improvements are welcome. Please open an issue to discuss prior to submitting PRs.