Files
linux-cloud-router/tests/remote/README.md
T

3.9 KiB

Remote tests

run.py installs the newest out/linux-manager_*_all.deb into instances of an LXD remote and checks the router and VPN components in three scenarios:

  • core: one interface, router and VPN off;
  • nat: VPN on, router off, one interface; WireGuard and OpenVPN clients reach a target through NAT, then the VPN is switched off;
  • s2s: router and VPN on, two sites with two interfaces each, a site-to-site connection with a pre-shared key, and a routed WireGuard client; the router is then switched off while site_to_site is set, which setup refuses.

Servers are virtual machines, clients and LAN hosts containers, all from ubuntu:26.04. Each scenario is a module in scenarios/ whose run(lab) uses the Lab class of run.py. wireguard_peer.py and echo.py are copied into the instances: the first gives the test user a WireGuard peer on the server, the second answers HTTP with the client's address.

export LXD_REMOTE=...
export LXD_POOL=...
./build.sh
tests/remote/run.py core nat s2s
tests/remote/run.py all

Options:

Option Variable Default Meaning
--remote LXD_REMOTE required The lxc remote
--pool LXD_POOL required The storage pool of the project's root disks
--project LXD_PROJECT lm-test The project the instances live in; it must not exist
--image LXD_IMAGE ubuntu:26.04 The image of every instance
--keep off Leaves the project and the networks in place; run one scenario then

Each scenario creates the project and its networks (lmt-<scenario>-<net>) and removes them at its end. The administrator password and the pre-shared key are generated per run and written to tmp/remote-test.env. The run prints PASS, FAIL or SKIP per check and exits non-zero on a failure; WireGuard is skipped when the host kernel has no WireGuard module.

The configurations in configs/ have placeholders that are filled in for each server:

  • @PSK@: the pre-shared key;
  • @ETH0@ and @ETH1@: the names of its interfaces;
  • @CIDR0@: the network of its first address.

A VM to work with

vm.py launches one server VM, lm-dev by default, on the LXD remote and leaves it running. The VM is created in a project, default by default, with that project's default profile, and takes its address from DHCP. It gets the newest package with the administrator admin and a generated password, written to tmp/vm-<name>.env, and a configuration from configs/, core.json by default; @ETH0@ is the interface of the VM's default route.

The leased address is pinned on the VM's NIC, as NAT proxy devices require a static address. Proxy devices then forward ports of the LXD host address --listen to the VM; by default that is the IPv4 address of the host in the remote's URL (lxc remote list), which must be an address of the LXD host itself:

  • 7080 to the Manager;
  • 7081 to the status web service;
  • 2222 to SSH, port 22.

The script prints the VM's address, the administrator's password, the proxied URLs, the command of a shell in it and the command that removes it.

tests/remote/vm.py
tests/remote/vm.py --remove

--remove deletes the VM and its env file. Options:

Option Variable Default Meaning
--remote LXD_REMOTE required The lxc remote
--project default The project of the VM
--name lm-dev The name of the VM; it must not exist
--image LXD_IMAGE ubuntu:26.04 The image of the VM
--config core.json The configuration from configs/
--listen LXD_LISTEN the remote URL's host An address of the LXD host the proxies listen on

Scope of the tests

Not covered by run.py: IKEv2 client access, HTTPS with Let's Encrypt, the OpenID Provider and passkeys, PowerDNS answering from outside, and the Azure and GCP platform modules.