Daniel Hilst
6a9983abef
The pacing that keeps the install monitor alive is written inline in xcatd, and xcatd cannot be run in a unit test: it needs the database, SSL, the plugin tree and /var/run/xcat before it will start at all. So the test reached for the only thing left and matched regular expressions against the script's source -- that a respawn branch exists, that it mentions an interval, that it names a cap. Every one of those assertions passes against pacing that is subtly wrong, and none of them would notice the retry budget running out and never being refilled, which is the actual defect under review. Grepping the implementation also pins its shape, so the code cannot be rearranged without editing the test that is supposed to be guarding it. State the pacing instead as an interface a test can execute: xCAT::RespawnUtils, pure functions that take a state and a time and return the next state, with no clock, no globals and no I/O of their own. Passing the time in is what lets the schedule be checked over a virtual clock rather than in real seconds. Drive it for the delay backing off to a ceiling and holding there, for the never-give-up property (three hours into a continuous failure the daemon is still forking monitors), for the reset (a monitor that stayed up long enough to serve clears the backoff when it later dies), for the guards on a policy that could not back off, and for purity itself. Then drive it for real against a genuinely held TCP port: fail several times, release the port, and require that a respawned monitor binds it and stays up without the daemon being restarted. 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.
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.