sanity_checks: add global build options

Some projects need non-default options to avoid build failures, and are
also frequent dependencies of other projects.  Rather than adding
"foo:tests=false" to all projects that depend on foo, allow specifying
the option globally.  Since we might want to disable foo tests only when
foo is built as a dependency, ignore any global options that configure the
project currently under test.

Consolidate existing options for libxml2.  Also disable building glib
tests; 2.86.0 introduced a build failure on clang-cl, our glib CI already
disables tests, and glib has a lot of them.

Also drop an unneeded glib:sysprof=disabled in pango.

Author: bgilbert

ci_config.json

@@ -1,5 +1,5 @@
 {
-  "_comment": [
+  "_comment_broken": [
     "This is intentionally undocumented in README.md, do not use it.",
     "Using it is an automatic CI error.",
     "broken_linux, broken_windows and broken_darwin are lists of wraps that are known",
@@ -23,6 +23,15 @@
     "graphite2",
     "mocklibc"
   ],
+  "_comment_global": [
+    "global_build_options are passed to every build except for the project",
+    "they control; for example glib:tests=false is passed to every project",
+    "except glib.  This helps avoid irrelevant CI failures in dependencies."
+  ],
+  "global_build_options": [
+    "glib:tests=false",
+    "libxml2:iconv=disabled"
+  ],
   "apache-orc": {
     "test_options": [
       "--timeout-multiplier=2"
@@ -92,13 +101,11 @@
   "cairo": {
     "_comment": [
       "- Force-enable fontconfig to avoid https://gitlab.freedesktop.org/cairo/cairo/-/issues/862",
-      "- Prevent libxml2 from requiring iconv",
       "- fontconfig warns on v1 wraps; fixed in next release",
       "- Some tests fails and they are still run despite -Dtests=disabled"
     ],
     "build_options": [
-      "cairo:fontconfig=enabled",
-      "libxml2:iconv=disabled"
+      "cairo:fontconfig=enabled"
     ],
     "fatal_warnings": false,
     "skip_tests": true
@@ -275,9 +282,6 @@
     "alpine_packages": [
       "bash"
     ],
-    "build_options": [
-      "libxml2:iconv=disabled"
-    ],
     "fatal_warnings": false
   },
   "freeglut": {
@@ -323,7 +327,6 @@
       "- By default Glycin is mandatory on Linux",
       "- Disable man because it requires rst2man",
       "- Enable miscellaneous built-in loaders",
-      "- glib tests don't build on clang-cl",
       "- Disable fatal warnings because of v1 wraps",
       "- Disable fatal warnings because of https://gitlab.gnome.org/GNOME/gdk-pixbuf/-/merge_requests/156",
       "- Disable tests because one is broken: https://gitlab.gnome.org/GNOME/gdk-pixbuf/-/issues/215",
@@ -332,8 +335,7 @@
     "build_options": [
       "gdk-pixbuf:glycin=disabled",
       "gdk-pixbuf:man=false",
-      "gdk-pixbuf:others=enabled",
-      "glib:tests=false"
+      "gdk-pixbuf:others=enabled"
     ],
     "alpine_packages": [
       "shared-mime-info"
@@ -456,7 +458,6 @@
     ],
     "fatal_warnings": false,
     "build_options": [
-      "glib:tests=false",
       "harfbuzz:glib=enabled",
       "harfbuzz:gobject=enabled",
       "harfbuzz:freetype=enabled",
@@ -831,11 +832,6 @@
       "diffutils"
     ]
   },
-  "libxmlpp": {
-    "build_options": [
-      "libxml2:iconv=disabled"
-    ]
-  },
   "libxkbcommon": {
     "build_options": [
       "libxkbcommon:enable-docs=false",
@@ -878,11 +874,6 @@
       "libx11-dev"
     ]
   },
-  "libxslt": {
-    "build_options": [
-      "libxml2:iconv=disabled"
-    ]
-  },
   "libxv": {
     "_comment": "X11 needs a POSIX system",
     "build_on": {
@@ -1132,14 +1123,10 @@
   },
   "pango": {
     "_comment": [
-      "- Avoid sysprof build errors on Windows",
       "- fontconfig warns on v1 wraps; fixed in next release",
       "- skip dependency checks for optionally provided dependencies",
       "- Known test failure: https://gitlab.gnome.org/GNOME/pango/-/issues/682"
     ],
-    "build_options": [
-      "glib:sysprof=disabled"
-    ],
     "fatal_warnings": false,
     "skip_dependency_check": [
       "pangoft2",

tools/sanity_checks.py

@@ -448,7 +448,7 @@ def check_new_release(self, name: str, builddir: str = '_build', deps=None, prog
         fatal_warnings = ci.get('fatal_warnings', expect_working) and self.fatal_warnings
         if fatal_warnings:
             options.append('--fatal-meson-warnings')
-        options += [f'-D{o}' for o in ci.get('build_options', [])]
+        options += self.ci_config.get_option_arguments(name)
         if Path(builddir, 'meson-private', 'cmd_line.txt').exists():
             options.append('--wipe')
         meson_env = self.install_packages(ci)
@@ -746,7 +746,7 @@ def get_meson_version_deps(self, name: str, builddir: str, wrap: configparser.Co
                 version_request += '.0'
 
         options = ['-Dpython.install_env=auto', f'-Dwraps={name}']
-        options += [f'-D{o}' for o in ci.get('build_options', [])]
+        options += self.ci_config.get_option_arguments(name)
         try:
             subprocess.check_call(
                 ['meson', 'rewrite', 'kwargs', 'set', 'project', '/', 'meson_version', '>=0'],

tools/utils.py

@@ -169,6 +169,12 @@ def broken(self) -> list[str]:
         system = platform.system().lower()
         return T.cast('list[str]', self.get(f'broken_{system}', []))
 
+    def get_option_arguments(self, name: str) -> list[str]:
+        global_opts = T.cast('list[str]', self.get('global_build_options', []))
+        opts = [o for o in global_opts if not o.startswith(f'{name}:')]
+        opts += self.get(name, {}).get('build_options', [])
+        return [f'-D{o}' for o in opts]
+
 def wrap_path(name: str) -> Path:
     return Path('subprojects', f'{name}.wrap')