Skylark provides automated acceptance testing for iOS apps by translating feature files written in Gherkin into Xcode UI tests driven by the XCTest framework.
To learn more about how to use Skylark, take a look at the table of contents below:
Skylark.framework
to your UI testing target in Xcode.Gherkin syntax is the language used by Cucumber to define test cases to be executed. The language is designed to be easily readable to humans whilst promoting a BDD approach to testing. Test cases are defined in terms of features and scenarios with a number of scenarios comprising each feature.
Skylark is a powerful UI testing framework offering many configuration options however to get up and running with minimum effort, add a Skylark.json
configuration file to your UI testing target copying the format of the Skylark.json provided in the example app. This file defines:
It is currently possible to configure Skylark in one of two ways:
The framework looks for an all-in-one configuration file containing the context definitions, application map and step definitions for your application named Skylark.json
in your test bundle. You should also define an initial context if using an all-in-one configuration file. The high-level structure of this file should follow the format below:
{
"skylark": {
"application": {
"initial-context": "home",
"map": {
},
"contexts": {
},
"steps": {
}
}
}
}
If you want to get started quickly, it's worth taking a look at the example Skylark.json provided with the example application.
Using a single configuration file is only recommended for very small apps since for apps of nontrivial size it's likely you will find that your Skylark.json
file grows to be quite large very quickly.
If you omit the initial-context
key from this file then there are two other ways of setting the initial context - see Initial Context.
This is the recommended way to configure Skylark for larger apps involving defining three separate config files:
{
"contexts": {
"home": {
"name": "Home",
"elements": [{
"name": "find product",
"id": "home-header-view-search-button",
"type": "buttons"
}],
...
},
...
}
{
"map": {
"home": [{
"destination": "trolley",
"actions": [
{
"action": "tap",
"element": "tab-bar-trolley"
}
]
},
...
{
"steps": {
"buttons": {
"existence": [
"$PARAMETER is displayed",
"$PARAMETER is shown",
"the $PARAMETER button is displayed",
"the $PARAMETER button is shown",
"the $PARAMETER is displayed",
"the $PARAMETER is shown",
"a $PARAMETER button is displayed",
"a $PARAMETER button is shown"
],
"interaction": {
"tap": [
"i tap $PARAMETER",
"i tap the $PARAMETER",
"i tap the $PARAMETER icon",
"i tap the $PARAMETER button",
"i tap the $PARAMETER link",
"tap the $PARAMETER button",
"then tap the $PARAMETER button",
"the $PARAMETER button is tapped",
"the $PARAMETER is tapped",
"$PARAMETER is tapped"
],
...
}
},
There are currently three way of setting the initial context for your app:
initial-context
key as part of your application definition e.g."application": {
"initial-context": "home",
...
home
as part of your context definitions then this the screen Skylark will think is being shown to the user when the app is initially launched. TODO: What happens if the initial context id doesn't match any context definition?If an error message is emitted indicating that an initial context must be specified this indicates that Skylark doesn't know which context to expect the app to be in when the tests start running. There are three means of specifying an initial context currently:
βlazy var testRunner = Skylark.testRunner(testCase: self, context: "Home")
setInitialContext
e.g. testRunner.setInitialContext("Home")
Skylark.json
configuration file by providing the context identifier as the value to the initial-context
key e.g.{
"skylark": {
"application": {
"initial-context": "Home",
...
To get started import the Skylark and XCTest frameworks into your UI testing target, create an XCTestCase subclass as usual and instantiate an instance of the test runner. Ensure that your feature file has been added to your UI test bundle with the file extension .feature
then invoke test(featureFile:)
to run your scenarios.
import Foundation
import Skylark
import XCTest
class MyUITests: XCTestCase {
// Obtain test runner instance
lazy var testRunner = Skylark.testRunner(testCase: self)
// Run scenarios from feature file
func testFromFeatureFile() {
testRunner.test(featureFile: "Main")
}
}
Skylark endeavors to limit the amount of additional Swift code you need to write on top of your feature files to get your tests to run. To this end, most existence checks (checking whether an element is displayed onscreen) and interaction checks e.g. tapping buttons will work out of the box. To take advantage of this functionality, simply create a JSON file with the file extension .screen
describing the elements on a screen e.g.
{
"name": "Main",
"buttons": {
"Test": "test-button"
}
}
In the above the keys are the names of the elements as you would refer to them in your feature files and the values are the accessibility identifiers assigned to your UIKit elements (label text may be used where no accessibility identifier has been assigned).
For steps that require a little more work to set up the test runner provides a number of methods for registering steps to be executed. Using these you can provide the Swift code to be executed when a given step is encountered.
CocoaPods is a dependency manager which integrates dependencies into your Xcode workspace. To install it using RubyGems run:
gem install cocoapods
To install Skylark using Cocoapods, simply add the following line to your Podfile:
pod "Skylark"
Then run the command:
pod install
For more information see here.
Carthage is a dependency manager which produces a binary for manual integration into your project. It can be installed via Homebrew using the commands:
brew update
brew install carthage
In order to integrate Skylark into your project via Carthage, add the following line to your project's Cartfile:
github "rwbutler/Skylark"
From the macOS Terminal run carthage update --platform iOS
to build the framework then drag Skylark.framework
into your Xcode project.
For more information see here.
Skylark is available under the MIT license. See the LICENSE file for more info.
AnimatedGradientView |
---|
Cheats | Connectivity | FeatureFlags | Skylark | TypographyKit | Updates |
---|---|---|---|---|---|
cdd
from the Terminal.Config Validator | IPA Uploader | Palette |
---|---|---|
link |
Stars: 15 |
Last commit: 4 years ago |
Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics