90b2f5b776
SetupOCIConfigFile creates a temporary directory with os.MkDirTemp(). This means the callers need to register a deferred function to remove it again. At least one of them was commented out meaning that a /temp/katatest- directory was leftover after the unit tests ran. Change to using t.TempDir() which as well as better matching other parts of the tests means the testing framework will handle cleaning it up. Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
Kata test utilities
This package provides a small set of test utilities. See the GoDoc for full details.
Test Constraints
This package provides helper functions that accept user-specified constraints that allow you to skip tests.
Usage
Create a TestConstraint object using the NewTestConstraint() constructor.
This takes a single boolean parameter that specifies if debug output is generated.
In each test that has particular test constraints, call the NotValid()
method on the TestConstraint object, passing one or more constraints that
you want to be valid.
The NotValid() function returns true if any of the specified constraints
are not available. This allows for a more natural way to code an arbitrarily
complex test skip as shown in the following example.
The main object is created in the init() function to make it available for
all tests:
import ktu "katatestutils"
var tc ktu.TestConstraint
func init() {
tc = NewTestConstraint(true)
}
func TestFoo(t *testing.T) {
// Specify one or more constraint functions. If not satisfied, the test
// will be skipped.
if tc.NotValid(...) {
t.Skip("skipping test")
}
// Test code ...
}
Displaying the TestConstraint
Note that you could add the TestConstraint object to the Skip() call as it
will provide details of why the skip occurred:
if tc.NotValid(...) {
t.Skipf("skipping test as requirements not met: %v", tc)
}
Associating an issue with a constraint
You can add a constraint which specifies an issue URL for the skip. No
checking is performed on the issue but if specified, it will be added to the
TestConstraint and recorded in error messages and when that object is
displayed:
if tc.NotValid(WithIssue("https://github.com/kata-containers/runtime/issues/1586"), ...) {
t.Skipf("skipping test as requirements not met: %v", tc)
}
Examples
Skip tests based on user
Use the NeedRoot() constraint to skip a test unless running as root:
func TestOnlyRunWhenRoot(t *testing.T) {
if tc.NotValid(ktu.NeedRoot()) {
t.Skip("skipping test as not running as root user")
}
// Test code to run as root user ...
}
Use the NeedNonRoot() constraint to skip a test unless running as a
non-root user:
func TestOnlyRunWhenNotRoot(t *testing.T) {
if tc.NotValid(ktu.NeedNonRoot()) {
t.Skip("skipping test as running as root user")
}
// Test code to run as non-root user ...
}
Skip tests based on kernel version
Use the NeedKernelVersionGE() constraint to skip a test unless running on a
system with at least the specified kernel version:
func TestNewKernelVersion(t *testing.T) {
if tc.NotValid(ktu.NeedKernelVersionGE("5.0.10")) {
t.Skip("skipping test as kernel is too old")
}
// Test code to run on specified kernel version (or newer) ...
}
Use the NeedKernelVersionLT() constraint to skip a test unless running on a
system whose kernel is older than the specified kernel version:
func TestOldKernelVersion(t *testing.T) {
if tc.NotValid(ktu.NeedKernelVersionLT("4.14.114")) {
t.Skip("skipping test as kernel is too new")
}
// Test code to run on specified kernel version (or newer) ...
}
Full details
The public API is shown in constraints_api.go or
the GoDoc.