docs: use lowercase "qemu" and other minor tweaks to test docs

We used both "qemu" and "QEMU", let's use the lower-case version everywhere
since it's also the name of the binary and the version that people are
most familiar with.

The stuff under test/ is not only for the integeration tests, but also
for various other test-related stuff, so adjust the docs a bit.

diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md
index 55891a92b629c96001c16ec882a088fd93e352e6..384e3d428803255b22cf715586cec4aa6f12c1c6 100644 (file)
--- a/docs/ARCHITECTURE.md
+++ b/docs/ARCHITECTURE.md
@@ -73,7 +73,7 @@ D-Bus messages in `src/shared/bus-unit-util.c`
 So that they are exercised by the fuzzing CI, new unit settings should also be listed in the
 text files under `test/fuzz/fuzz-unit-file/`.
 
-## UDEV
+## systemd-udev
 
 Sources for the udev daemon and command-line tool (single binary) can be found under
 `src/udev/`.
@@ -83,7 +83,7 @@ Sources for the udev daemon and command-line tool (single binary) can be found u
 Source files found under `src/test/` implement unit-level testing, mostly for
 modules found in `src/basic/` and `src/shared/`, but not exclusively. Each test
 file is compiled in a standalone binary that can be run to exercise the
-corresponding module. While most of the tests can be ran by any user, some
+corresponding module. While most of the tests can be run by any user, some
 require privileges, and will attempt to clearly log about what they need
 (mostly in the form of effective capabilities). These tests are self-contained,
 and generally safe to run on the host without side effects.
@@ -104,20 +104,21 @@ and output looks awkward if they are too long.
 
 # Integration Tests
 
-Sources in `test/` implement system-level testing for executables, libraries and
-daemons that are shipped by the project. They require privileges to run, and
-are not safe to execute directly on a host. By default they will build an image
-and run the test under it via `QEMU` or `systemd-nspawn`.
+Sources in `test/TEST-*` implement system-level testing for executables,
+libraries and daemons that are shipped by the project. They require privileges
+to run, and are not safe to execute directly on a host. By default they will
+build an image and run the test under it via `qemu` or `systemd-nspawn`.
 
-Most of those tests should be able to run via `systemd-nspawn`, which is orders of
-magnitude faster than `QEMU`, but some tests require privileged operations like
-using `dm-crypt` or `loopdev`. They are clearly marked if that is the case.
+Most of those tests should be able to run via `systemd-nspawn`, which is
+orders-of-magnitude faster than `qemu`, but some tests require privileged
+operations like using `dm-crypt` or `loopdev`. They are clearly marked if that
+is the case.
 
 See `test/README.testsuite` for more specific details.
 
-# HWDB
+# hwdb
 
-Rules built in the static `HWDB` database shipped by the project can be found
+Rules built in the static hardware database shipped by the project can be found
 under `hwdb.d/`. Some of these files are updated automatically, some are filled
 by contributors.
 
@@ -130,7 +131,7 @@ Markdown files found under `docs/` are automatically published on the
 to ensure the formatting doesn't have errors is included in the
 `meson test -C build/ github-pages` run as part of the CI.
 
-## MAN pages
+## Man pages
 
 Manpages for binaries and libraries, and the DBUS interfaces, can be found under
 `man/` and should ideally be kept in sync with changes to the corresponding

diff --git a/test/README.testsuite b/test/README.testsuite
index 24b98f78cd1330b2057718ba126d73723e6ca16a..7e3d6c0623737f17aa8ab403afb89232f47a1e4f 100644 (file)
--- a/test/README.testsuite
+++ b/test/README.testsuite
@@ -1,5 +1,7 @@
-The extended testsuite only works with UID=0. It contains of several
-subdirectories named "test/TEST-??-*", which are run one by one.
+The extended testsuite only works with UID=0. It consists of the subdirectories
+named "test/TEST-??-*", each of which contains a description of an OS image and
+a test which consists of systemd units and scripts to execute in this image.
+The same image is used for execution under `systemd-nspawn` and `qemu`.
 
 To run the extended testsuite do the following:
 
