Merge lp:~mandel/ubuntuone-dev-tools/refactor-testcase into lp:ubuntuone-dev-tools

[Manuel de la Peña]

Refactor the dbus test case to accommodate the code for the addition of extra test cases.

Refactor the dbus test case to accommodate the code for the addition of extra test cases.

[Diego Sarmentero (diegosarmentero)]

+1

review: Approve

[dobey (dobey)]

review: Approve

[dobey (dobey)]

+"""Matain old API."""

Maintain, I presume? :)

review: Needs Fixing

[dobey (dobey)]

Oh, and should probably update the year in the Copyright headers for the new files in testcases/ also.

[dobey (dobey)]

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

The attempt to merge lp:~mandel/ubuntuone-dev-tools/refactor-testcase into lp:ubuntuone-dev-tools failed. Below is the output from the failed tests.

ubuntuone.devtools.testcases.dbus
  DBusTestCase
    runTest ... [OK]
ubuntuone.devtools.services.tests.test_dbus
  TestWithDBus
    test_config_file_path ... [OK]
    test_dbus_session_is_running ... [OK]
ubuntuone.devtools.testcases
  BaseTestCase
    runTest ... [OK]
ubuntuone.devtools.tests.test_decorators
  TestSkipBasicDecorators
    test_skip_class ... [OK]
    test_skip_decorators ... [OK]
ubuntuone.devtools.tests.test_txcheck
  TestCheckTwistedTestClass
    test_bad_mixin_order ... [OK]
    test_bare_super ... [OK]
    test_inline_callbacks ... [OK]
    test_inline_callbacks_missing ... [OK]
    test_missing_return ... [OK]
    test_no_problems ... [OK]
    test_not_twisted ... [OK]
    test_ok_mixin_order ... [OK]
    test_super_not_called ... [OK]
  TestTwistedCheckSuite
    test_suite_catches_problems ... [OK]
    test_suite_runs_tests ... [OK]
twisted.trial.unittest
  TestCase
    runTest ... [OK]

-------------------------------------------------------------------------------
Ran 18 tests in 0.259s

PASSED (successes=18)
Name Stmts Exec Cover
-----------------------------------------------------------------
ubuntuone/__init__ 1 0 0%
ubuntuone/devtools/__init__ 0 0 100%
ubuntuone/devtools/handlers 30 0 0%
ubuntuone/devtools/reactors/__init__ 0 0 100%
ubuntuone/devtools/reactors/glib 7 0 0%
ubuntuone/devtools/reactors/qt4 11 0 0%
ubuntuone/devtools/reactors/twisted 2 0 0%
ubuntuone/devtools/reactors/txnp 4 0 0%
ubuntuone/devtools/services/__init__ 0 0 100%
ubuntuone/devtools/services/dbus 58 33 56%
ubuntuone/devtools/services/tests/__init__ 0 0 100%
ubuntuone/devtools/services/tests/test_dbus 16 8 50%
ubuntuone/devtools/testcase 4 0 0%
ubuntuone/devtools/testcases/__init__ 77 27 35%
ubuntuone/devtools/testcases/dbus 42 14 33%
ubuntuone/devtools...

[Ubuntu One Auto Pilot (otto-pilot)]

The attempt to merge lp:~mandel/ubuntuone-dev-tools/refactor-testcase into lp:ubuntuone-dev-tools failed. Below is the output from the failed tests.

ubuntuone.devtools.testcases.dbus
  DBusTestCase
    runTest ... [OK]
ubuntuone.devtools.services.tests.test_dbus
  TestWithDBus
    test_config_file_path ... [OK]
    test_dbus_session_is_running ... [OK]
ubuntuone.devtools.testcases
  BaseTestCase
    runTest ... [OK]
ubuntuone.devtools.tests.test_decorators
  TestSkipBasicDecorators
    test_skip_class ... [OK]
    test_skip_decorators ... [OK]
