Added support for enabling GCD, or not, at build time.

remoting/webapp/build-webapp.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 directory with with the unpacked contents of the remoting webapp.
 
 The directory will contain a copy-of or a link-to to all remoting webapp
 resources.  This includes HTML/JS and any plugin binaries. The script also
 massages resulting files appropriately with host plugin data. Finally,
 a zip archive for all of the above is produced.
 """
 
 # Python 2.5 compatibility
 from __future__ import with_statement
 
+import argparse
 import io
 import os
 import platform
 import re
 import shutil
 import subprocess
 import sys
 import time
 import zipfile
 
@@ skipping 28 matching lines @@
       rel_path = os.path.relpath(full_path, directory)
       zip.write(full_path, os.path.join(zipfile_base, rel_path))
   zip.close()
 
 
 def replaceString(destination, placeholder, value):
   findAndReplace(os.path.join(destination, 'plugin_settings.js'),
                  "'" + placeholder + "'", "'" + value + "'")
 
 
+def replaceBool(destination, placeholder, value):
+  findAndReplace(os.path.join(destination, 'plugin_settings.js'),
+                 "!!'" + placeholder + "'", 'true' if value else 'false')

[Sergey Ulanov, 2015/03/25 18:56:43]

Why do you need !! here?

[John Williams, 2015/03/25 20:32:19]

The JS code is typechecked before being processed by this script, so the value
being replaced has to be boolean.

[Sergey Ulanov, 2015/03/25 20:50:50]

Right, but type is explicitly specified there anyway, so I'm not sure it's
necessary. Anyway, XMPP_SERVER_USE_TLS flag is also boolean and it's replaced
differently. It's better to make them consistent, i.e. use replaceBool() for it
too.

[John Williams, 2015/03/25 22:54:51]

Done.

+
+
 def processJinjaTemplate(input_file, include_paths, output_file, context):
   jinja2_path = os.path.normpath(
       os.path.join(os.path.abspath(__file__),
                    '../../../third_party/jinja2'))
   sys.path.append(os.path.split(jinja2_path)[0])
   import jinja2
   (template_path, template_name) = os.path.split(input_file)
   include_paths = [template_path] + include_paths
   env = jinja2.Environment(loader=jinja2.FileSystemLoader(include_paths))
   template = env.get_template(template_name)
   rendered = template.render(context)
   io.open(output_file, 'w', encoding='utf-8').write(rendered)
 
 def buildWebApp(buildtype, version, destination, zip_path,
-                manifest_template, webapp_type, app_id, app_name,
-                app_description, app_capabilities, files, locales, jinja_paths,
-                service_environment):
+                manifest_template, webapp_type, appid, app_name,
+                app_description, app_capabilities, files, locales_listfile,
+                jinja_paths, service_environment, use_gcd):
   """Does the main work of building the webapp directory and zipfile.
 
   Args:
     buildtype: the type of build ("Official", "Release" or "Dev").
     destination: A string with path to directory where the webapp will be
                  written.
     zipfile: A string with path to the zipfile to create containing the
              contents of |destination|.
     manifest_template: jinja2 template file for manifest.
     webapp_type: webapp type ("v1", "v2", "v2_pnacl" or "app_remoting").
