commit b46f6cba79f9f6f809f7c21fe0dabaeb1f171c04 · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       177
       177
        
         ./programs/tmux.nix

     

       178
       178
        
         ./programs/traceroute.nix

     

       179
       179
        
         ./programs/tsm-client.nix

     

       180
       180
       +
         ./programs/turbovnc.nix

     

       180
       181
        
         ./programs/udevil.nix

     

       181
       182
        
         ./programs/usbtop.nix

     

       182
       183
        
         ./programs/vim.nix

+54

nixos/modules/programs/turbovnc.nix

···

       1
       1
       +
       # Global configuration for the SSH client.

     

       2
       2
       +
       

     

       3
       3
       +
       { config, lib, pkgs, ... }:

     

       4
       4
       +
       

     

       5
       5
       +
       with lib;

     

       6
       6
       +
       

     

       7
       7
       +
       let

     

       8
       8
       +
         cfg = config.programs.turbovnc;

     

       9
       9
       +
       in

     

       10
       10
       +
       {

     

       11
       11
       +
         options = {

     

       12
       12
       +
       

     

       13
       13
       +
           programs.turbovnc = {

     

       14
       14
       +
       

     

       15
       15
       +
             ensureHeadlessSoftwareOpenGL = mkOption {

     

       16
       16
       +
               type = types.bool;

     

       17
       17
       +
               default = false;

     

       18
       18
       +
               description = ''

     

       19
       19
       +
                 Whether to set up NixOS such that TurboVNC's built-in software OpenGL

     

       20
       20
       +
                 implementation works.

     

       21
       21
       +
       

     

       22
       22
       +
                 This will enable <option>hardware.opengl.enable</option> so that OpenGL

     

       23
       23
       +
                 programs can find Mesa's llvmpipe drivers.

     

       24
       24
       +
       

     

       25
       25
       +
                 Setting this option to <code>false</code> does not mean that software

     

       26
       26
       +
                 OpenGL won't work; it may still work depending on your system

     

       27
       27
       +
                 configuration.

     

       28
       28
       +
       

     

       29
       29
       +
                 This option is also intended to generate warnings if you are using some

     

       30
       30
       +
                 configuration that's incompatible with using headless software OpenGL

     

       31
       31
       +
                 in TurboVNC.

     

       32
       32
       +
               '';

     

       33
       33
       +
             };

     

       34
       34
       +
       

     

       35
       35
       +
           };

     

       36
       36
       +
       

     

       37
       37
       +
         };

     

       38
       38
       +
       

     

       39
       39
       +
         config = mkIf cfg.ensureHeadlessSoftwareOpenGL {

     

       40
       40
       +
       

     

       41
       41
       +
           # TurboVNC has builtin support for Mesa llvmpipe's `swrast`

     

       42
       42
       +
           # software rendering to implemnt GLX (OpenGL on Xorg).

     

       43
       43
       +
           # However, just building TurboVNC with support for that is not enough

     

       44
       44
       +
           # (it only takes care of the X server side part of OpenGL);

     

       45
       45
       +
           # the indiviudual applications (e.g. `glxgears`) also need to directly load

     

       46
       46
       +
           # the OpenGL libs.

     

       47
       47
       +
           # Thus, this creates `/run/opengl-driver` populated by Mesa so that the applications

     

       48
       48
       +
           # can find the llvmpipe `swrast.so` software rendering DRI lib via `libglvnd`.

     

       49
       49
       +
           # This comment exists to explain why `hardware.` is involved,

     

       50
       50
       +
           # even though 100% software rendering is used.

     

       51
       51
       +
           hardware.opengl.enable = true;

     

       52
       52
       +
       

     

       53
       53
       +
         };

     

       54
       54
       +
       }

nixos/tests/all-tests.nix

···

       408
       408
        
         trickster = handleTest ./trickster.nix {};

     

       409
       409
        
         trilium-server = handleTestOn ["x86_64-linux"] ./trilium-server.nix {};

     

       410
       410
        
         tuptime = handleTest ./tuptime.nix {};

     

       411
       411
       +
         turbovnc-headless-server = handleTest ./turbovnc-headless-server.nix {};

     

       411
       412
        
         ucg = handleTest ./ucg.nix {};

     

       412
       413
        
         udisks2 = handleTest ./udisks2.nix {};

     

       413
       414
        
         unbound = handleTest ./unbound.nix {};

