systemd/test
2022-03-19 00:13:55 +01:00
..
dmidecode-dumps memory-id: Work-around incorrect "Number of slots" 2022-03-07 15:33:26 +00:00
fuzz network: dhcp: rename NextServer= and Filename= settings 2022-03-11 10:14:57 +09:00
hwdb.d Rename udev's hwdb/ to hwdb.d/ 2019-10-10 00:53:09 +01:00
journal-data gitattributes: introduce and use "generated" attribute 2021-10-18 09:42:55 +02:00
TEST-01-BASIC tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-02-UNITTESTS tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-03-JOBS tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-04-JOURNAL tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-05-RLIMITS tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-06-SELINUX TEST-06-SELINUX: add the usual spdx license header to policy files 2021-10-18 09:43:18 +02:00
TEST-07-ISSUE-1981 tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-08-ISSUE-2730 TEST-08: don't force ext4 for / 2021-11-16 16:58:49 +01:00
TEST-09-ISSUE-2691 tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-10-ISSUE-2467 test: tweak TriggerLimitIntervalSec= when built with coverage 2021-10-25 11:02:22 +02:00
TEST-11-ISSUE-3166 tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-12-ISSUE-3171 tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-13-NSPAWN-SMOKE tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-14-MACHINE-ID tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-15-DROPIN tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-16-EXTEND-TIMEOUT tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-17-UDEV test: skip TEST-17 on ubuntu ppc64el 2022-03-08 17:03:11 +00:00
TEST-18-FAILUREACTION tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-19-DELEGATE tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-20-MAINPIDGAMES tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-22-TMPFILES tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-23-TYPE-EXEC tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-24-CRYPTSETUP test: collect the coverage _before_ unmounting the rootfs 2021-10-21 18:12:06 +02:00
TEST-25-IMPORT tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-26-SETENV tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-27-STDOUTFILE tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-28-PERCENTJ-WANTEDBY tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-29-PORTABLE test: install losetup by default 2021-12-20 23:34:27 +09:00
TEST-30-ONCLOCKCHANGE tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-31-DEVICE-ENUMERATION tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-32-OOMPOLICY tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-33-CLEAN-UNIT tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-34-DYNAMICUSERMIGRATE tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-36-NUMAPOLICY tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-37-RUNTIMEDIRECTORYPRESERVE tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-38-FREEZER tests: use !/usr/bin/env bash consistently 2021-10-18 09:04:45 +02:00
TEST-39-EXECRELOAD tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-40-EXEC-COMMAND-EX tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-41-ONESHOT-RESTART tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-42-EXECSTOPPOST tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-43-PRIVATEUSER-UNPRIV core: support ExtensionDirectories in user manager 2022-03-10 20:38:10 +00:00
TEST-44-LOG-NAMESPACE tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-46-HOMED test: make homed test run in qemu 2021-11-16 12:33:44 +01:00
TEST-47-ISSUE-14566 tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-48-START-STOP-NO-RELOAD tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-49-RUNTIME-BIND-PATHS tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-50-DISSECT test: install losetup by default 2021-12-20 23:34:27 +09:00
TEST-51-ISSUE-16115 tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-52-HONORFIRSTSHUTDOWN tests: use !/usr/bin/env bash consistently 2021-10-18 09:04:45 +02:00
TEST-53-ISSUE-16347 tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-54-CREDS tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-55-OOMD tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-56-EXIT-TYPE test: require unified cgroup hierarchy for TEST-56 2022-02-01 22:13:48 +01:00
TEST-57-ONSUCCESS-UPHOLD tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-58-REPART tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-59-RELOADING-RESTART tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-60-MOUNT-RATELIMIT tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-61-UNITTESTS-QEMU tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-62-RESTRICT-IFACES tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-63-ISSUE-17433 test: tweak TriggerLimitIntervalSec= if we're running w/o KVM as well 2021-12-22 08:56:20 +09:00
TEST-64-UDEV-STORAGE test: temporary workaround for #21819 2022-01-27 22:51:15 +01:00
TEST-65-ANALYZE tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-66-DEVICE-ISOLATION tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
TEST-67-INTEGRITY test: install losetup by default 2021-12-20 23:34:27 +09:00
TEST-68-PROPAGATE-EXIT-STATUS tests: add test to cover service exit status propagation 2021-12-13 14:44:06 +00:00
TEST-69-SHUTDOWN test: use ~/.bashrc instead of /etc/bash.bashrc 2022-01-31 17:47:01 +01:00
TEST-70-TPM2 cryptenroll: add tests for TPM2 unlocking 2022-03-15 21:17:00 +01:00
TEST-72-SYSUPDATE test: add integration test for sysupdate 2022-03-19 00:13:55 +01:00
test-bcd test: Add BCD unit test 2021-12-11 21:32:29 +01:00
test-execute core: add %d specifier for the $CREDENTIALS_DIRECTORY 2022-03-17 17:45:01 +01:00
test-fstab-generator test: store empty files rather than symlinks for test-fstab-generator 2022-01-09 18:17:40 +01:00
test-keymap-util test-keymap-util: always use kbd-model-map we ship 2021-11-02 16:48:55 +01:00
test-network network: l2tp: change create type to independent 2022-02-27 09:36:48 +09:00
test-network-generator-conversion gitattributes: introduce and use "generated" attribute 2021-10-18 09:42:55 +02:00
test-path tests: add spdx license header to test unit/link/network/conf files 2021-10-18 09:04:45 +02:00
test-path-util tests: add spdx headers to scripts and Makefiles 2021-10-18 09:04:45 +02:00
test-resolve resolved: Test for DnsStream (plain TCP DNS and DoT) 2022-01-27 14:33:56 +09:00
test-sysusers gitattributes: introduce and use "generated" attribute 2021-10-18 09:42:55 +02:00
test-umount gitattributes: introduce and use "generated" attribute 2021-10-18 09:42:55 +02:00
testsuite-04.units tests: add spdx license header to test unit/link/network/conf files 2021-10-18 09:04:45 +02:00
testsuite-06.units tests: add spdx license header to test unit/link/network/conf files 2021-10-18 09:04:45 +02:00
testsuite-08.units TEST-08: don't force ext4 for / 2021-11-16 16:58:49 +01:00
testsuite-10.units tests: add spdx license header to test unit/link/network/conf files 2021-10-18 09:04:45 +02:00
testsuite-11.units tests: add spdx license header to test unit/link/network/conf files 2021-10-18 09:04:45 +02:00
testsuite-16.units tests: add spdx license header to test unit/link/network/conf files 2021-10-18 09:04:45 +02:00
testsuite-28.units tests: add spdx license header to test unit/link/network/conf files 2021-10-18 09:04:45 +02:00
testsuite-30.units/systemd-timedated.service.d tests: add spdx license header to test unit/link/network/conf files 2021-10-18 09:04:45 +02:00
testsuite-52.units tests: add spdx license header to test unit/link/network/conf files 2021-10-18 09:04:45 +02:00
testsuite-63.units core: Add trigger limit for path units 2021-12-18 11:26:25 +01:00
units test: add integration test for sysupdate 2022-03-19 00:13:55 +01:00
.gitignore update .gitignore 2013-01-28 03:54:49 +01:00
create-busybox-container licensing: add forgotten spdx headers 2021-10-01 14:45:00 +02:00
create-sys-script.py license: LGPL-2.1+ -> LGPL-2.1-or-later 2020-11-09 13:23:58 +09:00
hwdb-test.sh test: shellcheck-ify test scripts 2021-09-30 12:12:00 +02:00
meson.build test: check systemd RPM macros 2022-03-06 13:07:20 +09:00
mkosi-check-and-shutdown.service ci: check for failed services after boot 2021-12-10 10:25:43 +01:00
mkosi-check-and-shutdown.sh ci: check for failed services after boot 2021-12-10 10:25:43 +01:00
mkosi.build.networkd-test licensing: add forgotten spdx headers 2021-10-01 14:45:00 +02:00
mkosi.default.networkd-test licensing: add forgotten spdx headers 2021-10-01 14:45:00 +02:00
mkosi.nspawn.networkd-test licensing: add forgotten spdx headers 2021-10-01 14:45:00 +02:00
networkd-test.py tree-wide: fix duplicated words 2022-03-18 08:14:01 +09:00
README.testsuite test: document how to run CodeQL/LGTM stuff manually 2022-03-11 16:51:53 +01:00
rule-syntax-check.py license: LGPL-2.1+ -> LGPL-2.1-or-later 2020-11-09 13:23:58 +09:00
run-integration-tests.sh test runner: print time before/after tests 2021-11-22 09:05:00 +00:00
run-unit-tests.py licensing: add forgotten spdx headers 2021-10-01 14:45:00 +02:00
sd-script.py tree-wide: fix typo 2020-12-14 12:05:55 +00:00
sys-script.py Merge pull request #17431 from msekletar/udev-link-update-race 2020-11-10 09:41:57 +01:00
sysv-generator-test.py license: LGPL-2.1+ -> LGPL-2.1-or-later 2020-11-09 13:23:58 +09:00
test-exec-deserialization.py license: LGPL-2.1+ -> LGPL-2.1-or-later 2020-11-09 13:23:58 +09:00
test-fstab-generator.sh test: store empty files rather than symlinks for test-fstab-generator 2022-01-09 18:17:40 +01:00
test-functions cryptenroll: add tests for TPM2 unlocking 2022-03-15 21:17:00 +01:00
test-network-generator-conversion.sh licensing: add forgotten spdx headers 2021-10-01 14:45:00 +02:00
test-rpm-macros.sh test: check systemd RPM macros 2022-03-06 13:07:20 +09:00
test-shutdown.py test: add shutdown test 2022-01-25 17:43:13 +01:00
test-systemd-tmpfiles.py tmpfiles: add '=' action modifier. 2021-06-08 17:23:26 +02:00
test-sysusers.sh.in licensing: add forgotten spdx headers 2021-10-01 14:45:00 +02:00
testdata test: convert TEST-35-NETWORK-GENERATOR into a unit test 2020-03-28 11:46:48 +01:00
udev-dmi-memory-id-test.sh test: shellcheck-ify test scripts 2021-09-30 12:12:00 +02:00
udev-test.pl licensing: add forgotten spdx headers 2021-10-01 14:45:00 +02:00

