Getting started with Allure Kotlin extensions

The Allure Kotlin extensions let you add steps, metadata and attachments to your Allure Report test reports with a Kotlin-friendly API: top-level functions with named arguments and default values, steps that return values, and steps that work with coroutines.

The extensions don't run your tests. They work together with an Allure Java integration for your test framework, such as Allure JUnit Jupiter or Allure TestNG, and call the same Runtime API that Java tests use. The original Allure class stays available.

There are two modules:

• allure-kotlin-extensions - the Kotlin API for steps, metadata, attachments and global errors.
• allure-kotlin-coroutines - steps that can suspend, and a way to pass the current test to coroutines that run on other threads. This module includes allure-kotlin-extensions.

The Allure Kotlin extensions are available in Allure Java 3.0.0 and newer. They require Java 17 or newer and Kotlin 2.3 or newer.

INFO

The Allure Kotlin extensions are a part of Allure Java. They are not related to Allure Kotlin, a separate project for Android tests.

Setting up

1. Make sure you have the Allure Report integration enabled for the test framework you use.

   See the instructions in the integration's documentation in Frameworks.

2. Add the Allure Kotlin extensions to your project's dependencies. If your tests use coroutines, use allure-kotlin-coroutines instead of allure-kotlin-extensions, to get suspending steps and to keep the steps of coroutines in the right test.

   Maven

   <!-- Define the version of Allure you want to use via the allure.version property -->
   <properties>
       <allure.version>VERSION</allure.version>
   </properties>
   
   <!-- Add allure-bom to dependency management to ensure correct versions of all the dependencies are used -->
   <dependencyManagement>
       <dependencies>
           <dependency>
               <groupId>io.qameta.allure</groupId>
               <artifactId>allure-bom</artifactId>
               <version>${allure.version}</version>
               <type>pom</type>
               <scope>import</scope>
           </dependency>
       </dependencies>
   </dependencyManagement>
   
   <dependencies>
       <dependency>
           <groupId>io.qameta.allure</groupId>
           <artifactId>allure-kotlin-extensions</artifactId>
           <scope>test</scope>
       </dependency>
   </dependencies>

   Gradle (Kotlin)

   val allureVersion = "VERSION"
   
   dependencies {
       testImplementation(platform("io.qameta.allure:allure-bom:$allureVersion"))
       testImplementation("io.qameta.allure:allure-kotlin-extensions")
   }

   Gradle (Groovy)

   def allureVersion = "VERSION"
   
   dependencies {
       testImplementation platform("io.qameta.allure:allure-bom:$allureVersion")
       testImplementation "io.qameta.allure:allure-kotlin-extensions"
   }

3. Import the functions you need from io.qameta.allure.kotlin.extensions, and use them in your tests.

   The example below shows the Allure Kotlin extensions in a JUnit Jupiter test.

   import io.qameta.allure.kotlin.extensions.attachment
   import io.qameta.allure.kotlin.extensions.feature
   import io.qameta.allure.kotlin.extensions.parameter
   import io.qameta.allure.kotlin.extensions.step
   import org.junit.jupiter.api.Assertions.assertEquals
   import org.junit.jupiter.api.Test
   
   class TestOrders {
   
       @Test
       fun testCreateOrder() {
           feature("Orders")
           val region = parameter("region", "eu-west")
   
           val orderId = step("Create order") {
               val id = createOrder(region)
               name("Create order $id")
               id
           }
   
           step("Check the order status") {
               val status = loadStatus(orderId)
               attachment(name = "status", content = status)
               assertEquals("created", status)
           }
       }
   }

   See the reference for all available functions.

4. Run your tests and generate a test report the same way as you would do usually.