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 whilesite_to_siteis 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:
7080to the Manager;7081to the status web service;2222to SSH, port22.
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 |
In a test project made by lxd-project.py, vm.py installs the package from the project's
repository instead of out/, so later dev builds reach the VM as updates. LXD refuses NAT proxy
devices in a project with networks of its own, so there the ports lead through a network forward
on the project's wan, whose listen address LXD allocates from the uplink's --routes;
--listen does not apply, and --remove deletes the forward with the VM.
A test project with dev builds
lxd-project.py create makes a project for manual tests that stays until
lxd-project.py remove; run.py keeps making and removing its own projects. The project has:
- networks of its own (
features.networks), OVN networks on the physical uplink--uplink:wan, with NAT and DHCP on a subnet LXD picks, andlanaandlanb, on subnets LXD picks without DHCP; OVN gives each network's router an address, which LAN hosts don't use as their gateway; - a default profile with a root disk on the pool and
eth0onwan; - the container
repo, whose nginx serves a signed apt repository of the dev builds,resolute mainfor amd64 and arm64, at its pinned address.
What the other scripts need, the repository's URL among it, is written to
tmp/lxd-project-<project>.json, and the repository's key to tmp/lxd-project-<project>.gpg.
remove deletes the project's instances, its networks, the project and those files.
The remote needs OVN, set up as LXD's standalone OVN guide describes, and a host bridge on the
LAN, whose host address stays on the bridge. uplink setup creates on it, once per remote, the
physical network --uplink that the OVN networks use as uplink:
--gateway: the LAN's gateway, as address/prefix;--dns: the LAN's name servers, comma-separated;--ovn-ranges: free LAN addresses outside the LAN's DHCP pool, asFIRST-LAST, one for the router of each OVN network;--routes: a free LAN subnet, in CIDR, whose addresses network forwards listen on.
OVN answers ARP for its routers' and forwards' addresses on the LAN (ovn.ingress_mode
l2proxy, LXD's default), so the LAN needs no route. uplink setup leaves an existing network
of that name as it is; uplink remove deletes it.
tests/remote/lxd-project.py uplink setup
tests/remote/lxd-project.py uplink remove
tests/remote/lxd-project.py create
tests/remote/lxd-project.py remove
| Option | Variable | Default | Meaning |
|---|---|---|---|
--remote |
LXD_REMOTE |
required | The lxc remote |
--pool |
LXD_POOL |
required by create |
The storage pool of the project's root disks |
--project |
LXD_PROJECT |
lm-dev |
The project |
--image |
LXD_IMAGE |
ubuntu:26.04 |
The image of the repository container |
--uplink |
LXD_UPLINK |
uplink |
The physical uplink network of the OVN networks |
--parent |
LXD_UPLINK_PARENT |
required by uplink setup |
The host bridge on the LAN |
--gateway |
LXD_UPLINK_GATEWAY |
required by uplink setup |
The LAN's gateway, address/prefix |
--dns |
LXD_UPLINK_DNS |
required by uplink setup |
The LAN's name servers |
--ovn-ranges |
LXD_UPLINK_OVN_RANGES |
required by uplink setup |
LAN addresses for OVN routers |
--routes |
LXD_UPLINK_ROUTES |
required by uplink setup |
A LAN subnet for network forwards |
dev-build.py builds and publishes the next dev build. Its version is the newest changelog
entry's with ~dev<N> before the Debian revision, 0.41.0~dev7-1 for 0.41.0-1, so the release
of that entry is newer than its dev builds. N is kept in tmp/test-number and goes up with each
build that succeeds. ./build.sh builds it, with CONTAINER_RUNTIME and DOCKER_CONTEXT from the
environment; the build is moved to out/dev/, copied into the repository and published there. A
VM of the project then gets it with Check update and Upgrade in the Manager, or apt-get update
and apt-get upgrade.
tests/remote/dev-build.py
--project (LXD_PROJECT, lm-dev by default) names the project.
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.