The extended testsuite only works with UID=0. It contains of several
subdirectories named "test/TEST-??-*", which are run one by one.

To run the extended testsuite do the following:

$ ninja -C build  # Avoid building anything as root later
$ sudo test/run-integration-tests.sh
ninja: Entering directory `/home/zbyszek/src/systemd/build'
ninja: no work to do.
--x-- Running TEST-01-BASIC --x--
+ make -C TEST-01-BASIC clean setup run
make: Entering directory '/home/zbyszek/src/systemd/test/TEST-01-BASIC'
TEST-01-BASIC CLEANUP: Basic systemd setup
TEST-01-BASIC SETUP: Basic systemd setup
...
TEST-01-BASIC RUN: Basic systemd setup [OK]
make: Leaving directory '/home/zbyszek/src/systemd/test/TEST-01-BASIC'
--x-- Result of TEST-01-BASIC: 0 --x--
--x-- Running TEST-02-CRYPTSETUP --x--
+ make -C TEST-02-CRYPTSETUP clean setup run

If one of the tests fails, then $subdir/test.log contains the log file of
the test.

To run just one of the cases:

$ sudo make -C test/TEST-01-BASIC clean setup run

Specifying the build directory
==============================

If the build directory is not detected automatically, it can be specified
with BUILD_DIR=:

$ sudo BUILD_DIR=some-other-build/ test/run-integration-tests

or

$ sudo make -C test/TEST-01-BASIC BUILD_DIR=../../some-other-build/ ...

Note that in the second case, the path is relative to the test case directory.
An absolute path may also be used in both cases.

Testing installed binaries instead of built
===========================================

To run the extended testsuite using the systemd installed on the system instead
of the systemd from a build, use the NO_BUILD=1:

$ sudo NO_BUILD=1 test/run-integration-tests

Configuration variables
=======================

TEST_NO_QEMU=1
    Don't run tests under QEMU

TEST_QEMU_ONLY=1
    Run only tests that require QEMU

TEST_NO_NSPAWN=1
    Don't run tests under systemd-nspawn

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)

TEST_NESTED_KVM=1
    Allow tests to run with nested KVM. By default, the testsuite disables
    nested KVM if the host machine already runs under KVM. Setting this
    variable disables such checks

QEMU_MEM=512M
    Configure amount of memory for QEMU VMs (defaults to 512M)

QEMU_SMP=1
    Configure number of CPUs for QEMU VMs (defaults to 1)

KERNEL_APPEND='...'
    Append additional parameters to the kernel command line

NSPAWN_ARGUMENTS='...'
    Specify additional arguments for systemd-nspawn

QEMU_TIMEOUT=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)

INTERACTIVE_DEBUG=1
    Configure the machine to be more *user-friendly* for interactive debuggung
    (e.g. by setting a usable default terminal, suppressing the shutdown after
    the test, etc.)

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
one with $QEMU_BIN.

Debugging the qemu image
========================

If you want to log in the testsuite virtual machine, you can specify additional
kernel command line parameter with $KERNEL_APPEND and then log in as root.

$ sudo make -C test/TEST-01-BASIC KERNEL_APPEND="systemd.unit=multi-user.target" run

Root password is empty.

Ubuntu CI
=========

New PR submitted to the project are run through regression tests, and one set
of those is the 'autopkgtest' runs for several different architectures, called
'Ubuntu CI'.  Part of that testing is to run all these tests.  Sometimes these
tests are temporarily deny-listed from running in the 'autopkgtest' tests while
debugging a flaky test; that is done by creating a file in the test directory
named 'deny-list-ubuntu-ci', for example to prevent the TEST-01-BASIC test from
running in the 'autopkgtest' runs, create the file
'TEST-01-BASIC/deny-list-ubuntu-ci'.

The tests may be disabled only for specific archs, by creating a deny-list file
with the arch name at the end, e.g.
'TEST-01-BASIC/deny-list-ubuntu-ci-arm64' to disable the TEST-01-BASIC test
only on test runs for the 'arm64' architecture.

Note the arch naming is not from 'uname -m', it is Debian arch names:
https://wiki.debian.org/ArchitectureSpecificsMemo

For PRs that fix a currently deny-listed test, the PR should include removal
of the deny-list file.

In case a test fails, the full set of artifacts, including the journal of the
failed run, can be downloaded from the artifacts.tar.gz archive which will be
reachable in the same URL parent directory as the logs.gz that gets linked on
the Github CI status.

To add new dependencies or new binaries to the packages used during the tests,
a merge request can be sent to: https://salsa.debian.org/systemd-team/systemd
targeting the 'upstream-ci' branch.

The cloud-side infrastructure, that is hooked into the Github interface, is
located at:

https://git.launchpad.net/autopkgtest-cloud/

In case of infrastructure issues with this CI, things might go wrong in two
places:

- starting a job: this is done via a Github webhook, so check if the HTTP POST
  are failing on https://github.com/systemd/systemd/settings/hooks
- running a job: all currently running jobs are listed at
  https://autopkgtest.ubuntu.com/running#pkg-systemd-upstream in case the PR
  does not show the status for some reason
- reporting the job result: this is done on Canonical's cloud infrastructure,
  if jobs are started and running but no status is visible on the PR, then it is
  likely that reporting back is not working

For infrastructure help, reaching out to Canonical via the #ubuntu-devel channel
on libera.chat is an effective way to receive support in general.

Manually running a part of the Ubuntu CI test suite
===================================================

In some situations one may want/need to run one of the tests run by Ubuntu CI
locally for debugging purposes. For this, you need a machine (or a VM) with
the same Ubuntu release as is used by Ubuntu CI (Focal ATTOW).

First of all, clone the Debian systemd repository and sync it with the code of
the PR (set by the $UPSTREAM_PULL_REQUEST env variable) you'd like to debug:

# git clone https://salsa.debian.org/systemd-team/systemd.git
# cd systemd
# git checkout upstream-ci
# TEST_UPSTREAM=1 UPSTREAM_PULL_REQUEST=12345 ./debian/extra/checkout-upstream

Now install necessary build & test dependencies:

## PPA with some newer Ubuntu packages required by upstream systemd
# add-apt-repository -y ppa:upstream-systemd-ci/systemd-ci
# apt build-dep -y systemd
# apt install -y autopkgtest debhelper genisoimage git qemu-system-x86 \
                 libzstd-dev libfdisk-dev libtss2-dev libfido2-dev libssl-dev \
                 python3-jinja2 zstd

Build systemd deb packages with debug info:

# DEB_BUILD_OPTIONS="nocheck nostrip" dpkg-buildpackage -us -uc
# cd ..

Prepare a testbed image for autopkgtest (tweak the release as necessary):

# autopkgtest-buildvm-ubuntu-cloud -v -a amd64 -r focal

And finally run the autopkgtest itself:

# autopkgtest -o logs *.deb systemd/ \
              --timeout-factor=3 \
              --test-name=boot-and-services \
              --shell-fail \
              -- autopkgtest-virt-qemu autopkgtest-focal-amd64.img

where --test-name= is the name of the test you want to run/debug. The
--shell-fail option will pause the execution in case the test fails and shows
you the information how to connect to the testbed for further debugging.

Manually running LGTM/CodeQL analysis
=====================================

This is mostly useful for debugging various CodeQL/LGTM quirks.

Download the CodeQL Bundle from https://github.com/github/codeql-action/releases
and unpack it somewhere. From now the 'tutorial' assumes you have the `codeql`
binary from the unpacked archive in $PATH for brevity.

Switch to the systemd repository if not already:

$ cd <systemd-repo>

Create an initial CodeQL database:

$ CCACHE_DISABLE=1 codeql database create codeqldb --language=cpp -vvv

Disabling ccache is important, otherwise you might see CodeQL complaining:

No source code was seen and extracted to /home/mrc0mmand/repos/@ci-incubator/systemd/codeqldb.
This can occur if the specified build commands failed to compile or process any code.
 - Confirm that there is some source code for the specified language in the project.
 - For codebases written in Go, JavaScript, TypeScript, and Python, do not specify
   an explicit --command.
 - For other languages, the --command must specify a "clean" build which compiles
   all the source code files without reusing existing build artefacts.

If you want to run all queries systemd uses in LGTM/CodeQL, run:

$ codeql database analyze codeqldb/ --format csv --output results.csv .github/codeql-custom.qls .lgtm/cpp-queries/*.ql -vvv

Note: this will take a while.

If you're interested in a specific check, the easiest way (without hunting down
the specific CodeQL query file) is to create a custom query suite. For example:

$ cat >test.qls <<EOF
- queries: .
  from: codeql/cpp-queries
- include:
    id:
        - cpp/missing-return
EOF

And then execute it in the same way as above:

$ codeql database analyze codeqldb/ --format csv --output results.csv test.qls -vvv

More about query suites here: https://codeql.github.com/docs/codeql-cli/creating-codeql-query-suites/

The results are then located in the `results.csv` file as a comma separated
values list (obviously), which is the most human-friendly output format the
CodeQL utility provides (so far).