Merge lp:~nataliabidart/ubuntu-sso-client/build-on-linux into lp:ubuntu-sso-client

[Natalia Bidart]

- setup.py is now building on linux!

To test, run in linux:

./setup.py build

You should get an output like this:

nessita@dali:~/canonical/ussoc/build-on-linux$ ./setup.py build
ERROR: Python module pythoncom not found
ERROR: Python module win32com.server.policy not found
ERROR: Python module win32com.client not found
(15067)/kdeui (Wallet): The kwalletd service has been disabled
(15067)/kdeui (Wallet): The kwalletd service has been disabled
(15067)/kdeui (Wallet): The kwalletd service has been disabled
(15067)/kdeui (Wallet): The kwalletd service has been disabled
(15067)/kdeui (Wallet): The kwalletd service has been disabled
(15067)/kdeui (Wallet): The kwalletd service has been disabled
ERROR: Python module _winreg not found
ERROR: Python module ubuntu_sso.main.windows not found
ERROR: Python module ubuntu_sso.main.windows not found
ERROR: Python module ubuntu_sso.main.windows not found
ERROR: Python module ubuntu_sso.networkstate.windows not found
ERROR: Python module _winreg not found
ERROR: Python module ubuntu_sso.main.windows not found
running build
Compiled data/qt/error_message.ui into ubuntu_sso/qt/error_message_ui.py
Compiled data/qt/choose_sign_in.ui into ubuntu_sso/qt/choose_sign_in_ui.py
Compiled data/qt/setup_account.ui into ubuntu_sso/qt/setup_account_ui.py
Compiled data/qt/reset_password.ui into ubuntu_sso/qt/reset_password_ui.py
Compiled data/qt/terms_and_conditions.ui into ubuntu_sso/qt/terms_and_conditions_ui.py
Compiled data/qt/email_verification.ui into ubuntu_sso/qt/email_verification_ui.py
Compiled data/qt/success_message.ui into ubuntu_sso/qt/success_message_ui.py
Compiled data/qt/current_user_sign_in.ui into ubuntu_sso/qt/current_user_sign_in_ui.py
Compiled data/qt/forgotten_password.ui into ubuntu_sso/qt/forgotten_password_ui.py
running build_py
copying ubuntu_sso/qt/controllers.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/qt
copying ubuntu_sso/qt/error_message_ui.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/qt
copying ubuntu_sso/qt/terms_and_conditions_ui.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/qt
copying ubuntu_sso/qt/forgotten_password_ui.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/qt
copying ubuntu_sso/qt/current_user_sign_in_ui.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/qt
copying ubuntu_sso/qt/reset_password_ui.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/qt
copying ubuntu_sso/qt/choose_sign_in_ui.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/qt
copying ubuntu_sso/qt/email_verification_ui.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/qt
copying ubuntu_sso/qt/setup_account_ui.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/qt
copying ubuntu_sso/qt/success_message_ui.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/qt
running build_i18n
intltool-update -p -g ubuntu-sso-client
running build_icons
running build_help
WARNING: the following files are not recognized by DistUtilsExtra.auto:
  _trial_temp/tmp/_trial_marker
  _trial_temp/tmp/test.log
  _trial_temp/xdg_cache/sso/sso-client.log
  bin/windows-ubuntu-sso-login
  pylintrc
  run-tests
  run-tests.bat
  ubuntu_sso/main/tests/ubuntuone.reg
  ubuntu_sso/tests/bin/show_gui
  ubuntu_sso/tests/bin/show_nm_state
  ubuntu_sso/tests/files/captcha.png
nessita@dali:~/canonical/ussoc/build-on-linux$

[Diego Sarmentero (diegosarmentero)]

+1

review: Approve

[Roberto Alsina (ralsina)]

Hey, it does! :-)

review: Approve

