about summary refs log tree commit diff
path: root/nixos/tests/swayfx.nix
blob: 77844ec80ae1da31fb6a558fd358ef4998852147 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
import ./make-test-python.nix (
  { pkgs, lib, ... }:
  {
    name = "swayfx";
    meta = {
      maintainers = with lib.maintainers; [ eclairevoyant ];
    };

    # testScriptWithTypes:49: error: Cannot call function of unknown type
    #           (machine.succeed if succeed else machine.execute)(
    #           ^
    # Found 1 error in 1 file (checked 1 source file)
    skipTypeCheck = true;

    nodes.machine =
      { config, ... }:
      {
        # Automatically login on tty1 as a normal user:
        imports = [ ./common/user-account.nix ];
        services.getty.autologinUser = "alice";

        environment = {
          # For glinfo and wayland-info:
          systemPackages = with pkgs; [
            mesa-demos
            wayland-utils
            alacritty
          ];
          # Use a fixed SWAYSOCK path (for swaymsg):
          variables = {
            "SWAYSOCK" = "/tmp/sway-ipc.sock";
            # TODO: Investigate if we can get hardware acceleration to work (via
            # virtio-gpu and Virgil). We currently have to use the Pixman software
            # renderer since the GLES2 renderer doesn't work inside the VM (even
            # with WLR_RENDERER_ALLOW_SOFTWARE):
            # "WLR_RENDERER_ALLOW_SOFTWARE" = "1";
            "WLR_RENDERER" = "pixman";
          };
          # For convenience:
          shellAliases = {
            test-x11 = "glinfo | tee /tmp/test-x11.out && touch /tmp/test-x11-exit-ok";
            test-wayland = "wayland-info | tee /tmp/test-wayland.out && touch /tmp/test-wayland-exit-ok";
          };

          # To help with OCR:
          etc."xdg/foot/foot.ini".text = lib.generators.toINI { } {
            main = {
              font = "inconsolata:size=14";
            };
            colors = rec {
              foreground = "000000";
              background = "ffffff";
              regular2 = foreground;
            };
          };

          etc."gpg-agent.conf".text = ''
            pinentry-timeout 86400
          '';
        };

        fonts.packages = [ pkgs.inconsolata ];

        # Automatically configure and start Sway when logging in on tty1:
        programs.bash.loginShellInit = ''
          if [ "$(tty)" = "/dev/tty1" ]; then
            set -e

            mkdir -p ~/.config/sway
            sed s/Mod4/Mod1/ /etc/sway/config > ~/.config/sway/config

            sway --validate
            sway && touch /tmp/sway-exit-ok
          fi
        '';

        programs.sway = {
          enable = true;
          package = pkgs.swayfx.override { isNixOS = true; };
        };

        # To test pinentry via gpg-agent:
        programs.gnupg.agent.enable = true;

        # Need to switch to a different GPU driver than the default one (-vga std) so that Sway can launch:
        virtualisation.qemu.options = [ "-vga none -device virtio-gpu-pci" ];
      };

    testScript =
      { nodes, ... }:
      ''
        import shlex
        import json

        q = shlex.quote
        NODE_GROUPS = ["nodes", "floating_nodes"]


        def swaymsg(command: str = "", succeed=True, type="command"):
            assert command != "" or type != "command", "Must specify command or type"
            shell = q(f"swaymsg -t {q(type)} -- {q(command)}")
            with machine.nested(
                f"sending swaymsg {shell!r}" + " (allowed to fail)" * (not succeed)
            ):
                ret = (machine.succeed if succeed else machine.execute)(
                    f"su - alice -c {shell}"
                )

            # execute also returns a status code, but disregard.
            if not succeed:
                _, ret = ret

            if not succeed and not ret:
                return None

            parsed = json.loads(ret)
            return parsed


        def walk(tree):
            yield tree
            for group in NODE_GROUPS:
                for node in tree.get(group, []):
                    yield from walk(node)


        def wait_for_window(pattern):
            def func(last_chance):
                nodes = (node["name"] for node in walk(swaymsg(type="get_tree")))

                if last_chance:
                    nodes = list(nodes)
                    machine.log(f"Last call! Current list of windows: {nodes}")

                return any(pattern in name for name in nodes)

            retry(func)

        start_all()
        machine.wait_for_unit("multi-user.target")

        # To check the version:
        print(machine.succeed("sway --version"))

        # Wait for Sway to complete startup:
        machine.wait_for_file("/run/user/1000/wayland-1")
        machine.wait_for_file("/tmp/sway-ipc.sock")

        # Test XWayland (foot does not support X):
        swaymsg("exec WINIT_UNIX_BACKEND=x11 WAYLAND_DISPLAY= alacritty")
        wait_for_window("alice@machine")
        machine.send_chars("test-x11\n")
        machine.wait_for_file("/tmp/test-x11-exit-ok")
        print(machine.succeed("cat /tmp/test-x11.out"))
        machine.copy_from_vm("/tmp/test-x11.out")
        machine.screenshot("alacritty_glinfo")
        machine.succeed("pkill alacritty")

        # Start a terminal (foot) on workspace 3:
        machine.send_key("alt-3")
        machine.sleep(3)
        machine.send_key("alt-ret")
        wait_for_window("alice@machine")
        machine.send_chars("test-wayland\n")
        machine.wait_for_file("/tmp/test-wayland-exit-ok")
        print(machine.succeed("cat /tmp/test-wayland.out"))
        machine.copy_from_vm("/tmp/test-wayland.out")
        machine.screenshot("foot_wayland_info")
        machine.send_key("alt-shift-q")
        machine.wait_until_fails("pgrep foot")

        # Test gpg-agent starting pinentry-gnome3 via D-Bus (tests if
        # $WAYLAND_DISPLAY is correctly imported into the D-Bus user env):
        swaymsg("exec mkdir -p ~/.gnupg")
        swaymsg("exec cp /etc/gpg-agent.conf ~/.gnupg")

        swaymsg("exec DISPLAY=INVALID gpg --no-tty --yes --quick-generate-key test", succeed=False)
        machine.wait_until_succeeds("pgrep --exact gpg")
        wait_for_window("gpg")
        machine.succeed("pgrep --exact gpg")
        machine.screenshot("gpg_pinentry")
        machine.send_key("alt-shift-q")
        machine.wait_until_fails("pgrep --exact gpg")

        # Test swaynag:
        def get_height():
            return [node['rect']['height'] for node in walk(swaymsg(type="get_tree")) if node['focused']][0]

        before = get_height()
        machine.send_key("alt-shift-e")
        retry(lambda _: get_height() < before)
        machine.screenshot("sway_exit")

        swaymsg("exec swaylock")
        machine.wait_until_succeeds("pgrep -x swaylock")
        machine.sleep(3)
        machine.send_chars("${nodes.machine.config.users.users.alice.password}")
        machine.send_key("ret")
        machine.wait_until_fails("pgrep -x swaylock")

        # Exit Sway and verify process exit status 0:
        swaymsg("exit", succeed=False)
        machine.wait_until_fails("pgrep -x sway")
        machine.wait_for_file("/tmp/sway-exit-ok")
      '';
  }
)