Merge lp:~pitti/autopilot-gtk/gtkbuilder-names into lp:autopilot-gtk

[Martin Pitt]

Expose GtkBuilder widget identifiers as "BuilderName" property. (LP: #1082391)

The objects on the application widget tree should have proper identifiers that
are given to them in the GtkBuilder .ui files. These identifiers are the ones
that the actual program code uses to refer to them, so they are both stable,
and also the most appropriate means to identify a particular widget.

This branch exposes them as "BuilderName" property (capitalized to avoid
potential conflict with real GTK widget properties), and adds/updates the test
cases accordingly.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:47
http://jenkins.qa.ubuntu.com/job/autopilot-gtk-ci/56/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-gtk-saucy-amd64-ci/18
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-gtk-saucy-armhf-ci/18

Click here to trigger a rebuild:
http://s-jenkins:8080/job/autopilot-gtk-ci/56/rebuild

review: Approve (continuous-integration)

[Thomi Richards (thomir-deactivatedaccount)]

Looks awesome.

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/autopilot-gtk-autolanding/13/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-gtk-saucy-amd64-autolanding/7/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-gtk-saucy-armhf-autolanding/7/console

review: Needs Fixing (continuous-integration)

[lp:~pitti/autopilot-gtk/gtkbuilder-names]

48. By Martin Pitt on 2013-06-27

merge with trunk

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:48
http://jenkins.qa.ubuntu.com/job/autopilot-gtk-ci/58/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-gtk-saucy-amd64-ci/20
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-gtk-saucy-armhf-ci/20

Click here to trigger a rebuild:
http://s-jenkins:8080/job/autopilot-gtk-ci/58/rebuild

review: Approve (continuous-integration)

=== modified file 'lib/GtkNode.cpp'
--- lib/GtkNode.cpp	2013-06-27 04:47:48 +0000
+++ lib/GtkNode.cpp	2013-06-27 06:09:24 +0000
@@ -105,6 +105,10 @@
   // add the names of our children
   builder_wrapper.add("Children", GetChildNodeNames());
 
+  // add the GtkBuilder name
+  if (GTK_IS_BUILDABLE (object_))
+    builder_wrapper.add("BuilderName", gtk_buildable_get_name(GTK_BUILDABLE (object_)));
+
   // add the GlobalRect property: "I am a GtkWidget" edition
   if (GTK_IS_WIDGET(object_)) {
     // FIXME: we'd like to remove this duplication (to GetGlobalRect)
@@ -215,6 +219,11 @@
   if (name == "id")
     return value == std::to_string(GetObjectId());
 
+  if (name == "BuilderName" && GTK_IS_BUILDABLE(object_)) {
+      const gchar* name = gtk_buildable_get_name(GTK_BUILDABLE (object_));
+      return name != NULL && std::string(name) == value;
+  }
+
   GObjectClass* klass = G_OBJECT_GET_CLASS(object_);
   GParamSpec* pspec = g_object_class_find_property(klass, name.c_str());
   if (pspec == NULL)

=== modified file 'tests/autopilot/tests/test_actions.py'
--- tests/autopilot/tests/test_actions.py	2013-06-26 07:22:11 +0000
+++ tests/autopilot/tests/test_actions.py	2013-06-27 06:09:24 +0000
@@ -35,15 +35,8 @@
     def test_greeting_keyboard(self):
         """Greeting with keyboard navigation"""
 
-        entries = self.app.select_many('GtkEntry')
-        self.assertEqual(len(entries), 2)
-        # the upper entry is for the name, the lower for the color
-        # FIXME: once we have proper names (LP# 1082391), replace this with an
-        # assertion
-        if entries[0].globalRect[1] < entries[1].globalRect[1]:
-            (entry_name, entry_color) = entries
-        else:
-            (entry_color, entry_name) = entries
+        entry_name = self.app.select_single(BuilderName='entry_name')
+        entry_color = self.app.select_single(BuilderName='entry_color')
 
         # FIXME: This isn't necessary for real X, but under Xvfb there is no
         # default focus sometimes
@@ -84,15 +77,8 @@
     def test_greeting_mouse(self):
         """Greeting with mouse navigation"""
 
-        entries = self.app.select_many('GtkEntry')
-        self.assertEqual(len(entries), 2)
-        # the upper entry is for the name, the lower for the color
-        # FIXME: once we have proper names (LP# 1082391), replace this with an
-        # assertion
-        if entries[0].globalRect[1] < entries[1].globalRect[1]:
-            (entry_name, entry_color) = entries
-        else:
-            (entry_color, entry_name) = entries
+        entry_name = self.app.select_single(BuilderName='entry_name')
+        entry_color = self.app.select_single(BuilderName='entry_color')
 
         # FIXME: This isn't necessary for real X, but under Xvfb there is no
         # default focus sometimes

=== modified file 'tests/autopilot/tests/test_properties.py'
--- tests/autopilot/tests/test_properties.py	2013-06-27 04:47:48 +0000
+++ tests/autopilot/tests/test_properties.py	2013-06-27 06:09:24 +0000
@@ -31,6 +31,20 @@
         super(PropertyTest, self).setUp()
         self.app = self.launch_test_application(test_app, app_type='gtk')
 
+    def test_gtk_builder_name(self):
+        """GtkBuilder name lookup"""
+
+        w = self.app.select_single(BuilderName='button_greet')
+        self.assertNotEqual(w, None)
+        self.assertEqual(w.label, 'Greet')
+
+        w = self.app.select_single(BuilderName='button_quit')
+        self.assertNotEqual(w, None)
+        self.assertEqual(w.label, 'gtk-quit')
+
+        w = self.app.select_single(BuilderName='entry_color')
+        self.assertNotEqual(w, None)
+
     def test_button(self):
         """GtkButton properties"""
 
@@ -53,18 +67,15 @@
         self.assertEqual(len(btn_greet.globalRect), 4)
         self.assertEqual(len(btn_quit.globalRect), 4)
 
+        # all our buttons have a GtkBuilder ID
+        self.assertEqual(btn_greet.BuilderName, 'button_greet')
+        self.assertEqual(btn_quit.BuilderName, 'button_quit')
+
     def test_entry(self):
         """GtkEntry properties"""
 
-        entries = self.app.select_many('GtkEntry')
-        self.assertEqual(len(entries), 2)
-        # the upper entry is for the name, the lower for the color
-        # FIXME: once we have proper names (LP# 1082391), replace this with an
-        # assertion
-        if entries[0].globalRect[1] < entries[1].globalRect[1]:
-            (entry_name, entry_color) = entries
-        else:
-            (entry_color, entry_name) = entries
+        entry_name = self.app.select_single(BuilderName='entry_name')
+        entry_color = self.app.select_single(BuilderName='entry_color')
 
         self.assertTrue(entry_name.visible)
         self.assertTrue(entry_color.visible)
@@ -78,6 +89,9 @@
         if not entry_name.has_focus:
             self.mouse.click_object(entry_name)
 
+        # the color entry is below the name entry
+        self.assertLess(entry_name.globalRect[1], entry_color.globalRect[1])
+
         # first entry has default focus
         self.assertEqual(entry_name.has_focus, True)
         self.assertEqual(entry_color.has_focus, False)