swarming: refactor cipd input

appengine/swarming/server/task_request_test.py

 #!/usr/bin/env python
 # Copyright 2014 The LUCI Authors. All rights reserved.
 # Use of this source code is governed by the Apache v2.0 license that can be
 # found in the LICENSE file.
 
 import datetime
 import logging
-import os
 import random
 import sys
 import unittest
 
 import test_env
 test_env.setup_test_env()
 
 from google.appengine.api import datastore_errors
 from google.appengine.ext import ndb
 
 from components import auth_testing
 from components import utils
+from proto import config_pb2
 from test_support import test_case
 
 from server import task_pack
 from server import task_request
 
 
 # pylint: disable=W0212
 
 
-PINNED_PACKAGE_VERSION = 'deadbeefdeadbeefdeadbeefdeadbeefdeadbeef'
+CIPD_SETTINGS = config_pb2.CipdSettings(
+    server_host='chrome-infra-packages.appspot.com',
+    client_package_name='infra/tools/cipd/${platform}',
+    client_package_version='git_revision:deadbeef')
+PINNED_PACKAGE_VERSION = 'git_revision:deadbeef'
 
 
 def mkreq(req):
   return task_request.make_request(req, True)
 
 
 def _gen_request(properties=None, **kwargs):
   """Creates a TaskRequest."""
   properties = properties or {}
-  packages = properties.pop('packages', [{
-    'package_name': 'rm',
-    'version': PINNED_PACKAGE_VERSION,
-  }])
+
+  def merge(override, defaults):
+    if override is None:
+      return None
+    result = defaults.copy()
+    result.update(override)
+    return result
+
+  cipd_input = merge(properties.pop('cipd_input', {}), {
+    'settings': CIPD_SETTINGS.SerializeToString(),
+    'packages': [{
+      'package_name': 'rm',
+      'version': PINNED_PACKAGE_VERSION,
+    }]
+  })
+
   inputs_ref = properties.pop('inputs_ref', {
     'isolatedserver': 'https://isolateserver.appspot.com',
     'namespace': 'default-gzip',
   })
-  props = {
+
+  properties = merge(properties, {
+    'cipd_input': cipd_input,
     'command': [u'command1', u'arg1'],
-    'packages': [task_request.CipdPackage(**p) for p in packages],
     'dimensions': {
       u'OS': u'Windows-3.1.1',
       u'hostname': u'localhost',
       u'pool': u'default',
     },
     'env': {u'foo': u'bar', u'joe': u'2'},
     'execution_timeout_secs': 30,
     'grace_period_secs': 30,
     'idempotent': False,
     'inputs_ref': inputs_ref,
     'io_timeout_secs': None,
-  }
-  props.update(properties)
+  })
   now = utils.utcnow()
   args = {
     'created_ts': now,
     'name': 'Request name',
     'priority': 50,
-    'properties': task_request.TaskProperties(**props),
+    'properties': properties,
     'expiration_ts': now + datetime.timedelta(seconds=30),
     'tags': [u'tag:1'],
     'user': 'Jesus',
   }
   args.update(kwargs)
+  # Note that ndb model constructor accepts dicts for structured properties.
   return task_request.TaskRequest(**args)
 
 
 class Prop(object):
   _name = 'foo'
 
 
 class TestCase(test_case.TestCase):
   def setUp(self):
     super(TestCase, self).setUp()
