Merge lp:~autopilot/autopilot/temp-dev into lp:autopilot

[Christopher Lee]

Fix DateTime tests that failed due to recent DateTime changes that removed assumption of UTC TZ. Fixes: https://bugs.launchpad.net/bugs/1324441.
Set process on proxy object when launched via fixture (LP:1327377). Fixes: https://bugs.launchpad.net/bugs/1327377.
Add link to url troubleshooting guide when state not found error is raise.
Update docs version number in sphinx config.
Update Apparmor rules.

Fix DateTime tests that failed due to recent DateTime changes that removed assumption of UTC TZ. Fixes: https://bugs.launchpad.net/bugs/1324441.
Set process on proxy object when launched via fixture (LP:1327377). Fixes: https://bugs.launchpad.net/bugs/1327377.
Add link to url troubleshooting guide when state not found error is raise.
Update docs version number in sphinx config.
Update Apparmor rules.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:523
http://jenkins.qa.ubuntu.com/job/autopilot-ci/743/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-amd64-ci/17
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-amd64-ci/17/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-armhf-ci/17
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-armhf-ci/17/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-i386-ci/17
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-i386-ci/17/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-utopic-autopilot/140
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-utopic-touch/166/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-utopic-autopilot/229
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/918
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/918/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/1580
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/1580/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/6814/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/8418

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

review: Approve (continuous-integration)

=== modified file 'autopilot/application/_launcher.py'
--- autopilot/application/_launcher.py	2014-05-29 16:43:08 +0000
+++ autopilot/application/_launcher.py	2014-06-13 00:22:23 +0000
@@ -379,6 +379,7 @@
             process=process,
             pid=process.pid
         )
+        proxy_object.set_process(process)
         return proxy_object
 
     def _setup_environment(self, app_path, app_type, arguments):

=== modified file 'autopilot/exceptions.py'
--- autopilot/exceptions.py	2014-05-21 07:39:59 +0000
+++ autopilot/exceptions.py	2014-06-13 00:22:23 +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_application_launcher.py'
--- autopilot/tests/unit/test_application_launcher.py	2014-05-29 16:43:08 +0000
+++ autopilot/tests/unit/test_application_launcher.py	2014-06-13 00:22:23 +0000
@@ -213,6 +213,20 @@
     @patch('autopilot.application._launcher.'
            'get_proxy_object_for_existing_process')
     @patch('autopilot.application._launcher._get_application_path')
+    def test_launch_sets_process_of_proxy_object(self, _, gpofep):
+        """Test that NormalApplicationLauncher.launch returns the proxy object
+        returned by get_proxy_object_for_existing_process."""
+        launcher = NormalApplicationLauncher()
+        with patch.object(launcher, '_launch_application_process') as lap:
+            with patch.object(launcher, '_setup_environment') as se:
+                se.return_value = ('', [])
+                launcher.launch('')
+                set_process = gpofep.return_value.set_process
+                set_process.assert_called_once_with(lap.return_value)
+
+    @patch('autopilot.application._launcher.'
+           'get_proxy_object_for_existing_process')
+    @patch('autopilot.application._launcher._get_application_path')
     def test_launch_returns_proxy_object(self, _, gpofep):
         """Test that NormalApplicationLauncher.launch returns the proxy object
         returned by get_proxy_object_for_existing_process."""

=== 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-13 00:22:23 +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-13 00:22:23 +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-13 00:22:23 +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,
@@ -307,13 +308,25 @@
     def test_datetime_has_properties(self):
         dt = DateTime(1377209927)
 
-        self.assertThat(dt.timestamp, Equals(1377209927))
-        self.assertThat(dt.year, Equals(2013))
-        self.assertThat(dt.month, Equals(8))
-        self.assertThat(dt.day, Equals(22))
-        self.assertThat(dt.hour, Equals(22))
-        self.assertThat(dt.minute, Equals(18))
-        self.assertThat(dt.second, Equals(47))
+        self.assertTrue(hasattr(dt, 'timestamp'))
+        self.assertTrue(hasattr(dt, 'year'))
+        self.assertTrue(hasattr(dt, 'month'))
+        self.assertTrue(hasattr(dt, 'day'))
+        self.assertTrue(hasattr(dt, 'hour'))
+        self.assertTrue(hasattr(dt, 'minute'))
+        self.assertTrue(hasattr(dt, 'second'))
+
+    def test_datetime_properties_have_correct_values(self):
+        dt = DateTime(1377209927)
+        dt_with_tz = datetime.fromtimestamp(1377209927)
+
+        self.assertThat(dt.timestamp, Equals(dt_with_tz.timestamp()))
+        self.assertThat(dt.year, Equals(dt_with_tz.year))
+        self.assertThat(dt.month, Equals(dt_with_tz.month))
+        self.assertThat(dt.day, Equals(dt_with_tz.day))
+        self.assertThat(dt.hour, Equals(dt_with_tz.hour))
+        self.assertThat(dt.minute, Equals(dt_with_tz.minute))
+        self.assertThat(dt.second, Equals(dt_with_tz.second))
 
     def test_equality_with_datetime(self):
         dt1 = DateTime(1377209927)
@@ -328,9 +341,10 @@
         self.assertThat(dt1, Equals(dt2))
 
     def test_equality_with_datetime_timestamp(self):
+        # DateTime no longer assumes UTC and uses local TZ.
         dt1 = DateTime(1377209927)
-        dt2 = datetime.utcfromtimestamp(1377209927)
-        dt3 = datetime.utcfromtimestamp(1377209928)
+        dt2 = datetime.fromtimestamp(1377209927)
+        dt3 = datetime.fromtimestamp(1377209928)
 
         self.assertThat(dt1, Equals(dt2))
         self.assertThat(dt1, NotEquals(dt3))
@@ -341,8 +355,12 @@
         self.assertThat(dt1.datetime, IsInstance(datetime))
 
     def test_repr(self):
+        expected = repr_type(
+            u"DateTime({:%Y-%m-%d %H:%M:%S})".format(
+                datetime.fromtimestamp(1377209927)
+            )
+        )
         dt = DateTime(1377209927)
-        expected = repr_type('DateTime(2013-08-22 22:18:47)')
         observed = repr(dt)
         self.assertEqual(expected, observed)
 

=== modified file 'docs/conf.py'
--- docs/conf.py	2014-04-30 21:39:57 +0000
+++ docs/conf.py	2014-06-13 00:22:23 +0000
@@ -75,7 +75,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.4'
+version = '1.5'
 
 # The full version, including alpha/beta/rc tags.
 try: