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, 9 insertions, 42 deletions

diff --git a/hyprtester/src/tests/main/hyprctl.cpp b/hyprtester/src/tests/main/hyprctl.cpp
index c6d6a9bf..c67c8af9 100644
--- a/hyprtester/src/tests/main/hyprctl.cpp
+++ b/hyprtester/src/tests/main/hyprctl.cpp
@@ -12,8 +12,6 @@
 #include <cerrno>
 #include "../shared.hpp"
 
-static int ret = 0;
-
 using namespace Hyprutils::OS;
 using namespace Hyprutils::Memory;
 
@@ -35,9 +33,7 @@ static void setWindowProp(const std::string& selector, const std::string& prop,
     getFromSocket("/dispatch hl.dsp.window.set_prop({ window = '" + selector + "', prop = '" + prop + "', value = '" + value + "' })");
 }
 
-static bool testDevicesActiveLayoutIndex() {
-    NLog::log("{}Testing hyprctl devices active_layout_index", Colors::GREEN);
-
+TEST_CASE(hyprctlDevicesActiveLayoutIndex) {
     // configure layouts
     OK(getFromSocket("r/eval hl.config({ input = { kb_layout = \"us,pl,ua\" } })"));
 
@@ -49,15 +45,11 @@ static bool testDevicesActiveLayoutIndex() {
         // check layout index
         EXPECT_CONTAINS(devicesJson, expected);
     }
-
-    return true;
 }
 
-static bool testGetprop() {
-    NLog::log("{}Testing hyprctl getprop", Colors::GREEN);
+TEST_CASE(hyprctlGetprop) {
     if (!Tests::spawnKitty()) {
-        NLog::log("{}Error: kitty did not spawn", Colors::RED);
-        return false;
+        FAIL_TEST("Could not spawn kitty");
     }
 
     // animation
@@ -166,41 +158,16 @@ static bool testGetprop() {
     EXPECT(getCommandStdOut("hyprctl getprop class:kitty"), "not enough args");
     EXPECT(getCommandStdOut("hyprctl getprop class:nonexistantclass animation"), "window not found");
     EXPECT(getCommandStdOut("hyprctl getprop class:kitty nonexistantprop"), "prop not found");
-
-    // kill all
-    NLog::log("{}Killing all windows", Colors::YELLOW);
-    Tests::killAllWindows();
-
-    NLog::log("{}Expecting 0 windows", Colors::YELLOW);
-    EXPECT(Tests::windowCount(), 0);
-
-    return true;
 }
 
-static void testSubmap() {
-    NLog::log("{}Testing hyprctl submap", Colors::GREEN);
-
+TEST_CASE(hyprctlSubmap) {
     EXPECT(getCommandStdOut("hyprctl submap"), "default\n");
     EXPECT(getCommandStdOut("hyprctl submap -j | jq -r \".\""), "default");
 }
 
-static bool test() {
-    NLog::log("{}Testing hyprctl", Colors::GREEN);
-
-    {
-        NLog::log("{}Testing hyprctl descriptions for any json errors", Colors::GREEN);
-        CProcess jqProc("bash", {"-c", "hyprctl descriptions | jq"});
-        jqProc.addEnv("HYPRLAND_INSTANCE_SIGNATURE", HIS);
-        jqProc.runSync();
-        EXPECT(jqProc.exitCode(), 0);
-    }
-
-    testGetprop();
-    testDevicesActiveLayoutIndex();
-    testSubmap();
-    getFromSocket("/reload");
-
-    return !ret;
+TEST_CASE(hyprctlJsonErrors) {
+    CProcess jqProc("bash", {"-c", "hyprctl descriptions | jq"});
+    jqProc.addEnv("HYPRLAND_INSTANCE_SIGNATURE", HIS);
+    jqProc.runSync();
+    EXPECT(jqProc.exitCode(), 0);
 }
-
-REGISTER_TEST_FN(test);