@@ skipping 108 matching lines @@
       task_request.validate_request_key(key)
 
   def test_make_request(self):
     # Compare with test_make_request_clone().
     parent = mkreq(_gen_request())
     # Hack: Would need to know about TaskResultSummary.
     parent_id = task_pack.pack_request_key(parent.key) + '1'
     r = _gen_request(properties=dict(idempotent=True), parent_task_id=parent_id)
     request = mkreq(r)
     expected_properties = {
+      'cipd_input': {
+        'settings': CIPD_SETTINGS.SerializeToString(),
+        'packages': [{'package_name': 'rm', 'version': PINNED_PACKAGE_VERSION}],
+      },
       'command': [u'command1', u'arg1'],
       'dimensions': {
         u'OS': u'Windows-3.1.1',
         u'hostname': u'localhost',
         u'pool': u'default',
       },
       'env': {u'foo': u'bar', u'joe': u'2'},
       'extra_args': [],
       'execution_timeout_secs': 30,
       'grace_period_secs': 30,
       'idempotent': True,
       'inputs_ref': {
         'isolated': None,
         'isolatedserver': 'https://isolateserver.appspot.com',
         'namespace': 'default-gzip',
       },
       'io_timeout_secs': None,
-      'packages': [{'package_name': 'rm', 'version': PINNED_PACKAGE_VERSION}],
     }
     expected_request = {
       'authenticated': auth_testing.DEFAULT_MOCKED_IDENTITY,
       'name': u'Request name',
       'parent_task_id': unicode(parent_id),
       'priority': 49,
       'properties': expected_properties,
       # Intentionally hard code the hash value since it has to be deterministic.
       # Other unit tests should use the calculated value.
-      'properties_hash': 'c3e067b4e232be5478e7147bb1f0506477444014',
+      'properties_hash': '2559848c0be0921d34b2f2085a6fb599efc9a8c9',
       'pubsub_topic': None,
       'pubsub_userdata': None,
       'tags': [
         u'OS:Windows-3.1.1',
         u'hostname:localhost',
         u'pool:default',
         u'priority:49',
         u'tag:1',
         u'user:Jesus',
       ],
@@ skipping 12 matching lines @@
         'isolated': '0123456789012345678901234567890123456789',
         'isolatedserver': 'http://localhost:1',
         'namespace': 'default-gzip',
       },
     }))
     # Hack: Would need to know about TaskResultSummary.
     parent_id = task_pack.pack_request_key(parent.key) + '1'
     request = mkreq(_gen_request(
         properties={'idempotent':True}, parent_task_id=parent_id))
     expected_properties = {
+      'cipd_input': {
+        'packages': [{'package_name': 'rm', 'version': PINNED_PACKAGE_VERSION}],
+        'settings': CIPD_SETTINGS.SerializeToString(),
+      },
       'command': [u'command1', u'arg1'],
       'dimensions': {
         u'OS': u'Windows-3.1.1',
         u'hostname': u'localhost',
         u'pool': u'default',
       },
       'env': {u'foo': u'bar', u'joe': u'2'},
       'extra_args': [],
       'execution_timeout_secs': 30,
       'grace_period_secs': 30,
       'idempotent': True,
       'inputs_ref': {
         'isolated': None,
         'isolatedserver': 'https://isolateserver.appspot.com',
         'namespace': 'default-gzip',
       },
       'io_timeout_secs': None,
-      'packages': [{'package_name': 'rm', 'version': PINNED_PACKAGE_VERSION}],
     }
     expected_request = {
       'authenticated': auth_testing.DEFAULT_MOCKED_IDENTITY,
       'name': u'Request name',
       'parent_task_id': unicode(parent_id),
       'priority': 49,
       'properties': expected_properties,
       # Intentionally hard code the hash value since it has to be deterministic.
       # Other unit tests should use the calculated value.
-      'properties_hash': 'c3e067b4e232be5478e7147bb1f0506477444014',
+      'properties_hash': '2559848c0be0921d34b2f2085a6fb599efc9a8c9',
       'pubsub_topic': None,
       'pubsub_userdata': None,
       'tags': [
         u'OS:Windows-3.1.1',
         u'hostname:localhost',
         u'pool:default',
         u'priority:49',
         u'tag:1',
         u'user:Jesus',
       ],
@@ skipping 19 matching lines @@
       _gen_request(parent_task_id='1d69b9f088008810')
 
   def test_make_request_idempotent(self):
     request = mkreq(_gen_request(properties=dict(idempotent=True)))
     as_dict = request.to_dict()
     self.assertEqual(True, as_dict['properties']['idempotent'])
     # Intentionally hard code the hash value since it has to be deterministic.
     # Other unit tests should use the calculated value.
     # Ensure the algorithm is deterministic.
     self.assertEqual(
-        'c3e067b4e232be5478e7147bb1f0506477444014', as_dict['properties_hash'])
+        '2559848c0be0921d34b2f2085a6fb599efc9a8c9', as_dict['properties_hash'])
 
   def test_duped(self):
     # Two TestRequest with the same properties.
     request_1 = mkreq(_gen_request(properties=dict(idempotent=True)))
     now = utils.utcnow()
     request_2 = mkreq(_gen_request(
         name='Other',
         user='Other',
         priority=201,
         created_ts=now,
@@ skipping 26 matching lines @@
 
     with self.assertRaises(datastore_errors.BadValueError):
       mkreq(_gen_request(properties=dict(command=[])))
     with self.assertRaises(datastore_errors.BadValueError):
       mkreq(_gen_request(properties=dict(command={'a': 'b'})))
     with self.assertRaises(datastore_errors.BadValueError):
       mkreq(_gen_request(properties=dict(command='python')))
     mkreq(_gen_request(properties=dict(command=['python'])))
     mkreq(_gen_request(properties=dict(command=[u'python'])))
 
+    def mkcipdreq(idempotent=False, **cipd_input):
+      mkreq(_gen_request(
+          properties=dict(idempotent=idempotent, cipd_input=cipd_input)))
+
     with self.assertRaises(datastore_errors.BadValueError):
-      mkreq(_gen_request(properties=dict(packages=[{}])))
+      mkcipdreq(packages=[{}])
     with self.assertRaises(datastore_errors.BadValueError):
-      mkreq(_gen_request(properties=dict(packages=[dict(package_name='rm')])))
+      mkcipdreq(packages=[dict(package_name='rm')])
     with self.assertRaises(datastore_errors.BadValueError):
-      mkreq(_gen_request(properties=dict(
-          packages=[{'package_name': 'infra|rm', 'version': 'latest'}])))
+      mkcipdreq(packages=[{'package_name': 'infra|rm', 'version': 'latest'}])
     with self.assertRaises(datastore_errors.BadValueError):
-      mkreq(_gen_request(properties=dict(
-        packages=[
-            {'package_name': 'rm', 'version': 'latest'},
-            {'package_name': 'rm', 'version': 'canary'},
-        ])))
+      mkcipdreq(packages=[
+        {'package_name': 'rm', 'version': 'latest'},
+        {'package_name': 'rm', 'version': 'canary'},
+      ])
     with self.assertRaises(datastore_errors.BadValueError):
-      mkreq(_gen_request(properties=dict(
-        idempotent=True,
-        packages=[{'package_name': 'rm', 'version': 'latest'}])))
-    mkreq(_gen_request(properties=dict(
-      packages=[{'package_name': 'rm', 'version': 'latest'}])))
+      mkcipdreq(
+          idempotent=True,
+          packages=[{'package_name': 'rm', 'version': 'latest'}])
+    with self.assertRaises(datastore_errors.BadValueError):
+      mkcipdreq(settings='blablah_invalid_protobuf')
+    mkcipdreq()
+    mkcipdreq(packages=[{'package_name': 'rm', 'version': 'latest'}])
 
     with self.assertRaises(TypeError):
       mkreq(_gen_request(properties=dict(dimensions=[])))
     with self.assertRaises(datastore_errors.BadValueError):
       mkreq(_gen_request(properties=dict(dimensions={})))
     with self.assertRaises(datastore_errors.BadValueError):
       mkreq(_gen_request(
           properties=dict(dimensions={u'id': u'b', u'a:': u'b'})))
     mkreq(_gen_request(
         properties=dict(dimensions={u'id': u'b', u'a.': u'b'})))
@@ skipping 65 matching lines @@
     parent = mkreq(_gen_request())
     # Hack: Would need to know about TaskResultSummary.
     parent_id = task_pack.pack_request_key(parent.key) + '1'
     data = _gen_request(
         properties=dict(idempotent=True), parent_task_id=parent_id)
     request = task_request.make_request_clone(mkreq(data))
     # Differences from make_request() are:
     # - idempotent was reset to False.
     # - parent_task_id was reset to None.
     expected_properties = {
+      'cipd_input': {
+        'settings': CIPD_SETTINGS.SerializeToString(),
+        'packages': [{'package_name': 'rm', 'version': PINNED_PACKAGE_VERSION}],
+      },
       'command': [u'command1', u'arg1'],
       'dimensions': {
         u'OS': u'Windows-3.1.1',
         u'hostname': u'localhost',
         u'pool': u'default',
       },
       'env': {u'foo': u'bar', u'joe': u'2'},
       'execution_timeout_secs': 30,
       'extra_args': [],
       'grace_period_secs': 30,
       'idempotent': False,
       'inputs_ref': {
         'isolated': None,
         'isolatedserver': 'https://isolateserver.appspot.com',
         'namespace': 'default-gzip',
       },
       'io_timeout_secs': None,
-      'packages': [{'package_name': 'rm', 'version': PINNED_PACKAGE_VERSION}],
     }
     # Differences from make_request() are:
     # - parent_task_id was reset to None.
     # - tag 'user:' was replaced
     # - user was replaced.
     expected_request = {
       'authenticated': auth_testing.DEFAULT_MOCKED_IDENTITY,
       'name': u'Request name (Retry #1)',
       'parent_task_id': None,
       'priority': 49,
@@ skipping 54 matching lines @@
         ndb.Key(task_request.TaskRequest, 0x7f14acec2fcfffff),
         task_request.request_id_to_key(0xeb5313d0300000))
 
 
 if __name__ == '__main__':
   if '-v' in sys.argv:
     unittest.TestCase.maxDiff = None
   logging.basicConfig(
       level=logging.DEBUG if '-v' in sys.argv else logging.ERROR)
   unittest.main()