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

...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))202         .result(result)203         .build()204      println(msg)205   }206   /**207    * For a given [TestCase] will output the "test suite started" message.208    */209   private fun startTestSuite(testCase: TestCase) {210      val msg = TeamCityMessageBuilder211         .testSuiteStarted(prefix, formatter.format(testCase))212         .id(testCase.descriptor.path().value)213         .parent(testCase.descriptor.parent.path().value)214         .locationHint(Locations.location(testCase.source))215         .build()216      println(msg)217      started.add(testCase.descriptor)218   }219   /**220    * For a given [TestCase] will output the "test suite finished" message.221    */222   private fun finishTestSuite(testCase: TestCase, result: TestResult) {223      val msg = TeamCityMessageBuilder224         .testSuiteFinished(prefix, formatter.format(testCase))225         .id(testCase.descriptor.path().value)226         .parent(testCase.descriptor.parent.path().value)227         .duration(result.duration)228         .locationHint(Locations.location(testCase.source))229         .result(result)230         .build()231      println(msg)232   }233}...

...68   }69   object Attributes {70      const val ACTUAL = "actual"71      const val EXPECTED = "expected"72      const val LOCATION_HINT = "locationHint"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   }...

1TeamCityMessageBuilder.locationHint( "my file" , 1 , 2 )2TeamCityMessageBuilder.locationHint( "my file" , 1 , 2 )3TeamCityMessageBuilder.locationHint( "my file" , 1 , 2 )4TeamCityMessageBuilder.locationHint( "my file" , 1 , 2 )5TeamCityMessageBuilder.locationHint( "my file" , 1 , 2 )6TeamCityMessageBuilder.locationHint( "my file" , 1 , 2 )7TeamCityMessageBuilder.locationHint( "my file" , 1 , 2 )8TeamCityMessageBuilder.locationHint( "my file" , 1 , 2 )9TeamCityMessageBuilder.locationHint( "my file" , 1 , 2 )10TeamCityMessageBuilder.locationHint( "my file" , 1 , 2 )11TeamCityMessageBuilder.locationHint( "my file" , 1 , 2 )12TeamCityMessageBuilder.locationHint( "my file" , 1 , 2 )13TeamCityMessageBuilder.locationHint( "my file" , 1 , 2 )

1val teamCityMessageBuilder = TeamCityMessageBuilder()2teamCityMessageBuilder.locationHint( "src/main/kotlin/io/kotest/examples/TeamCityMessageBuilderExample.kt" , 14)3teamCityMessageBuilder.build()4val teamCityMessageBuilder = TeamCityMessageBuilder()5teamCityMessageBuilder.progressMessage( "This is a progress message" )6teamCityMessageBuilder.build()7val teamCityMessageBuilder = TeamCityMessageBuilder()8teamCityMessageBuilder.progressStart( "This is a start progress message" )9teamCityMessageBuilder.build()10val teamCityMessageBuilder = TeamCityMessageBuilder()11teamCityMessageBuilder.progressFinish( "This is a finish progress message" )12teamCityMessageBuilder.build()13val teamCityMessageBuilder = TeamCityMessageBuilder()14teamCityMessageBuilder.publishArtifacts( "build/outputs" )15teamCityMessageBuilder.build()16val teamCityMessageBuilder = TeamCityMessageBuilder()17teamCityMessageBuilder.testCount( 1 )18teamCityMessageBuilder.build()19val teamCityMessageBuilder = TeamCityMessageBuilder()20teamCityMessageBuilder.testIgnored( "This is a testIgnored message" )21teamCityMessageBuilder.build()22val teamCityMessageBuilder = TeamCityMessageBuilder()23teamCityMessageBuilder.testFailed( "This is a testFailed message" )24teamCityMessageBuilder.build()25val teamCityMessageBuilder = TeamCityMessageBuilder()26teamCityMessageBuilder.testFinished( "This is a testFinished message" )27teamCityMessageBuilder.build()

1 fun  teamCityTestListener() = object : TestListener {2     override   fun  beforeTest(testCase: TestCase) {3        TeamCityMessageBuilder.testStarted(testCase.displayName)4    }5     override   fun  afterTest(testCase: TestCase, result: TestResult) {6         when  (result) {7             is  TestResult.Success -> TeamCityMessageBuilder.testFinished(testCase.displayName)8             is  TestResult.Failure -> {9                TeamCityMessageBuilder.testFailed(testCase.displayName, result.error)10                TeamCityMessageBuilder.testFinished(testCase.displayName)11            }12             is  TestResult.Error -> {13                TeamCityMessageBuilder.testFailed(testCase.displayName, result.error)14                TeamCityMessageBuilder.testFinished(testCase.displayName)15            }16             is  TestResult.Ignored -> TeamCityMessageBuilder.testIgnored(testCase.displayName)17        }18    }19}20 fun  teamCitySpecListener() = object : SpecListener {21     override   fun  beforeSpecClass(spec: Spec, tests: List<TestCase>) {22        TeamCityMessageBuilder.testSuiteStarted(spec::class.simpleName!!)23    }24     override   fun  afterSpecClass(spec: Spec, results: Map<TestCase, TestResult>) {25        TeamCityMessageBuilder.testSuiteFinished(spec::class.simpleName!!)26    }27}28 fun  teamCityProjectListener() = object : ProjectListener {29     override   fun  beforeProject() {

1    if (System.getenv("TEAMCITY_VERSION") != null) {2        val locationHint = TeamCityMessageBuilder.locationHint(testCase.source?.lineNumber ?: 0, testCase.source?.fileName ?: "")3        println(locationHint)4    }5    if (System.getenv("TEAMCITY_VERSION") != null) {6        val testFailed = TeamCityMessageBuilder.testFailed(testCase.description.name, "Test Failed", "Test Failed", "Test Failed")7        println(testFailed)8    }9    if (System.getenv("TEAMCITY_VERSION") != null) {10        val testFinished = TeamCityMessageBuilder.testFinished(testCase.description.name)11        println(testFinished)12    }13    if (System.getenv("TEAMCITY_VERSION") != null) {14        val testSuiteFinished = TeamCityMessageBuilder.testSuiteFinished(testCase.description.name)15        println(testSuiteFinished)16    }17}