Adds Testcontainers support for kotest(kotlintest) by ashishkujoy · Pull Request #2533 · testcontainers/testcontainers-java

ashishkujoy · 2020-04-06T19:38:30Z

Kotest previously known kotlintest is a widely used test framework for kotlin. This commit add test container support for kotest by providing TestListeners implementation to hookup test container with test lifecycle.

ashishkujoy · 2020-04-09T22:26:37Z

@rnorth @bsideup @kiview Any feedback on this pull request?

modules/kotest/src/main/kotlin/org/testcontainers/containers/ContainerPerTestListener.kt

modules/kotest/src/main/kotlin/org/testcontainers/containers/ContainerPerSpecListener.kt

…r from java docs comment

… in examples/kotest module

.../examples/kotest/src/test/kotlin/com/example/kotest/TestContainerKotestIntegrationPerTest.kt

.../examples/kotest/src/test/kotlin/com/example/kotest/TestcontainerKotestIntegrationPerSpec.kt

modules/kotest/build.gradle

modules/kotest/src/main/kotlin/org/testcontainers/containers/ContainerPerTestListener.kt

modules/kotest/src/test/kotlin/org/testcontainers/containers/ContainerPerSpecListenerTest.kt

docs/examples/kotest/build.gradle

…r creating listener from container

...otest/src/test/kotlin/org/testcontainers/containers/TestcontainerKotestIntegrationPerSpec.kt

modules/kotest/src/main/kotlin/org/testcontainers/containers/StartablePerSpecListener.kt

modules/kotest/src/main/kotlin/org/testcontainers/containers/StartablePerTestListener.kt

...otest/src/test/kotlin/org/testcontainers/containers/TestContainerKotestIntegrationPerTest.kt

…rSpecListener as that causes compilation errors

…and start-stop startable in IO coroutine context

modules/kotest/src/main/kotlin/org/testcontainers/containers/Extensions.kt

…s in per test listener

bsideup · 2020-04-21T15:18:48Z

modules/kotest/src/main/kotlin/org/testcontainers/containers/StartablePerSpecListener.kt

+internal class StartablePerSpecListener(private val startable: Startable) : TestListener {
+    override suspend fun beforeSpec(spec: Spec) {
+        withContext(Dispatchers.IO) {
+            startable.start()


TestLifecycleAware support is still missing...

TestLifecycleAware has two methods beforeTest and afterTest, as whereas SpecListener are for runnig before and after the entire spec(Test class). Thats the reason i have not added it there.

please see other integrations

@ashishkujoy As I understand it, if the startable is a TestLifecycleAware, then we should call beforeTest and afterTest on it, as the container may need to do "other things" between tests, even if we're registering it on the spec (class) level.

The documentation needs to be corrected:
This should be use when you want to a single container for all test in a single test class.
to
This listener should be used when you want to use a single container for all tests in a single spec class.

@sksamuel That would be difficult because the before and after test functions in TestLifecylceAware takes TestDescription as parameter which in itself needs testId and testName and these informations are not present in Spec class which we receive in beforeSpec and afterSpec callback.

You could store them in a variable in the beforeSpec callback.

support added

@ashishkujoy please do not resolve conversations started by others. e.g. this one remains unresolved, in fact.

That would be difficult because the before and after test functions in TestLifecylceAware takes TestDescription as parameter which in itself needs testId and testName and these informations are not present in Spec class which we receive in beforeSpec and afterSpec callback.

something to improve in kotest? Other test frameworks don't have this problem.

modules/kotest/src/main/kotlin/org/testcontainers/containers/StartablePerTestListener.kt

bsideup · 2020-04-21T15:19:57Z

modules/kotest/src/main/kotlin/org/testcontainers/containers/StartablePerTestListener.kt

+private fun TestCase.toTestDescription() = object : TestDescription {
+
+    override fun getFilesystemFriendlyName(): String {
+        return name.replace(" ", "-")


what if name contains /, .. or similar characters?

For what purpose this FilesystemFriendlyName is used for?

e.g. for writing video recordings captured from running a Chrome instance in the Selenium module

Will encoding the name will be ok like in SpockTestDescription?

testcontainers-java/modules/spock/src/main/groovy/org/testcontainers/spock/SpockTestDescription.groovy

Lines 30 to 35 in 9c4756f

@Override

String getFilesystemFriendlyName() {

return [specName, featureName].collect {

URLEncoder.encode(it, 'UTF-8')

}.join('-')

}

modules/kotest/src/test/kotlin/org/testcontainers/containers/TestLifecycleAwareTest.kt

sksamuel · 2020-04-25T04:34:11Z

How close are we on this PR? I'd love to start using it. At the moment I'm having to roll my own support.

…tartable is not of type TestLifeCycleAware

ashishkujoy · 2020-04-27T18:09:14Z

@bsideup could you please let me know what else we need to improve in this pull request

rnorth · 2020-05-01T18:27:09Z

@ashishkujoy please hold tight; as you can see we have quite a few other PRs to review. Also this one needs more careful consideration than most: adding a new language to our build is not a small thing for those of us who will have to maintain it.

We'll get back to you!

ashishkujoy · 2020-05-01T19:45:18Z

@ashishkujoy please hold tight; as you can see we have quite a few other PRs to review. Also this one needs more careful consideration than most: adding a new language to our build is not a small thing for those of us who will have to maintain it.

We'll get back to you!

Agreed, thanks for reply.

araujogo · 2020-05-22T00:12:41Z

Looking forward to use this as my colleagues and I are migrating all of our services to kotlin and using kotest. I suggest giving this PR an extra attention as it`s a switch that would give support to lots of kotlin devs, of a very increasing community

bsideup · 2020-05-22T07:14:48Z

@araujogo FTR, there is nothing that prevents you from using Testcontainers with kotest straight away. In fact, in the current form, it is just a couple of lines.

As per @rnorth's comment, we're still evaluating how to proceed, stay tuned.

ashishkujoy · 2020-06-07T08:04:57Z

Closing this pull request as we have now merged the kotest-extensions-testcontainers support in Kotest repository. Thanks @bsideup @kiview @sksamuel for your valuable guidance in this pull request.

kiview · 2020-06-07T08:12:16Z

Thanks @ashishkujoy, very happy to see the implementation in Kotest repository.

bsideup · 2020-06-07T09:14:10Z

@ashishkujoy wow, very cool! I believe keeping it closer to the framework will allow you to have it very aligned with framework's ideas and future new APIs 👍

sksamuel · 2020-06-07T09:29:37Z

Should we open a pr to add a link in the docs?

…

On Sun, 7 Jun 2020, 04:14 Sergei Egorov, ***@***.***> wrote: @ashishkujoy <https://github.com/ashishkujoy> wow, very cool! I believe keeping it closer to the framework will allow you to have it very aligned with framework's ideas and future new APIs 👍 — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2533 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAFVSGRYNQPMKNIK4ZFPEVDRVNK65ANCNFSM4MCRL7IQ> .

ashishkujoy requested review from bsideup, kiview and rnorth as code owners April 6, 2020 19:38

ashishkujoy mentioned this pull request Apr 6, 2020

#1353 Adds pertest and perspec listener for testcontainers kotest/kotest#1360

Closed

bsideup changed the title ~~Adds TestContainer support for kotest(kotlintest)~~ Adds Testcontainers support for kotest(kotlintest) Apr 7, 2020

sksamuel mentioned this pull request Apr 11, 2020

Integration with Testcontainers kotest/kotest#1353

Closed

kiview reviewed Apr 17, 2020

View reviewed changes

modules/kotest/src/main/kotlin/org/testcontainers/containers/ContainerPerTestListener.kt Outdated Show resolved Hide resolved

modules/kotest/src/main/kotlin/org/testcontainers/containers/ContainerPerSpecListener.kt Outdated Show resolved Hide resolved

ashishkujoy added 5 commits April 17, 2020 21:38

Adds TestContainer support in kotest

cd4781b

Upgrades kotest to latest 4.0.3

9571cf6

Removes usage of ContainerPerSpecListener and ContainerPerSpecListene…

b45b02c

…r from java docs comment

Adds example of ContainerPerSpecListener and ContainerPerSpecListener…

ccabb4d

… in examples/kotest module

Moves kotest examples to docs

9f33df6

bsideup reviewed Apr 19, 2020

View reviewed changes

.../examples/kotest/src/test/kotlin/com/example/kotest/TestContainerKotestIntegrationPerTest.kt Outdated Show resolved Hide resolved

bsideup reviewed Apr 19, 2020

View reviewed changes

.../examples/kotest/src/test/kotlin/com/example/kotest/TestContainerKotestIntegrationPerTest.kt Outdated Show resolved Hide resolved

bsideup reviewed Apr 19, 2020

View reviewed changes

.../examples/kotest/src/test/kotlin/com/example/kotest/TestcontainerKotestIntegrationPerSpec.kt Outdated Show resolved Hide resolved

bsideup reviewed Apr 19, 2020

View reviewed changes

modules/kotest/build.gradle Outdated Show resolved Hide resolved

bsideup reviewed Apr 19, 2020

View reviewed changes

modules/kotest/src/main/kotlin/org/testcontainers/containers/ContainerPerTestListener.kt Outdated Show resolved Hide resolved

bsideup reviewed Apr 19, 2020

View reviewed changes

modules/kotest/src/test/kotlin/org/testcontainers/containers/ContainerPerSpecListenerTest.kt Outdated Show resolved Hide resolved

bsideup reviewed Apr 19, 2020

View reviewed changes

docs/examples/kotest/build.gradle Outdated Show resolved Hide resolved

ashishkujoy added 2 commits April 19, 2020 18:01

Removes kotest from docs, renames listener, add extension function fo…

0d312ce

…r creating listener from container

Removes mockk dependency

2e7bb58

bsideup reviewed Apr 21, 2020

View reviewed changes

...otest/src/test/kotlin/org/testcontainers/containers/TestcontainerKotestIntegrationPerSpec.kt Outdated Show resolved Hide resolved

bsideup reviewed Apr 21, 2020

View reviewed changes

modules/kotest/src/main/kotlin/org/testcontainers/containers/StartablePerSpecListener.kt Outdated Show resolved Hide resolved

bsideup reviewed Apr 21, 2020

View reviewed changes

modules/kotest/src/main/kotlin/org/testcontainers/containers/StartablePerSpecListener.kt Outdated Show resolved Hide resolved

bsideup reviewed Apr 21, 2020

View reviewed changes

modules/kotest/src/main/kotlin/org/testcontainers/containers/StartablePerSpecListener.kt Outdated Show resolved Hide resolved

bsideup reviewed Apr 21, 2020

View reviewed changes

modules/kotest/src/main/kotlin/org/testcontainers/containers/StartablePerSpecListener.kt Outdated Show resolved Hide resolved

bsideup reviewed Apr 21, 2020

View reviewed changes

modules/kotest/src/main/kotlin/org/testcontainers/containers/StartablePerTestListener.kt Outdated Show resolved Hide resolved

bsideup reviewed Apr 21, 2020

View reviewed changes

...otest/src/test/kotlin/org/testcontainers/containers/TestContainerKotestIntegrationPerTest.kt Outdated Show resolved Hide resolved

Removes delay between test and use alpine image for containers

b75fcc3

ashishkujoy added 6 commits April 21, 2020 15:15

Makes StartablePerSpecListener and StartablePerTestListener as private

636567a

Removes private keyword from StartablePerSpecListener and StartablePe…

fbfecb3

…rSpecListener as that causes compilation errors

Replace container based test with mock implementation of startable

3bfdc06

Fixes failing test

e9b3a61

Makes StartablePerSpecListener and StartablePerTestListener internal …

14c514c

…and start-stop startable in IO coroutine context

Adds support for TestLifecycleAware

4d93f7d

bsideup reviewed Apr 21, 2020

View reviewed changes

modules/kotest/src/main/kotlin/org/testcontainers/containers/Extensions.kt Outdated Show resolved Hide resolved

ashishkujoy added 2 commits April 21, 2020 20:42

Removes TestLifecycleAwareListener and call TestLifecycleAware method…

f03e1c1

…s in per test listener

Updates doc

38b6862

bsideup reviewed Apr 21, 2020

View reviewed changes

modules/kotest/src/main/kotlin/org/testcontainers/containers/StartablePerTestListener.kt Outdated Show resolved Hide resolved

bsideup reviewed Apr 21, 2020

View reviewed changes

modules/kotest/src/test/kotlin/org/testcontainers/containers/TestLifecycleAwareTest.kt Outdated Show resolved Hide resolved

ashishkujoy added 2 commits April 21, 2020 21:58

Adds test around test descriptor name

5572b99

Encode test name to make it filesystemFriendlyName and updates docs

439876a

ashishkujoy added 3 commits April 25, 2020 14:50

Moves TestLifecycleAwareListener in a separate file

2bd5127

Adds TestLifecycleAware support in StartablePerSpecListener

cf4b30b

Adds a test to verify TestLifecycleAwareListener does not fail when s…

64eda9f

…tartable is not of type TestLifeCycleAware

ashishkujoy closed this Jun 7, 2020

LeoColman mentioned this pull request Apr 19, 2023

Add new section for test integrations #6930

Merged

	@Override
	String getFilesystemFriendlyName() {
	return [specName, featureName].collect {
	URLEncoder.encode(it, 'UTF-8')
	}.join('-')
	}

Uh oh!

Conversation

ashishkujoy commented Apr 6, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ashishkujoy commented Apr 9, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sksamuel Apr 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ashishkujoy Apr 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bsideup May 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sksamuel commented Apr 25, 2020

Uh oh!

ashishkujoy commented Apr 27, 2020

Uh oh!

rnorth commented May 1, 2020

Uh oh!

ashishkujoy commented May 1, 2020

Uh oh!

araujogo commented May 22, 2020

Uh oh!

bsideup commented May 22, 2020

Uh oh!

ashishkujoy commented Jun 7, 2020

Uh oh!

kiview commented Jun 7, 2020

Uh oh!

bsideup commented Jun 7, 2020

Uh oh!

sksamuel commented Jun 7, 2020 via email

Uh oh!

ashishkujoy commented Apr 6, 2020 •

edited

Loading

sksamuel Apr 21, 2020 •

edited

Loading

ashishkujoy Apr 21, 2020 •

edited

Loading

bsideup May 22, 2020 •

edited

Loading