Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joshludahl/espresso-library-kotlin
https://github.com/joshludahl/espresso-library-kotlin
Last synced: 12 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/joshludahl/espresso-library-kotlin
- Owner: JoshLudahl
- Created: 2021-11-14T05:44:12.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-30T00:37:05.000Z (about 1 year ago)
- Last Synced: 2023-09-30T03:50:47.558Z (about 1 year ago)
- Language: Kotlin
- Size: 142 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://jitpack.io/#JoshLudahl/espresso-library-kotlin) [](https://github.com/JoshLudahl/espresso-library-kotlin/actions/workflows/android.yml)
# ELK
## Espresso Extension library written in Kotlin
A simple extension library for Espresso with support for the page object design, or in this case, the Robot Pattern. This library is growing and more features to come. There are a few ways to perform different actions and assertions as well as matching objects.
# Note
This library will not be maintained going forward. With Jetpack Compose, please see [CAT](https://github.com/JoshLudahl/CAT), Compose for Android Testing. Look, I just wanted to use CAT, it's okay.
### Get started
To include the library, add the following to your app module build.gradle file:
```groovy
dependencies {
androidTestImplementation "com.github.JoshLudahl:espresso-library-kotlin:$elk_version"
}
```
And be sure to include jitpack in the repositories:
```groovy
repositories {
maven { url 'https://jitpack.io' }
}
```
### Simple infix notation to simplify code expression
Clicking on an object is easy:
```kotlin
click on view(R.id.id_resource)
```
Type text into a TextView:
```kotlin
type text("text") into(R.id.textview_item)
```
Basic assertions are human readable:
```kotlin
view(R.id.id_resource) confirm isDisplayed
```
Simple extension to check if something isn't in a state:
```kotlin
view(R.id.id_resource) confirm isDisplayed.not()
```
A simple replacement for onView(allOf(...)):
```kotlin
view(
view("Text to check"),
view(R.id.id_resource_to_check),
view(R.string.string_resource_to_check)
)
```
`view` is a powerhouse replacement for `onView(withId(R.id.some_id))`, `onView(withText(R.string.some_text))`, `onView(withId("a string literal"))`
or even `onView(allOf(...))`:
```kotlin
view("Text to check") //String Literal matcher
view(R.id.id_resource_to_check) //Id resource matcher
view(R.string.string_resource_to_check) //String resource matcher
view(TextView::class.java) //Class matcher
view(
view("Text to check"),
view(R.id.id_resource_to_check),
view(R.string.string_resource_to_check)
) // simplification matcher for onView(allOf(...))
```
### Multiple ways to check views
A simple, bulk check:
```kotlin
viewsAreDisplayed(
view("Text to check"),
view(R.id.id_resource_to_check),
view(R.string.string_resource_to_check)
)
```
### Extensions utilize both ViewInteractions, Matchers, and some sugar syntax utilizing Kotlins infix notation
For example ViewMatchers.isDisplayed() can be used as part of a ViewInteraction, Matcher, or as part of an assertion:
```kotlin
view(id) check isDisplayed
onView(withId(id)).isDisplayed()
withId(id).isDisplayed()
R.id.id_resource.isDisplayed()
```
This allows for flexibility, so you can customize how your testing library looks and feels.
### Custom View Matchers will help find elements easier
A regular expression helper function:
```kotlin
fun checker() {
view(R.id.resource_id).withPattern("\\+d")
}
```
Check the theme mode for dark or light mode:
```kotlin
fun checker() {
view(isRoot()).withMode(Configuration.UI_MODE_NIGHT_YES)
}
```
Which checks the provided mode against the system mode and will return true if they match.
### Annotations out of the box for Gherkin support and code separation
Gherkin useage:
```kotlin
fun simpleCheck() {
@Given("I am on the home page")
@And("I am not logged in")
@When("I click on the login link")
@Then("I am taken to the login page")
}
```
Separate Production, Development, and Local tests:
```kotlin
@Development
@Test
fun checkSomething() {
...
}
@Production
@Test
fun checkSomething() {
...
}
@Local
@Test
fun checkSomething() {
...
}
```
Then just use a runner or command argument to exclude the desired tests:
```groovy
testInstrumentationRunnerArgument "notAnnotation", "com.android.elk.common.Production"
```
A generic TestId annotation which takes in a vararg integer:
```kotlin
@Test
@TestId(12345) // could take in zero or many integers
fun checkSomething() {
...
}
```
### RecyclerView
Various RecyclerView extensions, still working to make them simpler to use.
### Checking Toasts is easy
Simply call the toastMatcher function with the expected string or string resource:
```kotlin
toastMatcher("My Message")
toastMatcher(R.string.toast_message)
```
### Changing orientation is easy
Call the Espresso orientation changer:
```kotlin
rotateOrientationToLandscape()
rotateOrientationToPortrait()
toggleOrientation()
```
### Includes an Espresso setup rule
Included in the setup is the Intents, Idling Resources, and DataBindingIdlingResource registering and unregistering.
Includes the suggested IdlingResource class from Android, which you can copy to your production code if you want to use it.
To use, set the rule up and send your activity rule as a parameter:
```kotlin
@get:Rule
val espressoSetupRule = EspressoSetupRule(activityRule)
```
If used, it will register/unregister:
* IdlingResources
* DataBindingIdlingResources
* Intents
### Test Configuration and Utilities
Simple utility functions for accessing configurations such as string resources:
```kotlin
context stringOf id.string.some_string
```
Assets:
```kotlin
assets
```
Instrumentation:
```kotlin
instrumentation
```
Simple, but useful way to easily get access to the applications configuration.
### Support for the Robot Pattern
You can use the Robot Pattern in your tests. A generic Robot class has been provided, so you can use syntax like:
```kotlin
screen {
screenObjectClassFunctions()
}
verify {
screenObjectClassFunctions()
}
```
It does require Kotlin's reflection library:
```groovy
dependencies {
implementation "org.jetbrains.kotlin:kotlin-reflect:$version"
}
```
### Disclaimer
This project is under development and is not suggested for production development at this time. Mostly used as a means to learn Kotlin. :)
### License
MIT License
Copyright (c) 2020 Josh Ludahl
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.