tests/README.tests

   1 To test a plugin using libguestfs
   2 =================================
   3
   4   - #include <test.h>
   5
   6   - Call:
   7
   8     test_start_nbdkit ("plugin", <plugin args ...>, NULL)
   9
  10     at the beginning.  This starts the nbdkit server.
  11
  12   - Open a libguestfs handle, and configure the NBD client using:
  13
  14     guestfs_add_drive_opts (g, "",
  15                             GUESTFS_ADD_DRIVE_OPTS_FORMAT, "raw",
  16                             GUESTFS_ADD_DRIVE_OPTS_PROTOCOL, "nbd",
  17                             GUESTFS_ADD_DRIVE_OPTS_SERVER, server,
  18                             -1);
  19
  20     'server' is a global that is initialized by 'test_start_nbdkit' and
  21     points to the nbdkit server socket.
  22
  23   - Perform tests via libguestfs using the libguestfs device "/dev/sda",
  24     which corresponds to the NBD drive exposed by the plugin.
  25
  26   - Close the handle and exit.  An 'atexit' handler installed by
  27     'test_start_nbdkit' cleans up the server automatically.
  28
  29 For an example, see 'test-data.c'.
  30
  31 To test a plugin using libnbd
  32 =============================
  33
  34   - Open a libnbd handle, and configure it using:
  35
  36     char *args[] = { "nbdkit", "-s", "--exit-with-parent",
  37                      "plugin", <plugin args ...>, NULL };
  38     nbd_connect_command (nbd, args);
  39
  40   - Perform tests via libnbd.
  41
  42 For an example, see 'test-delay.c'.