nixos/tests/listmonk.nix

   1 import ./make-test-python.nix ({ lib, ... }: {
   2   name = "listmonk";
   3   meta.maintainers = with lib.maintainers; [ raitobezarius ];
   4
   5   nodes.machine = { pkgs, ... }: {
   6     services.mailhog.enable = true;
   7     services.listmonk = {
   8       enable = true;
   9       settings = {
  10         admin_username = "listmonk";
  11         admin_password = "hunter2";
  12       };
  13       database = {
  14         createLocally = true;
  15         # https://github.com/knadh/listmonk/blob/174a48f252a146d7e69dab42724e3329dbe25ebe/internal/messenger/email/email.go#L18-L27
  16         settings.smtp = [ {
  17           enabled = true;
  18           host = "localhost";
  19           port = 1025;
  20           tls_type = "none";
  21         }];
  22       };
  23     };
  24   };
  25
  26   testScript = ''
  27     import json
  28
  29     start_all()
  30
  31     basic_auth = "listmonk:hunter2"
  32     def generate_listmonk_request(type, url, data=None):
  33        if data is None: data = {}
  34        json_data = json.dumps(data)
  35        return f'curl -u "{basic_auth}" -X {type} "http://localhost:9000/api/{url}" -H "Content-Type: application/json; charset=utf-8" --data-raw \'{json_data}\'''
  36
  37     machine.wait_for_unit("mailhog.service")
  38     machine.wait_for_unit("postgresql.service")
  39     machine.wait_for_unit("listmonk.service")
  40     machine.wait_for_open_port(1025)
  41     machine.wait_for_open_port(8025)
  42     machine.wait_for_open_port(9000)
  43     machine.succeed("[[ -f /var/lib/listmonk/.db_settings_initialized ]]")
  44
  45     # Test transactional endpoint
  46     # subscriber_id=1 is guaranteed to exist at install-time
  47     # template_id=2 is guaranteed to exist at install-time and is a transactional template (1 is a campaign template).
  48     machine.succeed(
  49       generate_listmonk_request('POST', 'tx', data={'subscriber_id': 1, 'template_id': 2})
  50     )
  51     assert 'Welcome John Doe' in machine.succeed(
  52         "curl --fail http://localhost:8025/api/v2/messages"
  53     )
  54
  55     # Test campaign endpoint
  56     # Based on https://github.com/knadh/listmonk/blob/174a48f252a146d7e69dab42724e3329dbe25ebe/cmd/campaigns.go#L549 as docs do not exist.
  57     campaign_data = json.loads(machine.succeed(
  58       generate_listmonk_request('POST', 'campaigns/1/test', data={'template_id': 1, 'subscribers': ['john@example.com'], 'name': 'Test', 'subject': 'NixOS is great', 'lists': [1], 'messenger': 'email'})
  59     ))
  60
  61     assert campaign_data['data']  # This is a boolean asserting if the test was successful or not: https://github.com/knadh/listmonk/blob/174a48f252a146d7e69dab42724e3329dbe25ebe/cmd/campaigns.go#L626
  62
  63     messages = json.loads(machine.succeed(
  64         "curl --fail http://localhost:8025/api/v2/messages"
  65     ))
  66
  67     assert messages['total'] == 2
  68   '';
  69 })