Tests: add basic unit tests exercising ConVar and scripting

Author: oSoMoN

.github/workflows/main.yml

@@ -19,7 +19,8 @@ jobs:
             libxtst libxkbcommon libdrm libinput wayland-protocols benchmark \
             xorg-xwayland pipewire cmake \
             libavif libheif aom rav1e libdecor libxdamage \
-            luajit
+            luajit \
+            catch2 gcovr
       - uses: actions/checkout@v6
         with:
           submodules: recursive
@@ -38,3 +39,14 @@ jobs:
 #          export CC=clang CXX=clang++
 #          meson setup build-clang/ -Dinput_emulation=disabled --werror --auto-features=enabled
 #          ninja -C build-clang/
+      - name: Run unit tests and collect coverage
+        run: |
+          export CC=gcc CXX=g++
+          meson configure -Db_coverage=true build-gcc
+          meson test -C build-gcc --suite gamescope -v
+          gcovr -f src --xml -o coverage.xml -s build-gcc
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v7
+        with:
+          name: code coverage
+          path: coverage.xml

meson.build

@@ -105,6 +105,11 @@ if get_option('enable_gamescope')
   subdir('src')
 endif
 
+if get_option('enable_tests')
+  subdir('tests')
+endif
+
+
 # Handle default script/config/looks stuff
 meson.add_install_script('default_extras_install.sh')
 

meson_options.txt

@@ -7,4 +7,5 @@ option('input_emulation' ,           type: 'feature', description: 'Support for
 option('enable_gamescope',           type : 'boolean', value : true, description: 'Build Gamescope executable')
 option('enable_gamescope_wsi_layer', type : 'boolean', value : true, description: 'Build Gamescope layer')
 option('enable_openvr_support',      type : 'boolean', value : true, description: 'OpenVR Integrations')
+option('enable_tests',               type : 'boolean', value : true, description: 'Build unit tests')
 option('benchmark', type: 'feature', description: 'Benchmark tools')

tests/meson.build

@@ -0,0 +1,16 @@
+catch2_dep = dependency('catch2-with-main', required: true)
+
+srcdir = '../src'
+unittest_src = []
+foreach src : gamescope_core_src + ['Script/Script.cpp', 'convar_script.cpp']
+	unittest_src += srcdir / src
+endforeach
+
+test_convar = executable(
+	'test_convar',
+	unittest_src + ['test_convar.cpp'],
+	include_directories: [srcdir, sol2_include],
+	dependencies: [catch2_dep, luajit_dep, cap_dep, drm_dep, glm_dep, wlroots_dep],
+	cpp_args: gamescope_cpp_args,
+)
+test('convar', test_convar)

tests/test_convar.cpp

@@ -0,0 +1,49 @@
+#include <catch2/catch_test_macros.hpp>
+
+#include "convar.h"
+#include "Script/Script.h"
+
+using namespace gamescope;
+
+TEST_CASE("ConVar", "[convar]") {
+	ConVar<bool> cv_bool_var {"foobar", true, "switch on and off"};
+	REQUIRE(cv_bool_var.GetName() == "foobar");
+	REQUIRE(cv_bool_var.GetDescription() == "switch on and off");
+	REQUIRE(cv_bool_var.Get() == true);
+	cv_bool_var.SetValue(false);
+	REQUIRE(cv_bool_var.Get() == false);
+
+	{
+		auto proxy = CScriptScopedLock().Manager().Gamescope().Convars.Base["foobar"];
+		REQUIRE(proxy.valid() == true);
+		ConVar<bool>* cv = proxy;
+		REQUIRE(cv->GetName() == "foobar");
+		REQUIRE(cv->GetDescription() == "switch on and off");
+		REQUIRE(cv->Get() == false);
+		cv->SetValue(true);
+		REQUIRE(cv_bool_var.Get() == true);
+	}
+
+	{
+		auto proxy = CScriptScopedLock().Manager().Gamescope().Convars.Base["nobar"];
+		REQUIRE(proxy.valid() == false);
+	}
+
+	{
+		auto proxy = CScriptScopedLock()->script("return gamescope.convars.foobar");
+		REQUIRE(proxy.valid() == true);
+		ConVar<bool>* cv = proxy;
+		REQUIRE(cv->GetName() == "foobar");
+		REQUIRE(cv->GetDescription() == "switch on and off");
+		REQUIRE(cv->Get() == true);
+		cv->SetValue(false);
+		REQUIRE(cv_bool_var.Get() == false);
+	}
+
+	{
+		auto proxy = CScriptScopedLock()->script("return gamescope.convars.nobar");
+		REQUIRE(proxy.valid() == true);
+		ConVar<bool>* cv = proxy;
+		REQUIRE(cv == nullptr);
+	}
+}