-    app_id: A string with the Remoting Application Id (only used for app
+    appid: A string with the Remoting Application Id (only used for app
              remoting webapps). If supplied, it defaults to using the
              test API server.
     app_name: A string with the name of the application.
     app_description: A string with the description of the application.
     app_capabilities: A set of strings naming the capabilities that should be
                       enabled for this application.
     files: An array of strings listing the paths for resources to include
            in this webapp.
-    locales: An array of strings listing locales, which are copied, along
-             with their directory structure from the _locales directory down.
+    locales_listfile: The name of a file containing a list of locales, one per
+             line, which are copied, along with their directory structure, from
+             the _locales directory down.
     jinja_paths: An array of paths to search for {%include} directives in
                  addition to the directory containing the manifest template.
     service_environment: Used to point the webApp to one of the
                          dev/test/staging/prod environments
+    use_gcd: True if GCD support should be enabled.
   """
+
+  # Load the locales files from the locales_listfile.
+  if not locales_listfile:
+    raise Exception('You must specify a locales_listfile')
+  locales = []
+  with open(locales_listfile) as input:
+    for s in input:
+      locales.append(s.rstrip())
+
   # Ensure a fresh directory.
   try:
     shutil.rmtree(destination)
   except OSError:
     if os.path.exists(destination):
       raise
     else:
       pass
   os.mkdir(destination, 0775)
 
@@ skipping 65 matching lines @@
     # apps for release (no impersonation) instead of dev.
     if service_environment == 'prod' and buildtype == 'Dev':
       raise Exception("Prod environment cannot be built for 'dev' builds")
 
     if buildtype != 'Dev':
       if service_environment != 'prod':
         raise Exception('Invalid service_environment targeted for '
                         + buildtype + ': ' + service_environment)
       if 'out/Release' not in destination and 'out\Release' not in destination:
         raise Exception('Prod builds must be placed in the out/Release folder')
-      if app_id != None:
-        raise Exception('Cannot pass in an app_id for '
+      if appid != None:
+        raise Exception('Cannot pass in an appid for '
                         + buildtype + ' builds: ' + service_environment)
       if appRemotingApiHost != None:
         raise Exception('Cannot set APP_REMOTING_API_HOST env var for '
                         + buildtype + ' builds')
       if appRemotingApplicationId != None:
         raise Exception('Cannot set APP_REMOTING_APPLICATION_ID env var for '
                         + buildtype + ' builds')
 
     # If an Application ID was set (either from service_environment variable or
     # from a command line argument), hardcode it, otherwise get it at runtime.
-    effectiveAppId = appRemotingApplicationId or app_id
+    effectiveAppId = appRemotingApplicationId or appid
     if effectiveAppId:
       appRemotingApplicationId = "'" + effectiveAppId + "'"
     else:
       appRemotingApplicationId = "chrome.i18n.getMessage('@@extension_id')"
     findAndReplace(os.path.join(destination, 'plugin_settings.js'),
                    "'APP_REMOTING_APPLICATION_ID'", appRemotingApplicationId)
 
   oauth2BaseUrl = oauth2AccountsHost + '/o/oauth2'
   oauth2ApiBaseUrl = oauth2ApiHost + '/oauth2'
   directoryApiBaseUrl = directoryApiHost + '/chromoting/v1'
@@ skipping 13 matching lines @@
     elif service_environment == 'staging':
       appRemotingServicePath = '/appremoting/v1beta1_staging'
     elif service_environment == 'prod':
       appRemotingServicePath = '/appremoting/v1beta1'
     else:
       raise Exception('Unknown service environment: ' + service_environment)
     appRemotingApiBaseUrl = appRemotingApiHost + appRemotingServicePath
   else:
     appRemotingApiBaseUrl = ''
 
+  replaceBool(destination, 'USE_GCD', use_gcd)
   replaceString(destination, 'OAUTH2_BASE_URL', oauth2BaseUrl)
   replaceString(destination, 'OAUTH2_API_BASE_URL', oauth2ApiBaseUrl)
   replaceString(destination, 'DIRECTORY_API_BASE_URL', directoryApiBaseUrl)
   if webapp_type == 'app_remoting':
     replaceString(destination, 'APP_REMOTING_API_BASE_URL',
                   appRemotingApiBaseUrl)
 
   # Substitute hosts in the manifest's CSP list.
   # Ensure we list the API host only once if it's the same for multiple APIs.
   googleApiHosts = ' '.join(set([oauth2ApiHost, directoryApiHost]))
@@ skipping 66 matching lines @@
   # Use a consistent extension id for dev builds.
   # AppRemoting builds always use the dev app id - the correct app id gets
   # written into the manifest later.
   if buildtype != 'Official' or webapp_type == 'app_remoting':
     manifestKey = '"key": "remotingdevbuild",'
   else:
     manifestKey = ''
 
   # Generate manifest.
   if manifest_template:
+    print 'args.use_gcd {!r}'.format(use_gcd)

[Sergey Ulanov, 2015/03/25 18:56:43]

remove this?

[John Williams, 2015/03/25 20:32:19]

Oops.

     context = {
         'webapp_type': webapp_type,
         'FULL_APP_VERSION': version,
         'MANIFEST_KEY_FOR_UNOFFICIAL_BUILD': manifestKey,
         'OAUTH2_REDIRECT_URL': oauth2RedirectUrlJson,
         'TALK_GADGET_HOST': talkGadgetHostJson,
         'THIRD_PARTY_AUTH_REDIRECT_URL': thirdPartyAuthUrlJson,
         'REMOTING_IDENTITY_API_CLIENT_ID': apiClientIdV2,
         'OAUTH2_BASE_URL': oauth2BaseUrl,
         'OAUTH2_API_BASE_URL': oauth2ApiBaseUrl,
         'DIRECTORY_API_BASE_URL': directoryApiBaseUrl,
         'APP_REMOTING_API_BASE_URL': appRemotingApiBaseUrl,
         'OAUTH2_ACCOUNTS_HOST': oauth2AccountsHost,
         'GOOGLE_API_HOSTS': googleApiHosts,
         'APP_NAME': app_name,
         'APP_DESCRIPTION': app_description,
         'OAUTH_GDRIVE_SCOPE': '',
+        'USE_GCD': use_gcd,
         'XMPP_SERVER': xmppServer,
     }
     if 'GOOGLE_DRIVE' in app_capabilities:
       context['OAUTH_GDRIVE_SCOPE'] = ('https://docs.google.com/feeds/ '
                                        'https://www.googleapis.com/auth/drive')
     processJinjaTemplate(manifest_template,
                          jinja_paths,
                          os.path.join(destination, 'manifest.json'),
                          context)
 
   # Make the zipfile.
   createZip(zip_path, destination)
 
   return 0
 
 
 def main():
-  if len(sys.argv) < 6:
-    print ('Usage: build-webapp.py '
-           '<build-type> <version> <dst> <zip-path> <manifest_template> '
-           '<webapp_type> <other files...> '
-           '--app_name <name> '
-           '--app_description <description> '
-           '--app_capabilities <capabilities...> '
-           '[--appid <appid>] '
-           '[--locales_listfile <locales-listfile-name>] '
-           '[--jinja_paths <paths...>] '
-           '[--service_environment <service_environment>]')
-    return 1
+  parser = argparse.ArgumentParser()
+  parser.add_argument('buildtype')
+  parser.add_argument('version')
+  parser.add_argument('destination')
+  parser.add_argument('zip_path')
+  parser.add_argument('manifest_template')
+  parser.add_argument('webapp_type')
+  parser.add_argument('files', nargs='*', metavar='file', default=[])
+  parser.add_argument('--app_name', metavar='NAME')
+  parser.add_argument('--app_description', metavar='TEXT')
+  parser.add_argument('--app_capabilities',
+                      nargs='*', default=[], metavar='CAPABILITY')
+  parser.add_argument('--appid')
+  parser.add_argument('--locales_listfile', default='', metavar='PATH')
+  parser.add_argument('--jinja_paths', nargs='*', default=[], metavar='PATH')
+  parser.add_argument('--service_environment', default='', metavar='ENV')
+  parser.add_argument('--use_gcd', choices=['0', '1'], default='0')
 
-  arg_type = ''
-  files = []
-  locales_listfile = ''
-  jinja_paths = []
-  app_id = None
-  app_name = None
-  app_description = None
-  app_capabilities = set([])
-  service_environment = ''
-
-  for arg in sys.argv[7:]:
-    if arg in ['--locales_listfile',
-               '--jinja_paths',
-               '--appid',
-               '--app_name',
-               '--app_description',
-               '--app_capabilities',
-               '--service_environment']:
-      arg_type = arg
-    elif arg_type == '--locales_listfile':
-      locales_listfile = arg
-      arg_type = ''
-    elif arg_type == '--jinja_paths':
-      jinja_paths.append(arg)
-    elif arg_type == '--appid':
-      app_id = arg
-      arg_type = ''
-    elif arg_type == '--app_name':
-      app_name = arg
-      arg_type = ''
-    elif arg_type == '--app_description':
-      app_description = arg
-      arg_type = ''
-    elif arg_type == '--app_capabilities':
-      app_capabilities.add(arg)
-    elif arg_type == '--service_environment':
-      service_environment = arg
-      arg_type = ''
-    else:
-      files.append(arg)
-
-  # Load the locales files from the locales_listfile.
-  if not locales_listfile:
-    raise Exception('You must specify a locales_listfile')
-  locales = []
-  with open(locales_listfile) as input:
-    for s in input:
-      locales.append(s.rstrip())
-
-  return buildWebApp(sys.argv[1], sys.argv[2], sys.argv[3], sys.argv[4],
-                     sys.argv[5], sys.argv[6], app_id, app_name,
-                     app_description, app_capabilities, files, locales,
-                     jinja_paths, service_environment)
+  args = parser.parse_args()
+  args.use_gcd = (args.use_gcd != '0')
+  args.app_capabilities = set(args.app_capabilities)
+  return buildWebApp(**args.__dict__)

[Sergey Ulanov, 2015/03/25 18:56:43]

Use dict(args) instead of args.__dict__

[John Williams, 2015/03/25 20:32:19]

Using |dict| doesn't work, but |vars| does.

 
 
 if __name__ == '__main__':
   sys.exit(main())