Merge lp:~andrea.corbellini/beeseek/packaging into lp:beeseek/1.0

[Andrea Corbellini]

[Andrea Corbellini (andrea.corbellini)]

The new code in this branch helps both users and developers when creating packages. It improves the build process in different ways:

setup.py:
1. Exclude files and directories that are not needed (test files and API documentation).
2. If given, use the --root option instead of --prefix to install data.

Makefile:
1. Avoid the re-build of files already created.

The Makefile also has new commands to create four different types of archives: tar, tar.gz, tar.bz2, zip.

This branch is needed for the creation of distribution packages too.

[Andrea Colangelo (warp10)]

review: Approve

=== modified file 'Makefile'
--- Makefile	2009-08-09 16:13:30 +0000
+++ Makefile	2009-08-28 13:32:45 +0000
@@ -13,20 +13,48 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-PYTHON=/usr/bin/python
-
+NAME := beeseek-peer
+VERSION := $(shell ./beeseek-peer version --short)
+FULLNAME := $(NAME)-$(VERSION)
+PYVERSION := $(shell python -V 2>&1 | egrep -o '([0-9]\.[0-9])')
+PLATFORM := $(shell uname -s | tr A-Z a-z)-$(shell uname -m)
+PKGFILES := build/lib.$(PLATFORM)-$(PYVERSION)/beeseek \
+            build/scripts-$(PYVERSION)/beeseek-peer \
+            beeseek-peer.init config database templates setup.py
 pyflakes_ignore := beeseek/tests/unittests/.*\.py.*(undefined name|imported but unused)
 
 build: version-info
-	$(PYTHON) setup.py build
+	python setup.py build
 
 install: build
-	$(PYTHON) setup.py install
+	python setup.py install
 
-version-info:
+version-info: beeseek/_version_info.py
+beeseek/_version_info.py:
 	bzr version-info --python > beeseek/_version_info.py
 
 
+dist: build
+	mkdir -p dist/$(FULLNAME)
+	cp -R $(PKGFILES) dist/$(FULLNAME)
+
+tar: dist/$(FULLNAME).tar
+dist/$(FULLNAME).tar: dist
+	tar -cf dist/$(FULLNAME).tar -C dist $(FULLNAME)
+
+tar.gz: dist/$(FULLNAME).tar.gz
+dist/$(FULLNAME).tar.gz: tar
+	gzip -9 dist/$(FULLNAME).tar
+
+tar.bz2: dist/$(FULLNAME).tar.bz2
+dist/$(FULLNAME).tar.bz2: tar
+	bzip2 -9 dist/$(FULLNAME).tar
+
+zip: dist/$(FULLNAME).zip
+dist/$(FULLNAME).zip: dist
+	cd dist; zip -rq $(FULLNAME).zip $(FULLNAME)
+
+
 pychecker:
 	find beeseek -name "*.py" | xargs pychecker --limit=100000
 
@@ -42,12 +70,13 @@
 	pylint -f parseable -r no --enable-checker miscellaneous beeseek
 
 
-docs:
+docs: doc/build
+doc/build:
 	sphinx-build -b html -d doc/build/doctrees -N -c doc/ beeseek/docs doc/build/html
 	epydoc --html -n"BeeSeek" --no-frames --no-source --simple-term beeseek -o doc/build/html/source
 
 clean:
-	rm -rf build doc/build dist beeseek/_version_info.py
+	rm -rf build dist doc/build beeseek/_version_info.py
 	find . -name "*.pyc" -o -name "*.pyo" -o -name "*~" | xargs rm -f
 
 clean-db:

=== modified file 'beeseek/app/directory.py'
--- beeseek/app/directory.py	2009-07-09 11:37:49 +0000
+++ beeseek/app/directory.py	2009-07-14 16:07:24 +0000
@@ -15,24 +15,37 @@
 
 import os
 import stat
+import sys
 import tempfile
 
 
-tempdirs = tempfile._candidate_tempdir_list()
+lockdirs = tempfile._candidate_tempdir_list()
+if os.name != 'nt':
+    lockdirs.insert(0, '/var/lock')
 
 class Directory(object):
 
     __slots__ = 'dirlist', '_mode', '_subdirs', '_directory', '_create'
 
-    def __init__(self, dirlist, **kwargs):
+    def __init__(self, dirlist, mode='rw', subdirs=(), create=False,
+                 adjust=False):
         if isinstance(dirlist, basestring):
             dirlist = (dirlist,)
+        if adjust and os.name == 'nt':
+            dirlist = self._adjust_for_win(dirlist)
         self.dirlist = tuple(os.path.normcase(os.path.abspath(
                              os.path.expanduser(directory)))
                              for directory in dirlist)
