Address additional comments to tarball creation script

tools/create_tarball.py

Index: tools/create_tarball.py
diff --git a/tools/create_tarball.py b/tools/create_tarball.py
index 97e1bcb72b1cbafd11bfe506a6d923d844fc4cb2..4c7b5b7aff858ec1536baa6ba6947f1c99a348e6 100755
--- a/tools/create_tarball.py
+++ b/tools/create_tarball.py
@@ -13,8 +13,8 @@
 # directory. This makes it easy to build Debian packages from the
 # tarball.
 #
-# For building a Debian package renaming the tarball to follow the
-# Debian is needed.
+# For building a Debian package one need to the tarball to follow the
+# Debian naming rules upstream tar files.
 #
 #  $ mv dart-XXX.tar.gz dart_XXX.orig.tar.gz
 #  $ tar xf dart_XXX.orig.tar.gz
@@ -25,13 +25,14 @@ import datetime
 import optparse
 import sys
 import tarfile
-import tempfile
 import utils
 
-from os import listdir, makedirs, remove, rmdir
-from os.path import basename, dirname, join, realpath, exists, isdir, split
+from os import listdir, makedirs
+from os.path import join, exists, split, dirname, realpath
 
 HOST_OS = utils.GuessOS()
+SCRIPT_DIR = dirname(sys.argv[0])
+DART_ROOT = realpath(join(SCRIPT_DIR, '..'))

[kustermann, 2014/02/07 10:10:14]

We usually do it like this (see e.g. tools/utils.py), it's a bit cleaner and
less error prone (e.g. if this file is not called directly but rather imported
by another python script):

DART_DIR = os.path.abspath(os.path.join(__file__, '..', '..'))

[Søren Gjesse, 2014/02/07 12:02:51]

Done (build.py still uses the other pattern)

 
 # TODO (16582): Remove this when the LICENSE file becomes part of
 # all checkouts.
@@ -96,7 +97,7 @@ verbose = False
 versiondir = ''
 
 # Ignore Git/SVN files, checked-in binaries, backup files, etc..
-ignoredPaths = ['out', 'tools/testing/bin'
+ignoredPaths = ['tools/testing/bin'
                 'third_party/7zip', 'third_party/android_tools',
                 'third_party/clang', 'third_party/d8',
                 'third_party/firefox_jsshell']
@@ -111,21 +112,22 @@ def BuildOptions():
   return result
 
 def Filter(tar_info):
-  _, tail = split(tar_info.name)
+  # Get the name of the file relative to the dart root directory.
+  original_name = tar_info.name[len(DART_ROOT):]

[kustermann, 2014/02/07 10:10:14]

Add an assert before that:

  assert tar_info.name.startswith(DART_ROOT)

[Søren Gjesse, 2014/02/07 12:02:51]

Done.

+  _, tail = split(original_name)
   if tail in ignoredDirs:
     return None
   for path in ignoredPaths:
-    if tar_info.name.startswith(path):
+    if original_name.startswith(path):
       return None
   for ending in ignoredEndings:
-    if tar_info.name.endswith(ending):
+    if original_name.endswith(ending):
       return None
-  # Add the dart directory name with version.
-  original_name = tar_info.name
-  # Place the debian directory one level over the rest which are
-  # placed in the directory 'dart'. This enables building the Debian
-  # packages out-of-the-box.
-  tar_info.name = join(versiondir, 'dart', tar_info.name)
+  # Add the dart directory name with version. Place the debian
+  # directory one level over the rest which are placed in the
+  # directory 'dart'. This enables building the Debian packages
+  # out-of-the-box.
+  tar_info.name = join(versiondir, 'dart', original_name)
   if verbose:
     print 'Adding %s as %s' % (original_name, tar_info.name)
   return tar_info
@@ -133,57 +135,56 @@ def Filter(tar_info):
 def GenerateCopyright(filename):
   license_lines = license
   try:
-    # Currently the LICENSE file is part of a svn-root checkout.
-    lf = open('../LICENSE', 'r')
-    license_lines = lf.read().splitlines()
-    print license_lines
-    lf.close()
+    # TODO (16582): The LICENSE file is currently not in a normal the
+    # dart checkout.
+    with open(join(DART_ROOT, 'LICENSE')) as lf:
+      license_lines = lf.read().splitlines()
   except:
     pass
 
-  f = open(filename, 'w')
-  f.write('Name: dart\n')
-  f.write('Maintainer: Dart Team <misc@dartlang.org>\n')
-  f.write('Source: https://code.google.com/p/dart/\n')
-  f.write('License:\n')
-  for line in license_lines:
-    f.write(' %s\n' % line)
-  f.close()
+  with open(filename, 'w') as f:
+    f.write('Name: dart\n')
+    f.write('Maintainer: Dart Team <misc@dartlang.org>\n')
+    f.write('Source: https://code.google.com/p/dart/\n')
+    f.write('License:\n')
+    for line in license_lines:
+      f.write(' %s\n' % line)
 
 def GenerateChangeLog(filename, version):
-  f = open(filename, 'w')
-  f.write('dart (%s-1) UNRELEASED; urgency=low\n' % version)
-  f.write('\n')
-  f.write('  * Generated file.\n')
-  f.write('\n')
-  f.write(' -- Dart Team <misc@dartlang.org>  %s\n' %
-          datetime.datetime.utcnow().strftime('%a, %d %b %Y %X +0000'))
-  f.close()
+  with open(filename, 'w') as f:
+    f.write('dart (%s-1) UNRELEASED; urgency=low\n' % version)
+    f.write('\n')
+    f.write('  * Generated file.\n')
+    f.write('\n')
+    f.write(' -- Dart Team <misc@dartlang.org>  %s\n' %
+            datetime.datetime.utcnow().strftime('%a, %d %b %Y %X +0000'))
 
 def GenerateSvnRevision(filename, svn_revision):
-  f = open(filename, 'w')
-  f.write(svn_revision)
-  f.close()
+  with open(filename, 'w') as f:
+    f.write(svn_revision)
 
 
 def CreateTarball():
+  global ignoredPaths  # Used for adding the output directory.
   # Generate the name of the tarfile
   version = utils.GetVersion()
   global versiondir
   versiondir = 'dart-%s' % version
   tarname = '%s.tar.gz' % versiondir
   debian_dir = 'tools/linux_dist_support/debian'
-  # Create the tar file in the out directory.
-  tardir = utils.GetBuildDir(HOST_OS, HOST_OS)
+  # Create the tar file in the build directory.
+  tardir = join(DART_ROOT, utils.GetBuildDir(HOST_OS, HOST_OS))
+  # Don't include the build directory in the tarball.
+  ignoredPaths.append(tardir)
   if not exists(tardir):
     makedirs(tardir)
   tarfilename = join(tardir, tarname)
-  print 'Creating tarball: %s' % (tarfilename)
+  print 'Creating tarball: %s' % tarfilename
   with tarfile.open(tarfilename, mode='w:gz') as tar:
-    for f in listdir('.'):
-      tar.add(f, filter=Filter)
-    for f in listdir(debian_dir):
-      tar.add(join(debian_dir, f),
+    for f in listdir(DART_ROOT):
+      tar.add(join(DART_ROOT, f), filter=Filter)
+    for f in listdir(join(DART_ROOT, debian_dir)):
+      tar.add(join(DART_ROOT, debian_dir, f),
               arcname='%s/debian/%s' % (versiondir, f))
 
     with utils.TempDir() as temp_dir: