[VS Addin] Add visual studio 2012 support

visual_studio/NativeClientVSAddIn/create_package.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.
 
 """Takes the output of the build step and turns it into a compressed
 archive ready for distribution.
 
 This script assumes the build script has been run to compile the add-in.
 It zips up all files required for the add-in installation and places the
 result in out/vs_addin/vs_addin.tgz.
 """
 
 import os
 import re
 import fileinput
 import win32api
 import shutil
 import tarfile
 import zipfile
+import string
 import sys
 from os.path import join
 
 SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__))
 
 # Checkout root
 ROOT = os.path.dirname(os.path.dirname(SCRIPT_DIR))
 
 # Root output directory.
 BUILD_DIR = join(ROOT, 'out', 'vs_addin')
 
 # Directory that contains the build assemblies.
-ASSEMBLY_DIRECTORY = join(BUILD_DIR, 'Debug')
+ASSEMBLY_DIRECTORY_2010 = join(BUILD_DIR, '2010', 'Debug')
+ASSEMBLY_DIRECTORY_2012 = join(BUILD_DIR, '2012', 'Debug')
 
 # Directory containing static installer resources.
 RESOURCE_DIRECTORY = join(SCRIPT_DIR, 'InstallerResources')
 
 # Base name of the final zip file.
 OUTPUT_NAME = join(BUILD_DIR, 'vs_addin.tgz')
 
 # AddIn metadata file path. We will modify this with the version #.
 ADDIN_METADATA = join(RESOURCE_DIRECTORY, 'NativeClientVSAddIn.AddIn')
 
 # AddIn dll file path. We will obtain our add-in version from this.
-ADDIN_ASSEMBLY = join(ASSEMBLY_DIRECTORY, 'NativeClientVSAddIn.dll')
+ADDIN_ASSEMBLY_2010 = join(ASSEMBLY_DIRECTORY_2010, 'NativeClientVSAddIn.dll')
+ADDIN_ASSEMBLY_2012 = join(ASSEMBLY_DIRECTORY_2012, 'NativeClientVSAddIn.dll')
 
 # Regex list to exclude from the archive. If a file path matches any of the
 # expressions during a call to AddFolderToArchive it is excluded from the
 # archive file.
 EXCLUDES = [
-    r'\.svn', # Exclude .svn directories.
-    r'\.swp', # Exclude .swp files.
+    r'\.svn$', # Exclude .svn directories.

[binji, 2013/05/25 00:02:55]

it seems like this was correct before -- shouldn't it ignore all children of
.svn directories?

[Sam Clegg, 2013/05/29 04:58:33]

Hmm yes I think you are right.

+    r'\.swp$', # Exclude .swp files.
+    r'\.pyc$', # Exclude .pyc files.
     r'examples\\.*\\chrome_data',
     r'examples\\.*\\Debug',
     r'examples\\.*\\newlib',
     r'examples\\.*\\glibc',
     r'examples\\.*\\PNaCl',
     r'examples\\.*\\win',
     r'examples\\.*\\ipch',
     r'examples\\.*\\*.sdf',
     r'examples\\.*\\*.suo',
     # Exclude .AddIn file for now since we need to modify it with version info.
     re.escape(ADDIN_METADATA)]
 
 # List of source/destination pairs to include in archive file.
 FILE_LIST = [
-  (ADDIN_ASSEMBLY, ''),
-  (join(ASSEMBLY_DIRECTORY, 'NaCl.Build.CPPTasks.dll'), 'NaCl')]
+  (ADDIN_ASSEMBLY_2010, '2010'),
+  (ADDIN_ASSEMBLY_2012, '2012'),
+  (join(ASSEMBLY_DIRECTORY_2010, 'NativeClientVSAddIn.AddIn'), '2010'),
+  (join(ASSEMBLY_DIRECTORY_2012, 'NativeClientVSAddIn.AddIn'), '2012'),
+  (join(ASSEMBLY_DIRECTORY_2010, 'NaCl.Build.CPPTasks.dll'), 'NaCl')]
 
 
 def AddFolderToArchive(path, archive, root=""):
   """Adds an entire folder and sub folders to an open archive object.
 
   The archive must already be open and it is not closed by this function.
 
   Args:
     path: Folder to add.
     archive: Already open archive file.
 
   Returns:
     Nothing.
   """
   # Ensure the path ends in trailing slash.
   path = path.rstrip("/\\") + "\\"
   for dir_path, dir_names, files in os.walk(path):
     for filename in files:
       read_path = join(dir_path, filename)
 
       # If the file path matches an exclude, don't include it.
       if any(re.search(expr, read_path) for expr in EXCLUDES):
         continue
 
       zip_based_dir = dir_path[len(path):]
       write_path = join(root, zip_based_dir, filename)
       WriteFileToArchive(archive, read_path, write_path)
 
 
-def AddVersionModifiedAddinFile(archive):
+def CopyAddinFile(assembly, path, vs_version):
   """Modifies the .AddIn file with the build version and adds to the zip.
 
   The version number is obtained from the NativeClientAddIn.dll assembly which
   is built during the build process.
-
-  Args:
-  archive: Already open archive file.
   """
-  path = '\\VarFileInfo\\Translation'
-  pairs = win32api.GetFileVersionInfo(ADDIN_ASSEMBLY, path)
+  infopath = '\\VarFileInfo\\Translation'
+  pairs = win32api.GetFileVersionInfo(assembly, infopath)
   lang, codepage = pairs[0]
