How to use details method of io.kotest.engine.teamcity.TeamCityMessageBuilder class

Best Kotest code snippet using io.kotest.engine.teamcity.TeamCityMessageBuilder.details

TeamCityTestEngineListener.kt

Source:TeamCityTestEngineListener.kt

...19 * A [TestEngineListener] that logs events to the console using a [TeamCityMessageBuilder].20 */21class TeamCityTestEngineListener(22   private val prefix: String = TeamCityMessageBuilder.TeamCityPrefix,23   private val details: Boolean = true,24) : TestEngineListener {25   private var formatter: DisplayNameFormatter = DefaultDisplayNameFormatter(ProjectConfiguration())26   // once a spec has completed, we want to be able to check whether any given test is27   // a container or a leaf test, and so this map contains all test that have children28   private val children = mutableMapOf<Descriptor, MutableList<TestCase>>()29   private val results = mutableMapOf<Descriptor, TestResult>()30   private val started = mutableSetOf<Descriptor.TestDescriptor>()31   // intellij has no method for failed suites, so if a container or spec fails we must insert32   // a dummy "test" in order to tag the error against that33   private fun insertPlaceholder(t: Throwable, parent: Descriptor) {34      val (name, cause) = ExtensionExceptionExtractor.resolve(t)35      val msg1 = TeamCityMessageBuilder36         .testStarted(prefix, name)37         .id(name)38         .parent(parent.path().value)39         .build()40      println(msg1)41      // we must print out the stack trace in between the dummy, so it appears when you click on the test name42      //t?.printStackTrace()43      val msg2 = TeamCityMessageBuilder44         .testFailed(prefix, name)45         .id(name)46         .parent(parent.path().value)47         .withException(cause, details)48         .build()49      println(msg2)50      val msg3 = TeamCityMessageBuilder51         .testFinished(prefix, name)52         .id(name)53         .parent(parent.path().value)54         .build()55      println(msg3)56   }57   override suspend fun engineStarted() {}58   override suspend fun engineInitialized(context: EngineContext) {59      formatter = getDisplayNameFormatter(context.configuration.registry, context.configuration)60   }61   override suspend fun engineFinished(t: List<Throwable>) {62      if (t.isNotEmpty()) {63         t.withIndex().forEach { (index, error) ->64            val testName = if (t.size == 1) "Engine exception" else "Engine exception ${index + 1}"65            println(TeamCityMessageBuilder.testStarted(prefix, testName).build())66            val message = error.message ?: t::class.bestName()67            println(TeamCityMessageBuilder.testFailed(prefix, testName).message(message).build())68            println(TeamCityMessageBuilder.testFinished(prefix, testName).build())69         }70      }71   }72   override suspend fun specStarted(kclass: KClass<*>) {73      val msg = TeamCityMessageBuilder74         .testSuiteStarted(prefix, formatter.format(kclass))75         .id(kclass.toDescriptor().path().value)76         .locationHint(Locations.location(kclass))77         .build()78      println(msg)79   }80   // ignored specs are completely hidden from output in team city81   override suspend fun specIgnored(kclass: KClass<*>, reason: String?) {}82   override suspend fun specFinished(kclass: KClass<*>, result: TestResult) {83      // if the spec itself has an error, we must insert a placeholder test84      when (val t = result.errorOrNull) {85         null -> Unit86         is MultipleExceptions -> t.causes.forEach { insertPlaceholder(it, kclass.toDescriptor()) }87         else -> insertPlaceholder(t, kclass.toDescriptor())88      }89      finishSpec(kclass)90      results.clear()91      children.clear()92   }93   private fun finishSpec(kclass: KClass<*>) {94      val msg = TeamCityMessageBuilder95         .testSuiteFinished(prefix, formatter.format(kclass))96         .id(kclass.toDescriptor().path().value)97         .locationHint(Locations.location(kclass))98         .build()99      println(msg)100   }101   override suspend fun testStarted(testCase: TestCase) {102      if (testCase.parent != null) addChild(testCase)103      when (testCase.type) {104         TestType.Container -> startTestSuite(testCase)105         TestType.Test -> startTest(testCase)106         TestType.Dynamic -> Unit107      }108   }109   override suspend fun testIgnored(testCase: TestCase, reason: String?) {110      ignoreTest(testCase, TestResult.Ignored(reason))111   }112   private fun addChild(testCase: TestCase) {113      children.getOrPut(testCase.descriptor.parent) { mutableListOf() }.add(testCase)114   }115   override suspend fun testFinished(testCase: TestCase, result: TestResult) {116      results[testCase.descriptor] = result117      when (testCase.type) {118         TestType.Container -> {119            failTestSuiteIfError(testCase, result)120            finishTestSuite(testCase, result)121         }122         TestType.Test -> {123            if (!started.contains(testCase.descriptor)) startTest(testCase)124            if (result.isErrorOrFailure) failTest(testCase, result)125            finishTest(testCase, result)126         }127         TestType.Dynamic -> {128            if (isParent(testCase)) {129               startTestSuite(testCase)130               failTestSuiteIfError(testCase, result)131               finishTestSuite(testCase, result)132            } else {133               startTest(testCase)134               if (result.isErrorOrFailure) failTest(testCase, result)135               finishTest(testCase, result)136            }137         }138      }139   }140   private fun failTestSuiteIfError(testCase: TestCase, result: TestResult) {141      // test suites cannot be in a failed state, so we must insert a placeholder to hold any error142      when (val t = result.errorOrNull) {143         null -> Unit144         is MultipleExceptions -> t.causes.forEach { insertPlaceholder(it, testCase.descriptor) }145         else -> insertPlaceholder(t, testCase.descriptor)146      }147   }148   // returns true if this test case is a parent149   private fun isParent(testCase: TestCase) = children.getOrElse(testCase.descriptor) { mutableListOf() }.isNotEmpty()150   /**151    * For a given [TestCase] will output the "test ignored" message.152    */153   private fun ignoreTest(testCase: TestCase, result: TestResult.Ignored) {154      val msg = TeamCityMessageBuilder155         .testIgnored(prefix, formatter.format(testCase))156         .id(testCase.descriptor.path().value)157         .parent(testCase.descriptor.parent.path().value)158         .locationHint(Locations.location(testCase.source))159         .message(result.reason)160         .result(result)161         .build()162      println(msg)163   }164   /**165    * For a [TestCase] will output the "test started" message.166    */167   private fun startTest(testCase: TestCase) {168      val msg = TeamCityMessageBuilder169         .testStarted(prefix, formatter.format(testCase))170         .id(testCase.descriptor.path().value)171         .parent(testCase.descriptor.parent.path().value)172         .locationHint(Locations.location(testCase.source))173         .build()174      println(msg)175      started.add(testCase.descriptor)176   }177   /**178    * For a given [TestCase] will output the "test failed" message.179    */180   private fun failTest(testCase: TestCase, result: TestResult) {181      val msg = TeamCityMessageBuilder182         .testFailed(prefix, formatter.format(testCase))183         .id(testCase.descriptor.path().value)184         .parent(testCase.descriptor.parent.path().value)185         .duration(result.duration)186         .locationHint(Locations.location(testCase.source))187         .withException(result.errorOrNull, details)188         .result(result)189         .build()190      println(msg)191   }192   /**193    * For a given [TestCase] will output the "test finished" message.194    */195   private fun finishTest(testCase: TestCase, result: TestResult) {196      val msg = TeamCityMessageBuilder197         .testFinished(prefix, formatter.format(testCase))198         .id(testCase.descriptor.path().value)199         .parent(testCase.descriptor.parent.path().value)200         .duration(result.duration)201         .locationHint(Locations.location(testCase.source))...

TeamCityMessageBuilder.kt

Source:TeamCityMessageBuilder.kt

...73      const val NAME = "name"74      const val DURATION = "duration"75      const val TIMESTAMP = "timestamp"76      const val TYPE = "type"77      const val DETAILS = "details"78      const val MESSAGE = "message"79      const val PARENT_ID = "parent_id"80      const val ID = "id"81      const val RESULT_STATUS = "result_status"82   }83   object Messages {84      const val TEST_SUITE_STARTED = "testSuiteStarted"85      const val TEST_SUITE_FINISHED = "testSuiteFinished"86      const val TEST_STARTED = "testStarted"87      const val TEST_FINISHED = "testFinished"88      const val TEST_IGNORED = "testIgnored"89      const val TEST_STD_OUT = "testStdOut"90      const val TEST_STD_ERR = "testStdErr"91      const val TEST_FAILED = "testFailed"92   }93   private val myText = StringBuilder(prefix).append("[$messageName")94   fun addAttribute(name: String, value: String): TeamCityMessageBuilder {95      myText96         .append(' ')97         .append(name).append("='")98         .append(Escaper.escapeForTeamCity(value))99         .append("'")100      return this101   }102   fun message(value: String?): TeamCityMessageBuilder =103      if (value != null) addAttribute(Attributes.MESSAGE, value.trim()) else this104   fun details(value: String?): TeamCityMessageBuilder =105      if (value != null) addAttribute(Attributes.DETAILS, value.trim()) else this106   fun type(value: String): TeamCityMessageBuilder = addAttribute(Attributes.TYPE, value.trim())107   fun actual(value: String): TeamCityMessageBuilder = addAttribute(Attributes.ACTUAL, value.trim())108   fun expected(value: String): TeamCityMessageBuilder = addAttribute(Attributes.EXPECTED, value.trim())109   fun result(value: TestResult): TeamCityMessageBuilder = addAttribute(Attributes.RESULT_STATUS, value.name)110   fun locationHint(value: String?): TeamCityMessageBuilder =111      if (value != null) addAttribute(Attributes.LOCATION_HINT, value) else this112   // note it seems that not attaching a message renders test failed irrelevant113   fun withException(error: Throwable?, showDetails: Boolean = true): TeamCityMessageBuilder {114      if (error == null) return this115      val line1 = error.message?.trim()?.lines()?.firstOrNull()116      val message = if (line1.isNullOrBlank()) "Test failed" else line1117      message(escapeColons(message))118      if (showDetails)119         details(escapeColons(error.stackTraceToString()))120      when (error) {121         is ComparisonError -> type("comparisonFailure").actual(error.actualValue).expected(error.expectedValue)122      }123      return this124   }125   // sets the test's parents id126   fun parent(value: String): TeamCityMessageBuilder = addAttribute(Attributes.PARENT_ID, value)127   // sets a unique parsable id for this test128   fun id(value: String): TeamCityMessageBuilder = addAttribute(Attributes.ID, value)129   // workaround for TC colon issue, see main javadoc130   fun escapeColons(value: String) = when (escapeColons) {131      true -> value.replace(":", "\u02D0")132      false -> value133   }...

