[pinpoint] Add QuestGenerator object.

dashboard/dashboard/pinpoint/models/job.py

 # Copyright 2016 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.
 
 import collections
 import logging
 import numbers
 import os
 
 from google.appengine.api import taskqueue
@@ skipping 42 matching lines @@
   # The name of the Task Queue task this job is running on. If it's present, the
   # job is running. The task is also None for Task Queue retries.
   task = ndb.StringProperty()
 
   # The string contents of any Exception that was thrown to the top level.
   # If it's present, the job failed.
   exception = ndb.StringProperty()
 
   # Request parameters.
   configuration = ndb.StringProperty(required=True)
-  test_suite = ndb.StringProperty()
-  test = ndb.StringProperty()
+  target = ndb.StringProperty()
+  test_config = ndb.PickleProperty()

[perezju, 2017/08/07 12:06:12]

nit: wondering whether this should be called target_config??

also wondering whether the target string should be part of the "config" object?

Not sure about either of these, but what are your thoughts?

[dtu, 2017/08/15 17:06:41]

`target` has to be "config" object because it needs to be passed into
FindIsolate().

But then we could also move FindIsolate inside Config.Quests(), making Config
the sole source for the Quest list. Then instead of a "config" object, it's some
kind of QuestGenerator object. That sounds pretty elegant.

[perezju, 2017/08/16 08:15:25]

Nice! This turned out pretty neat!

   metric = ndb.StringProperty()
 
   # If True, the service should pick additional Changes to run (bisect).
   # If False, only run the Changes explicitly added by the user.
   auto_explore = ndb.BooleanProperty(required=True)
 
   # TODO: The bug id is only used for posting bug comments when a job starts and
   # completes. This probably should not be the responsibility of Pinpoint.
   bug_id = ndb.IntegerProperty()
 
   state = ndb.PickleProperty(required=True)
 
   @classmethod
-  def New(cls, configuration, test_suite, test, metric, auto_explore, bug_id):
+  def New(cls, configuration, target, test_config, auto_explore, bug_id):
     # Get list of quests.
     quests = [quest_module.FindIsolate(configuration)]
-    if test_suite:
-      quests.append(quest_module.RunTest(configuration, test_suite, test,
-                                         _DEFAULT_REPEAT_COUNT))
-    if metric:
-      quests.append(quest_module.ReadValue(metric, test))
+    quests += test_config.Quests()
 
     # Create job.
     return cls(
         configuration=configuration,
-        test_suite=test_suite,
-        test=test,
-        metric=metric,
+        target=target,
+        test_config=test_config,
         auto_explore=auto_explore,
         bug_id=bug_id,
         state=_JobState(quests, _DEFAULT_ATTEMPT_COUNT))
 
   @property
   def job_id(self):
     return self.key.urlsafe()
 
   @property
   def status(self):
@@ skipping 47 matching lines @@
         self.Complete()
     except BaseException as e:
       self.exception = str(e)
       raise
 
   def AsDict(self):
     return {
         'job_id': self.job_id,
 
         'configuration': self.configuration,
-        'test_suite': self.test_suite,
-        'test': self.test,
-        'metric': self.metric,
+        'target': self.target,
+        'test_config': self.test_config.AsDict(),
         'auto_explore': self.auto_explore,
 
         'created': self.created.strftime('%Y-%m-%d %H:%M:%S %Z'),
         'updated': self.updated.strftime('%Y-%m-%d %H:%M:%S %Z'),
         'status': self.status,
 
         'state': self.state.AsDict(),
     }
 
 
@@ skipping 173 matching lines @@
   # We want the results_values to provide both a message that can be shown to
   # the user for why something failed, and also something comparable that can
   # be used for bisect. Therefore, they contain the thrown Exceptions. This
   # function then converts them into comparable numbers for bisect.
   if isinstance(obj, numbers.Number):
     return obj
   elif isinstance(obj, Exception):
     return hash(obj.__class__)
   else:
     return hash(obj)