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

How to use WordSpecShouldContainerScope class of io.kotest.core.spec.style.scopes package

Best Kotest code snippet using io.kotest.core.spec.style.scopes.WordSpecShouldContainerScope

SequenceMatchersTest.kt

Source:SequenceMatchersTest.kt

2import io.kotest.assertions.throwables.shouldThrow3import io.kotest.assertions.throwables.shouldThrowAny4import io.kotest.core.spec.style.WordSpec5import io.kotest.core.spec.style.scopes.WordSpecTerminalScope6import io.kotest.core.spec.style.scopes.WordSpecShouldContainerScope7import io.kotest.matchers.sequences.shouldBeLargerThan8import io.kotest.matchers.sequences.shouldBeSameCountAs9import io.kotest.matchers.sequences.shouldBeSmallerThan10import io.kotest.matchers.sequences.shouldBeSorted11import io.kotest.matchers.sequences.shouldBeSortedWith12import io.kotest.matchers.sequences.shouldBeUnique13import io.kotest.matchers.sequences.shouldContain14import io.kotest.matchers.sequences.shouldContainAll15import io.kotest.matchers.sequences.shouldContainAllInAnyOrder16import io.kotest.matchers.sequences.shouldContainDuplicates17import io.kotest.matchers.sequences.shouldContainExactly18import io.kotest.matchers.sequences.shouldContainInOrder19import io.kotest.matchers.sequences.shouldContainNoNulls20import io.kotest.matchers.sequences.shouldContainNull21import io.kotest.matchers.sequences.shouldContainOnlyNulls22import io.kotest.matchers.sequences.shouldExist23import io.kotest.matchers.sequences.shouldHaveAtLeastCount24import io.kotest.matchers.sequences.shouldHaveAtMostCount25import io.kotest.matchers.sequences.shouldHaveCount26import io.kotest.matchers.sequences.shouldHaveElementAt27import io.kotest.matchers.sequences.shouldHaveLowerBound28import io.kotest.matchers.sequences.shouldHaveSingleElement29import io.kotest.matchers.sequences.shouldHaveUpperBound30import io.kotest.matchers.sequences.shouldNotBeSorted31import io.kotest.matchers.sequences.shouldNotBeSortedWith32import io.kotest.matchers.sequences.shouldNotBeUnique33import io.kotest.matchers.sequences.shouldNotContain34import io.kotest.matchers.sequences.shouldNotContainAllInAnyOrder35import io.kotest.matchers.sequences.shouldNotContainExactly36import io.kotest.matchers.sequences.shouldNotContainNoNulls37import io.kotest.matchers.sequences.shouldNotContainNull38import io.kotest.matchers.sequences.shouldNotContainOnlyNulls39import io.kotest.matchers.sequences.shouldNotHaveCount40import io.kotest.matchers.sequences.shouldNotHaveElementAt41class SequenceMatchersTest : WordSpec() {42   /* PassFail */43   private suspend fun WordSpecShouldContainerScope.pass(name: String, test: suspend WordSpecTerminalScope.() -> Unit) {44      ("succeed $name")(test)45   }46   private suspend fun WordSpecShouldContainerScope.succeed(name: String, test: suspend WordSpecTerminalScope.() -> Unit) = pass(name, test)47   fun WordSpecShouldContainerScope.fail(msg: String): Nothing = io.kotest.assertions.fail(msg)48   suspend fun WordSpecShouldContainerScope.fail(name: String, test: () -> Any?) {49      ("fail $name") { shouldThrowAny(test) }50   }51   suspend inline fun <reified E : Throwable> WordSpecShouldContainerScope.abort(name: String, crossinline test: () -> Any?) {52      ("abort $name") { shouldThrow<E>(test) }53   }54   suspend inline fun <reified E : Throwable> WordSpecShouldContainerScope.`throw`(name: String, crossinline test: () -> Any?) = abort<E>(55      name,56      test)57   /* sample data */58   val empty = emptySequence<Int>()59   val single = sequenceOf(0)60   val nulls = sequenceOf<Int?>(null, null, null, null)61   val sparse = sequenceOf(null, null, null, 3)62   val countup = (0..10).asSequence()63   val countdown = (10 downTo 0).asSequence()64   val unique = sequenceOf(3, 2, 1)65   val repeating = sequenceOf(1, 2, 3, 1, 2, 3)66   val asc = { a: Int, b: Int -> a - b }67   val desc = { a: Int, b: Int -> b - a }68   /* tests */...

WordSpecShouldContainerScope.kt

Source:WordSpecShouldContainerScope.kt

...6import io.kotest.core.test.EnabledIf7import io.kotest.core.test.TestCaseSeverityLevel8import io.kotest.core.test.TestScope9import kotlin.time.Duration10@Deprecated("This interface has been renamed to WordSpecShouldContainerScope. Deprecated since 4.5")11typealias WordSpecShouldScope = WordSpecShouldContainerScope12@Deprecated("This interface has been renamed to WordSpecShouldContainerScope. Deprecated since 5.0")13typealias WordSpecShouldContainerContext = WordSpecShouldContainerScope14/**15 * A scope that allows tests to be registered using the syntax:16 *17 * "some context" { }18 *19 * or20 *21 * "some context".config(...) { }22 *23 */24@KotestTestScope25class WordSpecShouldContainerScope(26   val testScope: TestScope,27) : AbstractContainerScope(testScope) {28   suspend fun String.config(29      enabled: Boolean? = null,30      invocations: Int? = null,31      threads: Int? = null,32      tags: Set<Tag>? = null,33      timeout: Duration? = null,34      extensions: List<TestCaseExtension>? = null,35      enabledIf: EnabledIf? = null,36      invocationTimeout: Duration? = null,37      severity: TestCaseSeverityLevel? = null,38      blockingTest: Boolean? = null,39      test: suspend TestScope.() -> Unit40   ) {41      TestWithConfigBuilder(42         TestName(this),43         context = this@WordSpecShouldContainerScope,44         xdisabled = false,45      ).config(46         enabled = enabled,47         invocations = invocations,48         threads = threads,49         tags = tags,50         timeout = timeout,51         extensions = extensions,52         enabledIf = enabledIf,53         invocationTimeout = invocationTimeout,54         severity = severity,55         blockingTest = blockingTest,56         test = test57      )...

KlipOption.kt

Source:KlipOption.kt

...53                  "io.kotest.core.spec.style.scopes.FunSpecRootScope.test",54                  "io.kotest.core.spec.style.scopes.DescribeSpecContainerScope.it",55                  "io.kotest.core.spec.style.scopes.BehaviorSpecWhenContainerScope.Then",56                  "io.kotest.core.spec.style.scopes.BehaviorSpecWhenContainerScope.then",57                  "io.kotest.core.spec.style.scopes.WordSpecShouldContainerScope.invoke",58                  "io.kotest.core.spec.style.scopes.FreeSpecContainerScope.invoke",59                  "io.kotest.core.spec.style.scopes.FeatureSpecContainerScope.scenario",60                  "io.kotest.core.spec.style.scopes.ExpectSpecContainerScope.expect",61              ),62      )63}...

