Add core-sparql-protos-google (#713)

Author: Ostrzyciel

build.sbt

@@ -127,9 +127,13 @@ def doPrepareGoogleProtos(baseDir: File): Seq[File] = {
       outputFile
     }
     .map { file =>
-      // Append java options to the file
-      val outPackage = "eu.neverblink.jelly.core.proto.google.v1" +
-        (if (file.getName == "patch.proto") ".patch" else "")
+      // Append java options to the file. The sub-package must match the one the crunchy plugin
+      // uses for the same file, so that the two sets of classes can live side by side.
+      val outPackage = "eu.neverblink.jelly.core.proto.google.v1" + (file.getName match {
+        case "patch.proto" => ".patch"
+        case "sparql.proto" => ".sparql"
+        case _ => ""
+      })
       val content = IO.read(file)
       val newContent = content +
         f"""
@@ -440,7 +444,42 @@ lazy val coreSparql = (project in file("core-sparql"))
     commonSettings,
     commonJavaSettings,
   )
-  .dependsOn(core % "compile->compile;test->test")
+  .dependsOn(
+    core % "compile->compile;test->test",
+    // Test-time dependency on Google protos for SparqlProtoSpec
+    coreSparqlProtosGoogle % "test->compile",
+  )
+
+lazy val coreSparqlProtosGoogle = (project in file("core-sparql-protos-google"))
+  .enablePlugins(ProtobufPlugin)
+  .settings(
+    name := "jelly-core-sparql-protos-google",
+    description := "Optional proto classes for Jelly-SPARQL (sparql.proto) compiled with Google's " +
+      "official Java protoc plugin. This is not needed, unless you need some functionality " +
+      "that is only available with the more heavyweight, Google-style proto classes, like " +
+      "support for the Protobuf Text Format.",
+    libraryDependencies ++= Seq("com.google.protobuf" % "protobuf-java" % protobufV),
+    prepareGoogleProtos := Def.uncached { doPrepareGoogleProtos(baseDirectory.value) },
+    Compile / compile := Def.uncached((Compile / compile).dependsOn(prepareGoogleProtos).value),
+    ProtobufConfig / protobufRunProtoc := Def.uncached(
+      (ProtobufConfig / protobufRunProtoc).dependsOn(
+        prepareGoogleProtos,
+      ).value,
+    ),
+    // See the comment in corePatchProtosGoogle: the scan of src/main/protobuf has to be ordered
+    // after prepareGoogleProtos, or a clean checkout generates nothing.
+    ProtobufConfig / protobufSources := Def.uncached(
+      (ProtobufConfig / protobufSources).dependsOn(prepareGoogleProtos).value,
+    ),
+    ProtobufConfig / protobufIncludeFilters := Seq(
+      Glob(baseDirectory.value.toPath) / "**" / "sparql.proto",
+    ),
+    // Don't throw errors, because Google's protoc generates code with a lot of warnings
+    javacOptions := javacOptions.value.filterNot(_ == "-Werror"),
+    commonSettings,
+    commonJavaSettings,
+    // sparql.proto imports rdf.proto and rdf2.proto, whose Google classes live in coreProtosGoogle
+  ).dependsOn(coreProtosGoogle)
 
 lazy val jena = (project in file("jena"))
   .settings(
@@ -736,6 +775,7 @@ lazy val root = (project in file("."))
     corePatch,
     corePatchProtosGoogle,
     coreSparql,
+    coreSparqlProtosGoogle,
     jena,
     jenaPatch,
     jenaSparql,

core-sparql-protos-google/.gitignore

@@ -0,0 +1,2 @@
+# Protos are copied here by sbt, they should not be committed.
+*.proto

core-sparql-protos-google/src/main/protobuf/.gitkeep

@@ -1,8 +1,9 @@
 package eu.neverblink.jelly.core.sparql
 
-import com.google.protobuf.{ByteString, InvalidProtocolBufferException}
+import com.google.protobuf.{ByteString, InvalidProtocolBufferException, TextFormat}
 import eu.neverblink.jelly.core.proto.v1.*
 import eu.neverblink.jelly.core.proto.v1.sparql.*
+import eu.neverblink.jelly.core.proto.google.v1.sparql as google
 import eu.neverblink.protoc.java.runtime.ProtoMessage
 import org.scalatest.matchers.should.Matchers
 import org.scalatest.wordspec.AnyWordSpec
@@ -12,6 +13,9 @@ import java.io.{ByteArrayInputStream, ByteArrayOutputStream, InputStream}
 /** Tests for the generated Protobuf messages of Jelly-SPARQL: the serialization round-trips and the
   * auxiliary methods (clone, copyFrom, mergeFrom, clear, equals) that the encoder and decoder do
   * not exercise by themselves.
+  *
+  * This also tests the classes generated by Google's protoc-java, from the
+  * core-sparql-protos-google module.
   */
 class SparqlProtoSpec extends AnyWordSpec, Matchers:
 
@@ -500,3 +504,51 @@ class SparqlProtoSpec extends AnyWordSpec, Matchers:
       a.mergeFrom(b) shouldBe merged
     }
   }
+
+  // Tests for the core-sparql-protos-google module. These also check that the two code generators
+  // agree on the wire format.
+  "proto.google.v1.sparql.SparqlResultsFrame" should {
+    val cases = Seq(
+      "frame with every field set" -> fullFrame,
+      "frame with a datatype-monomorphic literal column" -> SparqlResultsFrame
+        .newInstance()
+        .setOptions(JellySparqlOptions.SMALL)
+        .setRowCount(3)
+        .addVariables(SparqlVariable.newInstance().setName("x").setColumnIndex(0))
+        .addLiteralColumns(lexLiteralColumn),
+    )
+
+    "round-trip in non-delimited binary form" when {
+      for (name, frame) <- cases do
+        s"a $name" in {
+          val gFrame = google.SparqlResultsFrame.parseFrom(frame.toByteArray)
+          SparqlResultsFrame.parseFrom(gFrame.toByteArray) shouldBe frame
+        }
+    }
+
+    "round-trip in delimited binary form" when {
+      for (name, frame) <- cases do
+        s"a $name" in {
+          val out = ByteArrayOutputStream()
+          frame.writeDelimitedTo(out)
+          val gFrame =
+            google.SparqlResultsFrame.parseDelimitedFrom(ByteArrayInputStream(out.toByteArray))
+          val gOut = ByteArrayOutputStream()
+          gFrame.writeDelimitedTo(gOut)
+          SparqlResultsFrame.parseDelimitedFrom(
+            ByteArrayInputStream(gOut.toByteArray),
+          ) shouldBe frame
+        }
+    }
+
+    "round-trip the message in Text Format" when {
+      for (name, frame) <- cases do
+        s"a $name" in {
+          val gFrame = google.SparqlResultsFrame.parseFrom(frame.toByteArray)
+          val text = gFrame.toString
+          val gFrame2 = TextFormat.parse(text, classOf[google.SparqlResultsFrame])
+          gFrame2 shouldBe gFrame
+          SparqlResultsFrame.parseFrom(gFrame2.toByteArray) shouldBe frame
+        }
+    }
+  }