1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
---
lastproofread: '2025-12-02'
---
(testing)=
# Testing
One of the major features introduced in VyOS 1.3 is an automated test
framework. When you assemble an ISO image, several things can go wrong.
VyOS uses this framework to detect issues before they cause downstream problems.
This section describes how the automated testing process at VyOS works.
## Smoketests
Smoketests execute predefined VyOS CLI commands and check if the desired
daemon or service configuration is rendered.
When an ISO image is assembled by the [VyOS CI](https://ci.vyos.net), the `BUILD_SMOKETEST`
parameter is enabled by default. This extends the ISO configuration line
with the following packages:
```python
def CUSTOM_PACKAGES = ''
if (params.BUILD_SMOKETESTS)
CUSTOM_PACKAGES = '--custom-package vyos-1x-smoketest'
```
If you plan to build your own custom ISO image and want to use VyOS's
smoketests, ensure that you have the `vyos-1x-smoketest` package installed.
The `make test` command from the [vyos-build](https://github.com/vyos/vyos-build) repository launches a new
QEMU instance, and the ISO image is first installed to the virtual hard disk.
After the first boot into the newly installed system, the main Smoketest script
is executed. It can be found at `/usr/bin/vyos-smoketest`.
The script searches for executable test cases under
`/usr/libexec/vyos/tests/smoke/cli/` and executes them one by one.
:::{note}
Smoketests will alter the system configuration. If you are logged
in remotely, you may lose your connection to the system.
:::
:::{note}
To enable smoketest debugging (print the CLI set commands used),
run: `touch /tmp/vyos.smoketest.debug`.
:::
### Manual Smoketest Run
Each test is contained in its own file, so you can execute a single Smoketest
manually by running the Python test script.
Example:
```none
vyos@vyos:~$ /usr/libexec/vyos/tests/smoke/cli/test_protocols_bgp.py
test_bgp_01_simple (__main__.TestProtocolsBGP) ... ok
test_bgp_02_neighbors (__main__.TestProtocolsBGP) ... ok
test_bgp_03_peer_groups (__main__.TestProtocolsBGP) ... ok
test_bgp_04_afi_ipv4 (__main__.TestProtocolsBGP) ... ok
test_bgp_05_afi_ipv6 (__main__.TestProtocolsBGP) ... ok
test_bgp_06_listen_range (__main__.TestProtocolsBGP) ... ok
test_bgp_07_l2vpn_evpn (__main__.TestProtocolsBGP) ... ok
test_bgp_08_zebra_route_map (__main__.TestProtocolsBGP) ... ok
test_bgp_09_distance_and_flowspec (__main__.TestProtocolsBGP) ... ok
test_bgp_10_vrf_simple (__main__.TestProtocolsBGP) ... ok
test_bgp_11_confederation (__main__.TestProtocolsBGP) ... ok
test_bgp_12_v6_link_local (__main__.TestProtocolsBGP) ... ok
test_bgp_13_solo (__main__.TestProtocolsBGP) ... ok
----------------------------------------------------------------------
Ran 13 tests in 348.191s
OK
```
### Interface-based tests
Our smoketests not only test daemons and services, but also check if interface
configuration works as expected. There is a common base class named
`base_interfaces_test.py` that holds all the common code for interface tests.
These common tests consist of:
- Add one or more IP addresses
- DHCP client and DHCPv6 prefix delegation
- MTU size
- IP and IPv6 options
- Port description
- Port disable
- VLANs (QinQ and regular 802.1q)
- ...
:::{note}
When you are working on interface configuration and want to test
if the Smoketests pass, you would normally lose the remote SSH connection
to your {abbr}`DUT (Device Under Test)`. To handle this, some interface-based
tests can be called with an environment variable beforehand to limit the
number of interfaces used in the test. By default, all interfaces (e.g., all
Ethernet interfaces) are used.
:::
```none
vyos@vyos:~$ TEST_ETH="eth1 eth2" /usr/libexec/vyos/tests/smoke/cli/test_interfaces_bonding.py
test_add_multiple_ip_addresses (__main__.BondingInterfaceTest) ... ok
test_add_single_ip_address (__main__.BondingInterfaceTest) ... ok
test_bonding_hash_policy (__main__.BondingInterfaceTest) ... ok
test_bonding_lacp_rate (__main__.BondingInterfaceTest) ... ok
test_bonding_min_links (__main__.BondingInterfaceTest) ... ok
test_bonding_remove_member (__main__.BondingInterfaceTest) ... ok
test_dhcpv6_client_options (__main__.BondingInterfaceTest) ... ok
test_dhcpv6pd_auto_sla_id (__main__.BondingInterfaceTest) ... ok
test_dhcpv6pd_manual_sla_id (__main__.BondingInterfaceTest) ... ok
test_interface_description (__main__.BondingInterfaceTest) ... ok
test_interface_disable (__main__.BondingInterfaceTest) ... ok
test_interface_ip_options (__main__.BondingInterfaceTest) ... ok
test_interface_ipv6_options (__main__.BondingInterfaceTest) ... ok
test_interface_mtu (__main__.BondingInterfaceTest) ... ok
test_ipv6_link_local_address (__main__.BondingInterfaceTest) ... ok
test_mtu_1200_no_ipv6_interface (__main__.BondingInterfaceTest) ... ok
test_span_mirror (__main__.BondingInterfaceTest) ... ok
test_vif_8021q_interfaces (__main__.BondingInterfaceTest) ... ok
test_vif_8021q_lower_up_down (__main__.BondingInterfaceTest) ... ok
test_vif_8021q_mtu_limits (__main__.BondingInterfaceTest) ... ok
test_vif_8021q_qos_change (__main__.BondingInterfaceTest) ... ok
test_vif_s_8021ad_vlan_interfaces (__main__.BondingInterfaceTest) ... ok
test_vif_s_protocol_change (__main__.BondingInterfaceTest) ... ok
----------------------------------------------------------------------
Ran 23 tests in 244.694s
OK
```
This will limit the `bond` interface test to use only `eth1` and `eth2`
as member ports.
## Config Load Tests
The other part of our tests are called "config load tests." Config load tests
sequentially load arbitrary configuration files to verify that configuration
migration scripts work as designed and that a given set of functionality can
still be loaded with a fresh VyOS ISO image.
The configurations are all derived from production systems and can act as
test cases or as references for enabling certain features. The configurations
can be found here:
<https://github.com/vyos/vyos-1x/tree/current/smoketest/configs>
The entire test is controlled by the main wrapper script
`/usr/bin/vyos-configtest`.
It behaves in the same way as the main smoketest script. It scans the folder
for potential configuration files and issues a `load` command for each file.
### Manual config load test
You do not have to load all configurations sequentially; you can also load
individual test configurations manually.
```none
vyos@vyos:~$ configure
load[edit]
vyos@vyos# load /usr/libexec/vyos/tests/config/ospf-small
Loading configuration from '/usr/libexec/vyos/tests/config/ospf-small'
Load complete. Use 'commit' to make changes effective.
[edit]
vyos@vyos# compare
[edit interfaces ethernet eth0]
-hw-id 00:50:56:bf:c5:6d
[edit interfaces ethernet eth1]
+duplex auto
-hw-id 00:50:56:b3:38:c5
+speed auto
[edit interfaces]
-ethernet eth2 {
- hw-id 00:50:56:b3:9c:1d
-}
-vti vti1 {
- address 192.0.2.1/30
-}
...
vyos@vyos# commit
vyos@vyos#
```
:::{note}
Some configurations have preconditions that must be met. These most
likely include generation of cryptographic keys before the config can be
applied; otherwise, you will get a commit error. If you are interested in
how those preconditions are fulfilled, check the [vyos-build](https://github.com/vyos/vyos-build) repository and
the `scripts/check-qemu-install` file.
:::
|
