Fixed spec lifecycle ordering for JS #3602

sksamuel · 2023-07-29T23:53:38Z

OliverO2 · 2023-08-10T10:49:58Z

I have extended your test so that it will additionally cover an extension configured project-wide and case-specific (the latter configured differently, intended to override the project-wide setting) . This currently fails on the Jvm, as the case-specific extension will wrap the project-level extension.

Here's the modified code for LifecycleOrderTest.kt:

package com.sksamuel.kotest.engine

import io.kotest.core.extensions.ProjectExtension
import io.kotest.core.extensions.SpecExtension
import io.kotest.core.extensions.TestCaseExtension
import io.kotest.core.project.ProjectContext
import io.kotest.core.spec.Spec
import io.kotest.core.spec.style.FunSpec
import io.kotest.core.test.TestCase
import io.kotest.core.test.TestResult
import io.kotest.engine.TestEngineLauncher
import io.kotest.engine.listener.CollectingTestEngineListener
import io.kotest.matchers.shouldBe

class LifecycleOrderTest : FunSpec() {
   init {

      test("project, spec and test interceptors should wrap each other") {
         val collector = CollectingTestEngineListener()
         TestEngineLauncher(collector)
            .withClasses(LifecycleTests::class)
            .withExtensions(LifecycleExtension("project"))
            .launch()
         collector.names shouldBe listOf("foo", "bar")
         LifecycleExtension.state shouldBe listOf(
            Triple("project", Lifecycle.PROJECT, Phase.ENTRY),
            Triple("project", Lifecycle.SPEC, Phase.ENTRY),
            Triple("project", Lifecycle.TEST_CASE, Phase.ENTRY),
            Triple("project", Lifecycle.TEST_CASE, Phase.EXIT),
            Triple("project", Lifecycle.TEST_CASE, Phase.ENTRY),
            Triple("bar", Lifecycle.TEST_CASE, Phase.ENTRY),
            Triple("bar", Lifecycle.TEST_CASE, Phase.EXIT),
            Triple("project", Lifecycle.TEST_CASE, Phase.EXIT),
            Triple("project", Lifecycle.SPEC, Phase.EXIT),
            Triple("project", Lifecycle.PROJECT, Phase.EXIT),
         )
      }
   }
}

private class LifecycleTests : FunSpec() {
   init {
      test("foo") {}
      test("bar").config(extensions = listOf(LifecycleExtension("bar"))) {}
   }
}

enum class Lifecycle {
   PROJECT,
   SPEC,
   TEST_CASE
}

enum class Phase {
   ENTRY,
   EXIT
}

class LifecycleExtension(val name: String) : ProjectExtension, SpecExtension, TestCaseExtension {

   companion object {
      val state = mutableListOf<Triple<String, Lifecycle, Phase>>()
   }

   override suspend fun interceptProject(context: ProjectContext, callback: suspend (ProjectContext) -> Unit) {
      state.add(Triple(name, Lifecycle.PROJECT, Phase.ENTRY))
      callback(context)
      state.add(Triple(name, Lifecycle.PROJECT, Phase.EXIT))
   }

   override suspend fun intercept(spec: Spec, execute: suspend (Spec) -> Unit) {
      state.add(Triple(name, Lifecycle.SPEC, Phase.ENTRY))
      execute(spec)
      state.add(Triple(name, Lifecycle.SPEC, Phase.EXIT))
   }

   override suspend fun intercept(testCase: TestCase, execute: suspend (TestCase) -> TestResult): TestResult {
      state.add(Triple(name, Lifecycle.TEST_CASE, Phase.ENTRY))
      val result = execute(testCase)
      state.add(Triple(name, Lifecycle.TEST_CASE, Phase.EXIT))
      return result
   }
}

This produces:

Element differ at index: [4, 5, 6, 7]
expected:<[(project, PROJECT, ENTRY), (project, SPEC, ENTRY), (project, TEST_CASE, ENTRY), (project, TEST_CASE, EXIT), (project, TEST_CASE, ENTRY), (bar, TEST_CASE, ENTRY), (bar, TEST_CASE, EXIT), (project, TEST_CASE, EXIT), (project, SPEC, EXIT), (project, PROJECT, EXIT)]> but was:<[(project, PROJECT, ENTRY), (project, SPEC, ENTRY), (project, TEST_CASE, ENTRY), (project, TEST_CASE, EXIT), (bar, TEST_CASE, ENTRY), (project, TEST_CASE, ENTRY), (project, TEST_CASE, EXIT), (bar, TEST_CASE, EXIT), (project, SPEC, EXIT), (project, PROJECT, EXIT)]>

) The test is actually Sam's work (kotest#3602), which I shamelessly copied and adapted for this issue's purpose.

