[Chromoting] Update installer archive to check file extensions in one location.

remoting/host/installer/build-installer-archive.py

 #!/usr/bin/env python
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Creates a zip archive for the Chrome Remote Desktop Host installer.
 
 This script builds a zip file that contains all the files needed to build an
 installer for Chrome Remote Desktop Host.
 
@@ skipping 53 matching lines @@
   zipfile_base = os.path.splitext(os.path.basename(zip_path))[0]
   zip = zipfile.ZipFile(zip_path, 'w', zipfile.ZIP_DEFLATED)
   for (root, dirs, files) in os.walk(directory):
     for f in files:
       full_path = os.path.join(root, f)
       rel_path = os.path.relpath(full_path, directory)
       zip.write(full_path, os.path.join(zipfile_base, rel_path))
   zip.close()
 
 
-def copyFileIntoArchive(src_file, out_dir, files_root, dst_file, defs):
-  """Copies the src_file into the out_dir, preserving the directory structure.
+def calcDestFilePath(out_dir, files_root, dst_file):
+  """Calculates destination file path and creates directory.

[alexeypa (please no reviews), 2012/04/30 16:33:48]

nit: This sounds like a perforce mapping. Basically it replaces one path prefix
with another, so you can rename |out_dir| -> |dst_root|, |files_root| ->
|src_root|

[garykac, 2012/04/30 21:24:39]

Done.

+
+  The |files_root| prefix is stripped from |dst_file| before

[alexeypa (please no reviews), 2012/04/30 16:33:48]

What happens if the file name does not start from  |files_root|? Should it be an
error condition?

[garykac, 2012/04/30 21:24:39]

No. I have a pending cl where I'll be expanding this to allow multiple src_roots
because the src files live in different directories.

+  appending to |out_dir|.
+
+  For example, given:
+    out_dir = /output
+    files_root = host/installer/mac
+    dst_file = host/installer/mac/Scripts/keystone_install.sh
+  The final calculated path is:
+    /output/Scripts/keystone_install.sh
 
   Args:
-    src_file: Full or relative path to source file to copy.
     out_dir: Target directory where files are copied.
     files_root: Path prefix which is stripped of dst_file before appending
                 it to the out_dir.
     dst_file: Relative path (and filename) where src_file should be copied.
-    defs: Dictionary of variable definitions.
+  Returns:
+    Full path to destination file in |out_dir|.
   """
-  root_len = len(files_root)
-  local_file_path = dst_file[root_len:]
-  full_dst_file = os.path.join(out_dir, local_file_path)
-  dst_dir = os.path.dirname(full_dst_file)
+  # Strip of directory prefix.
+  if dst_file.startswith(files_root):
+    dst_file = dst_file[len(files_root):]
+  dst_file = os.path.join(out_dir, dst_file)
+  # Make sure target directory exists.
+  dst_dir = os.path.dirname(dst_file)
   if not os.path.exists(dst_dir):
     os.makedirs(dst_dir, 0775)
-
-  (base, ext) = os.path.splitext(src_file)
-  if ext == '.app':
-    shutil.copytree(src_file, full_dst_file)
-  elif ext in ['.sh', '.packproj', '.plist']:
-    copyFileWithDefs(src_file, full_dst_file, defs)
-  else:
-    shutil.copy2(src_file, full_dst_file)
+  return dst_file
 
 
 def copyFileWithDefs(src_file, dst_file, defs):
   """Copies from src_file to dst_file, performing variable substitution.
 
