NamespaceBlock tests and cleanup (#1067)

Author: fabsx00

fuzzyc2cpg-tests/src/test/scala/io/shiftleft/fuzzyc2cpg/querying/NamespaceBlockTests.scala

@@ -0,0 +1,41 @@
+package io.shiftleft.fuzzyc2cpg.querying
+
+import io.shiftleft.fuzzyc2cpg.testfixtures.FuzzyCCodeToCpgSuite
+import io.shiftleft.semanticcpg.language._
+import io.shiftleft.semanticcpg.language.types.structure.{File, Namespace}
+
+class NamespaceBlockTests extends FuzzyCCodeToCpgSuite {
+
+  // The fuzzyC parser currently just ignores namespaces. We place symbols
+  // that can't be associated in a file into the namespace "<global>", and
+  // those which can in `filename:<global>`
+
+  override val code: String =
+    """
+      |""".stripMargin
+
+  "should contain two namespace blocks in total" in {
+    cpg.namespaceBlock.size shouldBe 2
+  }
+
+  "should contain a correct global namespace block for the `<unknown>` file" in {
+    cpg.namespaceBlock.filename(File.UNKNOWN).l match {
+      case List(x) =>
+        x.name shouldBe Namespace.globalNamespaceName
+        x.fullName shouldBe Namespace.globalNamespaceName
+        x.order shouldBe 0
+      case _ => fail
+    }
+  }
+
+  "should contain correct namespace block for known file" in {
+    cpg.namespaceBlock.filenameNot(File.UNKNOWN).l match {
+      case List(x) =>
+        x.name shouldBe Namespace.globalNamespaceName
+        x.fullName shouldBe s"${x.filename}:${Namespace.globalNamespaceName}"
+        x.order shouldBe 0
+      case _ => fail
+    }
+  }
+
+}

fuzzyc2cpg/src/main/scala/io/shiftleft/fuzzyc2cpg/Defines.scala

@@ -1,7 +1,6 @@
 package io.shiftleft.fuzzyc2cpg
 
 object Defines {
-  val globalNamespaceName = "<global>"
   val anyTypeName = "ANY"
   val voidTypeName = "void"
   val charPointerTypeName = "char *"

fuzzyc2cpg/src/main/scala/io/shiftleft/fuzzyc2cpg/passes/AstCreationPass.scala

@@ -3,8 +3,9 @@ package io.shiftleft.fuzzyc2cpg.passes
 import io.shiftleft.codepropertygraph.Cpg
 import io.shiftleft.codepropertygraph.generated.nodes
 import io.shiftleft.fuzzyc2cpg.passes.astcreation.{AntlrCModuleParserDriver, AstVisitor}
-import io.shiftleft.fuzzyc2cpg.{Defines, Global}
+import io.shiftleft.fuzzyc2cpg.Global
 import io.shiftleft.passes.{DiffGraph, IntervalKeyPool, ParallelCpgPass}
+import io.shiftleft.semanticcpg.language.types.structure.Namespace
 import org.slf4j.LoggerFactory
 
 /**
@@ -24,9 +25,10 @@ class AstCreationPass(filenames: List[String], cpg: Cpg, keyPool: IntervalKeyPoo
     val diffGraph = DiffGraph.newBuilder
     val absolutePath = new java.io.File(filename).toPath.toAbsolutePath.normalize().toString
     val namespaceBlock = nodes.NewNamespaceBlock(
-      name = Defines.globalNamespaceName,
+      name = Namespace.globalNamespaceName,
       fullName = CMetaDataPass.getGlobalNamespaceBlockFullName(Some(absolutePath)),
-      filename = absolutePath
+      filename = absolutePath,
+      order = 0
     )
     diffGraph.addNode(namespaceBlock)
     val driver = createDriver(namespaceBlock)

fuzzyc2cpg/src/main/scala/io/shiftleft/fuzzyc2cpg/passes/CMetaDataPass.scala

@@ -2,8 +2,8 @@ package io.shiftleft.fuzzyc2cpg.passes
 
 import io.shiftleft.codepropertygraph.Cpg
 import io.shiftleft.codepropertygraph.generated.{Languages, nodes}
-import io.shiftleft.fuzzyc2cpg.Defines
 import io.shiftleft.passes.{CpgPass, DiffGraph, KeyPool}
+import io.shiftleft.semanticcpg.language.types.structure.{File, Namespace}
 
 /**
   * A pass that creates a MetaData node, specifying that this
@@ -19,8 +19,10 @@ class CMetaDataPass(cpg: Cpg, keyPool: Option[KeyPool] = None) extends CpgPass(c
 
     def addAnyNamespaceBlock(diffGraph: DiffGraph.Builder): Unit = {
       val node = nodes.NewNamespaceBlock(
-        name = Defines.globalNamespaceName,
-        fullName = CMetaDataPass.getGlobalNamespaceBlockFullName(None)
+        name = Namespace.globalNamespaceName,
+        fullName = CMetaDataPass.getGlobalNamespaceBlockFullName(None),
+        filename = File.UNKNOWN,
+        order = 0
       )
       diffGraph.addNode(node)
     }
@@ -37,9 +39,9 @@ object CMetaDataPass {
   def getGlobalNamespaceBlockFullName(fileNameOption: Option[String]): String = {
     fileNameOption match {
       case Some(fileName) =>
-        s"$fileName:${Defines.globalNamespaceName}"
+        s"$fileName:${Namespace.globalNamespaceName}"
       case None =>
-        Defines.globalNamespaceName
+        Namespace.globalNamespaceName
     }
   }
 

fuzzyc2cpg/src/test/scala/io/shiftleft/fuzzyc2cpg/ProgramStructureTests.scala

@@ -2,6 +2,7 @@ package io.shiftleft.fuzzyc2cpg
 
 import io.shiftleft.codepropertygraph.generated.NodeKeys
 import io.shiftleft.proto.cpg.Cpg.CpgStruct.Node.NodeType
+import io.shiftleft.semanticcpg.language.types.structure.Namespace
 import org.scalatest.matchers.should.Matchers
 import org.scalatest.wordspec.AnyWordSpec
 import overflowdb._
@@ -15,7 +16,7 @@ class ProgramStructureTests extends AnyWordSpec with Matchers {
       val namespaceBlocks =
         fixture.traversalSource
           .label(NodeType.NAMESPACE_BLOCK.toString)
-          .has(NodeKeys.FULL_NAME -> Defines.globalNamespaceName)
+          .has(NodeKeys.FULL_NAME -> Namespace.globalNamespaceName)
           .l
 
       namespaceBlocks.size shouldBe 1

fuzzyc2cpg/src/test/scala/io/shiftleft/fuzzyc2cpg/passes/CMetaDataPassTests.scala

@@ -1,8 +1,8 @@
 package io.shiftleft.fuzzyc2cpg.passes
 
 import io.shiftleft.codepropertygraph.Cpg
-import io.shiftleft.fuzzyc2cpg.Defines
 import io.shiftleft.semanticcpg.language._
+import io.shiftleft.semanticcpg.language.types.structure.Namespace
 import org.scalatest.matchers.should.Matchers
 import org.scalatest.wordspec.AnyWordSpec
 
@@ -27,7 +27,7 @@ class CMetaDataPassTests extends AnyWordSpec with Matchers {
     }
 
     "create a '<global>' NamespaceBlock" in {
-      cpg.namespaceBlock.name.l shouldBe List(Defines.globalNamespaceName)
+      cpg.namespaceBlock.name.l shouldBe List(Namespace.globalNamespaceName)
     }
 
   }

schema/src/main/resources/schemas/source-specific.json

@@ -10,7 +10,6 @@
 
 	{"name" : "FILE",
 	 "outEdges" : [
-	   // TODO: remove AST edge here
 	   {"edgeName": "AST", "inNodes": [{"name": "COMMENT"}]}
 	 ]
 	}

semanticcpg/src/main/scala/io/shiftleft/semanticcpg/language/types/structure/Namespace.scala

@@ -44,3 +44,9 @@ class Namespace(val traversal: Traversal[nodes.Namespace]) extends AnyVal {
     traversal.where(_.typeDecl.internal)
 
 }
+
+object Namespace {
+
+  val globalNamespaceName = "<global>"
+
+}