ubuntuone.devtools.tests.test_txcheck
  TestCheckTwistedTestClass
    test_bad_mixin_order ... [OK]
    test_bare_super ... [OK]
    test_inline_callbacks ... [OK]
    test_inline_callbacks_missing ... [OK]
    test_missing_return ... [OK]
    test_no_problems ... [OK]
    test_not_twisted ... [OK]
    test_ok_mixin_order ... [OK]
    test_super_not_called ... [OK]
  TestTwistedCheckSuite
    test_suite_catches_problems ... [OK]
    test_suite_runs_tests ... [OK]
twisted.trial.unittest
  TestCase
    runTest ... [OK]

-------------------------------------------------------------------------------
Ran 18 tests in 0.283s

PASSED (successes=18)
Name Stmts Exec Cover
-----------------------------------------------------------------
ubuntuone/__init__ 1 0 0%
ubuntuone/devtools/__init__ 0 0 100%
ubuntuone/devtools/handlers 30 0 0%
ubuntuone/devtools/reactors/__init__ 0 0 100%
ubuntuone/devtools/reactors/glib 7 0 0%
ubuntuone/devtools/reactors/qt4 11 0 0%
ubuntuone/devtools/reactors/twisted 2 0 0%
ubuntuone/devtools/reactors/txnp 4 0 0%
ubuntuone/devtools/services/__init__ 0 0 100%
ubuntuone/devtools/services/dbus 58 33 56%
ubuntuone/devtools/services/tests/__init__ 0 0 100%
ubuntuone/devtools/services/tests/test_dbus 16 8 50%
ubuntuone/devtools/testcase 4 0 0%
ubuntuone/devtools/testcases/__init__ 77 27 35%
ubuntuone/devtools/testcases/dbus 42 14 33%
ubuntuone/devtools...

