Merge lp:~thomir-deactivatedaccount/autopilot/fix-select-single into lp:autopilot/1.3

[Thomi Richards]

Fix select_single inconsistency.

This branch fixes the issue with select_single where it should raise an exception instead of returning None.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:336
http://jenkins.qa.ubuntu.com/job/autopilot-1.3-ci/12/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-1.3-saucy-amd64-ci/12
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-1.3-saucy-armhf-ci/12

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

review: Approve (continuous-integration)

[Martin Pitt (pitti)]

The docstring still says

        If nothing is returned from the query, this method returns None.

which needs to be updated.

Otherwise, LGTM.

review: Needs Fixing

[lp:~thomir-deactivatedaccount/autopilot/fix-select-single]

337. By Thomi Richards on 2013-09-16

Fix issues arising from code review.

[Martin Pitt (pitti)]

LGTM, thanks!

review: Approve

=== modified file 'autopilot/introspection/dbus.py'
--- autopilot/introspection/dbus.py	2013-09-16 13:45:13 +0000
+++ autopilot/introspection/dbus.py	2013-09-16 13:45:13 +0000
@@ -359,7 +359,8 @@
             app.select_single('QPushButton', objectName='clickme')
             # returns a QPushButton whose 'objectName' property is 'clickme'.
 
-        If nothing is returned from the query, this method returns None.
+        If nothing is returned from the query, this method raises
+        StateNotFoundError.
 
         :param type_name: Either a string naming the type you want, or a class
             of the appropriate type (the latter case is for overridden emulator
@@ -371,6 +372,8 @@
         :raises TypeError: if neither *type_name* or keyword filters are
             provided.
 
+        :raises StateNotFoundError: if the requested object was not found.
+
         .. seealso::
             Tutorial Section :ref:`custom_emulators`
 
@@ -379,7 +382,7 @@
         if len(instances) > 1:
             raise ValueError("More than one item was returned for query")
         if not instances:
-            return None
+            raise StateNotFoundError(type_name, **kwargs)
         return instances[0]
 
     def select_many(self, type_name='*', **kwargs):

=== modified file 'autopilot/tests/functional/test_dbus_query.py'
--- autopilot/tests/functional/test_dbus_query.py	2013-07-29 10:29:37 +0000
+++ autopilot/tests/functional/test_dbus_query.py	2013-09-16 13:45:13 +0000
@@ -26,6 +26,7 @@
 
 from autopilot.testcase import AutopilotTestCase
 from testtools.matchers import Equals, NotEquals, raises
+from autopilot.introspection.dbus import StateNotFoundError
 
 
 class DbusQueryTests(AutopilotTestCase):
@@ -126,10 +127,10 @@
         fn = lambda: app.select_single()
         self.assertThat(fn, raises(TypeError))
 
-    def test_select_single_no_match_returns_none(self):
+    def test_select_single_no_match_raises_exception(self):
         app = self.start_fully_featured_app()
-        failed_match = app.select_single("QMadeupType")
-        self.assertThat(failed_match, Equals(None))
+        match_fn = lambda: app.select_single("QMadeupType")
+        self.assertThat(match_fn, raises(StateNotFoundError('QMadeupType')))
 
     def test_select_single_parameters_only(self):
         app = self.start_fully_featured_app()
@@ -138,10 +139,13 @@
         self.assertThat(titled_help, NotEquals(None))
         self.assertThat(titled_help.title, Equals('Help'))
 
-    def test_select_single_parameters_no_match_returns_none(self):
+    def test_select_single_parameters_no_match_raises_exception(self):
         app = self.start_fully_featured_app()
-        failed_match = app.select_single(title="Non-existant object")
-        self.assertThat(failed_match, Equals(None))
+        match_fn = lambda: app.select_single(title="Non-existant object")
+        self.assertThat(
+            match_fn,
+            raises(StateNotFoundError(title="Non-existant object"))
+        )
 
     def test_select_single_returning_multiple_raises(self):
         app = self.start_fully_featured_app()

=== modified file 'autopilot/tests/unit/test_exceptions.py'
--- autopilot/tests/unit/test_exceptions.py	2013-09-16 13:45:13 +0000
+++ autopilot/tests/unit/test_exceptions.py	2013-09-16 13:45:13 +0000
@@ -65,7 +65,7 @@
         )
         self.assertThat(
             unicode(err),
-            Equals("State not found with filters {'foo': 'bar'}.")
+            Equals(u"State not found with filters {'foo': 'bar'}.")
         )
 
     def test_can_be_constructed_with_class_name_and_filters(self):
@@ -83,6 +83,6 @@
         )
         self.assertThat(
             unicode(err),
-            Equals("State not found for class 'MyClass'"
+            Equals(u"State not found for class 'MyClass'"
                    " and filters {'foo': 'bar'}.")
         )