Enables descriptive and readable test writing with `describe` and `itShould` blocks, utilizing `ParameterizedRobolectricTestRunner` and supporting behavior-driven development for structured and clear test cases.
RoboSpec is a library that provides a way to write tests using describe and itShould blocks with Robolectric.
I've been using Robolectric with Roborazzi for testing.
My test names were always something like launch_article_list_shot(). These names make it hard to understand what each test does.
Also, when using this for screenshot testing, it's not clear what each screenshot shows or if it's correct.
Kotest provides a more readable way to write tests. It allows us to write tests using describe and it, similar to RSpec.
However, Robolectric doesn't currently support JUnit5 (although this may change in the future). Consequently, we can't use Kotest with Robolectric.
I discovered that we can use Robolectric's ParameterizedRobolectricTestRunner to structure our tests more descriptively.
RoboSpec is a library that provides a way to write tests using describe and itShould blocks with Robolectric.
You can call describeBehaviors to create a list of DescribedBehavior objects and run each test with the execute() method.
This test creates three test cases as parameterized tests:
ArticleListScreenTest.test[when server is operational - it should show article items]ArticleListScreenTest.test[when server is operational - click first article bookmark - it should show bookmarked article]ArticleListScreenTest.test[when server is down - it should show error message]I believe this is more readable than test names like launch_article_list_shot().
This is a very simple and lightweight Kotlin library. In fact, it doesn't even depend on Robolectric. You can use it by adding the following dependency:
testImplementation("io.github.takahirom.robospec:robospec:[latest version]")
For version catalogs:
robospec = { module = "io.github.takahirom.robospec:robospec", version.ref = "robospec" }
DescribedBehaviors object.For example, you can create YAML files by using toYamlString().
val behaviors = describeBehaviors<Unit>("root") {
describe("describe1") {
doIt("describe1 doIt") { }
itShould("itShould1") { }
}
describe("describe2") {
doIt("describe2 doIt") { }
itShould("itShould2") { }
}
}
val yaml = behaviors.toYamlString()
println(yaml)
- root:
- describe1:
- doIt: describe1 doIt
- itShould: itShould1
- describe2:
- doIt: describe2
// You don't need to use @HiltAndroidTest if you don't use Hilt
class ArticleListScreenTest(
private val behavior: DescribedBehavior<ArticleListScreenRobot>
) {
// ArticleListScreenRobot is not a part of RoboSpec.
// I recommend that you provide a Robot or PageObject for easy testing
lateinit var articleListScreenRobot: ArticleListScreenRobot
fun test() {
runTest {
behavior.execute(articleListScreenRobot)
}
}
companion object {
.Parameters(name = "{0}")
fun behaviors(): List<DescribedBehavior<ArticleListScreenRobot>> {
// describeBehaviors is a function that creates a list of DescribedBehavior
return describeBehaviors<ArticleListScreenRobot>(name = "ArticleListScreen") {
describe("when server is operational") {
doIt {
// setupArticleListServer and setupArticleListScreenContent
// are functions of ArticleListScreenRobot
setupArticleListServer(ServerStatus.Operational)
setupArticleListScreenContent()
}
itShould("show article items") {
// captureScreenWithChecks and checkArticleListItemsDisplayed
// are functions of ArticleListScreenRobot
captureScreenWithChecks(checks = {
checkArticleListItemsDisplayed()
})
}
describe("click first article bookmark") {
doIt {
clickFirstArticleBookmark()
}
itShould("show bookmarked article") {
captureScreenWithChecks {
checkFirstArticleBookmarked()
}
}
}
}
describe("when server is down") {
doIt {
setupArticleListServer(ServerStatus.Error)
setupArticleListScreenContent()
}
itShould("show error message") {
captureScreenWithChecks {
checkErrorMessageDisplayed()
}
}
}
}
}
}
}
Surfaced from shared tags and platforms — no rankings paid for.