SConstruct

   1 #
   2 # SConstruct file to build scons packages during development.
   3 #
   4 # See the README file for an overview of how SCons is built and tested.
   5 #
   6
   7 copyright_years = '2001, 2002, 2003'
   8
   9 #
  10 # __COPYRIGHT__
  11 #
  12 # Permission is hereby granted, free of charge, to any person obtaining
  13 # a copy of this software and associated documentation files (the
  14 # "Software"), to deal in the Software without restriction, including
  15 # without limitation the rights to use, copy, modify, merge, publish,
  16 # distribute, sublicense, and/or sell copies of the Software, and to
  17 # permit persons to whom the Software is furnished to do so, subject to
  18 # the following conditions:
  19 #
  20 # The above copyright notice and this permission notice shall be included
  21 # in all copies or substantial portions of the Software.
  22 #
  23 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  24 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  25 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  27 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  28 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  29 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  30 #
  31
  32 import distutils.util
  33 import os
  34 import os.path
  35 import socket
  36 import stat
  37 import string
  38 import sys
  39 import time
  40
  41 project = 'scons'
  42 default_version = '0.15'
  43 copyright = "Copyright (c) %s Steven Knight" % copyright_years
  44
  45 Default('.')
  46
  47 #
  48 # An internal "whereis" routine to figure out if a given program
  49 # is available on this system.
  50 #
  51 def whereis(file):
  52     for dir in string.split(os.environ['PATH'], os.pathsep):
  53         f = os.path.join(dir, file)
  54         if os.path.isfile(f):
  55             try:
  56                 st = os.stat(f)
  57             except:
  58                 continue
  59             if stat.S_IMODE(st[stat.ST_MODE]) & 0111:
  60                 return f
  61     return None
  62
  63 #
  64 # We let the presence or absence of various utilities determine
  65 # whether or not we bother to build certain pieces of things.
  66 # This should allow people to still do SCons work even if they
  67 # don't have Aegis or RPM installed, for example.
  68 #
  69 aegis = whereis('aegis')
  70 aesub = whereis('aesub')
  71 dh_builddeb = whereis('dh_builddeb')
  72 fakeroot = whereis('fakeroot')
  73 gzip = whereis('gzip')
  74 rpmbuild = whereis('rpmbuild') or whereis('rpm')
  75 unzip = whereis('unzip')
  76 zip = whereis('zip')
  77
  78 #
  79 # Now grab the information that we "build" into the files.
  80 #
  81 try:
  82     date = ARGUMENTS['date']
  83 except:
  84     date = time.strftime("%Y/%m/%d %H:%M:%S", time.localtime(time.time()))
  85
  86 if ARGUMENTS.has_key('developer'):
  87     developer = ARGUMENTS['developer']
  88 elif os.environ.has_key('USERNAME'):
  89     developer = os.environ['USERNAME']
  90 elif os.environ.has_key('LOGNAME'):
  91     developer = os.environ['LOGNAME']
  92 elif os.environ.has_key('USER'):
  93     developer = os.environ['USER']
  94
  95 if ARGUMENTS.has_key('build_system'):
  96     build_system = ARGUMENTS['build_system']
  97 else:
  98     build_system = string.split(socket.gethostname(), '.')[0]
  99
 100 if ARGUMENTS.has_key('version'):
 101     revision = ARGUMENTS['version']
 102 elif aesub:
 103     revision = os.popen(aesub + " \\$version", "r").read()[:-1]
 104 else:
 105     revision = default_version
 106
 107 a = string.split(revision, '.')
 108 arr = [a[0]]
 109 for s in a[1:]:
 110     if len(s) == 1:
 111         s = '0' + s
 112     arr.append(s)
 113 revision = string.join(arr, '.')
 114
 115 # Here's how we'd turn the calculated $revision into our package $version.
 116 # This makes it difficult to coordinate with other files (debian/changelog
 117 # and rpm/scons.spec) that hard-code the version number, so just go with
 118 # the flow for now and hard code it here, too.
 119 #if len(arr) >= 2:
 120 #    arr = arr[:-1]
 121 #def xxx(str):
 122 #    if str[0] == 'C' or str[0] == 'D':
 123 #        str = str[1:]
 124 #    while len(str) > 2 and str[0] == '0':
 125 #        str = str[1:]
 126 #    return str
 127 #arr = map(lambda x, xxx=xxx: xxx(x), arr)
 128 #version = string.join(arr, '.')
 129 version = default_version
 130
 131 build_id = string.replace(revision, version + '.', '')
 132
 133 if ARGUMENTS.has_key('change'):
 134     change = ARGUMENTS['change']
 135 elif aesub:
 136     change = os.popen(aesub + " \\$change", "r").read()[:-1]
 137 else:
 138     change = default_version
 139
 140 python_ver = sys.version[0:3]
 141
 142 platform = distutils.util.get_platform()
 143
 144 ENV = { 'PATH' : os.environ['PATH'] }
 145 for key in ['AEGIS_PROJECT', 'PYTHONPATH']:
 146     if os.environ.has_key(key):
 147         ENV[key] = os.environ[key]
 148
 149 lib_project = os.path.join("lib", project)
 150
 151 cwd_build = os.path.join(os.getcwd(), "build")
 152
 153 test_deb_dir          = os.path.join(cwd_build, "test-deb")
 154 test_rpm_dir          = os.path.join(cwd_build, "test-rpm")
 155 test_tar_gz_dir       = os.path.join(cwd_build, "test-tar-gz")
 156 test_src_tar_gz_dir   = os.path.join(cwd_build, "test-src-tar-gz")
 157 test_local_tar_gz_dir = os.path.join(cwd_build, "test-local-tar-gz")
 158 test_zip_dir          = os.path.join(cwd_build, "test-zip")
 159 test_src_zip_dir      = os.path.join(cwd_build, "test-src-zip")
 160 test_local_zip_dir    = os.path.join(cwd_build, "test-local-zip")
 161
 162 unpack_tar_gz_dir     = os.path.join(cwd_build, "unpack-tar-gz")
 163 unpack_zip_dir        = os.path.join(cwd_build, "unpack-zip")
 164
 165 if platform == "win32":
 166     tar_hflag = ''
 167     python_project_subinst_dir = None
 168     project_script_subinst_dir = 'Scripts'
 169 else:
 170     tar_hflag = 'h'
 171     python_project_subinst_dir = lib_project
 172     project_script_subinst_dir = 'bin'
 173
 174
 175 zcat = 'gzip -d -c'
 176
 177 #
 178 # Figure out if we can handle .zip files.
 179 #
 180 zipit = None
 181 unzipit = None
 182 try:
 183     import zipfile
 184
 185     def zipit(env, target, source):
 186         print "Zipping %s:" % str(target[0])
 187         def visit(arg, dirname, names):
 188             for name in names:
 189                 path = os.path.join(dirname, name)
 190                 if os.path.isfile(path):
 191                     arg.write(path)
 192         zf = zipfile.ZipFile(str(target[0]), 'w')
 193         olddir = os.getcwd()
 194         os.chdir(env['CD'])
 195         try: os.path.walk(env['PSV'], visit, zf)
 196         finally: os.chdir(olddir)
 197         zf.close()
 198
 199     def unzipit(env, target, source):
 200         print "Unzipping %s:" % str(source[0])
 201         zf = zipfile.ZipFile(str(source[0]), 'r')
 202         for name in zf.namelist():
 203             dest = os.path.join(env['UNPACK_ZIP_DIR'], name)
 204             dir = os.path.dirname(dest)
 205             try:
 206                 os.makedirs(dir)
 207             except:
 208                 pass
 209             print dest,name
 210             # if the file exists, then delete it before writing
 211             # to it so that we don't end up trying to write to a symlink:
 212             if os.path.isfile(dest) or os.path.islink(dest):
 213                 os.unlink(dest)
 214             if not os.path.isdir(dest):
 215                 open(dest, 'w').write(zf.read(name))
 216
 217 except:
 218     if unzip and zip:
 219         zipit = "cd $CD && $ZIP $ZIPFLAGS $( ${TARGET.abspath} $) $PSV"
 220         unzipit = "$UNZIP $UNZIPFLAGS $SOURCES"
 221
 222 def SCons_revision(target, source, env):
 223     """Interpolate specific values from the environment into a file.
 224
 225     This is used to copy files into a tree that gets packaged up
 226     into the source file package.
 227     """
 228     t = str(target[0])
 229     s = source[0].rstr()
 230     inf = open(s, 'rb')
 231     outf = open(t, 'wb')
 232     for line in inf.readlines():
 233         # Note:  We construct the __*__ substitution strings here
 234         # so that they don't get replaced when this file gets
 235         # copied into the tree for packaging.
 236         line = string.replace(line, '__BUILD'     + '__', env['BUILD'])
 237         line = string.replace(line, '__BUILDSYS'  + '__', env['BUILDSYS'])
 238         line = string.replace(line, '__COPYRIGHT' + '__', env['COPYRIGHT'])
 239         line = string.replace(line, '__DATE'      + '__', env['DATE'])
 240         line = string.replace(line, '__DEVELOPER' + '__', env['DEVELOPER'])
 241         line = string.replace(line, '__FILE'      + '__', str(source[0]))
 242         line = string.replace(line, '__REVISION'  + '__', env['REVISION'])
 243         line = string.replace(line, '__VERSION'   + '__', env['VERSION'])
 244         line = string.replace(line, '__NULL'      + '__', '')
 245         outf.write(line)
 246     inf.close()
 247     outf.close()
 248     os.chmod(t, os.stat(s)[0])
 249
 250 revbuilder = Builder(action = Action(SCons_revision, varlist=['VERSION']))
 251
 252 env = Environment(
 253                    ENV                 = ENV,
 254
 255                    BUILD               = build_id,
 256                    BUILDSYS            = build_system,
 257                    COPYRIGHT           = copyright,
 258                    DATE                = date,
 259                    DEVELOPER           = developer,
 260                    REVISION            = revision,
 261                    VERSION             = version,
 262                    DH_COMPAT           = 2,
 263
 264                    TAR_HFLAG           = tar_hflag,
 265
 266                    ZIP                 = zip,
 267                    ZIPFLAGS            = '-r',
 268                    UNZIP               = unzip,
 269                    UNZIPFLAGS          = '-o -d $UNPACK_ZIP_DIR',
 270
 271                    ZCAT                = zcat,
 272
 273                    RPMBUILD            = rpmbuild,
 274                    RPM2CPIO            = 'rpm2cpio',
 275
 276                    TEST_DEB_DIR        = test_deb_dir,
 277                    TEST_RPM_DIR        = test_rpm_dir,
 278                    TEST_SRC_TAR_GZ_DIR = test_src_tar_gz_dir,
 279                    TEST_SRC_ZIP_DIR    = test_src_zip_dir,
 280                    TEST_TAR_GZ_DIR     = test_tar_gz_dir,
 281                    TEST_ZIP_DIR        = test_zip_dir,
 282
 283                    UNPACK_TAR_GZ_DIR   = unpack_tar_gz_dir,
 284                    UNPACK_ZIP_DIR      = unpack_zip_dir,
 285
 286                    BUILDERS            = { 'SCons_revision' : revbuilder },
 287
 288                    PYTHON              = sys.executable
 289                  )
 290
 291 #
 292 # Define SCons packages.
 293 #
 294 # In the original, more complicated packaging scheme, we were going
 295 # to have separate packages for:
 296 #
 297 #       python-scons    only the build engine
 298 #       scons-script    only the script
 299 #       scons           the script plus the build engine
 300 #
 301 # We're now only delivering a single "scons" package, but this is still
 302 # "built" as two sub-packages (the build engine and the script), so
 303 # the definitions remain here, even though we're not using them for
 304 # separate packages.
 305 #
 306
 307 python_scons = {
 308         'pkg'           : 'python-' + project,
 309         'src_subdir'    : 'engine',
 310         'inst_subdir'   : os.path.join('lib', 'python1.5', 'site-packages'),
 311         'rpm_dir'       : '/usr/lib/scons',
 312
 313         'debian_deps'   : [
 314                             'debian/changelog',
 315                             'debian/control',
 316                             'debian/copyright',
 317                             'debian/dirs',
 318                             'debian/docs',
 319                             'debian/postinst',
 320                             'debian/prerm',
 321                             'debian/rules',
 322                           ],
 323
 324         'files'         : [ 'LICENSE.txt',
 325                             'README.txt',
 326                             'setup.cfg',
 327                             'setup.py',
 328                           ],
 329
 330         'filemap'       : {
 331                             'LICENSE.txt' : '../LICENSE.txt'
 332                           },
 333 }
 334
 335 #
 336 # The original packaging scheme would have have required us to push
 337 # the Python version number into the package name (python1.5-scons,
 338 # python2.0-scons, etc.), which would have required a definition
 339 # like the following.  Leave this here in case we ever decide to do
 340 # this in the future, but note that this would require some modification
 341 # to src/engine/setup.py before it would really work.
 342 #
 343 #python2_scons = {
 344 #        'pkg'          : 'python2-' + project,
 345 #        'src_subdir'   : 'engine',
 346 #        'inst_subdir'  : os.path.join('lib', 'python2.1', 'site-packages'),
 347 #
 348 #        'debian_deps'  : [
 349 #                            'debian/changelog',
 350 #                            'debian/control',
 351 #                            'debian/copyright',
 352 #                            'debian/dirs',
 353 #                            'debian/docs',
 354 #                            'debian/postinst',
 355 #                            'debian/prerm',
 356 #                            'debian/rules',
 357 #                          ],
 358 #
 359 #        'files'        : [
 360 #                            'LICENSE.txt',
 361 #                            'README.txt',
 362 #                            'setup.cfg',
 363 #                            'setup.py',
 364 #                          ],
 365 #        'filemap'      : {
 366 #                            'LICENSE.txt' : '../LICENSE.txt',
 367 #                          },
 368 #}
 369 #
 370
 371 scons_script = {
 372         'pkg'           : project + '-script',
 373         'src_subdir'    : 'script',
 374         'inst_subdir'   : 'bin',
 375         'rpm_dir'       : '/usr/bin',
 376
 377         'debian_deps'   : [
 378                             'debian/changelog',
 379                             'debian/control',
 380                             'debian/copyright',
 381                             'debian/dirs',
 382                             'debian/docs',
 383                             'debian/postinst',
 384                             'debian/prerm',
 385                             'debian/rules',
 386                           ],
 387
 388         'files'         : [
 389                             'LICENSE.txt',
 390                             'README.txt',
 391                             'setup.cfg',
 392                             'setup.py',
 393                           ],
 394
 395         'filemap'       : {
 396                             'LICENSE.txt' : '../LICENSE.txt',
 397                             'scons'       : 'scons.py',
 398                            }
 399 }
 400
 401 scons = {
 402         'pkg'           : project,
 403
 404         'debian_deps'   : [
 405                             'debian/changelog',
 406                             'debian/control',
 407                             'debian/copyright',
 408                             'debian/dirs',
 409                             'debian/docs',
 410                             'debian/postinst',
 411                             'debian/prerm',
 412                             'debian/rules',
 413                           ],
 414
 415         'files'         : [
 416                             'CHANGES.txt',
 417                             'LICENSE.txt',
 418                             'README.txt',
 419                             'RELEASE.txt',
 420                             'os_spawnv_fix.diff',
 421                             'scons.1',
 422                             'script/scons.bat',
 423                             'setup.cfg',
 424                             'setup.py',
 425                           ],
 426
 427         'filemap'       : {
 428                             'scons.1' : '../doc/man/scons.1',
 429                           },
 430
 431         'subpkgs'       : [ python_scons, scons_script ],
 432
 433         'subinst_dirs'  : {
 434                              'python-' + project : python_project_subinst_dir,
 435                              project + '-script' : project_script_subinst_dir,
 436                            },
 437 }
 438
 439 src_deps = []
 440 src_files = []
 441
 442 for p in [ scons ]:
 443     #
 444     # Initialize variables with the right directories for this package.
 445     #
 446     pkg = p['pkg']
 447     pkg_version = "%s-%s" % (pkg, version)
 448
 449     src = 'src'
 450     if p.has_key('src_subdir'):
 451         src = os.path.join(src, p['src_subdir'])
 452
 453     build = os.path.join('build', pkg)
 454
 455     tar_gz = os.path.join(build, 'dist', "%s.tar.gz" % pkg_version)
 456     platform_tar_gz = os.path.join(build,
 457                                    'dist',
 458                                    "%s.%s.tar.gz" % (pkg_version, platform))
 459     zip = os.path.join(build, 'dist', "%s.zip" % pkg_version)
 460     platform_zip = os.path.join(build,
 461                                 'dist',
 462                                 "%s.%s.zip" % (pkg_version, platform))
 463     win32_exe = os.path.join(build, 'dist', "%s.win32.exe" % pkg_version)
 464
 465     #
 466     # Update the environment with the relevant information
 467     # for this package.
 468     #
 469     # We can get away with calling setup.py using a directory path
 470     # like this because we put a preamble in it that will chdir()
 471     # to the directory in which setup.py exists.
 472     #
 473     setup_py = os.path.join(build, 'setup.py')
 474     env.Replace(PKG = pkg,
 475                 PKG_VERSION = pkg_version,
 476                 SETUP_PY = setup_py)
 477     Local(setup_py)
 478
 479     #
 480     # Read up the list of source files from our MANIFEST.in.
 481     # This list should *not* include LICENSE.txt, MANIFEST,
 482     # README.txt, or setup.py.  Make a copy of the list for the
 483     # destination files.
 484     #
 485     manifest_in = File(os.path.join(src, 'MANIFEST.in')).rstr()
 486     src_files = map(lambda x: x[:-1],
 487                     open(manifest_in).readlines())
 488     raw_files = src_files[:]
 489     dst_files = src_files[:]
 490     rpm_files = []
 491
 492     MANIFEST_in_list = []
 493
 494     if p.has_key('subpkgs'):
 495         #
 496         # This package includes some sub-packages.  Read up their
 497         # MANIFEST.in files, and add them to our source and destination
 498         # file lists, modifying them as appropriate to add the
 499         # specified subdirs.
 500         #
 501         for sp in p['subpkgs']:
 502             ssubdir = sp['src_subdir']
 503             isubdir = p['subinst_dirs'][sp['pkg']]
 504             MANIFEST_in = File(os.path.join(src, ssubdir, 'MANIFEST.in')).rstr()
 505             MANIFEST_in_list.append(MANIFEST_in)
 506             files = map(lambda x: x[:-1], open(MANIFEST_in).readlines())
 507             raw_files.extend(files)
 508             src_files.extend(map(lambda x, s=ssubdir: os.path.join(s, x), files))
 509             for f in files:
 510                 r = os.path.join(sp['rpm_dir'], f)
 511                 rpm_files.append(r)
 512                 if f[-3:] == ".py":
 513                     rpm_files.append(r + 'c')
 514             if isubdir:
 515                 files = map(lambda x, i=isubdir: os.path.join(i, x), files)
 516             dst_files.extend(files)
 517             for k in sp['filemap'].keys():
 518                 f = sp['filemap'][k]
 519                 if f:
 520                     k = os.path.join(sp['src_subdir'], k)
 521                     p['filemap'][k] = os.path.join(sp['src_subdir'], f)
 522
 523     #
 524     # Now that we have the "normal" source files, add those files
 525     # that are standard for each distribution.  Note that we don't
 526     # add these to dst_files, because they don't get installed.
 527     # And we still have the MANIFEST to add.
 528     #
 529     src_files.extend(p['files'])
 530
 531     #
 532     # Now run everything in src_file through the sed command we
 533     # concocted to expand __FILE__, __VERSION__, etc.
 534     #
 535     for b in src_files:
 536         s = p['filemap'].get(b, b)
 537         env.SCons_revision(os.path.join(build, b), os.path.join(src, s))
 538
 539     #
 540     # NOW, finally, we can create the MANIFEST, which we do
 541     # by having Python spit out the contents of the src_files
 542     # array we've carefully created.  After we've added
 543     # MANIFEST itself to the array, of course.
 544     #
 545     src_files.append("MANIFEST")
 546     MANIFEST_in_list.append(os.path.join(src, 'MANIFEST.in'))
 547
 548     def write_src_files(target, source, **kw):
 549         global src_files
 550         src_files.sort()
 551         f = open(str(target[0]), 'wb')
 552         for file in src_files:
 553             f.write(file + "\n")
 554         f.close()
 555         return 0
 556     env.Command(os.path.join(build, 'MANIFEST'),
 557                 MANIFEST_in_list,
 558                 write_src_files)
 559
 560     #
 561     # Now go through and arrange to create whatever packages we can.
 562     #
 563     build_src_files = map(lambda x, b=build: os.path.join(b, x), src_files)
 564     apply(Local, build_src_files, {})
 565
 566     distutils_formats = []
 567
 568     distutils_targets = [ win32_exe ]
 569
 570     install_targets = distutils_targets[:]
 571
 572     if gzip:
 573
 574         distutils_formats.append('gztar')
 575
 576         src_deps.append(tar_gz)
 577
 578         distutils_targets.extend([ tar_gz, platform_tar_gz ])
 579         install_targets.extend([ tar_gz, platform_tar_gz ])
 580
 581         #
 582         # Unpack the tar.gz archive created by the distutils into
 583         # build/unpack-tar-gz/scons-{version}.
 584         #
 585         # We'd like to replace the last three lines with the following:
 586         #
 587         #       tar zxf $SOURCES -C $UNPACK_TAR_GZ_DIR
 588         #
 589         # but that gives heartburn to Cygwin's tar, so work around it
 590         # with separate zcat-tar-rm commands.
 591         #
 592         unpack_tar_gz_files = map(lambda x, u=unpack_tar_gz_dir, pv=pkg_version:
 593                                          os.path.join(u, pv, x),
 594                                   src_files)
 595         env.Command(unpack_tar_gz_files, tar_gz, [
 596                     "rm -rf %s" % os.path.join(unpack_tar_gz_dir, pkg_version),
 597                     "$ZCAT $SOURCES > .temp",
 598                     "tar xf .temp -C $UNPACK_TAR_GZ_DIR",
 599                     "rm -f .temp",
 600         ])
 601
 602         #
 603         # Run setup.py in the unpacked subdirectory to "install" everything
 604         # into our build/test subdirectory.  The runtest.py script will set
 605         # PYTHONPATH so that the tests only look under build/test-{package},
 606         # and under etc (for the testing modules TestCmd.py, TestSCons.py,
 607         # and unittest.py).  This makes sure that our tests pass with what
 608         # we really packaged, not because of something hanging around in
 609         # the development directory.
 610         #
 611         # We can get away with calling setup.py using a directory path
 612         # like this because we put a preamble in it that will chdir()
 613         # to the directory in which setup.py exists.
 614         #
 615         dfiles = map(lambda x, d=test_tar_gz_dir: os.path.join(d, x), dst_files)
 616         env.Command(dfiles, unpack_tar_gz_files, [
 617             "rm -rf %s" % os.path.join(unpack_tar_gz_dir, pkg_version, 'build'),
 618             "rm -rf $TEST_TAR_GZ_DIR",
 619             "$PYTHON %s install --prefix=$TEST_TAR_GZ_DIR" % \
 620                 os.path.join(unpack_tar_gz_dir, pkg_version, 'setup.py'),
 621         ])
 622
 623     if zipit:
 624
 625         distutils_formats.append('zip')
 626
 627         src_deps.append(zip)
 628
 629         distutils_targets.extend([ zip, platform_zip ])
 630         install_targets.extend([ zip, platform_zip ])
 631
 632         #
 633         # Unpack the zip archive created by the distutils into
 634         # build/unpack-zip/scons-{version}.
 635         #
 636         unpack_zip_files = map(lambda x, u=unpack_zip_dir, pv=pkg_version:
 637                                       os.path.join(u, pv, x),
 638                                src_files)
 639
 640         env.Command(unpack_zip_files, zip, unzipit)
 641
 642         #
 643         # Run setup.py in the unpacked subdirectory to "install" everything
 644         # into our build/test subdirectory.  The runtest.py script will set
 645         # PYTHONPATH so that the tests only look under build/test-{package},
 646         # and under etc (for the testing modules TestCmd.py, TestSCons.py,
 647         # and unittest.py).  This makes sure that our tests pass with what
 648         # we really packaged, not because of something hanging around in
 649         # the development directory.
 650         #
 651         # We can get away with calling setup.py using a directory path
 652         # like this because we put a preamble in it that will chdir()
 653         # to the directory in which setup.py exists.
 654         #
 655         dfiles = map(lambda x, d=test_zip_dir: os.path.join(d, x), dst_files)
 656         env.Command(dfiles, unpack_zip_files, [
 657             "rm -rf %s" % os.path.join(unpack_zip_dir, pkg_version, 'build'),
 658             "rm -rf $TEST_ZIP_DIR",
 659             "$PYTHON %s install --prefix=$TEST_ZIP_DIR" % \
 660                 os.path.join(unpack_zip_dir, pkg_version, 'setup.py'),
 661         ])
 662
 663     if rpmbuild:
 664         topdir = os.path.join(os.getcwd(), build, 'build',
 665                               'bdist.' + platform, 'rpm')
 666
 667         BUILDdir = os.path.join(topdir, 'BUILD', pkg + '-' + version)
 668         RPMSdir = os.path.join(topdir, 'RPMS', 'noarch')
 669         SOURCESdir = os.path.join(topdir, 'SOURCES')
 670         SPECSdir = os.path.join(topdir, 'SPECS')
 671         SRPMSdir = os.path.join(topdir, 'SRPMS')
 672
 673         specfile_in = os.path.join('rpm', "%s.spec.in" % pkg)
 674         specfile = os.path.join(SPECSdir, "%s-1.spec" % pkg_version)
 675         sourcefile = os.path.join(SOURCESdir, "%s.tar.gz" % pkg_version);
 676         noarch_rpm = os.path.join(RPMSdir, "%s-1.noarch.rpm" % pkg_version)
 677         src_rpm = os.path.join(SRPMSdir, "%s-1.src.rpm" % pkg_version)
 678
 679         def spec_function(target, source, env):
 680             """Generate the RPM .spec file from the template file.
 681
 682             This fills in the %files portion of the .spec file with a
 683             list generated from our MANIFEST(s), so we don't have to
 684             maintain multiple lists.
 685             """
 686             c = open(str(source[0]), 'rb').read()
 687             c = string.replace(c, '__RPM_FILES__', env['RPM_FILES'])
 688             open(str(target[0]), 'wb').write(c)
 689
 690         rpm_files.sort()
 691         rpm_files_str = string.join(rpm_files, "\n") + "\n"
 692         rpm_spec_env = env.Copy(RPM_FILES = rpm_files_str)
 693         rpm_spec_action = Action(spec_function, varlist=['RPM_FILES'])
 694         rpm_spec_env.Command(specfile, specfile_in, rpm_spec_action)
 695
 696         env.InstallAs(sourcefile, tar_gz)
 697
 698         targets = [ noarch_rpm, src_rpm ]
 699         cmd = "$RPMBUILD --define '_topdir $(%s$)' -ba $SOURCES" % topdir
 700         if not os.path.isdir(BUILDdir):
 701             cmd = ("$( mkdir -p %s; $)" % BUILDdir) + cmd
 702         env.Command(targets, specfile, cmd)
 703         env.Depends(targets, sourcefile)
 704
 705         install_targets.extend(targets)
 706
 707         dfiles = map(lambda x, d=test_rpm_dir: os.path.join(d, 'usr', x),
 708                      dst_files)
 709         env.Command(dfiles,
 710                     noarch_rpm,
 711                     "$RPM2CPIO $SOURCES | (cd $TEST_RPM_DIR && cpio -id)")
 712
 713     if dh_builddeb and fakeroot:
 714         # Our Debian packaging builds directly into build/dist,
 715         # so we don't need to add the .debs to install_targets.
 716         deb = os.path.join('build', 'dist', "%s_%s-1_all.deb" % (pkg, version))
 717         for d in p['debian_deps']:
 718             b = env.SCons_revision(os.path.join(build, d), d)
 719             env.Depends(deb, b)
 720             Local(b)
 721         env.Command(deb, build_src_files, [
 722             "cd %s && fakeroot make -f debian/rules PYTHON=$PYTHON BUILDDEB_OPTIONS=--destdir=../../build/dist binary" % build,
 723                     ])
 724
 725         old = os.path.join('lib', 'scons', '')
 726         new = os.path.join('lib', 'python2.1', 'site-packages', '')
 727         def xxx(s, old=old, new=new):
 728             if s[:len(old)] == old:
 729                 s = new + s[len(old):]
 730             return os.path.join('usr', s)
 731         dfiles = map(lambda x, t=test_deb_dir: os.path.join(t, x),
 732                      map(xxx, dst_files))
 733         env.Command(dfiles,
 734                     deb,
 735                     "dpkg --fsys-tarfile $SOURCES | (cd $TEST_DEB_DIR && tar -xf -)")
 736
 737
 738     #
 739     # Generate portage files for submission to Gentoo Linux.
 740     #
 741     gentoo = os.path.join('build', 'gentoo')
 742     ebuild = os.path.join(gentoo, 'scons-%s.ebuild' % version)
 743     digest = os.path.join(gentoo, 'files', 'digest-scons-%s' % version)
 744     env.Command(ebuild, os.path.join('gentoo', 'scons.ebuild.in'), SCons_revision)
 745     def Digestify(target, source, env):
 746         import md5
 747         def hexdigest(s):
 748             """Return a signature as a string of hex characters.
 749             """
 750             # NOTE:  This routine is a method in the Python 2.0 interface
 751             # of the native md5 module, but we want SCons to operate all
 752             # the way back to at least Python 1.5.2, which doesn't have it.
 753             h = string.hexdigits
 754             r = ''
 755             for c in s:
 756                 i = ord(c)
 757                 r = r + h[(i >> 4) & 0xF] + h[i & 0xF]
 758             return r
 759         src = source[0].rfile()
 760         contents = open(str(src)).read()
 761         sig = hexdigest(md5.new(contents).digest())
 762         bytes = os.stat(str(src))[6]
 763         open(str(target[0]), 'w').write("MD5 %s %s %d\n" % (sig,
 764                                                             src.name,
 765                                                             bytes))
 766     env.Command(digest, tar_gz, Digestify)
 767
 768     #
 769     # Use the Python distutils to generate the appropriate packages.
 770     #
 771     commands = [
 772         "rm -rf %s" % os.path.join(build, 'build', 'lib'),
 773         "rm -rf %s" % os.path.join(build, 'build', 'scripts'),
 774     ]
 775
 776     if distutils_formats:
 777         commands.append("rm -rf %s" % os.path.join(build,
 778                                                    'build',
 779                                                    'bdist.' + platform,
 780                                                    'dumb'))
 781         for format in distutils_formats:
 782             commands.append("$PYTHON $SETUP_PY bdist_dumb -f %s" % format)
 783
 784         commands.append("$PYTHON $SETUP_PY sdist --formats=%s" %  \
 785                             string.join(distutils_formats, ','))
 786
 787     commands.append("$PYTHON $SETUP_PY bdist_wininst")
 788
 789     env.Command(distutils_targets, build_src_files, commands)
 790
 791     #
 792     # Now create local packages for people who want to let people
 793     # build their SCons-buildable packages without having to
 794     # install SCons.
 795     #
 796     s_l_v = '%s-local-%s' % (pkg, version)
 797
 798     local = os.path.join('build', pkg + '-local')
 799     cwd_local = os.path.join(os.getcwd(), local)
 800     cwd_local_slv = os.path.join(os.getcwd(), local, s_l_v)
 801
 802     local_tar_gz = os.path.join('build', 'dist', "%s.tar.gz" % s_l_v)
 803     local_zip = os.path.join('build', 'dist', "%s.zip" % s_l_v)
 804
 805     commands = [
 806         "rm -rf %s" % local,
 807         "$PYTHON $SETUP_PY install --install-script=%s --install-lib=%s --no-compile" % \
 808                                                 (cwd_local, cwd_local_slv),
 809         "mv %s/scons %s/scons.py" % (local, local),
 810     ]
 811
 812     rf = filter(lambda x: x != "scons", raw_files)
 813     rf = map(lambda x, slv=s_l_v: os.path.join(slv, x), rf)
 814     rf.append("scons.py")
 815     local_targets = map(lambda x, s=local: os.path.join(s, x), rf)
 816
 817     env.Command(local_targets, build_src_files, commands)
 818
 819     scons_LICENSE = os.path.join(local, 'scons-LICENSE')
 820     env.SCons_revision(scons_LICENSE, 'LICENSE-local')
 821     local_targets.append(scons_LICENSE)
 822
 823     scons_README = os.path.join(local, 'scons-README')
 824     env.SCons_revision(scons_README, 'README-local')
 825     local_targets.append(scons_README)
 826
 827     if gzip:
 828         env.Command(local_tar_gz,
 829                     local_targets,
 830                     "cd %s && tar czf $( ${TARGET.abspath} $) *" % local)
 831
 832         unpack_targets = map(lambda x, d=test_local_tar_gz_dir:
 833                                     os.path.join(d, x),
 834                              rf)
 835         commands = ["rm -rf %s" % test_local_tar_gz_dir,
 836                     "mkdir %s" % test_local_tar_gz_dir,
 837                     "cd %s && tar xzf $( ${SOURCE.abspath} $)" % test_local_tar_gz_dir]
 838
 839         env.Command(unpack_targets, local_tar_gz, commands)
 840
 841     if zipit:
 842         zipenv = env.Copy(CD = local, PSV = '.')
 843         zipenv.Command(local_zip, local_targets, zipit)
 844
 845         unpack_targets = map(lambda x, d=test_local_zip_dir:
 846                                     os.path.join(d, x),
 847                              rf)
 848         commands = ["rm -rf %s" % test_local_zip_dir,
 849                     "mkdir %s" % test_local_zip_dir,
 850                     unzipit]
 851
 852         zipenv = env.Copy(UNPACK_ZIP_DIR = test_local_zip_dir)
 853         zipenv.Command(unpack_targets, local_zip, unzipit)
 854
 855     #
 856     # And, lastly, install the appropriate packages in the
 857     # appropriate subdirectory.
 858     #
 859     b_d_files = env.Install(os.path.join('build', 'dist'), install_targets)
 860     Local(b_d_files)
 861
 862 #
 863 #
 864 #
 865 Export('env')
 866
 867 SConscript('etc/SConscript')
 868
 869 #
 870 # Documentation.
 871 #
 872 BuildDir('build/doc', 'doc')
 873
 874 Export('env', 'whereis')
 875
 876 SConscript('build/doc/SConscript')
 877
 878 #
 879 # If we're running in the actual Aegis project, pack up a complete
 880 # source archive from the project files and files in the change,
 881 # so we can share it with helpful developers who don't use Aegis.
 882 #
 883
 884 if change:
 885     df = []
 886     cmd = "aegis -list -unf -c %s cf 2>/dev/null" % change
 887     for line in map(lambda x: x[:-1], os.popen(cmd, "r").readlines()):
 888         a = string.split(line)
 889         if a[1] == "remove":
 890             df.append(a[-1])
 891
 892     cmd = "aegis -list -terse pf 2>/dev/null"
 893     pf = map(lambda x: x[:-1], os.popen(cmd, "r").readlines())
 894     cmd = "aegis -list -terse cf 2>/dev/null"
 895     cf = map(lambda x: x[:-1], os.popen(cmd, "r").readlines())
 896     u = {}
 897     for f in pf + cf:
 898         u[f] = 1
 899     for f in df:
 900         try:
 901             del u[f]
 902         except KeyError:
 903             pass
 904     sfiles = filter(lambda x: x[-9:] != '.aeignore' and x[-9:] != '.sconsign',
 905                     u.keys())
 906
 907     if sfiles:
 908         ps = "%s-src" % project
 909         psv = "%s-%s" % (ps, version)
 910         b_ps = os.path.join('build', ps)
 911         b_psv = os.path.join('build', psv)
 912         b_psv_stamp = b_psv + '-stamp'
 913
 914         src_tar_gz = os.path.join('build', 'dist', '%s.tar.gz' % psv)
 915         src_zip = os.path.join('build', 'dist', '%s.zip' % psv)
 916
 917         Local(src_tar_gz, src_zip)
 918
 919         for file in sfiles:
 920             env.SCons_revision(os.path.join(b_ps, file), file)
 921
 922         b_ps_files = map(lambda x, d=b_ps: os.path.join(d, x), sfiles)
 923         cmds = [
 924             "rm -rf %s" % b_psv,
 925             "cp -rp %s %s" % (b_ps, b_psv),
 926             "find %s -name .sconsign -exec rm {} \\;" % b_psv,
 927             "touch $TARGET",
 928         ]
 929
 930         env.Command(b_psv_stamp, src_deps + b_ps_files, cmds)
 931
 932         apply(Local, b_ps_files, {})
 933
 934         if gzip:
 935
 936             env.Command(src_tar_gz, b_psv_stamp,
 937                         "tar cz${TAR_HFLAG} -f $TARGET -C build %s" % psv)
 938
 939             #
 940             # Unpack the archive into build/unpack/scons-{version}.
 941             #
 942             unpack_tar_gz_files = map(lambda x, u=unpack_tar_gz_dir, psv=psv:
 943                                              os.path.join(u, psv, x),
 944                                       sfiles)
 945
 946             #
 947             # We'd like to replace the last three lines with the following:
 948             #
 949             #   tar zxf $SOURCES -C $UNPACK_TAR_GZ_DIR
 950             #
 951             # but that gives heartburn to Cygwin's tar, so work around it
 952             # with separate zcat-tar-rm commands.
 953             env.Command(unpack_tar_gz_files, src_tar_gz, [
 954                 "rm -rf %s" % os.path.join(unpack_tar_gz_dir, psv),
 955                 "$ZCAT $SOURCES > .temp",
 956                 "tar xf .temp -C $UNPACK_TAR_GZ_DIR",
 957                 "rm -f .temp",
 958             ])
 959
 960             #
 961             # Run setup.py in the unpacked subdirectory to "install" everything
 962             # into our build/test subdirectory.  The runtest.py script will set
 963             # PYTHONPATH so that the tests only look under build/test-{package},
 964             # and under etc (for the testing modules TestCmd.py, TestSCons.py,
 965             # and unittest.py).  This makes sure that our tests pass with what
 966             # we really packaged, not because of something hanging around in
 967             # the development directory.
 968             #
 969             # We can get away with calling setup.py using a directory path
 970             # like this because we put a preamble in it that will chdir()
 971             # to the directory in which setup.py exists.
 972             #
 973             dfiles = map(lambda x, d=test_src_tar_gz_dir: os.path.join(d, x),
 974                             dst_files)
 975             ENV = env.Dictionary('ENV')
 976             ENV['SCONS_LIB_DIR'] = os.path.join(unpack_tar_gz_dir, psv, 'src', 'engine')
 977             ENV['USERNAME'] = developer
 978             env.Copy(ENV = ENV).Command(dfiles, unpack_tar_gz_files, [
 979                 "rm -rf %s" % os.path.join(unpack_tar_gz_dir,
 980                                            psv,
 981                                            'build',
 982                                            'scons',
 983                                            'build'),
 984                 "rm -rf $TEST_SRC_TAR_GZ_DIR",
 985                 "cd %s && $PYTHON %s %s" % \
 986                     (os.path.join(unpack_tar_gz_dir, psv),
 987                      os.path.join('src', 'script', 'scons.py'),
 988                      os.path.join('build', 'scons')),
 989                 "$PYTHON %s install --prefix=$TEST_SRC_TAR_GZ_DIR" % \
 990                     os.path.join(unpack_tar_gz_dir,
 991                                  psv,
 992                                  'build',
 993                                  'scons',
 994                                  'setup.py'),
 995             ])
 996
 997         if zipit:
 998
 999             zipenv = env.Copy(CD = 'build', PSV = psv)
