Add a check for whether icons used in glade files are valid

tests/glade/icons/check_icons.py

@@ -0,0 +1,72 @@
+#!/usr/bin/python
+#
+# Copyright (C) 2014  Red Hat, Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Author: David Shea <dshea@redhat.com>
+#
+"""
+Check that all icons referenced from glade files are valid in the gnome icon theme.
+"""
+
+import argparse
+import sys
+
+try:
+    from lxml import etree
+except ImportError:
+    print("You need to install the python-lxml package to use check_pw_visibility.py")
+    sys.exit(1)
+
+from iconcheck import icon_exists
+
+def check_glade_file(glade_file_path):
+    glade_success = True
+    with open(glade_file_path) as glade_file:
+        # Parse the XML
+        glade_tree = etree.parse(glade_file)
+
+        # Stock image names are deprecated
+        for element in glade_tree.xpath("//property[@name='stock' or @name='stock_id']"):
+            glade_success = False
+            print("Deprecated stock icon found at %s:%d" % (glade_file_path, element.sourceline))
+
+        # Check whether named icons exist
+        for element in glade_tree.xpath("//property[@name='icon_name']"):
+            if not icon_exists(element.text):
+                glade_success = False
+                print("Invalid icon name %s found at %s:%d" % (element.text, glade_file_path, element.sourceline))
+
+    return glade_success
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser("Check that password entries have visibility set to False")
+
+    # Ignore translation arguments
+    parser.add_argument("-t", "--translate", action='store_true',
+            help=argparse.SUPPRESS)
+    parser.add_argument("-p", "--podir", action='store', type=str,
+            metavar='PODIR', help=argparse.SUPPRESS, default='./po')
+
+    parser.add_argument("glade_files", nargs="+", metavar="GLADE-FILE",
+            help='The glade file to check')
+    args = parser.parse_args(args=sys.argv[1:])
+
+    success = True
+    for file_path in args.glade_files:
+        if not check_glade_file(file_path):
+            success = False
+
+    sys.exit(0 if success else 1)

tests/lib/iconcheck.py

@@ -0,0 +1,41 @@
+#
+# iconcheck.py: Gtk icon testing
+#
+# Copyright (C) 2014  Red Hat, Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Author: David Shea <dshea@redhat.com>
+
+import os
+
+ICON_PATH = "/usr/share/icons/gnome"
+ICON_EXTS = ("png", "jpg", "svg")
+
+# This method depends on gnome-icon-theme being installed. gnome-icon-theme-legacy
+# may be installed, but the icons in it will not be considered.
+def icon_exists(icon_name):
+    for dirpath, _dirs, files in os.walk(ICON_PATH):
+        for icon in (icon_name + "." + ext for ext in ICON_EXTS):
+            if icon in files:
+                icon_path = os.path.join(dirpath, icon)
+
+                # If the file is a symbolic link, it's a legacy icon; reject it
+                if os.path.islink(icon_path):
+                    return False
+                else:
+                    return True
+
+    # Nothing found
+    return False