Merge lp:~brian.curtin/ubuntuone-windows-installer/buildout-env into lp:ubuntuone-windows-installer

[Brian Curtin]

- Implement a buildout to create a simple, reproducible development environment.

Implement a buildout providing all of our necessary dependencies as well as support for running Python within that environment.

This change provides the following:
* bootstrap.py
 The buildout bootstrap script, to be executed first in order to bootstrap the environment. The script should be executed as "C:\Python27\python.exe bootstrap.py --distribute" to kick the setup off.
* buildout.cfg
 Version-specific configuration of all dependencies needed to build, run, and test all U1 projects. This includes a common "development" set of cross-platform dependencies, and a "windows" set which inherits from "development" and includes Windows-only projects. This script is picked up by the bin\buildout.exe binary created by the bootstrap. In order to setup a Windows environment, run "bin\buidout.exe install windows". The "install sources" will create branches of all of our projects in the "parts" folder.

* env.bat
 A batch script to be run which does some environment setup to place the buildout-specific Python in the path for the current command prompt session and place any auxiliary scripts in the proper places, e.g., u1trial.

* get_protoc.py
 A Python script to fetch the proper version of Google Protobuf to place the protoc.exe compiler in the Path. This is executed by the env.bat script.

[lp:~brian.curtin/ubuntuone-windows-installer/buildout-env]

116. By Brian Curtin on 2012-04-17

direction updates

117. By Brian Curtin on 2012-04-18

Move standalone script code into a function

[Roberto Alsina (ralsina)]

I wuld move dirspec into sources but other than that, excellent branch!

review: Approve

[Alejandro J. Cura (alecu)]

I seem to have completely missed the "--distribute" flag when running bootstrap.py for the first time, so probably something broke on my end because of that. Sorry!

I was able to run all tests in the buildout created by this branch, but for that I had to remove the devtools installed by these scripts and force the use of devtools from trunk, otherwise I would get an error caused by a missing new testing baseclass that was recently added by mandel to devtools.

I think that deserves a different bug, so I'm approving this branch.

Great work!

review: Approve

=== added directory 'scripts/devsetup'
=== added file 'scripts/devsetup/README.txt'
--- scripts/devsetup/README.txt	1970-01-01 00:00:00 +0000
+++ scripts/devsetup/README.txt	2012-04-18 14:27:24 +0000
@@ -0,0 +1,39 @@
+Ubuntu One buildout
+===================
+
+This is a buildout for Ubuntu One. It aims to provide the following 
+when developing on windows (or in other Linuxes other than Ubuntu?):
+
+* A controlled set of dependencies for all our code
+* A mechanism to create a repeatable build for our windows releases
+* A simpler, more automated windows developer setup
+
+How Do I Use It
+===============
+
+1. Get python 2.7 32 bits, get PyQt, get pywin32.
+2. Setup bazaar and your keys
+3. python bootstrap.py
+
+If you are on Windows, run "bin\buildout install windows"
+On other OSes, run "bin\buildout install development"
+
+At this point you should have a bin\python.exe which is a custom interpreter
+that can access all the required dependencies. If it fails installing
+logilab-something: try again.
+
+You should also have all the required scripts, like pep8, coverage and pylint,
+in the bin folder.
+
+5. bin\buildout install sources
+
+This will do a clean branch of all our relevant source code into the parts
+folder, so you can use it. As long as you use the custom python interpreter,
+everything should just work as you are used to. If it doesn't let me know
+at [e-mail]
+
+6. On Windows, running "env.bat" will put the "bin\python.exe" which
+buildout created into the Path. It will also gather necessary scripts
+from the buildout and place them in the bin folder as needed. Now your
+tests should be able to use this Python in this buildout and work without
+needed anything installed into your system's Python installation.