[Ubuntu One Auto Pilot (otto-pilot)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

=== modified file 'setup.py'
--- setup.py	2011-11-14 22:16:40 +0000
+++ setup.py	2011-11-23 11:17:24 +0000
@@ -52,7 +52,8 @@
                 'ubuntuone.devtools',
                 'ubuntuone.devtools.reactors',
                 'ubuntuone.devtools.services',
-                'ubuntuone.devtools.testing'],
+                'ubuntuone.devtools.testing',
+                'ubuntuone.devtools.testcases'],
       extra_path='ubuntuone-dev-tools',
       scripts=['bin/u1lint',
                'bin/u1trial',

=== modified file 'ubuntuone/devtools/services/tests/test_dbus.py'
--- ubuntuone/devtools/services/tests/test_dbus.py	2011-11-18 23:09:59 +0000
+++ ubuntuone/devtools/services/tests/test_dbus.py	2011-11-23 11:17:24 +0000
@@ -3,7 +3,7 @@
 import os
 import shutil
 
-from ubuntuone.devtools.testcase import DBusTestCase
+from ubuntuone.devtools.testcases.dbus import DBusTestCase
 from ubuntuone.devtools.services.dbus import DBusRunner
 from urllib import unquote
 

=== added file 'ubuntuone/devtools/testcase.py'
--- ubuntuone/devtools/testcase.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/devtools/testcase.py	2011-11-23 11:17:24 +0000
@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""Maintain old API."""
+
+import warnings
+warnings.warn(
+            'Deprecated import path; use ubuntuone.devtools.testcases'
+            'instead.', DeprecationWarning, stacklevel=2)
+
+# pylint: disable=W0401,W0614
+from ubuntuone.devtools.testcases import *
+from ubuntuone.devtools.testcases.dbus import *

=== added directory 'ubuntuone/devtools/testcases'
=== renamed file 'ubuntuone/devtools/testcase.py' => 'ubuntuone/devtools/testcases/__init__.py'
--- ubuntuone/devtools/testcase.py	2011-06-14 13:40:37 +0000
+++ ubuntuone/devtools/testcases/__init__.py	2011-11-23 11:17:24 +0000
@@ -1,8 +1,6 @@
 # -*- coding: utf-8 -*-
-
-# Author: Guillermo Gonzalez <[e-mail]>
 #
-# Copyright 2009-2010 Canonical Ltd.
+# Copyright 2009-2011 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
@@ -27,31 +25,9 @@
 
 from functools import wraps
 
-from twisted.internet import defer
 from twisted.trial.unittest import TestCase, SkipTest
 
-# DBusRunner for DBusTestCase using tests
-from ubuntuone.devtools.services.dbus import DBusRunner
-
-
-# pylint: disable=F0401,C0103
-try:
-    import dbus
-except ImportError:
-    dbus = None
-
-try:
-    import dbus.service as service
-except ImportError:
-    service = None
-
-try:
-    from dbus.mainloop.glib import DBusGMainLoop
-except ImportError:
-    DBusGMainLoop = None
-
-
-# pylint: enable=F0401,C0103
+
 @contextlib.contextmanager
 def environ(env_var, new_value):
     """context manager to replace/add an environ value"""
@@ -128,17 +104,6 @@
 # pylint: enable=C0103
 
 
-class InvalidSessionBus(Exception):
-    """Error when we are connected to the wrong session bus in tests."""
-
-
-class FakeDBusInterface(object):
-    """A fake DBusInterface..."""
-
-    def shutdown(self, with_restart=False):
-        """...that only knows how to go away"""
-
-
 class BaseTestCase(TestCase):
     """Base TestCase with helper methods to handle temp dir.
 
@@ -199,61 +164,3 @@
         if os.path.exists(parent):
             os.chmod(parent, 0755)
         os.makedirs(path)
-
-
-@skipIf(dbus is None or service is None or DBusGMainLoop is None,
-    "The test requires dbus.")
-class DBusTestCase(BaseTestCase):
-    """Test the DBus event handling."""
-
-    def required_services(self):
-        """Return the list of required services for DBusTestCase."""
-        services = super(DBusTestCase, self).required_services()
-        services.extend([DBusRunner])
-        return services
-
-    @defer.inlineCallbacks
-    def setUp(self):
-        """Setup the infrastructure fo the test (dbus service)."""
-        # Class 'BaseTestCase' has no 'setUp' member
-        # pylint: disable=E1101
-        # dbus modules will be imported by the decorator
-        # pylint: disable=E0602
-        yield super(DBusTestCase, self).setUp()
-
-        # We need to ensure DBUS_SESSION_BUS_ADDRESS is private here
-        from urllib import unquote
-        bus_address = os.environ.get('DBUS_SESSION_BUS_ADDRESS', None)
-        if os.path.dirname(unquote(bus_address.split(',')[0].split('=')[1])) \
-                != os.path.dirname(os.getcwd()):
-            raise InvalidSessionBus('DBUS_SESSION_BUS_ADDRES is wrong.')
-
-        # Set up the main loop and bus connection
-        self.loop = DBusGMainLoop(set_as_default=True)
-        self.bus = dbus.bus.BusConnection(address_or_type=bus_address,
-                                          mainloop=self.loop)
-
-        # Monkeypatch the dbus.SessionBus/SystemBus methods, to ensure we
-        # always point at our own private bus instance.
-        self.patch(dbus, 'SessionBus', lambda: self.bus)
-        self.patch(dbus, 'SystemBus', lambda: self.bus)
-
-        # Check that we are on the correct bus for real
-# Disable this for now, because our tests are extremely broken :(
-#        bus_names = self.bus.list_names()
-#        if len(bus_names) > 2:
-#            raise InvalidSessionBus('Too many bus connections: %s (%r)' %
-#                                    (len(bus_names), bus_names))
-
-        # monkeypatch busName.__del__ to avoid errors on gc
-        # we take care of releasing the name in shutdown
-        service.BusName.__del__ = lambda _: None
-        yield self.bus.set_exit_on_disconnect(False)
-        self.signal_receivers = set()
-
-    @defer.inlineCallbacks
-    def tearDown(self):
-        """Cleanup the test."""
-        yield self.bus.flush()
-        yield self.bus.close()
-        yield super(DBusTestCase, self).tearDown()

=== added file 'ubuntuone/devtools/testcases/dbus.py'
--- ubuntuone/devtools/testcases/dbus.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/devtools/testcases/dbus.py	2011-11-23 11:17:24 +0000
@@ -0,0 +1,118 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2009-2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Base tests cases and test utilities."""
+
+from __future__ import absolute_import, with_statement
+
+import os
+
+from twisted.internet import defer
+
+# lint seems not tow work well when we use decorators
+# pylint:disable=W0611
+from ubuntuone.devtools.testcase import BaseTestCase, skipIf
+# pylint:enable=W0611
+# DBusRunner for DBusTestCase using tests
+from ubuntuone.devtools.services.dbus import DBusRunner
+
+
+# pylint: disable=F0401,C0103,W0406,E0611
+try:
+    import dbus
+except ImportError, e:
+    dbus = None
+
+try:
+    import dbus.service as service
+except ImportError:
+    service = None
+
+try:
+    from dbus.mainloop.glib import DBusGMainLoop
+except ImportError:
+    DBusGMainLoop = None
+
+# pylint: enable=F0401,C0103,W0406,E0611
+
+
+class InvalidSessionBus(Exception):
+    """Error when we are connected to the wrong session bus in tests."""
+
+
+class FakeDBusInterface(object):
+    """A fake DBusInterface..."""
+
+    def shutdown(self, with_restart=False):
+        """...that only knows how to go away"""
+
+
+@skipIf(dbus is None or service is None or DBusGMainLoop is None,
+    "The test requires dbus.")
+class DBusTestCase(BaseTestCase):
+    """Test the DBus event handling."""
+
+    def required_services(self):
+        """Return the list of required services for DBusTestCase."""
+        services = super(DBusTestCase, self).required_services()
+        services.extend([DBusRunner])
+        return services
+
+    @defer.inlineCallbacks
+    def setUp(self):
+        """Setup the infrastructure fo the test (dbus service)."""
+        # Class 'BaseTestCase' has no 'setUp' member
+        # pylint: disable=E1101
+        # dbus modules will be imported by the decorator
+        # pylint: disable=E0602
+        yield super(DBusTestCase, self).setUp()
+
+        # We need to ensure DBUS_SESSION_BUS_ADDRESS is private here
+        from urllib import unquote
+        bus_address = os.environ.get('DBUS_SESSION_BUS_ADDRESS', None)
+        if os.path.dirname(unquote(bus_address.split(',')[0].split('=')[1])) \
+                != os.path.dirname(os.getcwd()):
+            raise InvalidSessionBus('DBUS_SESSION_BUS_ADDRES is wrong.')
+
+        # Set up the main loop and bus connection
+        self.loop = DBusGMainLoop(set_as_default=True)
+        self.bus = dbus.bus.BusConnection(address_or_type=bus_address,
+                                          mainloop=self.loop)
+
+        # Monkeypatch the dbus.SessionBus/SystemBus methods, to ensure we
+        # always point at our own private bus instance.
+        self.patch(dbus, 'SessionBus', lambda: self.bus)
+        self.patch(dbus, 'SystemBus', lambda: self.bus)
+
+        # Check that we are on the correct bus for real
+# Disable this for now, because our tests are extremely broken :(
+#        bus_names = self.bus.list_names()
+#        if len(bus_names) > 2:
+#            raise InvalidSessionBus('Too many bus connections: %s (%r)' %
+#                                    (len(bus_names), bus_names))
+
+        # monkeypatch busName.__del__ to avoid errors on gc
+        # we take care of releasing the name in shutdown
+        service.BusName.__del__ = lambda _: None
+        yield self.bus.set_exit_on_disconnect(False)
+        self.signal_receivers = set()
+
+    @defer.inlineCallbacks
+    def tearDown(self):
+        """Cleanup the test."""
+        yield self.bus.flush()
+        yield self.bus.close()
+        yield super(DBusTestCase, self).tearDown()

=== modified file 'ubuntuone/devtools/testing/txcheck.py'
--- ubuntuone/devtools/testing/txcheck.py	2011-11-03 11:50:48 +0000
+++ ubuntuone/devtools/testing/txcheck.py	2011-11-23 11:17:24 +0000
@@ -330,7 +330,7 @@
     class TXCheckTest(TestCase):
         """Test case which checks the test classes for problems."""
 
-        def runTest(self):  # pylint: disable-msg=C0103
+        def runTest(self):  # pylint: disable=C0103
             """Do nothing."""
 
         def run(self, result=None):