+171

nixos/tests/turbovnc-headless-server.nix

···

       1
       1
       +
       import ./make-test-python.nix ({ pkgs, lib, ... }: {

     

       2
       2
       +
         name = "turbovnc-headless-server";

     

       3
       3
       +
         meta = {

     

       4
       4
       +
           maintainers = with lib.maintainers; [ nh2 ];

     

       5
       5
       +
         };

     

       6
       6
       +
       

     

       7
       7
       +
         machine = { pkgs, ... }: {

     

       8
       8
       +
       

     

       9
       9
       +
           environment.systemPackages = with pkgs; [

     

       10
       10
       +
             glxinfo

     

       11
       11
       +
             procps # for `pkill`, `pidof` in the test

     

       12
       12
       +
             scrot # for screenshotting Xorg

     

       13
       13
       +
             turbovnc

     

       14
       14
       +
           ];

     

       15
       15
       +
       

     

       16
       16
       +
           programs.turbovnc.ensureHeadlessSoftwareOpenGL = true;

     

       17
       17
       +
       

     

       18
       18
       +
           networking.firewall = {

     

       19
       19
       +
             # Reject instead of drop, for failures instead of hangs.

     

       20
       20
       +
             rejectPackets = true;

     

       21
       21
       +
             allowedTCPPorts = [

     

       22
       22
       +
               5900 # VNC :0, for seeing what's going on in the server

     

       23
       23
       +
             ];

     

       24
       24
       +
           };

     

       25
       25
       +
       

     

       26
       26
       +
           # So that we can ssh into the VM, see e.g.

     

       27
       27
       +
           # http://blog.patapon.info/nixos-local-vm/#accessing-the-vm-with-ssh

     

       28
       28
       +
           services.openssh.enable = true;

     

       29
       29
       +
           services.openssh.permitRootLogin = "yes";

     

       30
       30
       +
           users.extraUsers.root.password = "";

     

       31
       31
       +
           users.mutableUsers = false;

     

       32
       32
       +
         };

     

       33
       33
       +
       

     

       34
       34
       +
         testScript = ''

     

       35
       35
       +
           def wait_until_terminated_or_succeeds(

     

       36
       36
       +
               termination_check_shell_command,

     

       37
       37
       +
               success_check_shell_command,

     

       38
       38
       +
               get_detail_message_fn,

     

       39
       39
       +
               retries=60,

     

       40
       40
       +
               retry_sleep=0.5,

     

       41
       41
       +
           ):

     

       42
       42
       +
               def check_success():

     

       43
       43
       +
                   command_exit_code, _output = machine.execute(success_check_shell_command)

     

       44
       44
       +
                   return command_exit_code == 0

     

       45
       45
       +
       

     

       46
       46
       +
               for _ in range(retries):

     

       47
       47
       +
                   exit_check_exit_code, _output = machine.execute(termination_check_shell_command)

     

       48
       48
       +
                   is_terminated = exit_check_exit_code != 0

     

       49
       49
       +
                   if is_terminated:

     

       50
       50
       +
                       if check_success():

     

       51
       51
       +
                           return

     

       52
       52
       +
                       else:

     

       53
       53
       +
                           details = get_detail_message_fn()

     

       54
       54
       +
                           raise Exception(

     

       55
       55
       +
                               f"termination check ({termination_check_shell_command}) triggered without command succeeding ({success_check_shell_command}); details: {details}"

     

       56
       56
       +
                           )

     

       57
       57
       +
                   else:

     

       58
       58
       +
                       if check_success():

     

       59
       59
       +
                           return

     

       60
       60
       +
                   time.sleep(retry_sleep)

     

       61
       61
       +
       

     

       62
       62
       +
               if not check_success():

     

       63
       63
       +
                   details = get_detail_message_fn()

     

       64
       64
       +
                   raise Exception(

     

       65
       65
       +
                       f"action timed out ({success_check_shell_command}); details: {details}"

     

       66
       66
       +
                   )

     

       67
       67
       +
       

     

       68
       68
       +
       

     

       69
       69
       +
           # Below we use the pattern:

     

       70
       70
       +
           #     (cmd | tee stdout.log) 3>&1 1>&2 2>&3 | tee stderr.log

     

       71
       71
       +
           # to capture both stderr and stdout while also teeing them, see:

     

       72
       72
       +
           # https://unix.stackexchange.com/questions/6430/how-to-redirect-stderr-and-stdout-to-different-files-and-also-display-in-termina/6431#6431

     

       73
       73
       +
       

     

       74
       74
       +
       

     

       75
       75
       +
           # Starts headless VNC server, backgrounding it.

     

       76
       76
       +
           def start_xvnc():

     

       77
       77
       +
               xvnc_command = " ".join(

     

       78
       78
       +
                   [

     

       79
       79
       +
                       "Xvnc",

     

       80
       80
       +
                       ":0",

     

       81
       81
       +
                       "-iglx",

     

       82
       82
       +
                       "-auth /root/.Xauthority",

     

       83
       83
       +
                       "-geometry 1240x900",

     

       84
       84
       +
                       "-depth 24",

     

       85
       85
       +
                       "-rfbwait 5000",

     

       86
       86
       +
                       "-deferupdate 1",

     

       87
       87
       +
                       "-verbose",

     

       88
       88
       +
                       "-securitytypes none",

     

       89
       89
       +
                       # We don't enforce localhost listening such that we

     

       90
       90
       +
                       # can connect from outside the VM using

     

       91
       91
       +
                       #     env QEMU_NET_OPTS=hostfwd=tcp::5900-:5900 $(nix-build nixos/tests/turbovnc-headless-server.nix -A driver)/bin/nixos-test-driver

     

       92
       92
       +
                       # for testing purposes, and so that we can in the future

     

       93
       93
       +
                       # add another test case that connects the TurboVNC client.

     

       94
       94
       +
                       # "-localhost",

     

       95
       95
       +
                   ]

     

       96
       96
       +
               )

     

       97
       97
       +
               machine.execute(

     

       98
       98
       +
                   # Note trailing & for backgrounding.

     

       99
       99
       +
                   f"({xvnc_command} | tee /tmp/Xvnc.stdout) 3>&1 1>&2 2>&3 | tee /tmp/Xvnc.stderr &",

     

       100
       100
       +
               )

     

       101
       101
       +
       

     

       102
       102
       +
       

     

       103
       103
       +
           # Waits until the server log message that tells us that GLX is ready

     

       104
       104
       +
           # (requires `-verbose` above), avoiding screenshoting racing below.

     

       105
       105
       +
           def wait_until_xvnc_glx_ready():

     

       106
       106
       +
               machine.wait_until_succeeds("test -f /tmp/Xvnc.stderr")

     

       107
       107
       +
               wait_until_terminated_or_succeeds(

     

       108
       108
       +
                   termination_check_shell_command="pidof Xvnc",

     

       109
       109
       +
                   success_check_shell_command="grep 'GLX: Initialized DRISWRAST' /tmp/Xvnc.stderr",

     

       110
       110
       +
                   get_detail_message_fn=lambda: "Contents of /tmp/Xvnc.stderr:\n"

     

       111
       111
       +
                   + machine.succeed("cat /tmp/Xvnc.stderr"),

     

       112
       112
       +
               )

     

       113
       113
       +
       

     

       114
       114
       +
       

     

       115
       115
       +
           # Checks that we detect glxgears failing when

     

       116
       116
       +
           # `LIBGL_DRIVERS_PATH=/nonexistent` is set

     

       117
       117
       +
           # (in which case software rendering should not work).

     

       118
       118
       +
           def test_glxgears_failing_with_bad_driver_path():

     

       119
       119
       +
               machine.execute(

     

       120
       120
       +
                   # Note trailing & for backgrounding.

     

       121
       121
       +
                   "(env DISPLAY=:0 LIBGL_DRIVERS_PATH=/nonexistent glxgears -info | tee /tmp/glxgears-should-fail.stdout) 3>&1 1>&2 2>&3 | tee /tmp/glxgears-should-fail.stderr &"

     

       122
       122
       +
               )

     

       123
       123
       +
               machine.wait_until_succeeds("test -f /tmp/glxgears-should-fail.stderr")

     

       124
       124
       +
               wait_until_terminated_or_succeeds(

     

       125
       125
       +
                   termination_check_shell_command="pidof glxgears",

     

       126
       126
       +
                   success_check_shell_command="grep 'libGL error: failed to load driver: swrast' /tmp/glxgears-should-fail.stderr",

     

       127
       127
       +
                   get_detail_message_fn=lambda: "Contents of /tmp/glxgears-should-fail.stderr:\n"

     

       128
       128
       +
                   + machine.succeed("cat /tmp/glxgears-should-fail.stderr"),

     

       129
       129
       +
               )

     

       130
       130
       +
               machine.wait_until_fails("pidof glxgears")

     

       131
       131
       +
       

     

       132
       132
       +
       

     

       133
       133
       +
           # Starts glxgears, backgrounding it. Waits until it prints the `GL_RENDERER`.

     

       134
       134
       +
           # Does not quit glxgears.

     

       135
       135
       +
           def test_glxgears_prints_renderer():

     

       136
       136
       +
               machine.execute(

     

       137
       137
       +
                   # Note trailing & for backgrounding.

     

       138
       138
       +
                   "(env DISPLAY=:0 glxgears -info | tee /tmp/glxgears.stdout) 3>&1 1>&2 2>&3 | tee /tmp/glxgears.stderr &"

     

       139
       139
       +
               )

     

       140
       140
       +
               machine.wait_until_succeeds("test -f /tmp/glxgears.stderr")

     

       141
       141
       +
               wait_until_terminated_or_succeeds(

     

       142
       142
       +
                   termination_check_shell_command="pidof glxgears",

     

       143
       143
       +
                   success_check_shell_command="grep 'GL_RENDERER' /tmp/glxgears.stdout",

     

       144
       144
       +
                   get_detail_message_fn=lambda: "Contents of /tmp/glxgears.stderr:\n"

     

       145
       145
       +
                   + machine.succeed("cat /tmp/glxgears.stderr"),

     

       146
       146
       +
               )

     

       147
       147
       +
       

     

       148
       148
       +
       

     

       149
       149
       +
           with subtest("Start Xvnc"):

     

       150
       150
       +
               start_xvnc()

     

       151
       151
       +
               wait_until_xvnc_glx_ready()

     

       152
       152
       +
       

     

       153
       153
       +
           with subtest("Ensure bad driver path makes glxgears fail"):

     

       154
       154
       +
               test_glxgears_failing_with_bad_driver_path()

     

       155
       155
       +
       

     

       156
       156
       +
           with subtest("Run 3D application (glxgears)"):

     

       157
       157
       +
               test_glxgears_prints_renderer()

     

       158
       158
       +
       

     

       159
       159
       +
               # Take screenshot; should display the glxgears.

     

       160
       160
       +
               machine.succeed("scrot --display :0 /tmp/glxgears.png")

     

       161
       161
       +
       

     

       162
       162
       +
           # Copy files down.

     

       163
       163
       +
           machine.copy_from_vm("/tmp/glxgears.png")

     

       164
       164
       +
           machine.copy_from_vm("/tmp/glxgears.stdout")

     

       165
       165
       +
           machine.copy_from_vm("/tmp/glxgears-should-fail.stdout")

     

       166
       166
       +
           machine.copy_from_vm("/tmp/glxgears-should-fail.stderr")

     

       167
       167
       +
           machine.copy_from_vm("/tmp/Xvnc.stdout")

     

       168
       168
       +
           machine.copy_from_vm("/tmp/Xvnc.stderr")

     

       169
       169
       +
         '';

     

       170
       170
       +
       

     

       171
       171
       +
       })

pkgs/tools/admin/turbovnc/default.nix

···

       1
       1
        
       { lib

     

       2
       2
        
       , stdenv

     

       3
       3
        
       , fetchFromGitHub

     

       4
       4
       +
       , nixosTests

     

       4
       5
        
       

     

       5
       6
        
       # Dependencies

     

       6
       7
        
       , cmake

     
···

       100
       101
        
             --prefix JAVA_HOME : "${lib.makeLibraryPath [ openjdk ]}/openjdk" \

     

       101
       102
        
             --prefix PATH : ${lib.makeBinPath [ openssh ]}

     

       102
       103
        
         '';

     

       104
       104
       +
       

     

       105
       105
       +
         passthru.tests.turbovnc-headless-server = nixosTests.turbovnc-headless-server;

     

       103
       106
        
       

     

       104
       107
        
         meta = {

     

       105
       108
        
           homepage = "https://turbovnc.org/";