From ce5b389bad464eded97b23153ad9dc115b6a43b7 Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Fri, 30 Oct 2026 07:44:21 -0700 Subject: [PATCH] docs(repo): config reload, exe rules and lock in the scenario table --- docs/dev/BEHAVIOUR.md | 14 ++++++++------ docs/dev/vm-tests.md | 14 ++++++++++++++ 2 files changed, 22 insertions(+), 6 deletions(-) diff --git a/docs/dev/BEHAVIOUR.md b/docs/dev/BEHAVIOUR.md index 166b25c1..6424ca8c 100644 --- a/docs/dev/BEHAVIOUR.md +++ b/docs/dev/BEHAVIOUR.md @@ -39,6 +39,9 @@ runs, and goes stale when the code changes. | `commands.unknown_monitor` | a window sent to a monitor that does not exist stays managed | **known failure** | **known failure** | | `rules` | initial, permanent and ignore rules by title, and that cleared rules stop applying | see below | pass | | `rules_class` | a workspace rule and an ignore rule by class (the app id on KDE) send a window or leave it alone | pass | pass | +| `rules_exe` | the same by the program that opened the window | pass | not run | +| `config_reload` | rewriting the `komorebi.json` the daemon runs on changes its names, layout and rules | pass | not run | +| `locking` | the screen is locked, a window moved, and unlocked: every window is in its tile again (session suite `core-lock`) | pass | not run | | `hotplug` | an unplugged display takes its windows to the other, a plugged one is a monitor | pass | pass | | `placement` | the placement rules of the config put a window first, last, or at a number | pass | 4 of 5 cases pass, **known failure**: the number 2 | | `startup_rules` | the workspace rules of the config apply to a window open before the daemon and to one after | pass | pass | @@ -64,6 +67,11 @@ and the cause is not known. ## What they have found +**`ignore-rule` drops a rule whose id an earlier rule has, whatever the kind.** `komorebi`'s +`IgnoreRule` handler compares only the ids, so `ignore-rule exe e2e-left` after `ignore-rule +class e2e-left` adds nothing and the window is managed. Seen on kfde; the scenarios use different +names (`rules_exe`). Whether kfw does the same is not known. + **A window sent to a monitor that does not exist is lost, on both ports.** After `komorebic send-to-monitor 7` (or `move-to-monitor 7`) on a desktop with one monitor, the daemon stops managing the focused window and leaves it on the screen with nothing tiling it. On kfw this @@ -192,12 +200,6 @@ because they only check the order of windows. Nothing else turned red. or acts on a second display with the pointer, cannot run there; none exists. Source: kfw's `e2e/platforms/qemu_windows/W1.md`, "The pointer with two displays". - Suspend and resume, which no guest can test. -- Reloading the configuration. kfde reloads `komorebi.json` about two seconds after the file - changes; kfw does it with `komorebic reload-configuration`, and `watch-configuration` there is - for the legacy files. The two have no command in common, so it has no neutral scenario: each - port tests its own (kfde's `the_daemon_follows_the_file_it_is_given_when_the_file_changes`). -- Rules by `exe`, which a scenario cannot give a test window on both ports without a program of - its own on each. - `commands` on kfw under load: it passed 247/0 in the two of four repeat runs that had the host to themselves, and the two that ran beside a VM suite and a build failed, with `komorebic state` replies slowing from milliseconds to about a second. Load is the likely cause, not shown. diff --git a/docs/dev/vm-tests.md b/docs/dev/vm-tests.md index 1a4c30cb..78fc8767 100644 --- a/docs/dev/vm-tests.md +++ b/docs/dev/vm-tests.md @@ -377,6 +377,20 @@ a suite, as `core-e2e` does, and run that suite on KVM: a scenario that passes the fake and fails on KDE has found a bug in the fake, the library or the daemon. `Snapshot.focused_title` was found wrong this way, by the `stacks` scenario. +## Recording a run with komorebi-recorder + +`komorebi-recorder`'s repository is private, so it is not an input of the flake. A run that wants +it builds it elsewhere and passes the store path, evaluating with `--impure`: + +```sh +KOMOREBI_RECORDER=$(nix build ~/komorebi-recorder#komorebi-recorder --no-link --print-out-paths) \ + nix build --impure .#checks.x86_64-linux.vm-core-lock -L +``` + +`core-e2e` and `core-lock` then record the session without video (`komorebi_vm.recorder`), print +the recorder's brief and findings into the log, and keep the session as `recording-NAME.tar.gz` +with the run's other artifacts. A run without the variable records nothing. + ## Looking inside a failed run `nix build -L` prints the guest's console, and a session test keeps its screenshots. Run the driver by hand, as