Bump Substrait, bake Substrait version into binaries

Author: jvanstraten

Cargo.lock

@@ -15,3 +15,4 @@ cbindgen = "0.20.0"
 substrait-validator = { path = "../rs", version = "0.0.1" }
 libc = "0.2"
 thiserror = "1.0"
+once_cell = "1.9"

c/Cargo.toml

@@ -794,3 +794,13 @@ pub extern "C" fn substrait_validator_export_proto(
 ) -> *mut u8 {
     export(substrait_validator::export::Format::Proto, handle, size)
 }
+
+/// Returns the version of Substrait that the validator was built against.
+#[no_mangle]
+pub extern "C" fn substrait_validator_substrait_version() -> *const libc::c_char {
+    static VERSION: once_cell::sync::OnceCell<std::ffi::CString> = once_cell::sync::OnceCell::new();
+    VERSION
+        .get_or_init(|| std::ffi::CString::new(substrait_validator::substrait_version()).unwrap())
+        .as_bytes_with_nul()
+        .as_ptr() as *const libc::c_char
+}

c/src/lib.rs

@@ -251,6 +251,13 @@ fn substrait_validator(_py: Python, m: &PyModule) -> PyResult<()> {
         Ok(dict.into())
     }
 
+    /// Returns the version of Substrait that the validator was built against.
+    #[pyfn(m)]
+    #[pyo3(name = "get_substrait_version")]
+    fn get_substrait_version_py(py: Python) -> PyResult<PyObject> {
+        Ok(substrait_validator::substrait_version().to_object(py))
+    }
+
     m.add_class::<Config>()?;
     m.add_class::<ResultHandle>()?;
     Ok(())

py/src/lib.rs

@@ -10,7 +10,12 @@
 from typing import Iterable
 from google.protobuf import json_format
 from google.protobuf.message import DecodeError as ProtoDecodeError
-from .substrait_validator import ResultHandle, Config as _Config, get_diagnostic_codes
+from .substrait_validator import (
+    ResultHandle,
+    Config as _Config,
+    get_diagnostic_codes,
+    get_substrait_version as _get_substrait_version,
+)
 from .substrait.plan_pb2 import Plan
 from .substrait.validator.validator_pb2 import ParseResult, Diagnostic, Path
 
@@ -284,6 +289,12 @@ def path_to_string(path: Path) -> str:
     return "".join(elements)
 
 
+def substrait_version() -> str:
+    """Returns the version of Substrait that the validator was built
+    against."""
+    return _get_substrait_version()
+
+
 @click.command()
 @click.argument("infile", required=False)
 @click.option(

py/substrait_validator/__init__.py

@@ -154,3 +154,8 @@ def resolver(s):
             },
             config,
         )
+
+
+def test_version():
+    """Tests whether Substrait version retrieval works."""
+    assert sv.substrait_version().startswith("v")

py/tests/test_api.py

@@ -71,6 +71,29 @@ fn main() -> Result<()> {
         let validator_git_dir = manifest_dir.join("..");
         let substrait_git_dir = validator_git_dir.join("substrait");
 
+        // Determine Substrait submodule version and write it to a resource
+        // file.
+        let substrait_version = std::process::Command::new("git")
+            .args(["describe", "--tags"])
+            .current_dir(&substrait_git_dir)
+            .output()
+            .expect("failed to get substrait submodule version");
+        let mut substrait_version = String::from_utf8_lossy(&substrait_version.stdout)
+            .trim()
+            .to_string();
+        let dirty = !std::process::Command::new("git")
+            .args(["diff", "--quiet"])
+            .current_dir(&substrait_git_dir)
+            .status()
+            .expect("failed to get substrait submodule dirty flag")
+            .success();
+        if dirty {
+            substrait_version += "+dirty";
+        }
+        let substrait_version: &str = &substrait_version;
+        fs::write(resource_dir.join("substrait-version"), substrait_version)
+            .expect("failed to write substrait submodule version file");
+
         // Synchronize the YAML extension file schema.
         synchronize(
             &substrait_git_dir,

rs/build.rs

@@ -54,3 +54,9 @@ pub fn parse<B: prost::bytes::Buf>(buffer: B, config: &Config) -> ParseResult {
 pub fn iter_diagnostics() -> impl Iterator<Item = Classification> {
     Classification::iter()
 }
+
+/// Returns the version of Substrait that this version of the validator was
+/// built against.
+pub fn substrait_version() -> &'static str {
+    include_str!("resources/substrait-version")
+}