]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/blobdiff - setup.py
Merge pull request #236 from daira/2725.timezone-test.0
[tahoe-lafs/tahoe-lafs.git] / setup.py
index 9cb68da3963e6c304304387c6c4c6c20f41dbf70..63697e004a4c7113b18d6733d8a7973719e97c72 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -1,15 +1,16 @@
 #! /usr/bin/env python
 # -*- coding: utf-8 -*-
+import sys; assert sys.version_info < (3,), ur"Tahoe-LAFS does not run under Python 3. Please use Python 2.7.x."
 
 # Tahoe-LAFS -- secure, distributed storage grid
 #
-# Copyright © 2008-2010 Allmydata, Inc.
+# Copyright © 2006-2012 The Tahoe-LAFS Software Foundation
 #
 # This file is part of Tahoe-LAFS.
 #
-# See the docs/about.html file for licensing information.
+# See the docs/about.rst file for licensing information.
 
-import glob, os, shutil, stat, subprocess, sys, zipfile, re
+import os, stat, subprocess, re
 
 ##### sys.path management
 
@@ -36,7 +37,8 @@ def read_version_py(infname):
         if mo:
             return mo.group(1)
 
-version = read_version_py("src/allmydata/_version.py")
+VERSION_PY_FILENAME = 'src/allmydata/_version.py'
+version = read_version_py(VERSION_PY_FILENAME)
 
 APPNAME='allmydata-tahoe'
 APPNAMEFILE = os.path.join('src', 'allmydata', '_appname.py')
@@ -48,7 +50,7 @@ except EnvironmentError:
     open(APPNAMEFILE, "w").write(APPNAMEFILESTR)
 else:
     if curappnamefilestr.strip() != APPNAMEFILESTR:
-        print "Error -- this setup.py file is configured with the 'application name' to be '%s', but there is already a file in place in '%s' which contains the contents '%s'.  If the file is wrong, please remove it and setup.py will regenerate it and write '%s' into it." % (APPNAME, APPNAMEFILE, curappnamefilestr, APPNAMEFILESTR)
+        print("Error -- this setup.py file is configured with the 'application name' to be '%s', but there is already a file in place in '%s' which contains the contents '%s'.  If the file is wrong, please remove it and setup.py will regenerate it and write '%s' into it." % (APPNAME, APPNAMEFILE, curappnamefilestr, APPNAMEFILESTR))
         sys.exit(-1)
 
 # setuptools/zetuptoolz looks in __main__.__requires__ for a list of
@@ -62,21 +64,19 @@ else:
 adglobals = {}
 execfile('src/allmydata/_auto_deps.py', adglobals)
 install_requires = adglobals['install_requires']
+setup_requires = adglobals['setup_requires']
+
+if len(sys.argv) > 1 and sys.argv[1] == '--fakedependency':
+    del sys.argv[1]
+    install_requires += ["fakedependency >= 1.0.0"]
 
 __requires__ = install_requires[:]
-if 'trial' in sys.argv or 'test' in sys.argv:
-    if version is not None:
-        __requires__.append(APPNAME + '==' + version)
-    else:
-        __requires__.append(APPNAME)
 
-egg = os.path.realpath(glob.glob('setuptools-*.egg')[0])
-sys.path.insert(0, egg)
-egg = os.path.realpath(glob.glob('darcsver-*.egg')[0])
+egg = os.path.realpath('setuptools-0.6c16dev6.egg')
 sys.path.insert(0, egg)
 import setuptools; setuptools.bootstrap_install_from = egg
 
-from setuptools import find_packages, setup
+from setuptools import setup
 from setuptools.command import sdist
 from setuptools import Command
 
