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, 41 insertions, 81 deletions

diff --git a/hyprtester/src/tests/main/master.cpp b/hyprtester/src/tests/main/master.cpp
index 02792631..b9364c45 100644
--- a/hyprtester/src/tests/main/master.cpp
+++ b/hyprtester/src/tests/main/master.cpp
@@ -3,10 +3,44 @@
 #include "../../hyprctlCompat.hpp"
 #include "tests.hpp"
 
-static int ret = 0;
+TEST_CASE(focusMasterPrevious) {
+    OK(getFromSocket("r/eval hl.config({ general = { layout = 'master' } })"));
+
+    // setup
+    NLog::log("{}Spawning 1 master and 3 slave windows", Colors::YELLOW);
+    // order of windows set according to new_status = master (set in test.lua)
+    for (auto const& win : {"slave1", "slave2", "slave3", "master"}) {
+        if (!Tests::spawnKitty(win)) {
+            FAIL_TEST("Could not spawn kitty with win class `{}`", win);
+        }
+    }
+    NLog::log("{}Ensuring focus is on master before testing", Colors::YELLOW);
+    OK(getFromSocket("/dispatch hl.dsp.layout('focusmaster master')"));
+    ASSERT_CONTAINS(getFromSocket("/activewindow"), "class: master");
+
+    // test
+    NLog::log("{}Testing fallback to focusmaster auto", Colors::YELLOW);
+
+    OK(getFromSocket("/dispatch hl.dsp.layout('focusmaster previous')"));
+    ASSERT_CONTAINS(getFromSocket("/activewindow"), "class: slave1");
+
+    NLog::log("{}Testing focusing from slave to master", Colors::YELLOW);
+
+    OK(getFromSocket("/dispatch hl.dsp.layout('cyclenext noloop')"));
+    ASSERT_CONTAINS(getFromSocket("/activewindow"), "class: slave2");
+    OK(getFromSocket("/dispatch hl.dsp.layout('focusmaster previous')"));
+    ASSERT_CONTAINS(getFromSocket("/activewindow"), "class: master");
+
+    NLog::log("{}Testing focusing on previous window", Colors::YELLOW);
+
+    OK(getFromSocket("/dispatch hl.dsp.layout('focusmaster previous')"));
+    ASSERT_CONTAINS(getFromSocket("/activewindow"), "class: slave2");
+
+    NLog::log("{}Testing focusing back to master", Colors::YELLOW);
+
+    OK(getFromSocket("/dispatch hl.dsp.layout('focusmaster previous')"));
+    ASSERT_CONTAINS(getFromSocket("/activewindow"), "class: master");
 
-// reqs 1 master 3 slaves
-static void testOrientations() {
     OK(getFromSocket("r/eval hl.config({ master = { orientation = 'top' } })"));
 
     // top
@@ -51,62 +85,15 @@ static void testOrientations() {
     }
 }
 
-static void focusMasterPrevious() {
-    // setup
-    NLog::log("{}Spawning 1 master and 3 slave windows", Colors::YELLOW);
-    // order of windows set according to new_status = master (set in test.lua)
-    for (auto const& win : {"slave1", "slave2", "slave3", "master"}) {
-        if (!Tests::spawnKitty(win)) {
-            NLog::log("{}Failed to spawn kitty with win class `{}`", Colors::RED, win);
-            ++TESTS_FAILED;
-            ret = 1;
-            return;
-        }
-    }
-    NLog::log("{}Ensuring focus is on master before testing", Colors::YELLOW);
-    OK(getFromSocket("/dispatch hl.dsp.layout('focusmaster master')"));
-    EXPECT_CONTAINS(getFromSocket("/activewindow"), "class: master");
-
-    // test
-    NLog::log("{}Testing fallback to focusmaster auto", Colors::YELLOW);
-
-    OK(getFromSocket("/dispatch hl.dsp.layout('focusmaster previous')"));
-    EXPECT_CONTAINS(getFromSocket("/activewindow"), "class: slave1");
-
-    NLog::log("{}Testing focusing from slave to master", Colors::YELLOW);
-
-    OK(getFromSocket("/dispatch hl.dsp.layout('cyclenext noloop')"));
-    EXPECT_CONTAINS(getFromSocket("/activewindow"), "class: slave2");
-    OK(getFromSocket("/dispatch hl.dsp.layout('focusmaster previous')"));
-    EXPECT_CONTAINS(getFromSocket("/activewindow"), "class: master");
-
-    NLog::log("{}Testing focusing on previous window", Colors::YELLOW);
-
-    OK(getFromSocket("/dispatch hl.dsp.layout('focusmaster previous')"));
-    EXPECT_CONTAINS(getFromSocket("/activewindow"), "class: slave2");
-
-    NLog::log("{}Testing focusing back to master", Colors::YELLOW);
-
-    OK(getFromSocket("/dispatch hl.dsp.layout('focusmaster previous')"));
-    EXPECT_CONTAINS(getFromSocket("/activewindow"), "class: master");
-
-    testOrientations();
-
-    // clean up
-    NLog::log("{}Killing all windows", Colors::YELLOW);
-    Tests::killAllWindows();
-}
-
-static void testFsBehavior() {
+TEST_CASE(fsBehavior) {
     // Master will re-send data to fullscreen / maximized windows, which can interfere with misc:on_focus_under_fullscreen
     // check that it doesn't.
 
+    OK(getFromSocket("r/eval hl.config({ general = { layout = 'master' } })"));
+
     for (auto const& win : {"master", "slave1", "slave2"}) {
         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);
         }
     }
 
@@ -153,31 +140,4 @@ static void testFsBehavior() {
         EXPECT_CONTAINS(str, "class: vaxwashere");
         EXPECT_CONTAINS(str, "fullscreen: 0");
     }
-
-    NLog::log("{}Killing all windows", Colors::YELLOW);
-    Tests::killAllWindows();
-}
-
-static bool test() {
-    NLog::log("{}Testing Master layout", Colors::GREEN);
-
-    // setup
-    OK(getFromSocket("/dispatch hl.dsp.focus({ workspace = 'name:master' })"));
-    OK(getFromSocket("r/eval hl.config({ general = { layout = 'master' } })"));
-
-    // test
-    NLog::log("{}Testing `focusmaster previous` layoutmsg", Colors::GREEN);
-    focusMasterPrevious();
-
-    NLog::log("{}Testing fs behavior", Colors::GREEN);
-    testFsBehavior();
-
-    // 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);