Add a --json option to git cl try-results.

git_cl.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.
 
 # Copyright (C) 2008 Evan Martin <martine@danga.com>
 
 """A git-command for integrating reviews on Rietveld and Gerrit."""
 
 from __future__ import print_function
@@ skipping 380 matching lines @@
       headers={'Content-Type': 'application/json'}
   )
   print_text.append('To see results here, run:        git cl try-results')
   print_text.append('To see results in browser, run:  git cl web')
   print('\n'.join(print_text))
 
 
 def fetch_try_jobs(auth_config, changelist, options):
   """Fetches try jobs from buildbucket.
 
-  Returns a map from build id to build info as json dictionary.
+  Returns a map from build id to build info as a dictionary.
   """
   rietveld_url = settings.GetDefaultServerUrl()
   rietveld_host = urlparse.urlparse(rietveld_url).hostname
   authenticator = auth.get_authenticator_for_host(rietveld_host, auth_config)
   if authenticator.has_cached_credentials():
     http = authenticator.authorize(httplib2.Http())
   else:
     print('Warning: Some results might be missing because %s' %
           # Get the message on how to login.
           (auth.LoginRequiredError(rietveld_host).message,))
@@ skipping 114 matching lines @@
   pop(status='SCHEDULED',
       title='Scheduled:',
       f=lambda b: (get_name(b), 'id=%s' % b['id']))
   # The last section is just in case buildbucket API changes OR there is a bug.
   pop(title='Other:',
       f=lambda b: (get_name(b), 'id=%s' % b['id']))
   assert len(builds) == 0
   print('Total: %d try jobs' % total)
 
 
+def write_try_results_json(output_file, builds):
+  """Writes a subset of the data from fetch_try_jobs to a file as JSON.
+
+  The input |builds| dict is assumed to be generated by Buildbucket.
+  Buildbucket documentation: http://goo.gl/G0s101
+  """
+
+  def convert_build_dict(build):
+    return {
+        'buildbucket_id': build.get('id'),
+        'status': build.get('status'),
+        'result': build.get('result'),
+        'builder_name': json.loads(
+            build.get('parameters_json', '{}')).get('builder_name'),

[tandrii(chromium), 2016/08/30 22:22:45]

what about bucket_name? (that's where you can get what we call master name in
buildbot world).

also, i think it's worthwhile to report category here and url.

[qyearsley, 2016/08/30 23:41:24]

Added bucket and url.

By category, do you mean something like the category printed with `git cl
try-results`, which is generally a combination of "status", "result", and
"failure_reason"?

[tandrii(chromium), 2016/08/30 23:47:35]

no, i meant parameters_json.category. It's usually CQ or "git cl" or
"experimental". That said, doesn't have to be in this CL.

+        'failure_reason': build.get('failure_reason'),

[qyearsley, 2016/08/30 22:13:22]

Does it seem like a good idea to use build['key'] instead for "id" and "status"
and "parameters_json", and raise a KeyError and abort if the Buildbucket builds
list doesn't match what we expect?

I'm thinking here that whatever consumes this JSON should check for nulls, and
handle that, and if at some point we discover that builder_name or status is
null, then that indicates that maybe the buildbucket response isn't as expected
and something here should be updated.

[tandrii(chromium), 2016/08/30 22:22:45]

What's build['key']? I don't see it in buildbucket docs.
this -> sgtm.

[qyearsley, 2016/08/30 23:41:25]

Ah, that's not a real thing, what I meant was "does it seem like a good idea to
use the square bracket operator (__getitem__) which raises a KeyError, instead
of dict.get?". Sounds like dict.get is a reasonable way to do it?

[tandrii(chromium), 2016/08/30 23:47:35]

ah, dict.get() is the right way.

+    }
+
+  converted = []
+  for _, build in sorted(builds.items()):
+      converted.append(convert_build_dict(build))
+  write_json(output_file, converted)
+
+
 def MatchSvnGlob(url, base_url, glob_spec, allow_wildcards):
   """Return the corresponding git ref if |base_url| together with |glob_spec|
   matches the full |url|.
 
   If |allow_wildcards| is true, |glob_spec| can contain wildcards (see below).
   """
   fetch_suburl, as_ref = glob_spec.split(':')
   if allow_wildcards:
     glob_match = re.match('(.+/)?(\*|{[^/]*})(/.+)?', fetch_suburl)
     if glob_match:
@@ skipping 4202 matching lines @@
   group.add_option(
       "-p", "--patchset", type=int, help="patchset number if not current.")
   group.add_option(
       "--print-master", action='store_true', help="print master name as well.")
   group.add_option(
       "--color", action='store_true', default=setup_color.IS_TTY,
       help="force color output, useful when piping output.")
   group.add_option(
       "--buildbucket-host", default='cr-buildbucket.appspot.com',
       help="Host of buildbucket. The default host is %default.")
+  group.add_option(
+      '--json', help='Path of JSON output file to write try job results to.')
   parser.add_option_group(group)
   auth.add_auth_options(parser)
   options, args = parser.parse_args(args)
   if args:
     parser.error('Unrecognized args: %s' % ' '.join(args))
 
   auth_config = auth.extract_auth_config_from_options(options)
   cl = Changelist(auth_config=auth_config)
   if not cl.GetIssue():
     parser.error('Need to upload first')
 
   if not options.patchset:
     options.patchset = cl.GetMostRecentPatchset()
     if options.patchset and options.patchset != cl.GetPatchset():
       print(
           '\nWARNING Mismatch between local config and server. Did a previous '
           'upload fail?\ngit-cl try always uses latest patchset from rietveld. '
           'Continuing using\npatchset %s.\n' % options.patchset)
   try:
     jobs = fetch_try_jobs(auth_config, cl, options)
   except BuildbucketResponseException as ex:
     print('Buildbucket error: %s' % ex)
     return 1
   except Exception as e:
     stacktrace = (''.join(traceback.format_stack()) + traceback.format_exc())
     print('ERROR: Exception when trying to fetch try jobs: %s\n%s' %
           (e, stacktrace))
     return 1
-  print_try_jobs(options, jobs)
+  if options.json:
+    write_try_results_json(options.json, jobs)
+  else:
+    print_try_jobs(options, jobs)
   return 0
 
 
 @subcommand.usage('[new upstream branch]')
 def CMDupstream(parser, args):
   """Prints or sets the name of the upstream branch, if any."""
   _, args = parser.parse_args(args)
   if len(args) > 1:
     parser.error('Unrecognized args: %s' % ' '.join(args))
 
@@ skipping 428 matching lines @@
 if __name__ == '__main__':
   # These affect sys.stdout so do it outside of main() to simplify mocks in
   # unit testing.
   fix_encoding.fix_encoding()
   setup_color.init()
   try:
     sys.exit(main(sys.argv[1:]))
   except KeyboardInterrupt:
     sys.stderr.write('interrupted\n')
     sys.exit(1)