Daniel Hilst
646b57c123
master changed the same three files this branch changes, so the pull request could not merge. Conflicts and how each was resolved: xCAT-genesis-builder/builddeb-genesis-base. Both sides teach the build root to cope with a package whose name moved between releases. master added optional_packages(), which keeps a package only where apt has a candidate, and called it for util-linux-extra. This branch added add_first_available(), which takes the first name apt carries and fails when it carries none, and calls it for bind9-dnsutils/dnsutils and util-linux-extra/util-linux, plus add_if_available() for tzdata-legacy. The branch covers master's case and two more, so its helpers are kept and optional_packages() goes with its only caller. Every other master change to this file, including the DHCP client fix, is preserved. xCAT-test/unit/genesis_payload_verification.t. master has four assertions this branch does not: two payloads missing an absolute path. Its version is kept. The branch replaced plan skip_all with a fail(), because skipping covers nothing when the file under test is the gate itself, and that change is applied to master's version. xCAT-test/unit/genesis_ubuntu_build_root.t. master's added assertions drive optional_packages() directly, which the resolved builder no longer has. This branch's version matches the implementation that survives, and it already dies rather than skipping when the builder is missing, so it is kept whole. prove -j4 -r xCAT-test/unit passes: 212 files, 5892 tests. Signed-off-by: Daniel Hilst <392820+dhilst@users.noreply.github.com>
xCAT-test/unit
Unit tests. These run against the source tree only -- no xCAT installation, no running daemons, no management node.
They are executed on every pull request by the xcat_test GitHub Actions workflow,
which calls run_unit_tests() in github_action_xcat_test.pl:
prove -r xCAT-test/unit
You can run exactly the same thing from a clean checkout:
cd <xcat-core checkout>
prove -r xCAT-test/unit
What belongs here
A test belongs in unit/ when everything it needs is in the checkout: plugin and
library sources, kickstart/preseed/subiquity templates, postscripts, packaging
metadata. Such a test asserts on rendered output or module logic and reaches the
repository root through FindBin:
use FindBin;
use lib "$FindBin::Bin/../../perl-xCAT";
use lib "$FindBin::Bin/../../xCAT-server/lib/perl";
Because of those FindBin paths the tests only work from a source tree. The copy
installed under /opt/xcat/share/xcat/tools/autotest/unit is not a substitute --
../.. resolves to /opt/xcat/share/xcat/tools there and the tests die or silently
skip. The CI takes a copy of the checkout before the build for this reason; see
preserve_source_tree().
What does not belong here
Anything that needs an installed xCAT, a populated /install, a real service binary
or a live daemon. Those go in ../integration and run on
a management node through xcattest. Both suites run on every pull request -- the
workflow installs xCAT on the runner and then runs the ci_test cases against it --
so putting a test in integration/ does not cost it CI coverage. What differs is what
each suite is allowed to depend on, and that unit tests also run standalone from a
bare checkout with no xCAT at all.
Shell-script unit tests belong in ../bats
and run with BATS. Do not add Perl .t tests that grep shell source when the
behavior can be exercised by sourcing a shell library or script and shadowing the
external commands it calls.
The distinction matters because a test that needs an absent environment does not fail
-- it calls plan skip_all and reports as skipped. A handful of those in a suite of
several hundred assertions is easy to stop reading. Keeping the two kinds in separate
directories means a skip in unit/ is a real signal rather than routine noise.
Guarding on a source file, on the other hand, is fine and common here:
plan skip_all => "compute.subiquity.tmpl not found" unless -f $tmpl_path;
That guard never fires when the tree is intact.