tests: Add MetaMonitorConfigStore tests

Add tests that check that a XML configuration file results in correct
MetaMonitorsConfig objects.

https://bugzilla.gnome.org/show_bug.cgi?id=777732

src/Makefile-tests.am

@@ -38,6 +38,8 @@ mutter_test_unit_tests_SOURCES = \
 	tests/meta-backend-test.h \
 	tests/meta-monitor-manager-test.c \
 	tests/meta-monitor-manager-test.h \
+	tests/monitor-store-unit-tests.c \
+	tests/monitor-store-unit-tests.h \
 	tests/monitor-unit-tests.c \
 	tests/monitor-unit-tests.h \
 	$(NULL)

src/tests/monitor-configs/single.xml

@@ -0,0 +1,22 @@
+<monitors version="2">
+  <configuration>
+    <logicalmonitor>
+      <x>0</x>
+      <y>0</y>
+      <primary>yes</primary>
+      <monitor>
+	<monitorspec>
+	  <connector>DP-1</connector>
+	  <vendor>MetaProduct's Inc.</vendor>
+	  <product>MetaMonitor</product>
+	  <serial>0x123456</serial>
+	</monitorspec>
+	<mode>
+	  <width>1920</width>
+	  <height>1080</height>
+	  <rate>60.000495910644531</rate>
+	</mode>
+      </monitor>
+    </logicalmonitor>
+  </configuration>
+</monitors>

src/tests/monitor-store-unit-tests.c