details

Using AI Code Generation

1val messageBuilder = TeamCityMessageBuilder()2messageBuilder.details("text")3val messageBuilder = TeamCityMessageBuilder()4messageBuilder.progressMessage("text")5val messageBuilder = TeamCityMessageBuilder()6messageBuilder.progressStart("text")7val messageBuilder = TeamCityMessageBuilder()8messageBuilder.progressFinish("text")9val messageBuilder = TeamCityMessageBuilder()10messageBuilder.build()11val messageBuilder = TeamCityMessageBuilder()12messageBuilder.build()13val messageBuilder = TeamCityMessageBuilder()14messageBuilder.build()15val messageBuilder = TeamCityMessageBuilder()16messageBuilder.build()17val messageBuilder = TeamCityMessageBuilder()18messageBuilder.build()19val messageBuilder = TeamCityMessageBuilder()20messageBuilder.build()21val messageBuilder = TeamCityMessageBuilder()22messageBuilder.build()23val messageBuilder = TeamCityMessageBuilder()24messageBuilder.build()25val messageBuilder = TeamCityMessageBuilder()26messageBuilder.build()27fun main() {28val messageBuilder = TeamCityMessageBuilder()29messageBuilder.build()30}31val messageBuilder = TeamCityMessageBuilder()32messageBuilder.build()

