nixos/tests/open-webui.nix

   1 { config, lib, ... }:
   2 let
   3   mainPort = "8080";
   4   webuiName = "NixOS Test";
   5 in
   6 {
   7   name = "open-webui";
   8   meta = with lib.maintainers; {
   9     maintainers = [ shivaraj-bh ];
  10   };
  11
  12   nodes = {
  13     machine =
  14       { ... }:
  15       {
  16         services.open-webui = {
  17           enable = true;
  18           environment = {
  19             # Requires network connection
  20             RAG_EMBEDDING_MODEL = "";
  21           };
  22
  23           # Test that environment variables can be
  24           # overridden through a file.
  25           environmentFile = config.node.pkgs.writeText "test.env" ''
  26             WEBUI_NAME="${webuiName}"
  27           '';
  28         };
  29       };
  30   };
  31
  32   testScript = ''
  33     import json
  34     import xml.etree.ElementTree as xml
  35
  36     machine.start()
  37
  38     machine.wait_for_unit("open-webui.service")
  39     machine.wait_for_open_port(${mainPort})
  40
  41     machine.succeed("curl http://127.0.0.1:${mainPort}")
  42
  43     # Load the Web UI config JSON and parse it.
  44     webui_config_json = machine.succeed("curl http://127.0.0.1:${mainPort}/api/config")
  45     webui_config = json.loads(webui_config_json)
  46
  47     # Check that the name was overridden via the environmentFile option.
  48     assert webui_config["name"] == "${webuiName} (Open WebUI)"
  49
  50     webui_opensearch_xml = machine.succeed("curl http://127.0.0.1:${mainPort}/opensearch.xml")
  51     webui_opensearch = xml.fromstring(webui_opensearch_xml)
  52
  53     webui_opensearch_url = webui_opensearch.find(
  54         ".//{http://a9.com/-/spec/opensearch/1.1/}Url"
  55     )
  56     assert (
  57         webui_opensearch_url is not None
  58     ), f"no url tag found in {webui_opensearch_xml}"
  59     assert (
  60         webui_opensearch_url.get("template") == "http://localhost:8080/?q={searchTerms}"
  61     ), "opensearch url doesn't match the configured port"
  62   '';
  63 }