1000             zipenv.Command(src_zip, b_psv_stamp, zipit)
1001
1002             #
1003             # Unpack the archive into build/unpack/scons-{version}.
1004             #
1005             unpack_zip_files = map(lambda x, u=unpack_zip_dir, psv=psv:
1006                                              os.path.join(u, psv, x),
1007                                       sfiles)
1008
1009             env.Command(unpack_zip_files, src_zip, unzipit)
1010
1011             #
1012             # Run setup.py in the unpacked subdirectory to "install" everything
1013             # into our build/test subdirectory.  The runtest.py script will set
1014             # PYTHONPATH so that the tests only look under build/test-{package},
1015             # and under etc (for the testing modules TestCmd.py, TestSCons.py,
1016             # and unittest.py).  This makes sure that our tests pass with what
1017             # we really packaged, not because of something hanging around in
1018             # the development directory.
1019             #
1020             # We can get away with calling setup.py using a directory path
1021             # like this because we put a preamble in it that will chdir()
1022             # to the directory in which setup.py exists.
1023             #
1024             dfiles = map(lambda x, d=test_src_zip_dir: os.path.join(d, x),
1025                             dst_files)
1026             ENV = env.Dictionary('ENV')
1027             ENV['SCONS_LIB_DIR'] = os.path.join(unpack_zip_dir, psv, 'src', 'engine')
1028             ENV['USERNAME'] = developer
1029             env.Copy(ENV = ENV).Command(dfiles, unpack_zip_files, [
1030                 "rm -rf %s" % os.path.join(unpack_zip_dir,
1031                                            psv,
1032                                            'build',
1033                                            'scons',
1034                                            'build'),
1035                 "rm -rf $TEST_SRC_ZIP_DIR",
1036                 "cd %s && $PYTHON %s %s" % \
1037                     (os.path.join(unpack_zip_dir, psv),
1038                      os.path.join('src', 'script', 'scons.py'),
1039                      os.path.join('build', 'scons')),
1040                 "$PYTHON %s install --prefix=$TEST_SRC_ZIP_DIR" % \
1041                     os.path.join(unpack_zip_dir,
1042                                  psv,
1043                                  'build',
1044                                  'scons',
1045                                  'setup.py'),
1046             ])