kc3-lang/libxkbcommon/test/xvfb-wrapper.c

• Show log

  Commit

• Hash : 3370ead3
  Author :
  Date : 2025-04-06T06:39:31
  

  test: Better handling of missing xkbcomp for X11 tests
  
  - meson: Warn if missing xkbcomp for X11 tests;
  - test: Better logging to spot missing Xorg executables.
  

Download

• test/xvfb-wrapper.c

• /*
   * Copyright © 2014 Ran Benita <ran234@gmail.com>
   * Copyright © 2023 Pierre Le Marre <dev@wismill.eu>
   * SPDX-License-Identifier: MIT
   */
  
  #include "config.h"
  
  #include <assert.h>
  #include <signal.h>
  #include <spawn.h>
  #include <stdio.h>
  #include <stdlib.h>
  #include <sys/types.h>
  #include <sys/wait.h>
  
  #include "test.h"
  #include "xvfb-wrapper.h"
  
  static bool xvfb_is_ready;
  
  static void
  sigusr1_handler(int signal)
  {
      xvfb_is_ready = true;
  }
  
  int
  xvfb_wrapper(int (*test_func)(char* display))
  {
      int ret = EXIT_SUCCESS;
      FILE * display_fd;
      char display_fd_string[32];
      sigset_t mask;
      struct sigaction sa;
      char *xvfb_argv[] = {
          (char *) "Xvfb", (char *) "-displayfd", display_fd_string, NULL
      };
      char *envp[] = { NULL };
      pid_t xvfb_pid = 0;
      size_t counter = 0;
      char display[32] = ":";
      size_t length;
  
      /* File descriptor to retrieve the display number */
      display_fd = tmpfile();
      if (display_fd == NULL){
          fprintf(stderr, "Unable to create temporary file.\n");
          goto err_display_fd;
      }
      snprintf(display_fd_string, sizeof(display_fd_string), "%d", fileno(display_fd));
  
      /* Set SIGUSR1 to SIG_IGN so Xvfb will send us that signal
       * when it's ready to accept connections */
      sigemptyset(&mask);
      sigaddset(&mask, SIGUSR1);
      sigprocmask(SIG_BLOCK, &mask, NULL);
      sa.sa_handler = SIG_IGN;
      sa.sa_flags = 0;
      sigemptyset(&sa.sa_mask);
      sigaction(SIGUSR1, &sa, NULL);
  
      xvfb_is_ready = false;
  
      /*
       * Xvfb command: let the server find an available display.
       *
       * Note that it may generate multiple times the following output in stderr:
       *    _XSERVTransSocketUNIXCreateListener: ...SocketCreateListener() failed
       * It is expected: this is the server trying the ports until it finds one
       * that works.
       */
      ret = posix_spawnp(&xvfb_pid, "Xvfb", NULL, NULL, xvfb_argv, envp);
      if (ret != 0) {
          fprintf(stderr,
                  "[ERROR] Cannot run Xvfb. posix_spawnp error %d: %s\n",
                  ret, strerror(ret));
          if (ret == ENOENT) {
              fprintf(stderr,
                      "[ERROR] Xvfb may be missing. "
                      "Please install the corresponding package, "
                      "e.g. \"xvfb\" or \"xorg-x11-server-Xvfb\".\n");
          }
          ret = TEST_SETUP_FAILURE;
          goto err_xvfd;
      }
  
      sa.sa_handler = SIG_DFL;
      sa.sa_flags = 0;
      sigemptyset(&sa.sa_mask);
      sigaction(SIGUSR1, &sa, NULL);
      signal(SIGUSR1, sigusr1_handler);
      sigprocmask (SIG_UNBLOCK, &mask, NULL);
  
      /* Now wait for the SIGUSR1 signal that Xvfb is ready */
      while (!xvfb_is_ready) {
          usleep(1000);
          if (++counter >= 3000) /* 3 seconds max wait */
              break;
      }
  
      signal(SIGUSR1, SIG_DFL);
  
      /* Retrieve the display number: Xvfd writes the display number as a newline-
       * terminated string; copy this number to form a proper display string. */
      fseek(display_fd, 0, SEEK_SET);
      length = fread(&display[1], 1, sizeof(display) - 1, display_fd);
      if (length <= 0) {
          fprintf(stderr, "fread error: length=%zu\n", length);
          ret = TEST_SETUP_FAILURE;
          goto err_xvfd;
      } else {
          /* Drop the newline character */
          display[length] = '\0';
      }
  
      /* Run the function requiring a running X server */
      ret = test_func(display);
  
  err_xvfd:
      if (xvfb_pid > 0)
          kill(xvfb_pid, SIGTERM);
      fclose(display_fd);
  err_display_fd:
      return ret;
  }
  
  /* All X11_TEST functions are in the test_func_sec ELF section.
   * __start and __stop point to the start and end of that section. See the
   * __attribute__(section) documentation.
   */
  DECLARE_TEST_ELF_SECTION_POINTERS(TEST_ELF_SECTION);
  
  int
  x11_tests_run(void)
  {
      int rc = 0;
      for (const struct test_function *t = &__start_test_func_sec;
           t < &__stop_test_func_sec;
           t++) {
          fprintf(stderr, "Running test: %s from %s\n", t->name, t->file);
          rc = xvfb_wrapper(t->func);
          if (rc != EXIT_SUCCESS) {
              break;
          }
      }
  
      return rc;
  }
  

Download