♻️ Improve getInstance() method, use it in test

diff --git a/src/test/kotlin/net/pterodactylus/sone/main/SoneModuleTest.kt b/src/test/kotlin/net/pterodactylus/sone/main/SoneModuleTest.kt
index 77633bd..83d3535 100644 (file)
--- a/src/test/kotlin/net/pterodactylus/sone/main/SoneModuleTest.kt
+++ b/src/test/kotlin/net/pterodactylus/sone/main/SoneModuleTest.kt
@@ -2,7 +2,7 @@ package net.pterodactylus.sone.main
 
 import com.google.common.base.*
 import com.google.common.eventbus.*
 
 import com.google.common.base.*
 import com.google.common.eventbus.*

-import com.google.inject.*
+import com.google.inject.Guice.*

 import com.google.inject.name.Names.*
 import net.pterodactylus.sone.database.*
 import net.pterodactylus.sone.database.memory.*
 import com.google.inject.name.Names.*
 import net.pterodactylus.sone.database.*
 import net.pterodactylus.sone.database.memory.*


@@ -28,6 +28,8 @@ class SoneModuleTest {
                whenever(homepage).thenReturn(pluginHomepage)
        }
 
                whenever(homepage).thenReturn(pluginHomepage)
        }
 

+       private val injector by lazy { createInjector(SoneModule(sonePlugin)) }
+

        @After
        fun removePropertiesFromCurrentDirectory() {
                File(currentDir, "sone.properties").delete()
        @After
        fun removePropertiesFromCurrentDirectory() {
                File(currentDir, "sone.properties").delete()


@@ -36,19 +38,19 @@ class SoneModuleTest {
        @Test
        fun `creator binds configuration when no file is present`() {
                File(currentDir, "sone.properties").delete()
        @Test
        fun `creator binds configuration when no file is present`() {
                File(currentDir, "sone.properties").delete()

-               assertThat(getInstance<Configuration>(), notNullValue())
+               assertThat(injector.getInstance<Configuration>(), notNullValue())

        }
 
        @Test
        fun `creator binds first start to true when no file is present`() {
                File(currentDir, "sone.properties").delete()
        }
 
        @Test
        fun `creator binds first start to true when no file is present`() {
                File(currentDir, "sone.properties").delete()

-               assertThat(getInstance(named("FirstStart")), equalTo(true))
+               assertThat(injector.getInstance(named("FirstStart")), equalTo(true))

        }
 
        @Test
        fun `config file is created in current directory if not present`() {
                File(currentDir, "sone.properties").delete()
        }
 
        @Test
        fun `config file is created in current directory if not present`() {
                File(currentDir, "sone.properties").delete()

-               val configuration = getInstance<Configuration>()
+               val configuration = injector.getInstance<Configuration>()

                configuration.save()
                assertThat(File(currentDir, "sone.properties").exists(), equalTo(true))
        }
                configuration.save()
                assertThat(File(currentDir, "sone.properties").exists(), equalTo(true))
        }


@@ -56,94 +58,94 @@ class SoneModuleTest {
        @Test
        fun `creator binds configuration when file is present`() {
                File(currentDir, "sone.properties").writeText("Option=old")
        @Test
        fun `creator binds configuration when file is present`() {
                File(currentDir, "sone.properties").writeText("Option=old")

-               assertThat(getInstance<Configuration>().getStringValue("Option").value, equalTo("old"))
+               assertThat(injector.getInstance<Configuration>().getStringValue("Option").value, equalTo("old"))

        }
 
        @Test
        fun `creator binds first start to false when file is present`() {
                File(currentDir, "sone.properties").writeText("Option=old")
        }
 
        @Test
        fun `creator binds first start to false when file is present`() {
                File(currentDir, "sone.properties").writeText("Option=old")

-               assertThat(getInstance(named("FirstStart")), equalTo(false))
+               assertThat(injector.getInstance(named("FirstStart")), equalTo(false))

        }
 
        @Test
        fun `invalid config file leads to new config being created`() {
                File(currentDir, "sone.properties").writeText("Option=old\nbroken")
        }
 
        @Test
        fun `invalid config file leads to new config being created`() {
                File(currentDir, "sone.properties").writeText("Option=old\nbroken")

-               val configuration = getInstance<Configuration>()
+               val configuration = injector.getInstance<Configuration>()

                assertThat(configuration.getStringValue("Option").getValue(null), nullValue())
        }
 
        @Test
        fun `invalid config file leads to new config being set to true`() {
                File(currentDir, "sone.properties").writeText("Option=old\nbroken")
                assertThat(configuration.getStringValue("Option").getValue(null), nullValue())
        }
 
        @Test
        fun `invalid config file leads to new config being set to true`() {
                File(currentDir, "sone.properties").writeText("Option=old\nbroken")

-               assertThat(getInstance(named("NewConfig")), equalTo(true))
+               assertThat(injector.getInstance(named("NewConfig")), equalTo(true))

        }
 
        @Test
        fun `valid config file leads to new config being set to false`() {
                File(currentDir, "sone.properties").writeText("Option=old")
        }
 
        @Test
        fun `valid config file leads to new config being set to false`() {
                File(currentDir, "sone.properties").writeText("Option=old")

-               assertThat(getInstance(named("NewConfig")), equalTo(false))
+               assertThat(injector.getInstance(named("NewConfig")), equalTo(false))

        }
 
        @Test
        fun `event bus is bound`() {
        }
 
        @Test
        fun `event bus is bound`() {

-               assertThat(getInstance<EventBus>(), notNullValue())
+               assertThat(injector.getInstance<EventBus>(), notNullValue())

        }
 
        @Test
        fun `context is bound`() {
        }
 
        @Test
        fun `context is bound`() {

-               assertThat(getInstance<Context>().context, equalTo("Sone"))
+               assertThat(injector.getInstance<Context>().context, equalTo("Sone"))

        }
 
        @Test
        fun `optional context is bound`() {
        }
 
        @Test
        fun `optional context is bound`() {

-               assertThat(getInstance<Optional<Context>>().get().context, equalTo("Sone"))
+               assertThat(injector.getInstance<Optional<Context>>().get().context, equalTo("Sone"))

        }
 
        @Test
        fun `sone plugin is bound`() {
        }
 
        @Test
        fun `sone plugin is bound`() {

-               assertThat(getInstance(), sameInstance(sonePlugin))
+               assertThat(injector.getInstance(), sameInstance(sonePlugin))

        }
 
        @Test
        fun `version is bound`() {
        }
 
        @Test
        fun `version is bound`() {

-               assertThat(getInstance(), equalTo(pluginVersion))
+               assertThat(injector.getInstance(), equalTo(pluginVersion))

        }
 
        @Test
        fun `plugin version is bound`() {
        }
 
        @Test
        fun `plugin version is bound`() {

-               assertThat(getInstance(), equalTo(PluginVersion(pluginVersion.toString())))
+               assertThat(injector.getInstance(), equalTo(PluginVersion(pluginVersion.toString())))

        }
 
        @Test
        fun `plugin year is bound`() {
        }
 
        @Test
        fun `plugin year is bound`() {

-               assertThat(getInstance(), equalTo(PluginYear(pluginYear)))
+               assertThat(injector.getInstance(), equalTo(PluginYear(pluginYear)))

        }
 
        @Test
        fun `plugin homepage in bound`() {
        }
 
        @Test
        fun `plugin homepage in bound`() {

-               assertThat(getInstance(), equalTo(PluginHomepage(pluginHomepage)))
+               assertThat(injector.getInstance(), equalTo(PluginHomepage(pluginHomepage)))

        }
 
        @Test
        fun `database is bound correctly`() {
        }
 
        @Test
        fun `database is bound correctly`() {

-               assertThat(getInstance<Database>(), instanceOf(MemoryDatabase::class.java))
+               assertThat(injector.getInstance<Database>(), instanceOf(MemoryDatabase::class.java))

        }
 
        @Test
        fun `default loader is used without dev options`() {
        }
 
        @Test
        fun `default loader is used without dev options`() {

-               assertThat(getInstance<Loaders>(), instanceOf(DefaultLoaders::class.java))
+               assertThat(injector.getInstance<Loaders>(), instanceOf(DefaultLoaders::class.java))

        }
 
        @Test
        fun `default loaders are used if no path is given`() {
                File(currentDir, "sone.properties").writeText("Developer.LoadFromFilesystem=true")
        }
 
        @Test
        fun `default loaders are used if no path is given`() {
                File(currentDir, "sone.properties").writeText("Developer.LoadFromFilesystem=true")

-               assertThat(getInstance<Loaders>(), instanceOf(DefaultLoaders::class.java))
+               assertThat(injector.getInstance<Loaders>(), instanceOf(DefaultLoaders::class.java))

        }
 
        @Test
        fun `debug loaders are used if path is given`() {
                File(currentDir, "sone.properties").writeText("Developer.LoadFromFilesystem=true\nDeveloper.FilesystemPath=/tmp")
        }
 
        @Test
        fun `debug loaders are used if path is given`() {
                File(currentDir, "sone.properties").writeText("Developer.LoadFromFilesystem=true\nDeveloper.FilesystemPath=/tmp")

-               assertThat(getInstance<Loaders>(), instanceOf(DebugLoaders::class.java))
+               assertThat(injector.getInstance<Loaders>(), instanceOf(DebugLoaders::class.java))

        }
 
        class TestObject {
        }
 
        class TestObject {


@@ -156,20 +158,11 @@ class SoneModuleTest {
 
        @Test
        fun `created objects are registered with event bus`() {
 
        @Test
        fun `created objects are registered with event bus`() {

-               val injector = createInjector()
-               val eventBus: EventBus = getInstance(injector = injector)
-               val testObject = getInstance<TestObject>(injector = injector)
+               val eventBus: EventBus = injector.getInstance()
+               val testObject = injector.getInstance<TestObject>()

                val event = Any()
                eventBus.post(event)
                assertThat(testObject.ref.get(), sameInstance(event))
        }
 
                val event = Any()
                eventBus.post(event)
                assertThat(testObject.ref.get(), sameInstance(event))
        }
 

-       private fun createInjector(): Injector = SoneModule(sonePlugin)
-                       .let { Guice.createInjector(it) }
-
-       private inline fun <reified R : Any> getInstance(annotation: Annotation? = null, injector: Injector = createInjector()): R =
-                       annotation
-                                       ?.let { injector.getInstance(Key.get(object : TypeLiteral<R>() {}, it)) }
-                                       ?: injector.getInstance(Key.get(object : TypeLiteral<R>() {}))
-

 }
 }

diff --git a/src/test/kotlin/net/pterodactylus/sone/test/Guice.kt b/src/test/kotlin/net/pterodactylus/sone/test/Guice.kt
index 2fc4a96..c8f2417 100644 (file)
--- a/src/test/kotlin/net/pterodactylus/sone/test/Guice.kt
+++ b/src/test/kotlin/net/pterodactylus/sone/test/Guice.kt
@@ -1,11 +1,10 @@
 package net.pterodactylus.sone.test
 
 package net.pterodactylus.sone.test
 

-import com.google.inject.Injector
-import com.google.inject.Module
+import com.google.inject.*

 import com.google.inject.name.*
 import org.mockito.*
 import javax.inject.Provider
 import com.google.inject.name.*
 import org.mockito.*
 import javax.inject.Provider

-import kotlin.reflect.KClass
+import kotlin.reflect.*

 
 fun <T : Any> KClass<T>.isProvidedBy(instance: T) = Module { it.bind(this.java).toProvider(Provider<T> { instance }) }
 fun <T : Any> KClass<T>.withNameIsProvidedBy(instance: T, name: String) = Module { it.bind(this.java).annotatedWith(Names.named(name)).toProvider(Provider<T> { instance }) }
 
 fun <T : Any> KClass<T>.isProvidedBy(instance: T) = Module { it.bind(this.java).toProvider(Provider<T> { instance }) }
 fun <T : Any> KClass<T>.withNameIsProvidedBy(instance: T, name: String) = Module { it.bind(this.java).annotatedWith(Names.named(name)).toProvider(Provider<T> { instance }) }


@@ -14,7 +13,9 @@ fun <T : Any> KClass<T>.isProvidedBy(provider: KClass<out Provider<T>>) = Module
 inline fun <reified T : Any> KClass<T>.isProvidedByMock() = Module { it.bind(this.java).toProvider(Provider<T> { mock() }) }
 inline fun <reified T : Any> KClass<T>.isProvidedByDeepMock() = Module { it.bind(this.java).toProvider(Provider<T> { deepMock() }) }
 
 inline fun <reified T : Any> KClass<T>.isProvidedByMock() = Module { it.bind(this.java).toProvider(Provider<T> { mock() }) }
 inline fun <reified T : Any> KClass<T>.isProvidedByDeepMock() = Module { it.bind(this.java).toProvider(Provider<T> { deepMock() }) }
 

-inline fun <reified T : Any> Injector.getInstance() = getInstance(T::class.java)!!
+inline fun <reified T : Any> Injector.getInstance(annotation: Annotation? = null): T = annotation
+               ?.let { getInstance(Key.get(object : TypeLiteral<T>() {}, it)) }
+               ?: getInstance(Key.get(object : TypeLiteral<T>() {}))

 
 fun <T : Any> supply(javaClass: Class<T>): Source<T> = object : Source<T> {
        override fun fromInstance(instance: T) = Module { it.bind(javaClass).toInstance(instance) }
 
 fun <T : Any> supply(javaClass: Class<T>): Source<T> = object : Source<T> {
        override fun fromInstance(instance: T) = Module { it.bind(javaClass).toInstance(instance) }