launchpad-reviewers team mailing list archive

[Gavin Panella <gavin.panella@xxxxxxxxxxxxx>]

Gavin Panella has proposed merging lp:~allenap/txlongpoll/bootstrap-without-net into lp:txlongpoll.

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~allenap/txlongpoll/bootstrap-without-net/+merge/81323

Several fixes relating to making deployment easier for the LOSAs, and
reliably repeatable:

- Make txlongpoll bootstrappable locally, without network, and build
  from cache.

- `make build` now only builds what's needed to _run_ txlongpoll.

- `make bin/test` installs the test runner and dependencies.

- `make tags TAGS` builds tag files.

- Build with relative paths to make deployment a bit easier, which
  goes in hand with the next change...

- `make build-update-paths` is for the use of people deploying
  txlongpoll, i.e. the LOSAs. They will build txlongpoll on one
  machine and sync it to another, but at a different fs location.
  `make build-update-paths` fixes the last few remaining absolute
  paths in the buildout. I suspect that the need to do this indicates
  a deficiency or bug in buildout or one of the recipes.

- Updated the README to reflect much of the above.

- Depend on txAMQP >= 0.5 because lower versions cause test failures.

-- 
https://code.launchpad.net/~allenap/txlongpoll/bootstrap-without-net/+merge/81323
Your team Launchpad code reviewers is requested to review the proposed merge of lp:~allenap/txlongpoll/bootstrap-without-net into lp:txlongpoll.

=== modified file 'Makefile'
--- Makefile	2011-11-04 14:35:34 +0000
+++ Makefile	2011-11-04 20:22:23 +0000
@@ -2,54 +2,68 @@
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 PYTHON = python
-PY = $(PWD)/bin/py
-
-BUILDOUT_CFG = buildout.cfg
-
-# Do not add bin/buildout to this list. It is impossible to get
-# buildout to tell us all the files it would build, since each egg's
-# setup.py doesn't tell us that information.
-#
-# NB: It's important BUILDOUT_BIN only mentions things genuinely
-# produced by buildout.
-BUILDOUT_BIN = $(PY) bin/tags bin/test bin/txlongpoll
+
+BUILDOUT_BIN := bin/buildout
+BUILDOUT_CFG := buildout.cfg
+BUILDOUT := $(BUILDOUT_BIN) -qc $(BUILDOUT_CFG)
 
 
 default: check
 
 
+build: bin/twistd
+
+
+# When a built tree is moved this updates absolute paths.
+build-update-paths:
+	$(BUILDOUT)
+
+
+check: bin/test
+	bin/test -vv
+
+
+dist: $(BUILDOUT_BIN)
+	$(BUILDOUT) setup setup.py egg_info -r sdist
+
+
+TAGS: bin/tags
+	bin/tags --ctags-emacs
+
+
+tags: bin/tags
+	bin/tags --ctags-vi
+
+
 download-cache:
-	mkdir download-cache
-
-
-bin/buildout: download-cache
-	$(PYTHON) bootstrap.py
+	mkdir -p download-cache
+
+
+eggs:
+	mkdir -p eggs
+
+
+$(BUILDOUT_BIN): download-cache eggs
+	PYTHONPATH= $(PYTHON) bootstrap.py \
+	    --setup-source=ez_setup.py \
+	    --download-base=download-cache/dist \
+	    --eggs=eggs --version=1.5.2
 	touch --no-create $@
 
 
-$(PY): bin/buildout $(BUILDOUT_CFG) setup.py
-	PYTHONPATH=. ./bin/buildout -c $(BUILDOUT_CFG)
-
-
-$(subst $(PY),,$(BUILDOUT_BIN)): $(PY)
-
-
-build: $(BUILDOUT_BIN)
-
-
-update-paths: bin/buildout
-	bin/buildout -oN
-
-
-dist: $(PY)
-	$(PY) setup.py egg_info -r sdist
-
-
-check: bin/test
-	./bin/test -vv
-
-
-clean_buildout: 
+bin/twistd: $(BUILDOUT_BIN) $(BUILDOUT_CFG) setup.py
+	$(BUILDOUT) install runtime
+
+
+bin/test: $(BUILDOUT_BIN) $(BUILDOUT_CFG) setup.py
+	$(BUILDOUT) install test
+
+
+bin/tags: $(BUILDOUT_BIN) $(BUILDOUT_CFG) setup.py
+	$(BUILDOUT) install tags
+
+
+clean_buildout:
 	$(RM) -r bin
 	$(RM) -r parts
 	$(RM) -r develop-eggs
