commit 44565adda500eb36e21a7c8f7ff67b32b272cf11 · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       473
        
         ./services/misc/synergy.nix

     

       474
        
         ./services/misc/sysprof.nix

     

       475
        
         ./services/misc/taskserver

     

       0
        
       
     

       476
        
         ./services/misc/tzupdate.nix

     

       477
        
         ./services/misc/uhub.nix

     

       478
        
         ./services/misc/weechat.nix

···

       473
        
         ./services/misc/synergy.nix

     

       474
        
         ./services/misc/sysprof.nix

     

       475
        
         ./services/misc/taskserver

     

       476
       +
         ./services/misc/tiddlywiki.nix

     

       477
        
         ./services/misc/tzupdate.nix

     

       478
        
         ./services/misc/uhub.nix

     

       479
        
         ./services/misc/weechat.nix

+52

nixos/modules/services/misc/tiddlywiki.nix

···

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

     

       2
       +
       

     

       3
       +
       with lib;

     

       4
       +
       

     

       5
       +
       let

     

       6
       +
       

     

       7
       +
         cfg = config.services.tiddlywiki;

     

       8
       +
         listenParams = concatStrings (mapAttrsToList (n: v: " '${n}=${toString v}' ") cfg.listenOptions);

     

       9
       +
         exe = "${pkgs.nodePackages.tiddlywiki}/lib/node_modules/.bin/tiddlywiki";

     

       10
       +
         name = "tiddlywiki";

     

       11
       +
         dataDir = "/var/lib/" + name;

     

       12
       +
       

     

       13
       +
       in {

     

       14
       +
       

     

       15
       +
         options.services.tiddlywiki = {

     

       16
       +
       

     

       17
       +
           enable = mkEnableOption "TiddlyWiki nodejs server";

     

       18
       +
       

     

       19
       +
           listenOptions = mkOption {

     

       20
       +
             type = types.attrs;

     

       21
       +
             default = {};

     

       22
       +
             example = {

     

       23
       +
               credentials = "../credentials.csv";

     

       24
       +
               readers="(authenticated)";

     

       25
       +
               port = 3456;

     

       26
       +
             };

     

       27
       +
             description = ''

     

       28
       +
               Parameters passed to <literal>--listen</literal> command.

     

       29
       +
               Refer to <link xlink:href="https://tiddlywiki.com/#WebServer"/>

     

       30
       +
               for details on supported values.

     

       31
       +
             '';

     

       32
       +
           };

     

       33
       +
         };

     

       34
       +
       

     

       35
       +
         config = mkIf cfg.enable {

     

       36
       +
           systemd = {

     

       37
       +
             services.tiddlywiki = {

     

       38
       +
               description = "TiddlyWiki nodejs server";

     

       39
       +
               after = [ "network.target" ];

     

       40
       +
               wantedBy = [ "multi-user.target" ];

     

       41
       +
               serviceConfig = {

     

       42
       +
                 Type = "simple";

     

       43
       +
                 Restart = "on-failure";

     

       44
       +
                 DynamicUser = true;

     

       45
       +
                 StateDirectory = name;

     

       46
       +
                 ExecStartPre = "-${exe} ${dataDir} --init server";

     

       47
       +
                 ExecStart = "${exe} ${dataDir} --listen ${listenParams}";

     

       48
       +
               };

     

       49
       +
             };

     

       50
       +
           };

     

       51
       +
         };

     

       52
       +
       }

nixos/tests/all-tests.nix

···

       247
        
         pdns-recursor = handleTest ./pdns-recursor.nix {};

     

       248
        
         taskserver = handleTest ./taskserver.nix {};

     

       249
        
         telegraf = handleTest ./telegraf.nix {};

     

       0
        
       
     

       250
        
         tinydns = handleTest ./tinydns.nix {};

     

       251
        
         tor = handleTest ./tor.nix {};

     

       252
        
         transmission = handleTest ./transmission.nix {};

