🔖 Release v1.0.0

.github/workflows/docs.yml

@@ -2,7 +2,7 @@ name: Documentation
 
 on:
   push:
-    tags: [ 'v*' ] # Push events to matching v*, i.e. v1.0, v20.15.10
+    tags: [ 'd*' ] # Temporarily disable this job
 
 jobs:
   publish:
@@ -12,15 +12,23 @@ jobs:
     steps:
       - uses: actions/checkout@v2
         with:
-          lfs: true
           fetch-depth: 0
 
       - name: Set up JDK 11
         uses: actions/setup-java@v1
         with:
           java-version: 11
 
+      - name: Setup SSH Keys and known_hosts
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
+
       - name: Build code
         run: sbt stage
-      - name: Build and deploy Scala documentation
-        run: sbt makeSite ghpagesPushSite
+      - name: Build ScalaDoc website
+        run: sbt makeSite
+      - name: Deploy ScalaSite
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: sbt ghpagesPushSite

.github/workflows/release.yml

@@ -2,7 +2,7 @@ name: Release
 
 on:
   push:
-    tags: [ 'v*' ] # Push events to matching v*, i.e. v1.0, v20.15.10
+    tags: [ '[0-9]+.[0-9]+.[0-9]+' ] # Push events to matching v*, i.e. 1.0.0, 20.15.10
 
 jobs:
   publish:

CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.0.0] - 2022-01-04
+
+### Changed
+
+- Whole project migrated to Scala
+- Every transaction as far as possible is a bulk transaction
+- Processing follows closely to layers used in other Joern frontends
+- Package structure changed from io.github to com.github
+
+### Removed
+
+- JanusGraph support
+
 ## [0.6.3] - 2021-12-10
 
 ### Fixed

README.md

@@ -40,7 +40,8 @@ params:
   txMax: 25
 ```
 
-For more documentation and basic guides, check out the [project homepage](https://plume-oss.github.io/plume-docs/).
+For more documentation and basic guides, check out the [project homepage](https://plume-oss.github.io/plume-docs/) or
+the [ScalaDoc](https://plume-oss.github.io/plume/latest/api/io/github/plume/oss/index.html).
 
 ## Community
 
@@ -58,17 +59,14 @@ Replace `X.X.X` with the desired version on [JitPack](https://jitpack.io/#plume-
 
 ```sbt
 libraryDependencies ++= Seq(
-  io.github.plume-oss %% plume % X.X.X
+  com.github.plume-oss % plume % X.X.X
 )
 ```
 
 Don't forget to include the JCenter and JitPack repository in your `build.sbt`.
 
 ```sbt
