fix for review comment

Author: max-leuthaeuser

joern-cli/frontends/swiftsrc2cpg/src/main/scala/io/joern/swiftsrc2cpg/passes/ConfigFileCreationPass.scala

@@ -25,19 +25,26 @@ class ConfigFileCreationPass(cpg: Cpg, config: Config)
 
   override val configFileFilters: List[Path => Boolean] = List(extensionFilter(PlistExt), extensionFilter(".xib"))
 
+  private def isBinaryPlist(file: Path): Boolean = {
+    if (!file.extension().contains(PlistExt)) return false
+    Try(IOUtils.readLinesInFile(file)) match {
+      case Success(dataBeginning :: _) => dataBeginning.trim.startsWith("bplist")
+      case _                           => false
+    }
+  }
+
   override def runOnPart(diffGraph: DiffGraphBuilder, file: Path): Unit = {
-    val contentMaybe = if (file.extension().contains(PlistExt)) {
-      Try(PropertyListParser.parse(file.toFile).toXMLPropertyList)
+    val parseResult = if (isBinaryPlist(file)) {
+      val header = s"<!--This has been generated from ${file.toAbsolutePath}-->\n"
+      Try((PropertyListParser.parse(file.toFile).toXMLPropertyList, header))
     } else {
-      Try(IOUtils.readEntireFile(file))
+      Try((IOUtils.readEntireFile(file), ""))
     }
-    contentMaybe match {
-      case Success(content) =>
-        val configFileContent =
-          s"""<!--This has been generated from ${file.toAbsolutePath}-->
-             |$content""".stripMargin
-        val name       = configFileName(file)
-        val configNode = NewConfigFile().name(name).content(configFileContent)
+    parseResult match {
+      case Success((content, header)) =>
+        val configFileContent = s"$header$content"
+        val name              = configFileName(file)
+        val configNode        = NewConfigFile().name(name).content(configFileContent)
         logger.debug(s"Adding config file $name")
         diffGraph.addNode(configNode)
       case Failure(error) =>

joern-cli/frontends/swiftsrc2cpg/src/test/scala/io/joern/swiftsrc2cpg/passes/config/ConfigFileCreationPassTests.scala

@@ -15,14 +15,14 @@ import java.nio.file.Files
 class ConfigFileCreationPassTests extends AnyFunSpec with Matchers {
 
   private class TestDiffGraphBuilder extends io.shiftleft.codepropertygraph.generated.DiffGraphBuilder(GraphSchema) {
-    val nodes = scala.collection.mutable.Buffer[Any]()
+    val nodes = scala.collection.mutable.Buffer[DNode]()
     override def addNode(newNode: DNode): this.type = {
       this.nodes.append(newNode)
       this
     }
   }
 
-  private val xml: String =
+  private val Xml: String =
     """<?xml version="1.0" encoding="UTF-8"?>
       |<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
       |<plist version="1.0">
@@ -31,44 +31,43 @@ class ConfigFileCreationPassTests extends AnyFunSpec with Matchers {
       |  <string>value</string>
       |</dict>
       |</plist>""".stripMargin
+      // com.dd.plist.NSObject#toXMLPropertyList uses line separator when converting
       .replace("\n", System.lineSeparator())
-      .replace("  ", "\t") // com.dd.plist.NSObject#toXMLPropertyList uses tabs when converting
+      // com.dd.plist.NSObject#toXMLPropertyList uses tabs when converting
+      .replace("  ", "\t")
 
   describe("ConfigFileCreationPass") {
     it("creates config node for an XML plist") {
       FileUtil.usingTemporaryFile("test", ".plist") { xmlFile =>
-        Files.write(xmlFile, xml.getBytes("UTF-8"))
+        Files.write(xmlFile, Xml.getBytes("UTF-8"))
 
-        val config = Config()
-        val pass   = new ConfigFileCreationPass(null /* cpg not used in here */, config)
-        val diff   = new TestDiffGraphBuilder
+        val pass = new ConfigFileCreationPass(null /* cpg not used in here */, Config())
+        val diff = new TestDiffGraphBuilder
 
-        // run the pass on the XML file
         pass.runOnPart(diff, xmlFile)
         diff.nodes.nonEmpty shouldBe true
         val node = diff.nodes.collectFirst { case n: NewConfigFile => n }.get
         node.name should (startWith("test") and endWith(".plist"))
-        node.content should (startWith("<!--This has been generated from") and endWith(xml))
+        node.content shouldBe Xml
       }
     }
 
     it("creates config node for a binary plist") {
       FileUtil.usingTemporaryFile("testbin-src", ".plist") { xmlFile =>
         FileUtil.usingTemporaryFile("testbin", ".plist") { binFile =>
-          Files.write(xmlFile, xml.getBytes("UTF-8"))
+          Files.write(xmlFile, Xml.getBytes("UTF-8"))
           PropertyListConverter.convertToBinary(xmlFile, binFile)
 
-          val config = Config()
-          val pass   = new ConfigFileCreationPass(null /* cpg not used in here */, config)
-          val diff   = new TestDiffGraphBuilder
+          val pass = new ConfigFileCreationPass(null /* cpg not used in here */, Config())
+          val diff = new TestDiffGraphBuilder
 
           pass.runOnPart(diff, binFile)
 
           diff.nodes.nonEmpty shouldBe true
           val node = diff.nodes.collectFirst { case n: NewConfigFile => n }.get
           node.name should (startWith("testbin") and endWith(".plist"))
           // binary should have been converted to XML content:
-          node.content should (startWith("<!--This has been generated from") and endWith(xml))
+          node.content should (startWith("<!--This has been generated from") and endWith(Xml))
         }
       }
     }