Generate dependencies for plugin environment automatically

Author: hlxid

build.sbt

@@ -98,14 +98,15 @@ fetch := BuildUtility(streams.value.log).fetchPluginsTask(pluginFolderNames.valu
 copy := BuildUtility(streams.value.log).copyPluginsTask(pluginFolderNames.value, pluginTargetFolderNames.value, scalaMajorVersion)
 bs := BootstrapUtility.bootstrapGenTask(streams.value.log, s"$scalaMajorVersion$scalaMinorVersion", getDependencyList.value)
 deploy := BootstrapUtility.prepareDeploymentTask(streams.value.log, scalaMajorVersion)
-deployDev := BootstrapUtility.prepareDevDeploymentTask(streams.value.log, scalaMajorVersion)
+deployDev := BootstrapUtility.prepareDevDeploymentTask(streams.value.log, scalaMajorVersion, getDependencyList.value)
 gui := BuildUtility(streams.value.log).guiTask(guiProjectPath.value, streams.value.cacheDirectory / "gui")
 
 // ---------------------------------------------------------------------------------------------------------------------
 // UTIL
 // ---------------------------------------------------------------------------------------------------------------------
 
 // Util task for bs, gets a dependency list kinda like "sbt dependencyList", but only includes deps required for runtime
+// Filters out all chatoverflow modules, because those are not actual dependencies.
 lazy val getDependencyList = Def.task[List[ModuleID]] {
   // only get deps required for runtime and not for anything else like testing
   val updateReport = update.value.configuration(ConfigRef("runtime"))
@@ -114,6 +115,8 @@ lazy val getDependencyList = Def.task[List[ModuleID]] {
     List()
   } else {
     updateReport.get.modules.map(m => m.module).toList
+      .filterNot(m => m.name == s"chatoverflow-api_$scalaMajorVersion" ||
+        m.name == s"chatoverflow_$scalaMajorVersion")
   }
 }
 

deployment-files-dev/build.sbt

@@ -1,5 +1,6 @@
 // This is a stripped down version of the build.sbt found in the main framework.
-// Its almost like the one from the framework but without some sbt tasks like 'deploy' that aren't needed for plugin developers.
+// Its almost like the one from the framework but without some sbt tasks like 'deploy' that aren't needed for plugin developers
+// and without dependencies, because those get their own generated file.
 
 // ---------------------------------------------------------------------------------------------------------------------
 // PROJECT INFORMATION
@@ -16,56 +17,6 @@ inThisBuild(List(
   retrieveManaged := false)
 )
 
-// ---------------------------------------------------------------------------------------------------------------------
-// LIBRARY DEPENDENCIES
-// ---------------------------------------------------------------------------------------------------------------------
-
-// Command Line Parsing
-libraryDependencies += "com.github.scopt" %% "scopt" % "3.5.0"
-
-// log4j Logger
-libraryDependencies += "org.slf4j" % "slf4j-log4j12" % "1.7.22"
-
-// Scalatra (REST, ...)
-libraryDependencies ++= Seq(
-  "org.scalatra" %% "scalatra" % "2.6.+",
-  "org.scalatra" %% "scalatra-scalate" % "2.6.+",
-  "org.scalatra" %% "scalatra-specs2" % "2.6.+",
-  "ch.qos.logback" % "logback-classic" % "1.2.3" % "provided",
-  "org.eclipse.jetty" % "jetty-webapp" % "9.4.7.v20170914" % "provided",
-  "javax.servlet" % "javax.servlet-api" % "3.1.0" % "provided",
-  "org.scalatra" %% "scalatra-json" % "2.6.3",
-  "org.scalatra" %% "scalatra-swagger" % "2.6.5",
-)
-
-// JSON Lib (Jackson)
-libraryDependencies += "org.json4s" %% "json4s-jackson" % "3.5.2"
-
-// PIRCBotX
-libraryDependencies += "org.pircbotx" % "pircbotx" % "2.1"
-
-// Reflections API for annotation indexing
-libraryDependencies += "org.reflections" % "reflections" % "0.9.11"
-
-// Akka Actors
-libraryDependencies ++= Seq(
-  "com.typesafe.akka" %% "akka-actor" % "2.5.18",
-  //"com.typesafe.akka" %% "akka-testkit" % "2.5.18" % Test
-)
-
-// Google GSON
-libraryDependencies += "com.google.code.gson" % "gson" % "2.8.5"
-
-// JDA
-resolvers += "jcenter-bintray" at "http://jcenter.bintray.com"
-libraryDependencies += "net.dv8tion" % "JDA" % "3.8.3_463"
-
-//Serial Communication
-libraryDependencies += "com.fazecast" % "jSerialComm" % "[2.0.0,3.0.0)"
-
-// Socket.io
-libraryDependencies += "io.socket" % "socket.io-client"% "1.0.0"
-
 unmanagedBase := file("bin")
 
 // ---------------------------------------------------------------------------------------------------------------------

project/BootstrapUtility.scala

@@ -70,12 +70,12 @@ object BootstrapUtility {
 
     logger info "Updating and modifying dependencies..."
 
-    // Modify dependencies: Remove ChatOverflow and opus-java, add scala library
+    // Modify dependencies: Remove opus-java, add scala library
     // opus-java is a virtual package which instructs sbt or any other build tool to get opus-java-api and opus-java-native.
     // Therefore it doesn't have a jar that needs to be downloaded and sbt includes the requested dependencies in the dependencyList.
     // So we can just ignore it as it can't be resolved and only need to include the requested deps in our xml.
     // Check https://github.com/discord-java/opus-java#opus-java-1 for more information on this.
-    val excludedDeps = List("chatoverflow", "chatoverflow-api", "opus-java")
+    val excludedDeps = List("opus-java")
     val filteredDeps = dependencyList.filter(d => !excludedDeps.contains(d.nameWithoutScalaVersion))
 
     val modifiedDependencies = filteredDeps ++
@@ -135,7 +135,7 @@ object BootstrapUtility {
    * @param logger              the sbt logger
    * @param scalaLibraryVersion the scala library major version
    */
-  def prepareDevDeploymentTask(logger: ManagedLogger, scalaLibraryVersion: String): Unit = {
+  def prepareDevDeploymentTask(logger: ManagedLogger, scalaLibraryVersion: String, dependencies: List[ModuleID]): Unit = {
     // Assuming, before this: clean, package and apiProject/packagedArtifacts
     // Assuming: Hardcoded "bin/" and "deployDev/" folders
     // Assuming: A folder called "deployment-files-dev" with more additional files for plugin developers
@@ -161,6 +161,10 @@ object BootstrapUtility {
         sbt.IO.copyFile(origFile, deployFile)
       }
 
+      // Fourth step: Create sbt files containing all dependencies
+      val depFile = new SbtFile(dependencies)
+      sbt.IO.write(new File("deployDev/dependencies.sbt"), depFile.toString)
+
       // Last step: Copy additional files
       val devDeploymentFiles = new File("deployment-files-dev/")
       if (!devDeploymentFiles.exists()) {

project/BuildUtility.scala

@@ -49,7 +49,7 @@ class BuildUtility(logger: ManagedLogger) {
       val allPlugins = getAllPlugins(pluginSourceFolderNames)
 
       // Create a sbt file with all plugin dependencies (sub projects)
-      val sbtFile = new SbtFile("", "", allPlugins, apiProjectPath, apiJarPath, defineRoot = true)
+      val sbtFile = new SbtFile("", "", allPlugins, apiProjectPath, apiJarPath, defineRoot = true, List())
 
       if (sbtFile.save(pluginBuildFileName)) {
         logger info s"Successfully updated plugin file at '$pluginBuildFileName'."

project/SbtFile.scala

@@ -1,5 +1,7 @@
 import java.io.{BufferedWriter, File, FileWriter, IOException}
 
+import sbt.librarymanagement.ModuleID
+
 /**
  * Represents a simple sbt files content and methods to create a new sbt file. Not intended to open/read sbt files.
  *
@@ -9,22 +11,30 @@ import java.io.{BufferedWriter, File, FileWriter, IOException}
  * @param apiProjectPath the path of a base api project which every project depends on
  * @param apiJarDirPath  the path of a directory containing jar files over the api. Designed to be a fallback to apiProjectPath
  * @param defineRoot     true, if a root project (".") should be defined in the sbt file
+ * @param dependencies   library dependencies to add to the sbt file
  */
 class SbtFile(val name: String, val version: String, val plugins: List[Plugin], val apiProjectPath: String,
-              val apiJarDirPath: String, val defineRoot: Boolean) {
+              val apiJarDirPath: String, val defineRoot: Boolean, dependencies: List[ModuleID]) {
   /**
     * Represents a simple sbt files content and methods to create a new sbt file. Not intended to open/read sbt files.
     *
     * @param name    the name of a sbt project
     * @param version the version of a sbt project
     */
-  def this(name: String, version: String) = this(name, version, List(), "", "", false)
+  def this(name: String, version: String) = this(name, version, List(), "", "", false, List())
 
   /**
     * Represents a simple sbt files content and methods to create a new sbt file. Not intended to open/read sbt files.
     */
   def this() = this("", "")
 
+  /**
+   * Represents a simple sbt files content and methods to create a new sbt file. Not intended to open/read sbt files.
+   *
+   * @param dependencies library dependencies to add to the sbt file
+   */
+  def this(dependencies: List[ModuleID]) = this("", "", List(), "", "", false, dependencies)
+
   /**
     * Tries to save the sbt files content into a defined directory.
     *
@@ -98,6 +108,16 @@ class SbtFile(val name: String, val version: String, val plugins: List[Plugin],
       sbtContent append rootLine
     }
 
+    if (dependencies.nonEmpty) {
+      sbtContent append "\nresolvers += \"jcenter-bintray\" at \"http://jcenter.bintray.com\"\n"
+
+      // Note that the %% in the string are required to escape the string formatter and will turn into a single %
+      val depString = dependencies.map(m => "\"%s\" %% \"%s\" %% \"%s\"".format(m.organization, m.name, m.revision))
+        .mkString("  ", ",\n  ", "")
+
+      sbtContent append s"libraryDependencies ++= Seq(\n$depString\n)\n"
+    }
+
     sbtContent.mkString
   }
 }