Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

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

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

TeamCityMessageBuilder.kt

Source:TeamCityMessageBuilder.kt

...19 * @param prefix Is the opening string used to signal that the line is a team city line.20 *               If unspecified this defaults to the team city format '##teamcity'.21 *               Can be overriden to help with testing.22 *23 * @param escapeColons team city uses colons in its format, and does not support colons inside messages properly,24 *                      and there is no escape, so we have to mangle colons if the output is going to the console.25 *                      See https://teamcity-support.jetbrains.com/hc/en-us/community/posts/206882875-Colons-in-test-service-messages-are-confusing-Team-City-26 */27class TeamCityMessageBuilder(28   prefix: String,29   messageName: String,30   private val escapeColons: Boolean = false31) {32   companion object {33      const val TeamCityPrefix = "##teamcity"34      fun testSuiteStarted(name: String): TeamCityMessageBuilder = testSuiteStarted(TeamCityPrefix, name)35      fun testSuiteStarted(prefix: String, name: String): TeamCityMessageBuilder {36         return TeamCityMessageBuilder(prefix, Messages.TEST_SUITE_STARTED).addAttribute(Attributes.NAME, name)37      }38      fun testSuiteFinished(name: String): TeamCityMessageBuilder = testSuiteFinished(TeamCityPrefix, name)39      fun testSuiteFinished(prefix: String, name: String): TeamCityMessageBuilder {40         return TeamCityMessageBuilder(prefix, Messages.TEST_SUITE_FINISHED).addAttribute(Attributes.NAME, name)41      }42      fun testStarted(name: String): TeamCityMessageBuilder = testStarted(TeamCityPrefix, name)43      fun testStarted(prefix: String, name: String): TeamCityMessageBuilder {44         return TeamCityMessageBuilder(prefix, Messages.TEST_STARTED).addAttribute(Attributes.NAME, name)45      }46      fun testFinished(name: String): TeamCityMessageBuilder = testFinished(TeamCityPrefix, name)47      fun testFinished(prefix: String, name: String): TeamCityMessageBuilder {48         return TeamCityMessageBuilder(prefix, Messages.TEST_FINISHED).addAttribute(Attributes.NAME, name)49      }50      fun testStdOut(name: String): TeamCityMessageBuilder = testStdOut(TeamCityPrefix, name)51      fun testStdOut(prefix: String, name: String): TeamCityMessageBuilder {52         return TeamCityMessageBuilder(prefix, Messages.TEST_STD_OUT).addAttribute(Attributes.NAME, name)53      }54      fun testStdErr(name: String): TeamCityMessageBuilder = testStdErr(TeamCityPrefix, name)55      fun testStdErr(prefix: String, name: String): TeamCityMessageBuilder {56         return TeamCityMessageBuilder(prefix, Messages.TEST_STD_ERR).addAttribute(Attributes.NAME, name)57      }58      // note it seems that not attaching a message renders test failed irrelevant59      fun testFailed(name: String): TeamCityMessageBuilder = testFailed(TeamCityPrefix, name)60      // note it seems that not attaching a message renders test failed irrelevant61      fun testFailed(prefix: String, name: String): TeamCityMessageBuilder {62         return TeamCityMessageBuilder(prefix, Messages.TEST_FAILED).addAttribute(Attributes.NAME, name)63      }64      fun testIgnored(name: String): TeamCityMessageBuilder = testIgnored(TeamCityPrefix, name)65      fun testIgnored(prefix: String, name: String): TeamCityMessageBuilder {66         return TeamCityMessageBuilder(prefix, Messages.TEST_IGNORED).addAttribute(Attributes.NAME, name)67      }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   }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   }134   fun duration(duration: Duration): TeamCityMessageBuilder =135      addAttribute(Attributes.DURATION, duration.inWholeMilliseconds.toString())136   /**137    * Returns the completed string.138    */139   fun build(): String = "$myText]"140   fun timestamp(ts: String) = addAttribute(Attributes.TIMESTAMP, ts)141}...

escapeColons

Using AI Code Generation

