データベース接続や組み込みのElasticsearchサーバーの起動/停止など、Kotlinで単体テストリソースを管理するにはどうすればよいですか？

Question

Kotlin JUnitテストでは、組み込みサーバーを起動/停止し、テスト内で使用します。

テストクラスのメソッドでJUnit @Beforeアノテーションを使用してみましたが、正常に動作しますが、一度だけではなくすべてのテストケースを実行するため、正しい動作ではありません。

したがって、メソッドで@BeforeClass注釈を使用したいのですが、メソッドに追加すると、静的メソッド上にある必要があるというエラーが発生します。 Kotlinには静的メソッドがないようです。そして、テストケースで使用するために組み込みサーバーへの参照を保持する必要があるため、静的変数にも同じことが当てはまります。

それでは、すべてのテストケースに対してこの組み込みデータベースを1回だけ作成するにはどうすればよいですか？

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

    ...
}

注：この質問は作者によって意図的に書かれ、回答されています（- Self-Answered Questions ） 、よく聞かれるKotlinトピックへの回答がSOに存在するように。

Answer 1

通常、単体テストクラスでは、テストメソッドのグループの共有リソースを管理するためにいくつかのことが必要です。また、Kotlinでは、テストクラスではなく@BeforeClassおよび@AfterClassを使用できますが、代わりに companionオブジェクト と @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 interopのコンパニオンオブジェクトメソッドを外部クラスの静的メソッドに変換するアノテーション
• lateinit -ライフサイクルが明確に定義されている場合、varプロパティを後で初期化できます。
• Delegates.notNull() -読み取り前に少なくとも1回設定する必要があるプロパティに対して、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
}

そして、もう1つの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

}

注：例の一部は...

Answer 2

テストでビフォア/アフターコールバックを使用してリソースを管理することには、明らかに長所があります。

• テストは「アトミック」です。テストはすべてのコールバックを使用して全体として実行されます。テストの前に依存関係サービスを起動し、完了後にシャットダウンすることを忘れないでください。適切に行われれば、実行コールバックはどの環境でも動作します。
• テストは自己完結型です。外部データやセットアップフェーズはありません。すべてがいくつかのテストクラスに含まれています。

短所もあります。それらの1つの重要な点は、コードを汚染し、コードが単一の責任原則に違反することです。テストは、何かをテストするだけでなく、重い初期化とリソース管理を実行します。場合によっては問題ありません（ configing an ObjectMapper ）が、Java.library.pathまたは別のプロセス（またはインプロセス組み込みデータベース）の生成はそれほど無害ではありません。

12factor.net で説明されているように、これらのサービスを「インジェクション」の対象となるテストの依存関係として扱わないのはなぜですか。

このようにして、テストコードの外部のどこかで依存関係サービスを開始および初期化します。

現在、仮想化とコンテナはほぼどこにでもあり、ほとんどの開発者のマシンはDockerを実行できます。そして、ほとんどのアプリケーションには、ドッキングされたバージョンがあります： Elasticsearch 、 DynamoDB 、 PostgreSQL など。 Dockerは、テストに必要な外部サービスに最適なソリューションです。

• 開発者がテストを実行するたびに手動で実行されるスクリプトを実行できます。
• ビルドツールによって実行されるタスクです（たとえば、Gradleには、依存関係を定義するためのDSL dependsOn およびDSL finalizedBy があります）。もちろん、タスクは、開発者がシェルアウト/プロセスexecを使用して手動で実行するのと同じスクリプトを実行できます。
• IDEテスト実行前に実行されるタスク の場合もあります。再び、同じスクリプトを使用できます。
• ほとんどのCI/CDプロバイダーには、「サービス」という概念があります。ビルドと並行して実行され、通常のSDK /コネクター/ APIを介してアクセスできる外部依存関係（プロセス）： Gitlab 、- Travis 、 Bitbucket 、 AppVeyor 、 セマフォ 、…

このアプローチ：

• 初期化ロジックからテストコードを解放します。あなたのテストはテストするだけで、それ以上何もしません。
• コードとデータを分離します。ネイティブツールセットを使用して依存関係サービスに新しいデータを追加することで、新しいテストケースを追加できるようになりました。つまりSQLデータベースではSQLを使用し、Amazon DynamoDBではCLIを使用してテーブルを作成し、アイテムを配置します。
• 「メイン」アプリケーションの開始時に明らかにこれらのサービスを開始しない実動コードに近い。

もちろん、それには欠陥があります（基本的に、私が始めた声明）：

• テストは「原子的」ではありません。依存関係サービスは、テストの実行前に何らかの方法で開始する必要があります。開始方法は、環境によって異なります：開発者のマシンまたはCI、IDEまたはビルドツールCLI。
• テストは自己完結型ではありません。現在、シードデータはイメージ内にパックされている場合があるため、変更するには別のプロジェクトを再構築する必要があります。