@@ -0,0 +1,279 @@
+/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
+
+/*
+ * Copyright (C) 2016 Red Hat, Inc.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "config.h"
+
+#include "tests/monitor-store-unit-tests.h"
+
+#include "backends/meta-backend-private.h"
+#include "backends/meta-monitor-config-store.h"
+#include "backends/meta-monitor-config-manager.h"
+#include "backends/meta-monitor-manager-private.h"
+
+#define MAX_N_MONITORS 10
+#define MAX_N_LOGICAL_MONITORS 10
+#define MAX_N_CONFIGURATIONS 10
+
+typedef struct _MonitorTestCaseMonitorMode
+{
+  int width;
+  int height;
+  float refresh_rate;
+} MonitorTestCaseMonitorMode;
+
+typedef struct _MonitorTestCaseMonitor
+{
+  const char *connector;
+  const char *vendor;
+  const char *product;
+  const char *serial;
+  MonitorTestCaseMonitorMode mode;
+} MonitorTestCaseMonitor;
+
+typedef struct _MonitorTestCaseLogicalMonitor
+{
+  MetaRectangle layout;
+  MonitorTestCaseMonitor monitors[MAX_N_MONITORS];
+  int n_monitors;
+} MonitorTestCaseLogicalMonitor;
+
+typedef struct _MonitorStoreTestConfiguration
+{
+  MonitorTestCaseLogicalMonitor logical_monitors[MAX_N_LOGICAL_MONITORS];
+  int n_logical_monitors;
+} MonitorStoreTestConfiguration;
+
+typedef struct _MonitorStoreTestExpect
+{
+  MonitorStoreTestConfiguration configurations[MAX_N_CONFIGURATIONS];
+  int n_configurations;
+} MonitorStoreTestExpect;
+
+static MetaMonitorConfigStore *
+get_monitor_config_store (void)
+{
+  MetaBackend *backend = meta_get_backend ();
+  MetaMonitorManager *monitor_manager =
+    meta_backend_get_monitor_manager (backend);
+  MetaMonitorConfigManager *config_manager = monitor_manager->config_manager;
+
+  if (!config_manager)
+    return NULL;
+
+  return meta_monitor_config_manager_get_store (config_manager);
+}
+
+static const char *
+get_monitor_test_file (const char *filename)
+{
+  return g_test_get_filename (G_TEST_DIST, "tests", "monitor-configs",
+                              filename, NULL);
+}
+
+static void
+set_custom_test_file (MetaMonitorConfigStore *config_store,
+                      const char             *filename)
+{
+  const char *path;
+  GError *error = NULL;
+
+  path = get_monitor_test_file (filename);
+  g_assert (path);
+
+  if (!meta_monitor_config_store_set_custom (config_store, path, &error))
+    {
+      g_error ("Failed to set custom monitors config: %s", error->message);
+      g_assert_not_reached ();
+    }
+}
+
+static MetaMonitorsConfigKey *
+create_config_key_from_expect (MonitorStoreTestConfiguration *expect_config)
+{
+  MetaMonitorsConfigKey *config_key;
+  GList *monitor_specs;
+  int i;
+
+  monitor_specs = NULL;
+  for (i = 0; i < expect_config->n_logical_monitors; i++)
+    {
+      int j;
+
+      for (j = 0; j < expect_config->logical_monitors[i].n_monitors; j++)
+        {
+          MetaMonitorSpec *monitor_spec;
+          MonitorTestCaseMonitor *test_monitor =
+            &expect_config->logical_monitors[i].monitors[j];
+
+          monitor_spec = g_new0 (MetaMonitorSpec, 1);
+
+          monitor_spec->connector = g_strdup (test_monitor->connector);
+          monitor_spec->vendor = g_strdup (test_monitor->vendor);
+          monitor_spec->product = g_strdup (test_monitor->product);
+          monitor_spec->serial = g_strdup (test_monitor->serial);
+
+          monitor_specs = g_list_prepend (monitor_specs, monitor_spec);
+        }
+    }
+
+  g_assert_nonnull (monitor_specs);
+
+  monitor_specs = g_list_sort (monitor_specs,
+                               (GCompareFunc) meta_monitor_spec_compare);
+
+  config_key = g_new0 (MetaMonitorsConfigKey, 1);
+  *config_key = (MetaMonitorsConfigKey) {
+    .monitor_specs = monitor_specs
+  };
+
+  return config_key;
+}
+
+static void
+check_monitor_configuration (MetaMonitorConfigStore        *config_store,
+                             MonitorStoreTestConfiguration *config_expect)
+{
+  MetaMonitorsConfigKey *config_key;
+  MetaMonitorsConfig *config;
+  GList *l;
+  int i;
+
+  config_key = create_config_key_from_expect (config_expect);
+  config = meta_monitor_config_store_lookup (config_store, config_key);
+  g_assert_nonnull (config);
+
+  g_assert (meta_monitors_config_key_equal (config->key, config_key));
+  meta_monitors_config_key_free (config_key);
+
+  g_assert_cmpuint (g_list_length (config->logical_monitor_configs),
+                    ==,
+                    config_expect->n_logical_monitors);
+
+  for (l = config->logical_monitor_configs, i = 0; l; l = l->next, i++)
+    {
+      MetaLogicalMonitorConfig *logical_monitor_config = l->data;
+      GList *k;
+      int j;
+
+      g_assert (meta_rectangle_equal (&logical_monitor_config->layout,
+                                      &config_expect->logical_monitors[i].layout));
+
+      for (k = logical_monitor_config->monitor_configs, j = 0;
+           k;
+           k = k->next, j++)
+        {
+          MetaMonitorConfig *monitor_config = k->data;
+          MonitorTestCaseMonitor *test_monitor =
+            &config_expect->logical_monitors[i].monitors[j];
+
+          g_assert_cmpstr (monitor_config->monitor_spec->connector,
+                           ==,
+                           test_monitor->connector);
+          g_assert_cmpstr (monitor_config->monitor_spec->vendor,
+                           ==,
+                           test_monitor->vendor);
+          g_assert_cmpstr (monitor_config->monitor_spec->product,
+                           ==,
+                           test_monitor->product);
+          g_assert_cmpstr (monitor_config->monitor_spec->serial,
+                           ==,
+                           test_monitor->serial);
+
+          g_assert_cmpint (monitor_config->mode_spec->width,
+                           ==,
+                           test_monitor->mode.width);
+          g_assert_cmpint (monitor_config->mode_spec->height,
+                           ==,
+                           test_monitor->mode.height);
+          g_assert_cmpfloat (monitor_config->mode_spec->refresh_rate,
+                             ==,
+                             test_monitor->mode.refresh_rate);
+        }
+    }
+}
+
+static void
+check_monitor_configurations (MetaMonitorConfigStore *config_store,
+                              MonitorStoreTestExpect *expect)
+{
+  int i;
+
+  g_assert_cmpint (meta_monitor_config_store_get_config_count (config_store),
+                   ==,
+                   expect->n_configurations);
+
+  for (i = 0; i < expect->n_configurations; i++)
+    check_monitor_configuration (config_store, &expect->configurations[i]);
+}
+
+static void
+meta_test_monitor_store_single (void)
+{
+  MetaMonitorConfigStore *config_store;
+  MonitorStoreTestExpect expect = {
+    .configurations = {
+      {
+        .logical_monitors = {
+          {
+            .layout = {
+              .x = 0,
+              .y = 0,
+              .width = 1920,
+              .height = 1080
+            },
+            .monitors = {
+              {
+                .connector = "DP-1",
+                .vendor = "MetaProduct's Inc.",
+                .product = "MetaMonitor",
+                .serial = "0x123456",
+                .mode = {
+                  .width = 1920,
+                  .height = 1080,
+                  .refresh_rate = 60.000495910644531
+                }
+              }
+            },
+            .n_monitors = 1,
+          }
+        },
+        .n_logical_monitors = 1
+      }
+    },
+    .n_configurations = 1
+  };
+
+  config_store = get_monitor_config_store ();
+  if (!config_store)
+    {
+      g_test_skip ("Not using MetaMonitorConfigManager");
+      return;
+    }
+
+  set_custom_test_file (config_store, "single.xml");
+
+  check_monitor_configurations (config_store, &expect);
+}
+
+void
+init_monitor_store_tests (void)
+{
+  g_test_add_func ("/backends/monitor-store/single",
+                   meta_test_monitor_store_single);
+}

src/tests/monitor-store-unit-tests.h

@@ -0,0 +1,25 @@
+/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
+
+/*
+ * Copyright (C) 2017 Red Hat, Inc.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef MONITOR_STORE_UNIT_TESTS_H
+#define MONITOR_STORE_UNIT_TESTS_H
+
+void init_monitor_store_tests (void);
+
+#endif /* MONITOR_STORE_UNIT_TESTS_H */

