Ticket #262: win32-setup-reorg.patch

New patches:

[use buildbot2 and service script if winxp. merge easy_install changes to trunk.
erik@purins.com**20080503064118] {
move ./contrib/windows/buildbot2.bat ./contrib/windows/buildbot.cmd
addfile ./ez_setup.py
hunk ./ez_setup.py 1
+#!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.6c8"
+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.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',
+}
+
+import sys, os
+
+def _validate_md5(egg_name, data):
+    if egg_name in md5_data:
+        from md5 import md5
+        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)
+        else:
+            del pkg_resources, sys.modules['pkg_resources']    # reload ok
+            return do_download()
+    except pkg_resources.DistributionNotFound:
+        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
+    from md5 import md5
+
+    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:])
+
+
+
+
+
addfile ./setup.cfg
hunk ./setup.cfg 1
+[easy_install]
+find_links = http://buildbot.net
hunk ./setup.py 1
-#! /usr/bin/env python
-
-import sys, os, re
-from distutils.core import setup
-from buildbot import version
-
-# Path: twisted!cvstoys!buildbot
-from distutils.command.install_data import install_data
-class install_data_twisted(install_data):
-    """make sure data files are installed in package.
-    this is evil.
-    copied from Twisted/setup.py.
-    """
-    def finalize_options(self):
-        self.set_undefined_options('install',
-            ('install_lib', 'install_dir')
-        )
-        install_data.finalize_options(self)
-
-long_description="""
-The BuildBot is a system to automate the compile/test cycle required by
-most software projects to validate code changes. By automatically
-rebuilding and testing the tree each time something has changed, build
-problems are pinpointed quickly, before other developers are
-inconvenienced by the failure. The guilty developer can be identified
-and harassed without human intervention. By running the builds on a
-variety of platforms, developers who do not have the facilities to test
-their changes everywhere before checkin will at least know shortly
-afterwards whether they have broken the build or not. Warning counts,
-lint checks, image size, compile time, and other build parameters can
-be tracked over time, are more visible, and are therefore easier to
-improve.
-"""
-
-scripts = ["bin/buildbot"]
-if sys.platform == "win32":
-    scripts.append("contrib/windows/buildbot.bat")
-    scripts.append("contrib/windows/buildbot_service.py")
-
-testmsgs = []
-for f in os.listdir("buildbot/test/mail"):
-    if f.endswith("~"):
-        continue
-    if re.search(r'\.\d+$', f):
-        testmsgs.append("buildbot/test/mail/%s" % f)
-
-setup_args = {
-    'name': "buildbot",
-    'version': version,
-    'description': "BuildBot build automation system",
-    'long_description': long_description,
-    'author': "Brian Warner",
-    'author_email': "warner-buildbot@lothar.com",
-    'url': "http://buildbot.net/",
-    'license': "GNU GPL",
-    # does this classifiers= mean that this can't be installed on 2.2/2.3?
-    'classifiers': [
-        'Development Status :: 4 - Beta',
-        'Environment :: No Input/Output (Daemon)',
-        'Environment :: Web Environment',
-        'Intended Audience :: Developers',
-        'License :: OSI Approved :: GNU General Public License (GPL)',
-        'Topic :: Software Development :: Build Tools',
-        'Topic :: Software Development :: Testing',
-        ],
-
-    'packages': ["buildbot",
-              "buildbot.status", "buildbot.status.web",
-              "buildbot.changes",
-              "buildbot.steps",
-              "buildbot.process",
-              "buildbot.clients",
-              "buildbot.slave",
-              "buildbot.scripts",
-              "buildbot.test",
-              ],
-    'data_files': [("buildbot", ["buildbot/buildbot.png"]),
-                ("buildbot/clients", ["buildbot/clients/debug.glade"]),
-                ("buildbot/status/web",
-                 ["buildbot/status/web/classic.css",
-                  "buildbot/status/web/index.html",
-                  "buildbot/status/web/robots.txt",
-                  ]),
-                ("buildbot/scripts", ["buildbot/scripts/sample.cfg"]),
-                ("buildbot/test/mail", testmsgs),
-                ("buildbot/test/subdir", ["buildbot/test/subdir/emit.py"]),
-                ],
-    'scripts ':  scripts,
-    'cmdclass': {'install_data': install_data_twisted},
-    }
-
-try:
-    # If setuptools is installed, then we'll add setuptools-specific arguments
-    # to the setup args.
-    import setuptools
-except ImportError:
-    pass
-else:
-    setup_args['install_requires'] = ['twisted >= 2.4.0']
-    entry_points={
-        'console_scripts': [
-            'buildbot = buildbot.scripts.runner:run'
-            ]
-        },
-
-setup(**setup_args)
-
-# Local Variables:
-# fill-column: 71
-# End:
+#! /usr/bin/env python
+"""The BuildBot is a system to automate the compile/test cycle 
+required by most software projects to validate code changes. 
+By automatically rebuilding and testing the tree each time 
+something has changed, build problems are pinpointed quickly, 
+before other developers are inconvenienced by the failure. 
+The guilty developer can be identified and harassed without 
+human intervention. By running the builds on a variety of platforms, 
+developers who do not have the facilities to test their changes 
+everywhere before checkin will at least know shortly afterwards 
+whether they have broken the build or not. Warning counts, 
+lint checks, image size, compile time, and other build parameters 
+can be tracked over time, are more visible, and are therefore 
+easier to improve.
+"""
+
+import sys, os, re
+from buildbot import version
+
+try:
+       # you could use ez_setup, if you think all buildbot users want setuptools.
+       # you would want to distribute ez_setup with your package.
+       #from ez_setup import use_setuptools()
+       #use_setuptools()
+       from setuptools import setup, find_packages
+except ImportError:
+       from distutils.core import setup
+
+# Path: twisted!cvstoys!buildbot
+from distutils.command.install_data import install_data
+class install_data_twisted(install_data):
+    """make sure data files are installed in package.
+    this is evil.
+    copied from Twisted/setup.py.
+    """
+    def finalize_options(self):
+        self.set_undefined_options('install',
+            ('install_lib', 'install_dir')
+        )
+        install_data.finalize_options(self)
+
+scripts = ["bin/buildbot"]
+if sys.platform == "win32":
+    if hasattr(sys,'getwindowsversion'):
+        major, minor, build, platform, text = sys.getwindowsversion()
+        #(5, 1, 2600, 2, 'Service Pack 2')
+        """
+        Return a tuple containing five components, describing the Windows version currently running. The elements are major, minor, build, platform, and text. text contains a string while all other values are integers.
+               platform may be one of the following values:
+               Constant Platform
+               0 (VER_PLATFORM_WIN32s) Win32s on Windows 3.1
+               1 (VER_PLATFORM_WIN32_WINDOWS) Windows 95/98/ME
+               2 (VER_PLATFORM_WIN32_NT) Windows NT/2000/XP
+               3 (VER_PLATFORM_WIN32_CE) Windows CE
+               
+               This function wraps the Win32 GetVersionEx() function; see the Microsoft documentation for more information about these fields.
+               Availability: Windows. New in version 2.3
+        """
+        if platform == 1:
+            scripts.append("contrib/windows/buildbot.bat")
+        elif platform == 2:
+            # Um, what does Vista report as?
+            scripts.append("contrib/windows/buildbot.cmd")
+            scripts.append("contrib/windows/buildbot_service.py")
+    else:
+        scripts.append("contrib/windows/buildbot.bat")
+
+testmsgs = []
+for f in os.listdir("buildbot/test/mail"):
+    if f.endswith("~"):
+        continue
+    if re.search(r'\.\d+$', f):
+        testmsgs.append("buildbot/test/mail/%s" % f)
+
+classifiers = [
+    'Development Status :: 4 - Beta',
+    'Environment :: No Input/Output (Daemon)',
+    'Environment :: Web Environment',
+    'Intended Audience :: Developers',
+    'License :: OSI Approved :: GNU General Public License (GPL)',
+    'Topic :: Software Development :: Build Tools',
+    'Topic :: Software Development :: Testing',
+    ]
+
+packages = ["buildbot",
+    "buildbot.changes",
+    "buildbot.clients",
+    "buildbot.process",
+    "buildbot.scripts",
+    "buildbot.slave",
+    "buildbot.status", "buildbot.status.web",
+    "buildbot.steps",
+    "buildbot.test",
+    ]
+
+description = "BuildBot build automation system"
+
+name = "buildbot"
+
+author = "Brian Warner"
+
+data_files=[("buildbot", ["buildbot/buildbot.png"]),
+             ("buildbot/clients", ["buildbot/clients/debug.glade"]),
+             ("buildbot/status/web",
+              ["buildbot/status/web/classic.css",
+               "buildbot/status/web/index.html",
+               "buildbot/status/web/robots.txt",
+               ]),
+             ("buildbot/scripts", ["buildbot/scripts/sample.cfg"]),
+             ("buildbot/test/mail", testmsgs),
+             ("buildbot/test/subdir", ["buildbot/test/subdir/emit.py"]),
+             ]
+
+author_email = "warner-buildbot@lothar.com"
+
+cmdclass={'install_data': install_data_twisted}
+
+url = "http://buildbot.net/"
+
+license = "GNU GPL"
+
+# if you need a min version, state that.
+install_requires = ['twisted >= 2.4.0']
+
+setup_args = {
+       'name' :        name,
+       'version':      version,
+       'description':  description,
+       'long_description':     __doc__,
+       'author':       author,
+       'author_email': author_email,
+       'url':          url,
+       'license':      license,
+       'classifiers':  classifiers,
+       'scripts':      scripts,
+       'data_files':   data_files,
+       'cmdclass':     cmdclass,
+       }
+
+#use different install args
+#depending on if user has setuptools.
+if 'find_packages' in dir():
+       setup_args['install_requires'] = install_requires
+       setup_args['packages'] = find_packages()
+             # But, maybe it's not zip-safe.
+               # On win32 when omitted,
+             # setuptools decides to put buildbot
+             # in an egg dir, not .egg archive
+       setup_args['zip_safe'] = True
+       
+       entry_points = {
+               'console_scripts': [
+                   'buildbot = buildbot.scripts.runner:run'
+                   ]
+               },
+else:
+       setup_args['packages'] = packages
+       
+setup(**setup_args)
+       
+# Local Variables:
+# fill-column: 71
+# End:
}