WordSpecExt.kt

Source:WordSpecExt.kt

...6import com.github.h0tk3y.betterParse.parser.toParsedOrThrow7import com.github.h0tk3y.betterParse.parser.tryParseToEnd8import io.kotest.assertions.throwables.shouldNotThrowAny9import io.kotest.assertions.throwables.shouldThrow10import io.kotest.core.spec.style.scopes.WordSpecShouldContainerScope11import io.kotest.matchers.equalityMatcher12import io.kotest.matchers.should13import io.kotest.matchers.shouldBe14import io.kotest.matchers.shouldNotHave15import ru.tesserakt.kodept.core.AST16import ru.tesserakt.kodept.core.convert17import ru.tesserakt.kodept.lexer.Lexer18suspend fun <T : Any, U : T> WordSpecShouldContainerScope.test(parser: Parser<T>, element: String, shouldParse: U?) =19    element.let {20        if (it.length > 20) "${it.take(20)}..." else it21    }.invoke {22        val lexer = Lexer()23        val tokens = lexer.tokenize(element)24        tokens shouldNotHave equalityMatcher(noneMatched)25        parser.tryParseToEnd(tokens, 0) should {26            when (shouldParse) {27                null -> shouldThrow<ParseException> { it.toParsedOrThrow() }28                else -> shouldNotThrowAny { it.toParsedOrThrow() }.value shouldBe shouldParse29            }30        }31    }32suspend fun <T : RLT.Node, V : AST.Node> WordSpecShouldContainerScope.test(33    parser: Parser<T>,34    element: String,35    shouldParse: V?,36) = test(parser.map(RLT.Node::convert).map { node ->37    fun AST.Node.dfs(f: (AST.Node) -> Unit) {38        val nodeList = ArrayDeque(listOf(this))39        while (nodeList.isNotEmpty()) {40            val current = nodeList.removeFirst()41            current.children().forEach { nodeList.addFirst(it) }42            f(current)43        }44    }45    node.dfs { it.metadata.clear() }46    node...

WordSpecWhenContainerScope.kt

Source:WordSpecWhenContainerScope.kt

...10@KotestTestScope11class WordSpecWhenContainerScope(12   val testScope: TestScope,13) : AbstractContainerScope(testScope) {14   suspend infix fun String.Should(test: suspend WordSpecShouldContainerScope.() -> Unit) = addShould(this, test, false)15   suspend infix fun String.should(test: suspend WordSpecShouldContainerScope.() -> Unit) = addShould(this, test, false)16   suspend infix fun String.xshould(test: suspend WordSpecShouldContainerScope.() -> Unit) = addShould(this, test, true)17   private suspend fun addShould(name: String, test: suspend WordSpecShouldContainerScope.() -> Unit, xdisabled: Boolean) {18      registerContainer(19         TestName(null, name, " should", true),20         xdisabled,21         null22      ) { WordSpecShouldContainerScope(this).test() }23   }24}...

WordSpecRootScope.kt

Source:WordSpecRootScope.kt

2import io.kotest.core.names.TestName3@Deprecated("Renamed to WordSpecRootContext. Deprecated since 5.0")4typealias WordSpecRootContext = WordSpecRootScope5interface WordSpecRootScope : RootScope {6   infix fun String.should(test: suspend WordSpecShouldContainerScope.() -> Unit) = addShould(this, false, test)7   infix fun String.xshould(test: suspend WordSpecShouldContainerScope.() -> Unit) = addShould(this, true, test)8   private fun addShould(name: String, disabled: Boolean, test: suspend WordSpecShouldContainerScope.() -> Unit) {9      addContainer(TestName(null, name, " should", true), disabled, null) { WordSpecShouldContainerScope(this).test() }10   }11   @Suppress("FunctionName")12   infix fun String.When(init: suspend WordSpecWhenContainerScope.() -> Unit) = addWhen(this, init)13   infix fun String.`when`(init: suspend WordSpecWhenContainerScope.() -> Unit) = addWhen(this, init)14   private fun addWhen(name: String, test: suspend WordSpecWhenContainerScope.() -> Unit) {15      addContainer(TestName(null, name, " when", true), false, null) { WordSpecWhenContainerScope(this).test() }16   }17}...

WordSpecShouldContainerScope

Using AI Code Generation

1import io.kotest.core.spec.style.scopes.WordSpecShouldContainerScope2class WordSpecShouldContainerScopeTest : WordSpec({3    "test" should {4        "test" {5        }6    }7})8import io.kotest.core.spec.style.scopes.WordSpecShouldTest9class WordSpecShouldTestTest : WordSpec({10    "test" should {11        "test" {12        }13    }14})15import io.kotest.core.spec.style.scopes.WordSpecTest16class WordSpecTestTest : WordSpec({17    "test" {18    }19})20import io.kotest.core.spec.style.scopes.WordSpecTestContext

WordSpecShouldContainerScope

Using AI Code Generation

1import io . kotest . core . spec . style . WordSpec2class WordSpecExample : WordSpec ({3"String.length" should {4"return the length of the string" {5}6}7"String.reverse" should {8"return the reversed string" {9"hello" . reversed () shouldBe "olleh"10}11}12})13import io . kotest . core . spec . style . FeatureSpec14class FeatureSpecExample : FeatureSpec ({15feature ( "String.length" ) {16scenario ( "return the length of the string" ) {17}18}19feature ( "String.reverse" ) {20scenario ( "return the reversed string" ) {21"hello" . reversed () shouldBe "olleh"22}23}24})25import io . kotest . core . spec . style . BehaviorSpec26class BehaviorSpecExample : BehaviorSpec ({27given ( "String.length" ) {28`when` ( "return the length of the string" ) {29}30}31given ( "String.reverse" ) {32`when` ( "return the reversed string" ) {33"hello" . reversed () shouldBe "olleh"34}35}36})37import io . kotest . core . spec . style . DescribeSpec38class DescribeSpecExample : DescribeSpec ({39describe ( "String.length" ) {40it ( "return the length of the string" ) {41}42}43describe ( "String.reverse" ) {44it ( "return the reversed string" ) {45"hello" . reversed () shouldBe "olleh"46}47}48})

WordSpecShouldContainerScope

Using AI Code Generation

1class WordSpecExampleTest : WordSpec({2"String.length" should {3"return the length of the string" {4"hello" should haveLength(5)5}6"return zero for an empty string" {7"" should haveLength(0)8}9}10})

WordSpecShouldContainerScope

Using AI Code Generation

1class WordSpecStyleTest : WordSpec({2    "A test" should {3        "do something" {4        }5    }6    "A test" When {7        "do something" {8        }9    }10})11class WordSpecStyleTest : WordSpec({12    "A test" should {13        "do something" {14        }15    }16    "A test" When {17        "do something" {18        }19    }20})21class WordSpecStyleTest : WordSpec({22    "A test" should {23        "do something" {24        }25    }26    "A test" When {27        "do something" {28        }29    }30})31class WordSpecStyleTest : WordSpec({32    "A test" should {33        "do something" {34        }35    }36    "A test" When {37        "do something" {38        }39    }40})41class WordSpecStyleTest : WordSpec({42    "A test" should {43        "do something" {44        }45    }46    "A test" When {47        "do something" {48        }49    }50})51class WordSpecStyleTest : WordSpec({52    "A test" should {53        "do something" {54        }55    }56    "A test" When {57        "do something" {

WordSpecShouldContainerScope

Using AI Code Generation

1class  WordSpecExample :  WordSpec ( )   { 2     init   { 3         "A string"   should   "start with the given prefix"   { 4             "kotest" . shouldStartWith ( "kot" ) 5         } 6     } 7 }8We can also use the should() method to create nested test cases. For example:9class  WordSpecExample :  WordSpec ( )   { 10     init   { 11         "A string"   should   "start with the given prefix"   { 12             "kotest" . shouldStartWith ( "kot" ) 13         } 14         "A string"   should   "end with the given suffix"   { 15             "kotest" . shouldEndWith ( "est" ) 16         } 17     } 18 }19The should() method can also be used to create a group of test cases. For example:20class  WordSpecExample :  WordSpec ( )   { 21     init   { 22         "A string"   should   { 23             "start with the given prefix"   { 24                 "kotest" . shouldStartWith ( "kot" ) 25             } 26             "end with the given suffix"   { 27                 "kotest" . shouldEndWith ( "est" ) 28             } 29         } 30     } 31 }

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.