-  path = u'\\StringFileInfo\\%04X%04X\\ProductVersion' % (lang, codepage)
-  prodVersion = win32api.GetFileVersionInfo(ADDIN_ASSEMBLY, path)
+  infopath = u'\\StringFileInfo\\%04X%04X\\ProductVersion' % (lang, codepage)
+  prodVersion = win32api.GetFileVersionInfo(assembly, infopath)
   version = "[%s]" % prodVersion
   print "\nNaCl VS Add-in Build version: %s\n" % (version)
 
   metadata_filename = os.path.basename(ADDIN_METADATA)
-  modified_file = join(ASSEMBLY_DIRECTORY, metadata_filename)
+  modified_file = join(path, metadata_filename)
 
   # Copy the metadata file to new location and modify the version info.
   with open(ADDIN_METADATA, 'r') as source_file:
     with open(modified_file, 'w') as dest_file:
-      for line in source_file:
-        dest_file.write(line.replace("[REPLACE_ADDIN_VERSION]", version))
-
-  WriteFileToArchive(archive, modified_file, metadata_filename)

[binji, 2013/05/25 00:02:55]

not added to archive...?

[Sam Clegg, 2013/05/29 04:58:33]

This is now done by including them in FILE_LIST.

I will update the docs for this function.

+      data = source_file.read()
+      replacements = {'VS_VERSION': vs_version, 'ADDIN_VERSION': version}
+      data = string.Template(data).substitute(replacements)
+      dest_file.write(data)
 
 
 def Error(msg):
   sys.stderr.write(msg + '\n')
   sys.exit(1)
 
 
 def WriteFileToArchive(archive, filename, archive_name):
   archive_name = join('vs_addin', archive_name)
   if archive_name.replace('\\', '/') in archive.getnames():
     print 'Skipping: %s' % archive_name
     return
   print 'Adding: %s' % archive_name
   archive.add(filename, archive_name)
 
 
 def CopyWithReplacement(src, dest, replacements):
   if os.path.exists(dest):
     shutil.rmtree(dest)
   os.makedirs(dest)
   src_basename = os.path.basename(src)
   dest_basename = os.path.basename(dest)
-  for filename in os.listdir(src):
-    srcfile = join(src, filename)
-    # skip non-files, in particular .svn folders.
-    if not os.path.isfile(srcfile):
-      continue
-    destfile = join(dest, filename.replace(src_basename, dest_basename))
-    with open(srcfile, "rb") as f:
-      data = f.read()
-      for pat, subst in replacements.iteritems():
-        data = data.replace(pat, subst)
-    with open(destfile, "wb") as f:
-      f.write(data)
+
+  olddir = os.getcwd()
+  try:
+    os.chdir(src)

[binji, 2013/05/25 00:02:55]

why chdir?

[Sam Clegg, 2013/05/29 04:58:33]

So that 'root' below is relative to 'src'.

Alternatively I would have trimmed src from the start of root but doing that is
also a little messy.

+    for root, dirs, filenames in os.walk('.'):
+      for filename in filenames:
+        srcfile = join(root, filename)
+        # skip non-files, in particular .svn folders.
+        if not os.path.isfile(srcfile):
+          continue
+
+        destdir = join(dest, root.replace(src_basename, dest_basename))
+        if not os.path.exists(destdir):
+          os.makedirs(destdir)
+
+        destfile = join(destdir, filename.replace(src_basename, dest_basename))
+        with open(srcfile, "rb") as f:
+          data = f.read()
+          for pat, subst in replacements.iteritems():
+            data = data.replace(pat, subst)
+        with open(destfile, "wb") as f:
+          f.write(data)
+  finally:
+    os.chdir(olddir)
 
 
 def main():
   if not os.path.exists(BUILD_DIR):
     Error("build dir not found: %s" % BUILD_DIR)
 
+  CopyAddinFile(ADDIN_ASSEMBLY_2010, ASSEMBLY_DIRECTORY_2010, '10.0')
+  CopyAddinFile(ADDIN_ASSEMBLY_2012, ASSEMBLY_DIRECTORY_2012, '11.0')
+
   archive = tarfile.open(OUTPUT_NAME, 'w:gz')
+
   for source_dest in FILE_LIST:
     file_name = os.path.basename(source_dest[0])
     dest = join(source_dest[1], file_name)
     WriteFileToArchive(archive, source_dest[0], dest)
 
   AddFolderToArchive(RESOURCE_DIRECTORY, archive)
 
   # Duplicate the NaCl64 platform but rename it to NaCl32
   src = join(RESOURCE_DIRECTORY, 'NaCl64')
 
@@ skipping 20 matching lines @@
       '64': '32',
       '.nexe': '.pexe',
       'nacl_link.xml': 'pnacl_link.xml',
       '$(ProjectName)_$(PlatformArchitecture)': '$(ProjectName)',
   }
 
   dest = join(BUILD_DIR, 'PNaCl')
   CopyWithReplacement(src, dest, pnacl_replacements)
   AddFolderToArchive(dest, archive, "PNaCl")
 
-  AddVersionModifiedAddinFile(archive)
   archive.close()
 
 
 if __name__ == '__main__':
   main()