Merge lp:~chris.gagnon/autopilot/troubleshooting-url into lp:~autopilot/autopilot/temp-dev

[Chris Gagnon]

link to url troubleshooting guide when state not found error is raise

[lp:~chris.gagnon/autopilot/troubleshooting-url]

492. By Chris Gagnon on 2014-05-30

add period back, from accidental deletion

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:491
http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-ci/135/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-amd64-ci/96
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-amd64-ci/96/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-armhf-ci/96
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-armhf-ci/96/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-i386-ci/96
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-i386-ci/96/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-utopic-autopilot/209
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/6769/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/7932

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-autopilot-temp-dev-ci/135/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:492
http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-ci/136/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-amd64-ci/97
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-amd64-ci/97/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-armhf-ci/97
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-armhf-ci/97/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-i386-ci/97
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-i386-ci/97/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-utopic-autopilot/210
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/6771/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/7938

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-autopilot-temp-dev-ci/136/rebuild

review: Approve (continuous-integration)

[Christopher Lee (veebers)]

(diffline 74) Seems annoying to use a setUp here just to get a message used later on. Perhaps you can make the test a module level private string and just import that?
Also could you create a test that specifically tests that the exception message includes the expected text?

[lp:~chris.gagnon/autopilot/troubleshooting-url]

493. By Chris Gagnon on 2014-06-02

make a private string for the url troubleshooting guide so it can be reused in tests, add a test to make sure it ends with the expected url guide text, don't use setup for url txt.

494. By Chris Gagnon on 2014-06-03

remove self

495. By Chris Gagnon on 2014-06-03

remove commented out print

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:493
http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-ci/137/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-amd64-ci/98
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-amd64-ci/98/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-armhf-ci/98
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-armhf-ci/98/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-i386-ci/98
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-i386-ci/98/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-utopic-autopilot/211
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/6781/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/7999

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-autopilot-temp-dev-ci/137/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:495
http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-ci/138/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-amd64-ci/99/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-armhf-ci/99/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-i386-ci/99/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-autopilot-temp-dev-ci/138/rebuild

review: Needs Fixing (continuous-integration)

[lp:~chris.gagnon/autopilot/troubleshooting-url]

496. By Chris Gagnon on 2014-06-03

fixup un-needed self.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:496
http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-ci/139/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-amd64-ci/100
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-amd64-ci/100/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-armhf-ci/100
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-armhf-ci/100/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-i386-ci/100
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-i386-ci/100/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-utopic-autopilot/212
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/6782/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/8002

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-autopilot-temp-dev-ci/139/rebuild

review: Approve (continuous-integration)

[Christopher Lee (veebers)]

I know I said module level var, but on reflection it should be a class variable on StateNotFound (I had in my mind that it would be useful in other places/exceptions, but YAGNI) sorry about that.

In the process could you also rename it from "_url_message_link" to something like "_troubleshoot_url_message"

The language in the message needs to be more friendly (i.e. 'fix your broken tests') perhaps something along the lines of:
    "See <url> for tips on minimising the occurrence of this failure"

review: Needs Fixing

[lp:~chris.gagnon/autopilot/troubleshooting-url]

497. By Chris Gagnon on 2014-06-04

fix flipflop in review, make message more polite.

[Christopher Lee (veebers)]

Sweet, LGTM

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:497
http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-ci/143/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-amd64-ci/104
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-amd64-ci/104/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-armhf-ci/104
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-armhf-ci/104/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-i386-ci/104
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-i386-ci/104/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-utopic-autopilot/217
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/6793/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/8099

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-autopilot-temp-dev-ci/143/rebuild

review: Approve (continuous-integration)

=== modified file 'autopilot/exceptions.py'
--- autopilot/exceptions.py	2014-05-21 07:39:59 +0000
+++ autopilot/exceptions.py	2014-06-04 22:03:19 +0000
@@ -26,11 +26,8 @@
 
 """
 
-import six
-
 
 class BackendException(RuntimeError):
-
     """An error occured while trying to initialise an autopilot backend."""
 
     def __init__(self, original_exception):
@@ -63,7 +60,6 @@
       application.
 
     """
-
     def __init__(self, class_name=None, **filters):
         """Construct a StateNotFoundError.
 
@@ -71,13 +67,14 @@
             are specified.
 
         """
+
         if class_name is None and not filters:
             raise ValueError("Must specify either class name or filters.")
 
         if class_name is None:
             self._message = \
                 u"Object not found with properties {}.".format(
-                    repr(filters)
+                    repr(filters),
                 )
         elif not filters:
             self._message = u"Object not found with name '{}'.".format(
@@ -90,14 +87,18 @@
                     repr(filters)
                 )
 
+    _troubleshoot_url_message = (
+        'Tips on minimizing the occurrence of this failure'
+        'are available here: '
+        'http://developer.ubuntu.com/api/devel/ubuntu-14.10/python/'
+        'autopilot/faq/troubleshooting.html'
+    )
+
     def __str__(self):
