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
  32 #include "test.h"
  33 #include "xkbcommon/xkbcommon-x11.h"
  34
  35 int
  36 main(void)
  37 {
  38     struct xkb_context *ctx = test_get_context(0);
  39     struct xkb_keymap *keymap;
  40     xcb_connection_t *conn;
  41     int32_t device_id;
  42     int ret, status;
  43     char display[512];
  44     char *xkb_path;
  45     char *original, *dump;
  46     char *envp[] = { NULL };
  47     char *xvfb_argv[] = { "Xvfb", display, NULL };
  48     pid_t xvfb_pid;
  49     char *xkbcomp_argv[] = { "xkbcomp", "-I", NULL /* xkb_path */, display,
  50                              NULL };
  51     pid_t xkbcomp_pid;
  52
  53     char *xhost = NULL;
  54     int xdpy_current;
  55     int xdpy_candidate;
  56
  57     /*
  58      * What all of this mess does is:
  59      * 1. Launch Xvfb on available DISPLAY.
  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 = xcb_parse_display(NULL, &xhost, &xdpy_current, NULL);
  70     assert(ret != 0);
  71     /*
  72      * IANA assigns TCP port numbers from 6000 through 6063 to X11
  73      * clients.  In addition, the current XCB implementaion shows
  74      * that, when an X11 client tries to establish a TCP connetion,
  75      * the port number needed is specified by adding 6000 to a given
  76      * display number.  So, one of reasonable ranges of xdpy_candidate
  77      * is [0, 63].
  78      */
  79     for (xdpy_candidate = 63; xdpy_candidate >= 0; xdpy_candidate--) {
  80         char *buf;
  81
  82         if (xdpy_candidate == xdpy_current) {
  83             continue;
  84         }
  85         snprintf(display, sizeof(display), "%s:%d", xhost, xdpy_candidate);
  86         ret = posix_spawnp(&xvfb_pid, "Xvfb", NULL, NULL, xvfb_argv, envp);
  87         if (ret == 0) {
  88             break;
  89         }
  90     }
  91     free(xhost);
  92     if (ret != 0) {
  93         ret = SKIP_TEST;
  94         goto err_ctx;
  95     }
  96
  97     /* Wait for Xvfb fully waking up to accept a connection from a client. */
  98     sleep(1);
  99
 100     conn = xcb_connect(display, NULL);
 101     if (xcb_connection_has_error(conn)) {
 102         ret = SKIP_TEST;
 103         goto err_xvfd;
 104     }
 105     ret = xkb_x11_setup_xkb_extension(conn,
 106                                       XKB_X11_MIN_MAJOR_XKB_VERSION,
 107                                       XKB_X11_MIN_MINOR_XKB_VERSION,
 108                                       XKB_X11_SETUP_XKB_EXTENSION_NO_FLAGS,
 109                                       NULL, NULL, NULL, NULL);
 110     if (!ret) {
 111         ret = SKIP_TEST;
 112         goto err_xcb;
 113     }
 114     device_id = xkb_x11_get_core_keyboard_device_id(conn);
 115     assert(device_id != -1);
 116
 117     xkb_path = test_get_path("keymaps/host.xkb");
 118     assert(ret >= 0);
 119     xkbcomp_argv[2] = xkb_path;
 120     ret = posix_spawnp(&xkbcomp_pid, "xkbcomp", NULL, NULL, xkbcomp_argv, envp);
 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     if (!streq(original, dump)) {
 143         fprintf(stderr,
 144                 "round-trip test failed: dumped map differs from original\n");
 145         fprintf(stderr, "length: dumped %lu, original %lu\n",
 146                 (unsigned long) strlen(dump),
 147                 (unsigned long) strlen(original));
 148         fprintf(stderr, "dumped map:\n");
 149         fprintf(stderr, "%s\n", dump);
 150         ret = 1;
 151         goto err_dump;
 152     }
 153
 154     ret = 0;
 155 err_dump:
 156     free(original);
 157     free(dump);
 158     xkb_keymap_unref(keymap);
 159 err_xcb:
 160     xcb_disconnect(conn);
 161 err_xvfd:
 162     kill(xvfb_pid, SIGTERM);
 163 err_ctx:
 164     xkb_context_unref(ctx);
 165     return ret;
 166 }