From: David ‘Bombe’ Roden <bombe@pterodactylus.net>
Date: Sun, 27 Oct 2019 16:11:22 +0000 (+0100)
Subject: ✨ Add facades for fred-based plugin interaction
X-Git-Tag: v81^2~107
X-Git-Url: https://git.pterodactylus.net/?a=commitdiff_plain;h=17b277ebd8cc7225c0cf6b0ef3927bc56794ce3f;p=Sone.git

✨ Add facades for fred-based plugin interaction
---

diff --git a/src/main/kotlin/net/pterodactylus/sone/freenet/plugin/PluginRespiratorFacade.kt b/src/main/kotlin/net/pterodactylus/sone/freenet/plugin/PluginRespiratorFacade.kt
new file mode 100644
index 0000000..3ec52ce
--- /dev/null
+++ b/src/main/kotlin/net/pterodactylus/sone/freenet/plugin/PluginRespiratorFacade.kt
@@ -0,0 +1,66 @@
+/**
+ * Sone - PluginRespiratorFacade.kt - Copyright © 2019 David ‘Bombe’ Roden
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/* Yes, this handle Fred-based stuff that’s mostly deprecated. */
+@file:Suppress("DEPRECATION")
+
+package net.pterodactylus.sone.freenet.plugin
+
+import freenet.pluginmanager.*
+import freenet.support.*
+import freenet.support.api.*
+import javax.inject.*
+
+/**
+ * Facade for the only method of a [plugin respirator][PluginRespirator] that Sone actually uses,
+ * for easier testing.
+ */
+interface PluginRespiratorFacade {
+
+	@Throws(PluginNotFoundException::class)
+	fun getPluginTalker(pluginTalker: FredPluginTalker, pluginName: String, identifier: String): PluginTalkerFacade
+
+}
+
+/**
+ * Facade for a [plugin talker][PluginTalker], for easier testing.
+ */
+interface PluginTalkerFacade {
+
+	fun send(pluginParameters: SimpleFieldSet, data: Bucket?)
+
+}
+
+/**
+ * Fred-based [PluginRespiratorFacade] implementation that proxies the given real [PluginRespirator].
+ */
+class FredPluginRespiratorFacade @Inject constructor(private val pluginRespirator: PluginRespirator) : PluginRespiratorFacade {
+
+	override fun getPluginTalker(pluginTalker: FredPluginTalker, pluginName: String, identifier: String) =
+			FredPluginTalkerFacade(pluginRespirator.getPluginTalker(pluginTalker, pluginName, identifier))
+
+}
+
+/**
+ * Fred-based [PluginTalkerFacade] implementation that proxies the given real [PluginTalker].
+ */
+class FredPluginTalkerFacade(private val pluginTalker: PluginTalker) : PluginTalkerFacade {
+
+	override fun send(pluginParameters: SimpleFieldSet, data: Bucket?) =
+			pluginTalker.send(pluginParameters, data)
+
+}
diff --git a/src/test/kotlin/net/pterodactylus/sone/freenet/plugin/PluginRespiratorFacadeTest.kt b/src/test/kotlin/net/pterodactylus/sone/freenet/plugin/PluginRespiratorFacadeTest.kt
new file mode 100644
index 0000000..4e44d5d
--- /dev/null
+++ b/src/test/kotlin/net/pterodactylus/sone/freenet/plugin/PluginRespiratorFacadeTest.kt
@@ -0,0 +1,46 @@
+package net.pterodactylus.sone.freenet.plugin
+
+import freenet.pluginmanager.*
+import freenet.support.*
+import freenet.support.api.*
+import freenet.support.io.*
+import net.pterodactylus.sone.freenet.*
+import net.pterodactylus.sone.test.*
+import org.hamcrest.MatcherAssert.*
+import org.hamcrest.Matchers.*
+import org.mockito.ArgumentMatchers.*
+import kotlin.test.*
+
+/**
+ * Unit test for [FredPluginRespiratorFacade] and [FredPluginTalkerFacade].
+ */
+@Suppress("DEPRECATION")
+class PluginRespiratorFacadeTest {
+
+	@Test
+	fun `respirator facade creates correct plugin talker facade`() {
+		val pluginTalkerSendParameters = mutableListOf<PluginTalkerSendParameters>()
+		val originalPluginTalker = mock<PluginTalker>().apply {
+			whenever(send(any(), any())).then { invocation ->
+				pluginTalkerSendParameters += PluginTalkerSendParameters(invocation.getArgument(0), invocation.getArgument(1))
+				Unit
+			}
+		}
+		val fredPluginTalker = FredPluginTalker { _, _, _, _ -> }
+		val pluginRespirator = mock<PluginRespirator>().apply {
+			whenever(getPluginTalker(fredPluginTalker, "test.plugin", "test-request-1")).thenReturn(originalPluginTalker)
+		}
+		val pluginRespiratorFacade = FredPluginRespiratorFacade(pluginRespirator)
+		val pluginTalker = pluginRespiratorFacade.getPluginTalker(fredPluginTalker, "test.plugin", "test-request-1")
+		pluginTalker.send(fields, data)
+		assertThat(pluginTalkerSendParameters, hasSize(1))
+		assertThat(pluginTalkerSendParameters[0].parameter, equalTo(fields))
+		assertThat(pluginTalkerSendParameters[0].data, equalTo(data))
+	}
+
+}
+
+private val fields = SimpleFieldSetBuilder().put("foo", "bar").get()
+private val data: Bucket? = ArrayBucket(byteArrayOf(1, 2))
+
+private data class PluginTalkerSendParameters(val parameter: SimpleFieldSet, val data: Bucket?)