path: root/gtest/test/xserver-test.cpp

#include <errno.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/wait.h>
#include <fstream>
#include <stdexcept>

#include <xorg/gtest/xorg-gtest.h>
#include <gtest/gtest-spi.h>
#include <X11/extensions/XInput2.h>

#if defined __GNUC__ || defined __clang__
#define XORG_GTEST_UNUSED __attribute__((unused))
#else
#define XORG_GTEST_UNUSED
#endif

using namespace xorg::testing;

TEST(XServer, LogRemoval)
{
  XORG_TESTCASE("X server startup and log file removal on success and error");
  std::string logfile = LOGFILE_DIR "/xorg-testing-xserver_____________.log";

  /* make sure a previous failed test didn't leave it around */
  unlink(logfile.c_str());

  XServer server;
  server.SetOption("-logfile", logfile);
  server.SetOption("-config", DUMMY_CONF_PATH);
  server.Start();
  server.Terminate(3000);
  server.RemoveLogFile();

  std::ifstream file(logfile.c_str());
  ASSERT_FALSE(file.good());
  file.close();

  server.SetOption("-doesnotexist", "");
  server.Start();
  while (server.GetState() == Process::RUNNING)
    usleep(5000);

  ASSERT_EQ(server.GetState(), Process::FINISHED_FAILURE);
  file.open(logfile.c_str());
  ASSERT_FALSE(file.good()); /* server didn't leave the file behind */

  /* now create it */
  std::ofstream f(logfile.c_str());
  file.open(logfile.c_str());
  ASSERT_TRUE(file.good());
  file.close();

  /* must not remove it now */
  server.RemoveLogFile();

  file.open(logfile.c_str());
  ASSERT_TRUE(file.good()); /* server didn't remove it */
  file.close();

  server.RemoveLogFile(true);
  file.open(logfile.c_str());
  ASSERT_FALSE(file.good()); /* server did remove it */
  file.close();
}

TEST(XServer, WaitForSIGUSR1)
{
  XORG_TESTCASE("XOpenDisplay() following server.Start() must\n"
                "succeed as we wait for the SIGUSR1 signal\n");
  for (int i = 0; i < 20; i++) {
    XServer server;
    server.SetOption("-logfile", LOGFILE_DIR "/xorg-testing-xserver-sigusr1.log");
    server.SetOption("-config", DUMMY_CONF_PATH);
    server.SetOption("-noreset", "");
    server.Start();
    ASSERT_EQ(server.GetState(), Process::RUNNING);
    Display *dpy = XOpenDisplay(server.GetDisplayString().c_str());
    ASSERT_TRUE(dpy != nullptr);
    XCloseDisplay(dpy);
    server.Terminate(500);
  }
}

static void assert_masks_equal(Display *dpy)
{
  int nmasks_before;
  XIEventMask *masks_before;
  int nmasks_after;
  XIEventMask *masks_after;

  masks_before = XIGetSelectedEvents(dpy, DefaultRootWindow(dpy), &nmasks_before);
  XServer::WaitForDevice(dpy, "not actually waiting for device", 1);
  masks_after = XIGetSelectedEvents(dpy, DefaultRootWindow(dpy), &nmasks_after);

  ASSERT_EQ(nmasks_before, nmasks_after);

  for (int i = 0; i < nmasks_before; i++) {
    ASSERT_EQ(masks_before[i].deviceid, masks_after[i].deviceid);
    ASSERT_EQ(masks_before[i].mask_len, masks_after[i].mask_len);
    ASSERT_EQ(memcmp(masks_before[i].mask, masks_after[i].mask, masks_before[i].mask_len), 0);
  }

  XFree(masks_before);
  XFree(masks_after);

}

