xgouchet / elmyr

A utility to make Kotlin/Java tests random yet reproducible

Greetings stranger 👋

About… me

Hello, My name's Xavier F. Gouchet, I'm a french multipotentialite, Open Source enthusiast, Android software engineer and team leader, professional speaker and erstwhile teacher.

• 🔭 I’m currently working on too many projects at the same time. Sci-fi books, music, Kotlin projects…
• 🌱 I’m currently learning Roku development, and Android Jetpack Compose
• 👯 I’m looking to collaborate on music, writing, code, …
• 💬 Ask me about anything, among others Android, testing, Kotlin, Roku, creative writing, music, …
• 🏳️‍🌈 Be kind to everyone

Reach out to me

Github Stats

elmyr's Issues

Add exhaustive URL generation

Following the RFC, create URL with any weird potential formats

• RFC 3986

Make source code available as a JAR

Have you thought about making the project available as a JAR, to make the source code visible in an IDE, after downloading the package?

Adding this to the build.gradle does the trick:

task packageSources(type: Jar, dependsOn: 'classes') {
    from sourceSets.main.allSource
    classifier = 'sources'
}

artifacts { archives packageSources }

Convenience method for generating an alphanumerical String

As an improvement, I think that the Forger should contain a method for generating an alphanumerical String, similar to the other aSomethingString ones.

[JUnit5] Inject list of forgeries

In a Junit5 test, it would be nice to be able to write (assuming a Forgery of Foo is available) :

``
`
class A {
@forgery lateinit var fakeList : List

@Test
fun test(@Forgery list : List<Foo>) {
    // …
}

}
`
``

Add a size attribute for @StringForgery

When forging an @StringForgery field or parameter, there's no way to specify the desired output String size.

[JUnit5] Include ForgeConfiguration from parent class

@ ExtendWith(ForgeExtension::class)
@ForgeConfiguration(Configurator::class)
abstract class A {
}

class B : A() {
}

When running tests from B, the configurator is not found. It would be neat if Elmyr could find it automatically!

Sources still not visible

Even though I'm using the latest version of your library (0.8) the source code is still not visible for me, when viewing from an IDE.

Create Factory templates for Idea / IntelliJ

Create list with provider

fun <T> createFakeList(forger: Forger, creator: (Forger) -> T): List<T> {
    val count = forger.aTinyInt()
    val list = ArrayList<T>(count)

    for (i in 0 until count) {
        list.add(creator(forger))
    }

    return list
}

Add Memoization to the RegexParser class

Right now, the RegexParser class will always parse the provided Regex. Adding a map/LRU/LFU of previously known regexes could improve the tests (especially since the same regex might be reused many times).

Migrate to Circle CI

Travis CI stopped providing free plans for Open Source project.

Ensure the lib is compatible with Kotlin MP

Add support for octal, hexadecimal and unicode escape in Regex forgery

Right now we don't support escaping octal characters (\0…), hexadecimal characters (\x…) and unicode characters (\u…).

Create a JUnit 5 extension

[Kotlin] Create delegate for Lists/Collections

If a forge is properly configurated to generate instances of Foo, we should have delegates to rite :

 internal val forgedFooList: List<Foo> by factoryListForgery()

Generate a sublist from a bigger list

Something like "pick n element from this m sized collection/array and return a collection/array containing them"

Can not set a seed with the default ForgeConfigurator

Hi,

I was just testing your lovely library after watching this video on youtube, and just got an error : I can not replay a test with a seed and the default ForgeConfigurator. It also happen with just @ForgeConfiguration (no seed and no Configurator provided)

class fr.xgouchet.elmyr.junit5.ForgeExtension cannot access a member of class fr.xgouchet.elmyr.ForgeConfigurator$NoOp with modifiers "private"
java.lang.IllegalAccessException: class fr.xgouchet.elmyr.junit5.ForgeExtension cannot access a member of class fr.xgouchet.elmyr.ForgeConfigurator$NoOp with modifiers "private"
	at java.base/jdk.internal.reflect.Reflection.newIllegalAccessException(Reflection.java:361)
	at java.base/jdk.internal.reflect.Reflection.ensureMemberAccess(Reflection.java:99)
	at java.base/java.lang.Class.newInstance(Class.java:579)
	at fr.xgouchet.elmyr.junit5.ForgeExtension.getConfigurators(ForgeExtension.kt:193)
	at fr.xgouchet.elmyr.junit5.ForgeExtension.beforeAll(ForgeExtension.kt:66)
	at org.junit.jupiter.engine.descriptor.ClassBasedTestDescriptor.lambda$invokeBeforeAllCallbacks$7(ClassBasedTestDescriptor.java:359)
	at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
	at 
[...]

Here is my very basic test class:

import fr.xgouchet.elmyr.annotation.IntForgery
import fr.xgouchet.elmyr.junit5.ForgeConfiguration
import fr.xgouchet.elmyr.junit5.ForgeExtension
import io.kotest.matchers.shouldBe
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith

@ExtendWith(ForgeExtension::class)
@ForgeConfiguration(seed = 0x2af7b7def4L)
class FooTest {
    @Test
    fun testSomething(@IntForgery i: Int) {
        i % 2 shouldBe 0
    }
}

version: 1.2.0
kotlin: 1.4.20
junit: 5.6.0