[document changes to setup.py since it is mostly a reorg to make it legible to me and might be hard to diff visually.
erik@purins.com**20080503153917] {
hunk ./setup.py 16
-
+# Moving the long description to __doc__ string puts the info at the top.
+# feels more like a module description there.
+# alternately, you could make it the doc string of buildbot and also
+# import that below like:
+# >>>from buildbot import __doc__ as long_description
hunk ./setup.py 47
+# buildbot.bat is written for python23, but
+# buildbot2.bat looks xp-friendly.
+# renamed it so both can be invoked as 'buildbot' (cmd and bat are the same and can co-exist)
+# and only install xp .cmd on xp, only install service if computer is NT.
hunk ./setup.py 83
+# split the assignment of setup arg values
+# so assigning to arg value and 
+# running setup with args
+# is more clear.
+
hunk ./setup.py 98
+#alphabatized. anal, I know.
hunk ./setup.py 136
-# if you need a min version, state that.
hunk ./setup.py 139
-       'name' :        name,
-       'version':      version,
-       'description':  description,
+       'name' :                        name,
+       'version':                      version,
+       'description':          description,
hunk ./setup.py 143
-       'author':       author,
-       'author_email': author_email,
-       'url':          url,
-       'license':      license,
-       'classifiers':  classifiers,
-       'scripts':      scripts,
-       'data_files':   data_files,
-       'cmdclass':     cmdclass,
+       'author':                       author,
+       'author_email':         author_email,
+       'url':                          url,
+       'license':                      license,
+       'classifiers':          classifiers,
+       'scripts':                      scripts,
+       'data_files':           data_files,
+       'cmdclass':                     cmdclass,
hunk ./setup.py 155
+#maybe find_packages() breaks your api by adding additional ones, I dunno.
+#but if you someday go all setuptools, 
+#you can remove the explicit package list.
hunk ./setup.py 159
-       setup_args['install_requires'] = install_requires
hunk ./setup.py 160
-             # But, maybe it's not zip-safe.
-               # On win32 when omitted,
-             # setuptools decides to put buildbot
-             # in an egg dir, not .egg archive
+       setup_args['install_requires'] = install_requires
+       # But, maybe it's not zip-safe.
+       # On win32 when omitted,
+       # setuptools decides to put buildbot
+       # in an egg dir, not .egg archive
hunk ./setup.py 166
-       
}

