NuKVM/libvirt
3
0
Fork 0
mirror of https://github.com/libvirt/libvirt.git synced 2025-02-25 18:55:26 -06:00
Code Issues Packages Projects Releases Wiki Activity

testutils: Document and enforce @func callback retvals for virTestMain()

Browse Source 
When a test has a wrapper over main() (e.g. because it's
preloading some mock libraries). the main() is renamed to
something else (usually mymain()), and main() is generated by
calling one of VIR_TEST_MAIN() or VIR_TEST_MAIN_PRELOAD() macros.

This has a neat side effect - if mymain() returns an error a
short summary is printed, e.g.:

  Some tests failed. Run them using:
  VIR_TEST_DEBUG=1 VIR_TEST_RANGE=5-6 ./virtest

However, this detection only works if EXIT_FAILURE is returned by
mymain(). Document and enforce this limitation.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
This commit is contained in:
Michal Privoznik 2021-05-16 18:20:56 +02:00
parent 5d99b157bc
commit 6eac856e7c
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
tests/testutils.c
View File

@ -838,6 +838,19 @@ int virTestMain(int argc,
fprintf(stderr, "%*s", 40 - (int)(testCounter % 40), ""); fprintf(stderr, "%*s", 40 - (int)(testCounter % 40), "");
fprintf(stderr, " %-3zu %s\n", testCounter, ret == 0 ? "OK" : "FAIL"); fprintf(stderr, " %-3zu %s\n", testCounter, ret == 0 ? "OK" : "FAIL");
} }
switch (ret) {
case EXIT_FAILURE:
case EXIT_SUCCESS:
case EXIT_AM_SKIP:
case EXIT_AM_HARDFAIL:
break;
default:
fprintf(stderr, "Test callback returned invalid value: %d\n", ret);
ret = EXIT_AM_HARDFAIL;
break;
}
if (ret == EXIT_FAILURE && !virBitmapIsAllClear(failedTests)) { if (ret == EXIT_FAILURE && !virBitmapIsAllClear(failedTests)) {
g_autofree char *failed = virBitmapFormat(failedTests); g_autofree char *failed = virBitmapFormat(failedTests);
fprintf(stderr, "Some tests failed. Run them using:\n"); fprintf(stderr, "Some tests failed. Run them using:\n");

4
tests/testutils.h
View File

@ -98,6 +98,10 @@ void virTestQuiesceLibvirtErrors(bool always);
void virTestCounterReset(const char *prefix); void virTestCounterReset(const char *prefix);
const char *virTestCounterNext(void); const char *virTestCounterNext(void);
/**
* The @func shall return EXIT_FAILURE or EXIT_SUCCESS or
* EXIT_AM_SKIP or EXIT_AM_HARDFAIL.
*/
int virTestMain(int argc, int virTestMain(int argc,
char **argv, char **argv,
int (*func)(void), int (*func)(void),