tahoe-lafs/setup.py

#! /usr/bin/env python

# Allmydata Tahoe -- secure, distributed storage grid
#
# Copyright (C) 2008 Allmydata, Inc.
#
# This file is part of tahoe.
#
# See the docs/about.html file for licensing information.

import os, re, sys, stat, subprocess

##### sys.path management

basedir = os.path.dirname(os.path.abspath(__file__))
pyver = "python%d.%d" % (sys.version_info[:2])
if sys.platform == "win32":
    supportlib = os.path.join("support", "Lib", "site-packages")
else:
    supportlib = os.path.join("support", "lib", pyver, "site-packages")
supportlib = os.path.join(basedir, supportlib)

def add_tahoe_paths():
    """Modify sys.path and PYTHONPATH to include Tahoe and supporting libraries

    The first step towards building Tahoe is to run::

      python setup.py build_tahoe

    which is the equivalent of::

      mkdir -p $(BASEDIR)/support/lib/python2.5/site-packages
       (or cygpath equivalent)
      setup.py develop --prefix=$(BASEDIR)/support

    This installs .eggs for any dependent libraries that aren't already
    available on the system, into support/lib/pythonN.N/site-packages (or
    support/Lib/site-packages on windows). It also adds an .egg-link for
    Tahoe itself into the same directory.

    We add this directory to os.environ['PYTHONPATH'], so that any child
    processes we spawn will be able to use these packages.

    When the setuptools site.py sees that supportlib in PYTHONPATH, it scans
    through it for .egg and .egg-link entries, and adds them to sys.path .
    Since python has already processed all the site.py files by the time we
    get here, we perform this same sort of processing ourselves: this makes
    tahoe (and dependency libraries) available to code within setup.py
    itself. This is used by the 'setup.py trial' subcommand, which invokes
    trial directly rather than spawning a subprocess (this is easier than
    locating the 'trial' executable, especially when Twisted was installed as
    a dependent library).

    We'll need to add these .eggs to sys.path before importing anything that
    isn't a part of stdlib. All the directories that we add this way are put
    at the start of sys.path, so they will override anything that was present
    on the system (and perhaps found lacking by the setuptools requirements
    expressed in _auto_deps.py).
    """

    extra_syspath_items = []
    extra_pythonpath_items = []

    extra_syspath_items.append(supportlib)
    extra_pythonpath_items.append(supportlib)

    # Since we use setuptools to populate that directory, there will be a
    # number of .egg and .egg-link entries there. Add all of them to
    # sys.path, since that what the setuptools site.py would do if it
    # encountered them at process start time. Without this step, the rest of
    # this process would be unable to use the packages installed there. We
    # don't need to add them to PYTHONPATH, since the site.py present there
    # will add them when the child process starts up.

    if os.path.isdir(supportlib):
        for fn in os.listdir(supportlib):
            if fn.endswith(".egg"):
                extra_syspath_items.append(os.path.join(supportlib, fn))

    # We also add our src/ directory, since that's where all the Tahoe code
    # lives. This matches what site.py does when it sees the .egg-link file
    # that is written to the support dir by an invocation of our 'setup.py
    # develop' command.
    extra_syspath_items.append(os.path.join(basedir, "src"))

    # and we put an extra copy of everything from PYTHONPATH in front, so
    # that it is possible to override the packages that setuptools downloads
    # with alternate versions, by doing e.g. "PYTHONPATH=foo python setup.py
    # trial"
    oldpp = os.environ.get("PYTHONPATH", "").split(os.pathsep)
    if oldpp == [""]:
        # grr silly split() behavior
        oldpp = []
    extra_syspath_items = oldpp + extra_syspath_items

    sys.path = extra_syspath_items + sys.path

    # We also provide it to any child processes we spawn, via
    # os.environ["PYTHONPATH"]
    os.environ["PYTHONPATH"] = os.pathsep.join(oldpp + extra_pythonpath_items)

# add_tahoe_paths() must be called before use_setuptools() is called. I don't
# know why. If it isn't, then a later pkg_resources.requires(pycryptopp) call
# fails because an old version (in /usr/lib) was already loaded.
add_tahoe_paths()

try:
    from ez_setup import use_setuptools
