test: add vm tests (wip)

Signed-off-by: Patrizio Bekerle <[email protected]>

Author: pbek

flake.nix

@@ -67,5 +67,9 @@
             echo "qmake:  $(qmake --version)"
           '';
         };
+
+      checks.x86_64-linux = {
+        qownnotes = pkgs.testers.runNixOSTest ./tests/vm/qownnotes.nix;
+      };
     };
 }

justfile

@@ -231,3 +231,15 @@ run-github-workflow args='format-check':
 [group('maintenance')]
 build-botan3-amalgamation:
     nix-build -E 'with import <nixpkgs> {}; callPackage ./scripts/botan3-amalgamation.nix {}'
+
+# Run the VM tests
+[group('tests')]
+vm-test:
+    nix build .#checks.x86_64-linux.qownnotes -L --no-link
+
+# Run the interactive VM test
+[group('tests')]
+vm-test-interactive:
+    nix build .#checks.x86_64-linux.qownnotes.driverInteractive
+    echo "To interact with the test VM, run: start_all()"
+    ./result/bin/nixos-test-driver

tests/vm/common/auto.nix

@@ -0,0 +1,52 @@
+{ config, lib, ... }:
+
+let
+  cfg = config.test-support.displayManager.auto;
+in
+{
+
+  ###### interface
+
+  options = {
+    test-support.displayManager.auto = {
+      enable = lib.mkOption {
+        default = false;
+        description = ''
+          Whether to enable the fake "auto" display manager, which
+          automatically logs in the user specified in the
+          {option}`user` option.  This is mostly useful for
+          automated tests.
+        '';
+      };
+
+      user = lib.mkOption {
+        default = "root";
+        description = "The user account to login automatically.";
+      };
+    };
+  };
+
+  ###### implementation
+
+  config = lib.mkIf cfg.enable {
+    services.xserver.displayManager.lightdm.enable = true;
+    services.displayManager.autoLogin = {
+      enable = true;
+      inherit (cfg) user;
+    };
+
+    # lightdm by default doesn't allow auto login for root, which is
+    # required by some nixos tests. Override it here.
+    security.pam.services.lightdm-autologin.text = lib.mkForce ''
+      auth     requisite pam_nologin.so
+      auth     required  pam_succeed_if.so quiet
+      auth     required  pam_permit.so
+
+      account  include   lightdm
+
+      password include   lightdm
+
+      session  include   lightdm
+    '';
+  };
+}

tests/vm/common/user-account.nix

@@ -0,0 +1,16 @@
+_:
+
+{
+  users.users.alice = {
+    isNormalUser = true;
+    description = "Alice Foobar";
+    password = "foobar";
+    uid = 1000;
+  };
+
+  users.users.bob = {
+    isNormalUser = true;
+    description = "Bob Foobar";
+    password = "foobar";
+  };
+}

tests/vm/common/x11.nix

@@ -0,0 +1,22 @@
+{ lib, ... }:
+
+{
+  imports = [
+    ./auto.nix
+  ];
+
+  services.xserver.enable = true;
+
+  # Automatically log in.
+  test-support.displayManager.auto.enable = true;
+
+  # Use IceWM as the window manager.
+  # Don't use a desktop manager.
+  services.displayManager.defaultSession = lib.mkDefault "none+icewm";
+  services.xserver.windowManager.icewm.enable = true;
+
+  # Help with OCR
+  environment.etc."icewm/theme".text = ''
+    Theme="gtk2/default.theme"
+  '';
+}

tests/vm/qownnotes.nix

@@ -0,0 +1,91 @@
+{ lib, pkgs, ... }:
+
+let
+  qownnotesLocal = pkgs.qt6Packages.callPackage ../../default.nix { };
+in
+{
+  name = "qownnotes";
+  meta.maintainers = [ lib.maintainers.pbek ];
+
+  nodes.machine =
+    { ... }:
+
+    {
+      imports = [
+        ./common/user-account.nix
+        ./common/x11.nix
+      ];
+
+      test-support.displayManager.auto.user = "alice";
+      environment.systemPackages = [
+        qownnotesLocal
+        pkgs.xdotool
+      ];
+    };
+
+  enableOCR = true;
+
+  # https://nixos.org/manual/nixos/stable/#ssec-machine-objects
+  testScript =
+    _:
+    let
+      aliceDo = cmd: ''machine.succeed("su - alice -c '${cmd}' >&2 &");'';
+    in
+    ''
+      with subtest("Ensure X starts"):
+          start_all()
+          machine.wait_for_x()
+
+      with subtest("Check QOwnNotes version on CLI"):
+          ${aliceDo "qownnotes --version"}
+
+          machine.wait_for_console_text("QOwnNotes ${qownnotesLocal.version}")
+
+      with subtest("Ensure QOwnNotes starts"):
+          # start QOwnNotes window
+          ${aliceDo "qownnotes"}
+
+          machine.wait_for_text("Welcome to QOwnNotes")
+          machine.screenshot("QOwnNotes-Welcome")
+
+      with subtest("Finish first-run wizard"):
+          # The wizard should show up now
+          machine.wait_for_text("Note folder")
+          machine.send_key("ret")
+          machine.wait_for_console_text("Note path '/home/alice/Notes' was now created.")
+          machine.wait_for_text("Panel layout")
+          machine.send_key("ret")
+          machine.wait_for_text("Nextcloud")
+          machine.send_key("ret")
+
+          # OCR can't detect "App metric" anymore, so we will wait for another text
+          machine.wait_for_text("Open network settings")
+          machine.send_key("ret")
+
+          # Doesn't work for non-root
+          #machine.wait_for_window("QOwnNotes - ${pkgs.qownnotes.version}")
+
+          # OCR doesn't seem to be able any more to handle the main window
+          #machine.wait_for_text("QOwnNotes - ${pkgs.qownnotes.version}")
+
+          # The main window should now show up
+          machine.wait_for_open_port(22222)
+          machine.wait_for_console_text("QOwnNotes server listening on port 22222")
+
+          machine.screenshot("QOwnNotes-DemoNote")
+
+      with subtest("Create a new note"):
+          machine.send_key("ctrl-n")
+          machine.sleep(1)
+          machine.send_chars("This is a NixOS test!\n")
+          machine.wait_until_succeeds("find /home/alice/Notes -type f | grep -qi 'Note 2'")
+
+          # OCR doesn't seem to be able any more to handle the main window
+          #machine.wait_for_text("This is a NixOS test!")
+
+          # Doesn't work for non-root
+          #machine.wait_for_window("- QOwnNotes - ${pkgs.qownnotes.version}")
+
+          machine.screenshot("QOwnNotes-NewNote")
+    '';
+}