Add CIPD pin reporting to swarming.

appengine/swarming/server/task_request.py

 # coding: utf-8
 # Copyright 2014 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.
 
 """Tasks definition.
 
 Each user request creates a new TaskRequest. The TaskRequest instance saves the
 metadata of the request, e.g. who requested it, when why, etc. It links to the
 actual data of the request in a TaskProperties. The TaskProperties represents
@@ skipping 274 matching lines @@
     return '%s:%s' % (self.package_name, self.version)
 
   def _pre_put_hook(self):
     super(CipdPackage, self)._pre_put_hook()
     if not self.package_name:
       raise datastore_errors.BadValueError('CIPD package name is required')
     if not self.version:
       raise datastore_errors.BadValueError('CIPD package version is required')
 
 
+PinInfo = collections.namedtuple('PinInfo', ['pkg', 'pin'])
+
+
 class CipdInput(ndb.Model):
   """Specifies which CIPD client and packages to install, from which server.
 
   A part of TaskProperties.
   """
   # URL of the CIPD server. Must start with "https://" or "http://".
   server = ndb.StringProperty(indexed=False, validator=_validate_url)
 
   # CIPD package of CIPD client to use.
   # client_package.version is required.
@@ skipping 21 matching lines @@
       p._pre_put_hook()
       if not p.path:
         raise datastore_errors.BadValueError(
             'package %s:%s: path is required' % (p.package_name, p.version))
       if p.package_name in package_names:
         raise datastore_errors.BadValueError(
            'package %s is specified more than once' % p.package_name)
       package_names.add(p.package_name)
     self.packages.sort(key=lambda p: p.package_name)
 
-  def packages_grouped_by_path(self):
-    """Returns sorted [(path), [package]) list. Used by user_task.html."""
+  def packages_grouped_by_path(self, pins):
+    """Returns sorted [(path, [PinInfo, ...])].
+
+    PinInfo is a namedtuple with two fields 'pkg' and 'pin'. 'pkg' is the
+    CipdPackage that was specified in the task request. 'pin' is the CipdPackage
+    that was resolved by the bot at runtime, and contains a full package name as

[M-A Ruel, 2016/08/24 19:34:07]

This is really part of the result, not the request, so any related function
should be in task_results.py, otherwise it's a layering violation

+    well as a package instance id.
+
+    If pinning information is unavailable, or if 'pkg' already specifies a full
+    pin, 'pin' is None. If 'version' or 'package_name' are the same between
+    'pkg' and 'pin', then the field in 'pin' is None.
+
+    Args:
+      pins - a list of CipdPackages which represent the pin counterparts of
+        self.packages.
+
+    Used by user_task.html.
+    """
+    assert pins is None or len(pins) == len(self.packages)
+    pinned = pins is not None
+
     packages = collections.defaultdict(list)
-    for p in self.packages:
-      packages[p.path].append(p)
+    for i, pkg in enumerate(self.packages):
+      pin = None
+      if pinned:
+        pin = pins[i]
+        if pkg.package_name == pin.package_name:
+          pin.package_name = None
+        if pkg.version == pin.version:
+          pin.version = None
+        if pin.package_name is None and pin.version is None:
+          pin = None
+      packages[pkg.path].append(PinInfo(pkg, pin))
     for pkgs in packages.itervalues():
-      pkgs.sort()
+      pkgs.sort(key=lambda x: (
+        x.pkg.package_name, x.pkg.version,
+        getattr(x.pin, 'package_name', None), getattr(x.pin, 'version', None)))
     return sorted(packages.iteritems())
 
 
 class TaskProperties(ndb.Model):
   """Defines all the properties of a task to be run on the Swarming
   infrastructure.
 
   This entity is not saved in the DB as a standalone entity, instead it is
   embedded in a TaskRequest.
 
@@ skipping 438 matching lines @@
   init_new_request(request, allow_high_priority)
   return request
 
 
 def validate_priority(priority):
   """Throws ValueError if priority is not a valid value."""
   if 0 > priority or MAXIMUM_PRIORITY < priority:
     raise datastore_errors.BadValueError(
         'priority (%d) must be between 0 and %d (inclusive)' %
         (priority, MAXIMUM_PRIORITY))