Add testall plugin (see codeoverflow-org/chatoverflow#42 )

Deleted discord test (moved to testall plugin)

Author: J0B10

discordtest/src/main/scala/discordTest.scala

@@ -1,4 +1,4 @@
 // GENERATED FILE USING THE CHAT OVERFLOW PLUGIN FRAMEWORK
 
-name := "discordTest"
+name := "testall"
 version := "0.1"

discordtest/src/main/scala/discordTestPlugin.scala

@@ -0,0 +1,47 @@
+package org.codeoverflow.plugins.testall
+
+import org.codeoverflow.chatoverflow.api.plugin.configuration.Requirement
+
+abstract class test(private val plugin: testallPlugin, val requirements : Requirement[_]*) {
+
+  /**
+    * Used on setup to determine if the testallPlugin should run this test.
+    *
+    * By default it only checks if the supplied requirements are set.
+    *
+    * Override to change this behaviour
+    *
+    * @return true if the test should be run
+    */
+  def runTest: Boolean = requirements.forall(_.isSet)
+
+  /**
+    * The name of the test for displaying in log
+    *
+    * @return the name
+    */
+  def name: String
+
+  /**
+    * Perform the tests that should be executed on startup
+    */
+  def setup(): Unit
+
+  /**
+    * Perform the tests that should be executed in a loop
+    */
+  def loop(): Unit
+
+  /**
+    * Perform the tests that should be executed at shutdown and close everything.
+    */
+  def shutdown(): Unit
+
+  /**
+    * Prints a log message on the console and saves the message for later inspection.
+    *
+    * @param message the message to show
+    */
+  protected final def log(message: String): Unit = plugin.getManager.log(message)
+
+}

discordtest/build.sbt renamed to testall/build.sbt

@@ -0,0 +1,30 @@
+package org.codeoverflow.plugins.testall
+
+import org.codeoverflow.chatoverflow.api.plugin.{PluginImpl, PluginManager}
+import org.codeoverflow.plugins.testall.tests.discordtest
+
+
+class testallPlugin(manager: PluginManager) extends PluginImpl(manager) {
+
+  private val tests: Seq[test] = Seq(
+    new discordtest(this,
+      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)
+    )
+  )
+
+  private var running = Seq[test]()
+
+  override def setup(): Unit = {
+    running = tests.filter(test => {
+      log(s"${test.name}: ${if (test.runTest) "testing" else "skipping (not all requirements are set)"}")
+      test.runTest
+    })
+    running.foreach(_.setup())
+  }
+
+  override def loop(): Unit = running.foreach(_.loop())
+
+  override def shutdown(): Unit = running.foreach(_.shutdown())
+}

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

@@ -0,0 +1,62 @@
+package org.codeoverflow.plugins.testall.tests
+
+import java.awt.Color
+
+import org.codeoverflow.chatoverflow.api.io.dto.chat.discord.{DiscordChatMessage, DiscordEmbed}
+import org.codeoverflow.chatoverflow.api.io.input.chat.DiscordChatInput
+import org.codeoverflow.chatoverflow.api.io.output.chat.DiscordChatOutput
+import org.codeoverflow.chatoverflow.api.io.parameter.StringParameter
+import org.codeoverflow.chatoverflow.api.plugin.configuration.Requirement
+import org.codeoverflow.plugins.testall.{test, testallPlugin}
+
+import scala.collection.JavaConverters._
+
+class discordtest(val plugin: testallPlugin,
+                  val in: Requirement[DiscordChatInput],
+                  val out: Requirement[DiscordChatOutput],
+                  val channel: Requirement[StringParameter]) extends test(plugin, in, out) {
+
+  override def name: String = "Discord test"
+  
+  override def setup(): Unit = {
+    in.get.setChannel(channel.get.get)
+    out.get.setChannel(channel.get.get)
+    println(s"Input connected to channel ${in.get().getChannelId}")
+    println(s"Output connected to channel ${out.get().getChannelId}")
+    in.get.registerMessageHandler(onMessage)
+    in.get.registerMessageEditHandler(onMessageEdit)
+    in.get.registerMessageDeleteHandler(onMessageDelete)
+    out.get.sendChatMessage("Hey I'm working! \uD83C\uDF89")
+    out.get().sendFile("../config/config.xml")
+    out.get().sendFile("allowed_file.png")
+    out.get().sendChatMessage(DiscordEmbed.Builder()
+      .withColor(Color.RED)
+      .withDescription("test")
+      .withAuthor("skateShiny", null, "https://cdn.discordapp.com/emojis/496389587329875981.png?v=1")
+      .build())
+    log(s"$name started successfully")
+  }
+
+  def onMessage(message: DiscordChatMessage): Unit = {
+    if (message.getMessage == "/messages") {
+      var s = "**Recent messages:**\n"
+      s += in.get.getLastMessages(1000*60).asScala.mkString("\n")
+      s += "\n\n**Recent private messages:**\n"
+      s += in.get().getLastPrivateMessages(1000*60).asScala.mkString("\n")
+      out.get.sendChatMessage(s)
+    }
+  }
+
+
+  def onMessageEdit(oldMessage: DiscordChatMessage, newMessage: DiscordChatMessage): Unit = {
+    log(s"$name: Message #${oldMessage.getId} was edited from '$oldMessage' to '$newMessage'")
+  }
+
+  def onMessageDelete(message: DiscordChatMessage): Unit = {
+    log(s"$name: Message #${message.getId} was deleted  (content: $message)")
+  }
+
+  override def loop(): Unit = {}
+
+  override def shutdown(): Unit = log(s"Stopped $name")
+}

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

@@ -0,0 +1,17 @@
+import org.codeoverflow.chatoverflow.api.plugin.{Pluggable, Plugin, PluginManager}
+import org.codeoverflow.plugins.testall.testallPlugin
+
+class testall extends Pluggable {
+
+  override def getName: String = "testall"
+
+  override def getAuthor: String = "joblo2213"
+
+  override def getDescription: String = "A plugin to simplify testing of all services"
+
+  override def getMajorAPIVersion: Int = 1
+
+  override def getMinorAPIVersion: Int = 0
+
+  override def createNewPluginInstance(manager: PluginManager): Plugin = new testallPlugin(manager)
+}