Add test for file connector

Author: Jonas

testall/src/main/scala/org/codeoverflow/plugins/testall/test.scala

@@ -2,6 +2,15 @@ package org.codeoverflow.plugins.testall
 
 import org.codeoverflow.chatoverflow.api.plugin.configuration.Requirement
 
+/**
+  * Used for testing a connector.
+  *
+  * Pass all requirements required for this test and implement your tests in the `setup()`, `loop()` and `shutdown()` functions.
+  * Also make sure to add the test in the `testallPlugin` class.
+  *
+  * @param plugin the testallPlugins instance (required for logging)
+  * @param requirements the requirements that are used by this test
+  */
 abstract class test(private val plugin: testallPlugin, val requirements : Requirement[_]*) {
 
   /**
@@ -42,6 +51,6 @@ abstract class test(private val plugin: testallPlugin, val requirements : Requir
     *
     * @param message the message to show
     */
-  protected final def log(message: String): Unit = plugin.getManager.log(message)
+  protected final def log(message: String): Unit = plugin.getManager.log(s"[$name] $message")
 
 }

testall/src/main/scala/org/codeoverflow/plugins/testall/testallPlugin.scala

@@ -1,7 +1,7 @@
 package org.codeoverflow.plugins.testall
 
 import org.codeoverflow.chatoverflow.api.plugin.{PluginImpl, PluginManager}
-import org.codeoverflow.plugins.testall.tests.discordtest
+import org.codeoverflow.plugins.testall.tests.{discordtest, filetest}
 
 
 class testallPlugin(manager: PluginManager) extends PluginImpl(manager) {
@@ -11,7 +11,12 @@ class testallPlugin(manager: PluginManager) extends PluginImpl(manager) {
       require.input.discordChat("reqDiscordIn", "Discord input", true),
       require.output.discordChat("reqDiscordOut", "Discord output", true),
       require.parameter.string("reqDiscordChannel", "The id of the channel to which the bot should connect", true)
+    ),
+    new filetest(this,
+      require.input.file("fileIn", "File input", true),
+      require.output.file("fileOut", "File output", true)
     )
+    //Add more tests here!
   )
 
   private var running = Seq[test]()

testall/src/main/scala/org/codeoverflow/plugins/testall/tests/discordtest.scala

@@ -11,6 +11,10 @@ import org.codeoverflow.plugins.testall.{test, testallPlugin}
 
 import scala.collection.JavaConverters._
 
+/**
+  * Test for the discord service, logs edited and deleted messages, tests sending of messages, embeds and files,
+  * allows listing the recent messages with /message command
+  */
 class discordtest(val plugin: testallPlugin,
                   val in: Requirement[DiscordChatInput],
                   val out: Requirement[DiscordChatOutput],
@@ -34,7 +38,7 @@ class discordtest(val plugin: testallPlugin,
       .withDescription("test")
       .withAuthor("skateShiny", null, "https://cdn.discordapp.com/emojis/496389587329875981.png?v=1")
       .build())
-    log(s"$name started successfully")
+    log("Started successfully")
   }
 
   def onMessage(message: DiscordChatMessage): Unit = {
@@ -49,14 +53,14 @@ class discordtest(val plugin: testallPlugin,
 
 
   def onMessageEdit(oldMessage: DiscordChatMessage, newMessage: DiscordChatMessage): Unit = {
-    log(s"$name: Message #${oldMessage.getId} was edited from '$oldMessage' to '$newMessage'")
+    log("Message #${oldMessage.getId} was edited from '$oldMessage' to '$newMessage'")
   }
 
   def onMessageDelete(message: DiscordChatMessage): Unit = {
-    log(s"$name: Message #${message.getId} was deleted  (content: $message)")
+    log("Message #${message.getId} was deleted  (content: $message)")
   }
 
   override def loop(): Unit = {}
 
-  override def shutdown(): Unit = log(s"Stopped $name")
+  override def shutdown(): Unit = log("Stopped")
 }

testall/src/main/scala/org/codeoverflow/plugins/testall/tests/filetest.scala

@@ -0,0 +1,60 @@
+package org.codeoverflow.plugins.testall.tests
+
+import org.codeoverflow.chatoverflow.api.io.input.FileInput
+import org.codeoverflow.chatoverflow.api.io.output.FileOutput
+import org.codeoverflow.chatoverflow.api.plugin.configuration.Requirement
+import org.codeoverflow.plugins.testall.{test, testallPlugin}
+
+/**
+  * Test the various different file system actions provided by FileInput and FileOutput
+  */
+class filetest(val plugin: testallPlugin, val in: Requirement[FileInput], val out: Requirement[FileOutput]) extends test(plugin, in, out) {
+
+  override def name: String = "Filesystem test"
+
+  override def setup(): Unit = {
+    log("Testing creation of folder")
+    log(out.get.createDirectory("test").toString)
+
+    log("Testing creation of folder #2")
+    log(out.get.createDirectory("test2/test2").toString)
+
+    log("Testing creation of folder #3")
+    log(out.get.createDirectory("ich/bin/ein/folder").toString)
+
+    log("Tesitng if file exists")
+    log(out.get.exists("test.json").toString)
+
+    log("Tesitng if file exists (non existant)")
+    log(out.get.exists("test2.json").toString)
+
+
+    log("Test file reading:")
+    val file = in.get.getFile("test.json")
+    log(if (file.isPresent) file.get() else "false")
+
+    log("Test file writing:")
+    log(out.get.saveFile(
+      """{
+        |  "type": "test",
+        |  "result": "success"
+        |}
+      """.stripMargin, "out.json").toString)
+
+    log("Tesitng if folder exists")
+    log(out.get.exists("test/").toString)
+    log(out.get.exists("test").toString)
+
+    log("Testing deletion of a folder")
+    log(out.get.delete("test").toString)
+    log(out.get.delete("test2/test2").toString)
+    log(out.get.delete("ich/bin/ein/folder").toString)
+
+    log("Testing deletion of a file")
+    log(out.get.delete("out.json").toString)
+  }
+
+  override def loop(): Unit = {}
+
+  override def shutdown(): Unit = {}
+}