Elmyr
Elmyr is a Kotlin library providing tools to generate “random” values, specifically useful for tests
Being an adept of testing code, I write a lot of tests. One thing I noticed is that in my tests, my fake / test data always look the same. My user names are always “Bob” and “Alice”, aged 42 or 69, with userId 4816152342 or 24601, and eating “spam”, “eggs” and “bacon”.
The problem is, the more test I write, the less I'm confident in my fake values, because they're always the same.
This is where Elmyr kicks in, allowing you to create fake/fuzzy data based on a few constraints, making your test data random, and yet reproducible.
Usage
Gradle
repositories {
maven { url "https://jitpack.io" }
}
dependencies {
testCompile("com.github.xgouchet.Elmyr:core:x.x.x")
testCompile("com.github.xgouchet.Elmyr:junit4:x.x.x")
testCompile("com.github.xgouchet.Elmyr:junit5:x.x.x")
testCompile("com.github.xgouchet.Elmyr:jvm:x.x.x")
}
Forging data: the core module
You can create an instance of the Forge class, and from that generate:
- primitives, with basic constraints
- Strings matching simple predicates or even Regexes
- Your own custom data, by implementing the
ForgeryFactoryinterface, then calling theForge::addFactorymethod.
ForgeRule for junit4
You can instantiate a ForgeRule instance, which extends the Forge class, add factories to it, and then annotate fields on your test class with @Forgery.
class FooTest {
@get:Rule
val forge = ForgeRule()
.withFactory(FooFactory())
.withFactory(BarFactory())
@Forgery
internal lateinit var fakeBar: Bar
@Forgery
lateinit var fakeFooList: List<Foo>
//…
}
ForgeExtension for junit5
You can add an extension and configure it. In addition to creating forgeries on fields/properties of your test class, you can inject parameters directly on your test methods.
@ExtendWith(ForgeExtension::class)
@ForgeConfiguration(KotlinAnnotationTest.Configurator::class)
internal class FooTest {
@Forgery
internal lateinit var fakeBar: Bar
@Forgery
lateinit var fakeFooList: List<Foo>
@Test
fun testSomething(@IntForgery i: Int, forge:Forge){
// …
}
}
spek forgeries
You can create a custom Forge instance with spekForge to be able to add reproducibility to Spek tests.
class CalculatorSpek : Spek({
val forge = spekForge(
seeds = mapOf(
"CalculatorSpek/A calculator/addition/returns the sum of its arguments" to 0x1337L
)
)
describe("A calculator") {
val calculator by memoized { Calculator() }
describe("addition") {
it("returns the sum of its arguments") {
val a = forge.anInt()
val b = forge.anInt()
assertEquals(calculator.add(a, b), a + b)
}
}
}
})
Documentation
The full documentation will be coming shortly
Contributing
Contribution is fully welcome. Before submitting a Pull Request, please verify you comply with the following checklist :
- All public classes, methods and fields must be documented
- All code must be unit tested (duh…)
- All code should be usable with and without the Android SDK, from Java and Kotlin
Release History
Latest Release: 1.3.1 (2021/09/07)
core
- Fix some invalid regex forgeries (e.g.:
"[^a-z]+"was not handled properly)
junit5
- Fix an error when a
ForgeConfigurationwas missing aForgeConfigurator
Donate
This library is completely free to use and modify (as per the License). I try my best to make it as good as possible, but only do this on my free time. If you want to support my work, you can click the Donate button below.
Meta
Xavier F. Gouchet – @xgouchet
Distributed under the MIT license. See LICENSE.md for more information.
361 Dec 31, 2022
15 Dec 23, 2022
8 Mar 23, 2022
52 Aug 15, 2022
220 Nov 29, 2022
2 Oct 28, 2021
1 Oct 20, 2021
4 Nov 10, 2021
2 Feb 2, 2022
1 Jan 26, 2022
1 Apr 12, 2022
1 Jun 28, 2022
395 Dec 8, 2022
5 Dec 15, 2022
8.4k Jan 9, 2023
3.9k Jan 5, 2023
7 Jun 8, 2022