aboutsummaryrefslogtreecommitdiffstats
path: root/tests/by-name/at/atuin-sync/test.nix
blob: cf8f0d82bf5430145f955880ccc568fb977f7e04 (plain) (blame)
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
{
  pkgs,
  extraModules,
  turtle,
  vhack,
  ...
}:
vhack.runTest {
  name = "atuin-sync";
  serverDomains = [
    {
      server = "atuin-sync.server";
    }
  ];

  nodes = let
    atuinSession = "01969ec6b8d07e30a9d2df0911fbfe2a";
    atuin = turtle.packages."${pkgs.stdenv.hostPlatform.system}".default;
  in {
    server = {config, ...}: {
      imports =
        extraModules
        ++ [
          ../../../../modules
        ];

      vhack = {
        persist.enable = true;
        nginx.enable = true;
        atuin-sync = {
          enable = true;
          fqdn = "atuin-sync.server";
        };
      };
    };

    client1 = {config, ...}: {
      environment.sessionVariables.ATUIN_SESSION = atuinSession;

      environment.systemPackages = [
        atuin
        pkgs.sqlite-interactive
      ];
    };
    client2 = {config, ...}: {
      environment.sessionVariables.ATUIN_SESSION = atuinSession;

      environment.systemPackages = [
        atuin
        pkgs.sqlite-interactive
      ];
    };
  };

  services = [
    {server = "turtle.service";}
  ];

  testScript = {nodes, ...}: let
    mkSyncConfig = pkgs.writeShellScript "register-atuin-sync-account" ''
      mkdir --parents ~/.config/turtle/

      cat << EOF > ~/.config/turtle/config.toml

      [sync]
      address = "https://atuin-sync.server"
      user_id_path = "${pkgs.writeText "user-id" "019eb88a-6b51-7e52-b12c-7d30bd8e5928"}"
      encryption_key_path = "${pkgs.writeText "encryption-key" "3AAgbWsDzL7M00/Mq0LMjsyOCy3MnsypBsyQzKbMywNGzNnMrUBozIINAxdbIiDMhQ=="}"
      EOF
    '';

    runCommandAndRecordInTurtle = pkgs.writeShellScript "run-command-and-record-in-atuin" ''
      # SPDX-SnippetBegin
      # SPDX-SnippetCopyrightText: 2023 mentalisttraceur (https://github.com/mentalisttraceur)
      # Source: https://github.com/atuinsh/atuin/issues/1188#issuecomment-1698354107
      run_and_record_in_atuin()
      {
          local id
          local status
          local escaped_command="$(printf '%q ' "$@")"
          id="$(turtle history start -- "$escaped_command")"
          "$@"
          status=$?
          turtle history end --exit $status "$id"
          return $status
      }
      # SPDX-SnippetEnd

      run_and_record_in_atuin "$@"
    '';
  in
    # Python
    ''
      server.wait_for_open_port(443)

      # Wait for the server to acquire the acme certificate
      client1.wait_until_succeeds("curl https://atuin-sync.server")

      with subtest("Setup client syncing"):
          for client in [client1, client2]:
            client.succeed("${mkSyncConfig}")

      with subtest("Start turtle daemon"):
          for client in [client1, client2]:
            client.succeed("systemd-run turtle-daemon start")

          for client in [client1, client2]:
            client.wait_until_succeeds("turtle daemon status")

      with subtest("Can generate shell history"):
          client1.succeed("${runCommandAndRecordInTurtle} echo hi - client 1")
          client2.succeed("${runCommandAndRecordInTurtle} echo hi - client 2")

      with subtest("Can sync"):
          for client in [client1, client2]:
            client.succeed("turtle sync perform")
          client1.succeed("turtle sync perform")

      with subtest("Have correct tasks"):
          hist1 = client1.succeed("turtle history list --cmd-only").strip().split('\n')
          hist2 = client2.succeed("turtle history list --cmd-only").strip().split('\n')

          hist1.sort()
          hist2.sort()

          canonicalHistory = [
            "echo hi - client 1",
            "echo hi - client 2"
          ]

          assert hist1 == hist2, f"The clients don't have the same amount of history items, client1: '{hist1}', client2: '{hist2}'"
          assert hist1 == canonicalHistory, f"The history is not correct: '{hist1}' vs. '{canonicalHistory}'"

      with subtest("Can sync again"):
          client1.succeed("${runCommandAndRecordInTurtle} echo second try - client 1")
          client2.succeed("${runCommandAndRecordInTurtle} echo second try - client 2")

          for client in [client1, client2]:
            client.succeed("turtle sync perform")
          client1.succeed("turtle sync perform")

          hist1 = client1.succeed("turtle history list --cmd-only").strip().split('\n')
          hist2 = client2.succeed("turtle history list --cmd-only").strip().split('\n')

          hist1.sort()
          hist2.sort()

          canonicalHistory = [
            # The old history
            "echo hi - client 1",
            "echo hi - client 2",

            # Our newly added history entries
            "echo second try - client 1",
            "echo second try - client 2"
          ]

          assert hist1 == hist2, f"The clients don't have the same amount of history items, client1: '{hist1}', client2: '{hist2}'"
          assert hist1 == canonicalHistory, f"The history is not correct, got: '{hist1}', expected: '{canonicalHistory}'"
    '';
}