Repository navigation
umbriel: add module - #9956
umbriel: add module#9956rachitvrma wants to merge 1 commit into
Conversation
|
@samiser could you please review this module? I took a lot of options from niri's home-manager module, but I am having some trouble writing tests for this module. |
| meta.maintainers = [ | ||
| lib.maintainers.rachitvrma | ||
| ]; | ||
| options.wayland.windowManager.umbriel = { |
There was a problem hiding this comment.
issue: new module is never imported
Home Manager imports this directory through modules/services/window-managers/default.nix, but that file has no ./umbriel.nix entry. A normal configuration therefore reports wayland.windowManager.umbriel.enable as an unknown option. Add the module to that import list.
| nullable = true; | ||
| extraDescription = '' | ||
| With `xwayland-satellite` in the {env}`$PATH`, umbriel can automatically | ||
| start XWayland when needed. Set to `null` if you want to disable xwayland. |
There was a problem hiding this comment.
issue: null satellite package does not disable xwayland
The default pkgs.umbriel package wraps umbriel with xwayland-satellite, and Umbriel enables general.xwayland by default. With xwaylandSatellitePackage = null, the wrapper still exposes the satellite binary, so Umbriel can still start XWayland. Make the package or generated configuration honor the null value.
| configPackages = lib.optional (cfg.package != null) cfg.package; | ||
| }; | ||
|
|
||
| xdg.configFile."umbriel/config.toml" = lib.mkIf (cfg.settings != { }) { |
There was a problem hiding this comment.
issue (blocking): Add basic NMT coverage for the new module
The only changed file is the module, so there are no tests of configuration generation or its conditional integrations. Could we add Linux-gated NMT cases, including a nonempty settings case compared against a handwritten TOML fixture and an empty-settings case proving no config is emitted? The package-null configuration should retain generated settings with systemd and validation disabled, and disabled-module/package/portal effects can be checked through config assertions. This directly addresses your request for help writing tests. The existing runner imports the module graph and provides home/XDG defaults, so these should be ordinary test modules rather than another evaluator. A generated-file fixture test can set checkConfig = false to avoid trying to execute a scrubbed package; that case does not prove the real validator path.
| lib.maintainers.rachitvrma | ||
| ]; | ||
| options.wayland.windowManager.umbriel = { | ||
| enable = lib.mkEnableOption "umbriel"; |
There was a problem hiding this comment.
issue (blocking): Include the required new-module news entry
Could we include a news entry announcing wayland.windowManager.umbriel? The contribution currently contains only the module, while the contributor news policy requires an entry for each new module. Generate it with nix run .#create-news-entry and restrict its audience to Linux, without conditioning it on the new enable option.
972d7a4 to
fc4d3bc
Compare
Description
Umbriel is a Wayland compositor designed by the Noctalia.dev project. It supports scrolling, dwindle and master layout. It is pre-configured to work with noctalia shell and greeter out of the box. Configuration is written in toml format.
See more at https://docs.noctalia.dev/umbriel/
Checklist
Change is backwards compatible.
Code formatted with
nix fmtornix-shell -A dev --run treefmt.Code tested through
nix build .#test-allor a targeted
nix run .#tests -- <pattern>.Test cases updated/added. See example.
Commit messages are formatted like
See CONTRIBUTING for more information and recent commit messages for examples.
If this PR adds a new module
If this PR adds an exciting new feature or contains a breaking change.