-  Any @@variables@@ in the source are replaced with
-  file with the out_dir, preserving the directory structure.
+  Any @@VARIABLE@@ in the source is replaced with the value of VARIABLE
+  in the |defs| dictionary when written to the destination file.
 
   Args:
     src_file: Full or relative path to source file to copy.
     dst_file: Relative path (and filename) where src_file should be copied.
     defs: Dictionary of variable definitions.
   """
   data = open(src_file, 'r').read()
   for key, val in defs.iteritems():
     try:
       data = data.replace('@@' + key + '@@', val)
@@ skipping 15 matching lines @@
   base_zip_name = os.path.basename(zip_file)
 
   # We don't use the 'zipfile' module here because it doesn't restore all the
   # file permissions correctly. We use the 'unzip' command manually.
   old_dir = os.getcwd();
   os.chdir(os.path.dirname(zip_file))
   subprocess.call(['unzip', '-qq', '-o', base_zip_name])
   os.chdir(old_dir)
 
   # Unzip into correct dir in out_dir.
-  root_len = len(files_root)
-  relative_zip_path = zip_file[root_len:]
-  out_zip_path = os.path.join(out_dir, relative_zip_path)
+  out_zip_path = calcDestFilePath(out_dir, files_root, zip_file)
   out_zip_dir = os.path.dirname(out_zip_path)
 
   (src_dir, ignore1) = os.path.splitext(zip_file)
   (base_dir_name, ignore2) = os.path.splitext(base_zip_name)
   shutil.copytree(src_dir, os.path.join(out_zip_dir, base_dir_name))
 
 
 def buildHostArchive(temp_dir, zip_path, source_files_root, source_files,
                      gen_files, gen_files_dst, defs):
   """Builds a zip archive with the files needed to build the installer.
 
   Args:
     temp_dir: Temporary dir used to build up the contents for the archive.
     zip_path: Full path to the zip file to create.
     source_files_root: Path prefix to strip off |files| when adding to archive.
     source_files: The array of files to add to archive. The path structure is
                   preserved (except for the |files_root| prefix).
     gen_files: Full path to binaries to add to archive.
     gen_files_dst: Relative path of where to add binary files in archive.
                    This array needs to parallel |binaries_src|.
     defs: Dictionary of variable definitions.
   """
   cleanDir(temp_dir)
 
-  for file in source_files:
-    base_file = os.path.basename(file)
-    (base, ext) = os.path.splitext(file)
+  for f in source_files:
+    dst_file = calcDestFilePath(temp_dir, source_files_root, f)
+    base_file = os.path.basename(f)
+    (base, ext) = os.path.splitext(f)
     if ext == '.zip':
-      copyZipIntoArchive(temp_dir, source_files_root, file)
+      copyZipIntoArchive(temp_dir, source_files_root, f)
+    elif ext in ['.sh', '.packproj', '.plist']:
+      copyFileWithDefs(f, dst_file, defs)
     else:
-      copyFileIntoArchive(file, temp_dir, source_files_root, file, defs)
+      shutil.copy2(src_file, dst_file)
 
   for bs, bd in zip(gen_files, gen_files_dst):
-    copyFileIntoArchive(bs, temp_dir, '', bd, {})
+    dst_file = calcDestFilePath(temp_dir, source_files_root, bd)
+    (base, ext) = os.path.splitext(bd)
+    if ext in ['.app', '.prefPane']:

[alexeypa (please no reviews), 2012/04/30 16:33:48]

nit: Maybe a better test would be checking if the source is a directory.

[garykac, 2012/04/30 21:24:39]

Done.

+      shutil.copytree(bs, dst_file)
+    else:
+      shutil.copy2(bs, dst_file)
 
   createZip(zip_path, temp_dir)
 
 
 def error(msg):
   sys.stderr.write('ERROR: %s' % msg)
   sys.exit(1)
 
+
 def usage():
   """Display basic usage information."""
   print ('Usage: %s\n'
          '  <temp-dir> <zip-path> <files-root-dir>\n'
          '  --source-files <list of source files...>\n'
          '  --generated-files <list of generated target files...>\n'
          '  --generated-files-dst <dst for each generated file...>\n'
          '  --defs <list of VARIABLE=value definitions...>'
          ) % sys.argv[0]
 
@@ skipping 50 matching lines @@
 
   result = buildHostArchive(temp_dir, zip_path, source_files_root,
                             source_files, generated_files, generated_files_dst,
                             defs)
 
   return 0
 
 
 if __name__ == '__main__':
   sys.exit(main())