[Cronet] Enforce Cronet API never modified, only grown

components/cronet/tools/api_static_checks.py

 #!/usr/bin/python
 # Copyright 2016 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.
 
-"""api_static_checks.py - Check Cronet implementation does not call through
-API classes.
-"""
+"""api_static_checks.py - Enforce Cronet API requirements."""
 
 import argparse
 import os
 import re
 import shutil
 import sys
 import tempfile
 
 REPOSITORY_ROOT = os.path.abspath(os.path.join(
     os.path.dirname(__file__), '..', '..', '..'))
 
 sys.path.append(os.path.join(REPOSITORY_ROOT, 'build/android/gyp/util'))
 import build_utils
 
+sys.path.append(os.path.join(REPOSITORY_ROOT, 'components/cronet'))
+from tools import update_api
+
+
 # These regular expressions catch the beginning of lines that declare classes
 # and methods.  The first group returned by a match is the class or method name.
-CLASS_RE = re.compile(r'.*class ([^ ]*) .*\{')
+from tools.update_api import CLASS_RE
 METHOD_RE = re.compile(r'.* ([^ ]*)\(.*\);')
 
 # Allowed exceptions.  Adding anything to this list is dangerous and should be
 # avoided if possible.  For now these exceptions are for APIs that existed in
 # the first version of Cronet and will be supported forever.
 # TODO(pauljensen): Remove these.
 ALLOWED_EXCEPTIONS = [
 'org.chromium.net.impl.CronetEngineBuilderImpl/build ->'
     ' org/chromium/net/ExperimentalCronetEngine/getVersionString:'
     '()Ljava/lang/String;',
@@ skipping 58 matching lines @@
         # Ignore VersionSafe calls
         if 'VersionSafeCallbacks' in caller_class:
           continue
         bad_call = '%s/%s -> %s/%s' % (caller_class, caller_method,
                                        callee_class, callee_method)
         if bad_call in ALLOWED_EXCEPTIONS:
           continue
         bad_calls += [bad_call]
 
 
-def main(args):
+def check_api_calls(opts):
   # Returns True if no calls through API classes in implementation.
 
-  parser = argparse.ArgumentParser(
-      description='Check modules do not contain ARM Neon instructions.')
-  parser.add_argument('--api_jar',
-                      help='Path to API jar (i.e. cronet_api.jar)',
-                      required=True,
-                      metavar='path/to/cronet_api.jar')
-  parser.add_argument('--impl_jar',
-                      help='Path to implementation jar '
-                          '(i.e. cronet_impl_native_java.jar)',
-                      required=True,
-                      metavar='path/to/cronet_impl_native_java.jar',
-                      action='append')
-  parser.add_argument('--stamp', help='Path to touch on success.')
-  opts = parser.parse_args(args)
-
   temp_dir = tempfile.mkdtemp()
 
   # Extract API class files from jar
   jar_cmd = ['jar', 'xf', os.path.abspath(opts.api_jar)]
   build_utils.CheckOutput(jar_cmd, cwd=temp_dir)
   shutil.rmtree(os.path.join(temp_dir, 'META-INF'))
 
   # Collect names of API classes
   api_classes = []
   for dirpath, _, filenames in os.walk(temp_dir):
     if not filenames:
       continue
     package = dirpath[len(temp_dir + '/'):]

[kapishnikov, 2016/12/28 20:37:35]

You probably can use

package = os.path.relpath(dirpath, temp_dir)

[pauljensen, 2017/01/03 15:01:48]

Done.

     if package:
       package += '/'
     for filename in filenames:
       if filename.endswith('.class'):
         classname = filename[:-len('.class')]
         api_classes += [package + classname]

[kapishnikov, 2016/12/28 20:37:35]

It is better to use os.path.join(package, classname) and remove

if package:
  package += '/'

[pauljensen, 2017/01/03 15:01:48]

Done, I had to wrap it in os.path.normpath() because os.path.relpath() returns
'.' instead of an empty string.

 
   shutil.rmtree(temp_dir)
   temp_dir = tempfile.mkdtemp()
 
   # Extract impl class files from jars
   for impl_jar in opts.impl_jar:
     jar_cmd = ['jar', 'xf', os.path.abspath(impl_jar)]
     build_utils.CheckOutput(jar_cmd, cwd=temp_dir)
   shutil.rmtree(os.path.join(temp_dir, 'META-INF'))
 
@@ skipping 15 matching lines @@
       find_api_calls(dump, api_classes, bad_api_calls)
 
   shutil.rmtree(temp_dir)
 
   if bad_api_calls:
     print 'ERROR: Found the following calls from implementation classes through'
     print '       API classes.  These could fail if older API is used that'
     print '       does not contain newer methods.  Please call through a'
     print '       wrapper class from VersionSafeCallbacks.'
     print '\n'.join(bad_api_calls)
-
-  if not bad_api_calls and opts.stamp:
-    build_utils.Touch(opts.stamp)
   return not bad_api_calls
 
 
+def check_api_version(opts):
+  if update_api.check_up_to_date(opts.api_jar):
+    return True
+  print 'ERROR: API file out of date.  Please run this command:'
+  print '       components/cronet/tools/update_api.py --api_jar %s' % (
+      os.path.abspath(opts.api_jar))
+  return False
+
+
+def main(args):
+  parser = argparse.ArgumentParser(
+      description='Enforce Cronet API requirements.')
+  parser.add_argument('--api_jar',
+                      help='Path to API jar (i.e. cronet_api.jar)',
+                      required=True,
+                      metavar='path/to/cronet_api.jar')
+  parser.add_argument('--impl_jar',
+                      help='Path to implementation jar '
+                          '(i.e. cronet_impl_native_java.jar)',
+                      required=True,
+                      metavar='path/to/cronet_impl_native_java.jar',
+                      action='append')
+  parser.add_argument('--stamp', help='Path to touch on success.')
+  opts = parser.parse_args(args)
+
+  ret = True
+  ret = check_api_calls(opts) and ret
+  ret = check_api_version(opts) and ret
+  if ret and opts.stamp:
+    build_utils.Touch(opts.stamp)
+  return ret
+
+
 if __name__ == '__main__':
   sys.exit(0 if main(sys.argv[1:]) else -1)