…3614) The test is actually Sam's work (#3602), which I shamelessly copied and adapted for this issue's purpose. Co-authored-by: Sam <sam@sksamuel.com>

sksamuel · 2023-08-30T00:21:21Z

I have extended your test so that it will additionally cover an extension configured project-wide and case-specific (the latter configured differently, intended to override the project-wide setting) . This currently fails on the Jvm, as the case-specific extension will wrap the project-level extension.

Here's the modified code for LifecycleOrderTest.kt:

package com.sksamuel.kotest.engine

import io.kotest.core.extensions.ProjectExtension
import io.kotest.core.extensions.SpecExtension
import io.kotest.core.extensions.TestCaseExtension
import io.kotest.core.project.ProjectContext
import io.kotest.core.spec.Spec
import io.kotest.core.spec.style.FunSpec
import io.kotest.core.test.TestCase
import io.kotest.core.test.TestResult
import io.kotest.engine.TestEngineLauncher
import io.kotest.engine.listener.CollectingTestEngineListener
import io.kotest.matchers.shouldBe

class LifecycleOrderTest : FunSpec() {
   init {

      test("project, spec and test interceptors should wrap each other") {
         val collector = CollectingTestEngineListener()
         TestEngineLauncher(collector)
            .withClasses(LifecycleTests::class)
            .withExtensions(LifecycleExtension("project"))
            .launch()
         collector.names shouldBe listOf("foo", "bar")
         LifecycleExtension.state shouldBe listOf(
            Triple("project", Lifecycle.PROJECT, Phase.ENTRY),
            Triple("project", Lifecycle.SPEC, Phase.ENTRY),
            Triple("project", Lifecycle.TEST_CASE, Phase.ENTRY),
            Triple("project", Lifecycle.TEST_CASE, Phase.EXIT),
            Triple("project", Lifecycle.TEST_CASE, Phase.ENTRY),
            Triple("bar", Lifecycle.TEST_CASE, Phase.ENTRY),
            Triple("bar", Lifecycle.TEST_CASE, Phase.EXIT),
            Triple("project", Lifecycle.TEST_CASE, Phase.EXIT),
            Triple("project", Lifecycle.SPEC, Phase.EXIT),
            Triple("project", Lifecycle.PROJECT, Phase.EXIT),
         )
      }
   }
}

private class LifecycleTests : FunSpec() {
   init {
      test("foo") {}
      test("bar").config(extensions = listOf(LifecycleExtension("bar"))) {}
   }
}

enum class Lifecycle {
   PROJECT,
   SPEC,
   TEST_CASE
}

enum class Phase {
   ENTRY,
   EXIT
}

class LifecycleExtension(val name: String) : ProjectExtension, SpecExtension, TestCaseExtension {

   companion object {
      val state = mutableListOf<Triple<String, Lifecycle, Phase>>()
   }

   override suspend fun interceptProject(context: ProjectContext, callback: suspend (ProjectContext) -> Unit) {
      state.add(Triple(name, Lifecycle.PROJECT, Phase.ENTRY))
      callback(context)
      state.add(Triple(name, Lifecycle.PROJECT, Phase.EXIT))
   }

   override suspend fun intercept(spec: Spec, execute: suspend (Spec) -> Unit) {
      state.add(Triple(name, Lifecycle.SPEC, Phase.ENTRY))
      execute(spec)
      state.add(Triple(name, Lifecycle.SPEC, Phase.EXIT))
   }

   override suspend fun intercept(testCase: TestCase, execute: suspend (TestCase) -> TestResult): TestResult {
      state.add(Triple(name, Lifecycle.TEST_CASE, Phase.ENTRY))
      val result = execute(testCase)
      state.add(Triple(name, Lifecycle.TEST_CASE, Phase.EXIT))
      return result
   }
}

This produces:

Element differ at index: [4, 5, 6, 7]
expected:<[(project, PROJECT, ENTRY), (project, SPEC, ENTRY), (project, TEST_CASE, ENTRY), (project, TEST_CASE, EXIT), (project, TEST_CASE, ENTRY), (bar, TEST_CASE, ENTRY), (bar, TEST_CASE, EXIT), (project, TEST_CASE, EXIT), (project, SPEC, EXIT), (project, PROJECT, EXIT)]> but was:<[(project, PROJECT, ENTRY), (project, SPEC, ENTRY), (project, TEST_CASE, ENTRY), (project, TEST_CASE, EXIT), (bar, TEST_CASE, ENTRY), (project, TEST_CASE, ENTRY), (project, TEST_CASE, EXIT), (bar, TEST_CASE, EXIT), (project, SPEC, EXIT), (project, PROJECT, EXIT)]>

Can you confirm that this does actually pass on the JVM because I can't get it to fail.

OliverO2 · 2023-08-30T14:24:22Z

Can you confirm that this does actually pass on the JVM because I can't get it to fail.

Took master as of commit c043f69 (plus "Refactor concurrency" PR), ran LifecycleOrderTest on JVM -> passed.

Then reverted the change of TestExtensions.kt from commit cfc45be, ran LifecycleOrderTest on JVM -> failed:

Element differ at index: [4, 5, 6, 7]
expected:<[(project, PROJECT, ENTRY), (project, SPEC, ENTRY), (project, TEST_CASE, ENTRY), (project, TEST_CASE, EXIT), (project, TEST_CASE, ENTRY), (bar, TEST_CASE, ENTRY), (bar, TEST_CASE, EXIT), (project, TEST_CASE, EXIT), (project, SPEC, EXIT), (project, PROJECT, EXIT)]> but was:<[(project, PROJECT, ENTRY), (project, SPEC, ENTRY), (project, TEST_CASE, ENTRY), (project, TEST_CASE, EXIT), (bar, TEST_CASE, ENTRY), (project, TEST_CASE, ENTRY), (project, TEST_CASE, EXIT), (bar, TEST_CASE, EXIT), (project, SPEC, EXIT), (project, PROJECT, EXIT)]>

sksamuel · 2023-08-31T20:53:17Z

Ok great so my changes to the test executor ended up fixing his too (on JVM).

stale · 2024-03-17T14:16:14Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

sksamuel marked this pull request as draft July 29, 2023 23:53

OliverO2 mentioned this pull request Aug 10, 2023

Test-specific extension is overridden by project-level extention #3613

Closed

OliverO2 added a commit to OliverO2/kotest that referenced this pull request Aug 10, 2023

Fix extension processing order, prioritize test case config (kotest#3613

e111b9e

) The test is actually Sam's work (kotest#3602), which I shamelessly copied and adapted for this issue's purpose.

OliverO2 mentioned this pull request Aug 10, 2023

Fix extension processing order, prioritize test case config (#3613) #3614

Merged

sksamuel requested a review from Kantis August 27, 2023 18:40

sksamuel added 9 commits August 27, 2023 20:34

Fixed spec lifecycle ordering for JS

61f089b

Fix big decimal test

281bbc0

Disable caches and use kotlin 1.8.20

12826a7

Renabled js tests module

4d4ff3b

Updated common test tests

3361f6f

api dump

fe4ba58

Removed lifecycle test

400e144

Update order test

27f3edd

Added lifecycle order test

05a9ab8

sksamuel force-pushed the sks/3340 branch from 38f51dd to 05a9ab8 Compare August 28, 2023 01:35

Merge branch 'master' into sks/3340

a7a6c7e

sksamuel marked this pull request as ready for review August 28, 2023 01:51

Merge branch 'master' into sks/3340

cb606bb

Removed jvm only lifecycle test

bca69c6

Merge branch 'master' into sks/3340

34d81db

stale bot added the stale label Mar 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed spec lifecycle ordering for JS #3602

Fixed spec lifecycle ordering for JS #3602

sksamuel commented Jul 29, 2023

OliverO2 commented Aug 10, 2023

sksamuel commented Aug 30, 2023

OliverO2 commented Aug 30, 2023 •

edited

sksamuel commented Aug 31, 2023

stale bot commented Mar 17, 2024

Fixed spec lifecycle ordering for JS #3602

Are you sure you want to change the base?

Fixed spec lifecycle ordering for JS #3602

Conversation

sksamuel commented Jul 29, 2023

OliverO2 commented Aug 10, 2023

sksamuel commented Aug 30, 2023

OliverO2 commented Aug 30, 2023 • edited

sksamuel commented Aug 31, 2023

stale bot commented Mar 17, 2024

OliverO2 commented Aug 30, 2023 •

edited