src/tests/monitor-unit-tests.c

@@ -589,9 +589,9 @@ create_monitor_test_setup (MonitorTestCase *test_case)
                                                     ++n_laptop_panels)
                                  : g_strdup_printf ("DP-%d",
                                                     ++n_normal_panels)),
-        .vendor = g_strdup ("MetaProducts Inc."),
-        .product = g_strdup ("unknown"),
-        .serial = g_strdup ("0xC0FFEE"),
+        .vendor = g_strdup ("MetaProduct's Inc."),
+        .product = g_strdup ("MetaMonitor"),
+        .serial = g_strdup ("0x123456"),
         .suggested_x = -1,
         .suggested_y = -1,
         .hotplug_mode_update = TRUE, /* Results in config being ignored */

src/tests/unit-tests.c

@@ -29,6 +29,7 @@
 #include "core/main-private.h"
 #include "tests/meta-backend-test.h"
 #include "tests/monitor-unit-tests.h"
+#include "tests/monitor-store-unit-tests.h"
 #include "wayland/meta-wayland.h"
 
 typedef struct _MetaTestLaterOrderCallbackData
@@ -201,6 +202,7 @@ init_tests (int argc, char **argv)
   g_test_add_func ("/util/meta-later/schedule-from-later",
                    meta_test_util_later_schedule_from_later);
 
+  init_monitor_store_tests ();
   init_monitor_tests ();
 }