hyprtester: minor refactoring/restructure (#14154)

* hyprtester: Minor misc fixes

- Use `std::filesystem::path` instead of `std::string` in some places;
- Use `std::ranges::sort`, as suggested by clang-tidy;
- Reset colors at the end of every log line;
- Give more specific error messages in main.

* hyprtester: Fix a bug in `hyprlandAlive()`

Successful standard library calls are permitted to (and do) modify the
value of `errno` arbitrarily. Checking the value of `errno` only makes
sense when the library function returns an error. So, the correct
condition of a successful signal delivery is that the call to `kill`
returns 0.

Btw, given the possible other error values of `kill(2)`, should we even
consider `errno` at all?

* hyprtester: Restructure main

Split main's `main()` into multiple functions, separate responsibilities
more cleanly.

Add default values for cmd-line options to the help message.

* hyprtester: Remove redundant path canonicalization

* hyprtester: Run unified clean up code before every test

* tests: Use RAII for clients in client tests

Turn clients in client tests into classes. Constructors
initialize, destructors deinitialize.

Not only is it better design when entities (clients) are
modeled as classes, keeping all the methods connected,
this also ensures the tests perform their custom cleanup.

This will be especially important when we introduce early
termination on failure into the tests.

* hyprtester: Rewrite the testing framework!

- Implement a new test definition system used via the `TEST_CASE` and
  `SUBTEST` macros.

- Adds `ASSERT*` and reimplements `EXPECT*` macros. The former now
  terminate the test immediately. Also add some new macros, such as
  `FAIL_TEST`.

- Move existing tests to the new system. For trivial cases, break
  existing test functions down to multiple test cases.

- For non-trivial cases and a few other possible improvements, leave
  TODOs.

* tests: Use `EXPECT*` instead of `ASSERT*` in some places

`ASSERT*` macros terminate the test as soon as they fail. They are
appropriate to use when, if something fails, the rest of the test
does not make sense and more error messages from failing checks will
just pollute the output.

`EXPECT*` macros mark the test as failed but its execution continues.
It makes sense to use them when error messages from the following checks
in the test may be useful for someone who will be reading the log.

I changed some uses of `ASSERT*` in main tests to `EXPECT*`. But I was
not reading tests very carefully, so maybe I was wrong in some places.
My rule of thumb was:
- Checks that ensure that a kitty opens / a certain set/number of
  windows exists are fatal;
- A series of checks, especially on the same string returned by
  `Hyprland`, are non-fatal;
- Checks in tests with tightly coupled steps (i.e., do this, check,
  do this with the result of the previous step, check, etc) are fatal.

1 files changed, 32 insertions, 91 deletions

diff --git a/hyprtester/src/tests/main/scroll.cpp b/hyprtester/src/tests/main/scroll.cpp
index 3b73b906..bd33e345 100644
--- a/hyprtester/src/tests/main/scroll.cpp
+++ b/hyprtester/src/tests/main/scroll.cpp
@@ -3,15 +3,12 @@
 #include "../../hyprctlCompat.hpp"
 #include "tests.hpp"
 
-static int  ret = 0;
+TEST_CASE(scrollFocusCycling) {
+    OK(getFromSocket("r/eval hl.config({ general = { layout = 'scrolling' } })"));
 
-static void testFocusCycling() {
     for (auto const& win : {"a", "b", "c", "d"}) {
         if (!Tests::spawnKitty(win)) {
-            NLog::log("{}Failed to spawn kitty with win class `{}`", Colors::RED, win);
-            ++TESTS_FAILED;
-            ret = 1;
-            return;
+            FAIL_TEST("Could not spawn kitty with win class `{}`", win);
         }
     }
 
@@ -21,49 +18,44 @@ static void testFocusCycling() {
 
     {
         auto str = getFromSocket("/activewindow");
-        EXPECT_CONTAINS(str, "class: b");
+        ASSERT_CONTAINS(str, "class: b");
     }
 
     OK(getFromSocket("/dispatch hl.dsp.focus({ direction = 'right' })"));
 
     {
         auto str = getFromSocket("/activewindow");
-        EXPECT_CONTAINS(str, "class: c");
+        ASSERT_CONTAINS(str, "class: c");
     }
 
     OK(getFromSocket("/dispatch hl.dsp.focus({ direction = 'right' })"));
 
     {
         auto str = getFromSocket("/activewindow");
-        EXPECT_CONTAINS(str, "class: d");
+        ASSERT_CONTAINS(str, "class: d");
     }
 
     OK(getFromSocket("/dispatch hl.dsp.window.move({ direction = 'left' })"));
 
     {
         auto str = getFromSocket("/activewindow");
-        EXPECT_CONTAINS(str, "class: d");
+        ASSERT_CONTAINS(str, "class: d");
     }
 
     OK(getFromSocket("/dispatch hl.dsp.focus({ direction = 'up' })"));
 
     {
         auto str = getFromSocket("/activewindow");
-        EXPECT_CONTAINS(str, "class: c");
+        ASSERT_CONTAINS(str, "class: c");
     }
-
-    // clean up
-    NLog::log("{}Killing all windows", Colors::YELLOW);
-    Tests::killAllWindows();
 }
 
-static void testFocusWrapping() {
+TEST_CASE(scrollFocusWrapping) {
+    OK(getFromSocket("r/eval hl.config({ general = { layout = 'scrolling' } })"));
+
     for (auto const& win : {"a", "b", "c", "d"}) {
         if (!Tests::spawnKitty(win)) {
-            NLog::log("{}Failed to spawn kitty with win class `{}`", Colors::RED, win);
-            ++TESTS_FAILED;
-            ret = 1;
-            return;
+            FAIL_TEST("Could not spawn kitty with win class `{}`", win);
         }
     }
 
@@ -76,14 +68,14 @@ static void testFocusWrapping() {
 
     {
         auto str = getFromSocket("/activewindow");
-        EXPECT_CONTAINS(str, "class: d");
+        ASSERT_CONTAINS(str, "class: d");
     }
 
     OK(getFromSocket("/dispatch hl.dsp.layout('focus r')"));
 
     {
         auto str = getFromSocket("/activewindow");
-        EXPECT_CONTAINS(str, "class: a");
+        ASSERT_CONTAINS(str, "class: a");
     }
 
     // set wrap_focus to false
@@ -95,7 +87,7 @@ static void testFocusWrapping() {
 
     {
         auto str = getFromSocket("/activewindow");
-        EXPECT_CONTAINS(str, "class: a");
+        ASSERT_CONTAINS(str, "class: a");
     }
 
     OK(getFromSocket("/dispatch hl.dsp.focus({ window = 'class:d' })"));
@@ -104,21 +96,16 @@ static void testFocusWrapping() {
 
     {
         auto str = getFromSocket("/activewindow");
-        EXPECT_CONTAINS(str, "class: d");
+        ASSERT_CONTAINS(str, "class: d");
     }
-
-    // clean up
-    NLog::log("{}Killing all windows", Colors::YELLOW);
-    Tests::killAllWindows();
 }
 
-static void testSwapcolWrapping() {
+TEST_CASE(scrollSwapcolWrapping) {
+    OK(getFromSocket("r/eval hl.config({ general = { layout = 'scrolling' } })"));
+
     for (auto const& win : {"a", "b", "c", "d"}) {
         if (!Tests::spawnKitty(win)) {
-            NLog::log("{}Failed to spawn kitty with win class `{}`", Colors::RED, win);
-            ++TESTS_FAILED;
-            ret = 1;
-            return;
+            FAIL_TEST("Could not spawn kitty with win class `{}`", win);
         }
     }
 
@@ -132,7 +119,7 @@ static void testSwapcolWrapping() {
 
     {
         auto str = getFromSocket("/activewindow");
-        EXPECT_CONTAINS(str, "class: c");
+        ASSERT_CONTAINS(str, "class: c");
     }
 
     // clean up
@@ -141,10 +128,7 @@ static void testSwapcolWrapping() {
 
     for (auto const& win : {"a", "b", "c", "d"}) {
         if (!Tests::spawnKitty(win)) {
-            NLog::log("{}Failed to spawn kitty with win class `{}`", Colors::RED, win);
-            ++TESTS_FAILED;
-            ret = 1;
-            return;
+            FAIL_TEST("Could not spawn kitty with win class `{}`", win);
         }
     }
 
@@ -154,7 +138,7 @@ static void testSwapcolWrapping() {
 
     {
         auto str = getFromSocket("/activewindow");
-        EXPECT_CONTAINS(str, "class: b");
+        ASSERT_CONTAINS(str, "class: b");
     }
 
     // clean up
@@ -163,10 +147,7 @@ static void testSwapcolWrapping() {
 
     for (auto const& win : {"a", "b", "c", "d"}) {
         if (!Tests::spawnKitty(win)) {
-            NLog::log("{}Failed to spawn kitty with win class `{}`", Colors::RED, win);
-            ++TESTS_FAILED;
-            ret = 1;
-            return;
+            FAIL_TEST("Could not spawn kitty with win class `{}`", win);
         }
     }
 
@@ -180,7 +161,7 @@ static void testSwapcolWrapping() {
 
     {
         auto str = getFromSocket("/activewindow");
-        EXPECT_CONTAINS(str, "class: b");
+        ASSERT_CONTAINS(str, "class: b");
     }
 
     OK(getFromSocket("/dispatch hl.dsp.focus({ window = 'class:d' })"));
@@ -190,15 +171,13 @@ static void testSwapcolWrapping() {
 
     {
         auto str = getFromSocket("/activewindow");
-        EXPECT_CONTAINS(str, "class: c");
+        ASSERT_CONTAINS(str, "class: c");
     }
-
-    // clean up
-    NLog::log("{}Killing all windows", Colors::YELLOW);
-    Tests::killAllWindows();
 }
 
-static bool testWindowRule() {
+TEST_CASE(scrollWindowRule) {
+    OK(getFromSocket("r/eval hl.config({ general = { layout = 'scrolling' } })"));
+
     NLog::log("{}Testing Scrolling Width", Colors::GREEN);
 
     // inject a new rule.
@@ -206,53 +185,15 @@ static bool testWindowRule() {
     OK(getFromSocket("/eval hl.window_rule({ name = 'scrolling-width', scrolling_width = 0.1 })"));
 
     if (!Tests::spawnKitty("kitty_scroll")) {
-        NLog::log("{}Failed to spawn kitty with win class `kitty_scroll`", Colors::RED);
-        return false;
+        FAIL_TEST("Could not spawn kitty with win class `kitty_scroll`");
     }
 
     if (!Tests::spawnKitty("kitty_scroll")) {
-        NLog::log("{}Failed to spawn kitty with win class `kitty_scroll`", Colors::RED);
-        return false;
+        FAIL_TEST("Could not spawn kitty with win class `kitty_scroll`");
     }
 
-    EXPECT(Tests::windowCount(), 2);
+    ASSERT(Tests::windowCount(), 2);
 
     // not the greatest test, but as long as res and gaps don't change, we good.
     EXPECT_CONTAINS(getFromSocket("/activewindow"), "size: 174,1036");
-
-    NLog::log("{}Killing all windows", Colors::YELLOW);
-    Tests::killAllWindows();
-    EXPECT(Tests::windowCount(), 0);
-    return true;
 }
-
-static bool test() {
-    NLog::log("{}Testing Scroll layout", Colors::GREEN);
-
-    // setup
-    OK(getFromSocket("/dispatch hl.dsp.focus({ workspace = 'name:scroll' })"));
-    OK(getFromSocket("r/eval hl.config({ general = { layout = 'scrolling' } })"));
-
-    // test
-    NLog::log("{}Testing focus cycling", Colors::GREEN);
-    testFocusCycling();
-
-    // test
-    NLog::log("{}Testing focus wrap", Colors::GREEN);
-    testFocusWrapping();
-
-    // test
-    NLog::log("{}Testing swapcol wrap", Colors::GREEN);
-    testSwapcolWrapping();
-
-    testWindowRule();
-
-    // clean up
-    NLog::log("Cleaning up", Colors::YELLOW);
-    OK(getFromSocket("/dispatch hl.dsp.focus({ workspace = '1' })"));
-    OK(getFromSocket("/reload"));
-
-    return !ret;
-}
-
-REGISTER_TEST_FN(test);