@@ -65,10 +79,11 @@
 
 
 clean: clean_buildout
+	find txlongpoll twisted -name '*.py[co]' -print0 | xargs -r0 $(RM)
 
 clean_all: clean_buildout clean_eggs
 
 
 .PHONY: \
-  build check clean clean_all clean_buildout \
-  clean_eggs default dist update-paths
+    build build-update-paths check clean clean_all clean_buildout \
+    clean_eggs default dist

=== modified file 'README'
--- README	2011-10-04 13:03:49 +0000
+++ README	2011-11-04 20:22:23 +0000
@@ -1,23 +1,45 @@
 Generic long poll server used by Launchpad and Landscape.
 
 
+Dependencies
+------------
+
+By default txlongpoll attempts to build without going to the network;
+instead it tries to find all dependencies from download-cache/dist,
+and you must download all the dependencies yourself.
+
+If you prefer for buildout to find dependencies from PyPI then comment
+out the ``install-from-cache = true`` line in buildout.cfg.
+
+To run the tests you may also need lp:rabbitfixture (bzr branch
+lp:rabbitfixture). Build it and drop the egg in download-cache/dist.
+You may also need to do the same for testresources-0.2.4_r58 until it
+reaches PyPI.
+
+txlongpoll needs a recent RabbitMQ with support for rejection. Maverick's
+1.8.0 is not sufficient, but 2.1.1 works fine, so >= Natty is OK.
+
+
 Building
 --------
 
-txlongpoll needs a recent RabbitMQ with support for rejection. Maverick's
-1.8.0 is not sufficient, but 2.1.1 works fine, so >= Natty is OK.
-
-You also need to get lp:rabbitfixture, build it and drop the egg in
-./download-cache/dist in order for txlongpoll to build.  You will also possibly
-need to do the same for testresources-0.2.4_r58 until it reaches PyPI.
-
  $ make build
 
+will build only those parts needed to run txlongpoll. No support for
+tags or testing.
+
 
 Testing
 -------
 
- $ bin/test
+ $ make check
+
+will build all the test-related parts of txlongpoll and then do a full
+test run, but
+
+ $ make bin/test
+
+will just do the first part.
 
 
 Running

=== modified file 'buildout.cfg'
--- buildout.cfg	2011-11-04 14:31:08 +0000
+++ buildout.cfg	2011-11-04 20:22:23 +0000
@@ -2,10 +2,7 @@
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 [buildout]
-parts =
-    interpreter
-    test
-    tags
+parts = runtime
 use-dependency-links = false
 unzip = true
 include-site-packages = false
@@ -13,20 +10,24 @@
 develop = .
 download-cache = download-cache
 eggs-directory = eggs
-# Relative paths are required for deployment.
+# Relative paths are useful when deploying built trees.
 relative-paths = true
+# Disable this option temporarily if you want buildout to find
+# software dependencies *other* than those in our download-cache.
+# Once you have the desired software, reenable this option.
+install-from-cache = true
+
+[runtime]
+recipe = zc.recipe.egg:scripts
+eggs = txlongpoll
+entry-points =  twistd=twisted.scripts.twistd:run
+interpreter = py
 
 [test]
 recipe = zc.recipe.testrunner
 eggs = txlongpoll [test]
 defaults = '--tests-pattern ^tests --exit-with-status'.split()
 
-[interpreter]
-recipe = zc.recipe.egg:scripts
-interpreter = py
-eggs = txlongpoll
-entry-points =  twistd=twisted.scripts.twistd:run
-
 [tags]
 recipe = z3c.recipe.tag:tags
 eggs = txlongpoll