except ImportError:
    pass
else:
    # This invokes our own customized version of ez_setup.py to make sure that
    # setuptools >= v0.6c8 (a.k.a. v0.6-final) is installed.

    # setuptools < v0.6c8 doesn't handle eggs which get installed into the CWD
    # as a result of being transitively depended on in a setup_requires, but
    # then are needed for the installed code to run, i.e. in an
    # install_requires.
    use_setuptools(download_delay=0, min_version="0.6c8")

from setuptools import find_packages, setup
from setuptools.command import sdist
from distutils.core import Command

# Make the dependency-version-requirement, which is used by the Makefile at
# build-time, also available to the app at runtime:
import shutil
shutil.copyfile("_auto_deps.py", os.path.join("src", "allmydata", "_auto_deps.py"))

trove_classifiers=[
    "Development Status :: 5 - Production/Stable",
    "Environment :: Console",
    "Environment :: Web Environment",
    "License :: OSI Approved :: GNU General Public License (GPL)",
    "License :: DFSG approved",
    "License :: Other/Proprietary License",
    "Intended Audience :: Developers",
    "Intended Audience :: End Users/Desktop",
    "Intended Audience :: System Administrators",
    "Operating System :: Microsoft",
    "Operating System :: Microsoft :: Windows",
    "Operating System :: Unix",
    "Operating System :: POSIX :: Linux",
    "Operating System :: POSIX",
    "Operating System :: MacOS :: MacOS X",
    "Operating System :: Microsoft :: Windows :: Windows NT/2000",
    "Operating System :: OS Independent",
    "Natural Language :: English",
    "Programming Language :: C",
    "Programming Language :: Python",
    "Topic :: Utilities",
    "Topic :: System :: Systems Administration",
    "Topic :: System :: Filesystems",
    "Topic :: System :: Distributed Computing",
    "Topic :: Software Development :: Libraries",
    "Topic :: Communications :: Usenet News",
    "Topic :: System :: Archiving :: Backup",
    "Topic :: System :: Archiving :: Mirroring",
    "Topic :: System :: Archiving",
    ]


VERSIONFILE = "src/allmydata/_version.py"
verstr = "unknown"
try:
    verstrline = open(VERSIONFILE, "rt").read()
except EnvironmentError:
    pass # Okay, there is no version file.
else:
    VSRE = r"^verstr = ['\"]([^'\"]*)['\"]"
    mo = re.search(VSRE, verstrline, re.M)
    if mo:
        verstr = mo.group(1)
    else:
        print "unable to find version in %s" % (VERSIONFILE,)
        raise RuntimeError("if %s.py exists, it is required to be well-formed" % (VERSIONFILE,))

LONG_DESCRIPTION=\
"""Welcome to the Tahoe project, a secure, decentralized, fault-tolerant
filesystem.  All of the source code is available under a Free Software, Open
Source licence.

This filesystem is encrypted and spread over multiple peers in such a way that
it remains available even when some of the peers are unavailable,
malfunctioning, or malicious."""


# Default setup_requires are pyutil for the Windows installer builder(see
# misc/sub-ver.py) and Twisted for the tests.
#setup_requires = ['pyutil >= 1.3.16', 'Twisted >= 2.4.0']
setup_requires = []

# darcsver is needed only if you want "./setup.py darcsver" to write a new
# version stamp in src/allmydata/_version.py, with a version number derived from
# darcs history.
# http://pypi.python.org/pypi/darcsver
if 'darcsver' in sys.argv[1:]:
    setup_requires.append('darcsver >= 1.1.5')

# setuptools_darcs is required to produce complete distributions (such as with
# "sdist" or "bdist_egg"), unless there is a PKG-INFO file present which shows
# that this is itself a source distribution.
# http://pypi.python.org/pypi/setuptools_darcs
if not os.path.exists('PKG-INFO'):
    setup_requires.append('setuptools_darcs >= 1.1.0')

class ShowSupportLib(Command):
    user_options = []
    def initialize_options(self):
        pass
    def finalize_options(self):
        pass
    def run(self):
        # TODO: --quiet suppresses the 'running show_supportlib' message.
        # Find a way to do this all the time.
        print supportlib # TODO windowsy

