TestIT Kotlin Integrations

The repository contains new versions of adaptors for Kotlin test frameworks.

Compatibility of Adapters and TMS

Test IT	Kotest
5.0	0.1.0

Supported test frameworks :

1. Kotest

🚀 Warning

• If value from @WorkItemIds annotation not found in TMS then test result will NOT be uploaded.

Metadata of autotest

Use metadata to specify information about autotest.

Description of metadata:

• externalId - unique internal autotest ID (used in Test IT)
• links - links listed in the autotest card
• workItemIds - a value that links autotests with manual tests. Receives the array of manual tests' IDs
• attachments - autotests attachments list
• name - internal autotest name (used in Test IT)
• title - autotest name specified in the autotest card. If not specified, the name from the displayName method is used
• message - autotest message
• itemStatus - autotest itemStatus
• description - autotest description specified in the autotest card
• labels - tags listed in the autotest card

All autotest metadata described with TestItContext class using testCase.setContext():

data class TestItContext (
    var uuid: String? = null,
    var externalId: String? = null,
    var links: MutableList<LinkItem>? = null,
    var workItemIds: MutableList<String>? = null,
    var attachments: MutableList<String>? = null,
    var name: String? = null,
    var title: String? = null,
    var message: String? = null,
    var itemStatus: ItemStatus? = null,
    var description: String? = null,
    var parameters: MutableMap<String, String>? = null,
    var labels: MutableList<Label>? = null,
)

Example:

 testCase.setContext(TestItContext(
    name = "isPythagTriple($a, $b, $c)",
    labels = mutableListOf(Label("123"))
))

Examples

Default example:

package org.example.tests

import io.kotest.core.spec.style.DescribeSpec
import io.kotest.matchers.shouldBe
import ru.testit.listener.TestItReporter
import ru.testit.models.LinkItem
import ru.testit.models.LinkType
import ru.testit.models.TestItContext
import ru.testit.utils.*

// isStepContainer true, 2 tests, before + after(failed): failed
class BeforePassedAfterPassed : DescribeSpec({
    // enable steps by true parameter
    extensions(TestItReporter(true))
    beforeTest {
    }
    // executes even if beforeTest is failed
    afterTest {
        it.testItAfterTest {
            "afterTest" shouldBe "failed"
        }
    }
    it("test1 passed, afterTest failed -> failed") {
        3 + 4 shouldBe 7
    }
    it("test2 failed, afterTest failed -> failed") {
        "TestBody" shouldBe "Failed"
    }
})

Steps container example

package org.example.tests

import io.kotest.core.spec.style.DescribeSpec
import io.kotest.matchers.shouldBe
import ru.testit.listener.TestItReporter
import ru.testit.models.LinkItem
import ru.testit.models.LinkType
import ru.testit.models.TestItContext
import ru.testit.utils.*

// isStepContainer true, 1 test, 2 steps before + after(failed): ok + failed
class BeforeAfterSteps : DescribeSpec({
    extensions(TestItReporter(true))

    beforeTest {
        it.setSetupName("beforeTest")
    }

    // executes even if beforeTest is failed
    afterTest {
        it.a.setTeardownName("afterTest")
        it.testItAfterTest {
        }
    }

    describe("describe step container test") {
        testCase.asStepContainer()
        testCase.setContext(
            TestItContext(
                links = mutableListOf(
                    LinkItem(url = "https://google.com", title = "",
                    description = "", type = LinkType.BLOCKED_BY)
                )
            )
        )
        it("an inner step1 - failed") {
            "Step1" shouldBe "Failed"
        }
        it("an inner step2 - pass") {
            3 + 4 shouldBe 7
        }
    }
})

Step container with FunSpec style

package org.example.tests

import io.kotest.core.spec.style.FunSpec
import io.kotest.matchers.shouldBe
import ru.testit.listener.TestItReporter
import ru.testit.models.Label
import ru.testit.models.TestItContext
import ru.testit.utils.asStepContainer
import ru.testit.utils.setContext

class StepContextTest : FunSpec({
   extensions(TestItReporter(true, ))


   context("fun step spec test") {
       testCase.asStepContainer()
       testCase.setContext(TestItContext(
           labels = mutableListOf(Label("some label1"))
       ))

       test("shouldFail_") {
           true shouldBe false
       }

       test("shouldPass") {
           true shouldBe true
       }
   }

})

Parametrized test example

package org.example.tests

import io.kotest.core.spec.style.FunSpec
import io.kotest.datatest.withData
import io.kotest.matchers.shouldBe
import ru.testit.listener.TestItReporter
import ru.testit.models.Label
import ru.testit.models.TestItContext
import ru.testit.utils.setContext
import ru.testit.utils.testItAfterTest


data class PythagTriple(val a: Int, val b: Int, val c: Int)
fun isPythagTriple(a: Int, b: Int, c: Int): Boolean = a * a + b * b == c * c


class NestingTest : FunSpec({
   val testit = TestItReporter(true)
   extensions(testit)

   context("Pythag triples tests") {
       withData(
           PythagTriple(3, 4, 5),
           PythagTriple(6, 8, 10),
           PythagTriple(8, 15, 17),
           PythagTriple(7, 24, 25),
           PythagTriple(7, 7, 7),

           ) { (a, b, c) ->
           testCase.setContext(TestItContext(
               name = "isPythagTriple($a, $b, $c)",
               labels = mutableListOf(Label("123"))
           ))
           isPythagTriple(a, b, c) shouldBe true
       }
   }

})