Move Lua test helpers out into separate (unpublished) package

Author: dcreager

Cargo.toml

@@ -3,6 +3,7 @@ resolver = "1"
 members = [
   # library projects
   "lsp-positions",
+  "lua-helpers",
   "stack-graphs",
   "tree-sitter-stack-graphs",
   "languages/*",

lua-helpers/Cargo.toml

@@ -0,0 +1,7 @@
+[package]
+name = "lua-helpers"
+version = "0.0.0"
+description = "Unpublished helper methods for our Lua test cases"
+
+[dependencies]
+mlua = { version = "0.9" }

lua-helpers/src/lib.rs

@@ -0,0 +1,106 @@
+// -*- coding: utf-8 -*-
+// ------------------------------------------------------------------------------------------------
+// Copyright © 2023, stack-graphs authors.
+// Licensed under either of Apache License, Version 2.0, or MIT license, at your option.
+// Please see the LICENSE-APACHE or LICENSE-MIT files in this distribution for license details.
+// ------------------------------------------------------------------------------------------------
+
+const TEST_PRELUDE: &str = r#"
+  function assert_eq(thing, expected, actual)
+    if expected ~= actual then
+      error("Expected "..thing.." "..expected..", got "..actual)
+    end
+  end
+
+  function deepeq(t1, t2, prefix)
+    prefix = prefix or ""
+    local ty1 = type(t1)
+    local ty2 = type(t2)
+    if ty1 ~= ty2 then
+      local msg = "different types for lhs"..prefix.." ("..ty1..") and rhs"..prefix.." ("..ty2..")"
+      return false, {msg}
+    end
+
+    -- non-table types can be directly compared
+    if ty1 ~= 'table' and ty2 ~= 'table' then
+      if t1 ~= t2 then
+        local msg = "different values for lhs"..prefix.." ("..t1..") and rhs"..prefix.." ("..t2..")"
+        return false, {msg}
+      end
+      return true, {}
+    end
+
+    local equal = true
+    local diffs = {}
+    for k2, v2 in pairs(t2) do
+      local v1 = t1[k2]
+      if v1 == nil then
+        equal = false
+        diffs[#diffs+1] = "missing lhs"..prefix.."."..k2
+      else
+        local e, d = deepeq(v1, v2, prefix.."."..k2)
+        equal = equal and e
+        table.move(d, 1, #d, #diffs+1, diffs)
+      end
+    end
+    for k1, v1 in pairs(t1) do
+      local v2 = t2[k1]
+      if v2 == nil then
+        equal = false
+        diffs[#diffs+1] = "missing rhs"..prefix.."."..k1
+      end
+    end
+    return equal, diffs
+  end
+
+  function assert_deepeq(thing, expected, actual)
+    local eq, diffs = deepeq(expected, actual)
+    if not eq then
+      error("Unexpected "..thing..": "..table.concat(diffs, ", "))
+    end
+  end
+"#;
+
+pub fn new_lua() -> Result<mlua::Lua, mlua::Error> {
+    let l = mlua::Lua::new();
+    l.load(TEST_PRELUDE).set_name("test prelude").exec()?;
+    Ok(l)
+}
+
+pub trait CheckLua {
+    fn check(&self, chunk: &str) -> Result<(), mlua::Error>;
+}
+
+impl CheckLua for mlua::Lua {
+    fn check(&self, chunk: &str) -> Result<(), mlua::Error> {
+        self.load(chunk).set_name("test chunk").exec()
+    }
+}
+
+#[test]
+fn can_deepeq_from_lua() -> Result<(), mlua::Error> {
+    let l = new_lua()?;
+    l.check(
+        r#"
+          function check_deepeq(lhs, rhs, expected, expected_diffs)
+            local actual, actual_diffs = deepeq(lhs, rhs)
+            actual_diffs = table.concat(actual_diffs, ", ")
+            assert_eq("deepeq", expected, actual)
+            assert_eq("differences", expected_diffs, actual_diffs)
+          end
+
+          check_deepeq(0, 0, true, "")
+          check_deepeq(0, 1, false, "different values for lhs (0) and rhs (1)")
+
+          check_deepeq({"a", "b", "c"}, {"a", "b", "c"}, true, "")
+          check_deepeq({"a", "b", "c"}, {"a", "b"}, false, "missing rhs.3")
+          check_deepeq({"a", "b", "c"}, {"a", "b", "d"}, false, "different values for lhs.3 (c) and rhs.3 (d)")
+
+          check_deepeq({a=1, b=2, c=3}, {a=1, b=2, c=3}, true, "")
+          check_deepeq({a=1, b=2, c=3}, {a=1, b=2}, false, "missing rhs.c")
+          check_deepeq({a=1, b=2, c=3}, {a=1, b=2, c=4}, false, "different values for lhs.c (3) and rhs.c (4)")
+          check_deepeq({a=1, b=2, c=3}, {a=1, b=2, d=3}, false, "missing lhs.d, missing rhs.c")
+        "#,
+    )?;
+    Ok(())
+}

stack-graphs/Cargo.toml

@@ -46,6 +46,7 @@ thiserror = { version = "1.0" }
 anyhow = "1.0"
 assert-json-diff = "2"
 itertools = "0.10"
+lua-helpers = { path = "../lua-helpers" }
 maplit = "1.0"
 pretty_assertions = "0.7"
 serde_json = { version = "1.0" }

stack-graphs/tests/it/lua.rs

@@ -7,87 +7,16 @@
 
 use std::collections::HashSet;
 
+use lua_helpers::new_lua;
 use maplit::hashset;
 use stack_graphs::graph::NodeID;
 use stack_graphs::graph::StackGraph;
 
-const TEST_PRELUDE: &str = r#"
-  function assert_eq(thing, expected, actual)
-    if expected ~= actual then
-      error("Expected "..thing.." "..expected..", got "..actual)
-    end
-  end
-
-  function deepeq(t1, t2, prefix)
-    prefix = prefix or ""
-    local ty1 = type(t1)
-    local ty2 = type(t2)
-    if ty1 ~= ty2 then
-      local msg = "different types for lhs"..prefix.." ("..ty1..") and rhs"..prefix.." ("..ty2..")"
-      return false, {msg}
-    end
-
-    -- non-table types can be directly compared
-    if ty1 ~= 'table' and ty2 ~= 'table' then
-      if t1 ~= t2 then
-        local msg = "different values for lhs"..prefix.." ("..t1..") and rhs"..prefix.." ("..t2..")"
-        return false, {msg}
-      end
-      return true, {}
-    end
-
-    equal = true
-    diffs = {}
-    for k2, v2 in pairs(t2) do
-      local v1 = t1[k2]
-      if v1 == nil then
-        equal = false
-        diffs[#diffs+1] = "missing lhs"..prefix.."."..k2
-      else
-        local e, d = deepeq(v1, v2, prefix.."."..k2)
-        equal = equal and e
-        table.move(d, 1, #d, #diffs+1, diffs)
-      end
-    end
-    for k1, v1 in pairs(t1) do
-      local v2 = t2[k1]
-      if v2 == nil then
-        equal = false
-        diffs[#diffs+1] = "missing rhs"..prefix.."."..k1
-      end
-    end
-    return equal, diffs
-  end
-
-  function assert_deepeq(thing, expected, actual)
-    local eq, diffs = deepeq(expected, actual)
-    if not eq then
-      error("Unexpected "..thing..": "..table.concat(diffs, ", "))
-    end
-  end
-"#;
-
-fn new_lua() -> mlua::Lua {
-    let l = mlua::Lua::new();
-    l.load(TEST_PRELUDE)
-        .set_name("test prelude")
-        .exec()
-        .expect("Error loading test prelude");
-    l
-}
-
 trait CheckLua {
-    /// Executes a chunk of Lua code.  If it returns a string, interprets that string as an
-    /// error message, and translates that into an `anyhow` error.
-    fn check_without_graph(&self, chunk: &str) -> Result<(), mlua::Error>;
     fn check(&self, graph: &mut StackGraph, chunk: &str) -> Result<(), mlua::Error>;
 }
 
 impl CheckLua for mlua::Lua {
-    fn check_without_graph(&self, chunk: &str) -> Result<(), mlua::Error> {
-        self.load(chunk).set_name("test chunk").exec()
-    }
-
     fn check(&self, graph: &mut StackGraph, chunk: &str) -> Result<(), mlua::Error> {
         self.scope(|scope| {
             let graph = scope.create_userdata_ref_mut(graph);
@@ -96,37 +25,9 @@ impl CheckLua for mlua::Lua {
     }
 }
 
-#[test]
-fn can_deepeq_from_lua() -> Result<(), anyhow::Error> {
-    let l = new_lua();
-    l.check_without_graph(
-        r#"
-          function check_deepeq(lhs, rhs, expected, expected_diffs)
-            local actual, actual_diffs = deepeq(lhs, rhs)
-            actual_diffs = table.concat(actual_diffs, ", ")
-            assert_eq("deepeq", expected, actual)
-            assert_eq("differences", expected_diffs, actual_diffs)
-          end
-
-          check_deepeq(0, 0, true, "")
-          check_deepeq(0, 1, false, "different values for lhs (0) and rhs (1)")
-
-          check_deepeq({"a", "b", "c"}, {"a", "b", "c"}, true, "")
-          check_deepeq({"a", "b", "c"}, {"a", "b"}, false, "missing rhs.3")
-          check_deepeq({"a", "b", "c"}, {"a", "b", "d"}, false, "different values for lhs.3 (c) and rhs.3 (d)")
-
-          check_deepeq({a=1, b=2, c=3}, {a=1, b=2, c=3}, true, "")
-          check_deepeq({a=1, b=2, c=3}, {a=1, b=2}, false, "missing rhs.c")
-          check_deepeq({a=1, b=2, c=3}, {a=1, b=2, c=4}, false, "different values for lhs.c (3) and rhs.c (4)")
-          check_deepeq({a=1, b=2, c=3}, {a=1, b=2, d=3}, false, "missing lhs.d, missing rhs.c")
-        "#,
-    )?;
-    Ok(())
-}
-
 #[test]
 fn can_create_nodes_from_lua() -> Result<(), anyhow::Error> {
-    let l = new_lua();
+    let l = new_lua()?;
     let mut graph = StackGraph::new();
     l.check(
         &mut graph,
@@ -154,7 +55,7 @@ fn can_create_nodes_from_lua() -> Result<(), anyhow::Error> {
 
 #[test]
 fn can_set_source_info_from_lua() -> Result<(), anyhow::Error> {
-    let l = new_lua();
+    let l = new_lua()?;
     let mut graph = StackGraph::new();
     l.check(&mut graph,
         r#"
@@ -191,7 +92,7 @@ fn can_set_source_info_from_lua() -> Result<(), anyhow::Error> {
 
 #[test]
 fn can_set_debug_info_from_lua() -> Result<(), anyhow::Error> {
-    let l = new_lua();
+    let l = new_lua()?;
     let mut graph = StackGraph::new();
     l.check(
         &mut graph,
@@ -210,7 +111,7 @@ fn can_set_debug_info_from_lua() -> Result<(), anyhow::Error> {
 
 #[test]
 fn can_create_edges_from_lua() -> Result<(), anyhow::Error> {
-    let l = new_lua();
+    let l = new_lua()?;
     let mut graph = StackGraph::new();
     l.check(
         &mut graph,
@@ -249,7 +150,7 @@ fn can_create_edges_from_lua() -> Result<(), anyhow::Error> {
 
 #[test]
 fn can_create_all_node_types_from_lua() -> Result<(), anyhow::Error> {
-    let l = new_lua();
+    let l = new_lua()?;
     let mut graph = StackGraph::new();
     l.check(
         &mut graph,