TEST(XServer, WaitForDeviceEventMask)
{
  XORG_TESTCASE("The event mask is left as-is by WaitForDevice");

  XServer server;
  server.SetOption("-logfile", LOGFILE_DIR "/Xorg-WaitForDevice.log");
  server.SetOption("-config", DUMMY_CONF_PATH);
  server.SetOption("-noreset", "");
  server.Start();
  ASSERT_EQ(server.GetState(), Process::RUNNING);
  ::Display *dpy = XOpenDisplay(server.GetDisplayString().c_str());
  ASSERT_TRUE(dpy != nullptr);
  int major = 2, minor = 0;
  XIQueryVersion(dpy, &major, &minor);

  /* empty mask */
  assert_masks_equal(dpy);

  /* device specific mask */
  XIEventMask m;
  m.deviceid = 2;
  m.mask_len = 1;
  m.mask = new unsigned char[m.mask_len]();
  XISetMask(m.mask, XI_Motion);
  XISelectEvents(dpy, DefaultRootWindow(dpy), &m, 1);

  assert_masks_equal(dpy);
  delete m.mask;

  /* XIAllDevices mask with short mask */
  m.deviceid = XIAllDevices;
  m.mask_len = 1;
  m.mask = new unsigned char[m.mask_len]();
  XISetMask(m.mask, XI_Motion);
  XISelectEvents(dpy, DefaultRootWindow(dpy), &m, 1);

  assert_masks_equal(dpy);
  delete m.mask;

  /* XIAllDevices mask with hierarchy bit not set */
  m.deviceid = XIAllDevices;
  m.mask_len = XIMaskLen(XI_HierarchyChanged);
  m.mask = new unsigned char[m.mask_len]();
  XISetMask(m.mask, XI_Motion);
  XISelectEvents(dpy, DefaultRootWindow(dpy), &m, 1);

  assert_masks_equal(dpy);
  delete m.mask;

  /* XIAllDevices mask with hierarchy bit set */
  m.deviceid = XIAllDevices;
  m.mask_len = XIMaskLen(XI_HierarchyChanged);
  m.mask = new unsigned char[m.mask_len]();
  XISetMask(m.mask, XI_HierarchyChanged);
  XISelectEvents(dpy, DefaultRootWindow(dpy), &m, 1);

  assert_masks_equal(dpy);
  delete m.mask;
}

TEST(XServer, IOErrorException)
{
  ASSERT_THROW({
  XServer server;
  server.SetOption("-logfile", LOGFILE_DIR "/xorg-io-error-test.log");
  server.SetOption("-config", DUMMY_CONF_PATH);
  server.SetOption("-noreset", "");
  server.Start();
  ASSERT_EQ(server.GetState(), Process::RUNNING);
  ::Display *dpy = XOpenDisplay(server.GetDisplayString().c_str());
  ASSERT_TRUE(dpy != nullptr);
  close(ConnectionNumber(dpy));
  XSync(dpy, False);
  }, XIOError);
}

TEST(XServer, ErrorHandler)
{
  XORG_TESTCASE("Start a server, trigger a BadColor error and expect a "
                 "failure from the default error handler\n");

  pid_t pid = fork();

  if (pid == 0) {
    EXPECT_NONFATAL_FAILURE({
      XServer server;
      server.SetOption("-logfile", LOGFILE_DIR "/xorg-error-handler-test.log");
      server.SetOption("-config", DUMMY_CONF_PATH);
      server.SetOption("-noreset", "");
      server.Start();
      ASSERT_EQ(server.GetState(), Process::RUNNING);
      ::Display *dpy = XOpenDisplay(server.GetDisplayString().c_str());
      ASSERT_TRUE(dpy != nullptr);
      XColor color;
      XQueryColor(dpy, 0, &color);
      XSync(dpy, False);
    }, "BadColor");
    exit(0);
  }

  /* if the Xlib default error handler triggers, child calls exit(1) */
  int status;
  ASSERT_EQ(waitpid(pid, &status, 0), pid);
  ASSERT_TRUE(WIFEXITED(status));
  ASSERT_EQ(WEXITSTATUS(status), 0);
}

static bool error_handler_triggered = false;

static int _test_error_handler(XORG_GTEST_UNUSED Display *dpy, XErrorEvent *error) {
  error_handler_triggered = true;
  if (error->error_code != BadColor)
    ADD_FAILURE() << "Error handler triggered with wrong error code\n";
  return 0;
}

