Add a simple lua test suite + add utils spec + fix keymap spec

10 files changed, 257 insertions, 14 deletions

diff --git a/flake.nix b/flake.nix
index 403f410..88087ba 100644
--- a/flake.nix
+++ b/flake.nix
@@ -17,14 +17,16 @@
           lua-libluv = pkgs.callPackage (import ./nix/libluv.nix) {
             inherit (myPkgs) libuv luajit;
           };
+          # lua-busted = pkgs.luajitPackages.busted;
         };
 
-        dependencies = [
-          myPkgs.qt.qtbase
-          myPkgs.qt.qtwebengine
-          myPkgs.luajit
-          myPkgs.libuv
-          myPkgs.lua-libluv
+        dependencies = with myPkgs; [
+          qt.qtbase
+          qt.qtwebengine
+          luajit
+          libuv
+          lua-libluv
+          # lua-busted
         ];
       in {
         devShells.default = pkgs.mkShell rec {
diff --git a/lua/null-browser/api.lua b/lua/null-browser/api.lua
index b3f1db1..f78ba4d 100644
--- a/lua/null-browser/api.lua
+++ b/lua/null-browser/api.lua
@@ -10,7 +10,7 @@ web.view = web.view or {}
 web.history = web.history or {}
 web.event = web.event or {}
 
-require 'lua.null-browser.utils'
+require 'null-browser.utils'
 
 --- Add a keymap
 ---
diff --git a/lua/null-browser/test-utils.lua b/lua/null-browser/test-utils.lua
new file mode 100644
index 0000000..8871ce6
--- /dev/null
+++ b/lua/null-browser/test-utils.lua
@@ -0,0 +1,74 @@
+local t = {}
+
+local indent = 0
+
+local function with_indent(func)
+  indent = indent + 1
+  func()
+  indent = indent - 1
+end
+
+function t.describe(description, func)
+  local prefix = string.rep(' ', indent)
+  print(prefix .. '\x1b[1m' .. description .. '\x1b[0m')
+  io.flush()
+
+  with_indent(func)
+end
+
+function t.context(description, func)
+  local prefix = string.rep(' ', indent)
+  print(prefix .. '│ \x1b[32m' .. description .. '\x1b[0m')
+  io.flush()
+  with_indent(func)
+end
+
+function t.it(description, func)
+  local prefix = string.rep(' ', indent - 1)
+  print(prefix .. '└─⚪\x1b[36m' .. description .. '\x1b[0m')
+  io.flush()
+  with_indent(func)
+end
+
+---@diagnostic disable-next-line: unused-local
+function t.xit(description, func)
+  print('└─⚪\x1b[33m' .. description .. '\x1b[0m')
+  io.flush()
+end
+
+function t.expect(received)
+  local assert = {}
+
+  local function assert_error(messages)
+    print('❌AssertionError:')
+    for _, msg in ipairs(messages) do
+      print('  ' .. msg)
+    end
+    error('assertion_error')
+  end
+
+  function assert.to_equal(expected)
+    if web.utils.equals(received, expected) then return end
+    assert_error({ 'Expected: ' .. web.inspect(expected), 'Received: ' .. web.inspect(received) })
+  end
+
+  function assert.to_be_true()
+    if received == true then return end
+    assert_error({ 'Expected: ' .. web.inspect(received) .. ' to be true' })
+  end
+
+  function assert.to_be_false()
+    if received == false then return end
+    assert_error({ 'Expected: ' .. web.inspect(received) .. ' to be false' })
+  end
+
+  return assert
+end
+
+_G.describe = t.describe
+_G.context = t.context
+_G.it = t.it
+_G.xit = t.xit
+_G.expect = t.expect
+
+return t
diff --git a/lua/null-browser/utils.lua b/lua/null-browser/utils.lua
index 244fa6f..b6ff40a 100644
--- a/lua/null-browser/utils.lua
+++ b/lua/null-browser/utils.lua
@@ -25,3 +25,38 @@ function web.utils.table_merge(t, ...)
 
   return t
 end
+
+function web.utils.table_keys(tbl)
+  local keys = {}
+  for key, _ in pairs(tbl) do
+    table.insert(keys, key)
+  end
+  return keys
+end
+
+local function is_deep_equal_helper(a, b, table_pairs)
+  if type(a) ~= type(b) then return false end
+  if type(a) == 'table' and type(b) == 'table' then
+    local keys_a = web.utils.table_keys(a)
+    local keys_b = web.utils.table_keys(b)
+    if #keys_a ~= #keys_b then return false end
+
+    if table_pairs[a] == b then
+      return true
+    end
+
+    table_pairs[a] = b
+
+    for k in pairs(a) do
+      if not is_deep_equal_helper(a[k], b[k], table_pairs) then return false end
+    end
+
+    return true
+  end
+
+  return a == b
+end
+
+function web.utils.equals(a, b)
+  return is_deep_equal_helper(a, b, {})
+end
diff --git a/spec/KeymapEvaluatorSpec.cpp b/spec/KeymapEvaluatorSpec.cpp
index 37f7ec8..5c2202b 100644
--- a/spec/KeymapEvaluatorSpec.cpp
+++ b/spec/KeymapEvaluatorSpec.cpp
@@ -13,6 +13,7 @@ private slots:
     it("calls mapping") {
       auto keymap_was_called = false;
       KeymapEvaluator evaluator;
+      evaluator.set_current_mode("n");
       evaluator.add_keymap("n", "<c-t>", [&keymap_was_called]() { keymap_was_called = true; });
 
       evaluator.evaluate(Qt::ControlModifier, Qt::Key_T);
@@ -37,6 +38,7 @@ private slots:
     it("calls mapping") {
       auto keymap_was_called = false;
       KeymapEvaluator evaluator;
+      evaluator.set_current_mode("n");
       evaluator.add_keymap("n", "<c-t>a", [&keymap_was_called]() { keymap_was_called = true; });
 
       evaluator.evaluate(Qt::ControlModifier, Qt::Key_T);
@@ -49,6 +51,7 @@ private slots:
     it("does not call mapping") {
       auto keymap_was_called = false;
       KeymapEvaluator evaluator;
+      evaluator.set_current_mode("n");
       evaluator.add_keymap("n", "<c-t>a", [&keymap_was_called]() { keymap_was_called = true; });
 
       evaluator.evaluate(Qt::ControlModifier, Qt::Key_T);
@@ -60,6 +63,7 @@ private slots:
     it("does not call mapping") {
       auto keymap_was_called = false;
       KeymapEvaluator evaluator;
+      evaluator.set_current_mode("n");
       evaluator.add_keymap("n", "<c-t>a", [&keymap_was_called]() { keymap_was_called = true; });
 
       evaluator.evaluate(Qt::ControlModifier, Qt::Key_K);
@@ -71,6 +75,7 @@ private slots:
     it("does not call mapping") {
       auto keymap_was_called = false;
       KeymapEvaluator evaluator;
+      evaluator.set_current_mode("n");
       evaluator.add_keymap("n", "<c-t>a", [&keymap_was_called]() { keymap_was_called = true; });
 
       evaluator.evaluate(Qt::ControlModifier, Qt::Key_T);
@@ -83,6 +88,7 @@ private slots:
     it("calls mapping") {
       auto keymap_was_called = false;
       KeymapEvaluator evaluator;
+      evaluator.set_current_mode("n");
       evaluator.add_keymap("n", "<c-t>a", [&keymap_was_called]() { keymap_was_called = true; });
 
       evaluator.evaluate(Qt::ControlModifier, Qt::Key_T);
@@ -98,6 +104,7 @@ private slots:
     it("does not call mapping") {
       auto keymap_was_called = false;
       KeymapEvaluator evaluator;
+      evaluator.set_current_mode("n");
       evaluator.add_keymap("n", "<c-t>a", [&keymap_was_called]() { keymap_was_called = true; });
 
       evaluator.evaluate(Qt::ControlModifier, Qt::Key_T);
diff --git a/spec/lua/utils_spec.lua b/spec/lua/utils_spec.lua
new file mode 100644
index 0000000..5ea2d78
--- /dev/null
+++ b/spec/lua/utils_spec.lua
@@ -0,0 +1,90 @@
+describe('web.utils.string_trim', function()
+  it('trims whitespace from the start and end of string', function()
+    expect(web.utils.string_trim('  hello')).to_equal 'hello'
+    expect(web.utils.string_trim('hello  ')).to_equal 'hello'
+    expect(web.utils.string_trim('  hello  ')).to_equal 'hello'
+  end)
+end)
+
+describe('web.utils.table_merge', function()
+  context('when both tables have integer keys', function()
+    it('returns merged table', function()
+      expect(web.utils.table_merge({ a = 0 }, { b = 1 }, { c = 2 }))
+          .to_equal { a = 0, b = 1, c = 2 }
+    end)
+  end)
+
+  context('when both tables unique keys', function()
+    it('returns merged table', function()
+      expect(web.utils.table_merge({ a = 0 }, { b = 1 }, { c = 2 }))
+          .to_equal { a = 0, b = 1, c = 2 }
+    end)
+  end)
+
+  context('when both tables have a key in common', function()
+    it('returns merged table', function()
+      expect(web.utils.table_merge({ foo = 1, a = 0 }, { foo = 2 }, { foo = 3 }))
+          .to_equal { foo = 3, a = 0 }
+    end)
+
+    it('mutates the first table', function()
+      local tbl = { foo = 1, a = 0 }
+      web.utils.table_merge(tbl, { foo = 2 })
+      expect(tbl).to_equal { foo = 2, a = 0 }
+    end)
+  end)
+end)
+
+describe('web.utils.equals', function()
+  context('when values are primitives', function()
+    it('checks for equality', function()
+      expect(web.utils.equals(1, 1)).to_be_true()
+      expect(web.utils.equals(3, 1)).to_be_false()
+      expect(web.utils.equals(nil, 1)).to_be_false()
+      expect(web.utils.equals(1, nil)).to_be_false()
+      expect(web.utils.equals(nil, nil)).to_be_true()
+    end)
+  end)
+
+  context('when values are tables', function()
+    it('checks for equality', function()
+      expect(web.utils.equals({}, 0)).to_be_false()
+      expect(web.utils.equals(0, {})).to_be_false()
+      expect(web.utils.equals({}, {})).to_be_true()
+      expect(web.utils.equals({ a = 1 }, { a = 1 })).to_be_true()
+      expect(web.utils.equals({ a = 2 }, { a = 1 })).to_be_false()
+      expect(web.utils.equals({}, { a = 1 })).to_be_false()
+      expect(web.utils.equals({ a = 1 }, {})).to_be_false()
+    end)
+
+    context('when tables are deeply nested', function()
+      it('checks for equality', function()
+        expect(web.utils.equals({ a = { b = 2 } }, { a = { b = 2 } })).to_be_true()
+        expect(web.utils.equals({ a = { b = 3 } }, { a = { b = 2 } })).to_be_false()
+      end)
+    end)
+  end)
+end)
+
+describe('web.utils.table_keys', function()
+  it('returns keys of given table', function()
+    local result = web.utils.table_keys({ a = 1, b = 2 })
+    table.sort(result) -- Sort for deterministic ordering
+    expect(result).to_equal({ 'a', 'b' })
+  end)
+
+  context('with index keys', function()
+    it('returns indexes of given table', function()
+      expect(web.utils.table_keys({ 'hello', 'world' })).to_equal({ 1, 2 })
+      expect(web.utils.table_keys({ 'hello', a = 1, 'world' })).to_equal({ 1, 2, 'a' })
+    end)
+  end)
+end)
+
+describe('web.inspect', function()
+  it('returns string representation of value', function()
+    expect(web.inspect('hello')).to_equal '"hello"'
+    expect(web.inspect(5)).to_equal '5'
+    expect(web.inspect({ a = '200', b = 5 })).to_equal '{\n  a = "200",\n  b = 5\n}'
+  end)
+end)
diff --git a/spec/main.cpp b/spec/main.cpp
index 15d0b60..1f60aea 100644
--- a/spec/main.cpp
+++ b/spec/main.cpp
@@ -1,8 +1,44 @@
+#include <QtCore>
+
+#include "LuaRuntime.hpp"
 #include "testUtils.h"
-#include <QtWidgets/qapplication.h>
+
+int run_lua_tests() {
+  QString test_name = getenv("TEST_NAME");
+  if (test_name.startsWith("lua ")) {
+    test_name = test_name.remove(0, 4);
+  } else if (!test_name.isEmpty())
+    return 0;
+
+  QDir dir("../spec/lua"); // TODO: relative to root instead of build/?
+  QStringList spec_files = dir.entryList(QDir::Files);
+  auto &lua = LuaRuntime::instance();
+
+  lua.start_event_loop();
+  lua.require_module("null-browser.test-utils");
+
+  for (auto &file : spec_files) {
+    auto is_spec = file.endsWith("_spec.lua");
+    auto should_run_spec = test_name.isEmpty() || file.contains(test_name);
+    if (is_spec && should_run_spec) {
+      qDebug() << "Running suite: " << file;
+      lua.load_file_sync(dir.filePath(file));
+    }
+  }
+
+  lua.stop_event_loop();
+
+  qDebug() << "Tests ran successfully";
+  return 0;
+}
 
 int main(int argc, char **argv) {
   QApplication app(argc, argv);
 
-  return run_all_tests();
+  int exit_code_app = run_app_tests();
+  int exit_code_lua = run_lua_tests();
+
+  if (exit_code_app != 0)
+    return exit_code_app;
+  return exit_code_lua;
 }
diff --git a/spec/testUtils.cpp b/spec/testUtils.cpp
index 8f348bd..661f6a3 100644
--- a/spec/testUtils.cpp
+++ b/spec/testUtils.cpp
@@ -8,7 +8,7 @@ std::vector<std::function<QObject *()>> &get_qtest_registry() {
   return registry;
 }
 
-int run_all_tests() {
+int run_app_tests() {
   int exit_code = 0;
 
   QString test_name = getenv("TEST_NAME");
@@ -27,8 +27,7 @@ int run_all_tests() {
 bool wait_for_lua_to_be_true(QString lua_code) {
   return QTest::qWaitFor([&lua_code]() {
     auto &lua = LuaRuntime::instance();
-    QSignalSpy evaluation_completed_spy(&lua,
-                                        &LuaRuntime::evaluation_completed);
+    QSignalSpy evaluation_completed_spy(&lua, &LuaRuntime::evaluation_completed);
     lua.evaluate(lua_code);
     evaluation_completed_spy.wait();
     return evaluation_completed_spy.first().first().toBool();
diff --git a/spec/testUtils.h b/spec/testUtils.h
index a20291c..bfc7374 100644
--- a/spec/testUtils.h
+++ b/spec/testUtils.h
@@ -34,7 +34,7 @@
 #define STRINGIFY(x) #x
 
 std::vector<std::function<QObject *()>> &get_qtest_registry();
-int run_all_tests();
+int run_app_tests();
 
 #define QTEST_REGISTER(klass)                                                                      \
   namespace {                                                                                      \
diff --git a/src/LuaRuntime.cpp b/src/LuaRuntime.cpp
index 73555e0..eaf3df7 100644
--- a/src/LuaRuntime.cpp
+++ b/src/LuaRuntime.cpp
@@ -95,7 +95,7 @@ void LuaRuntime::append_package_path(const QString &path) {
 void LuaRuntime::load_file_sync(const QString &path) {
   preserve_top(state, {
     if (luaL_dofile(state, path.toStdString().c_str()) != LUA_OK) {
-      qDebug() << "Load file error:" << lua_tostring(state, -1);
+      lua_error(state);
     }
   });
 }