Merge lp:~mikemc/ubuntuone-client/add-no-reactor-test into lp:ubuntuone-client

[Mike McCracken]

- Add test script that fails if reactor is imported from the wrong place (LP: #1030961)

- Add test script that fails if reactor is imported from the wrong place (LP: #1030961)

[dobey (dobey)]

As this is entirely new code, and it is Python, I think it would be good to use the new syntax for certain things, and import unicode_literals and print_statement from __future__.

review: Needs Fixing

[lp:~mikemc/ubuntuone-client/add-no-reactor-test]

1287. By Mike McCracken on 2012-07-30

use new-style print function, format syntax

[dobey (dobey)]

The %-notation for strings is still valid and acceptable, if you prefer it. I just meant the necessary things like unicode string literals (to expose potential issues when they come up) and the print function. Thanks.

review: Approve

[Brian Curtin (brian.curtin)]

Looks good to me.

review: Approve

=== modified file 'Makefile.am'
--- Makefile.am	2012-07-11 17:23:37 +0000
+++ Makefile.am	2012-07-30 21:47:17 +0000
@@ -56,6 +56,7 @@
 	if test "x$(builddir)" == "x$(srcdir)"; then \
 		PYTHONPATH="$(PYTHONPATH)" u1trial -r $(REACTOR) -p tests/platform/windows,tests/proxy -i "test_windows.py,test_darwin.py,test_fsevents_daemon.py" tests || exit 1; \
 		PYTHONPATH="$(PYTHONPATH)" u1trial -r qt4 -p tests/platform/windows -i "test_windows.py,test_darwin.py" tests/proxy || exit 1; \
+		PYTHONPATH="$(PYTHONPATH)" $(PYTHON) tests/platform/check_reactor_import.py || exit 1; \
 	fi
 	rm -rf _trial_temp
 

=== modified file 'run-mac-tests'
--- run-mac-tests	2012-06-27 19:48:24 +0000
+++ run-mac-tests	2012-07-30 21:47:17 +0000
@@ -45,3 +45,5 @@
 python $u1trial --reactor=twisted -i "test_linux.py,test_windows.py" -p tests/platform/linux "$MODULE"
 rm -rf _trial_temp
 rm -rf build
+
+python tests/platform/check_reactor_import.py

=== modified file 'run-tests.bat'
--- run-tests.bat	2012-06-27 17:38:05 +0000
+++ run-tests.bat	2012-07-30 21:47:17 +0000
@@ -82,6 +82,8 @@
 ECHO Performing style checks...
 "%PYTHONEXEPATH%" "%LINTPATH%"
 
+"%PYTHONEXEPATH%" tests\platform\check_reactor_import.py
+
 :: if pep8 is not present, move to the end
 IF EXIST "%PEP8PATH%" (
     "%PEP8PATH%" --repeat ubuntuone

=== added file 'tests/platform/check_reactor_import.py'
--- tests/platform/check_reactor_import.py	1970-01-01 00:00:00 +0000
+++ tests/platform/check_reactor_import.py	2012-07-30 21:47:17 +0000
@@ -0,0 +1,74 @@
+#! /usr/bin/python
+#
+# Copyright (C) 2012 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/>.
+#
+# In addition, as a special exception, the copyright holders give
+# permission to link the code of portions of this program with the
+# OpenSSL library under certain conditions as described in each
+# individual source file, and distribute linked combinations
+# including the two.
+# You must obey the GNU General Public License in all respects
+# for all of the code used other than OpenSSL.  If you modify
+# file(s) with this exception, you may extend this exception to your
+# version of the file(s), but you are not obligated to do so.  If you
+# do not wish to do so, delete this exception statement from your
+# version.  If you delete this exception statement from all source
+# files in the program, then also delete it here.
+"""A script that checks for unintended imports of twisted.internet.reactor."""
+
+# NOTE: the goal of this script is to avoid a bug that affects
+# ubuntuone-control-panel on windows and darwin. Those platforms use
+# the qt4reactor, and will break if the default reactor is installed
+# first. This can happen if a module used by control-panel (such as
+# ubuntuone.platform.credentials), imports reactor.  Only sub-modules
+# that are not used by ubuntuone-control-panel can safely import
+# reactor at module-level.
+
+from __future__ import (unicode_literals, print_function)
+
+import __builtin__
+
+import sys
+import traceback
+
+
+def fake_import(*args, **kwargs):
+    """A wrapper for __import__ that dies when importing reactor."""
+    imp_name_base = args[0]
+
+    if len(args) == 4 and args[3] is not None:
+        imp_names = ["{0}.{1}".format(imp_name_base, sm)
+                     for sm in args[3]]
+    else:
+        imp_names = [imp_name_base]
+
+    for imp_name in imp_names:
+        if 'twisted.internet.reactor' == imp_name:
+            print("ERROR: should not import reactor here:")
+            traceback.print_stack()
+            sys.exit(1)
+
+    r = real_import(*args, **kwargs)
+    return r
+
+
+if __name__ == '__main__':
+
+    real_import = __builtin__.__import__
+    __builtin__.__import__ = fake_import
+
+    subs = ["", ".tools", ".logger", ".credentials"]
+    for module in ["ubuntuone.platform" + p for p in subs]:
+        m = __import__(module)