TEST(XServer, NondefaultErrorHandler)
{
  XORG_TESTCASE("Set a custom error handler, start a server, trigger a "
                "BadColor error and expect the custom error handler to be "
                "triggered\n");

  pid_t pid = fork();

  if (pid == 0) {
    XErrorHandler old_handler;
    old_handler = XSetErrorHandler(_test_error_handler);

    XServer server;
    server.SetOption("-logfile", LOGFILE_DIR "/xorg-error-handler-test.log");
    server.SetOption("-config", DUMMY_CONF_PATH);
    server.SetOption("-noreset", "");
    server.Start();
    ASSERT_EQ(server.GetState(), Process::RUNNING);
    ::Display *dpy = XOpenDisplay(server.GetDisplayString().c_str());
    ASSERT_TRUE(dpy != nullptr);
    XColor color;
    XQueryColor(dpy, 0, &color);
    XSync(dpy, False);
    XSetErrorHandler(old_handler);
    exit(error_handler_triggered ? 0 : 1);
  }

  /* if the Xlib default error handler triggers, child calls exit(1) */
  int status;
  ASSERT_EQ(waitpid(pid, &status, 0), pid);
  ASSERT_TRUE(WIFEXITED(status));
  ASSERT_EQ(WEXITSTATUS(status), 0);
}

TEST(XServer, KeepAlive)
{
  XORG_TESTCASE("If XORG_GTEST_XSERVER_KEEPALIVE is set,\n"
                "XServer::Terminate() and XServer::Kill() have no "
                "effect");

  int pipefd[2];
  ASSERT_NE(pipe(pipefd), -1);

  if (fork() == 0) {
    close(pipefd[0]);

    ASSERT_EQ(setenv("XORG_GTEST_XSERVER_KEEPALIVE", "1", 1), 0);
    ASSERT_TRUE(getenv("XORG_GTEST_XSERVER_KEEPALIVE") != nullptr);

    XServer server;
    server.SetOption("-logfile", LOGFILE_DIR "/Xorg-keepalive.log");
    server.SetOption("-config", DUMMY_CONF_PATH);
    server.SetOption("-noreset", "");
    server.Start();
    ASSERT_EQ(server.GetState(), Process::RUNNING);
    ::Display *dpy = XOpenDisplay(server.GetDisplayString().c_str());
    ASSERT_TRUE(dpy != nullptr);

    server.Terminate();
    ASSERT_EQ(server.GetState(), Process::RUNNING);
    server.Kill();
    ASSERT_EQ(server.GetState(), Process::RUNNING);

    unsetenv("XORG_GTEST_XSERVER_KEEPALIVE");

    char *buffer;
    ASSERT_GT(asprintf(&buffer, "%d", server.Pid()), 0);
    ASSERT_EQ(write(pipefd[1], buffer, strlen(buffer)), static_cast<int>(strlen(buffer)));
    close(pipefd[1]);
    free(buffer);
    exit(0);
  }

  sigset_t sig_mask;
  sigemptyset(&sig_mask);
  sigaddset(&sig_mask, SIGCHLD);
  struct timespec tv = { 1, 0 };
  sigprocmask(SIG_BLOCK, &sig_mask, nullptr);

  /* parent */
  close(pipefd[1]);

  char buffer[20] = {0};
  ASSERT_GT(read(pipefd[0], buffer, sizeof(buffer)), 0);
  close(pipefd[0]);

  /* wait for forked child to die */
  ASSERT_EQ(sigtimedwait(&sig_mask, nullptr, &tv), SIGCHLD);

  pid_t server_pid = atoi(buffer);

  /* server must still be running, kill it */
  ASSERT_EQ(kill(server_pid, 0), 0);
  kill(server_pid, SIGTERM);

  int i = 0;

  while(kill(server_pid, 0) == 0 && i++ < 10)
    usleep(50000);

  ASSERT_EQ(kill(server_pid, 0), -1);
  ASSERT_EQ(errno, ESRCH);
}

TEST(XServer, RemoveOption)
{
  int i = 0;
  XServer server;
  server.SetOption("-fail", "yes");
  server.SetOption("-logfile", LOGFILE_DIR "/Xorg-remove-option.log");
  server.Start(TEST_BUILD_DIR "/xserver-test-helper");

  while(i++ < 10 && server.GetState() == Process::RUNNING)
    usleep(50000);

  ASSERT_EQ(server.GetState(), Process::FINISHED_FAILURE);

  server.RemoveOption("-fail");
  server.Start(TEST_BUILD_DIR "/xserver-test-helper");
  ASSERT_EQ(server.GetState(), Process::FINISHED_SUCCESS);
}

int main(int argc, char *argv[]) {
  testing::InitGoogleTest(&argc, argv);
  return RUN_ALL_TESTS();
}