@@ -53,10 +55,10 @@ Configuration variables
 =======================
 
 TEST_NO_QEMU=1
-    Don't run tests under QEMU
+    Don't run tests under qemu
 
 TEST_QEMU_ONLY=1
-    Run only tests that require QEMU
+    Run only tests that require qemu
 
 TEST_NO_NSPAWN=1
     Don't run tests under systemd-nspawn
@@ -65,8 +67,8 @@ TEST_PREFER_NSPAWN=1
     Run all tests that do not require qemu under systemd-nspawn
 
 TEST_NO_KVM=1
-    Disable QEMU KVM auto-detection (may be necessary when you're trying to run the
-    *vanilla* QEMU and have both qemu and qemu-kvm installed)
+    Disable qemu KVM auto-detection (may be necessary when you're trying to run the
+    *vanilla* qemu and have both qemu and qemu-kvm installed)
 
 TEST_NESTED_KVM=1
     Allow tests to run with nested KVM. By default, the testsuite disables
@@ -74,10 +76,10 @@ TEST_NESTED_KVM=1
     variable disables such checks
 
 QEMU_MEM=512M
-    Configure amount of memory for QEMU VMs (defaults to 512M)
+    Configure amount of memory for qemu VMs (defaults to 512M)
 
 QEMU_SMP=1
-    Configure number of CPUs for QEMU VMs (defaults to 1)
+    Configure number of CPUs for qemu VMs (defaults to 1)
 
 KERNEL_APPEND='...'
     Append additional parameters to the kernel command line
@@ -86,7 +88,7 @@ NSPAWN_ARGUMENTS='...'
     Specify additional arguments for systemd-nspawn
 
 QEMU_TIMEOUT=infinity
-    Set a timeout for tests under QEMU (defaults to infinity)
+    Set a timeout for tests under qemu (defaults to infinity)
 
 NSPAWN_TIMEOUT=infinity
     Set a timeout for tests under systemd-nspawn (defaults to infinity)
@@ -99,7 +101,7 @@ INTERACTIVE_DEBUG=1
 The kernel and initramfs can be specified with $KERNEL_BIN and $INITRD.
 (Fedora's or Debian's default kernel path and initramfs are used by default)
 
-A script will try to find your QEMU binary. If you want to specify a different
+A script will try to find your qemu binary. If you want to specify a different
 one with $QEMU_BIN.
 
 Debugging the qemu image

