[Cronet] Enforce Cronet API never modified, only grown

[Cronet] Enforce Cronet API never modified, only grown

Enforce that the Cronet API classes and methods are never modified or
removed, only added.  Modifying or removing an API class or method
breaks backwards compatibility.  This is enforced by:
1. Keep an updated dump of the Cronet API in components/cronet/android/api.txt
2. When building check that the Cronet API matches that in api.txt
3. Provide a script for updating api.txt; this script also enforces that
   only additions are made to the API.
This change also maintains a version number for the Cronet API.  Cronet
can use this to enforce, for example that the Cronet implementation is at
least as new as the Cronet API being used.

BUG=629299
R=kapishnikov
CQ_INCLUDE_TRYBOTS=master.tryserver.chromium.android:android_cronet_tester

Committed: https://crrev.com/2a6ee085bd4c2bd39625a867561c5cc39a1377db
Cr-Commit-Position: refs/heads/master@{#441455}

[pauljensen, 2016-12-01 18:43:10]

Description was changed from

==========
[Cronet] Enforce Cronet API never modified, only grown

Enforce that the Cronet API classes and methods are never modified or
removed, only added.  Modifying or removing an API class or method
breaks backwards compatibility.  This is enforced by:
1. Keep an updated dump of the Cronet API in components/cronet/android/api.txt
2. When building check that the Cronet API matches that in api.txt
3. Provide a script for updating api.txt; this script also enforces that
   only additions are made to the API.
This change also maintains a version number for the Cronet API.  Cronet
can use this to enforce, for example that the Cronet implementation is at
least as new as the Cronet API being used.

BUG=629299
R=kapishnikov
==========

to

==========
[Cronet] Enforce Cronet API never modified, only grown

Enforce that the Cronet API classes and methods are never modified or
removed, only added.  Modifying or removing an API class or method
breaks backwards compatibility.  This is enforced by:
1. Keep an updated dump of the Cronet API in components/cronet/android/api.txt
2. When building check that the Cronet API matches that in api.txt
3. Provide a script for updating api.txt; this script also enforces that
   only additions are made to the API.
This change also maintains a version number for the Cronet API.  Cronet
can use this to enforce, for example that the Cronet implementation is at
least as new as the Cronet API being used.

BUG=629299
R=kapishnikov
CQ_INCLUDE_TRYBOTS=master.tryserver.chromium.android:android_cronet_tester
==========

[pauljensen, 2016-12-01 19:11:55]

Andrei, PTAL, thank you!

[kapishnikov, 2016-12-01 23:28:34]

https://codereview.chromium.org/2544043002/diff/40001/components/cronet/tools...
File components/cronet/tools/update_api.py (right):

https://codereview.chromium.org/2544043002/diff/40001/components/cronet/tools...
components/cronet/tools/update_api.py:32: CLASS_RE = re.compile(r'.*class ([^
]*) .*{')
Backward slash needed before '{'

https://codereview.chromium.org/2544043002/diff/40001/components/cronet/tools...
components/cronet/tools/update_api.py:43: output_file.write('DO NOT EDIT THIS
FILE, USE update_api.py TO UPDATE IT\n')
One extra new line to separate the warning from the content?

https://codereview.chromium.org/2544043002/diff/40001/components/cronet/tools...
components/cronet/tools/update_api.py:52: for root, _, filenames in
os.walk(temp_dir):
I wonder if the order of filenames will always be the same.

https://codereview.chromium.org/2544043002/diff/40001/components/cronet/tools...
components/cronet/tools/update_api.py:58: print 'ERROR: javap failed on ' +
api_jar
Should we print the failed command line to make debug easier?

[pauljensen, 2016-12-16 19:17:03]

https://codereview.chromium.org/2544043002/diff/40001/components/cronet/tools...
File components/cronet/tools/update_api.py (right):

https://codereview.chromium.org/2544043002/diff/40001/components/cronet/tools...
components/cronet/tools/update_api.py:32: CLASS_RE = re.compile(r'.*class ([^
]*) .*{')
On 2016/12/01 23:28:34, kapishnikov wrote:
> Backward slash needed before '{'

Done.

https://codereview.chromium.org/2544043002/diff/40001/components/cronet/tools...
components/cronet/tools/update_api.py:43: output_file.write('DO NOT EDIT THIS
FILE, USE update_api.py TO UPDATE IT\n')
On 2016/12/01 23:28:34, kapishnikov wrote:
> One extra new line to separate the warning from the content?

Done.

https://codereview.chromium.org/2544043002/diff/40001/components/cronet/tools...
components/cronet/tools/update_api.py:52: for root, _, filenames in
os.walk(temp_dir):
On 2016/12/01 23:28:34, kapishnikov wrote:
> I wonder if the order of filenames will always be the same.

I sorted the list.

https://codereview.chromium.org/2544043002/diff/40001/components/cronet/tools...
components/cronet/tools/update_api.py:58: print 'ERROR: javap failed on ' +
api_jar
On 2016/12/01 23:28:34, kapishnikov wrote:
> Should we print the failed command line to make debug easier?

Done.

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

LGTM. A couple of nits.

https://codereview.chromium.org/2544043002/diff/140001/components/cronet/tool...
File components/cronet/tools/api_static_checks.py (right):

https://codereview.chromium.org/2544043002/diff/140001/components/cronet/tool...
components/cronet/tools/api_static_checks.py:121: package = dirpath[len(temp_dir
+ '/'):]
You probably can use

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

https://codereview.chromium.org/2544043002/diff/140001/components/cronet/tool...
components/cronet/tools/api_static_checks.py:127: api_classes += [package +
classname]
It is better to use os.path.join(package, classname) and remove

if package:
  package += '/'

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

https://codereview.chromium.org/2544043002/diff/140001/components/cronet/tool...
File components/cronet/tools/api_static_checks.py (right):

https://codereview.chromium.org/2544043002/diff/140001/components/cronet/tool...
components/cronet/tools/api_static_checks.py:121: package = dirpath[len(temp_dir
+ '/'):]
On 2016/12/28 20:37:35, kapishnikov wrote:
> You probably can use
> 
> package = os.path.relpath(dirpath, temp_dir)

Done.

https://codereview.chromium.org/2544043002/diff/140001/components/cronet/tool...
components/cronet/tools/api_static_checks.py:127: api_classes += [package +
classname]
On 2016/12/28 20:37:35, kapishnikov wrote:
> It is better to use os.path.join(package, classname) and remove
> 
> if package:
>   package += '/'

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

[pauljensen, 2017-01-03 20:10:31]

The CQ bit was checked by pauljensen@chromium.org

[pauljensen, 2017-01-03 20:10:31]

The patchset sent to the CQ was uploaded after l-g-t-m from
kapishnikov@chromium.org
Link to the patchset: https://codereview.chromium.org/2544043002/#ps200001
(title: "rebase")

[commit-bot: I haz the power, 2017-01-03 20:11:01]

CQ is trying da patch. Follow status at
 
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[commit-bot: I haz the power, 2017-01-03 20:25:06]

The CQ bit was unchecked by commit-bot@chromium.org

[commit-bot: I haz the power, 2017-01-03 20:25:06]

Try jobs failed on following builders:
  android_cronet on master.tryserver.chromium.android (JOB_FAILED,
https://build.chromium.org/p/tryserver.chromium.android/builders/android_cron...)

[kapishnikov, 2017-01-04 19:50:06]

lgtm

[pauljensen, 2017-01-04 19:50:27]

The CQ bit was checked by pauljensen@chromium.org

[commit-bot: I haz the power, 2017-01-04 19:51:08]

CQ is trying da patch. Follow status at
 
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[commit-bot: I haz the power, 2017-01-04 20:42:28]

CQ is committing da patch.

Bot data: {"patchset_id": 360001, "attempt_start_ts": 1483559427732820,
"parent_rev": "153bba1b8d33c6cb02933913a33011722ff12535", "commit_rev":
"2b9e5691c39784f1aaffb7c386a73979b3711865"}

[commit-bot: I haz the power, 2017-01-04 20:42:58]

Description was changed from

==========
[Cronet] Enforce Cronet API never modified, only grown

Enforce that the Cronet API classes and methods are never modified or
removed, only added.  Modifying or removing an API class or method
breaks backwards compatibility.  This is enforced by:
1. Keep an updated dump of the Cronet API in components/cronet/android/api.txt
2. When building check that the Cronet API matches that in api.txt
3. Provide a script for updating api.txt; this script also enforces that
   only additions are made to the API.
This change also maintains a version number for the Cronet API.  Cronet
can use this to enforce, for example that the Cronet implementation is at
least as new as the Cronet API being used.

BUG=629299
R=kapishnikov
CQ_INCLUDE_TRYBOTS=master.tryserver.chromium.android:android_cronet_tester
==========

to

==========
[Cronet] Enforce Cronet API never modified, only grown

Enforce that the Cronet API classes and methods are never modified or
removed, only added.  Modifying or removing an API class or method
breaks backwards compatibility.  This is enforced by:
1. Keep an updated dump of the Cronet API in components/cronet/android/api.txt
2. When building check that the Cronet API matches that in api.txt
3. Provide a script for updating api.txt; this script also enforces that
   only additions are made to the API.
This change also maintains a version number for the Cronet API.  Cronet
can use this to enforce, for example that the Cronet implementation is at
least as new as the Cronet API being used.

BUG=629299
R=kapishnikov
CQ_INCLUDE_TRYBOTS=master.tryserver.chromium.android:android_cronet_tester

Review-Url: https://codereview.chromium.org/2544043002
==========

[commit-bot: I haz the power, 2017-01-04 20:42:59]

Committed patchset #19 (id:360001)

[commit-bot: I haz the power, 2017-01-04 20:45:50]

Description was changed from

==========
[Cronet] Enforce Cronet API never modified, only grown

Enforce that the Cronet API classes and methods are never modified or
removed, only added.  Modifying or removing an API class or method
breaks backwards compatibility.  This is enforced by:
1. Keep an updated dump of the Cronet API in components/cronet/android/api.txt
2. When building check that the Cronet API matches that in api.txt
3. Provide a script for updating api.txt; this script also enforces that
   only additions are made to the API.
This change also maintains a version number for the Cronet API.  Cronet
can use this to enforce, for example that the Cronet implementation is at
least as new as the Cronet API being used.

BUG=629299
R=kapishnikov
CQ_INCLUDE_TRYBOTS=master.tryserver.chromium.android:android_cronet_tester

Review-Url: https://codereview.chromium.org/2544043002
==========

to

==========
[Cronet] Enforce Cronet API never modified, only grown

Enforce that the Cronet API classes and methods are never modified or
removed, only added.  Modifying or removing an API class or method
breaks backwards compatibility.  This is enforced by:
1. Keep an updated dump of the Cronet API in components/cronet/android/api.txt
2. When building check that the Cronet API matches that in api.txt
3. Provide a script for updating api.txt; this script also enforces that
   only additions are made to the API.
This change also maintains a version number for the Cronet API.  Cronet
can use this to enforce, for example that the Cronet implementation is at
least as new as the Cronet API being used.

BUG=629299
R=kapishnikov
CQ_INCLUDE_TRYBOTS=master.tryserver.chromium.android:android_cronet_tester

Committed: https://crrev.com/2a6ee085bd4c2bd39625a867561c5cc39a1377db
Cr-Commit-Position: refs/heads/master@{#441455}
==========

[commit-bot: I haz the power, 2017-01-04 20:45:51]

Patchset 19 (id:??) landed as
https://crrev.com/2a6ee085bd4c2bd39625a867561c5cc39a1377db
Cr-Commit-Position: refs/heads/master@{#441455}