class ShowPythonPath(Command):
    user_options = []
    def initialize_options(self):
        pass
    def finalize_options(self):
        pass
    def run(self):
        # TODO: --quiet suppresses the 'running show_supportlib' message.
        # Find a way to do this all the time.
        print "PYTHONPATH=%s" % os.environ["PYTHONPATH"]

class RunWithPythonPath(Command):
    description = "Run a subcommand with PYTHONPATH set appropriately"

    user_options = [ ("python", "p",
                      "Treat command string as arguments to a python executable"),
                     ("command=", "c", "Command to be run"),
                     ("directory=", "d", "Directory to run the command in"),
                     ]
    boolean_options = ["python"]

    def initialize_options(self):
        self.command = None
        self.python = False
        self.directory = None
    def finalize_options(self):
        pass
    def run(self):
        # os.environ['PYTHONPATH'] is already set by add_tahoe_paths, so we
        # just need to exec() their command. We must require the command to
        # be safe to split on whitespace, and have --python and --directory
        # to make it easier to achieve this.
        command = []
        if self.python:
            command.append(sys.executable)
        if self.command:
            command.extend(self.command.split())
        if not command:
            raise RuntimeError("The --command argument is mandatory")
        if self.directory:
            os.chdir(self.directory)
        if self.verbose:
            print "command =", " ".join(command)
        rc = subprocess.call(command)
        sys.exit(rc)

class CheckAutoDeps(Command):
    user_options = []
    def initialize_options(self):
        pass
    def finalize_options(self):
        pass
    def run(self):
        import _auto_deps
        _auto_deps.require_auto_deps()


class BuildTahoe(Command):
    user_options = []
    def initialize_options(self):
        pass
    def finalize_options(self):
        pass
    def run(self):
        # chmod +x bin/tahoe
        bin_tahoe = os.path.join("bin", "tahoe")
        old_mode = stat.S_IMODE(os.stat(bin_tahoe)[stat.ST_MODE])
        new_mode = old_mode | (stat.S_IXUSR | stat.S_IRUSR |
                               stat.S_IXGRP | stat.S_IRGRP |
                               stat.S_IXOTH | stat.S_IROTH )
        os.chmod(bin_tahoe, new_mode)

        # 'setup.py develop --prefix SUPPORT' will complain if SUPPORTLIB is
        # not on PYTHONPATH, because it thinks you are installing to a place
        # that will not be searched at runtime (which is true, except that we
        # add SUPPORTLIB to PYTHONPATH to run tests, etc). So set up
        # PYTHONPATH now, then spawn a 'setup.py develop' command. Also, we
        # have to create the directory ourselves.
        if not os.path.isdir(supportlib):
            os.makedirs(supportlib)

        command = [sys.executable, "setup.py", "develop", "--prefix", "support"]
        if sys.platform == "linux2":
            # workaround for tahoe #229 / setuptools #17, on debian
            command.extend(["--site-dirs", "/var/lib/python-support/" + pyver])
        print "Command:", " ".join(command)
        rc = subprocess.call(command)
        if rc < 0:
            print >>sys.stderr, "'setup.py develop' terminated by signal", -rc
            sys.exit(1)
        elif rc > 0:
            print >>sys.stderr, "'setup.py develop' exited with rc", rc
            sys.exit(rc)

