Teardown not invoked on Ctrl-C / SIGINT

[mwisnicki]

Originally reported as typelevel/munit-cats-effect#467

Looks like FunFixture.async teardown is not invoked when tests are interrupted with Ctrl-C or SIGINT

build.sbt

scalaVersion := "3.8.1"
libraryDependencies ++= Seq(
  "org.scalameta" %% "munit" % "1.2.1" % Test,
)
Test / fork := true // needed for Ctrl-C to gracefully terminate tests

src/test/scala/FunFixtureAsyncTest.scala

import munit.FunSuite
import scala.concurrent.Future

class FunFixtureAsyncTest extends FunSuite {

  val fixture = FunFixture.async[Unit](
    setup = { testOptions =>
      println("setup")
      Future.successful(())
    },
    teardown = { _ =>
      println("teardown")
      Future.successful(())
    }
  )

  fixture.test("async fixture test") { _ =>
    println("running test")
    Thread.sleep(5000)
    Future.successful {
      assert(true)
    }
  }
}

sbt "testOnly FunFixtureAsyncTest" and press Ctrl-C when sleeping

Result:

setup
running test
^C
[warn] Canceling execution...
Cancelled: testOnly FunFixtureAsyncTest
[error] Cancelled: testOnly FunFixtureAsyncTest

[kitbellew]

i think that sbt simply kills the process when you press ctrl-c, it doesn't communicate any graceful interrupt messages.

i think a reasonable solution, if you want teardown to run, is to register your own shutdown hook and make sure it doesn't deadlock.

otherwise, munit would have to trust that your teardown is safe, to register a shutdown hook for it, which is not really an assumption it's free to make.

also, what to do about afterEach and afterAll?

[mwisnicki]

Shutdown hook would also not run in such case but it does. The process is shutdown gracefully.

[mwisnicki]

After hooks should still run since that's where resource cleanup could be but worth checking what JUnit does in such case.

[mwisnicki]

OTOH tearing down all resources might be too expensive and unnecessary but IOApp does the same