python3 -m pip install -r requirements_test.txt
The Firewall used for testing should be a dedicated VM for testing. You can use the official ova image.
THE TESTS WILL OVERRIDE THE EXISTING CONFIG!
Most tests fail if some other config is found.
Some tests need packages to be pre-installed:
- webproxy_* -
os-squid
- frr_* -
os-frr
- bind_* -
os-bind
Some tests benefit from having a second network-interface available.
You need to add a opt1
dummy-interface named TEST
. The assigned IPs do not matter.
To perform some tests (system, ids) the test firewall needs to reach some public service:
- system -
pkg.opnsense.org
- ids -
rules.emergingthreats.net
These internal certificates need to be created:
- CA:
OpenVPN
- Client Certificate:
OpenVPN Client
- Server Certificate:
OpenVPN Server
- SANDNS:openvpn.intern
bash scripts/test_single.sh
> Arguments:
> 1: firewall
> 2: api key file
> 3: path to local collection - set to '0' to clone from github
> 4: name of test to run
> 5: if check-mode should be ran (optional; 0/1; default=1)
> 6: path to virtual environment (optional)
bash scripts/test.sh
> Arguments:
> 1: firewall
> 2: api key file
> 3: path to local collection - set to '0' to clone from github
> 4: path to virtual environment (optional)
The tests are run automatically using the AnsibleGuy infrastructure!
It is based on some bash scripts and systemd timers.
Logs for those functional tests can be found here: Short, Full