nixpkgs/nixos/tests/searx.nix

import ./make-test-python.nix ({ pkgs, ...} :

{
  name = "searx";
  meta = with pkgs.lib.maintainers; {
    maintainers = [ rnhmjoj ];
  };

  # basic setup: searx running the built-in webserver
  nodes.base = { ... }: {
    imports = [ ../modules/profiles/minimal.nix ];

    services.searx = {
      enable = true;
      environmentFile = pkgs.writeText "secrets" ''
        WOLFRAM_API_KEY  = sometoken
        SEARX_SECRET_KEY = somesecret
      '';

      settings.server =
        { port = "8080";
          bind_address = "0.0.0.0";
          secret_key = "@SEARX_SECRET_KEY@";
        };
      settings.engines = [
        { name = "wolframalpha";
          api_key = "@WOLFRAM_API_KEY@";
          engine = "wolframalpha_api";
        }
        { name = "startpage";
          shortcut = "start";
        }
      ];
    };

  };

  # fancy setup: run in uWSGI and use nginx as proxy
  nodes.fancy = { ... }: {
    imports = [ ../modules/profiles/minimal.nix ];

    services.searx = {
      enable = true;
      # searx refuses to run if unchanged
      settings.server.secret_key = "somesecret";

      runInUwsgi = true;
      uwsgiConfig = {
        # serve using the uwsgi protocol
        socket = "/run/searx/uwsgi.sock";
        chmod-socket = "660";

        # use /searx as url "mountpoint"
        mount = "/searx=searx.webapp:application";
        module = "";
        manage-script-name = true;
      };
    };

    # use nginx as reverse proxy
    services.nginx.enable = true;
    services.nginx.virtualHosts.localhost = {
      locations."/searx".extraConfig =
        ''
          include ${pkgs.nginx}/conf/uwsgi_params;
          uwsgi_pass unix:/run/searx/uwsgi.sock;
        '';
      locations."/searx/static/".alias = "${pkgs.searx}/share/static/";
    };

    # allow nginx access to the searx socket
    users.users.nginx.extraGroups = [ "searx" ];

  };

  testScript =
    ''
      base.start()

      with subtest("Settings have been merged"):
          base.wait_for_unit("searx-init")
          base.wait_for_file("/run/searx/settings.yml")
          output = base.succeed(
              "${pkgs.yq-go}/bin/yq eval"
              " '.engines[] | select(.name==\"startpage\") | .shortcut'"
              " /run/searx/settings.yml"
          ).strip()
          assert output == "start", "Settings not merged"

      with subtest("Environment variables have been substituted"):
          base.succeed("grep -q somesecret /run/searx/settings.yml")
          base.succeed("grep -q sometoken /run/searx/settings.yml")
          base.copy_from_vm("/run/searx/settings.yml")

      with subtest("Basic setup is working"):
          base.wait_for_open_port(8080)
          base.wait_for_unit("searx")
          base.succeed(
              "${pkgs.curl}/bin/curl --fail http://localhost:8080"
          )
          base.shutdown()

      with subtest("Nginx+uWSGI setup is working"):
          fancy.start()
          fancy.wait_for_open_port(80)
          fancy.wait_for_unit("uwsgi")
          fancy.succeed(
              "${pkgs.curl}/bin/curl --fail http://localhost/searx >&2"
          )
          fancy.succeed(
              "${pkgs.curl}/bin/curl --fail http://localhost/searx/static/js/bootstrap.min.js >&2"
          )
    '';
})