Getting Started¶

Requirements:

• Instancio 5.x: Java 8 or higher.
• Instancio 6.x: Java 17 or higher.

Dependencies¶

The following dependencies are available from Maven central:

instancio-junit¶

Use the instancio-junit dependency that matches your JUnit version:

• For JUnit 5, use instancio-junit:5.x
• For JUnit 6, use instancio-junit:6.x

It includes a transitive dependency on instancio-core, therefore it is not necessary to import both.

1
2
3
4
5
6

<dependency>
    <groupId>org.instancio</groupId>
    <artifactId>instancio-junit</artifactId>
    <version>6.0.0-RC4</version>
    <scope>test</scope>
</dependency>

1
2
3

dependencies {
    testImplementation 'org.instancio:instancio-junit:6.0.0-RC4'
}

instancio-core¶

If you use JUnit 4, TestNG, or would like to use Instancio standalone, then use instancio-core:

1
2
3
4
5
6

<dependency>
    <groupId>org.instancio</groupId>
    <artifactId>instancio-core</artifactId>
    <version>6.0.0-RC4</version>
    <scope>test</scope>
</dependency>

1
2
3

dependencies {
    testImplementation 'org.instancio:instancio-core:6.0.0-RC4'
}

instancio-guava¶

Using instancio-guava requires the following dependencies on the classpath:

• either instancio-core or instancio-junit
• com.google.guava:guava version 23.1-jre or higher

instancio-kotlin¶

instancio-kotlin includes a transitive dependency on instancio-core, therefore it is not necessary to import both.

The following Kotlin dependencies are not included transitively. Please make sure they are available on the classpath:

• org.jetbrains.kotlin:kotlin-stdlib
• org.jetbrains.kotlin:kotlin-reflect

instancio-protobuf¶

Using instancio-protobuf requires the following dependencies on the classpath:

• either instancio-core or instancio-junit
• com.google.protobuf:protobuf-java version 4.x

instancio-bom¶

Use instancio-bom to easily manage Instancio dependencies:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.instancio</groupId>
            <artifactId>instancio-bom</artifactId>
            <version>6.0.0-RC4</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
<dependencies>
    <dependency>
        <groupId>org.instancio</groupId>
        <artifactId>instancio-core</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.instancio</groupId>
        <artifactId>instancio-junit</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.instancio</groupId>
        <artifactId>instancio-guava</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.instancio</groupId>
        <artifactId>instancio-kotlin</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.instancio</groupId>
        <artifactId>instancio-protobuf</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

1
2
3
4
5
6
7
8

dependencies {
    implementation platform('org.instancio:instancio-bom:6.0.0-RC4')
    testImplementation 'org.instancio:instancio-core'
    testImplementation 'org.instancio:instancio-junit'
    testImplementation 'org.instancio:instancio-guava'
    testImplementation 'org.instancio:instancio-kotlin'
    testImplementation 'org.instancio:instancio-protobuf'
}

Versioning¶

Instancio version numbers adhere to the MAJOR.MINOR.PATCH format.

• Major versions are generally reserved for significant features and breaking changes.
• Minor and Patch versions include bug fixes, smaller new features, but may also include minor breaking changes.

In other words, the project does not follow Semantic Versioning, though the versioning scheme loosely resembles it.