Context:

[for source mode=copy, use cp -RPp instead of cp -r. Closes #86
warner@lothar.com**20080429163120] 
[sample.cfg: fix comments, closes #193
warner@lothar.com**20080429162427] 
[bonsaipoller: apply fixes from Ben Hearsum, closes #216
warner@lothar.com**20080429162108] 
[MailNotifier: add mode=passing. Closes #169
warner@lothar.com**20080429160409] 
[status/tinderbox.py: add useChangeTim= argument, closes #213
warner@lothar.com**20080429154719] 
[svnpoller: fix broken log message
warner@lothar.com**20080429154455] 
[status/tinderbox.py: fix scope of logEncoding
warner@lothar.com**20080429154000] 
[changelog for #231 patch
warner@lothar.com**20080429152845] 
[#231:docs-fix.patch
dustin@v.igoro.us**20080412015359
 Small documentation patch by Christian Theune (ctheune)
] 
[changelog for zooko's optional-setuptools setup.py patches
warner@lothar.com**20080424224922] 
[setup: add a console_scripts entry point so that if setuptools is present at install time an executable suitable for your platform will be created
zooko@zooko.com**20080415034501] 
[setup: declare dependency on twisted >= 2.4.0
zooko@zooko.com**20080415034224] 
[changelog for zooko's non-behavior-changing setup.py patches
warner@lothar.com**20080424224658] 
[shebang usr bin env python
zooko@zooko.com**20080415033828
 This makes it possible for me to execute "./setup.py", even on cygwin.
 
] 
[setup: pass a dict of setup_args instead of passing a bunch of keyword args to setup
zooko@zooko.com**20080415033745
 (This is a preparation for adding optional setuptools features.)
] 
[add changelog for zooko's bin/buildbot patch
warner@lothar.com**20080424223548] 
[shebang usr bin env python
zooko@zooko.com**20080313185918] 
[README: add Twisted-8.0.1 to the list of known-good versions
warner@lothar.com**20080424221637] 
[bump version to 0.7.7+ while between releases
warner@lothar.com**20080415203010] 
[TAG buildbot-0.7.7
warner@lothar.com**20080330025903] 
Patch bundle hash:
d9a9ae3d59e6c1e8f9ebd13d155dd6e4b06ecacc