Skip to content

Requirements

Introduction🔗

With Chutney you can write and run functional scenarios.
Those scenarios validate high level requirements and are not tied to your application code.

Instead, you will target I/O interfaces of your application (i.e. HTTP endpoints, Kafka topics, AMQP queues, etc.) without writing the same boilerplate code for respective clients, consumers, or even mock clients or producers.

To get you started, we will cover how to write scenarios with the Chutney Kotlin DSL and run them with JUnit5.

Minimal Setup🔗

Requirements

  • java 17 or later and Kotlin
  • your preferred build tool (ex. maven, gradle, etc.)
  • your preferred test engine (ex. Junit 5.x, TestNG, etc.)
Building a Kotlin project

In order to build your Kotlin project, you may need to add the following configuration with maven :

 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
<build>
    <sourceDirectory>${project.basedir}/src/main/kotlin</sourceDirectory>
    <testSourceDirectory>${project.basedir}/src/test/kotlin</testSourceDirectory>

    <plugins>
        <plugin>
            <groupId>org.jetbrains.kotlin</groupId>
            <artifactId>kotlin-maven-plugin</artifactId>
            <version>1.6.10</version>
            <executions>
                <execution>
                    <id>compile</id>
                    <phase>compile</phase>
                    <goals>
                        <goal>compile</goal>
                    </goals>
                </execution>
                <execution>
                    <id>test-compile</id>
                    <goals>
                        <goal>test-compile</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

Dependencies🔗

Create a Kotlin project with the following 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
<dependencies>
    <dependency>
        <groupId>com.chutneytesting</groupId>
        <artifactId>chutney-kotlin-dsl</artifactId> <!--(1)-->
        <version>1.7.0</version>
    </dependency>
   <dependency>
        <groupId>org.jetbrains.kotlin</groupId>
        <artifactId>kotlin-stdlib</artifactId> <!--(2)-->
        <version>1.6.10</version>
    </dependency>
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter-api</artifactId>
        <version>5.8.2</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter-engine</artifactId> <!-- Optional (3) -->
        <version>5.8.2</version>
        <scope>test</scope>
    </dependency>
</dependencies>
  1. Required for using the Chutney Kotlin DSL
  2. Required for compiling Kotlin project
  3. Only required if you want to run your test within IntelliJ with the gutter icon 
1
2
3
4
5
6
7
dependencies {
    implementation("com.chutneytesting:chutney-kotlin-dsl:0.1.18")

    testImplementation(kotlin("test"))
    testImplementation("org.junit.jupiter:junit-jupiter-api:5.8.2")
    testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.8.2")
}