=== added file 'scripts/devsetup/bootstrap.py'
--- scripts/devsetup/bootstrap.py	1970-01-01 00:00:00 +0000
+++ scripts/devsetup/bootstrap.py	2012-04-18 14:27:24 +0000
@@ -0,0 +1,262 @@
+##############################################################################
+#
+# Copyright (c) 2006 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Bootstrap a buildout-based project
+
+Simply run this script in a directory containing a buildout.cfg.
+The script accepts buildout command-line options, so you can
+use the -c option to specify an alternate configuration file.
+"""
+
+import os, shutil, sys, tempfile, urllib, urllib2, subprocess
+from optparse import OptionParser
+
+if sys.platform == 'win32':
+    def quote(c):
+        if ' ' in c:
+            return '"%s"' % c  # work around spawn lamosity on windows
+        else:
+            return c
+else:
+    quote = str
+
+# See zc.buildout.easy_install._has_broken_dash_S for motivation and comments.
+stdout, stderr = subprocess.Popen(
+    [sys.executable, '-Sc',
+     'try:\n'
+     '    import ConfigParser\n'
+     'except ImportError:\n'
+     '    print 1\n'
+     'else:\n'
+     '    print 0\n'],
+    stdout=subprocess.PIPE, stderr=subprocess.PIPE).communicate()
+has_broken_dash_S = bool(int(stdout.strip()))
+
+# In order to be more robust in the face of system Pythons, we want to
+# run without site-packages loaded.  This is somewhat tricky, in
+# particular because Python 2.6's distutils imports site, so starting
+# with the -S flag is not sufficient.  However, we'll start with that:
+if not has_broken_dash_S and 'site' in sys.modules:
+    # We will restart with python -S.
+    args = sys.argv[:]
+    args[0:0] = [sys.executable, '-S']
+    args = map(quote, args)
+    os.execv(sys.executable, args)
+# Now we are running with -S.  We'll get the clean sys.path, import site
+# because distutils will do it later, and then reset the path and clean
+# out any namespace packages from site-packages that might have been
+# loaded by .pth files.
+clean_path = sys.path[:]
+import site  # imported because of its side effects
+sys.path[:] = clean_path
+for k, v in sys.modules.items():
+    if k in ('setuptools', 'pkg_resources') or (
+        hasattr(v, '__path__') and
+        len(v.__path__) == 1 and
+        not os.path.exists(os.path.join(v.__path__[0], '__init__.py'))):
+        # This is a namespace package.  Remove it.
+        sys.modules.pop(k)
+
+is_jython = sys.platform.startswith('java')
+
+setuptools_source = 'http://peak.telecommunity.com/dist/ez_setup.py'
+distribute_source = 'http://python-distribute.org/distribute_setup.py'
+
+
+# parsing arguments
+def normalize_to_url(option, opt_str, value, parser):
+    if value:
+        if '://' not in value:  # It doesn't smell like a URL.
+            value = 'file://%s' % (
+                urllib.pathname2url(
+                    os.path.abspath(os.path.expanduser(value))),)
+        if opt_str == '--download-base' and not value.endswith('/'):
+            # Download base needs a trailing slash to make the world happy.
+            value += '/'
+    else:
+        value = None
+    name = opt_str[2:].replace('-', '_')
+    setattr(parser.values, name, value)
+
+usage = '''\
+[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options]
+
+Bootstraps a buildout-based project.
+
+Simply run this script in a directory containing a buildout.cfg, using the
+Python that you want bin/buildout to use.
+
+Note that by using --setup-source and --download-base to point to
+local resources, you can keep this script from going over the network.
+'''
+
+parser = OptionParser(usage=usage)
+parser.add_option("-v", "--version", dest="version",
+                          help="use a specific zc.buildout version")
+parser.add_option("-d", "--distribute",
+                   action="store_true", dest="use_distribute", default=False,
+                   help="Use Distribute rather than Setuptools.")
+parser.add_option("--setup-source", action="callback", dest="setup_source",
+                  callback=normalize_to_url, nargs=1, type="string",
+                  help=("Specify a URL or file location for the setup file. "
+                        "If you use Setuptools, this will default to " +
+                        setuptools_source + "; if you use Distribute, this "
+                        "will default to " + distribute_source + "."))
+parser.add_option("--download-base", action="callback", dest="download_base",
+                  callback=normalize_to_url, nargs=1, type="string",
+                  help=("Specify a URL or directory for downloading "
+                        "zc.buildout and either Setuptools or Distribute. "
+                        "Defaults to PyPI."))
+parser.add_option("--eggs",
+                  help=("Specify a directory for storing eggs.  Defaults to "
+                        "a temporary directory that is deleted when the "
+                        "bootstrap script completes."))
+parser.add_option("-t", "--accept-buildout-test-releases",
+                  dest='accept_buildout_test_releases',
+                  action="store_true", default=False,
+                  help=("Normally, if you do not specify a --version, the "
+                        "bootstrap script and buildout gets the newest "
+                        "*final* versions of zc.buildout and its recipes and "
+                        "extensions for you.  If you use this flag, "
+                        "bootstrap and buildout will get the newest releases "
+                        "even if they are alphas or betas."))
+parser.add_option("-c", None, action="store", dest="config_file",
+                   help=("Specify the path to the buildout configuration "
+                         "file to be used."))
+
+options, args = parser.parse_args()
+
+# if -c was provided, we push it back into args for buildout's main function
+if options.config_file is not None:
+    args += ['-c', options.config_file]
+
+if options.eggs:
+    eggs_dir = os.path.abspath(os.path.expanduser(options.eggs))
+else:
+    eggs_dir = tempfile.mkdtemp()
+
+if options.setup_source is None:
+    if options.use_distribute:
+        options.setup_source = distribute_source
+    else:
+        options.setup_source = setuptools_source
+
+if options.accept_buildout_test_releases:
+    args.append('buildout:accept-buildout-test-releases=true')
+args.append('bootstrap')
+
+try:
+    import pkg_resources
+    import setuptools  # A flag.  Sometimes pkg_resources is installed alone.
+    if not hasattr(pkg_resources, '_distribute'):
+        raise ImportError
+except ImportError:
+    ez_code = urllib2.urlopen(
+        options.setup_source).read().replace('\r\n', '\n')
+    ez = {}
+    exec ez_code in ez
+    setup_args = dict(to_dir=eggs_dir, download_delay=0)
+    if options.download_base:
+        setup_args['download_base'] = options.download_base
+    if options.use_distribute:
+        setup_args['no_fake'] = True
+    ez['use_setuptools'](**setup_args)
+    if 'pkg_resources' in sys.modules:
+        reload(sys.modules['pkg_resources'])
+    import pkg_resources
+    # This does not (always?) update the default working set.  We will
+    # do it.
+    for path in sys.path:
+        if path not in pkg_resources.working_set.entries:
+            pkg_resources.working_set.add_entry(path)
+
+cmd = [quote(sys.executable),
+       '-c',
+       quote('from setuptools.command.easy_install import main; main()'),
+       '-mqNxd',
+       quote(eggs_dir)]
+
+if not has_broken_dash_S:
+    cmd.insert(1, '-S')
+
+find_links = options.download_base
+if not find_links:
+    find_links = os.environ.get('bootstrap-testing-find-links')
+if find_links:
+    cmd.extend(['-f', quote(find_links)])
+
+if options.use_distribute:
+    setup_requirement = 'distribute'
+else:
+    setup_requirement = 'setuptools'
+ws = pkg_resources.working_set
+setup_requirement_path = ws.find(
+    pkg_resources.Requirement.parse(setup_requirement)).location
+env = dict(
+    os.environ,
+    PYTHONPATH=setup_requirement_path)
+
+requirement = 'zc.buildout'
+version = options.version
+if version is None and not options.accept_buildout_test_releases:
+    # Figure out the most recent final version of zc.buildout.
+    import setuptools.package_index
+    _final_parts = '*final-', '*final'
+
+    def _final_version(parsed_version):
+        for part in parsed_version:
+            if (part[:1] == '*') and (part not in _final_parts):
+                return False
+        return True
+    index = setuptools.package_index.PackageIndex(
+        search_path=[setup_requirement_path])
+    if find_links:
+        index.add_find_links((find_links,))
+    req = pkg_resources.Requirement.parse(requirement)
+    if index.obtain(req) is not None:
+        best = []
+        bestv = None
+        for dist in index[req.project_name]:
+            distv = dist.parsed_version
+            if _final_version(distv):
+                if bestv is None or distv > bestv:
+                    best = [dist]
+                    bestv = distv
+                elif distv == bestv:
+                    best.append(dist)
+        if best:
+            best.sort()
+            version = best[-1].version
+if version:
+    requirement = '=='.join((requirement, version))
+cmd.append(requirement)
+
+if is_jython:
+    import subprocess
+    exitcode = subprocess.Popen(cmd, env=env).wait()
+else:  # Windows prefers this, apparently; otherwise we would prefer subprocess
+    exitcode = os.spawnle(*([os.P_WAIT, sys.executable] + cmd + [env]))
+if exitcode != 0:
+    sys.stdout.flush()
+    sys.stderr.flush()
+    print ("An error occurred when trying to install zc.buildout. "
+           "Look above this message for any errors that "
+           "were output by easy_install.")
+    sys.exit(exitcode)
+
+ws.add_entry(eggs_dir)
+ws.require(requirement)
+import zc.buildout.buildout
+zc.buildout.buildout.main(args)
+if not options.eggs:  # clean up temporary egg directory
+    shutil.rmtree(eggs_dir)

=== added file 'scripts/devsetup/buildout.cfg'
--- scripts/devsetup/buildout.cfg	1970-01-01 00:00:00 +0000
+++ scripts/devsetup/buildout.cfg	2012-04-18 14:27:24 +0000
@@ -0,0 +1,98 @@
+[buildout]
+parts =
+    development
+    windows
+
+find-links =
+    https://github.com/ghtdak/qtreactor/tarball/master#egg=qt4reactor
+    http://launchpad.net/python-distutils-extra/trunk/2.31/+download/python-distutils-extra-2.31.tar.gz#egg=python-distutils-extra
+# Mandel's patched keyring, already built
+    http://u1.to/ralsina/L/keyring-0.7-py2.7.egg#egg=keyring
+# Pycrypto already built using python -c "import setuptools; execfile('setup.py')" bdist_egg
+    http://u1.to/ralsina/P/pycrypto-2.4.1-py2.7-win32.egg#egg=pycrypto
+# Py2exe already build using python -c "import setuptools; execfile('setup.py')" bdist_egg
+    http://u1.to/ralsina/x/py2exe-0.6.9-py2.7-win32.egg#egg=py2exe
+# Protobuf's upstream zip file doesn't work via easy_install so using an egg.
+    http://u1.to/ralsina/G/protobuf-2.4.1-py2.7.egg#egg=protobuf
+# Comtypes has a bug in setup.py with Python 2.7, so this should be changed eventually
+# http://sourceforge.net/tracker/index.php?func=detail&aid=3036368&group_id=115265&atid=692940
+    http://u1.to/ralsina/w/comtypes-0.6.2.zip#egg=comtypes
+    http://launchpad.net/configglue/trunk/1.0/+download/configglue-1.0.tar.gz#egg=configglue
+    http://launchpad.net/ubuntuone-dev-tools/stable-3-0/3.0.0/+download/ubuntuone-dev-tools-3.0.0.tar.gz#egg=ubuntuone-dev-tools
+    http://launchpad.net/dirspec/stable-3-0/3.0.0/+download/dirspec-3.0.0.tar.gz#egg=dirspec
+    http://u1.to/ralsina/7/Twisted-11.1.0-py2.7-win32.egg#egg=twisted
+unzip = true
+newest = false
+versions = versions
+
+[windows]
+recipe =  zc.recipe.egg:scripts
+versions = versions
+eggs =
+    py2exe
+    comtypes
+# Include the common [development] eggs
+    ${development:eggs}
+interpreter = python
+
+[development]
+recipe = zc.recipe.egg:scripts
+eggs =
+    twisted
+    qt4reactor
+    python-distutils-extra
+    keyring
+    pycrypto
+    lazr.restfulclient
+    pyOpenSSL
+    pil
+    httplib2
+    protobuf
+    configglue
+    logilab-astng
+    logilab-common
+    mocker
+    coverage
+    pylint
+    pyflakes
+    pep8
+    ubuntuone-dev-tools
+    dirspec
+    oauth
+    simplejson
+versions = versions
+interpreter = python
+
+[versions]
+twisted = 11.1.0
+# qt4reactor does not go in here. Specifying the github link covers it.
+python-distutils-extra = 2.31
+keyring = 0.7
+pycrypto = 2.4.1
+lazr.restfulclient = 0.12.0
+pyOpenSSL = 0.13
+pil = 1.1.7
+httplib2 = 0.7.2
+protobuf = 2.4.1
+configglue = 1.0.0
+logilab-astng = 0.23.1
+logilab-common = 0.57.1
+mocker = 1.1
+coverage = 3.5.1
+pylint = 0.25.1
+pyflakes = 0.5.0
+pep8 = 0.6.1
+ubuntuone-dev-tools = 3.0.0
+dirspec = 3.0.0
+oauth = 1.0.1
+py2exe = 0.6.9
+comtypes = 0.6.2
+
+[sources]
+recipe = bazaarrecipeinfrae
+urls =    
+    lp:ubuntuone-client ubuntuone-client
+    lp:ubuntu-sso-client ubuntu-sso-client
+    lp:ubuntuone-storage-protocol ubuntuone-storage-protocol
+    lp:ubuntuone-control-panel ubuntuone-control-panel
+    lp:ubuntuone-windows-installer ubuntuone-windows-installer

=== added file 'scripts/devsetup/env.bat'
--- scripts/devsetup/env.bat	1970-01-01 00:00:00 +0000
+++ scripts/devsetup/env.bat	2012-04-18 14:27:24 +0000
@@ -0,0 +1,79 @@
+@echo off
+
+:: for jenkins
+cd %~dp0
+
+SET PYTHONPATHTOKENS=3
+VER | FIND "XP" > nul
+IF %ERRORLEVEL% == 0 SET PYTHONPATHTOKENS=4
+
+echo Adding bin folder to Path
+set Path=%CD%\bin;%Path%
+
+:: Get protoc.exe for ubuntuone-storage-protocol building
+:: This will use the Python on the Path that we got from Buildout
+python.exe get_protoc.py
+
+
+FOR /F "tokens=*" %%A IN ('python -c "import sys;print [dir for dir in sys.path if \"ubuntuone_dev_tools\" in dir][0]"') DO SET DEVTOOLS=%%A
+FOR /F "tokens=*" %%A IN ('python -c "import sys;print [dir for dir in sys.path if \"pylint\" in dir][0]"') DO SET PYLINT=%%A
+FOR /F "tokens=*" %%A IN ('python -c "import sys;print [dir for dir in sys.path if \"pyflakes\" in dir][0]"') DO SET PYFLAKES=%%A
+
+IF EXIST "%~dp0bin\u1trial" GOTO TRIALALREADY
+echo Copying u1trial to bin
+copy %DEVTOOLS%\EGG-INFO\scripts\u1trial bin
+copy %DEVTOOLS%\EGG-INFO\scripts\u1trial.bat bin
+:TRIALALREADY
+
+IF EXIST "%~dp0bin\u1lint" GOTO LINTALREADY
+echo Copying u1lint to bin
+copy %DEVTOOLS%\EGG-INFO\scripts\u1lint bin
+copy %DEVTOOLS%\EGG-INFO\scripts\u1lint.bat bin
+:LINTALREADY
+
+IF EXIST "%~dp0bin\pylint" GOTO PYLINTALREADY
+echo Copying pylint to bin
+copy %PYLINT%\EGG-INFO\scripts\pylint bin
+copy %PYLINT%\\EGG-INFO\scripts\pylint.bat bin
+:PYLINTALREADY
+
+IF EXIST "%~dp0bin\pyflakes" GOTO PYFLAKESALREADY
+echo Copying pyflakes to bin
+copy %PYFLAKES%\pyflakes\scripts\pyflakes.py bin\pyflakes
+:PYFLAKESALREADY
+
+:: Running ubuntuone-control-panel tests requires -protocol to be built
+IF EXIST "%~dp0parts\ubuntuone-storage-protocol\build" GOTO PROTOCOLBUILT
+echo Building ubuntuone-storage-protocol
+cd parts\ubuntuone-storage-protocol
+python.exe setup.py install
+cd %~dp0
+:PROTOCOLBUILT
+
+
+
+:: Run all tests
+IF NOT "%1" == "testall" GOTO END
+
+cd parts\ubuntu-sso-client
+:: Check for one of the expected reg values and install the value if we don't find it.
+FOR /F "tokens=%PYTHONPATHTOKENS%" %%A IN ('REG QUERY "HKEY_LOCAL_MACHINE\SOFTWARE\Ubuntu One" /v path-ubuntuone-syncdaemon') DO SET SYNCDAEMON=%%A
+IF NOT %errorlevel% == 0 ubuntu_sso\main\tests\ubuntuone.reg
+
+CALL run-tests.bat
+cd "%~dp0"
+
+cd parts\ubuntuone-client
+CALL run-tests.bat
+cd "%~dp0"
+
+cd parts\ubuntuone-control-panel
+CALL run-tests.bat
+cd "%~dp0"
+
+cd parts\ubuntuone-windows-installer
+CALL run-tests.bat
+cd "%~dp0"
+
+:END
+

=== added file 'scripts/devsetup/get_protoc.py'
--- scripts/devsetup/get_protoc.py	1970-01-01 00:00:00 +0000
+++ scripts/devsetup/get_protoc.py	2012-04-18 14:27:24 +0000
@@ -0,0 +1,33 @@
+import sys
+import subprocess
+import shlex
+import os
+import urllib
+import tempfile
+import zipfile
+
+URL = "http://protobuf.googlecode.com/files/protoc-2.4.1-win32.zip"
+
+def get_protoc():
+    response = urllib.urlopen(URL)
+    data = response.read()
+    if not data:
+        raise Exception("Unable to download %s" % URL)
+
+    fd, name = tempfile.mkstemp()
+
+    with os.fdopen(fd, "w") as f:
+        f.write(data)
+    with zipfile.ZipFile(name) as zf:
+        path = zf.extract("protoc.exe", "bin")
+    return path
+
+def _main():
+    bin_dir = os.path.join(os.getcwd(), "bin")
+    if not os.path.exists(os.path.join(bin_dir, "protoc.exe")):
+        path = get_protoc()
+        print "Protobuf compiler installed to %s" % path
+
+if __name__ == "__main__":
+    sys.exit(_main())
+

=== added file 'scripts/devsetup/updateall.bat'
--- scripts/devsetup/updateall.bat	1970-01-01 00:00:00 +0000
+++ scripts/devsetup/updateall.bat	2012-04-18 14:27:24 +0000
@@ -0,0 +1,23 @@
+@echo off
+
+cd %1\ubuntu-sso-client
+bzr pull
+cd %~dp0
+
+cd %1\ubuntuone-client
+bzr pull
+cd %~dp0
+
+cd %1\ubuntuone-control-panel
+bzr pull
+cd %~dp0
+
+cd %1\ubuntuone-storage-protocol
+bzr pull
+cd %~dp0
+
+cd %1\ubuntuone-windows-installer
+bzr pull
+cd %~dp0
+
+cd %~dp0