-        self._mode = kwargs.get('mode', 'rw')
-        self._subdirs = kwargs.get('subdirs', ())
-        self._create = kwargs.get('create', ())
+        self._mode = mode
+        self._subdirs = subdirs
+        self._create = create
+
+    def _adjust_for_win(self, dirlist):
+        basepath = os.path.dirname(sys.executable)
+        for directory in dirlist:
+            yield os.path.join(basepath,
+                               'BeeSeek',
+                               os.path.basename(directory))
 
     def _check_permissions(self, directory):
         strmode = self._mode
@@ -41,7 +54,6 @@
         stat_result = os.stat(directory)
         usermode = groupmode = othermode = 0
 
-        # _issuitable() should be called rarely so we can use hasattr() here
         if not hasattr(os, 'getuid') or stat_result.st_uid == os.getuid():
             if 'r' in strmode:
                 usermode = stat.S_IXUSR

=== modified file 'beeseek/app/options.py'
--- beeseek/app/options.py	2009-08-23 19:12:47 +0000
+++ beeseek/app/options.py	2009-08-24 15:10:30 +0000
@@ -15,7 +15,7 @@
 
 import os
 from beeseek.app import instance
-from beeseek.app.directory import Directory, tempdirs
+from beeseek.app.directory import Directory, lockdirs
 from beeseek.interface import Interface, implements
 
 
@@ -198,6 +198,14 @@
                      'Enable the testing mode.')
 
 
+class VersionOptions(BaseOptionList):
+
+    implements(IOptionList)
+
+    short = Option(bool, None, ('-s', '--short'), None,
+                   'Show just the version number.')
+
+
 class CommonServiceOptions(CommonOptions):
 
     """Options to deal with the service."""
@@ -212,7 +220,7 @@
     lockdir = Option(Directory, 'LockDirectory',
         ('-L', '--lock-dir'), None,
         'The directory for lock files.',
-        default=['/var/lock'] + tempdirs,
+        default=lockdirs,
         convert_default=True)
 
     user = Option(str, 'User',
@@ -235,7 +243,8 @@
         convert_kwargs={
             'subdirs': ('keywords', 'pages', 'configuration',
                         'statistics', 'keys', 'needed-results'),
-            'create': True})
+            'create': True,
+            'adjust': True})
 
     daemon = Option(bool, 'Daemon',
         ('-b', '--daemon'), ('-f', '--foreground'),
@@ -254,7 +263,9 @@
         testing_default='templates',
         convert_default=True,
         convert_kwargs={
-            'mode': 'r', 'subdirs': ('css', 'html', 'images', 'javascript')})
+            'mode': 'r',
+            'subdirs': ('css', 'html', 'images', 'javascript'),
+            'adjust': True})
 
     server_hostname = Option(str, 'ServerHostname',
         ('-s', '--server'), None,

=== modified file 'beeseek/app/session.py'
--- beeseek/app/session.py	2009-08-24 12:38:07 +0000
+++ beeseek/app/session.py	2009-08-24 15:10:30 +0000
@@ -29,7 +29,7 @@
 from beeseek.app.command import CommandObject, command
 from beeseek.app.baseconfig import ConfigurationParser
 from beeseek.app.options import (
-    CommonOptions, CommonServiceOptions, StartOptions)
+    CommonOptions, VersionOptions, CommonServiceOptions, StartOptions)
 from beeseek.app.directory import Directory
 from beeseek.app.utils import get_argcount
 
@@ -210,7 +210,10 @@
         return getattr(self, '_status', 'unknown')
 
     # Configuration
-    configdir = Directory(('/etc/beeseek', '~/.beeseek', 'config'), mode='r')
+    # XXX This should be set elsewhere
+    configdir = Directory(('/etc/beeseek', 'config'),
+                          mode='r',
+                          adjust=True)
     logfile = open(os.devnull, 'w')
     debug = False
 
@@ -645,12 +648,15 @@
             parser.populate(command_obj.optionlist)
             print parser.format_option_help()
 
-    @command(CommonOptions)
+    @command(VersionOptions)
     def version(self):
         """Show version information."""
-        print '%s version %s' % (self.appname, version_info)
-        if version_info.revno:
-            print 'Revision: %s' % version_info.revno
+        if self.short:
+            print version_info
+        else:
+            print '%s version %s' % (self.appname, version_info)
+            if version_info.revno:
+                print 'Revision: %s' % version_info.revno
 
 
     # Operations queue and threads

=== modified file 'setup.py'
--- setup.py	2009-08-23 19:12:47 +0000
+++ setup.py	2009-08-26 13:11:35 +0000
@@ -23,43 +23,71 @@
 import os
 from distutils.core import setup
 from distutils.command.install_data import install_data
-import pwd
+try:
+    import pwd
+except ImportError:
+    pwd = None
 import beeseek
 
 
 class configure_and_install_data(install_data):
 