class Trial(Command):
    # Unlike 'build' and 'bdist_egg', the 'trial' subcommand cannot be run in
    # conjunction with other subcommands.

    # The '-a' argument is split on whitespace and passed into trial. (the
    # distutils parser does not give subcommands access to the rest of
    # sys.argv, so unfortunately we cannot just do something like:
    #   setup.py trial --reporter=text allmydata.test.test_util

    # Examples:
    #  setup.py trial    # run all tests
    #  setup.py trial -a allmydata.test.test_util   # run some tests
    #  setup.py trial -a '--reporter=text allmydata.test.test_util' #other args

    description = "Run unit tests via trial"

    user_options = [ ("args=", "a", "Argument string to pass to trial: setup.py trial -a allmydata.test.test_util"),
                     ]
    def initialize_options(self):
        self.args = "allmydata"
    def finalize_options(self):
        pass

    def run(self):
        # make sure Twisted is available (for trial itself), and both the
        # Tahoe source code and our dependent libraries are available (so
        # that trial has some test code to work with)

        from twisted.scripts import trial

        args = self.args.strip().split()

        # one wrinkle: we want to set the reactor here, because of bug #402
        # (twisted bug #3218). We just jam in a "--reactor poll" at the start
        # of the arglist. This does not permit the reactor to be overridden,
        # unfortunately.
        if sys.platform in ("linux2", "cygwin"):
            # poll on linux2 to avoid #402 problems with select
            # poll on cygwin since selectreactor runs out of fds
            args = ["--reactor", "poll"] + args

        # zooko also had os.environ["PYTHONUNBUFFERED"]="1" and
        # args.append("--rterrors")

        sys.argv = ["trial"] + args
        if self.verbose > 1:
            print "To run this test directly, use:"
            print "PYTHONPATH=%s %s" % (os.environ["PYTHONPATH"],
                                        " ".join(sys.argv))
        else:
            print "(run setup.py with -vv for trial command-line details)"
        trial.run() # this does sys.exit
        # NEVER REACHED

class MySdist(sdist.sdist):
    """ A hook in the sdist command so that we can determine whether this the
    tarball should be 'SUMO' or not, i.e. whether or not to include the
    external dependency tarballs. Note that we always include
    misc/dependencies/* in the tarball; --sumo controls whether tahoe-deps/*
    is included as well.
    """

    user_options = sdist.sdist.user_options + \
        [('sumo', 's',
          "create a 'sumo' sdist which includes the contents of tahoe-deps/*"),
         ]
    boolean_options = ['sumo']

    def initialize_options(self):
        sdist.sdist.initialize_options(self)
        self.sumo = False

    def make_distribution(self):
        # add our extra files to the list just before building the
        # tarball/zipfile. We override make_distribution() instead of run()
        # because setuptools.command.sdist.run() does not lend itself to
        # easy/robust subclassing (the code we need to add goes right smack
        # in the middle of a 12-line method). If this were the distutils
        # version, we'd override get_file_list().

        if self.sumo:
            # If '--sumo' was specified, include tahoe-deps/* in the sdist.
            # We assume that the user has fetched the tahoe-deps.tar.gz
            # tarball and unpacked it already.
            self.filelist.extend([os.path.join("tahoe-deps", fn)
                                  for fn in os.listdir("tahoe-deps")])
            # In addition, we want the tarball/zipfile to have -SUMO in the
            # name, and the unpacked directory to have -SUMO too. The easiest
            # way to do this is to patch self.distribution and override the
            # get_fullname() method. (an alternative is to modify
            # self.distribution.metadata.version, but that also affects the
            # contents of PKG-INFO).
            fullname = self.distribution.get_fullname()
            def get_fullname():
                return fullname + "-SUMO"
            self.distribution.get_fullname = get_fullname

        return sdist.sdist.make_distribution(self)

# Tahoe's dependencies are managed by the find_links= entry in setup.cfg and
# the _auto_deps.install_requires list, which is used in the call to setup()
# at the end of this file
from _auto_deps import install_requires

setup(name='allmydata-tahoe',
      version=verstr,
      description='secure, decentralized, fault-tolerant filesystem',
      long_description=LONG_DESCRIPTION,
      author='the allmydata.org Tahoe project',
      author_email='tahoe-dev@allmydata.org',
      url='http://allmydata.org/',
      license='GNU GPL',
      cmdclass={"show_supportlib": ShowSupportLib,
                "show_pythonpath": ShowPythonPath,
                "run_with_pythonpath": RunWithPythonPath,
                "check_auto_deps": CheckAutoDeps,
                "build_tahoe": BuildTahoe,
                "trial": Trial,
                "sdist": MySdist,
                },
      package_dir = {'':'src'},
      packages=find_packages("src"),
      classifiers=trove_classifiers,
      test_suite="allmydata.test",
      install_requires=install_requires,
      include_package_data=True,
      setup_requires=setup_requires,
      entry_points = { 'console_scripts': [ 'tahoe = allmydata.scripts.runner:run' ] },
      zip_safe=False, # We prefer unzipped for easier access.
      )