Generate a Path string

Also add the option to make it Linux / Mac / Windows / android style

Seems like the hosting server of Elmyr library has been shutdown

Seems like this library was using https://status.bintray.com/ which has been shutdown/ Is there any way to host the library in a different place?

In order to reproduce this issue you can check this link:
https://google.bintray.com/flexbox-layout/com/github/xgouchet/Elmyr/1.3.0/Elmyr-1.3.0.pom
It is returning a 502 error

Add reproducibility test

Given a seed, make sure that the test is reproducible.

Create generators for KotlinTest

cf : https://github.com/kotlintest/kotlintest/blob/master/doc/reference.md#property-based
KotlinTest has a PropertyBased testing feature, that can use generators following the given interface :

interface Gen<T> {
  fun constants(): Iterable<T>
  fun random(): Sequence<T>
}

Migrate to new Gradle dependencies versionning

Replace the Dependencies class in buildSrc and replace it with Gradle's version catalog

Implement `java.time.*` forgeries

java.time.Duration
java.time.LocalDate
java.time.LocalDateTime
java.time.LocalTime
java.time.Period

Create standard JVM classes factories

Date, File, …

Crash with Repeater Rule if one test method is not annotated

java.lang.NullPointerException
	at fr.xgouchet.elmyr.junit.Repeater$apply$1.evaluate(Repeater.kt:25)
	at org.junit.rules.RunRules.evaluate(RunRules.java:20)
	at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:325)
	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:78)
	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:57)
	at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290)
	at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71)
	at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288)
	at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58)
	at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268)
	at org.junit.runners.ParentRunner.run(ParentRunner.java:363)

Add doc sample to create custom forgeries

eg :

fun Forger.aUser() : User {
  return User(
      id = anHexadecimalString(),
      name = aSentence()
  )
}

NoSuchFieldError: CAPITALIZED_SENTENCE

After updating Gradle to the 6.7.1 version the library cannot find CAPITALIZED_SENTENCE and it crashes when executes a test.

Issue with Java 11

Since upgrading to 1.3.2, I have the following compile issue when testing : Cannot inline bytecode built with JVM target 11 into bytecode that is being built with JVM target 1.8. Please specify proper '-jvm-target' option

Could the libs be built with Java 8 ?

Allow ignore test when precondition fails

eg : when creating anInt with min and max, if min>= max throw an assumption error instead of IllegalArgument

Alphanumerical characters contain "_"

ALPHA_NUM_UPPER and ALPHA_NUM_LOWER should not contain the _ character.
I see that they are used when generating a character with anAlphaNumericalChar method.

Also, is there an easier way to generate an alphanumerical String of fixed case and length?

Add support for Kotest

Add shuffle list

Allow shuffling a given array / collection

Add customizable options for Urls

Let users customize URLs with custom scheme, hostname, tld etc...

eg :

forger.aUrl(scheme = "https", tld="com", queryParams=false)

Generate url that matches Patterns.WEB_URL

Hi!
Is it possible to generate url which matches Patterns.WEB_URL from Android?

 /**
     *  Regular expression pattern to match most part of RFC 3987
     *  Internationalized URLs, aka IRIs.
     */
    public static final Pattern WEB_URL = Pattern.compile("("
            + "("
            + "(?:" + PROTOCOL + "(?:" + USER_INFO + ")?" + ")?"
            + "(?:" + DOMAIN_NAME_STR + ")"
            + "(?:" + PORT_NUMBER + ")?"
            + ")"
            + "(" + PATH_AND_QUERY + ")?"
            + WORD_BOUNDARY
            + ")");

Forger.aUrl(scheme = "http") does not follow that standard.

Combine the StringForgery and RegexForgery annotations

Library is not compatible with Android SDK version lower than 24

I'm running into problems using your library for instrumented Android tests on devices running Android SDK version 21 and 23, when calling the Forger.aSentence() function.

The problem is caused by the Integer.min() function, which has only been added in Android version 24. So devices running older versions of Android are lacking the implementation.

I would suggest using the kotlin.math.min() function instead, which also uses Java's Math.min() under the hood.

Apart from that I enjoy using your library. Keep up the good work!

The error I got:
java.lang.NoSuchMethodError: No static method min(II)I in class Ljava/lang/Integer; or its super classes (declaration of 'java.lang.Integer' appears in /system/framework/core-libart.jar) at fr.xgouchet.elmyr.Forger.aSentence(Forger.kt:755) at fr.xgouchet.elmyr.Forger.aSentence$default(Forger.kt:735) ...

Create an artifact with additional methods for forging Strings

Right now you can only generate Strings by character class or by regex.
It'd be nice to have some extension methods to generate

• email
• url
• java identifier
• file path
• …

Add support for Character Class Intersection in Regex forgery

Right now we do not support Character Class Intersection:

• /[a-m&&[g-x]]/ should have the same results as /[g-m]/
• /[a-m&&g-x]/ should have the same results as /[g-m]/
• /[a-m&&[^c-g]]/ should have the same results as /[a-bh-m]/
• /[a-z&&[aeiou&&[^c-g]]]/ should have the same results as /[aiou]/

Add exhaustive email generation

Following the RFCs, make sure that any possible email could be created

• RFC 822 (email adress) and explanation