如何在Kotlin中管理单元测试资源，例如启动/停止数据库连接或嵌入式Elasticsearch服务器？

在我的Kotlin JUnit测试中，我想启动/停止嵌入式服务器并在测试中使用它们。

我尝试@Before在测试类中的方法上使用JUnit批注，它可以正常工作，但这不是正确的行为，因为它运行每个测试用例，而不是运行一次。

因此，我想@BeforeClass在方法上使用批注，但是将其添加到方法中会导致错误，提示它必须在静态方法上。Kotlin似乎没有静态方法。然后，这同样适用于静态变量，因为我需要保留对嵌入式服务器的引用，以便在测试用例中使用。

那么，如何为所有测试用例一次创建一个嵌入式数据库？

class MyTest {
    @Before fun setup() {
       // works in that it opens the database connection, but is wrong 
       // since this is per test case instead of being shared for all
    }

    @BeforeClass fun setupClass() {
       // what I want to do instead, but results in error because 
       // this isn't a static method, and static keyword doesn't exist
    }

    var referenceToServer: ServerType // wrong because is not static either

    ...
}

注意： 这个问题是作者故意写和回答的（“自我回答的问题”），因此SO中提供了常见Kotlin主题的答案。

您的单元测试类通常需要一些东西来管理一组测试方法的共享资源。在Kotlin中，您可以使用@BeforeClass而@AfterClass不是在测试类中使用，而可以在其伴随对象以及@JvmStatic注释中使用。

测试类的结构如下所示：

class MyTestClass {
    companion object {
        init {
           // things that may need to be setup before companion class member variables are instantiated
        }

        // variables you initialize for the class just once:
        val someClassVar = initializer() 

        // variables you initialize for the class later in the @BeforeClass method:
        lateinit var someClassLateVar: SomeResource 

        @BeforeClass @JvmStatic fun setup() {
           // things to execute once and keep around for the class
        }

        @AfterClass @JvmStatic fun teardown() {
           // clean up after this class, leave nothing dirty behind
        }
    }

    // variables you initialize per instance of the test class:
    val someInstanceVar = initializer() 

    // variables you initialize per test case later in your @Before methods:
    var lateinit someInstanceLateZVar: MyType 

    @Before fun prepareTest() { 
        // things to do before each test
    }

    @After fun cleanupTest() {
        // things to do after each test
    }

    @Test fun testSomething() {
        // an actual test case
    }

    @Test fun testSomethingElse() {
        // another test case
    }

    // ...more test cases
}  

鉴于以上所述，您应该阅读以下内容：

• 随播对象-与Java中的Class对象类似，但是每个类的单例不是静态的
• @JvmStatic -一个注释，该注释在Java互操作的外部类上将伴随对象方法转换为静态方法
• lateinit -允许 var在拥有明确定义的生命周期时初始化属性
• Delegates.notNull() -可以代替 lateinit在读取前应至少设置一次的属性。

以下是管理嵌入式资源的Kotlin测试类的完整示例。

第一个是从Solr-Undertow测试中复制和修改的，在运行测试用例之前，请配置并启动Solr-Undertow服务器。测试运行后，它将清除测试创建的所有临时文件。它还可以在运行测试之前确保环境变量和系统属性正确。在测试用例之间，它会卸载所有临时加载的Solr内核。考试：

class TestServerWithPlugin {
    companion object {
        val workingDir = Paths.get("test-data/solr-standalone").toAbsolutePath()
        val coreWithPluginDir = workingDir.resolve("plugin-test/collection1")

        lateinit var server: Server

        @BeforeClass @JvmStatic fun setup() {
            assertTrue(coreWithPluginDir.exists(), "test core w/plugin does not exist $coreWithPluginDir")

            // make sure no system properties are set that could interfere with test
            resetEnvProxy()
            cleanSysProps()
            routeJbossLoggingToSlf4j()
            cleanFiles()

            val config = mapOf(...) 
            val configLoader = ServerConfigFromOverridesAndReference(workingDir, config) verifiedBy { loader ->
                ...
            }

            assertNotNull(System.getProperty("solr.solr.home"))

            server = Server(configLoader)
            val (serverStarted, message) = server.run()
            if (!serverStarted) {
                fail("Server not started: '$message'")
            }
        }

        @AfterClass @JvmStatic fun teardown() {
            server.shutdown()
            cleanFiles()
            resetEnvProxy()
            cleanSysProps()
        }

        private fun cleanSysProps() { ... }

        private fun cleanFiles() {
            // don't leave any test files behind
            coreWithPluginDir.resolve("data").deleteRecursively()
            Files.deleteIfExists(coreWithPluginDir.resolve("core.properties"))
            Files.deleteIfExists(coreWithPluginDir.resolve("core.properties.unloaded"))
        }
    }

    val adminClient: SolrClient = HttpSolrClient("http://localhost:8983/solr/")

    @Before fun prepareTest() {
        // anything before each test?
    }

    @After fun cleanupTest() {
        // make sure test cores do not bleed over between test cases
        unloadCoreIfExists("tempCollection1")
        unloadCoreIfExists("tempCollection2")
        unloadCoreIfExists("tempCollection3")
    }

    private fun unloadCoreIfExists(name: String) { ... }

    @Test
    fun testServerLoadsPlugin() {
        println("Loading core 'withplugin' from dir ${coreWithPluginDir.toString()}")
        val response = CoreAdminRequest.createCore("tempCollection1", coreWithPluginDir.toString(), adminClient)
        assertEquals(0, response.status)
    }

    // ... other test cases
}