-        if six.PY3:
-            return self._message
-        else:
-            return self._message.encode('utf8')
-
-    def __unicode__(self):
-        return self._message
+        return '{}\n\n{}'.format(
+            self._message,
+            self._troubleshoot_url_message
+        )
 
 
 class InvalidXPathQuery(ValueError):

=== modified file 'autopilot/tests/unit/test_exceptions.py'
--- autopilot/tests/unit/test_exceptions.py	2014-04-15 02:32:16 +0000
+++ autopilot/tests/unit/test_exceptions.py	2014-06-04 22:03:19 +0000
@@ -17,9 +17,8 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-import six
 from testtools import TestCase
-from testtools.matchers import raises, Equals
+from testtools.matchers import raises, EndsWith, Equals
 
 from autopilot.exceptions import StateNotFoundError
 
@@ -41,26 +40,23 @@
         err = StateNotFoundError("MyClass")
         self.assertThat(
             str(err),
-            Equals("Object not found with name 'MyClass'.")
+            Equals("Object not found with name 'MyClass'.\n\n{}".format(
+                StateNotFoundError._troubleshoot_url_message
+            ))
         )
-        if not six.PY3:
-            self.assertThat(
-                unicode(err),
-                Equals(u"Object not found with name 'MyClass'.")
-            )
 
     def test_can_be_constructed_with_filters_only(self):
         """Must be able to construct exception with filters only."""
         err = StateNotFoundError(foo="bar")
         self.assertThat(
             str(err),
-            Equals("Object not found with properties {'foo': 'bar'}.")
+            Equals(
+                "Object not found with properties {}."
+                "\n\n{}".format(
+                    "{'foo': 'bar'}",
+                    StateNotFoundError._troubleshoot_url_message
+                ))
         )
-        if not six.PY3:
-            self.assertThat(
-                unicode(err),
-                Equals(u"Object not found with properties {'foo': 'bar'}.")
-            )
 
     def test_can_be_constructed_with_class_name_and_filters(self):
         """Must be able to construct with both class name and filters."""
@@ -68,11 +64,21 @@
         self.assertThat(
             str(err),
             Equals("Object not found with name 'MyClass'"
-                   " and properties {'foo': 'bar'}.")
+                   " and properties {}.\n\n{}".format(
+                       "{'foo': 'bar'}",
+                       StateNotFoundError._troubleshoot_url_message
+                   ))
         )
-        if not six.PY3:
-            self.assertThat(
-                unicode(err),
-                Equals(u"Object not found with name 'MyClass'"
-                       " and properties {'foo': 'bar'}.")
+
+    def test_StateNotFoundError_endswith_troubleshoot_url_message_text(self):
+        """The assertion raised must end with a link to troubleshooting url."""
+        err = StateNotFoundError('MyClass', foo="bar")
+        self.assertThat(
+            str(err),
+            EndsWith(
+                'Tips on minimizing the occurrence of this failure'
+                'are available here: '
+                'http://developer.ubuntu.com/api/devel/ubuntu-14.10/python/'
+                'autopilot/faq/troubleshooting.html'
             )
+        )

=== modified file 'autopilot/tests/unit/test_introspection_dbus.py'
--- autopilot/tests/unit/test_introspection_dbus.py	2014-05-20 08:53:21 +0000
+++ autopilot/tests/unit/test_introspection_dbus.py	2014-06-04 22:03:19 +0000
@@ -171,7 +171,9 @@
             path: '/some/path'
             text: 'Hello'
             Error: Object not found with name 'child'.
-            """))
+
+            {}
+            """.format(StateNotFoundError._troubleshoot_url_message)))
 
     def test_print_tree_fileobj(self):
         """print_tree with file object output"""

=== modified file 'autopilot/tests/unit/test_types.py'
--- autopilot/tests/unit/test_types.py	2014-05-20 08:53:21 +0000
+++ autopilot/tests/unit/test_types.py	2014-06-04 22:03:19 +0000
@@ -19,13 +19,14 @@
 
 from __future__ import absolute_import
 
+import dbus
+import six
+
 from datetime import datetime, time
-from unittest.mock import patch, Mock
-import six
 from testscenarios import TestWithScenarios
 from testtools import TestCase
 from testtools.matchers import Equals, IsInstance, NotEquals, raises
-import dbus
+from unittest.mock import patch, Mock
 
 from autopilot.introspection.types import (
     Color,

=== modified file 'debian/changelog'
--- debian/changelog	2014-05-09 00:48:14 +0000
+++ debian/changelog	2014-06-04 22:03:19 +0000
@@ -1,3 +1,11 @@
+autopilot (1.5.0+14.10.20140526.1-0ubuntu1) utopic; urgency=low
+
+  [ Tarmac ]
+  * Add fixtures for launching applications. (LP: #1322033, #1291531,
+    #1320149)
+
+ -- Ubuntu daily release <[e-mail]>  Mon, 26 May 2014 12:50:10 +0000
+
 autopilot (1.5.0+14.10.20140509-0ubuntu1) utopic; urgency=low
 
   [ Thomi Richards ]