debian: Note that libconfig-dev ought to be required.
[libguestfs.git] / test-tool / test-tool.c
1 /* libguestfs-test-tool
2  * Copyright (C) 2009-2011 Red Hat Inc.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <config.h>
20
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <stdint.h>
24 #include <inttypes.h>
25 #include <string.h>
26 #include <fcntl.h>
27 #include <unistd.h>
28 #include <getopt.h>
29 #include <sys/types.h>
30 #include <sys/stat.h>
31 #include <sys/wait.h>
32 #include <locale.h>
33 #include <limits.h>
34
35 #include <guestfs.h>
36
37 #ifdef HAVE_GETTEXT
38 #include "gettext.h"
39 #define _(str) dgettext(PACKAGE, (str))
40 //#define N_(str) dgettext(PACKAGE, (str))
41 #else
42 #define _(str) str
43 //#define N_(str) str
44 #endif
45
46 #if !ENABLE_NLS
47 #undef textdomain
48 #define textdomain(Domainname) /* empty */
49 #undef bindtextdomain
50 #define bindtextdomain(Domainname, Dirname) /* empty */
51 #endif
52
53 #define STREQ(a,b) (strcmp((a),(b)) == 0)
54 //#define STRCASEEQ(a,b) (strcasecmp((a),(b)) == 0)
55 //#define STRNEQ(a,b) (strcmp((a),(b)) != 0)
56 //#define STRCASENEQ(a,b) (strcasecmp((a),(b)) != 0)
57 #define STREQLEN(a,b,n) (strncmp((a),(b),(n)) == 0)
58 //#define STRCASEEQLEN(a,b,n) (strncasecmp((a),(b),(n)) == 0)
59 //#define STRNEQLEN(a,b,n) (strncmp((a),(b),(n)) != 0)
60 //#define STRCASENEQLEN(a,b,n) (strncasecmp((a),(b),(n)) != 0)
61 //#define STRPREFIX(a,b) (strncmp((a),(b),strlen((b))) == 0)
62
63 #ifndef P_tmpdir
64 #define P_tmpdir "/tmp"
65 #endif
66
67 #define DEFAULT_TIMEOUT 120
68
69 static int timeout = DEFAULT_TIMEOUT;
70 static char tmpf[] = P_tmpdir "/libguestfs-test-tool-sda-XXXXXX";
71 static guestfs_h *g;
72
73 static void make_files (void);
74 static void set_qemu (const char *path, int use_wrapper);
75
76 static void
77 usage (void)
78 {
79   printf (_("libguestfs-test-tool: interactive test tool\n"
80             "Copyright (C) 2009-2011 Red Hat Inc.\n"
81             "Usage:\n"
82             "  libguestfs-test-tool [--options]\n"
83             "Options:\n"
84             "  --help         Display usage\n"
85             "  --qemudir dir  Specify QEMU source directory\n"
86             "  --qemu qemu    Specify QEMU binary\n"
87             "  --timeout n\n"
88             "  -t n           Set launch timeout (default: %d seconds)\n"
89             ),
90           DEFAULT_TIMEOUT);
91 }
92
93 extern char **environ;
94
95 int
96 main (int argc, char *argv[])
97 {
98   setlocale (LC_ALL, "");
99   bindtextdomain (PACKAGE, LOCALEBASEDIR);
100   textdomain (PACKAGE);
101
102   static const char *options = "t:?";
103   static const struct option long_options[] = {
104     { "help", 0, 0, '?' },
105     { "qemu", 1, 0, 0 },
106     { "qemudir", 1, 0, 0 },
107     { "timeout", 1, 0, 't' },
108     { 0, 0, 0, 0 }
109   };
110   int c;
111   int option_index;
112   int i;
113   struct guestfs_version *vers;
114
115   for (;;) {
116     c = getopt_long (argc, argv, options, long_options, &option_index);
117     if (c == -1) break;
118
119     switch (c) {
120     case 0:                     /* options which are long only */
121       if (STREQ (long_options[option_index].name, "qemu"))
122         set_qemu (optarg, 0);
123       else if (STREQ (long_options[option_index].name, "qemudir"))
124         set_qemu (optarg, 1);
125       else {
126         fprintf (stderr,
127                  _("libguestfs-test-tool: unknown long option: %s (%d)\n"),
128                  long_options[option_index].name, option_index);
129         exit (EXIT_FAILURE);
130       }
131       break;
132
133     case 't':
134       if (sscanf (optarg, "%d", &timeout) != 1 || timeout < 0) {
135         fprintf (stderr,
136                  _("libguestfs-test-tool: invalid timeout: %s\n"),
137                  optarg);
138         exit (EXIT_FAILURE);
139       }
140       break;
141
142     case '?':
143       usage ();
144       exit (EXIT_SUCCESS);
145
146     default:
147       fprintf (stderr,
148                _("libguestfs-test-tool: unexpected command line option 0x%x\n"),
149                c);
150       exit (EXIT_FAILURE);
151     }
152   }
153
154   make_files ();
155
156   printf ("===== Test starts here =====\n");
157
158   /* Must set LIBGUESTFS_DEBUG=1 */
159   setenv ("LIBGUESTFS_DEBUG", "1", 1);
160
161   /* Print out any environment variables which may relate to this test. */
162   for (i = 0; environ[i] != NULL; ++i)
163     if (STREQLEN (environ[i], "LIBGUESTFS_", 11))
164       printf ("%s\n", environ[i]);
165
166   /* Create the handle and configure it. */
167   g = guestfs_create ();
168   if (g == NULL) {
169     fprintf (stderr,
170              _("libguestfs-test-tool: failed to create libguestfs handle\n"));
171     exit (EXIT_FAILURE);
172   }
173   if (guestfs_add_drive_opts (g, tmpf,
174                               GUESTFS_ADD_DRIVE_OPTS_FORMAT, "raw",
175                               -1) == -1) {
176     fprintf (stderr,
177              _("libguestfs-test-tool: failed to add drive '%s'\n"),
178              tmpf);
179     exit (EXIT_FAILURE);
180   }
181
182   /* Print any version info etc. */
183   vers = guestfs_version (g);
184   if (vers == NULL) {
185     fprintf (stderr, _("libguestfs-test-tool: guestfs_version failed\n"));
186     exit (EXIT_FAILURE);
187   }
188   printf ("library version: %"PRIi64".%"PRIi64".%"PRIi64"%s\n",
189           vers->major, vers->minor, vers->release, vers->extra);
190   guestfs_free_version (vers);
191
192   printf ("guestfs_get_append: %s\n", guestfs_get_append (g) ? : "(null)");
193   printf ("guestfs_get_attach_method: %s\n",
194           guestfs_get_attach_method (g) ? : "(null)");
195   printf ("guestfs_get_autosync: %d\n", guestfs_get_autosync (g));
196   printf ("guestfs_get_direct: %d\n", guestfs_get_direct (g));
197   printf ("guestfs_get_memsize: %d\n", guestfs_get_memsize (g));
198   printf ("guestfs_get_network: %d\n", guestfs_get_network (g));
199   printf ("guestfs_get_path: %s\n", guestfs_get_path (g));
200   printf ("guestfs_get_qemu: %s\n", guestfs_get_qemu (g));
201   printf ("guestfs_get_recovery_proc: %d\n",
202           guestfs_get_recovery_proc (g));
203   printf ("guestfs_get_selinux: %d\n", guestfs_get_selinux (g));
204   printf ("guestfs_get_trace: %d\n", guestfs_get_trace (g));
205   printf ("guestfs_get_verbose: %d\n", guestfs_get_verbose (g));
206
207   printf ("host_cpu: %s\n", host_cpu);
208
209   /* Launch the guest handle. */
210   printf ("Launching appliance, timeout set to %d seconds.\n", timeout);
211   fflush (stdout);
212
213   alarm (timeout);
214
215   if (guestfs_launch (g) == -1) {
216     fprintf (stderr,
217              _("libguestfs-test-tool: failed to launch appliance\n"));
218     exit (EXIT_FAILURE);
219   }
220
221   alarm (0);
222
223   printf ("Guest launched OK.\n");
224   fflush (stdout);
225
226   /* Create the filesystem and mount everything. */
227   if (guestfs_part_disk (g, "/dev/sda", "mbr") == -1) {
228     fprintf (stderr,
229              _("libguestfs-test-tool: failed to run part-disk\n"));
230     exit (EXIT_FAILURE);
231   }
232
233   if (guestfs_mkfs (g, "ext2", "/dev/sda1") == -1) {
234     fprintf (stderr,
235              _("libguestfs-test-tool: failed to mkfs.ext2\n"));
236     exit (EXIT_FAILURE);
237   }
238
239   if (guestfs_mount_options (g, "", "/dev/sda1", "/") == -1) {
240     fprintf (stderr,
241              _("libguestfs-test-tool: failed to mount /dev/sda1 on /\n"));
242     exit (EXIT_FAILURE);
243   }
244
245   /* Touch a file. */
246   if (guestfs_touch (g, "/hello") == -1) {
247     fprintf (stderr,
248              _("libguestfs-test-tool: failed to touch file\n"));
249     exit (EXIT_FAILURE);
250   }
251
252   /* Booted and performed some simple operations -- success! */
253   printf ("===== TEST FINISHED OK =====\n");
254   exit (EXIT_SUCCESS);
255 }
256
257 static char qemuwrapper[] = P_tmpdir "/libguestfs-test-tool-wrapper-XXXXXX";
258
259 static void
260 cleanup_wrapper (void)
261 {
262   unlink (qemuwrapper);
263 }
264
265 /* Handle the --qemu and --qemudir parameters.  use_wrapper is true
266  * in the --qemudir (source directory) case, where we have to create
267  * a wrapper shell script.
268  */
269 static void
270 set_qemu (const char *path, int use_wrapper)
271 {
272   char buffer[PATH_MAX];
273   struct stat statbuf;
274   int fd;
275   FILE *fp;
276
277   if (getenv ("LIBGUESTFS_QEMU")) {
278     fprintf (stderr,
279     _("LIBGUESTFS_QEMU environment variable is already set, so\n"
280       "--qemu/--qemudir options cannot be used.\n"));
281     exit (EXIT_FAILURE);
282   }
283
284   if (!use_wrapper) {
285     if (access (path, X_OK) == -1) {
286       fprintf (stderr,
287                _("Binary '%s' does not exist or is not executable\n"),
288                path);
289       exit (EXIT_FAILURE);
290     }
291
292     setenv ("LIBGUESTFS_QEMU", path, 1);
293     return;
294   }
295
296   /* This should be a source directory, so check it. */
297   snprintf (buffer, sizeof buffer, "%s/pc-bios", path);
298   if (stat (buffer, &statbuf) == -1 ||
299       !S_ISDIR (statbuf.st_mode)) {
300     fprintf (stderr,
301              _("%s: does not look like a qemu source directory\n"),
302              path);
303     exit (EXIT_FAILURE);
304   }
305
306   /* Make a wrapper script. */
307   fd = mkstemp (qemuwrapper);
308   if (fd == -1) {
309     perror (qemuwrapper);
310     exit (EXIT_FAILURE);
311   }
312
313   fchmod (fd, 0700);
314
315   fp = fdopen (fd, "w");
316   fprintf (fp,
317            "#!/bin/sh -\n"
318            "qemudir='%s'\n"
319            "\"$qemudir\"/",
320            path);
321
322   /* Select the right qemu binary for the wrapper script. */
323 #ifdef __i386__
324   fprintf (fp, "i386-softmmu/qemu");
325 #else
326   fprintf (fp, host_cpu "-softmmu/qemu-system-" host_cpu);
327 #endif
328
329   fprintf (fp, " -L \"$qemudir\"/pc-bios \"$@\"\n");
330
331   fclose (fp);
332
333   setenv ("LIBGUESTFS_QEMU", qemuwrapper, 1);
334   atexit (cleanup_wrapper);
335 }
336
337 static void
338 cleanup_tmpfiles (void)
339 {
340   unlink (tmpf);
341 }
342
343 static void
344 make_files (void)
345 {
346   int fd;
347
348   /* Allocate the sparse file for /dev/sda. */
349   fd = mkstemp (tmpf);
350   if (fd == -1) {
351     perror (tmpf);
352     exit (EXIT_FAILURE);
353   }
354
355   if (lseek (fd, 100 * 1024 * 1024 - 1, SEEK_SET) == -1) {
356     perror ("lseek");
357     close (fd);
358     unlink (tmpf);
359     exit (EXIT_FAILURE);
360   }
361
362   if (write (fd, "\0", 1) == -1) {
363     perror ("write");
364     close (fd);
365     unlink (tmpf);
366     exit (EXIT_FAILURE);
367   }
368
369   close (fd);
370
371   atexit (cleanup_tmpfiles);    /* Removes tmpf. */
372 }