Cleanup gms update/preprocess scripts, roll android_tools

build/android/play_services/utils.py

 # Copyright 2015 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.
 
 '''
 Utility functions for all things related to manipulating google play services
 related files.
 '''
 
 import argparse
@@ skipping 25 matching lines @@
 class ConfigParser(object):
   '''Reads and writes the configuration files for play services related scripts
 
   The configuration files are JSON files. Here is the data they are expected
   to contain:
 
    -  version_number
       Number. Mirrors @integer/google_play_services_version from the library.
       Example: 815000
 
+   -  sdk_version
+      Version of the Play Services SDK to retrieve, when preprocessing the
+      library from a maven/gradle repository.
+      Example: "8.1.0"
+
+   -  clients
+      List of strings. Name of the clients (or play services modules) to
+      include when preprocessing the library.
+      Example: ["play-services-base", "play-services-cast"]
+
+   -  version_xml_path
+      String. Path to the version.xml string describing the current version.
+      Should be relative to the library base directory
+      Example: "res/values/version.xml"
+
+   -  locale_whitelist
+      List of strings. List of locales to keep from the resources. Can be
+      obtained by generating an android build and looking at the content of
+      `out/Debug/gen/chrome/java/res`; or looking at the android section in
+      `//chrome/app/generated_resources.grd`
+      Example: ["am", "ar", "bg", "ca", "cs"]
+
   '''
   _VERSION_NUMBER_KEY = 'version_number'
 
   def __init__(self, path):
     self.path = path
-    self.data = {}
+    self._data = {}
 
     with open(path, 'r') as stream:
-      self.data = json.load(stream)
+      self._data = json.load(stream)
 
   @property
   def version_number(self):
-    return self.data[self._VERSION_NUMBER_KEY]
+    return self._data[self._VERSION_NUMBER_KEY]
+
+  @property
+  def sdk_version(self):
+    return self._data['sdk_version']
+
+  @property
+  def clients(self):
+    return self._data['clients']
+
+  @property
+  def version_xml_path(self):
+    return self._data['version_xml_path']
+
+  @property
+  def locale_whitelist(self):
+    return self._data['locale_whitelist']

[jbudorick, 2015/12/10 14:16:31]

clients, version_xml_path, and locale_whitelist don't appear to handle the
expected case where they don't exist in the config.

[dgn, 2015/12/10 14:35:19]

But that happens only when trying to read it. If running the preprocess script,
I would expect the input config to be properly populated. In the download/update
case, we don't read those so there is no issue.

[jbudorick, 2015/12/10 14:37:27]

Hm. I'm debating between raising a KeyError and returning None, and I'm leaning
toward None.

[dgn, 2015/12/10 21:12:57]

Done.

 
   def UpdateVersionNumber(self, new_version_number):
     '''Updates the version number and saves it in the configuration file. '''
 
     with open(self.path, 'w') as stream:
-      self.data[self._VERSION_NUMBER_KEY] = new_version_number
-      json.dump(self.data, stream, sort_keys=True, indent=2)
-      stream.write(os.linesep)
+      self._data[self._VERSION_NUMBER_KEY] = new_version_number
+      stream.write(DumpTrimmedJson(self._data))
+
+def DumpTrimmedJson(json_data):
+  '''
+  Default formatting when dumping json to string has trailing spaces and lacks
+  a new line at the end. This function fixes that.
+  '''
+
+  out = json.dumps(json_data, sort_keys=True, indent=2)
+  out = out.replace(' ' + os.linesep, os.linesep)
+  return out + os.linesep
 
 
 def FileEquals(expected_file, actual_file):
   '''
   Returns whether the two files are equal. Returns False if any of the files
   doesn't exist.
   '''
 
   if not os.path.isfile(actual_file) or not os.path.isfile(expected_file):
     return False
@@ skipping 27 matching lines @@
 def MakeLocalCommit(repo_root, files_to_commit, message):
   '''Makes a local git commit.'''
 
   logging.debug('Staging files (%s) for commit.', files_to_commit)
   if cmd_helper.Call(['git', 'add'] + files_to_commit, cwd=repo_root) != 0:
     raise Exception('The local commit failed.')
 
   logging.debug('Committing.')
   if cmd_helper.Call(['git', 'commit', '-m', message], cwd=repo_root) != 0:
     raise Exception('The local commit failed.')