=== modified file 'run-tests'
--- run-tests	2011-04-27 03:31:27 +0000
+++ run-tests	2011-07-19 00:45:37 +0000
@@ -27,6 +27,7 @@
 fi
 
 style_check() {
+    ./setup.py clean
     u1lint
     if [ -x `which pep8` ]; then
         pep8 --repeat bin/ $MODULE

=== modified file 'setup.py'
--- setup.py	2011-06-24 19:02:21 +0000
+++ setup.py	2011-07-19 00:45:37 +0000
@@ -1,10 +1,11 @@
 #!/usr/bin/env python
 # setup.py - Build system for Ubuntu SSO Client package
 #
-# Author: Natalia B. Bidart <[e-mail]>
-# Author: Manuel de la Pena <[e-mail]>
+# Authors: Natalia B. Bidart <[e-mail]>
+#          Manuel de la Pena <[e-mail]>
+#          Alejandro J. Cura <[e-mail]>
 #
-# Copyright 2010 Canonical Ltd.
+# Copyright 2010-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
@@ -17,9 +18,10 @@
 #
 # You should have received a copy of the GNU General Public License along
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
-"""setup.py"""
-
-import cgi
+"""Setup.py: build, distribute, clean."""
+
+# pylint: disable=W0404, W0511
+
 import os
 import sys
 
@@ -34,71 +36,42 @@
        'needs DistUtilsExtra.auto >= 2.18'
 
 from distutils import log
-from distutils.command import clean
-from distutils.spawn import find_executable
-
-# Defining variables for various rules here, similar to a Makefile.am
-LINUX_CLEANFILES = ['data/com.ubuntu.sso.service', 'po/ubuntu-sso-client.pot',
-              'MANIFEST']
-
-
-# pylint: disable=W0511
-# This needs some serious cleanup
-class SSOLinuxBuild(build_extra.build_extra):
-    """Build  the extra files required on Linux.."""
-
-    description = 'build extra files needed by ubuntu-sso-client'
-
-    def __init__(self, *args):
-        build_extra.build_extra.__init__(self, *args)
-
-    def run(self):
-        """Do the build."""
-        sed = find_executable('sed')
-        if sed is None:
-            sys.stderr.write('Cannont find sed; required to build')
-            sys.exit(-1)
-
-        in_file = 'data/com.ubuntu.sso.service.in'
-        out_file = 'data/com.ubuntu.sso.service'
-        replaced_path = '/usr/lib/ubuntu-sso-client'
-
-        cmd = "%(cmd)s -e 's|\@libexecdir\@|%(rep)s|g' < %(in)s > %(out)s"
-        os.system( cmd %
-                  {'cmd' : sed,
-                   'rep' : replaced_path,
-                   'in' : in_file,
-                   'out' : out_file,
-                   }
-                  )
-
-        # Run the parent build command
-        build_extra.build_extra.run(self)
-
-
-class SSOLinuxClean(clean.clean):
-    """Class to clean up after the build."""
-
-    description = 'Clean up built files.'
-
-    def run(self):
-        """Clean up the built files."""
-        for built_file in LINUX_CLEANFILES:
-            if os.path.exists(built_file):
-                os.unlink(built_file)
-
-        # Run the parent clean command
-        clean.clean.run(self)
-
-
-class SSOWindowsBuild(build_extra.build_extra):
+
+POT_FILE = 'po/ubuntu-sso-client.pot'
+SERVICE_FILE = 'data/com.ubuntu.sso.service'
+
+CLEANFILES = [SERVICE_FILE, POT_FILE, 'MANIFEST']
+QT_UI_DIR = os.path.join('ubuntu_sso', 'qt')
+
+def replace_prefix(prefix):
+    """Replace every '@prefix@' with prefix within 'filename' content."""
+    # replace .service file, DATA_DIR constant
+    for filename in (SERVICE_FILE,):
+        with open(filename + '.in') as in_file:
+            content = in_file.read()
+            with open(filename, 'w') as out_file:
+                out_file.write(content.replace('@prefix@', prefix))
+
+
+class SSOInstall(DistUtilsExtra.auto.install_auto):
+    """Class to install proper files."""
+
+    def run(self):
+        """Do the install.
+
+        Read from *.service.in and generate .service files by replacing
+        @prefix@ by self.prefix.
+
+        """
+        replace_prefix(self.prefix)
+        DistUtilsExtra.auto.install_auto.run(self)
+
+
+class SSOBuild(build_extra.build_extra):
     """Build PyQt (.ui) files and resources."""
 
     description = "build PyQt GUIs (.ui) and resources (.qrc)"
 
-    def __init__(self, *args):
-        build_extra.build_extra.__init__(self, *args)
-
     def compile_ui(self, ui_file, py_file=None):
         """Compile the .ui files to python modules."""
         # Search for pyuic4 in python bin dir, then in the $Path.
@@ -107,7 +80,7 @@
             # python file in the qt moodule
             py_file = os.path.split(ui_file)[1]
             py_file = os.path.splitext(py_file)[0] + '_ui.py'
-            py_file = os.path.join('ubuntu_sso', 'qt', py_file)
+            py_file = os.path.join(QT_UI_DIR, py_file)
         # we indeed want to catch Exception, is ugly but we need it
         # pylint: disable=W0703
         try:
@@ -120,7 +93,7 @@
             fp.close()
             log.info('Compiled %s into %s', ui_file, py_file)
         except Exception, e:
-            self.warn('Unable to compile user interface %s: %s', py_file, e)
+            self.warn('Unable to compile user interface %s: %s' % (py_file, e))
             if not os.path.exists(py_file) or not file(py_file).read():
                 raise SystemExit(1)
             return
@@ -133,13 +106,14 @@
         if py_file is None:
             py_file = os.path.split(qrc_file)[1]
             py_file = os.path.splitext(py_file)[0] + '_rc.py'
-            py_file = os.path.join('ubuntu_sso', 'qt', py_file)
+            py_file = os.path.join(QT_UI_DIR, py_file)
         path = os.getenv('PATH')
-        os.putenv('PATH', path + ';' + os.path.join(
-                  os.path.dirname(PyQt4.__file__),'bin'))
+        os.putenv('PATH', path + os.path.pathsep + os.path.join(
+                  os.path.dirname(PyQt4.__file__), 'bin'))
         if os.system('pyrcc4 "%s" -o "%s"' % (qrc_file, py_file)) > 0:
-            self.warn('Unable to generate python module %s '
-                      + 'for resource file %s', py_file, qrc_file)
+            self.warn('Unable to generate python module {py_file}'
+                      ' for resource file {qrc_file}'.format(
+                      py_file=py_file, qrc_file=qrc_file))
             if not os.path.exists(py_file) or not file(py_file).read():
                 raise SystemExit(1)
         else:
@@ -152,6 +126,7 @@
         f = open(qrc_file, 'w')
         try:
             f.write('<!DOCTYPE RCC><RCC version="1.0">\n')
+            import cgi
             f.write('  <qresource prefix="%s">\n' % cgi.escape(prefix))
             for e in srcfiles:
                 relpath = e[len(basedir) + 1:]
@@ -191,8 +166,11 @@
                 elif filename.endswith('.qrc'):
                     self.compile_rc(os.path.join(dirpath, filename))
 
+        build_extra.build_extra.run(self)
+
     # pylint: disable=E1002
     _wrappeduic = False
+
     @classmethod
     def _wrapuic(cls):
         """Wrap uic to use gettext's _() in place of tr()"""
@@ -207,13 +185,13 @@
             def createToplevelWidget(self, classname, widgetname):
                 o = indenter.getIndenter()
                 o.level = 0
-                o.write('from ubuntu_sso.utils.ui import _')
+                o.write('from gettext import gettext as _')
                 return super(_UICompiler, self).createToplevelWidget(classname,
                     widgetname)
         compiler.UICompiler = _UICompiler
 
         class _i18n_string(qtproxies.i18n_string):
-            """Provide a trnalated text."""
+            """Provide a translated text."""
 
             def __str__(self):
                 return "_('%s')" % self.string.encode('string-escape')
@@ -224,20 +202,25 @@
         # pylint: enable=C0103
     # pylint: enable=E1002
 
-class SSOWindowsClean(clean.clean):
-    """Clean the files from a Windows build."""
 
-    description = 'Clean up built files.'
+class SSOClean(DistUtilsExtra.auto.clean_build_tree):
+    """Class to clean up after the build."""
 
     def run(self):
         """Clean up the built files."""
-        # remove the generated ui files
-        for dirpath, _, filenames in os.walk(os.path.join('ubuntu_sso', 'qt')):
+        for built_file in CLEANFILES:
+            if os.path.exists(built_file):
+                os.unlink(built_file)
+
+        for dirpath, _, filenames in os.walk(os.path.join(QT_UI_DIR)):
             for current_file in filenames:
                 if current_file.endswith('_ui.py') or\
                                 current_file.endswith('_rc.py'):
                     os.unlink(os.path.join(dirpath, current_file))
 
+        DistUtilsExtra.auto.clean_build_tree.run(self)
+
+
 def set_py2exe_paths():
     """Set the path so that py2exe finds the required modules."""
     # Pylint does not understand same spaced imports which is what lazr uses
@@ -319,76 +302,62 @@
 
     return MediaCollector
 
+# pylint: disable=C0103
+
+cmdclass = {
+    'install': SSOInstall,
+    'build': SSOBuild,
+    'clean': SSOClean,
+}
+
 def setup_windows():
     """Provide the required info to setup the project on windows."""
     set_py2exe_paths()
-    _scripts = []
     _data_files = []
-    _packages = ['ubuntu_sso', 'ubuntu_sso.qt', 'ubuntu_sso.utils',
-                 'ubuntu_sso.keyring', 'ubuntu_sso.networkstate',
-                 'ubuntu_sso.main']
-    _extra = {}
-    _cmdclass = {'build' : SSOWindowsBuild,
-                 'clean' : SSOWindowsClean,
-                 'py2exe' : get_py2exe_extension()}
-
+    cmdclass['py2exe'] = get_py2exe_extension()
     # for PyQt, see http://www.py2exe.org/index.cgi/Py2exeAndPyQt
     _includes = ['sip', 'email', 'ubuntu_sso.qt.gui',
-                'ubuntu_sso.qt.controllers', 'PyQt4.QtNetwork', 'PIL']
-    # exclude the modules that are not part of windows, this will not do much
-    # besides the fact that the warnings wont be returned.
-    _excludes = ['dbus', 'dbus.mainloop.glib', 'osx_keychain', 'gobject',
-                'gnomekeyring']
-
-    _extra['options'] = {
-           'py2exe' : {
-               'bundle_files' : 1,
-               'skip_archive' : 0,
-               'includes' : _includes,
-               'optimize' : 1,
-               'dll_excludes': [ "mswsock.dll", "powrprof.dll" ]
-           }
-        }
-    # add the console script so that py2exe compiles it
-    _extra['console'] = ['bin/windows-ubuntu-sso-login',]
-    _extra['zipfile'] = None
-    return _scripts, _data_files, _packages, _extra, _cmdclass
-
-def setup_linux():
-    """Provide the required info to setup the project on linux."""
-    _scripts = []
-    _data_files = [('share/dbus-1/services', ['data/com.ubuntu.sso.service']),
+                 'ubuntu_sso.qt.controllers', 'PyQt4.QtNetwork', 'PIL']
+    _extra = {
+        'options': {
+            'py2exe': {
+                'bundle_files': 1,
+                'skip_archive': 0,
+                'includes': _includes,
+                'optimize': 1,
+                'dll_excludes': ["mswsock.dll", "powrprof.dll"],
+            },
+        },
+        # add the console script so that py2exe compiles it
+        'console': ['bin/windows-ubuntu-sso-login',],
+        'zipfile': None,
+    }
+    return _data_files, _extra
+
+if sys.platform == 'win32':
+    data_files, extra = setup_windows()
+else:
+    data_files = [('share/dbus-1/services', ['data/com.ubuntu.sso.service']),
                    ('lib/ubuntu-sso-client', ['bin/ubuntu-sso-login']),
                    ('share/ubuntu-sso-client/data/gtk', ['data/gtk/ui.glade'])]
-    _packages = ['ubuntu_sso', 'ubuntu_sso.gtk', 'ubuntu_sso.utils',
-                'ubuntu_sso.keyring', 'ubuntu_sso.networkstate',
-                'ubuntu_sso.main']
-    _extra = {}
-    _cmdclass = {'build' : SSOLinuxBuild,
-                 'clean' : SSOLinuxClean}
-    return _scripts, _data_files, _packages, _extra, _cmdclass
-
-if __name__ == "__main__":
-
-    # pylint: disable=C0103
-    scripts = data_files = packages = extra = cmdclass = None
-    if sys.platform == 'win32':
-        scripts, data_files, packages, extra, cmdclass = setup_windows()
-    else:
-        scripts, data_files, packages, extra, cmdclass = setup_linux()
-
-    DistUtilsExtra.auto.setup(
-        name='ubuntu-sso-client',
-        version='1.3.1',
-        license='GPL v3',
-        author='Natalia Bidart',
-        author_email='[e-mail]',
-        description='Ubuntu Single Sign-On client',
-        long_description='Desktop service to allow applications to sign in' \
-            'to Ubuntu services via SSO',
-        url='https://launchpad.net/ubuntu-sso-client',
-        scripts=scripts,
-        data_files=data_files,
-        packages=packages,
-        cmdclass=cmdclass,
-        **extra)
+    extra = {}
+
+DistUtilsExtra.auto.setup(
+    name='ubuntu-sso-client',
+    version='1.3.1',
+    license='GPL v3',
+    author='Natalia Bidart',
+    author_email='[e-mail]',
+    description='Ubuntu Single Sign-On client',
+    long_description='Desktop service to allow applications to sign in' \
+        'to Ubuntu services via SSO',
+    url='https://launchpad.net/ubuntu-sso-client',
+    extra_path='ubuntu-sso-client',
+    data_files=data_files,
+    packages=[
+        'ubuntu_sso', 'ubuntu_sso.utils', 'ubuntu_sso.keyring',
+        'ubuntu_sso.networkstate', 'ubuntu_sso.main',
+        'ubuntu_sso.gtk', 'ubuntu_sso.qt',
+    ],
+    cmdclass=cmdclass,
+    **extra)

=== modified file 'ubuntu_sso/qt/controllers.py'
--- ubuntu_sso/qt/controllers.py	2011-07-06 17:10:13 +0000
+++ ubuntu_sso/qt/controllers.py	2011-07-19 00:45:37 +0000
@@ -31,7 +31,6 @@
 
 from ubuntu_sso import NO_OP
 from ubuntu_sso.logger import setup_logging
-from ubuntu_sso.main.windows import UbuntuSSOClient
 from ubuntu_sso.utils.ui import (
     CAPTCHA_SOLUTION_ENTRY,
     EMAIL1_ENTRY,
@@ -98,6 +97,7 @@
         """Return the backend used by the controller."""
         # get the back end from the root
         if self.root is None:
+            from ubuntu_sso.main.windows import UbuntuSSOClient
             self.root = UbuntuSSOClient()
             self.root = yield self.root.connect()
         self.backend = self.root.sso_login