config/lua: init lua config manager, use lua if available (#13817)

Adds a new lua config manager, which will automatically be used if there is a lua config present.

1 files changed, 115 insertions, 0 deletions

diff --git a/tests/config/lua/LuaEventHandler.cpp b/tests/config/lua/LuaEventHandler.cpp
new file mode 100644
index 00000000..570014d3
--- /dev/null
+++ b/tests/config/lua/LuaEventHandler.cpp
@@ -0,0 +1,115 @@
+#include <config/lua/LuaEventHandler.hpp>
+
+#include <event/EventBus.hpp>
+
+#include <gtest/gtest.h>
+
+extern "C" {
+#include <lualib.h>
+#include <lauxlib.h>
+}
+
+using namespace Config::Lua;
+
+namespace {
+    class CLuaState {
+      public:
+        CLuaState() : m_lua(luaL_newstate()) {
+            luaL_openlibs(m_lua);
+        }
+
+        ~CLuaState() {
+            if (m_lua)
+                lua_close(m_lua);
+        }
+
+        lua_State* get() const {
+            return m_lua;
+        }
+
+      private:
+        lua_State* m_lua = nullptr;
+    };
+
+    int refGlobalFunction(lua_State* L, const char* name) {
+        lua_getglobal(L, name);
+        EXPECT_TRUE(lua_isfunction(L, -1));
+        return luaL_ref(L, LUA_REGISTRYINDEX);
+    }
+
+    int getGlobalInt(lua_State* L, const char* name) {
+        lua_getglobal(L, name);
+        const int val = sc<int>(lua_tointeger(L, -1));
+        lua_pop(L, 1);
+        return val;
+    }
+}
+
+TEST(ConfigLuaEventHandler, knownEventsContainsExpectedEntries) {
+    const auto& known = CLuaEventHandler::knownEvents();
+    EXPECT_TRUE(known.contains("config.reloaded"));
+    EXPECT_TRUE(known.contains("keybinds.submap"));
+    EXPECT_TRUE(known.contains("window.open"));
+}
+
+TEST(ConfigLuaEventHandler, registerDispatchAndUnregister) {
+    CLuaState        S;
+    const auto       L = S.get();
+    CLuaEventHandler handler(L);
+
+    ASSERT_EQ(luaL_dostring(L, R"(
+        count = 0
+        lastSubmap = ""
+        function onSubmap(name)
+            count = count + 1
+            lastSubmap = name
+        end
+    )"),
+              LUA_OK);
+
+    const int  ref    = refGlobalFunction(L, "onSubmap");
+    const auto handle = handler.registerEvent("keybinds.submap", ref);
+    ASSERT_TRUE(handle.has_value());
+
+    Event::bus()->m_events.keybinds.submap.emit("main");
+    EXPECT_EQ(getGlobalInt(L, "count"), 1);
+
+    lua_getglobal(L, "lastSubmap");
+    ASSERT_TRUE(lua_isstring(L, -1));
+    EXPECT_STREQ(lua_tostring(L, -1), "main");
+    lua_pop(L, 1);
+
+    EXPECT_TRUE(handler.unregisterEvent(*handle));
+
+    Event::bus()->m_events.keybinds.submap.emit("other");
+    EXPECT_EQ(getGlobalInt(L, "count"), 1);
+}
+
+TEST(ConfigLuaEventHandler, registerUnknownEventReturnsNullopt) {
+    CLuaState        S;
+    const auto       L = S.get();
+    CLuaEventHandler handler(L);
+
+    ASSERT_EQ(luaL_dostring(L, "function cb() end"), LUA_OK);
+
+    const int  ref    = refGlobalFunction(L, "cb");
+    const auto handle = handler.registerEvent("totally.unknown", ref);
+
+    EXPECT_FALSE(handle.has_value());
+    luaL_unref(L, LUA_REGISTRYINDEX, ref);
+}
+
+TEST(ConfigLuaEventHandler, callbackLuaErrorDoesNotCrashDispatch) {
+    CLuaState        S;
+    const auto       L = S.get();
+    CLuaEventHandler handler(L);
+
+    ASSERT_EQ(luaL_dostring(L, "function broken() error('boom') end"), LUA_OK);
+
+    const int  ref = refGlobalFunction(L, "broken");
+    const auto h   = handler.registerEvent("config.reloaded", ref);
+    ASSERT_TRUE(h.has_value());
+
+    Event::bus()->m_events.config.reloaded.emit();
+    SUCCEED();
+}