=== added file 'ez_setup.py'
--- ez_setup.py	1970-01-01 00:00:00 +0000
+++ ez_setup.py	2011-11-04 20:22:23 +0000
@@ -0,0 +1,284 @@
+#!python
+"""Bootstrap setuptools installation
+
+If you want to use setuptools in your package's setup.py, just include this
+file in the same directory with it, and add this to the top of your setup.py::
+
+    from ez_setup import use_setuptools
+    use_setuptools()
+
+If you want to require a specific version of setuptools, set a download
+mirror, or use an alternate download directory, you can do so by supplying
+the appropriate options to ``use_setuptools()``.
+
+This file can also be run as a script to install or upgrade setuptools.
+"""
+import sys
+DEFAULT_VERSION = "0.6c11"
+DEFAULT_URL     = "http://pypi.python.org/packages/%s/s/setuptools/"; % sys.version[:3]
+
+md5_data = {
+    'setuptools-0.6b1-py2.3.egg': '8822caf901250d848b996b7f25c6e6ca',
+    'setuptools-0.6b1-py2.4.egg': 'b79a8a403e4502fbb85ee3f1941735cb',
+    'setuptools-0.6b2-py2.3.egg': '5657759d8a6d8fc44070a9d07272d99b',
+    'setuptools-0.6b2-py2.4.egg': '4996a8d169d2be661fa32a6e52e4f82a',
+    'setuptools-0.6b3-py2.3.egg': 'bb31c0fc7399a63579975cad9f5a0618',
+    'setuptools-0.6b3-py2.4.egg': '38a8c6b3d6ecd22247f179f7da669fac',
+    'setuptools-0.6b4-py2.3.egg': '62045a24ed4e1ebc77fe039aa4e6f7e5',
+    'setuptools-0.6b4-py2.4.egg': '4cb2a185d228dacffb2d17f103b3b1c4',
+    'setuptools-0.6c1-py2.3.egg': 'b3f2b5539d65cb7f74ad79127f1a908c',
+    'setuptools-0.6c1-py2.4.egg': 'b45adeda0667d2d2ffe14009364f2a4b',
+    'setuptools-0.6c10-py2.3.egg': 'ce1e2ab5d3a0256456d9fc13800a7090',
+    'setuptools-0.6c10-py2.4.egg': '57d6d9d6e9b80772c59a53a8433a5dd4',
+    'setuptools-0.6c10-py2.5.egg': 'de46ac8b1c97c895572e5e8596aeb8c7',
+    'setuptools-0.6c10-py2.6.egg': '58ea40aef06da02ce641495523a0b7f5',
+    'setuptools-0.6c11-py2.3.egg': '2baeac6e13d414a9d28e7ba5b5a596de',
+    'setuptools-0.6c11-py2.4.egg': 'bd639f9b0eac4c42497034dec2ec0c2b',
+    'setuptools-0.6c11-py2.5.egg': '64c94f3bf7a72a13ec83e0b24f2749b2',
+    'setuptools-0.6c11-py2.6.egg': 'bfa92100bd772d5a213eedd356d64086',
+    'setuptools-0.6c2-py2.3.egg': 'f0064bf6aa2b7d0f3ba0b43f20817c27',
+    'setuptools-0.6c2-py2.4.egg': '616192eec35f47e8ea16cd6a122b7277',
+    'setuptools-0.6c3-py2.3.egg': 'f181fa125dfe85a259c9cd6f1d7b78fa',
+    'setuptools-0.6c3-py2.4.egg': 'e0ed74682c998bfb73bf803a50e7b71e',
+    'setuptools-0.6c3-py2.5.egg': 'abef16fdd61955514841c7c6bd98965e',
+    'setuptools-0.6c4-py2.3.egg': 'b0b9131acab32022bfac7f44c5d7971f',
+    'setuptools-0.6c4-py2.4.egg': '2a1f9656d4fbf3c97bf946c0a124e6e2',
+    'setuptools-0.6c4-py2.5.egg': '8f5a052e32cdb9c72bcf4b5526f28afc',
+    'setuptools-0.6c5-py2.3.egg': 'ee9fd80965da04f2f3e6b3576e9d8167',
+    'setuptools-0.6c5-py2.4.egg': 'afe2adf1c01701ee841761f5bcd8aa64',
+    'setuptools-0.6c5-py2.5.egg': 'a8d3f61494ccaa8714dfed37bccd3d5d',
+    'setuptools-0.6c6-py2.3.egg': '35686b78116a668847237b69d549ec20',
+    'setuptools-0.6c6-py2.4.egg': '3c56af57be3225019260a644430065ab',
+    'setuptools-0.6c6-py2.5.egg': 'b2f8a7520709a5b34f80946de5f02f53',
+    'setuptools-0.6c7-py2.3.egg': '209fdf9adc3a615e5115b725658e13e2',
+    'setuptools-0.6c7-py2.4.egg': '5a8f954807d46a0fb67cf1f26c55a82e',
+    'setuptools-0.6c7-py2.5.egg': '45d2ad28f9750e7434111fde831e8372',
+    'setuptools-0.6c8-py2.3.egg': '50759d29b349db8cfd807ba8303f1902',
+    'setuptools-0.6c8-py2.4.egg': 'cba38d74f7d483c06e9daa6070cce6de',
+    'setuptools-0.6c8-py2.5.egg': '1721747ee329dc150590a58b3e1ac95b',
+    'setuptools-0.6c9-py2.3.egg': 'a83c4020414807b496e4cfbe08507c03',
+    'setuptools-0.6c9-py2.4.egg': '260a2be2e5388d66bdaee06abec6342a',
+    'setuptools-0.6c9-py2.5.egg': 'fe67c3e5a17b12c0e7c541b7ea43a8e6',
+    'setuptools-0.6c9-py2.6.egg': 'ca37b1ff16fa2ede6e19383e7b59245a',
+}
+
+import sys, os
+try: from hashlib import md5
+except ImportError: from md5 import md5
+
+def _validate_md5(egg_name, data):
+    if egg_name in md5_data:
+        digest = md5(data).hexdigest()
+        if digest != md5_data[egg_name]:
+            print >>sys.stderr, (
+                "md5 validation of %s failed!  (Possible download problem?)"
+                % egg_name
+            )
+            sys.exit(2)
+    return data
+
+def use_setuptools(
+    version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
+    download_delay=15
+):
+    """Automatically find/download setuptools and make it available on sys.path
+
+    `version` should be a valid setuptools version number that is available
+    as an egg for download under the `download_base` URL (which should end with
+    a '/').  `to_dir` is the directory where setuptools will be downloaded, if
+    it is not already available.  If `download_delay` is specified, it should
+    be the number of seconds that will be paused before initiating a download,
+    should one be required.  If an older version of setuptools is installed,
+    this routine will print a message to ``sys.stderr`` and raise SystemExit in
+    an attempt to abort the calling script.
+    """
+    was_imported = 'pkg_resources' in sys.modules or 'setuptools' in sys.modules
+    def do_download():
+        egg = download_setuptools(version, download_base, to_dir, download_delay)
+        sys.path.insert(0, egg)
+        import setuptools; setuptools.bootstrap_install_from = egg
+    try:
+        import pkg_resources
+    except ImportError:
+        return do_download()       
+    try:
+        pkg_resources.require("setuptools>="+version); return
+    except pkg_resources.VersionConflict, e:
+        if was_imported:
+            print >>sys.stderr, (
+            "The required version of setuptools (>=%s) is not available, and\n"
+            "can't be installed while this script is running. Please install\n"
+            " a more recent version first, using 'easy_install -U setuptools'."
+            "\n\n(Currently using %r)"
+            ) % (version, e.args[0])
+            sys.exit(2)
+    except pkg_resources.DistributionNotFound:
+        pass
+
+    del pkg_resources, sys.modules['pkg_resources']    # reload ok
+    return do_download()
+
+def download_setuptools(
+    version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
+    delay = 15
+):
+    """Download setuptools from a specified location and return its filename
+
+    `version` should be a valid setuptools version number that is available
+    as an egg for download under the `download_base` URL (which should end
+    with a '/'). `to_dir` is the directory where the egg will be downloaded.
+    `delay` is the number of seconds to pause before an actual download attempt.
+    """
+    import urllib2, shutil
+    egg_name = "setuptools-%s-py%s.egg" % (version,sys.version[:3])
+    url = download_base + egg_name
+    saveto = os.path.join(to_dir, egg_name)
+    src = dst = None
+    if not os.path.exists(saveto):  # Avoid repeated downloads
+        try:
+            from distutils import log
+            if delay:
+                log.warn("""
+---------------------------------------------------------------------------
+This script requires setuptools version %s to run (even to display
+help).  I will attempt to download it for you (from
+%s), but
+you may need to enable firewall access for this script first.
+I will start the download in %d seconds.
+
+(Note: if this machine does not have network access, please obtain the file
+
+   %s
+
+and place it in this directory before rerunning this script.)
+---------------------------------------------------------------------------""",
+                    version, download_base, delay, url
+                ); from time import sleep; sleep(delay)
+            log.warn("Downloading %s", url)
+            src = urllib2.urlopen(url)
+            # Read/write all in one block, so we don't create a corrupt file
+            # if the download is interrupted.
+            data = _validate_md5(egg_name, src.read())
+            dst = open(saveto,"wb"); dst.write(data)
+        finally:
+            if src: src.close()
+            if dst: dst.close()
+    return os.path.realpath(saveto)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+def main(argv, version=DEFAULT_VERSION):
+    """Install or upgrade setuptools and EasyInstall"""
+    try:
+        import setuptools
+    except ImportError:
+        egg = None
+        try:
+            egg = download_setuptools(version, delay=0)
+            sys.path.insert(0,egg)
+            from setuptools.command.easy_install import main
+            return main(list(argv)+[egg])   # we're done here
+        finally:
+            if egg and os.path.exists(egg):
+                os.unlink(egg)
+    else:
+        if setuptools.__version__ == '0.0.1':
+            print >>sys.stderr, (
+            "You have an obsolete version of setuptools installed.  Please\n"
+            "remove it from your system entirely before rerunning this script."
+            )
+            sys.exit(2)
+
+    req = "setuptools>="+version
+    import pkg_resources
+    try:
+        pkg_resources.require(req)
+    except pkg_resources.VersionConflict:
+        try:
+            from setuptools.command.easy_install import main
+        except ImportError:
+            from easy_install import main
+        main(list(argv)+[download_setuptools(delay=0)])
+        sys.exit(0) # try to force an exit
+    else:
+        if argv:
+            from setuptools.command.easy_install import main
+            main(argv)
+        else:
+            print "Setuptools version",version,"or greater has been installed."
+            print '(Run "ez_setup.py -U setuptools" to reinstall or upgrade.)'
+
+def update_md5(filenames):
+    """Update our built-in md5 registry"""
+
+    import re
+
+    for name in filenames:
+        base = os.path.basename(name)
+        f = open(name,'rb')
+        md5_data[base] = md5(f.read()).hexdigest()
+        f.close()
+
+    data = ["    %r: %r,\n" % it for it in md5_data.items()]
+    data.sort()
+    repl = "".join(data)
+
+    import inspect
+    srcfile = inspect.getsourcefile(sys.modules[__name__])
+    f = open(srcfile, 'rb'); src = f.read(); f.close()
+
+    match = re.search("\nmd5_data = {\n([^}]+)}", src)
+    if not match:
+        print >>sys.stderr, "Internal error!"
+        sys.exit(2)
+
+    src = src[:match.start(1)] + repl + src[match.end(1):]
+    f = open(srcfile,'w')
+    f.write(src)
+    f.close()
+
+
+if __name__=='__main__':
+    if len(sys.argv)>2 and sys.argv[1]=='--md5update':
+        update_md5(sys.argv[2:])
+    else:
+        main(sys.argv[1:])
+
+
+
+
+
+

=== modified file 'setup.py'
--- setup.py	2011-11-04 14:51:49 +0000
+++ setup.py	2011-11-04 20:22:23 +0000
@@ -22,7 +22,7 @@
         'oops_twisted >= 0.0.3',
         'setproctitle',
         'Twisted',
-        'txamqp',
+        'txAMQP >= 0.5',
         'zope.interface',
         ],
     extras_require=dict(