+    def finalize_options(self):
+        if self.install_dir is None:
+            install_cmd = self.distribution.get_command_obj('install')
+            self.install_dir = install_cmd.root or install_cmd.prefix
+            dir_specified = self.install_dir
+        install_data.finalize_options(self)
+        if not dir_specified and os.name != 'nt':
+            self.install_dir = os.path.dirname(install_cmd.prefix)
+
     def run(self):
-        data_files = self.data_files = []
-        dirs_map = {
-           'etc/beeseek': 'config',
-           'var/lib/beeseek/database': 'database',
-           'usr/share/beeseek/templates': 'templates'
-        }
+        install_dir = self.install_dir
+        if os.name == 'nt':
+            dirs_map = {
+                'BeeSeek/config': 'config',
+                'BeeSeek/database': 'database',
+                'BeeSeek/webdata': 'webdata'
+            }
+        else:
+            dirs_map = {
+               'etc/beeseek': 'config',
+               'var/lib/beeseek/database': 'database',
+               'usr/share/beeseek/templates': 'templates'
+            }
 
         for destination, source in dirs_map.iteritems():
-            sourcelen = len(source) + 1
+            destination = os.path.join(install_dir, destination)
+            self.mkpath(destination)
             for directory, subdirs, subfiles in os.walk(source):
-                path = os.path.join(destination, directory[sourcelen:])
-                subfiles = [os.path.join(directory, filename)
-                            for filename in subfiles]
-                data_files.append((path, subfiles))
-
-        install_data.run(self)
-        self.mkpath(os.path.join(self.install_dir, 'etc/init.d'))
-        self.copy_file('beeseek-peer.init',
-                       os.path.join(self.install_dir,
-                                    'etc/init.d/beeseek-peer'))
-        self.mkpath(os.path.join(self.install_dir, 'var/log/beeseek'))
-
-        items = pwd.getpwnam('www-data')
-        uid, gid = items[2], items[3]
-        for path in ('var/log/beeseek', 'var/lib/beeseek'):
-            path = os.path.join(self.install_dir, path)
-            for directory, subdirs, subfiles in os.walk(path):
-                os.chown(directory, uid, gid)
-                for filename in subfiles:
-                    os.chown(os.path.join(directory, filename), uid, gid)
+                subdirectory = directory[len(source)+1:]
+                for subdir in subdirs:
+                    self.mkpath(
+                        os.path.join(destination, subdirectory, subdir))
+                for file_name in subfiles:
+                    self.copy_file(
+                        os.path.join(directory, file_name),
+                        os.path.join(destination, subdirectory, file_name))
+
+        if os.name != 'nt':
+            self.mkpath(os.path.join(install_dir, 'etc/init.d'))
+            self.copy_file('beeseek-peer.init',
+                os.path.join(install_dir, 'etc/init.d/beeseek-peer'))
+            self.mkpath(os.path.join(install_dir, 'var/log/beeseek'))
+
+        if not self.dry_run and pwd:
+            items = pwd.getpwnam('www-data')
+            uid, gid = items[2], items[3]
+            for path in ('var/log/beeseek', 'var/lib/beeseek'):
+                path = os.path.join(install_dir, path)
+                for directory, subdirs, subfiles in os.walk(path):
+                    try:
+                        os.chown(directory, uid, gid)
+                        for filename in subfiles:
+                            os.chown(
+                                os.path.join(directory, filename), uid, gid)
+                    except OSError:
+                        pass
 
 
 def add_packages(metadata):
@@ -68,10 +96,13 @@
     packages = metadata['packages'] = []
     for directory, subdirs, subfiles in os.walk(path):
         name = directory[unneeded:].replace(os.path.sep, '.')
-        if (name.startswith('beeseek.tests')
-            or name.startswith('beeseek.app.server')):
-            continue
-        packages.append(name)
+        skip = False
+        for package in exclude_packages:
+            if name.startswith(package):
+                skip = True
+                break
+        if not skip:
+            packages.append(name)
 
 def add_description(metadata):
     from beeseek.app import peer
@@ -83,6 +114,13 @@
     metadata['description'] = summary.rstrip('.')
     metadata['long_description'] = description.strip()
 
+exclude_packages = [
+    'beeseek.app.server',
+    'beeseek.docs',
+    'beeseek.testing',
+    'beeseek.tests',
+    ]
+
 metadata = {
     'name': 'beeseek-peer',
     'version': beeseek.__version__,

=== modified file 'testsuite.py'
--- testsuite.py	2009-08-05 16:40:13 +0000
+++ testsuite.py	2009-08-24 14:52:46 +0000
@@ -130,6 +130,9 @@
     for test_case in testlist:
         test_case.run(run_dependencies)
     testing.Logger.finish()
+    if testing.Logger.failures or testing.Logger.errors:
+        sys.exit(1)
+    sys.exit(0)
 
 
 if __name__ == '__main__':