1val message = TeamCityMessageBuilder.escapeColons("message with : in it")2val message = TeamCityMessageBuilder.escapePipes("message with | in it")3val message = TeamCityMessageBuilder.escapeLineBreaks("message with4val message = TeamCityMessageBuilder.escapeLineBreaks("message with \r in it")5val message = TeamCityMessageBuilder.escapeLineBreaks("message with \r6val message = TeamCityMessageBuilder.escapeLineBreaks("message with \u0085 in it")7val message = TeamCityMessageBuilder.escapeLineBreaks("message with \u2028 in it")8val message = TeamCityMessageBuilder.escapeLineBreaks("message with \u2029 in it")9val message = TeamCityMessageBuilder.escapeLineBreaks("message with \u000C in it")10val message = TeamCityMessageBuilder.escapeLineBreaks("message with \u000B in it")11val message = TeamCityMessageBuilder.escapeLineBreaks("message with \u000B in it")12val message = TeamCityMessageBuilder.escapeLineBreaks("message with \u000B in it")

escapeColons

Using AI Code Generation

1val teamCityMessageBuilder = TeamCityMessageBuilder()2val message = teamCityMessageBuilder.escapeColons("some message")3val teamCityMessageBuilder = TeamCityMessageBuilder()4val message = teamCityMessageBuilder.escapePipes("some message")5val teamCityMessageBuilder = TeamCityMessageBuilder()6val message = teamCityMessageBuilder.escapePipes("some message")7val teamCityMessageBuilder = TeamCityMessageBuilder()8val message = teamCityMessageBuilder.escapePipes("some message")9val teamCityMessageBuilder = TeamCityMessageBuilder()10val message = teamCityMessageBuilder.escapePipes("some message")11val teamCityMessageBuilder = TeamCityMessageBuilder()12val message = teamCityMessageBuilder.escapePipes("some message")13val teamCityMessageBuilder = TeamCityMessageBuilder()14val message = teamCityMessageBuilder.escapePipes("some message")15val teamCityMessageBuilder = TeamCityMessageBuilder()16val message = teamCityMessageBuilder.escapePipes("some message")17val teamCityMessageBuilder = TeamCityMessageBuilder()18val message = teamCityMessageBuilder.escapePipes("some message")19val teamCityMessageBuilder = TeamCityMessageBuilder()20val message = teamCityMessageBuilder.escapePipes("some message")21val teamCityMessageBuilder = TeamCityMessageBuilder()22val message = teamCityMessageBuilder.escapePipes("some message")

escapeColons

Using AI Code Generation

1val message = TeamCityMessageBuilder.escapeColons("some text with : in the middle")2val message = TeamCityMessageBuilder.escapePipes("some text with | in the middle")3val message = TeamCityMessageBuilder.escapePipes("some text with | in the middle")4val message = TeamCityMessageBuilder.escapePipes("some text with | in the middle")5val message = TeamCityMessageBuilder.escapePipes("some text with | in the middle")6val message = TeamCityMessageBuilder.escapePipes("some text with | in the middle")7val message = TeamCityMessageBuilder.escapePipes("some text with | in the middle")8val message = TeamCityMessageBuilder.escapePipes("some text with | in the middle")9val message = TeamCityMessageBuilder.escapePipes("some text with | in the middle")10val message = TeamCityMessageBuilder.escapePipes("some text with | in the middle")11val message = TeamCityMessageBuilder.escapePipes("some text with | in the middle")12val message = TeamCityMessageBuilder.escapePipes("some text with | in the middle")

escapeColons

Using AI Code Generation

1val message = TeamCityMessageBuilder.escapeColons("some:colon:separated:string")2val message = TeamCityMessageBuilder.escapePipes("some|pipe|separated|string")3val message = TeamCityMessageBuilder.escapeSquareBrackets("some[bracket]separated[string]")4val message = TeamCityMessageBuilder.escapeAmpersands("some&ampersand&separated&string")5val message = TeamCityMessageBuilder.escapeLineBreaks("some6val message = TeamCityMessageBuilder.escape("some7val message = TeamCityMessageBuilder.message("some8val message = TeamCityMessageBuilder.testStarted("some9val message = TeamCityMessageBuilder.testFinished("some10val message = TeamCityMessageBuilder.testIgnored("some11val message = TeamCityMessageBuilder.testFailed("some12val message = TeamCityMessageBuilder.testStdOut("some

escapeColons

Using AI Code Generation

1val message = TeamCityMessageBuilder.escapeColons("message with :colon: in it")2val message = TeamCityMessageBuilder.escapePipes("message with |pipe| in it")3val message = TeamCityMessageBuilder.escapeQuotes("message with \"quotes\" in it")4val message = TeamCityMessageBuilder.escapeLineBreaks("message with5val message = TeamCityMessageBuilder.escape("message with :colon: |pipe| \"quotes\" and6val message = TeamCityMessageBuilder.escape("message with :colon: |pipe| \"quotes\" and7val message = TeamCityMessageBuilder.escape("message with :colon: |pipe| \"quotes\" and8val message = TeamCityMessageBuilder.escape("message with :colon: |pipe| \"quotes\" and

escapeColons

Using AI Code Generation

1val teamCityMessageBuilder = TeamCityMessageBuilder()2val escapedTestName = teamCityMessageBuilder.escapeColons(testName)3val testDescription = TestDescription.fromSpecAndTest(spec::class, testName)4val testPath = testDescription.path()5val testPath = "${spec::class.simpleName}.$testName"6val testDescription = TestDescription.fromSpecAndTest(spec::class, testName)7val testPath = testDescription.path()8val testPath = "${spec::class.simpleName}.$testName"9val testDescription = TestDescription.fromSpecAndTest(spec::class, testName)10val testPath = testDescription.path()11val testPath = "${spec::class.simpleName}.$testName"12val testDescription = TestDescription.fromSpecAndTest(spec::class, testName)13val testPath = testDescription.path()14val testPath = "${spec::class.simpleName}.$testName"15val testDescription = TestDescription.fromSpecAndTest(spec::class, testName)16val testPath = testDescription.path()17val testPath = "${spec::class.simpleName}.$testName"18val testDescription = TestDescription.fromSpecAndTest(spec::class, testName)19val testPath = testDescription.path()20val testPath = "${spec::class.simpleName}.$testName"21val testDescription = TestDescription.fromSpecAndTest(spec::class, testName)22val testPath = testDescription.path()23val testPath = "${spec::class.simpleName}.$testName"24val testDescription = TestDescription.fromSpecAndTest(spec::class, testName)25val testPath = testDescription.path()

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.