1
0
mirror of https://passt.top/passt synced 2024-06-27 13:32:41 +00:00
passt/test
David Gibson 32c5e05479 tests: Move distro image download to asset build makefile
Rather than directly download distro images from the test scripts, handle
all the downloads during the test asset build, then just clone them for
the tests themselves.  This avoids repeated downloads which can be very
slow when debugging failing tests.

Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
[sbrivio: Add OPENSUSE_IMGS to DOWNLOAD_ASSETS in Makefile, and note
 that xzcat doesn't take a -O option in test/distro/opensuse]
Signed-off-by: Stefano Brivio <sbrivio@redhat.com>
2022-07-14 01:34:37 +02:00
..
build tests: Remove not-very-useful "req" directive 2022-07-14 01:32:42 +02:00
demo tests: Explicitly list test files in test/run, remove "onlyfor" support 2022-07-14 01:32:42 +02:00
dhcp tests: Explicitly list test files in test/run, remove "onlyfor" support 2022-07-14 01:32:42 +02:00
distro tests: Move distro image download to asset build makefile 2022-07-14 01:34:37 +02:00
env LICENSES: Add license text files, add missing notices, fix SPDX tags 2021-10-20 08:29:30 +02:00
icmp tests: Explicitly list test files in test/run, remove "onlyfor" support 2022-07-14 01:32:42 +02:00
lib tests: Explicitly list test files in test/run, remove "onlyfor" support 2022-07-14 01:32:42 +02:00
ndp tests: Explicitly list test files in test/run, remove "onlyfor" support 2022-07-14 01:32:42 +02:00
perf tests: Explicitly list test files in test/run, remove "onlyfor" support 2022-07-14 01:32:42 +02:00
tcp tests: Explicitly list test files in test/run, remove "onlyfor" support 2022-07-14 01:32:42 +02:00
two_guests test: Embed script for dhclient(8) in mbuto(1) profile 2022-07-14 01:31:28 +02:00
udp tests: Explicitly list test files in test/run, remove "onlyfor" support 2022-07-14 01:32:42 +02:00
valgrind tests: Explicitly list test files in test/run, remove "onlyfor" support 2022-07-14 01:32:42 +02:00
.gitignore tests: Move distro image download to asset build makefile 2022-07-14 01:34:37 +02:00
ci test: Add CI/demo scripts 2021-09-27 15:10:35 +02:00
find-arm64-firmware.sh tests: Search multiple places for aarch64 EDK2 bios image 2022-07-14 01:32:42 +02:00
Makefile tests: Move distro image download to asset build makefile 2022-07-14 01:34:37 +02:00
passt.mbuto test: Embed script for dhclient(8) in mbuto(1) profile 2022-07-14 01:31:28 +02:00
README.md tests: Use nmap-ncat instead of openbsd netcat for pasta tests 2022-06-18 09:05:06 +02:00
run tests: Explicitly list test files in test/run, remove "onlyfor" support 2022-07-14 01:32:42 +02:00
run_demo test: Add CI/demo scripts 2021-09-27 15:10:35 +02:00
valgrind.supp test, seccomp, Makefile: Switch to valgrind runs for passt functional tests 2022-03-29 15:35:38 +02:00

Scope

This directory contains test cases for passt and pasta and a simple POSIX shell-based framework to define them, and run them as a suite.

These tests can be run as part of a continuous integration workflow, and are also used to provide short usage demos, with video recording, for passt and pasta basic use cases.

Run

Dependencies

Packages

The tests require some package dependencies commonly available in Linux distributions. If some packages are not available, the test groups that need them will be selectively skipped.

This is a non-exhaustive list of packages that might not commonly be installed on a system, i.e. common utilities such as a shell are not included here.

Example for Debian, and possibly most Debian-based distributions:

build-essential git jq strace iperf3 qemu-system-x86 tmux sipcalc bc
clang-tidy cppcheck isc-dhcp-common psmisc linux-cpupower ncat
netcat-openbsd fakeroot lz4 lm-sensors qemu-system-arm qemu-system-ppc
qemu-system-misc qemu-system-x86 valgrind

Other tools

Test measuring request-response and connect-request-response latencies use neper, which is not commonly packaged by distributions and needs to be built and installed manually:

git clone https://github.com/google/neper
cd neper; make
cp tcp_crr tcp_rr udp_rr /usr/local/bin

Virtual machine images are built during test executions using mbuto, the shell script is sourced via git as needed, so there's no need to actually install it.

Special requirements for continuous integration and demo modes

Running the test suite as continuous integration or demo modes will record the terminal with the steps being executed, using asciinema(1), and create binary packages.

The following additional packages are commonly needed:

alien asciinema linux-perf tshark

Regular test

Just issue:

./run

from the test directory. Elevated privileges are not needed. Environment variable settings: DEBUG=1 enables debugging messages, TRACE=1 enables tracing (further debugging messages), PCAP=1 enables packet captures. Example:

PCAP=1 TRACE=1 ./run

Continuous integration

Issuing:

./ci

will run the whole test suite while recording the execution, and it will also build JavaScript fragments used on http://passt.top/ for performance data tables and links to specific offsets in the captures.

Demo mode

Issuing:

./demo

will run the demo cases under demo, with terminal captures as well.

Framework

The implementation of the testing framework is under lib, and it provides facilities for terminal and tmux session management, interpretation of test directives, video recording, and suchlike. Test cases are organised in the remaining directories.

Test cases can be implemented as POSIX shell scripts, or as a set of directives, which are not formally documented here, but should be clear enough from the existing cases. The entry point for interpretation of test directives is implemented in lib/test.