commit 06c01cba2aabec83954d6bf0a5cf2e4c7dc1b976 · pyrox.dev/nixpkgs

+219 -123

nixos/tests/akkoma.nix

···

       1
       1
       -
       /*

     

       2
       2
       -
         End-to-end test for Akkoma.

     

       3
       3
       -
       

     

       4
       4
       -
         Based in part on nixos/tests/pleroma.

     

       1
       1
       +
       # end‐to‐end test for Akkoma

     

       2
       2
       +
       {

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         confined ? false,

     

       6
       6
       +
         ...

     

       7
       7
       +
       }:

     

       8
       8
       +
       let

     

       9
       9
       +
         inherit ((pkgs.formats.elixirConf { }).lib) mkRaw;

     

       5
       10
        
       

     

       6
       6
       -
         TODO: Test federation.

     

       7
       7
       -
       */

     

       8
       8
       -
       import ./make-test-python.nix (

     

       9
       9
       -
         {

     

       10
       10
       -
           pkgs,

     

       11
       11
       -
           package ? pkgs.akkoma,

     

       12
       12
       -
           confined ? false,

     

       13
       13
       -
           ...

     

       14
       14
       -
         }:

     

       15
       15
       -
         let

     

       16
       16
       -
           userPassword = "4LKOrGo8SgbPm1a6NclVU5Wb";

     

       17
       17
       -
       

     

       18
       18
       -
           provisionUser = pkgs.writers.writeBashBin "provisionUser" ''

     

       19
       19
       -
             set -eu -o errtrace -o pipefail

     

       20
       20
       -
       

     

       21
       21
       -
             pleroma_ctl user new jamy jamy@nixos.test --password '${userPassword}' --moderator --admin -y

     

       22
       22
       -
           '';

     

       23
       23
       -
       

     

       24
       24
       -
           tlsCert =

     

       25
       25
       -
             pkgs.runCommand "selfSignedCerts"

     

       26
       26
       -
               {

     

       27
       27
       -
                 nativeBuildInputs = with pkgs; [ openssl ];

     

       28
       28
       -
               }

     

       29
       29
       -
               ''

     

       30
       30
       -
                 mkdir -p $out

     

       31
       31
       -
                 openssl req -x509 \

     

       32
       32
       -
                   -subj '/CN=akkoma.nixos.test/' -days 49710 \

     

       33
       33
       -
                   -addext 'subjectAltName = DNS:akkoma.nixos.test' \

     

       34
       34
       -
                   -keyout "$out/key.pem" -newkey ed25519 \

     

       35
       35
       -
                   -out "$out/cert.pem" -noenc

     

       36
       36
       -
               '';

     

       11
       11
       +
         package = pkgs.akkoma;

     

       37
       12
        
       

     

       38
       38
       -
           sendToot = pkgs.writers.writeBashBin "sendToot" ''

     

       39
       39
       -
             set -eu -o errtrace -o pipefail

     

       13
       13
       +
         tlsCert =

     

       14
       14
       +
           names:

     

       15
       15
       +
           pkgs.runCommand "certificates-${lib.head names}"

     

       16
       16
       +
             {

     

       17
       17
       +
               nativeBuildInputs = with pkgs; [ openssl ];

     

       18
       18
       +
             }

     

       19
       19
       +
             ''

     

       20
       20
       +
               mkdir -p $out

     

       21
       21
       +
               openssl req -x509 \

     

       22
       22
       +
                 -subj '/CN=${lib.head names}/' -days 49710 \

     

       23
       23
       +
                 -addext 'subjectAltName = ${lib.concatStringsSep ", " (map (name: "DNS:${name}") names)}' \

     

       24
       24
       +
                 -keyout "$out/key.pem" -newkey ed25519 \

     

       25
       25
       +
                 -out "$out/cert.pem" -noenc

     

       26
       26
       +
             '';

     

       40
       27
        
       

     

       41
       41
       -
             export REQUESTS_CA_BUNDLE="/etc/ssl/certs/ca-certificates.crt"

     

       28
       28
       +
         tlsCertA = tlsCert [

     

       29
       29
       +
           "akkoma-a.nixos.test"

     

       30
       30
       +
           "media.akkoma-a.nixos.test"

     

       31
       31
       +
         ];

     

       42
       32
        
       

     

       43
       43
       -
             ${pkgs.toot}/bin/toot login_cli -i "akkoma.nixos.test" -e "jamy@nixos.test" -p '${userPassword}'

     

       44
       44
       -
             ${pkgs.toot}/bin/toot post "hello world Jamy here"

     

       45
       45
       -
             ${pkgs.toot}/bin/toot timeline -1 | grep -F -q "hello world Jamy here"

     

       33
       33
       +
         tlsCertB = tlsCert [

     

       34
       34
       +
           "akkoma-b.nixos.test"

     

       35
       35
       +
           "media.akkoma-b.nixos.test"

     

       36
       36
       +
         ];

     

       46
       37
        
       

     

       47
       47
       -
             # Test file upload

     

       48
       48
       -
             echo "y" | ${pkgs.toot}/bin/toot upload <(dd if=/dev/zero bs=1024 count=1024 status=none) \

     

       49
       49
       -
               | grep -F -q "https://akkoma.nixos.test:443/media"

     

       50
       50
       -
           '';

     

       38
       38
       +
         testMedia = pkgs.runCommand "blank.png" { nativeBuildInputs = with pkgs; [ imagemagick ]; } ''

     

       39
       39
       +
           magick -size 640x480 canvas:transparent "PNG8:$out"

     

       40
       40
       +
         '';

     

       51
       41
        
       

     

       52
       52
       -
           checkFe = pkgs.writers.writeBashBin "checkFe" ''

     

       53
       53
       -
             set -eu -o errtrace -o pipefail

     

       54
       54
       -
       

     

       42
       42
       +
         checkFe = pkgs.writeShellApplication {

     

       43
       43
       +
           name = "checkFe";

     

       44
       44
       +
           runtimeInputs = with pkgs; [ curl ];

     

       45
       45
       +
           text = ''

     

       55
       46
        
             paths=( / /static/{config,styles}.json /pleroma/admin/ )

     

       56
       47
        
       

     

       57
       48
        
             for path in "''${paths[@]}"; do

     

       58
       49
        
               diff \

     

       59
       59
       -
                 <(${pkgs.curl}/bin/curl -f -S -s -o /dev/null -w '%{response_code}' "https://akkoma.nixos.test$path") \

     

       50
       50
       +
                 <(curl -f -S -s -o /dev/null -w '%{response_code}' "https://$1$path") \

     

       60
       51
        
                 <(echo -n 200)

     

       61
       52
        
             done

     

       62
       53
        
           '';

     

       54
       54
       +
         };

     

       63
       55
        
       

     

       64
       64
       -
           hosts = nodes: ''

     

       65
       65
       -
             ${nodes.akkoma.networking.primaryIPAddress} akkoma.nixos.test

     

       66
       66
       -
             ${nodes.client.networking.primaryIPAddress} client.nixos.test

     

       67
       67
       -
           '';

     

       68
       68
       -
         in

     

       69
       69
       -
         {

     

       70
       70
       -
           name = "akkoma";

     

       71
       71
       -
           nodes = {

     

       72
       72
       -
             client =

     

       73
       73
       -
               {

     

       74
       74
       -
                 nodes,

     

       75
       75
       -
                 pkgs,

     

       76
       76
       -
                 config,

     

       77
       77
       -
                 ...

     

       78
       78
       -
               }:

     

       79
       79
       -
               {

     

       80
       80
       -
                 security.pki.certificateFiles = [ "${tlsCert}/cert.pem" ];

     

       81
       81
       -
                 networking.extraHosts = hosts nodes;

     

       56
       56
       +
         commonConfig =

     

       57
       57
       +
           { nodes, ... }:

     

       58
       58
       +
           {

     

       59
       59
       +
             security.pki.certificateFiles = [

     

       60
       60
       +
               "${tlsCertA}/cert.pem"

     

       61
       61
       +
               "${tlsCertB}/cert.pem"

     

       62
       62
       +
             ];

     

       63
       63
       +
       

     

       64
       64
       +
             networking.extraHosts = ''

     

       65
       65
       +
               ${nodes.akkoma-a.networking.primaryIPAddress} akkoma-a.nixos.test media.akkoma-a.nixos.test

     

       66
       66
       +
               ${nodes.akkoma-b.networking.primaryIPAddress} akkoma-b.nixos.test media.akkoma-b.nixos.test

     

       67
       67
       +
               ${nodes.client-a.networking.primaryIPAddress} client-a.nixos.test

     

       68
       68
       +
               ${nodes.client-b.networking.primaryIPAddress} client-b.nixos.test

     

       69
       69
       +
             '';

     

       70
       70
       +
           };

     

       71
       71
       +
       

     

       72
       72
       +
         clientConfig =

     

       73
       73
       +
           { pkgs, ... }:

     

       74
       74
       +
           {

     

       75
       75
       +
             environment = {

     

       76
       76
       +
               sessionVariables = {

     

       77
       77
       +
                 REQUESTS_CA_BUNDLE = "/etc/ssl/certs/ca-certificates.crt";

     

       82
       78
        
               };

     

       79
       79
       +
               systemPackages = with pkgs; [ toot ];

     

       80
       80
       +
             };

     

       81
       81
       +
           };

     

       83
       82
        
       

     

       84
       84
       -
             akkoma =

     

       85
       85
       -
               {

     

       86
       86
       -
                 nodes,

     

       87
       87
       -
                 pkgs,

     

       88
       88
       -
                 config,

     

       89
       89
       -
                 ...

     

       90
       90
       -
               }:

     

       91
       91
       -
               {

     

       92
       92
       -
                 networking.extraHosts = hosts nodes;

     

       93
       93
       -
                 networking.firewall.allowedTCPPorts = [ 443 ];

     

       94
       94
       -
                 environment.systemPackages = with pkgs; [ provisionUser ];

     

       95
       95
       -
                 systemd.services.akkoma.confinement.enable = confined;

     

       83
       83
       +
         serverConfig =

     

       84
       84
       +
           { config, pkgs, ... }:

     

       85
       85
       +
           {

     

       86
       86
       +
             networking = {

     

       87
       87
       +
               domain = "nixos.test";

     

       88
       88
       +
               firewall.allowedTCPPorts = [ 443 ];

     

       89
       89
       +
             };

     

       96
       90
        
       

     

       97
       97
       -
                 services.akkoma = {

     

       98
       98
       -
                   enable = true;

     

       99
       99
       -
                   package = package;

     

       100
       100
       -
                   config = {

     

       101
       101
       -
                     ":pleroma" = {

     

       102
       102
       -
                       ":instance" = {

     

       103
       103
       -
                         name = "NixOS test Akkoma server";

     

       104
       104
       -
                         description = "NixOS test Akkoma server";

     

       105
       105
       -
                         email = "akkoma@nixos.test";

     

       106
       106
       -
                         notify_email = "akkoma@nixos.test";

     

       107
       107
       -
                         registration_open = true;

     

       108
       108
       -
                       };

     

       91
       91
       +
             systemd.services.akkoma.confinement.enable = confined;

     

       109
       92
        
       

     

       110
       110
       -
                       ":media_proxy" = {

     

       111
       111
       -
                         enabled = false;

     

       112
       112
       -
                       };

     

       93
       93
       +
             services.akkoma = {

     

       94
       94
       +
               enable = true;

     

       95
       95
       +
               inherit package;

     

       96
       96
       +
               config = {

     

       97
       97
       +
                 ":pleroma" = {

     

       98
       98
       +
                   ":instance" = {

     

       99
       99
       +
                     name = "NixOS test Akkoma server";

     

       100
       100
       +
                     description = "NixOS test Akkoma server";

     

       101
       101
       +
                     email = "akkoma@nixos.test";

     

       102
       102
       +
                     notify_email = "akkoma@nixos.test";

     

       103
       103
       +
                     registration_open = true;

     

       104
       104
       +
                   };

     

       113
       105
        
       

     

       114
       114
       -
                       "Pleroma.Web.Endpoint" = {

     

       115
       115
       -
                         url.host = "akkoma.nixos.test";

     

       116
       116
       -
                       };

     

       117
       117
       -
                       "Pleroma.Upload" = {

     

       118
       118
       -
                         base_url = "https://akkoma.nixos.test:443/media/";

     

       119
       119
       -
                       };

     

       120
       120
       -
                     };

     

       106
       106
       +
                   ":media_proxy" = {

     

       107
       107
       +
                     enabled = false;

     

       108
       108
       +
                   };

     

       109
       109
       +
       

     

       110
       110
       +
                   "Pleroma.Web.Endpoint" = {

     

       111
       111
       +
                     url.host = config.networking.fqdn;

     

       121
       112
        
                   };

     

       122
       113
        
       

     

       123
       123
       -
                   nginx = {

     

       124
       124
       -
                     addSSL = true;

     

       125
       125
       -
                     sslCertificate = "${tlsCert}/cert.pem";

     

       126
       126
       -
                     sslCertificateKey = "${tlsCert}/key.pem";

     

       114
       114
       +
                   "Pleroma.Upload" = {

     

       115
       115
       +
                     base_url = "https://media.${config.networking.fqdn}/media/";

     

       127
       116
        
                   };

     

       117
       117
       +
       

     

       118
       118
       +
                   # disable certificate verification until we figure out how to

     

       119
       119
       +
                   # supply our own certificates

     

       120
       120
       +
                   ":http".adapter.pools = mkRaw "%{default: [conn_opts: [transport_opts: [verify: :verify_none]]]}";

     

       128
       121
        
                 };

     

       122
       122
       +
               };

     

       129
       123
        
       

     

       130
       130
       -
                 services.nginx.enable = true;

     

       131
       131
       -
                 services.postgresql.enable = true;

     

       124
       124
       +
               nginx.addSSL = true;

     

       125
       125
       +
             };

     

       126
       126
       +
       

     

       127
       127
       +
             services.nginx.enable = true;

     

       128
       128
       +
             services.postgresql.enable = true;

     

       129
       129
       +
           };

     

       130
       130
       +
       in

     

       131
       131
       +
       {

     

       132
       132
       +
         name = "akkoma";

     

       133
       133
       +
         nodes = {

     

       134
       134
       +
           client-a =

     

       135
       135
       +
             { ... }:

     

       136
       136
       +
             {

     

       137
       137
       +
               imports = [

     

       138
       138
       +
                 clientConfig

     

       139
       139
       +
                 commonConfig

     

       140
       140
       +
               ];

     

       141
       141
       +
             };

     

       142
       142
       +
       

     

       143
       143
       +
           client-b =

     

       144
       144
       +
             { ... }:

     

       145
       145
       +
             {

     

       146
       146
       +
               imports = [

     

       147
       147
       +
                 clientConfig

     

       148
       148
       +
                 commonConfig

     

       149
       149
       +
               ];

     

       150
       150
       +
             };

     

       151
       151
       +
       

     

       152
       152
       +
           akkoma-a =

     

       153
       153
       +
             { ... }:

     

       154
       154
       +
             {

     

       155
       155
       +
               imports = [

     

       156
       156
       +
                 commonConfig

     

       157
       157
       +
                 serverConfig

     

       158
       158
       +
               ];

     

       159
       159
       +
       

     

       160
       160
       +
               services.akkoma.nginx = {

     

       161
       161
       +
                 sslCertificate = "${tlsCertA}/cert.pem";

     

       162
       162
       +
                 sslCertificateKey = "${tlsCertA}/key.pem";

     

       163
       163
       +
               };

     

       164
       164
       +
             };

     

       165
       165
       +
       

     

       166
       166
       +
           akkoma-b =

     

       167
       167
       +
             { ... }:

     

       168
       168
       +
             {

     

       169
       169
       +
               imports = [

     

       170
       170
       +
                 commonConfig

     

       171
       171
       +
                 serverConfig

     

       172
       172
       +
               ];

     

       173
       173
       +
       

     

       174
       174
       +
               services.akkoma.nginx = {

     

       175
       175
       +
                 sslCertificate = "${tlsCertB}/cert.pem";

     

       176
       176
       +
                 sslCertificateKey = "${tlsCertB}/key.pem";

     

       132
       177
        
               };

     

       133
       133
       -
           };

     

       178
       178
       +
             };

     

       179
       179
       +
         };

     

       180
       180
       +
       

     

       181
       181
       +
         testScript = ''

     

       182
       182
       +
           import json

     

       183
       183
       +
           import random

     

       184
       184
       +
           import string

     

       185
       185
       +
           from shlex import quote

     

       186
       186
       +
       

     

       187
       187
       +
           def randomString(len):

     

       188
       188
       +
             return "".join(random.choice(string.ascii_letters + string.digits) for _ in range(len))

     

       189
       189
       +
       

     

       190
       190
       +
           def registerUser(user, password):

     

       191
       191
       +
             return 'pleroma_ctl user new {0} {0}@nixos.test --password {1} -y'.format(

     

       192
       192
       +
               quote(user), quote(password))

     

       193
       193
       +
       

     

       194
       194
       +
           def loginUser(instance, user, password):

     

       195
       195
       +
             return 'toot login_cli -i {}.nixos.test -e {}@nixos.test -p {}'.format(

     

       196
       196
       +
               quote(instance), quote(user), quote(password))

     

       197
       197
       +
       

     

       198
       198
       +
           userAName = randomString(11)

     

       199
       199
       +
           userBName = randomString(11)

     

       200
       200
       +
           userAPassword = randomString(22)

     

       201
       201
       +
           userBPassword = randomString(22)

     

       202
       202
       +
       

     

       203
       203
       +
           testMessage = randomString(22)

     

       204
       204
       +
           testMedia = '${testMedia}'

     

       205
       205
       +
       

     

       206
       206
       +
           start_all()

     

       207
       207
       +
           akkoma_a.wait_for_unit('akkoma-initdb.service')

     

       208
       208
       +
           akkoma_b.wait_for_unit('akkoma-initdb.service')

     

       209
       209
       +
       

     

       210
       210
       +
           # test repeated initialisation

     

       211
       211
       +
           akkoma_a.systemctl('restart akkoma-initdb.service')

     

       212
       212
       +
       

     

       213
       213
       +
           akkoma_a.wait_for_unit('akkoma.service')

     

       214
       214
       +
           akkoma_b.wait_for_unit('akkoma.service')

     

       215
       215
       +
           akkoma_a.wait_for_file('/run/akkoma/socket');

     

       216
       216
       +
           akkoma_b.wait_for_file('/run/akkoma/socket');

     

       217
       217
       +
       

     

       218
       218
       +
           akkoma_a.succeed(registerUser(userAName, userAPassword))

     

       219
       219
       +
           akkoma_b.succeed(registerUser(userBName, userBPassword))

     

       134
       220
        
       

     

       135
       135
       -
           testScript =

     

       136
       136
       -
             { nodes, ... }:

     

       137
       137
       -
             ''

     

       138
       138
       -
               start_all()

     

       139
       139
       -
               akkoma.wait_for_unit('akkoma-initdb.service')

     

       140
       140
       -
               akkoma.systemctl('restart akkoma-initdb.service')  # test repeated initialisation

     

       141
       141
       -
               akkoma.wait_for_unit('akkoma.service')

     

       142
       142
       -
               akkoma.wait_for_file('/run/akkoma/socket');

     

       143
       143
       -
               akkoma.succeed('${provisionUser}/bin/provisionUser')

     

       144
       144
       -
               akkoma.wait_for_unit('nginx.service')

     

       145
       145
       -
               client.succeed('${sendToot}/bin/sendToot')

     

       146
       146
       -
               client.succeed('${checkFe}/bin/checkFe')

     

       147
       147
       -
             '';

     

       148
       148
       -
         }

     

       149
       149
       -
       )

     

       221
       221
       +
           akkoma_a.wait_for_unit('nginx.service')

     

       222
       222
       +
           akkoma_b.wait_for_unit('nginx.service')

     

       223
       223
       +
       

     

       224
       224
       +
           client_a.succeed(loginUser('akkoma-a', userAName, userAPassword))

     

       225
       225
       +
           client_b.succeed(loginUser('akkoma-b', userBName, userBPassword))

     

       226
       226
       +
       

     

       227
       227
       +
           client_b.succeed('toot follow {}@akkoma-a.nixos.test'.format(userAName))

     

       228
       228
       +
           client_a.wait_until_succeeds('toot followers | grep -F -q {}'.format(quote(userBName)))

     

       229
       229
       +
       

     

       230
       230
       +
           client_a.succeed('toot post {} --media {} --description "nothing to see here"'.format(

     

       231
       231
       +
             quote(testMessage), quote(testMedia)))

     

       232
       232
       +
       

     

       233
       233
       +
           # verify test message

     

       234
       234
       +
           status = json.loads(client_b.wait_until_succeeds(

     

       235
       235
       +
             'toot status --json "$(toot timeline -1 | grep -E -o \'^ID [^ ]+\' | cut -d \' \' -f 2)"'))

     

       236
       236
       +
           assert status['content'] == testMessage

     

       237
       237
       +
       

     

       238
       238
       +
           # compare attachment to original

     

       239
       239
       +
           client_b.succeed('cmp {} <(curl -f -S -s {})'.format(quote(testMedia),

     

       240
       240
       +
             quote(status['media_attachments'][0]['url'])))

     

       241
       241
       +
       

     

       242
       242
       +
           client_a.succeed('${lib.getExe checkFe} akkoma-a.nixos.test')

     

       243
       243
       +
           client_b.succeed('${lib.getExe checkFe} akkoma-b.nixos.test')

     

       244
       244
       +
         '';

     

       245
       245
       +
       }

+8 -2

nixos/tests/all-tests.nix

···

       156
       156
        
         age-plugin-tpm-decrypt = runTest ./age-plugin-tpm-decrypt.nix;

     

       157
       157
        
         agorakit = runTest ./web-apps/agorakit.nix;

     

       158
       158
        
         airsonic = runTest ./airsonic.nix;

     

       159
       159
       -
         akkoma = handleTestOn [ "x86_64-linux" "aarch64-linux" ] ./akkoma.nix {};

     

       160
       160
       -
         akkoma-confined = handleTestOn [ "x86_64-linux" "aarch64-linux" ] ./akkoma.nix { confined = true; };

     

       159
       159
       +
         akkoma = runTestOn [ "x86_64-linux" "aarch64-linux" ] {

     

       160
       160
       +
           imports = [ ./akkoma.nix ];

     

       161
       161
       +
           _module.args.confined = false;

     

       162
       162
       +
         };

     

       163
       163
       +
         akkoma-confined = runTestOn [ "x86_64-linux" "aarch64-linux" ] {

     

       164
       164
       +
           imports = [ ./akkoma.nix ];

     

       165
       165
       +
           _module.args.confined = true;

     

       166
       166
       +
         };

     

       161
       167
        
         alice-lg = runTest ./alice-lg.nix;

     

       162
       168
        
         alloy = runTest ./alloy.nix;

     

       163
       169
        
         allTerminfo = runTest ./all-terminfo.nix;