io.qameta.allure.kotlin.junit4.AllureJunit4.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of allure-kotlin-junit4 Show documentation
Module allure-kotlin-junit4 of Allure Framework.
There is a newer version: 2.4.0
package io.qameta.allure.kotlin.junit4

import io.qameta.allure.kotlin.Allure
import io.qameta.allure.kotlin.AllureLifecycle
import io.qameta.allure.kotlin.model.*
import io.qameta.allure.kotlin.util.AnnotationUtils
import io.qameta.allure.kotlin.util.AnnotationUtils.getLabels
import io.qameta.allure.kotlin.util.AnnotationUtils.getLinks
import io.qameta.allure.kotlin.util.ResultsUtils
import io.qameta.allure.kotlin.util.ResultsUtils.createFrameworkLabel
import io.qameta.allure.kotlin.util.ResultsUtils.createHostLabel
import io.qameta.allure.kotlin.util.ResultsUtils.createLanguageLabel
import io.qameta.allure.kotlin.util.ResultsUtils.createPackageLabel
import io.qameta.allure.kotlin.util.ResultsUtils.createSuiteLabel
import io.qameta.allure.kotlin.util.ResultsUtils.createTestClassLabel
import io.qameta.allure.kotlin.util.ResultsUtils.createTestMethodLabel
import io.qameta.allure.kotlin.util.ResultsUtils.createThreadLabel
import io.qameta.allure.kotlin.util.ResultsUtils.getStatus
import io.qameta.allure.kotlin.util.ResultsUtils.getStatusDetails
import io.qameta.allure.kotlin.util.ResultsUtils.md5
import org.junit.Ignore
import org.junit.runner.Description
import org.junit.runner.Result
import org.junit.runner.notification.Failure
import org.junit.runner.notification.RunListener
import java.util.*

/**
 * Allure Junit4 listener.
 */
@RunListener.ThreadSafe
class AllureJunit4 @JvmOverloads constructor(val lifecycle: AllureLifecycle = Allure.lifecycle) :
    RunListener() {
    private val testCases: ThreadLocal = object : InheritableThreadLocal() {
        override fun initialValue(): String = UUID.randomUUID().toString()
    }

    override fun testRunStarted(description: Description) { //do nothing
    }

    override fun testRunFinished(result: Result) { //do nothing
    }

    override fun testStarted(description: Description) {
        val uuid = testCases.get()
        val result = createTestResult(uuid, description)
        lifecycle.scheduleTestCase(result)
        lifecycle.startTestCase(uuid)
    }

    override fun testFinished(description: Description) {
        val uuid = testCases.get()
        testCases.remove()
        lifecycle.updateTestCase(uuid) { testResult: TestResult ->
            if (testResult.status == null) {
                testResult.status = Status.PASSED
            }
        }
        lifecycle.stopTestCase(uuid)
        lifecycle.writeTestCase(uuid)
    }

    override fun testFailure(failure: Failure) {
        val uuid = testCases.get()
        lifecycle.updateTestCase(uuid) { testResult: TestResult ->
            with(testResult) {
                status = getStatus(failure.exception)
                statusDetails = getStatusDetails(failure.exception)
            }
        }
    }

    override fun testAssumptionFailure(failure: Failure) {
        val uuid = testCases.get()
        lifecycle.updateTestCase(uuid) { testResult: TestResult ->
            with(testResult) {
                status = Status.SKIPPED
                statusDetails = getStatusDetails(failure.exception)
            }
        }
    }

    override fun testIgnored(description: Description) {
        val uuid = testCases.get()
        testCases.remove()

        val result = createTestResult(uuid, description).apply {
            status = Status.SKIPPED
            statusDetails = getIgnoredMessage(description)
            start = System.currentTimeMillis()
        }
        lifecycle.scheduleTestCase(result)
        lifecycle.stopTestCase(uuid)
        lifecycle.writeTestCase(uuid)
    }

    private fun getDisplayName(result: Description): String? {
        return result.getAnnotation(DisplayName::class.java)?.value
    }

    private fun getDescription(result: Description): String? {
        return result.getAnnotation(io.qameta.allure.kotlin.Description::class.java)?.value
    }

    private fun extractLinks(description: Description): List {
        val result = ArrayList(getLinks(description.annotations))
        description.testClass
            ?.let(AnnotationUtils::getLinks)
            ?.let(result::addAll)
        return result
    }

    private fun extractLabels(description: Description): List {
        val result = ArrayList(getLabels(description.annotations))
        description.testClass
            ?.let(AnnotationUtils::getLabels)
            ?.let(result::addAll)
        return result
    }

    private fun getHistoryId(description: Description): String {
        return md5(description.className + description.methodName)
    }

    private fun getPackage(testClass: Class<*>?): String {
        return testClass?.getPackage()?.name ?: ""
    }

    private fun getIgnoredMessage(description: Description): StatusDetails {
        val ignore: Ignore? = description.getAnnotation(Ignore::class.java)
        val message = ignore?.value?.takeIf { it.isNotEmpty() } ?: "Test ignored (without reason)!"
        return StatusDetails(message = message)
    }

    private fun createTestResult(uuid: String, description: Description): TestResult {
        val className: String = description.className
        val methodName: String? = description.methodName
        val name = methodName ?: className
        val fullName = if (methodName != null) "$className.$methodName" else className
        val suite: String = description.testClass?.getAnnotation(DisplayName::class.java)?.value ?: className
        val testResult: TestResult = TestResult(uuid).apply {
            this.historyId = getHistoryId(description)
            this.fullName = fullName
            this.name = name
        }
        testResult.labels.addAll(ResultsUtils.getProvidedLabels())
        testResult.labels.addAll(
            listOf(
                createPackageLabel(getPackage(description.testClass)),
                createTestClassLabel(className),
                createTestMethodLabel(name),
                createSuiteLabel(suite),
                createHostLabel(),
                createThreadLabel(),
                createFrameworkLabel("junit4"),
                createLanguageLabel("kotlin")
            )
        )
        testResult.labels.addAll(extractLabels(description))
        testResult.links.addAll(extractLinks(description))
        getDisplayName(description)?.let {
            testResult.name = it
        }
        getDescription(description)?.let {
            testResult.description = it
        }
        return testResult
    }

}