test/x11comp.c

   1 /*
   2  * Copyright © 2014 Ran Benita <ran234@gmail.com>
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 #include <stdio.h>
  25 #include <spawn.h>
  26 #include <unistd.h>
  27 #include <assert.h>
  28 #include <signal.h>
  29 #include <sys/types.h>
  30 #include <sys/wait.h>
  31 #include <linux/input.h>
  32
  33 #include "test.h"
  34 #include "xkbcommon/xkbcommon-x11.h"
  35
  36 int
  37 main(void)
  38 {
  39     struct xkb_context *ctx = test_get_context(0);
  40     struct xkb_keymap *keymap;
  41     xcb_connection_t *conn;
  42     int32_t device_id;
  43     int pipefds[2];
  44     int ret, status;
  45     char displayfd[128], display[128];
  46     char *search_path, *search_path_arg, *xkb_path;
  47     char *original, *dump;
  48     char *envp[] = { NULL };
  49     char *xvfb_argv[] = { "Xvfb", "-displayfd", displayfd, NULL };
  50     pid_t xvfb_pid;
  51     char *xkbcomp_argv[] = { "xkbcomp", "-I", NULL /* search_path_arg */,
  52                              NULL /* xkb_path */, display, NULL };
  53     pid_t xkbcomp_pid;
  54
  55     /*
  56      * What all of this mess does is:
  57      * 1. Launch Xvfb on the next available DISPLAY. Xvfb reports the
  58      *    display number to an fd passed with -displayfd once it's
  59      *    initialized. We pass a pipe there to read it.
  60      * 2. Make an xcb connection to this display.
  61      * 3. Launch xkbcomp to change the keymap of the new display (doing
  62      *    this programmatically is major work [which we may yet do some
  63      *    day for xkbcommon-x11] so we use xkbcomp for now).
  64      * 4. Download the keymap back from the display using xkbcommon-x11.
  65      * 5. Compare received keymap to the uploaded keymap.
  66      * 6. Kill the server & clean up.
  67      */
  68
  69     ret = pipe(pipefds);
  70     assert(ret == 0);
  71
  72     ret = snprintf(displayfd, sizeof(displayfd), "%d", pipefds[1]);
  73     assert(ret >= 0 && ret < sizeof(displayfd));
  74
  75     ret = posix_spawnp(&xvfb_pid, "Xvfb", NULL, NULL, xvfb_argv, envp);
  76     if (ret != 0) {
  77         ret = SKIP_TEST;
  78         goto err_ctx;
  79     }
  80
  81     close(pipefds[1]);
  82
  83     display[0] = ':';
  84     ret = read(pipefds[0], display + 1, sizeof(display) - 1);
  85     if (ret <= 0 || 1 + ret >= sizeof(display) - 1) {
  86         ret = SKIP_TEST;
  87         goto err_xvfd;
  88     }
  89     if (display[ret] == '\n')
  90         display[ret] = '\0';
  91     display[1 + ret] = '\0';
  92     close(pipefds[0]);
  93
  94     conn = xcb_connect(display, NULL);
  95     if (xcb_connection_has_error(conn)) {
  96         ret = SKIP_TEST;
  97         goto err_xvfd;
  98     }
  99     ret = xkb_x11_setup_xkb_extension(conn,
 100                                       XKB_X11_MIN_MAJOR_XKB_VERSION,
 101                                       XKB_X11_MIN_MINOR_XKB_VERSION,
 102                                       XKB_X11_SETUP_XKB_EXTENSION_NO_FLAGS,
 103                                       NULL, NULL, NULL, NULL);
 104     if (!ret) {
 105         ret = SKIP_TEST;
 106         goto err_xcb;
 107     }
 108     device_id = xkb_x11_get_core_keyboard_device_id(conn);
 109     assert(device_id != -1);
 110
 111     xkb_path = test_get_path("keymaps/host.xkb");
 112     search_path = test_get_path("");
 113     assert(search_path);
 114     ret = asprintf(&search_path_arg, "-I%s", search_path);
 115     assert(ret >= 0);
 116     xkbcomp_argv[2] = search_path_arg;
 117     xkbcomp_argv[3] = xkb_path;
 118     ret = posix_spawnp(&xkbcomp_pid, "xkbcomp", NULL, NULL, xkbcomp_argv, envp);
 119     free(search_path_arg);
 120     free(search_path);
 121     free(xkb_path);
 122     if (ret != 0) {
 123         ret = SKIP_TEST;
 124         goto err_xcb;
 125     }
 126     ret = waitpid(xkbcomp_pid, &status, 0);
 127     if (ret < 0 || !WIFEXITED(status) || WEXITSTATUS(status) != 0) {
 128         ret = SKIP_TEST;
 129         goto err_xcb;
 130     }
 131
 132     keymap = xkb_x11_keymap_new_from_device(ctx, conn, device_id,
 133                                             XKB_KEYMAP_COMPILE_NO_FLAGS);
 134     assert(keymap);
 135
 136     original = test_read_file("keymaps/host.xkb");
 137     assert(original);
 138
 139     dump = xkb_keymap_get_as_string(keymap, XKB_KEYMAP_USE_ORIGINAL_FORMAT);
 140     assert(dump);
 141
 142     ret = streq(original, dump);
 143     if (!ret) {
 144         fprintf(stderr,
 145                 "round-trip test failed: dumped map differs from original\n");
 146         fprintf(stderr, "length: dumped %lu, original %lu\n",
 147                 (unsigned long) strlen(dump),
 148                 (unsigned long) strlen(original));
 149         fprintf(stderr, "dumped map:\n");
 150         fprintf(stderr, "%s\n", dump);
 151         ret = 1;
 152         goto err_dump;
 153     }
 154
 155     ret = 0;
 156 err_dump:
 157     free(original);
 158     free(dump);
 159     xkb_keymap_unref(keymap);
 160 err_xcb:
 161     xcb_disconnect(conn);
 162 err_xvfd:
 163     kill(xvfb_pid, SIGTERM);
 164 err_ctx:
 165     xkb_context_unref(ctx);
 166     return ret;
 167 }