Add CIPD pin reporting to swarming.

appengine/swarming/handlers_bot.py

 # Copyright 2015 The LUCI Authors. All rights reserved.
 # Use of this source code is governed under the Apache License, Version 2.0
 # that can be found in the LICENSE file.
 
 """Internal bot API handlers."""
 
 import base64
 import json
 import logging
 import re
@@ skipping 614 matching lines @@
     self.send_response({})
 
 
 class BotTaskUpdateHandler(_BotApiHandler):
   """Receives updates from a Bot for a task.
 
   The handler verifies packets are processed in order and will refuse
   out-of-order packets.
   """
   ACCEPTED_KEYS = {
-    u'bot_overhead', u'cipd_stats', u'cost_usd', u'duration', u'exit_code',
-    u'hard_timeout', u'id', u'io_timeout', u'isolated_stats', u'output',
-    u'output_chunk_start', u'outputs_ref', u'task_id',
+    u'bot_overhead', u'cipd_pins', u'cipd_stats', u'cost_usd', u'duration',
+    u'exit_code', u'hard_timeout', u'id', u'io_timeout', u'isolated_stats',
+    u'output', u'output_chunk_start', u'outputs_ref', u'task_id',
   }
   REQUIRED_KEYS = {u'id', u'task_id'}
 
   @auth.public  # auth happens in bot_auth.validate_bot_id_and_fetch_config()
   def post(self, task_id=None):
     # Unlike handshake and poll, we do not accept invalid keys here. This code
     # path is much more strict.
     request = self.parse_body()
     msg = log_unexpected_subset_keys(
         self.ACCEPTED_KEYS, self.REQUIRED_KEYS, request, self.request, 'bot',
         'keys')
     if msg:
       self.abort_with_error(400, error=msg)
 
     bot_id = request['id']
     task_id = request['task_id']
 
     # Make sure bot self-reported ID matches the authentication token. Raises
     # auth.AuthorizationError if not.
     bot_auth.validate_bot_id_and_fetch_config(bot_id)
 
     bot_overhead = request.get('bot_overhead')
+    cipd_pins = request.get('cipd_pins')
+    cipd_stats = request.get('cipd_stats')
     cost_usd = request.get('cost_usd', 0)
     duration = request.get('duration')
     exit_code = request.get('exit_code')
     hard_timeout = request.get('hard_timeout')
     io_timeout = request.get('io_timeout')
     isolated_stats = request.get('isolated_stats')
-    cipd_stats = request.get('cipd_stats')
     output = request.get('output')
     output_chunk_start = request.get('output_chunk_start')
     outputs_ref = request.get('outputs_ref')
 
     if (isolated_stats or cipd_stats) and bot_overhead is None:
       ereporter2.log_request(
           request=self.request,
           source='server',
           category='task_failure',
           message='Failed to update task: %s' % task_id)
@@ skipping 36 matching lines @@
         logging.error('Failed to decode output\n%s\n%r', e, output)
         output = output.encode('ascii', 'replace')
       except TypeError as e:
         # Save the output as-is instead. The error will be logged in ereporter2
         # and returning a HTTP 500 would only force the bot to stay in a retry
         # loop.
         logging.error('Failed to decode output\n%s\n%r', e, output)
     if outputs_ref:
       outputs_ref = task_request.FilesRef(**outputs_ref)
 
+    if cipd_pins:
+      cipd_pins = task_result.CipdPins(
+        client_package=task_request.CipdPackage(
+            **cipd_pins['client_package']),
+        packages=[
+            task_request.CipdPackage(**args) for args in cipd_pins['packages']]
+      )
+
     try:
       state = task_scheduler.bot_update_task(
           run_result_key=run_result_key,
           bot_id=bot_id,
           output=output,
           output_chunk_start=output_chunk_start,
           exit_code=exit_code,
           duration=duration,
           hard_timeout=hard_timeout,
           io_timeout=io_timeout,
           cost_usd=cost_usd,
           outputs_ref=outputs_ref,
+          cipd_pins=cipd_pins,
           performance_stats=performance_stats)
       if not state:
         logging.info('Failed to update, please retry')
         self.abort_with_error(500, error='Failed to update, please retry')
 
       if state in (task_result.State.COMPLETED, task_result.State.TIMED_OUT):
         action = 'task_completed'
       elif state == task_result.State.CANCELED:
         action = 'task_canceled'
       else:
@@ skipping 95 matching lines @@
       ('/swarming/api/v1/bot/poll', BotPollHandler),
       ('/swarming/api/v1/bot/server_ping', ServerPingHandler),
       ('/swarming/api/v1/bot/task_update', BotTaskUpdateHandler),
       ('/swarming/api/v1/bot/task_update/<task_id:[a-f0-9]+>',
           BotTaskUpdateHandler),
       ('/swarming/api/v1/bot/task_error', BotTaskErrorHandler),
       ('/swarming/api/v1/bot/task_error/<task_id:[a-f0-9]+>',
           BotTaskErrorHandler),
   ]
   return [webapp2.Route(*i) for i in routes]