details

Using AI Code Generation

1fun TeamCityMessageBuilder.details(message: String) {2this.message("##teamcity[message text='${message.escape()}' status='NORMAL']")3}4fun TeamCityMessageBuilder.details(message: String) {5this.message("##teamcity[message text='${message.escape()}' status='NORMAL']")6}7fun TeamCityMessageBuilder.details(message: String) {8this.message("##teamcity[message text='${message.escape()}' status='NORMAL']")9}10fun TeamCityMessageBuilder.details(message: String) {11this.message("##teamcity[message text='${message.escape()}' status='NORMAL']")12}13fun TeamCityMessageBuilder.details(message: String) {14this.message("##teamcity[message text='${message.escape()}' status='NORMAL']")15}16fun TeamCityMessageBuilder.details(message: String) {17this.message("##teamcity[message text='${message.escape()}' status='NORMAL']")18}19fun TeamCityMessageBuilder.details(message: String) {20this.message("##teamcity[message text='${message.escape()}' status='NORMAL']")21}22fun TeamCityMessageBuilder.details(message: String) {23this.message("##teamcity[message text='${message.escape()}' status='NORMAL']")24}25fun TeamCityMessageBuilder.details(message: String) {26this.message("##teamcity[message text='${message.escape()}' status='NORMAL']")27}28fun TeamCityMessageBuilder.details(message: String) {29this.message("##teamcity[message text='${message.escape()}' status='NORMAL']")30}

details

Using AI Code Generation

1fun details ( message : String , block : TeamCityMessageBuilder .() -> Unit ) {2this . block ()3this . message ( message )4}5fun build ( block : TeamCityMessageBuilder .() -> Unit ) {6this . block ()7}8fun build ( block : TeamCityMessageBuilder .() -> Unit ) {9this . block ()10}11fun build ( block : TeamCityMessageBuilder .() -> Unit ) {12this . block ()13}14fun build ( block : TeamCityMessageBuilder .() -> Unit ) {15this . block ()16}17fun build ( block : TeamCityMessageBuilder .() -> Unit ) {18this . block ()19}20fun build ( block : TeamCityMessageBuilder .() -> Unit ) {21this . block ()22}23fun build ( block : TeamCityMessageBuilder .() -> Unit ) {24this . block ()25}26fun build ( block : TeamCityMessageBuilder .() -> Unit ) {27this . block ()28}29fun build ( block : TeamCityMessageBuilder .() -> Unit ) {30this . block ()31}32fun build ( block : TeamCityMessageBuilder .() -> Unit ) {33this . block ()34}35fun build ( block : TeamCityMessageBuilder .() -> Unit ) {36this . block ()37}38fun build ( block : TeamCityMessage

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.