@@ -92,7 +92,6 @@ trove_classifiers=[
     "Intended Audience :: System Administrators",
     "Operating System :: Microsoft",
     "Operating System :: Microsoft :: Windows",
-    "Operating System :: Microsoft :: Windows :: Windows NT/2000",
     "Operating System :: Unix",
     "Operating System :: POSIX :: Linux",
     "Operating System :: POSIX",
@@ -102,162 +101,91 @@ trove_classifiers=[
     "Programming Language :: C",
     "Programming Language :: Python",
     "Programming Language :: Python :: 2",
-    "Programming Language :: Python :: 2.4",
-    "Programming Language :: Python :: 2.5",
-    "Programming Language :: Python :: 2.6",
+    "Programming Language :: Python :: 2.7",
     "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",
     ]
 
 
-setup_requires = []
-
-# The darcsver command from the darcsver plugin is needed to initialize the
-# distribution's .version attribute correctly. (It does this either by
-# examining darcs history, or if that fails by reading the
-# src/allmydata/_version.py file). darcsver will also write a new version
-# stamp in src/allmydata/_version.py, with a version number derived from
-# darcs history. Note that the setup.cfg file has an "[aliases]" section
-# which enumerates commands that you might run and specifies that it will run
-# darcsver before each one. If you add different commands (or if I forgot
-# some that are already in use), you may need to add it to setup.cfg and
-# configure it to run darcsver before your command, if you want the version
-# number to be correct when that command runs.
-# http://pypi.python.org/pypi/darcsver
-setup_requires.append('darcsver >= 1.7.1')
-
-# Nevow requires Twisted to setup, but doesn't declare that requirement in a
-# way that enables setuptools to satisfy that requirement before Nevow's
-# setup.py tried to "import twisted". Fortunately we require setuptools_trial
-# to setup and setuptools_trial requires Twisted to install, so hopefully
-# everything will work out until the Nevow issue is fixed:
-# http://divmod.org/trac/ticket/2629 setuptools_trial is needed if you want
-# "./setup.py trial" or "./setup.py test" to execute the tests (and in order
-# to make sure Twisted is installed early enough -- see the paragraph above).
-# http://pypi.python.org/pypi/setuptools_trial
-setup_requires.extend(['setuptools_trial >= 0.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). For simplicity, and
-# because there is some unknown error with setuptools_darcs when building and
-# testing tahoe all in one python command on some platforms, we always add it
-# to setup_requires. http://pypi.python.org/pypi/setuptools_darcs
-setup_requires.append('setuptools_darcs >= 1.1.0')
-
-# trialcoverage is required if you want the "trial" unit test runner to have a
-# "--reporter=bwverbose-coverage" option which produces code-coverage results.
-# The required version is 0.3.3, because that is the latest version that only
-# depends on a version of pycoverage for which binary packages are available.
-if "--reporter=bwverbose-coverage" in sys.argv:
-    setup_requires.append('trialcoverage >= 0.3.3')
-
-# stdeb is required to produce Debian files with the "sdist_dsc" command.
-if "sdist_dsc" in sys.argv:
-    setup_requires.append('stdeb >= 0.3')
-
-tests_require=[
-    # Mock - Mocking and Testing Library
-    # http://www.voidspace.org.uk/python/mock/
-    "mock",
-    ]
-
-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.get("PYTHONPATH", '')
+# We no longer have any requirements specific to tests.
+tests_require=[]
 
-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"]
+class Trial(Command):
+    description = "run trial (use 'bin%stahoe debug trial' for the full set of trial options)" % (os.sep,)
+    # This is just a subset of the most useful options, for compatibility.
+    user_options = [ ("no-rterrors", None, "Don't print out tracebacks as they occur."),
+                     ("rterrors", "e", "Print out tracebacks as they occur (default, so ignored)."),
+                     ("until-failure", "u", "Repeat a test (specified by -s) until it fails."),
+                     ("reporter=", None, "The reporter to use for this test run."),
+                     ("suite=", "s", "Specify the test suite."),
+                     ("quiet", None, "Don't display version numbers and paths of Tahoe dependencies."),
+                     ("coverage", "c", "Collect branch coverage information."),
+                   ]
 
     def initialize_options(self):
-        self.command = None
-        self.python = False
-        self.directory = None
-    def finalize_options(self):
-        pass
-    def run(self):
-        oldpp = os.environ.get("PYTHONPATH", "").split(os.pathsep)
-        if oldpp == [""]:
-            # grr silly split() behavior
-            oldpp = []
-        os.environ['PYTHONPATH'] = os.pathsep.join(oldpp + [supportlib,])
-
-        # 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)
+        self.rterrors = False
+        self.no_rterrors = False
+        self.until_failure = False
+        self.reporter = None
+        self.suite = "allmydata"
+        self.quiet = False
+        self.coverage = False
 
-class TestMacDiskImage(Command):
-    user_options = []
-    def initialize_options(self):
-        pass
     def finalize_options(self):
         pass
-    def run(self):
-        import sys
-        sys.path.append(os.path.join('misc', 'build_helpers'))
-        import test_mac_diskimage
-        return test_mac_diskimage.test_mac_diskimage('Allmydata', version=self.distribution.metadata.version)
 
-class CheckAutoDeps(Command):
-    user_options = []
-    def initialize_options(self):
-        pass
-    def finalize_options(self):
-        pass
     def run(self):
-        adglobals = {}
-        execfile('src/allmydata/_auto_deps.py', adglobals)
-        adglobals['require_auto_deps']()
+        args = [sys.executable, os.path.join('bin', 'tahoe')]
+
+        if self.coverage:
+            from errno import ENOENT
+            coverage_cmd = 'coverage'
+            try:
+                subprocess.call([coverage_cmd, 'help'])
+            except OSError as e:
+                if e.errno != ENOENT:
+                    raise
+                coverage_cmd = 'python-coverage'
+                try:
+                    rc = subprocess.call([coverage_cmd, 'help'])
+                except OSError as e:
+                    if e.errno != ENOENT:
+                        raise
+                    print >>sys.stderr
+                    print >>sys.stderr, "Couldn't find the command 'coverage' nor 'python-coverage'."
+                    print >>sys.stderr, "coverage can be installed using 'pip install coverage', or on Debian-based systems, 'apt-get install python-coverage'."
+                    sys.exit(1)
+
+            args += ['@' + coverage_cmd, 'run', '--branch', '--source=src/allmydata', '@tahoe']
+
+        if not self.quiet:
+            args.append('--version-and-path')
+        args += ['debug', 'trial']
+        if self.rterrors and self.no_rterrors:
+            raise AssertionError("--rterrors and --no-rterrors conflict.")
+        if not self.no_rterrors:
+            args.append('--rterrors')
+        if self.until_failure:
+            args.append('--until-failure')
+        if self.reporter:
+            args.append('--reporter=' + self.reporter)
+        if self.suite:
+            args.append(self.suite)
+        rc = subprocess.call(args)
+        sys.exit(rc)
 
 
 class MakeExecutable(Command):
+    description = "make the 'bin%stahoe' scripts" % (os.sep,)
     user_options = []
+
     def initialize_options(self):
         pass
     def finalize_options(self):
@@ -265,11 +193,9 @@ class MakeExecutable(Command):
     def run(self):
         bin_tahoe_template = os.path.join("bin", "tahoe-script.template")
 
-        if sys.platform == 'win32':
-            # 'tahoe' script is needed for cygwin
-            script_names = ["tahoe.pyscript", "tahoe"]
-        else:
-            script_names = ["tahoe"]
+        # tahoe.pyscript is really only necessary for Windows, but we also
+        # create it on Unix for consistency.
+        script_names = ["tahoe.pyscript", "tahoe"]
 
         # Create the tahoe script file under the 'bin' directory. This
         # file is exactly the same as the 'tahoe-script.template' script
@@ -291,12 +217,13 @@ class MakeExecutable(Command):
                 f.write(line)
             f.close()
 
-            # chmod +x
-            old_mode = stat.S_IMODE(os.stat(tahoe_script)[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(tahoe_script, new_mode)
+        # chmod +x
+        unix_script = os.path.join("bin", "tahoe")
+        old_mode = stat.S_IMODE(os.stat(unix_script)[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(unix_script, new_mode)
 
         old_tahoe_exe = os.path.join("bin", "tahoe.exe")
         try:
@@ -306,6 +233,136 @@ class MakeExecutable(Command):
                 raise
 
 
+GIT_VERSION_BODY = '''
+# This _version.py is generated from git metadata by the tahoe setup.py.
+
+__pkgname__ = %(pkgname)r
+real_version = %(version)r
+full_version = %(full)r
+branch = %(branch)r
+verstr = %(normalized)r
+__version__ = verstr
+'''
+
+def run_command(args, cwd=None):
+    use_shell = sys.platform == "win32"
+    try:
+        p = subprocess.Popen(args, stdout=subprocess.PIPE, cwd=cwd, shell=use_shell)
+    except EnvironmentError as e:  # if this gives a SyntaxError, note that Tahoe-LAFS requires Python 2.7+
+        print("Warning: unable to run %r." % (" ".join(args),))
+        print(e)
+        return None
+    stdout = p.communicate()[0].strip()
+    if p.returncode != 0:
+        print("Warning: %r returned error code %r." % (" ".join(args), p.returncode))
+        return None
+    return stdout
+
+
+def versions_from_git(tag_prefix):
+    # This runs 'git' from the directory that contains this file. That either
+    # means someone ran a setup.py command (and this code is in
+    # versioneer.py, thus the containing directory is the root of the source
+    # tree), or someone ran a project-specific entry point (and this code is
+    # in _version.py, thus the containing directory is somewhere deeper in
+    # the source tree). This only gets called if the git-archive 'subst'
+    # variables were *not* expanded, and _version.py hasn't already been
+    # rewritten with a short version string, meaning we're inside a checked
+    # out source tree.
+
+    # versions_from_git (as copied from python-versioneer) returns strings
+    # like "1.9.0-25-gb73aba9-dirty", which means we're in a tree with
+    # uncommited changes (-dirty), the latest checkin is revision b73aba9,
+    # the most recent tag was 1.9.0, and b73aba9 has 25 commits that weren't
+    # in 1.9.0 . The narrow-minded NormalizedVersion parser that takes our
+    # output (meant to enable sorting of version strings) refuses most of
+    # that. Tahoe uses a function named suggest_normalized_version() that can
+    # handle "1.9.0.post25", so dumb down our output to match.
+
+    try:
+        source_dir = os.path.dirname(os.path.abspath(__file__))
+    except NameError as e:
+        # some py2exe/bbfreeze/non-CPython implementations don't do __file__
+        print("Warning: unable to find version because we could not obtain the source directory.")
+        print(e)
+        return {}
+    stdout = run_command(["git", "describe", "--tags", "--dirty", "--always"],
+                         cwd=source_dir)
+    if stdout is None:
+        # run_command already complained.
+        return {}
+    if not stdout.startswith(tag_prefix):
+        print("Warning: tag %r doesn't start with prefix %r." % (stdout, tag_prefix))
+        return {}
+    version = stdout[len(tag_prefix):]
+    pieces = version.split("-")
+    if len(pieces) == 1:
+        normalized_version = pieces[0]
+    else:
+        normalized_version = "%s.post%s" % (pieces[0], pieces[1])
+
+    stdout = run_command(["git", "rev-parse", "HEAD"], cwd=source_dir)
+    if stdout is None:
+        # run_command already complained.
+        return {}
+    full = stdout.strip()
+    if version.endswith("-dirty"):
+        full += "-dirty"
+        normalized_version += ".dev0"
+
+    # Thanks to Jistanidiot at <http://stackoverflow.com/questions/6245570/get-current-branch-name>.
+    stdout = run_command(["git", "rev-parse", "--abbrev-ref", "HEAD"], cwd=source_dir)
+    branch = (stdout or "unknown").strip()
+
+    return {"version": version, "normalized": normalized_version, "full": full, "branch": branch}
+
+# setup.cfg has an [aliases] section which runs "update_version" before many
+# commands (like "build" and "sdist") that need to know our package version
+# ahead of time. If you add different commands (or if we forgot some), you
+# may need to add it to setup.cfg and configure it to run update_version
+# before your command.
+
+class UpdateVersion(Command):
+    description = "update _version.py from revision-control metadata"
+    user_options = []
+
+    def initialize_options(self):
+        pass
+    def finalize_options(self):
+        pass
+    def run(self):
+        global version
+        verstr = version
+        if os.path.isdir(os.path.join(basedir, ".git")):
+            verstr = self.try_from_git()
+
+        if verstr:
+            self.distribution.metadata.version = verstr
+        else:
+            print("""\
+********************************************************************
+Warning: no version information found. This may cause tests to fail.
+********************************************************************
+""")
+
+    def try_from_git(self):
+        # If we change APPNAME, the release tag names should also change from then on.
+        versions = versions_from_git(APPNAME + '-')
+        if versions:
+            f = open(VERSION_PY_FILENAME, "wb")
+            f.write(GIT_VERSION_BODY %
+                    { "pkgname": self.distribution.get_name(),
+                      "version": versions["version"],
+                      "normalized": versions["normalized"],
+                      "full": versions["full"],
+                      "branch": versions["branch"],
+                    })
+            f.close()
+            print("Wrote normalized version %r into '%s'" % (versions["normalized"], VERSION_PY_FILENAME))
+
+        return versions.get("normalized", None)
+
+
 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
@@ -349,37 +406,55 @@ class MySdist(sdist.sdist):
                 return fullname + "-SUMO"
             self.distribution.get_fullname = get_fullname
 
-        return sdist.sdist.make_distribution(self)
+        try:
+            old_mask = os.umask(int("022", 8))
+            return sdist.sdist.make_distribution(self)
+        finally:
+            os.umask(old_mask)
+
 
 setup_args = {}
 if version:
     setup_args["version"] = version
 
 setup(name=APPNAME,
-      description='secure, decentralized, fault-tolerant filesystem',
-      long_description=open('README.txt', 'rU').read(),
+      description='secure, decentralized, fault-tolerant file store',
+      long_description=open('README.rst', 'rU').read(),
       author='the Tahoe-LAFS project',
       author_email='tahoe-dev@tahoe-lafs.org',
-      url='http://tahoe-lafs.org/',
-      license='GNU GPL', # see README.txt -- there is an alternative licence
-      cmdclass={"show_supportlib": ShowSupportLib,
-                "show_pythonpath": ShowPythonPath,
-                "run_with_pythonpath": RunWithPythonPath,
-                "check_auto_deps": CheckAutoDeps,
-                "test_mac_diskimage": TestMacDiskImage,
+      url='https://tahoe-lafs.org/',
+      license='GNU GPL', # see README.rst -- there is an alternative licence
+      cmdclass={"trial": Trial,
                 "make_executable": MakeExecutable,
+                "update_version": UpdateVersion,
                 "sdist": MySdist,
                 },
       package_dir = {'':'src'},
-      packages=find_packages("src"),
+      packages=['allmydata',
+                'allmydata.frontends',
+                'allmydata.immutable',
+                'allmydata.immutable.downloader',
+                'allmydata.introducer',
+                'allmydata.mutable',
+                'allmydata.scripts',
+                'allmydata.storage',
+                'allmydata.test',
+                'allmydata.util',
+                'allmydata.web',
+                'allmydata.windows',
+                'buildtest'],
       classifiers=trove_classifiers,
       test_suite="allmydata.test",
       install_requires=install_requires,
       tests_require=tests_require,
-      include_package_data=True,
+      package_data={"allmydata.web": ["*.xhtml",
+                                      "static/*.js", "static/*.png", "static/*.css",
+                                      "static/img/*.png",
+                                      "static/css/*.css",
+                                      ]
+                    },
       setup_requires=setup_requires,
       entry_points = { 'console_scripts': [ 'tahoe = allmydata.scripts.runner:run' ] },
       zip_safe=False, # We prefer unzipped for easier access.
-      versionfiles=['src/allmydata/_version.py',],
       **setup_args
       )