| #!/usr/bin/env python |
| # Copyright 2016 The Chromium Authors |
| # Use of this source code is governed by a BSD-style license that can be |
| # found in the LICENSE file. |
| |
| """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__), os.pardir, os.pardir, os.pardir)) |
| |
| sys.path.insert(0, os.path.join(REPOSITORY_ROOT, 'build/android/gyp')) |
| from util import build_utils # pylint: disable=wrong-import-position |
| |
| sys.path.insert(0, os.path.join(REPOSITORY_ROOT, 'components')) |
| from cronet.tools import update_api # pylint: disable=wrong-import-position |
| |
| |
| # 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. |
| from cronet.tools.update_api import CLASS_RE # pylint: disable=wrong-import-position |
| |
| METHOD_RE = re.compile(r".* ([^ ]*)\(.*\)( .+)?;") |
| |
| # Adding anything to this list is dangerous: do so only if you deeply understand Cronet's API/IMPL layering. |
| ALLOWED_EXCEPTIONS = [ |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/disconnect -> org/chromium/net/UrlRequest/cancel:()V', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/getResponseMessage -> org/chromium/net/UrlResponseInfo/getHttpStatusText:()Ljava/lang/String;', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/getResponseCode -> org/chromium/net/UrlResponseInfo/getHttpStatusCode:()I', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/getInputStream -> org/chromium/net/UrlResponseInfo/getHttpStatusCode:()I', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/startRequest -> org/chromium/net/CronetEngine/newUrlRequestBuilder:(Ljava/lang/String;Lorg/chromium/net/UrlRequest$Callback;Ljava/util/concurrent/Executor;)Lorg/chromium/net/UrlRequest$Builder;', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/startRequest -> org/chromium/net/ExperimentalUrlRequest$Builder/setUploadDataProvider:(Lorg/chromium/net/UploadDataProvider;Ljava/util/concurrent/Executor;)Lorg/chromium/net/ExperimentalUrlRequest$Builder;', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/startRequest -> org/chromium/net/UploadDataProvider/getLength:()J', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/startRequest -> org/chromium/net/ExperimentalUrlRequest$Builder/addHeader:(Ljava/lang/String;Ljava/lang/String;)Lorg/chromium/net/ExperimentalUrlRequest$Builder;', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/startRequest -> org/chromium/net/ExperimentalUrlRequest$Builder/disableCache:()Lorg/chromium/net/ExperimentalUrlRequest$Builder;', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/startRequest -> org/chromium/net/ExperimentalUrlRequest$Builder/setHttpMethod:(Ljava/lang/String;)Lorg/chromium/net/ExperimentalUrlRequest$Builder;', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/startRequest -> org/chromium/net/ExperimentalUrlRequest$Builder/setTrafficStatsTag:(I)Lorg/chromium/net/ExperimentalUrlRequest$Builder;', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/startRequest -> org/chromium/net/ExperimentalUrlRequest$Builder/setTrafficStatsUid:(I)Lorg/chromium/net/ExperimentalUrlRequest$Builder;', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/startRequest -> org/chromium/net/ExperimentalUrlRequest$Builder/build:()Lorg/chromium/net/ExperimentalUrlRequest;', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/startRequest -> org/chromium/net/UrlRequest/start:()V', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/getErrorStream -> org/chromium/net/UrlResponseInfo/getHttpStatusCode:()I', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/getMoreData -> org/chromium/net/UrlRequest/read:(Ljava/nio/ByteBuffer;)V', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection/getAllHeadersAsList -> org/chromium/net/UrlResponseInfo/getAllHeadersAsList:()Ljava/util/List;', |
| 'org.chromium.net.urlconnection.CronetChunkedOutputStream$UploadDataProviderImpl/read -> org/chromium/net/UploadDataSink/onReadSucceeded:(Z)V', |
| 'org.chromium.net.urlconnection.CronetChunkedOutputStream$UploadDataProviderImpl/rewind -> org/chromium/net/UploadDataSink/onRewindError:(Ljava/lang/Exception;)V', |
| 'org.chromium.net.urlconnection.CronetFixedModeOutputStream$UploadDataProviderImpl/read -> org/chromium/net/UploadDataSink/onReadSucceeded:(Z)V', |
| 'org.chromium.net.urlconnection.CronetFixedModeOutputStream$UploadDataProviderImpl/rewind -> org/chromium/net/UploadDataSink/onRewindError:(Ljava/lang/Exception;)V', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection$CronetUrlRequestCallback/onRedirectReceived -> org/chromium/net/UrlRequest/followRedirect:()V', |
| 'org.chromium.net.urlconnection.CronetHttpURLConnection$CronetUrlRequestCallback/onRedirectReceived -> org/chromium/net/UrlRequest/cancel:()V', |
| 'org.chromium.net.urlconnection.CronetHttpURLStreamHandler/openConnection -> org/chromium/net/ExperimentalCronetEngine/openConnection:(Ljava/net/URL;)Ljava/net/URLConnection;', |
| 'org.chromium.net.urlconnection.CronetHttpURLStreamHandler/openConnection -> org/chromium/net/ExperimentalCronetEngine/openConnection:(Ljava/net/URL;Ljava/net/Proxy;)Ljava/net/URLConnection;', |
| 'org.chromium.net.urlconnection.CronetBufferedOutputStream$UploadDataProviderImpl/read -> org/chromium/net/UploadDataSink/onReadSucceeded:(Z)V', |
| 'org.chromium.net.urlconnection.CronetBufferedOutputStream$UploadDataProviderImpl/rewind -> org/chromium/net/UploadDataSink/onRewindSucceeded:()V', |
| 'org.chromium.net.impl.CronetEngineBase/newBidirectionalStreamBuilder -> org/chromium/net/ExperimentalCronetEngine/newBidirectionalStreamBuilder:(Ljava/lang/String;Lorg/chromium/net/BidirectionalStream$Callback;Ljava/util/concurrent/Executor;)Lorg/chromium/net/ExperimentalBidirectionalStream$Builder;', |
| 'org.chromium.net.impl.NetworkExceptionImpl/getMessage -> org/chromium/net/NetworkException/getMessage:()Ljava/lang/String;', |
| 'org.chromium.net.impl.VersionSafeProxyOptions/org.chromium.net.impl.VersionSafeProxyOptions -> org/chromium/net/ProxyOptions/getProxyList:()Ljava/util/List;', |
| 'org.chromium.net.impl.VersionSafeProxyOptions/createProxyCallbackList -> org/chromium/net/ProxyOptions/getProxyList:()Ljava/util/List;', |
| 'org.chromium.net.impl.VersionSafeProxyOptions/createProxyCallbackList -> org/chromium/net/Proxy/getCallback:()Lorg/chromium/net/Proxy$HttpConnectCallback;', |
| 'org.chromium.net.impl.VersionSafeProxyOptions/createProxyCallbackList -> org/chromium/net/Proxy/getExecutor:()Ljava/util/concurrent/Executor;', |
| 'org.chromium.net.impl.VersionSafeProxyOptions/createProxyOptionsProto -> org/chromium/net/ProxyOptions/getProxyList:()Ljava/util/List;', |
| 'org.chromium.net.impl.VersionSafeProxyOptions/createProxyOptionsProto -> org/chromium/net/Proxy/getHost:()Ljava/lang/String;', |
| 'org.chromium.net.impl.VersionSafeProxyOptions/createProxyOptionsProto -> org/chromium/net/Proxy/getPort:()I', |
| 'org.chromium.net.impl.VersionSafeProxyOptions/createProxyOptionsProto -> org/chromium/net/Proxy/getScheme:()I', |
| 'org.chromium.net.impl.VersionSafeProxyCallback/onBeforeTunnelRequest -> org/chromium/net/Proxy$HttpConnectCallback/onBeforeRequest:(Lorg/chromium/net/Proxy$HttpConnectCallback$Request;)V', |
| 'org.chromium.net.impl.VersionSafeProxyCallback/onTunnelHeadersReceived -> org/chromium/net/Proxy$HttpConnectCallback/onResponseReceived:(Ljava/util/List;I)I', |
| 'org.chromium.net.impl.VersionSafeCallbacks$UrlRequestStatusListener/onStatus -> org/chromium/net/UrlRequest$StatusListener/onStatus:(I)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$UrlRequestCallback/onRedirectReceived -> org/chromium/net/UrlRequest$Callback/onRedirectReceived:(Lorg/chromium/net/UrlRequest;Lorg/chromium/net/UrlResponseInfo;Ljava/lang/String;)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$UrlRequestCallback/onResponseStarted -> org/chromium/net/UrlRequest$Callback/onResponseStarted:(Lorg/chromium/net/UrlRequest;Lorg/chromium/net/UrlResponseInfo;)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$UrlRequestCallback/onReadCompleted -> org/chromium/net/UrlRequest$Callback/onReadCompleted:(Lorg/chromium/net/UrlRequest;Lorg/chromium/net/UrlResponseInfo;Ljava/nio/ByteBuffer;)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$UrlRequestCallback/onSucceeded -> org/chromium/net/UrlRequest$Callback/onSucceeded:(Lorg/chromium/net/UrlRequest;Lorg/chromium/net/UrlResponseInfo;)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$UrlRequestCallback/onFailed -> org/chromium/net/UrlRequest$Callback/onFailed:(Lorg/chromium/net/UrlRequest;Lorg/chromium/net/UrlResponseInfo;Lorg/chromium/net/CronetException;)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$UrlRequestCallback/onCanceled -> org/chromium/net/UrlRequest$Callback/onCanceled:(Lorg/chromium/net/UrlRequest;Lorg/chromium/net/UrlResponseInfo;)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$UploadDataProviderWrapper/getLength -> org/chromium/net/UploadDataProvider/getLength:()J', |
| 'org.chromium.net.impl.VersionSafeCallbacks$UploadDataProviderWrapper/read -> org/chromium/net/UploadDataProvider/read:(Lorg/chromium/net/UploadDataSink;Ljava/nio/ByteBuffer;)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$UploadDataProviderWrapper/rewind -> org/chromium/net/UploadDataProvider/rewind:(Lorg/chromium/net/UploadDataSink;)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$UploadDataProviderWrapper/close -> org/chromium/net/UploadDataProvider/close:()V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$RequestFinishedInfoListener/org.chromium.net.impl.VersionSafeCallbacks$RequestFinishedInfoListener -> org/chromium/net/RequestFinishedInfo$Listener/getExecutor:()Ljava/util/concurrent/Executor;', |
| 'org.chromium.net.impl.VersionSafeCallbacks$RequestFinishedInfoListener/onRequestFinished -> org/chromium/net/RequestFinishedInfo$Listener/onRequestFinished:(Lorg/chromium/net/RequestFinishedInfo;)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$RequestFinishedInfoListener/getExecutor -> org/chromium/net/RequestFinishedInfo$Listener/getExecutor:()Ljava/util/concurrent/Executor;', |
| 'org.chromium.net.impl.VersionSafeCallbacks$NetworkQualityThroughputListenerWrapper/org.chromium.net.impl.VersionSafeCallbacks$NetworkQualityThroughputListenerWrapper -> org/chromium/net/NetworkQualityThroughputListener/getExecutor:()Ljava/util/concurrent/Executor;', |
| 'org.chromium.net.impl.VersionSafeCallbacks$NetworkQualityThroughputListenerWrapper/onThroughputObservation -> org/chromium/net/NetworkQualityThroughputListener/onThroughputObservation:(IJI)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$NetworkQualityThroughputListenerWrapper/getExecutor -> org/chromium/net/NetworkQualityThroughputListener/getExecutor:()Ljava/util/concurrent/Executor;', |
| 'org.chromium.net.impl.VersionSafeCallbacks$NetworkQualityRttListenerWrapper/org.chromium.net.impl.VersionSafeCallbacks$NetworkQualityRttListenerWrapper -> org/chromium/net/NetworkQualityRttListener/getExecutor:()Ljava/util/concurrent/Executor;', |
| 'org.chromium.net.impl.VersionSafeCallbacks$NetworkQualityRttListenerWrapper/onRttObservation -> org/chromium/net/NetworkQualityRttListener/onRttObservation:(IJI)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$NetworkQualityRttListenerWrapper/getExecutor -> org/chromium/net/NetworkQualityRttListener/getExecutor:()Ljava/util/concurrent/Executor;', |
| 'org.chromium.net.impl.VersionSafeCallbacks$LibraryLoader/loadLibrary -> org/chromium/net/CronetEngine$Builder$LibraryLoader/loadLibrary:(Ljava/lang/String;)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$BidirectionalStreamCallback/onStreamReady -> org/chromium/net/BidirectionalStream$Callback/onStreamReady:(Lorg/chromium/net/BidirectionalStream;)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$BidirectionalStreamCallback/onResponseHeadersReceived -> org/chromium/net/BidirectionalStream$Callback/onResponseHeadersReceived:(Lorg/chromium/net/BidirectionalStream;Lorg/chromium/net/UrlResponseInfo;)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$BidirectionalStreamCallback/onReadCompleted -> org/chromium/net/BidirectionalStream$Callback/onReadCompleted:(Lorg/chromium/net/BidirectionalStream;Lorg/chromium/net/UrlResponseInfo;Ljava/nio/ByteBuffer;Z)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$BidirectionalStreamCallback/onWriteCompleted -> org/chromium/net/BidirectionalStream$Callback/onWriteCompleted:(Lorg/chromium/net/BidirectionalStream;Lorg/chromium/net/UrlResponseInfo;Ljava/nio/ByteBuffer;Z)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$BidirectionalStreamCallback/onResponseTrailersReceived -> org/chromium/net/BidirectionalStream$Callback/onResponseTrailersReceived:(Lorg/chromium/net/BidirectionalStream;Lorg/chromium/net/UrlResponseInfo;Lorg/chromium/net/UrlResponseInfo$HeaderBlock;)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$BidirectionalStreamCallback/onSucceeded -> org/chromium/net/BidirectionalStream$Callback/onSucceeded:(Lorg/chromium/net/BidirectionalStream;Lorg/chromium/net/UrlResponseInfo;)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$BidirectionalStreamCallback/onFailed -> org/chromium/net/BidirectionalStream$Callback/onFailed:(Lorg/chromium/net/BidirectionalStream;Lorg/chromium/net/UrlResponseInfo;Lorg/chromium/net/CronetException;)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$BidirectionalStreamCallback/onCanceled -> org/chromium/net/BidirectionalStream$Callback/onCanceled:(Lorg/chromium/net/BidirectionalStream;Lorg/chromium/net/UrlResponseInfo;)V', |
| 'org.chromium.net.impl.VersionSafeCallbacks$ApiVersion/getMaximumAvailableApiLevel -> org/chromium/net/ApiVersion/getApiLevel:()I', |
| 'org.chromium.net.impl.VersionSafeCallbacks$ApiVersion/getMaximumAvailableApiLevel -> org/chromium/net/ApiVersion/getMaximumAvailableApiLevel:()I', |
| 'org.chromium.net.impl.VersionSafeCallbacks$ApiVersion/getCronetVersion -> org/chromium/net/ApiVersion/getCronetVersion:()Ljava/lang/String;', |
| ] |
| |
| JAR_PATH = os.path.join(build_utils.JAVA_HOME, 'bin', 'jar') |
| JAVAP_PATH = os.path.join(build_utils.JAVA_HOME, 'bin', 'javap') |
| |
| |
| def find_api_calls(dump, api_classes, bad_calls): |
| # Given a dump of an implementation class, find calls through API classes. |
| # |dump| is the output of "javap -c" on the implementation class files. |
| # |api_classes| is the list of classes comprising the API. |
| # |bad_calls| is the list of calls through API classes. This list is built up |
| # by this function. |
| |
| for i, line in enumerate(dump): |
| try: |
| if CLASS_RE.match(line): |
| caller_class = CLASS_RE.match(line).group(2) |
| if METHOD_RE.match(line): |
| caller_method = METHOD_RE.match(line).group(1) |
| if line.startswith(': invoke', 8) and not line.startswith('dynamic', 16): |
| callee = line.split(' // ')[1].split('Method ')[1].split('\n')[0] |
| callee_class = callee.split('.')[0] |
| assert callee_class |
| if callee_class in api_classes: |
| callee_method = callee.split('.')[1] |
| assert callee_method |
| # Ignore constructor calls for now as every implementation class |
| # that extends an API class will call them. |
| # TODO(pauljensen): Look into enforcing restricting constructor calls. |
| # https://crbug.com/674975 |
| if callee_method.startswith('"<init>"'): |
| 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] |
| except Exception: |
| sys.stderr.write(f'Failed on line {i+1}: {line}') |
| raise |
| |
| |
| def check_api_calls(opts): |
| # Returns True if no calls through API classes in implementation. |
| |
| temp_dir = tempfile.mkdtemp() |
| |
| # Extract API class files from jar |
| jar_cmd = [os.path.relpath(JAR_PATH, temp_dir), 'xf', |
| os.path.abspath(opts.api_jar)] |
| build_utils.CheckOutput(jar_cmd, cwd=temp_dir) |
| shutil.rmtree(os.path.join(temp_dir, 'META-INF'), ignore_errors=True) |
| |
| # Collect names of API classes |
| api_classes = [] |
| for dirpath, _, filenames in os.walk(temp_dir): |
| if not filenames: |
| continue |
| package = os.path.relpath(dirpath, temp_dir) |
| for filename in filenames: |
| if filename.endswith('.class'): |
| classname = filename[:-len('.class')] |
| api_classes += [os.path.normpath(os.path.join(package, classname))] |
| |
| shutil.rmtree(temp_dir) |
| temp_dir = tempfile.mkdtemp() |
| |
| # Extract impl class files from jars |
| for impl_jar in opts.impl_jar: |
| jar_cmd = [os.path.relpath(JAR_PATH, temp_dir), 'xf', |
| os.path.abspath(impl_jar)] |
| build_utils.CheckOutput(jar_cmd, cwd=temp_dir) |
| shutil.rmtree(os.path.join(temp_dir, 'META-INF'), ignore_errors=True) |
| |
| # Process classes |
| bad_api_calls = [] |
| for dirpath, _, filenames in os.walk(temp_dir): |
| if not filenames: |
| continue |
| # Dump classes |
| dump_file = os.path.join(temp_dir, 'dump.txt') |
| javap_cmd = '%s -private -c %s > %s' % (JAVAP_PATH, ' '.join( |
| os.path.join(dirpath, f) |
| for f in filenames).replace('$', '\\$'), dump_file) |
| if os.system(javap_cmd): |
| print('ERROR: javap failed on ' + ' '.join(filenames)) |
| return False |
| # Process class dump |
| with open(dump_file, 'r') as dump: |
| 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)) |
| 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) |
