Merge pull request #93413 from liff/taskserver-python-test

nixosTests.taskserver: Port to python

nixos/tests/taskserver.nix

@@ -1,4 +1,4 @@
-import ./make-test.nix ({ pkgs, ... }: let
+import ./make-test-python.nix ({ pkgs, ... }: let
   snakeOil = pkgs.runCommand "snakeoil-certs" {
     outputs = [ "out" "cacert" "cert" "key" "crl" ];
     buildInputs = [ pkgs.gnutls.bin ];
@@ -105,187 +105,178 @@ in {
     newServerSystem = nodes.newServer.config.system.build.toplevel;
     switchToNewServer = "${newServerSystem}/bin/switch-to-configuration test";
   in ''
-    sub su ($$) {
+    from shlex import quote
-      my ($user, $cmd) = @_;
-      my $esc = $cmd =~ s/'/'\\${"'"}'/gr;
-      return "su - $user -c '$esc'";
-    }
 
-    sub setupClientsFor ($$;$) {
-      my ($org, $user, $extraInit) = @_;
 
-      for my $client ($client1, $client2) {
+    def su(user, cmd):
-        $client->nest("initialize client for user $user", sub {
+        return f"su - {user} -c {quote(cmd)}"
-          $client->succeed(
-            (su $user, "rm -rf /home/$user/.task"),
-            (su $user, "task rc.confirmation=no config confirmation no")
-          );
 
-          my $exportinfo = $server->succeed(
-            "nixos-taskserver user export $org $user"
-          );
 
-          $exportinfo =~ s/'/'\\'''/g;
+    def no_extra_init(client, org, user):
+        pass
 
-          $client->nest("importing taskwarrior configuration", sub {
-            my $cmd = su $user, "eval '$exportinfo' >&2";
-            my ($status, $out) = $client->execute_($cmd);
-            if ($status != 0) {
-              $client->log("output: $out");
-              die "command `$cmd' did not succeed (exit code $status)\n";
-            }
-          });
 
-          eval { &$extraInit($client, $org, $user) };
+    def setup_clients_for(org, user, extra_init=no_extra_init):
+        for client in [client1, client2]:
+            with client.nested(f"initialize client for user {user}"):
+                client.succeed(
+                    su(user, f"rm -rf /home/{user}/.task"),
+                    su(user, "task rc.confirmation=no config confirmation no"),
+                )
 
-          $client->succeed(su $user,
+                exportinfo = server.succeed(f"nixos-taskserver user export {org} {user}")
-            "task config taskd.server server:${portStr} >&2"
-          );
 
-          $client->succeed(su $user, "task sync init >&2");
+                with client.nested("importing taskwarrior configuration"):
-        });
+                    client.succeed(su(user, f"eval {quote(exportinfo)} >&2"))
-      }
-    }
 
-    sub restartServer {
+                extra_init(client, org, user)
-      $server->succeed("systemctl restart taskserver.service");
-      $server->waitForOpenPort(${portStr});
-    }
 
-    sub readdImperativeUser {
+                client.succeed(su(user, "task config taskd.server server:${portStr} >&2"))
-      $server->nest("(re-)add imperative user bar", sub {
+
-        $server->execute("nixos-taskserver org remove imperativeOrg");
+                client.succeed(su(user, "task sync init >&2"))
-        $server->succeed(
+
+
+    def restart_server():
+        server.systemctl("restart taskserver.service")
+        server.wait_for_open_port(${portStr})
+
+
+    def re_add_imperative_user():
+        with server.nested("(re-)add imperative user bar"):
+            server.execute("nixos-taskserver org remove imperativeOrg")
+            server.succeed(
                 "nixos-taskserver org add imperativeOrg",
-          "nixos-taskserver user add imperativeOrg bar"
+                "nixos-taskserver user add imperativeOrg bar",
-        );
+            )
-        setupClientsFor "imperativeOrg", "bar";
+            setup_clients_for("imperativeOrg", "bar")
-      });
-    }
 
-    sub testSync ($) {
-      my $user = $_[0];
-      subtest "sync for user $user", sub {
-        $client1->succeed(su $user, "task add foo >&2");
-        $client1->succeed(su $user, "task sync >&2");
-        $client2->fail(su $user, "task list >&2");
-        $client2->succeed(su $user, "task sync >&2");
-        $client2->succeed(su $user, "task list >&2");
-      };
-    }
 
-    sub checkClientCert ($) {
+    def test_sync(user):
-      my $user = $_[0];
+        with subtest(f"sync for user {user}"):
+            client1.succeed(su(user, "task add foo >&2"))
+            client1.succeed(su(user, "task sync >&2"))
+            client2.fail(su(user, "task list >&2"))
+            client2.succeed(su(user, "task sync >&2"))
+            client2.succeed(su(user, "task list >&2"))
+
+
+    def check_client_cert(user):
         # debug level 3 is a workaround for gnutls issue https://gitlab.com/gnutls/gnutls/-/issues/1040
-      my $cmd = "gnutls-cli -d 3".
+        cmd = (
-        " --x509cafile=/home/$user/.task/keys/ca.cert".
+            f"gnutls-cli -d 3"
-        " --x509keyfile=/home/$user/.task/keys/private.key".
+            f" --x509cafile=/home/{user}/.task/keys/ca.cert"
-        " --x509certfile=/home/$user/.task/keys/public.cert".
+            f" --x509keyfile=/home/{user}/.task/keys/private.key"
-        " --port=${portStr} server < /dev/null";
+            f" --x509certfile=/home/{user}/.task/keys/public.cert"
-      return su $user, $cmd;
+            f" --port=${portStr} server < /dev/null"
-    }
+        )
+        return su(user, cmd)
+
 
     # Explicitly start the VMs so that we don't accidentally start newServer
-    $server->start;
+    server.start()
-    $client1->start;
+    client1.start()
-    $client2->start;
+    client2.start()
 
-    $server->waitForUnit("taskserver.service");
+    server.wait_for_unit("taskserver.service")
 
-    $server->succeed(
+    server.succeed(
         "nixos-taskserver user list testOrganisation | grep -qxF alice",
         "nixos-taskserver user list testOrganisation | grep -qxF foo",
-      "nixos-taskserver user list anotherOrganisation | grep -qxF bob"
+        "nixos-taskserver user list anotherOrganisation | grep -qxF bob",
-    );
+    )
 
-    $server->waitForOpenPort(${portStr});
+    server.wait_for_open_port(${portStr})
 
-    $client1->waitForUnit("multi-user.target");
+    client1.wait_for_unit("multi-user.target")
-    $client2->waitForUnit("multi-user.target");
+    client2.wait_for_unit("multi-user.target")
 
-    setupClientsFor "testOrganisation", "alice";
+    setup_clients_for("testOrganisation", "alice")
-    setupClientsFor "testOrganisation", "foo";
+    setup_clients_for("testOrganisation", "foo")
-    setupClientsFor "anotherOrganisation", "bob";
+    setup_clients_for("anotherOrganisation", "bob")
 
-    testSync $_ for ("alice", "bob", "foo");
+    for user in ["alice", "bob", "foo"]:
+        test_sync(user)
 
-    $server->fail("nixos-taskserver user add imperativeOrg bar");
+    server.fail("nixos-taskserver user add imperativeOrg bar")
-    readdImperativeUser;
+    re_add_imperative_user()
 
-    testSync "bar";
+    test_sync("bar")
 
-    subtest "checking certificate revocation of user bar", sub {
+    with subtest("checking certificate revocation of user bar"):
-      $client1->succeed(checkClientCert "bar");
+        client1.succeed(check_client_cert("bar"))
 
-      $server->succeed("nixos-taskserver user remove imperativeOrg bar");
+        server.succeed("nixos-taskserver user remove imperativeOrg bar")
-      restartServer;
+        restart_server()
 
-      $client1->fail(checkClientCert "bar");
+        client1.fail(check_client_cert("bar"))
 
-      $client1->succeed(su "bar", "task add destroy everything >&2");
+        client1.succeed(su("bar", "task add destroy everything >&2"))
-      $client1->fail(su "bar", "task sync >&2");
+        client1.fail(su("bar", "task sync >&2"))
-    };
 
-    readdImperativeUser;
+    re_add_imperative_user()
 
-    subtest "checking certificate revocation of org imperativeOrg", sub {
+    with subtest("checking certificate revocation of org imperativeOrg"):
-      $client1->succeed(checkClientCert "bar");
+        client1.succeed(check_client_cert("bar"))
 
-      $server->succeed("nixos-taskserver org remove imperativeOrg");
+        server.succeed("nixos-taskserver org remove imperativeOrg")
-      restartServer;
+        restart_server()
 
-      $client1->fail(checkClientCert "bar");
+        client1.fail(check_client_cert("bar"))
 
-      $client1->succeed(su "bar", "task add destroy even more >&2");
+        client1.succeed(su("bar", "task add destroy even more >&2"))
-      $client1->fail(su "bar", "task sync >&2");
+        client1.fail(su("bar", "task sync >&2"))
-    };
 
-    readdImperativeUser;
+    re_add_imperative_user()
 
-    subtest "check whether declarative config overrides user bar", sub {
+    with subtest("check whether declarative config overrides user bar"):
-      restartServer;
+        restart_server()
-      testSync "bar";
+        test_sync("bar")
-    };
 
-    subtest "check manual configuration", sub {
+
+    def init_manual_config(client, org, user):
+        cfgpath = f"/home/{user}/.task"
+
+        client.copy_from_host(
+            "${snakeOil.cacert}",
+            f"{cfgpath}/ca.cert",
+        )
+        for file in ["alice.key", "alice.cert"]:
+            client.copy_from_host(
+                f"${snakeOil}/{file}",
+                f"{cfgpath}/{file}",
+            )
+
+        for file in [f"{user}.key", f"{user}.cert"]:
+            client.copy_from_host(
+                f"${snakeOil}/{file}",
+                f"{cfgpath}/{file}",
+            )
+
+        client.succeed(
+            su("alice", f"task config taskd.ca {cfgpath}/ca.cert"),
+            su("alice", f"task config taskd.key {cfgpath}/{user}.key"),
+            su(user, f"task config taskd.certificate {cfgpath}/{user}.cert"),
+        )
+
+
+    with subtest("check manual configuration"):
         # Remove the keys from automatic CA creation, to make sure the new
         # generation doesn't use keys from before.
-      $server->succeed('rm -rf ${cfg.dataDir}/keys/* >&2');
+        server.succeed("rm -rf ${cfg.dataDir}/keys/* >&2")
 
-      $server->succeed('${switchToNewServer} >&2');
+        server.succeed(
-      $server->waitForUnit("taskserver.service");
+            "${switchToNewServer} >&2"
-      $server->waitForOpenPort(${portStr});
+        )
+        server.wait_for_unit("taskserver.service")
+        server.wait_for_open_port(${portStr})
 
-      $server->succeed(
+        server.succeed(
             "nixos-taskserver org add manualOrg",
-        "nixos-taskserver user add manualOrg alice"
+            "nixos-taskserver user add manualOrg alice",
-      );
+        )
 
-      setupClientsFor "manualOrg", "alice", sub {
+        setup_clients_for("manualOrg", "alice", init_manual_config)
-        my ($client, $org, $user) = @_;
-        my $cfgpath = "/home/$user/.task";
 
-        $client->copyFileFromHost("${snakeOil.cacert}", "$cfgpath/ca.cert");
+        test_sync("alice")
-        for my $file ('alice.key', 'alice.cert') {
-          $client->copyFileFromHost("${snakeOil}/$file", "$cfgpath/$file");
-        }
-
-        for my $file ("$user.key", "$user.cert") {
-          $client->copyFileFromHost(
-            "${snakeOil}/$file", "$cfgpath/$file"
-          );
-        }
-        $client->copyFileFromHost(
-          "${snakeOil.cacert}", "$cfgpath/ca.cert"
-        );
-        $client->succeed(
-          (su "alice", "task config taskd.ca $cfgpath/ca.cert"),
-          (su "alice", "task config taskd.key $cfgpath/$user.key"),
-          (su $user, "task config taskd.certificate $cfgpath/$user.cert")
-        );
-      };
-
-      testSync "alice";
-    };
   '';
 })