diff --git a/test/TEST-64-UDEV-STORAGE/test.sh b/test/TEST-64-UDEV-STORAGE/test.sh
index d2660d39517561ea928f45e8b9ebac8b72a653e8..e273d211bc2d784068355ce0ddd6488e55f5514e 100755 (executable)
--- a/test/TEST-64-UDEV-STORAGE/test.sh
+++ b/test/TEST-64-UDEV-STORAGE/test.sh
@@ -101,7 +101,7 @@ test_run_one() {
     local test_id="${1:?}"
 
     if run_qemu "$test_id"; then
-        check_result_qemu || { echo "QEMU test failed"; return 1; }
+        check_result_qemu || { echo "qemu test failed"; return 1; }
     fi
 
     return 0
@@ -117,7 +117,7 @@ test_run() {
     mount_initdir
 
     if get_bool "${TEST_NO_QEMU:=}" || ! find_qemu_bin; then
-        dwarn "can't run QEMU, skipping"
+        dwarn "can't run qemu, skipping"
         return 0
     fi
 

diff --git a/test/networkd-test.py b/test/networkd-test.py
index 1001cd7cc8eb8a0be0bb7e55859a4dd15013f502..4b5ba622fa6f31e6c33e15299d271dd651c0b772 100755 (executable)
--- a/test/networkd-test.py
+++ b/test/networkd-test.py
@@ -7,7 +7,7 @@
 # but it assumes (and checks at the beginning) that networkd is not currently
 # running.
 #
-# This can be run on a normal installation, in QEMU, nspawn (with
+# This can be run on a normal installation, in qemu, systemd-nspawn (with
 # --private-network), LXD (with "--config raw.lxc=lxc.aa_profile=unconfined"),
 # or LXC system containers. You need at least the "ip" tool from the iproute
 # package; it is recommended to install dnsmasq too to get full test coverage.

diff --git a/test/test-functions b/test/test-functions
index 365f535bf01976b88bda282ef5492e346086c3e1..90c8f79468fd70c2608bdc78d431aa8f2a7f41c8 100644 (file)
--- a/test/test-functions
+++ b/test/test-functions
@@ -60,7 +60,7 @@ get_bool() {
     fi
 }
 
-# Decide if we can (and want to) run QEMU with KVM acceleration.
+# Decide if we can (and want to) run qemu with KVM acceleration.
 # Check if nested KVM is explicitly enabled (TEST_NESTED_KVM). If not,
 # check if it's not explicitly disabled (TEST_NO_KVM) and we're not already
 # running under KVM. If these conditions are met, enable KVM (and possibly
@@ -310,7 +310,7 @@ find_qemu_bin() {
     esac
 
     if [[ ! -e "$QEMU_BIN" ]]; then
-        echo "Could not find a suitable QEMU binary" >&2
+        echo "Could not find a suitable qemu binary" >&2
         return 1
     fi
 }
@@ -334,8 +334,8 @@ qemu_min_version() {
     printf "%s\n%s\n" "$1" "$qemu_ver" | sort -V -C
 }
 
-# Return 0 if QEMU did run (then you must check the result state/logs for actual
-# success), or 1 if QEMU is not available.
+# Return 0 if qemu did run (then you must check the result state/logs for actual
+# success), or 1 if qemu is not available.
 run_qemu() {
     if [ -f /etc/machine-id ]; then
         read -r MACHINE_ID </etc/machine-id
@@ -480,7 +480,7 @@ run_qemu() {
         derror "Test timed out after ${QEMU_TIMEOUT}s"
         TIMED_OUT=1
     else
-        [ "$rc" != 0 ] && derror "QEMU failed with exit code $rc"
+        [ "$rc" != 0 ] && derror "qemu failed with exit code $rc"
     fi
     return 0
 }
@@ -2877,9 +2877,9 @@ test_run() {
 
     if ! get_bool "${TEST_NO_QEMU:=}"; then
         if run_qemu "$test_id"; then
-            check_result_qemu || { echo "QEMU test failed"; return 1; }
+            check_result_qemu || { echo "qemu test failed"; return 1; }
         else
-            dwarn "can't run QEMU, skipping"
+            dwarn "can't run qemu, skipping"
         fi
     fi
     if ! get_bool "${TEST_NO_NSPAWN:=}"; then
@@ -2909,12 +2909,12 @@ do_test() {
     fi
 
     if get_bool "${TEST_NO_QEMU:=}" && get_bool "${TEST_NO_NSPAWN:=}"; then
-        echo "TEST: $TEST_DESCRIPTION [SKIPPED]: both QEMU and nspawn disabled" >&2
+        echo "TEST: $TEST_DESCRIPTION [SKIPPED]: both qemu and nspawn disabled" >&2
         exit 0
     fi
 
     if get_bool "${TEST_QEMU_ONLY:=}" && ! get_bool "$TEST_NO_NSPAWN"; then
-        echo "TEST: $TEST_DESCRIPTION [SKIPPED]: QEMU-only tests requested" >&2
+        echo "TEST: $TEST_DESCRIPTION [SKIPPED]: qemu-only tests requested" >&2
         exit 0
     fi