jacobhboy / fixture-monkey

Let Fixture Monkey generate test instances including edge cases automatically

Fixture Monkey

Designed by SeongIn Hong

"Write once, Test anywhere"

Fixture Monkey is designed to easily generate controllable arbitrary instances. It allows you to reuse the same configurations of the instances in several tests.

You can write countless tests including edge cases, using just only one instance of the FixtureMonkey type. You can automatically generate instances of complex types and set fields with values from builders of the ArbitraryBuilder type. The well-defined builders can be reused in any test.

Each primitive type property is generated by Jqwik or kotest-property.

Requirements

• JDK 1.8 or higher
• Jqwik 1.7.3
• Kotlin 1.8 or higher
• kotest-property 5.6.2

Install

Gradle

Java

testImplementation("com.navercorp.fixturemonkey:fixture-monkey-starter:1.0.4")

Kotlin

testImplementation("com.navercorp.fixturemonkey:fixture-monkey-starter-kotlin:1.0.4")

Maven

Java

<dependency>
    <groupId>com.navercorp.fixturemonkey</groupId>
    <artifactId>fixture-monkey-starter</artifactId>
    <version>1.0.4</version>
    <scope>test</scope>
</dependency>

Kotlin

<dependency>
    <groupId>com.navercorp.fixturemonkey</groupId>
    <artifactId>fixture-monkey-starter-kotlin</artifactId>
    <version>1.0.4</version>
    <scope>test</scope>
</dependency>

Example

Add "lombok.anyConstructor.addConstructorProperties=true" in lombok.config

Java

@Value
public class Order {
    Long id;

    String orderNo;

    String productName;

    int quantity;

    long price;

    List<String> items;

    Instant orderedAt;
}

@Test
void sampleOrder() {
    // given
    FixtureMonkey sut = FixtureMonkey.builder()
            .objectIntrospector(ConstructorPropertiesArbitraryIntrospector.INSTANCE)
            .build();

    // when
    Order actual = sut.giveMeBuilder(Order.class)
            .set(javaGetter(Order::getOrderNo), "1")
            .set(javaGetter(Order::getProductName), "Line Sally")
            .minSize(javaGetter(Order::getItems), 1)
            .sample();

    // then
    then(actual.getOrderNo()).isEqualTo("1");
    then(actual.getProductName()).isEqualTo("Line Sally");
    then(actual.getItems()).hasSizeGreaterThanOrEqualTo(1);
}

Kotlin

data class Order (
    val id: Long,

    val orderNo: String,

    val productName: String,

    val quantity: Int,

    val price: Long,

    val items: List<String>,

    val orderedAt: Instant
)

@Test
fun sampleOrder() {
    // given
    val sut = FixtureMonkey.builder()
            .plugin(KotlinPlugin())
            .build()

    // when
    val actual = sut.giveMeBuilder<Order>()
            .setExp(Order::orderNo, "1")
            .setExp(Order::productName, "Line Sally")
            .minSizeExp(Order::items, 1)
            .sample()

    // then
    then(actual.orderNo).isEqualTo("1")
    then(actual.productName).isEqualTo("Line Sally")
    then(actual.items).hasSizeGreaterThanOrEqualTo(1)
}

Documentation

• English

Third-party Modules

Plugins

• FixtureMonkey Helper
  • IntelliJ plugin that makes it easier to use Fixture Monkey string expressions & Kotlin DSL

Contributors

• 🐒 ah.jo
• 🐒 mhyeon-lee
• 🐒 acktsap
• 🐒 benelog
• 🐒 jwChung
• 🐒 SooKim1110
• @KoEonYack
• @G-ONL
• @imbyungjun
• @sandrawangyx
• @dbgsprw
• @kshired
• @ByungjunYou
• @esfomeado
• @yn-jn-j
• @jongwooo
• @doljae
• @jbl428
• @sangy515
• @yunseok-jeong0
• @wicksome

More about Fixture Monkey

• Deview 2021

Articles

• fixure monkey로 예외 발생 테스트
• 테스트 객체를 더쉽게 만들어보자, Fixture-monkey
• Junit Test with Fixture Monkey
• Fixture monkey
• 테스트 데이터도구 - Fixture Monkey
• Fixture Monkey란?
• 테스트를 작성할 수 밖에 없는 사람들에게
• Fixture Monkey 사용해보기
• Simplify Unit Testing with Fixture Monkey
• Getting Started Easy Test Fixture Customization with Fixture Monkey

Welcome to write articles about Fixture Monkey!

License

Copyright 2021-present NAVER Corp.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.