另一个作为嵌入式数据库的启动AWS DynamoDB本地（已从运行AWS DynamoDB-local Embedded进行了稍微复制和修改）。此测试必须先破解，java.library.path然后再进行其他操作，否则本地DynamoDB（将sqlite与二进制库一起使用）将无法运行。然后，它启动服务器以共享所有测试类，并清除测试之间的临时数据。考试：

class TestAccountManager {
    companion object {
        init {
            // we need to control the "java.library.path" or sqlite cannot find its libraries
            val dynLibPath = File("./src/test/dynlib/").absoluteFile
            System.setProperty("java.library.path", dynLibPath.toString());

            // TEST HACK: if we kill this value in the System classloader, it will be
            // recreated on next access allowing java.library.path to be reset
            val fieldSysPath = ClassLoader::class.java.getDeclaredField("sys_paths")
            fieldSysPath.setAccessible(true)
            fieldSysPath.set(null, null)

            // ensure logging always goes through Slf4j
            System.setProperty("org.eclipse.jetty.util.log.class", "org.eclipse.jetty.util.log.Slf4jLog")
        }

        private val localDbPort = 19444

        private lateinit var localDb: DynamoDBProxyServer
        private lateinit var dbClient: AmazonDynamoDBClient
        private lateinit var dynamo: DynamoDB

        @BeforeClass @JvmStatic fun setup() {
            // do not use ServerRunner, it is evil and doesn't set the port correctly, also
            // it resets logging to be off.
            localDb = DynamoDBProxyServer(localDbPort, LocalDynamoDBServerHandler(
                    LocalDynamoDBRequestHandler(0, true, null, true, true), null)
            )
            localDb.start()

            // fake credentials are required even though ignored
            val auth = BasicAWSCredentials("fakeKey", "fakeSecret")
            dbClient = AmazonDynamoDBClient(auth) initializedWith {
                signerRegionOverride = "us-east-1"
                setEndpoint("http://localhost:$localDbPort")
            }
            dynamo = DynamoDB(dbClient)

            // create the tables once
            AccountManagerSchema.createTables(dbClient)

            // for debugging reference
            dynamo.listTables().forEach { table ->
                println(table.tableName)
            }
        }

        @AfterClass @JvmStatic fun teardown() {
            dbClient.shutdown()
            localDb.stop()
        }
    }

    val jsonMapper = jacksonObjectMapper()
    val dynamoMapper: DynamoDBMapper = DynamoDBMapper(dbClient)

    @Before fun prepareTest() {
        // insert commonly used test data
        setupStaticBillingData(dbClient)
    }

    @After fun cleanupTest() {
        // delete anything that shouldn't survive any test case
        deleteAllInTable<Account>()
        deleteAllInTable<Organization>()
        deleteAllInTable<Billing>()
    }

    private inline fun <reified T: Any> deleteAllInTable() { ... }

    @Test fun testAccountJsonRoundTrip() {
        val acct = Account("123",  ...)
        dynamoMapper.save(acct)

        val item = dynamo.getTable("Accounts").getItem("id", "123")
        val acctReadJson = jsonMapper.readValue<Account>(item.toJSON())
        assertEquals(acct, acctReadJson)
    }

    // ...more test cases

}

注意：示例的某些部分缩写为...

在测试中使用之前/之后的回调来管理资源显然是有好处的：

• 测试是“原子的”。一个测试通过所有回调整体执行，一个人不会忘记在测试之前启动依赖项服务，并在完成后将其关闭。如果操作正确，执行回调将可在任何环境下使用。
• 测试是独立的。没有外部数据或设置阶段，所有内容都包含在几个测试类中。

它也有一些缺点。其中一项重要功能是污染代码并使代码违反单一责任原则。现在，测试不仅可以测试某些内容，还可以执行重量级的初始化和资源管理。在某些情况下（例如配置ObjectMapper）可以这样做，但修改java.library.path或生成另一个进程（或进程内嵌入式数据库）并不是那么简单。

为什么不将这些服务视为您的测试符合“注入”条件的依赖项，如12factor.net所述。

这样，您就可以在测试代码之外的某个地方启动和初始化依赖项服务。

如今，虚拟化和容器几乎无处不在，大多数开发人员的机器都能够运行Docker。而且大多数应用程序都有dockerized版本：Elasticsearch，DynamoDB，PostgreSQL等。Docker是测试所需的外部服务的理想解决方案。

• 它可以是运行在开发人员每次想要执行测试时手动运行的脚本。
• 它可以通过构建工具运行任务（如摇篮有真棒dependsOn和finalizedByDSL定义依赖）。当然，任务可以执行与开发人员使用shell-outs / process exec手动执行的脚本相同的脚本。
• 它可以是IDE在测试执行之前运行的任务。同样，它可以使用相同的脚本。
• 大多数CI / CD提供程序都具有“服务”的概念—与构建并行运行的外部依赖项（进程），可以通过其通常的SDK /连接器/ API进行访问：Gitlab，Travis，Bitbucket，AppVeyor，Semaphore等。

这种方法：

• 从初始化逻辑中释放测试代码。您的测试只会进行测试，仅此而已。
• 解耦代码和数据。现在可以通过使用本机工具集将新数据添加到依赖项服务中来添加新的测试用例。即对于SQL数据库，您将使用SQL，对于Amazon DynamoDB，您将使用CLI创建表和放置项目。
• 更接近生产代码，您显然在其中不会在“主”应用程序启动时启动那些服务。

当然，它有缺陷（基本上是我从这里开始的陈述）：

• 测试不是更“原子”的。必须在测试执行之前以某种方式启动依赖性服务。在不同的环境中，启动方式可能有所不同：开发人员的计算机或CI，IDE或构建工具CLI。
• 测试不是独立的。现在，您的种子数据甚至可能打包在图像中，因此更改它可能需要重新构建一个不同的项目。