Daniel Hilst
58d8aa45eb
Write down, as scenarios, what xCAT's DHCP server is supposed to do from the point of view of a machine booting on a provisioning network: which address it gets, what it is told to boot, where it fetches the loader from, and what else the reply has to carry for a deployment to complete. Read out of the source rather than from the documentation, and cited back to it line by line, so a scenario that stops matching xCAT is a bug in one of the two and it is clear which. Scenarios that cannot be seen from the wire -- a generated file, a daemon's command line -- are marked [config] and belong to the Perl unit tests instead. The rest defines the domain the dhcptest wire cases are measured against, including the ISC/Kea asymmetries the source shows but nothing yet asserts.
xCAT-test
Unit tests that run from the source checkout are split by implementation language:
| Test type | Location | Runner |
|---|---|---|
| Perl unit tests | xCAT-test/unit/*.t |
prove -r xCAT-test/unit |
| Shell unit tests | xCAT-test/bats/*.bats |
bats -r xCAT-test/bats |
| DHCP wire tests | xCAT-test/dhcptest/ |
python3 -m unittest discover -s tests, then dhcptest run -i <nic> <conf> |
| CLI functional tests | xCAT-test/autotest/testcase/ and xCAT-test/autotest/bundle/ |
xcattest -f <cluster.conf> -t <case> or xcattest -f <cluster.conf> -b <bundle> |
Use Perl .t tests for Perl modules, Perl scripts, templates, and repository
artifacts. Use BATS tests for shell-script behavior that can be exercised from
the checkout by sourcing a shell library or script and shadowing external
commands.
Shell behavior should not be tested by Perl tests that grep shell source. Put
those tests under xCAT-test/bats instead.
dhcptest is the odd one out: its Python unit tests and dhcptest validate
run offline like the others, but its point is the third column -- driving real
DHCP transactions on a provisioning NIC and asserting on what came back. It
talks to the server only over the wire, so it is agnostic to which DHCP
implementation is answering and to xCAT itself.
See unit/README.md, bats/README.md and dhcptest/README.md for the
detailed rules for each suite.