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, 10 insertions, 73 deletions

diff --git a/hyprtester/src/tests/main/dwindle.cpp b/hyprtester/src/tests/main/dwindle.cpp
index b0bbe9a9..5641f8ac 100644
--- a/hyprtester/src/tests/main/dwindle.cpp
+++ b/hyprtester/src/tests/main/dwindle.cpp
@@ -3,15 +3,10 @@
 #include "../../hyprctlCompat.hpp"
 #include "tests.hpp"
 
-static int  ret = 0;
-
-static void testFloatClamp() {
+TEST_CASE(dwindleFloatClamp) {
     for (auto const& win : {"a", "b", "c"}) {
         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);
         }
     }
 
@@ -30,25 +25,16 @@ static void testFloatClamp() {
     }
 
     OK(getFromSocket("/eval hl.config({ dwindle = { force_split = 0 } })"));
-
-    // clean up
-    NLog::log("{}Killing all windows", Colors::YELLOW);
-    Tests::killAllWindows();
-
-    OK(getFromSocket("/reload"));
 }
 
-static void test13349() {
+TEST_CASE(dwindleIssue13349) {
 
     // Test if dwindle properly uses a focal point to place a new window.
     // exposed by #13349 as a regression from #12890
 
     for (auto const& win : {"a", "b", "c"}) {
         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);
         }
     }
 
@@ -75,13 +61,9 @@ static void test13349() {
         EXPECT_CONTAINS(str, "at: 967,547");
         EXPECT_CONTAINS(str, "size: 931,511");
     }
-
-    // clean up
-    NLog::log("{}Killing all windows", Colors::YELLOW);
-    Tests::killAllWindows();
 }
 
-static void testSplit() {
+TEST_CASE(dwindleSplit) {
     // Test various split methods
 
     Tests::spawnKitty("a");
@@ -130,22 +112,16 @@ static void testSplit() {
         EXPECT_CONTAINS(str, "at: 22,859");
         EXPECT_CONTAINS(str, "size: 1876,199");
     }
-
-    NLog::log("{}Killing all windows", Colors::YELLOW);
-    Tests::killAllWindows();
 }
 
-static void testRotatesplit() {
+TEST_CASE(dwindleRotateSplit) {
     OK(getFromSocket("r/eval hl.config({ general = { gaps_in = 0 } })"));
     OK(getFromSocket("r/eval hl.config({ general = { gaps_out = 0 } })"));
     OK(getFromSocket("r/eval hl.config({ general = { border_size = 0 } })"));
 
     for (auto const& win : {"a", "b"}) {
         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);
         }
     }
 
@@ -220,19 +196,14 @@ static void testRotatesplit() {
         EXPECT_CONTAINS(str, "at: 960,0");
         EXPECT_CONTAINS(str, "size: 960,1080");
     }
-
-    NLog::log("{}Killing all windows", Colors::YELLOW);
-    Tests::killAllWindows();
-
-    OK(getFromSocket("/reload"));
 }
 
-static void testForceSplitOnMoveToWorkspace() {
+TEST_CASE(dwindleForceSplitOnMoveToWorkspace) {
     OK(getFromSocket("/dispatch hl.dsp.focus({ workspace = '2' })"));
-    EXPECT(!!Tests::spawnKitty("kitty"), true);
+    ASSERT(!!Tests::spawnKitty("kitty"), true);
 
     OK(getFromSocket("/dispatch hl.dsp.focus({ workspace = '1' })"));
-    EXPECT(!!Tests::spawnKitty("kitty"), true);
+    ASSERT(!!Tests::spawnKitty("kitty"), true);
     std::string posBefore = Tests::getWindowAttribute(getFromSocket("/activewindow"), "at:");
 
     OK(getFromSocket("/eval hl.config({ dwindle = { force_split = 2 } })"));
@@ -242,38 +213,4 @@ static void testForceSplitOnMoveToWorkspace() {
     // Should be moved to the right, so the position should change
     std::string activeWindow = getFromSocket("/activewindow");
     EXPECT(activeWindow.contains(posBefore), false);
-
-    // clean up
-    OK(getFromSocket("/reload"));
-    Tests::killAllWindows();
-    Tests::waitUntilWindowsN(0);
-}
-
-static bool test() {
-    NLog::log("{}Testing Dwindle layout", Colors::GREEN);
-
-    // test
-    NLog::log("{}Testing float clamp", Colors::GREEN);
-    testFloatClamp();
-
-    NLog::log("{}Testing #13349", Colors::GREEN);
-    test13349();
-
-    NLog::log("{}Testing splits", Colors::GREEN);
-    testSplit();
-
-    NLog::log("{}Testing rotatesplit", Colors::GREEN);
-    testRotatesplit();
-
-    NLog::log("{}Testing force_split on move to workspace", Colors::GREEN);
-    testForceSplitOnMoveToWorkspace();
-
-    // clean up
-    NLog::log("Cleaning up", Colors::YELLOW);
-    getFromSocket("/dispatch hl.dsp.focus({ workspace = '1' })");
-    OK(getFromSocket("/reload"));
-
-    return !ret;
 }
-
-REGISTER_TEST_FN(test);