summaryrefslogtreecommitdiffstats
path: root/nixos/tests/litestream.nix
blob: f879226e6f56e09e06dec1c8bf81820192d76e2c (plain)
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
{ pkgs, lib, ... }:
let
  dbPath = "/var/lib/grafana/data/grafana.db";
  socketPath = "/run/litestream/litestream.sock";
in
{
  name = "litestream";
  meta = with pkgs.lib.maintainers; {
    maintainers = [ jwygoda ];
  };

  nodes.machine =
    { pkgs, ... }:
    {
      services.litestream = {
        enable = true;
        settings = {
          socket = {
            enabled = true;
            path = socketPath;
          };
          dbs = [
            {
              path = dbPath;
              replicas = [
                {
                  url = "sftp://foo:bar@127.0.0.1:22/home/foo/grafana";
                  auto-recover = true;
                }
              ];
            }
          ];
        };
      };
      # Litestream 0.5.x writes to the database (_litestream_seq table),
      # so grafana's data directory must be group-writable.
      systemd.tmpfiles.settings."10-litestream" = {
        "/var/lib/grafana".d = {
          mode = "0750";
          user = "grafana";
          group = "grafana";
        };
        "/var/lib/grafana/data".d = {
          mode = "2770";
          user = "grafana";
          group = "grafana";
        };
      };
      systemd.services.grafana.serviceConfig = {
        ExecStartPre = lib.mkAfter "+${pkgs.sqlite}/bin/sqlite3 ${dbPath} 'PRAGMA journal_mode=WAL;'";
        UMask = lib.mkForce "0007";
      };
      systemd.services.litestream = {
        after = [
          "grafana.service"
          "sshd.service"
        ];
        requires = [ "grafana.service" ];
        wants = [ "sshd.service" ];
        serviceConfig = {
          RuntimeDirectory = "litestream";
          ExecStartPre = "+/bin/sh -c 'chmod g+rw ${dbPath}*'";
        };
      };
      services.openssh = {
        enable = true;
        allowSFTP = true;
        listenAddresses = [
          {
            addr = "127.0.0.1";
            port = 22;
          }
        ];
      };
      services.grafana = {
        enable = true;
        settings = {
          security = {
            admin_user = "admin";
            admin_password = "admin";
            secret_key = "SW2YcwTIb9zpOOhoPsMm";
          };

          server = {
            http_addr = "127.0.0.1";
            http_port = 3000;
          };

          database = {
            type = "sqlite3";
            path = dbPath;
            wal = true;
          };
        };
      };
      users.users.foo = {
        isNormalUser = true;
        password = "bar";
      };
      users.users.litestream.extraGroups = [ "grafana" ];
      environment.systemPackages = [ pkgs.sqlite ];
    };

  testScript = ''
    start_all()
    machine.wait_for_open_port(3000)
    with subtest("Verify litestream replicates changes"):
        machine.succeed("""
            curl -sSfN -X PUT --json '{
              "name": "LitestreamTest",
              "login": "admin",
              "email": "admin@localhost"
            }' http://admin:admin@127.0.0.1:3000/api/user
        """)
        machine.succeed("litestream sync -wait -socket ${socketPath} ${dbPath}")
        machine.succeed(
            "litestream restore -o /tmp/restored.db ${dbPath} && "
            "sqlite3 /tmp/restored.db '.dump' | grep -q LitestreamTest"
        )

    with subtest("Simulate disaster recovery"):
        # https://litestream.io/guides/systemd/#simulating-a-disaster
        machine.systemctl("stop litestream.service grafana.service")
        machine.succeed(
            "rm -f ${dbPath} "
            "${dbPath}-shm "
            "${dbPath}-wal"
        )
        machine.succeed(
            "litestream restore ${dbPath} "
            "&& chown grafana:grafana ${dbPath} "
            "&& chmod 660 ${dbPath}"
        )
        machine.systemctl("restart grafana.service litestream.service")
        machine.wait_for_open_port(3000)
        machine.wait_for_unit("litestream.service")
        machine.succeed(
            "curl -sSfN -u admin:admin http://127.0.0.1:3000/api/user | grep LitestreamTest"
        )
  '';
}