···

       247
        
         pdns-recursor = handleTest ./pdns-recursor.nix {};

     

       248
        
         taskserver = handleTest ./taskserver.nix {};

     

       249
        
         telegraf = handleTest ./telegraf.nix {};

     

       250
       +
         tiddlywiki = handleTest ./tiddlywiki.nix {};

     

       251
        
         tinydns = handleTest ./tinydns.nix {};

     

       252
        
         tor = handleTest ./tor.nix {};

     

       253
        
         transmission = handleTest ./transmission.nix {};

+67

nixos/tests/tiddlywiki.nix

···

       1
       +
       import ./make-test.nix ({ ... }: {

     

       2
       +
         name = "tiddlywiki";

     

       3
       +
         nodes = {

     

       4
       +
           default = {

     

       5
       +
             services.tiddlywiki.enable = true;

     

       6
       +
           };

     

       7
       +
           configured = {

     

       8
       +
             boot.postBootCommands = ''

     

       9
       +
               echo "username,password

     

       10
       +
               somelogin,somesecret" > /var/lib/wikiusers.csv

     

       11
       +
             '';

     

       12
       +
             services.tiddlywiki = {

     

       13
       +
               enable = true;

     

       14
       +
               listenOptions = {

     

       15
       +
                 port = 3000;

     

       16
       +
                 credentials="../wikiusers.csv";

     

       17
       +
                 readers="(authenticated)";

     

       18
       +
               };

     

       19
       +
             };

     

       20
       +
           };

     

       21
       +
         };

     

       22
       +
       

     

       23
       +
         testScript = ''

     

       24
       +
           startAll;

     

       25
       +
       

     

       26
       +
           subtest "by default works without configuration", sub {

     

       27
       +
             $default->waitForUnit("tiddlywiki.service");

     

       28
       +
           };

     

       29
       +
       

     

       30
       +
           subtest "by default available on port 8080 without auth", sub {

     

       31
       +
             $default->waitForUnit("tiddlywiki.service");

     

       32
       +
             $default->waitForOpenPort(8080);

     

       33
       +
             $default->succeed("curl --fail 127.0.0.1:8080");

     

       34
       +
           };

     

       35
       +
       

     

       36
       +
           subtest "by default creates empty wiki", sub {

     

       37
       +
             $default->succeed("test -f /var/lib/tiddlywiki/tiddlywiki.info");

     

       38
       +
           };

     

       39
       +
       

     

       40
       +
           subtest "configured on port 3000 with basic auth", sub {

     

       41
       +
             $configured->waitForUnit("tiddlywiki.service");

     

       42
       +
             $configured->waitForOpenPort(3000);

     

       43
       +
             $configured->fail("curl --fail 127.0.0.1:3000");

     

       44
       +
             $configured->succeed("curl --fail 127.0.0.1:3000 --user somelogin:somesecret");

     

       45
       +
           };

     

       46
       +
       

     

       47
       +
           subtest "configured with different wikifolder", sub {

     

       48
       +
             $configured->succeed("test -f /var/lib/tiddlywiki/tiddlywiki.info");

     

       49
       +
           };

     

       50
       +
       

     

       51
       +
           subtest "restart preserves changes", sub {

     

       52
       +
             # given running wiki

     

       53
       +
             $default->waitForUnit("tiddlywiki.service");

     

       54
       +
             # with some changes

     

       55
       +
             $default->succeed("curl --fail --request PUT --header 'X-Requested-With:TiddlyWiki' --data '{ \"title\": \"title\", \"text\": \"content\" }' --url 127.0.0.1:8080/recipes/default/tiddlers/somepage ");

     

       56
       +
             $default->succeed("sleep 2"); # server syncs to filesystem on timer

     

       57
       +
       

     

       58
       +
             # when wiki is cycled

     

       59
       +
             $default->systemctl("restart tiddlywiki.service");

     

       60
       +
             $default->waitForUnit("tiddlywiki.service");

     

       61
       +
             $default->waitForOpenPort(8080);

     

       62
       +
       

     

       63
       +
             # the change is preserved

     

       64
       +
             $default->succeed("curl --fail 127.0.0.1:8080/recipes/default/tiddlers/somepage");

     

       65
       +
           };

     

       66
       +
         '';

     

       67
       +
       })