-resolvers ++= Seq(
-  "jitpack" at "https://jitpack.io",
-  Resolver.JCenterRepository
-)
+resolvers += "jitpack" at "https://jitpack.io"
 ```
 
 ## Building from Source

build.sbt

@@ -1,5 +1,5 @@
 name := "Plume"
-organization := "io.github.plume-oss"
+organization := "com.github.plume-oss"
 version := "1.0.0"
 
 scalaVersion := "2.13.6"
@@ -65,8 +65,10 @@ enablePlugins(
 )
 
 scmInfo := Some(
-  ScmInfo(url("https://github.com/plume-oss/plume"), "scm:[email protected]:/plume-oss/plume.git")
+  ScmInfo(url("https://github.com/plume-oss/plume"), "[email protected]:plume-oss/plume.git")
 )
+git.remoteRepo := scmInfo.value.get.connection
+
 homepage := Some(url("https://github.com/plume-oss/plume/"))
 licenses := List("Apache-2.0" -> url("https://www.apache.org/licenses/LICENSE-2.0"))
 developers := List(
@@ -84,10 +86,10 @@ developers := List(
   )
 )
 
-git.remoteRepo := "[email protected]:plume-oss/plume.git"
-
 Global / onChangedBuildSource := ReloadOnSourceChanges
 
+publishMavenStyle := true
+
 lazy val root = (project in file("."))
   .configs(NeoIntTest)
   .settings(

jitpack.yml

@@ -0,0 +1,2 @@
+jdk:
+  - openjdk11

project/build.properties

@@ -1 +1 @@
-sbt.version=1.5.5
+sbt.version=1.5.7

src/main/scala/io/github/plume/oss/HashUtil.scala → src/main/scala/com/github/plume/oss/HashUtil.scala

@@ -1,4 +1,4 @@
-package io.github.plume.oss
+package com.github.plume.oss
 
 import net.jpountz.xxhash.{StreamingXXHash32, XXHashFactory}
 

src/main/scala/io/github/plume/oss/Jimple2Cpg.scala → src/main/scala/com/github/plume/oss/Jimple2Cpg.scala

@@ -1,14 +1,29 @@
-package io.github.plume.oss
+package com.github.plume.oss
 
-import io.github.plume.oss.drivers.{IDriver, OverflowDbDriver}
-import io.github.plume.oss.passes._
-import io.github.plume.oss.passes.concurrent.{
+import com.github.plume.oss.drivers.{IDriver, OverflowDbDriver}
+import com.github.plume.oss.passes.concurrent.{
   PlumeCfgCreationPass,
   PlumeContainsEdgePass,
   PlumeDiffPass,
   PlumeHashPass
 }
-import io.github.plume.oss.passes.parallel._
+import com.github.plume.oss.passes.parallel.{
+  AstCreationPass,
+  PlumeCdgPass,
+  PlumeCfgDominatorPass,
+  PlumeMethodStubCreator,
+  PlumeReachingDefPass
+}
+import com.github.plume.oss.passes.{
+  IncrementalKeyPool,
+  PlumeCpgPassBase,
+  PlumeFileCreationPass,
+  PlumeMetaDataPass,
+  PlumeMethodDecoratorPass,
+  PlumeNamespaceCreator,
+  PlumeTypeDeclStubCreator,
+  PlumeTypeNodePass
+}
 import io.shiftleft.codepropertygraph.Cpg
 import io.shiftleft.codepropertygraph.generated.{NodeTypes, PropertyNames}
 import io.shiftleft.passes.CpgPassBase
@@ -71,7 +86,6 @@ class Jimple2Cpg {
       val sourceCodePath = if (rawSourceCodeFile.isDirectory) {
         rawSourceCodeFile.toPath.toAbsolutePath.normalize.toString
       } else {
-        println(rawSourceCodeFile.getAbsolutePath)
         Paths
           .get(new JFile(rawSourceCodeFile.getAbsolutePath).getParentFile.getAbsolutePath)
           .normalize

src/main/scala/io/github/plume/oss/Plume.scala → src/main/scala/com/github/plume/oss/Plume.scala

@@ -1,7 +1,14 @@
-package io.github.plume.oss
+package com.github.plume.oss
 
 import better.files.File
-import io.github.plume.oss.drivers._
+import com.github.plume.oss.drivers.{
+  IDriver,
+  Neo4jDriver,
+  NeptuneDriver,
+  OverflowDbDriver,
+  TigerGraphDriver,
+  TinkerGraphDriver
+}
 import io.shiftleft.x2cpg.{X2Cpg, X2CpgConfig}
 import scopt.OParser
 

src/main/scala/io/github/plume/oss/drivers/GremlinDriver.scala → src/main/scala/com/github/plume/oss/drivers/GremlinDriver.scala

@@ -1,4 +1,4 @@
-package io.github.plume.oss.drivers
+package com.github.plume.oss.drivers
 
 import io.shiftleft.codepropertygraph.generated.nodes.{AbstractNode, NewNode, StoredNode}
 import io.shiftleft.codepropertygraph.generated.{EdgeTypes, NodeTypes, PropertyNames}

src/main/scala/io/github/plume/oss/drivers/IDriver.scala → src/main/scala/com/github/plume/oss/drivers/IDriver.scala

@@ -1,4 +1,4 @@
-package io.github.plume.oss.drivers
+package com.github.plume.oss.drivers
 
 import io.shiftleft.codepropertygraph.generated.nodes.{AbstractNode, NewNode, StoredNode}
 import io.shiftleft.codepropertygraph.generated.{EdgeTypes, NodeTypes, PropertyNames}

src/main/scala/io/github/plume/oss/drivers/Neo4jDriver.scala → src/main/scala/com/github/plume/oss/drivers/Neo4jDriver.scala

@@ -1,5 +1,6 @@
-package io.github.plume.oss.drivers
-import io.github.plume.oss.drivers.Neo4jDriver._
+package com.github.plume.oss.drivers
+
+import Neo4jDriver._
 import io.shiftleft.codepropertygraph.generated.nodes.NewNode
 import io.shiftleft.codepropertygraph.generated.{EdgeTypes, NodeTypes, PropertyNames}
 import io.shiftleft.passes.AppliedDiffGraph

src/main/scala/io/github/plume/oss/drivers/NeptuneDriver.scala → src/main/scala/com/github/plume/oss/drivers/NeptuneDriver.scala

@@ -1,8 +1,8 @@
-package io.github.plume.oss.drivers
+package com.github.plume.oss.drivers
 
 import io.circe.generic.semiauto.deriveDecoder
 import io.circe.{Decoder, jawn}
-import io.github.plume.oss.drivers.NeptuneDriver.DEFAULT_PORT
+import NeptuneDriver.DEFAULT_PORT
 import org.apache.tinkerpop.gremlin.driver.Cluster
 import org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
 import org.apache.tinkerpop.gremlin.process.traversal.AnonymousTraversalSource

src/main/scala/io/github/plume/oss/drivers/OverflowDbDriver.scala → src/main/scala/com/github/plume/oss/drivers/OverflowDbDriver.scala

@@ -1,7 +1,7 @@
-package io.github.plume.oss.drivers
+package com.github.plume.oss.drivers
 
-import io.github.plume.oss.drivers.OverflowDbDriver.newOverflowGraph
-import io.github.plume.oss.passes.PlumeDynamicCallLinker
+import OverflowDbDriver.newOverflowGraph
+import com.github.plume.oss.passes.PlumeDynamicCallLinker
 import io.joern.dataflowengineoss.language.toExtendedCfgNode
 import io.joern.dataflowengineoss.queryengine.{EngineConfig, EngineContext}
 import io.joern.dataflowengineoss.semanticsloader.{Parser, Semantics}
@@ -16,6 +16,7 @@ import overflowdb.{Config, Node}
 
 import java.io.{File => JFile}
 import scala.collection.mutable
+import scala.io.Source
 import scala.jdk.CollectionConverters.IteratorHasAsScala
 import scala.util.{Failure, Success, Try}
 
@@ -30,9 +31,10 @@ case class OverflowDbDriver(
     maxCallDepth: Int = 2
 ) extends IDriver {
 
-  private val logger                  = LoggerFactory.getLogger(classOf[OverflowDbDriver])
-  private val semanticsParser         = new Parser()
-  private val defaultSemantics        = getClass.getClassLoader.getResource("default.semantics")
+  private val logger          = LoggerFactory.getLogger(classOf[OverflowDbDriver])
+  private val semanticsParser = new Parser()
+  private val defaultSemantics =
+    Source.fromInputStream(getClass.getClassLoader.getResourceAsStream("default.semantics"))
   implicit var context: EngineContext = loadDataflowContext(maxCallDepth)
 
   private val odbConfig = Config
@@ -48,7 +50,7 @@ case class OverflowDbDriver(
   def loadDataflowContext(maxCallDepth: Int): EngineContext = {
     if (defaultSemantics != null) {
       EngineContext(
-        Semantics.fromList(semanticsParser.parseFile(defaultSemantics.getFile)),
+        Semantics.fromList(semanticsParser.parse(defaultSemantics.getLines().mkString("\n"))),
         EngineConfig(maxCallDepth)
       )
     } else {

src/main/scala/io/github/plume/oss/drivers/TigerGraphDriver.scala → src/main/scala/com/github/plume/oss/drivers/TigerGraphDriver.scala

@@ -1,10 +1,10 @@
-package io.github.plume.oss.drivers
+package com.github.plume.oss.drivers
 
 import io.circe
 import io.circe.generic.auto._
 import io.circe.syntax._
 import io.circe.{Encoder, Json, JsonObject}
-import io.github.plume.oss.drivers.TigerGraphDriver._
+import TigerGraphDriver._
 import io.shiftleft.codepropertygraph.generated.nodes._
 import io.shiftleft.codepropertygraph.generated.{EdgeTypes, NodeTypes, PropertyNames}
 import io.shiftleft.passes.AppliedDiffGraph

src/main/scala/io/github/plume/oss/drivers/TinkerGraphDriver.scala → src/main/scala/com/github/plume/oss/drivers/TinkerGraphDriver.scala

@@ -1,4 +1,4 @@
-package io.github.plume.oss.drivers
+package com.github.plume.oss.drivers
 
 import org.slf4j.{Logger, LoggerFactory}
 

src/main/scala/io/github/plume/oss/passes/IncrementalKeyPool.scala → src/main/scala/com/github/plume/oss/passes/IncrementalKeyPool.scala

@@ -1,4 +1,4 @@
-package io.github.plume.oss.passes
+package com.github.plume.oss.passes
 
 import io.shiftleft.passes.KeyPool
 

src/main/scala/io/github/plume/oss/passes/PlumeCpgPass.scala → src/main/scala/com/github/plume/oss/passes/PlumeCpgPass.scala

@@ -1,6 +1,6 @@
-package io.github.plume.oss.passes
+package com.github.plume.oss.passes
 
-import io.github.plume.oss.drivers.IDriver
+import com.github.plume.oss.drivers.IDriver
 import io.shiftleft.codepropertygraph.Cpg
 import io.shiftleft.codepropertygraph.generated.PropertyNames
 import io.shiftleft.codepropertygraph.generated.nodes.{AbstractNode, NewNode, StoredNode}

src/main/scala/com/github/plume/oss/passes/PlumeCpgPassBase.scala

@@ -0,0 +1,9 @@
+package com.github.plume.oss.passes
+
+import com.github.plume.oss.drivers.IDriver
+
+trait PlumeCpgPassBase {
+
+  def createAndApply(driver: IDriver): Unit
+
+}

src/main/scala/io/github/plume/oss/passes/PlumeDynamicCallLinker.scala → src/main/scala/com/github/plume/oss/passes/PlumeDynamicCallLinker.scala

@@ -1,4 +1,4 @@
-package io.github.plume.oss.passes
+package com.github.plume.oss.passes
 
 import io.shiftleft.codepropertygraph.Cpg
 import io.shiftleft.codepropertygraph.generated.nodes.{Call, Method, TypeDecl}

src/main/scala/io/github/plume/oss/passes/concurrent/PlumeCfgCreationPass.scala → src/main/scala/com/github/plume/oss/passes/concurrent/PlumeCfgCreationPass.scala

@@ -1,7 +1,7 @@
-package io.github.plume.oss.passes.concurrent
+package com.github.plume.oss.passes.concurrent
 
-import io.github.plume.oss.drivers.IDriver
-import io.github.plume.oss.passes.PlumeCpgPassBase
+import com.github.plume.oss.drivers.IDriver
+import com.github.plume.oss.passes.PlumeCpgPassBase
 import io.shiftleft.codepropertygraph.Cpg
 import io.shiftleft.passes.DiffGraph
 import io.shiftleft.semanticcpg.passes.controlflow.CfgCreationPass

src/main/scala/io/github/plume/oss/passes/concurrent/PlumeConcurrentCpgPass.scala → src/main/scala/com/github/plume/oss/passes/concurrent/PlumeConcurrentCpgPass.scala

@@ -1,6 +1,6 @@
-package io.github.plume.oss.passes.concurrent
+package com.github.plume.oss.passes.concurrent
 
-import io.github.plume.oss.drivers.IDriver
+import com.github.plume.oss.drivers.IDriver
 import io.shiftleft.codepropertygraph.Cpg
 import io.shiftleft.codepropertygraph.generated.nodes.AstNode
 import io.shiftleft.passes.{ConcurrentWriterCpgPass, DiffGraph}

src/main/scala/io/github/plume/oss/passes/concurrent/PlumeConcurrentWriter.scala → src/main/scala/com/github/plume/oss/passes/concurrent/PlumeConcurrentWriter.scala

@@ -1,6 +1,6 @@
-package io.github.plume.oss.passes.concurrent
+package com.github.plume.oss.passes.concurrent
 
-import io.github.plume.oss.drivers.IDriver
+import com.github.plume.oss.drivers.IDriver
 import io.shiftleft.codepropertygraph.Cpg
 import io.shiftleft.passes.{CpgPass, DiffGraph}
 import org.slf4j.{Logger, LoggerFactory}

src/main/scala/io/github/plume/oss/passes/concurrent/PlumeContainsEdgePass.scala → src/main/scala/com/github/plume/oss/passes/concurrent/PlumeContainsEdgePass.scala

@@ -1,7 +1,7 @@
-package io.github.plume.oss.passes.concurrent
+package com.github.plume.oss.passes.concurrent
 
-import io.github.plume.oss.drivers.IDriver
-import io.github.plume.oss.passes.PlumeCpgPassBase
+import com.github.plume.oss.drivers.IDriver
+import com.github.plume.oss.passes.PlumeCpgPassBase
 import io.shiftleft.codepropertygraph.Cpg
 import io.shiftleft.passes.DiffGraph
 import io.shiftleft.semanticcpg.passes.base.ContainsEdgePass

src/main/scala/io/github/plume/oss/passes/concurrent/PlumeDiffPass.scala → src/main/scala/com/github/plume/oss/passes/concurrent/PlumeDiffPass.scala

@@ -1,7 +1,7 @@
-package io.github.plume.oss.passes.concurrent
+package com.github.plume.oss.passes.concurrent
 
-import io.github.plume.oss.HashUtil
-import io.github.plume.oss.drivers.IDriver
+import com.github.plume.oss.HashUtil
+import com.github.plume.oss.drivers.IDriver
 import io.shiftleft.codepropertygraph.generated.{NodeTypes, PropertyNames}
 import org.slf4j.{Logger, LoggerFactory}
 

src/main/scala/io/github/plume/oss/passes/concurrent/PlumeHashPass.scala → src/main/scala/com/github/plume/oss/passes/concurrent/PlumeHashPass.scala

@@ -1,6 +1,6 @@
-package io.github.plume.oss.passes.concurrent
+package com.github.plume.oss.passes.concurrent
 
-import io.github.plume.oss.HashUtil
+import com.github.plume.oss.HashUtil
 import io.shiftleft.codepropertygraph.Cpg
 import io.shiftleft.codepropertygraph.generated.PropertyNames
 import io.shiftleft.codepropertygraph.generated.nodes.File

src/main/scala/io/github/plume/oss/passes/parallel/PlumeAstCreationPass.scala → src/main/scala/com/github/plume/oss/passes/parallel/PlumeAstCreationPass.scala

@@ -1,7 +1,7 @@
-package io.github.plume.oss.passes.parallel
+package com.github.plume.oss.passes.parallel
 
-import io.github.plume.oss.Jimple2Cpg
-import io.github.plume.oss.passes.IncrementalKeyPool
+import com.github.plume.oss.Jimple2Cpg
+import com.github.plume.oss.passes.IncrementalKeyPool
 import io.shiftleft.codepropertygraph.Cpg
 import io.shiftleft.passes.DiffGraph
 import org.slf4j.LoggerFactory