Install schema extensions from plugin zip files (#1075)

* WIP install schema extensions from plugin zip files

* Run schema-extender.sh

* Removal of installed schema extensions

Author: fabsx00

console/src/main/scala/io/shiftleft/console/PluginManager.scala

@@ -4,13 +4,14 @@ import better.files.Dsl._
 import better.files.File.apply
 
 import java.nio.file.Path
+import scala.sys.process.Process
 import scala.util.{Failure, Success, Try}
 
 /**
   * Plugin management component
   * @param installDir the Joern/Ocular installation dir
   * */
-class PluginManager(installDir: File) {
+class PluginManager(val installDir: File) {
 
   def listPlugins(): List[String] = {
     val installedPluginNames = pluginDir.toList
@@ -55,6 +56,26 @@ class PluginManager(installDir: File) {
         }
       }
     }
+    installSchemaExtensions(file, pluginName)
+  }
+
+  private def installSchemaExtensions(file: File, pluginName: String): Unit = {
+    schemaDir.foreach { sDir =>
+      file.listRecursively
+        .filter(_.path.toString.contains("schema"))
+        .filter(_.name.endsWith(".json"))
+        .foreach { json =>
+          val name = json.name
+          val dstFileName = s"joernext-$pluginName-$name"
+          cp(json, sDir / dstFileName)
+        }
+    }
+    try {
+      Process("./schema-extender.sh", installDir.toJava).!!
+    } catch {
+      case e: Exception =>
+        System.err.println(s"Error running schema-extender: ${e.getMessage}")
+    }
   }
 
   private def extractToTemporaryDir(file: File) = {
@@ -76,9 +97,13 @@ class PluginManager(installDir: File) {
         dir.list.filter { f =>
           f.name.startsWith(s"joernext-$name")
         }
+      } ++ schemaDir.toList.flatMap { dir =>
+        dir.list.filter { f =>
+          f.name.startsWith(s"joernext-$name")
+        }
       }
       filesToRemove.foreach(f => f.delete())
-      filesToRemove.map(_.name)
+      filesToRemove.map(_.pathAsString)
     }
   }
 
@@ -92,4 +117,14 @@ class PluginManager(installDir: File) {
     }
   }
 
+  def schemaDir: Option[Path] = {
+    val pathToSchemaDir = installDir.path.resolve("schema-extender/schemas/")
+    if (pathToSchemaDir.toFile.exists()) {
+      Some(pathToSchemaDir)
+    } else {
+      println(s"Schema directory at $pathToSchemaDir does not exist")
+      None
+    }
+  }
+
 }

console/src/test/resources/test.zip

@@ -5,6 +5,8 @@ import better.files._
 import org.scalatest.matchers.should.Matchers
 import org.scalatest.wordspec.AnyWordSpec
 
+import java.nio.file.attribute.PosixFilePermission
+
 class PluginManagerTests extends AnyWordSpec with Matchers {
 
   "PluginManager::add" should {
@@ -27,6 +29,18 @@ class PluginManagerTests extends AnyWordSpec with Matchers {
         case None => fail
       }
     }
+
+    "copy schema file in zip to schema dir and execute schema extender" in Fixture() { manager =>
+      val testZipFileName = "console/src/test/resources/test.zip"
+      manager.add(testZipFileName)
+      manager.schemaDir match {
+        case Some(dir) =>
+          dir.toFile.list().toList shouldBe List("joernext-test-foo.json")
+          (manager.installDir / "out.txt").exists shouldBe true
+        case None => fail
+      }
+    }
+
   }
 
   "PluginManager::rm" should {
@@ -38,10 +52,10 @@ class PluginManagerTests extends AnyWordSpec with Matchers {
     "remove existing plugin" in Fixture() { manager =>
       val testZipFileName = "console/src/test/resources/test.zip"
       manager.add(testZipFileName)
-      manager.rm("test") shouldBe List("joernext-test-foo.jar")
+      manager.rm("test").map(x => File(x).name).toSet shouldBe Set("joernext-test-foo.jar", "joernext-test-foo.json")
       manager.listPlugins() shouldBe List()
       manager.add(testZipFileName)
-      manager.rm("test") shouldBe List("joernext-test-foo.jar")
+      manager.rm("test").map(x => File(x).name).toSet shouldBe Set("joernext-test-foo.jar", "joernext-test-foo.json")
       manager.listPlugins() shouldBe List()
     }
 
@@ -67,6 +81,11 @@ object Fixture {
   def apply[T]()(f: PluginManager => T): T = {
     val dir = File.newTemporaryDirectory("pluginmantests")
     mkdir(dir / "lib")
+    mkdirs(dir / "schema-extender" / "schemas")
+    val extender = dir / "schema-extender.sh"
+    val extenderContents = "#!/bin/sh\necho 'foo' > " + (dir / "out.txt")
+    extender.write(extenderContents)
+    chmod_+(PosixFilePermission.OWNER_EXECUTE, extender)
     val result = f(new PluginManager(dir))
     dir.delete()
     result