[pinpoint] Post bug comments when a job starts and completes.

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
 from google.appengine.ext import ndb
 
+from dashboard.common import utils
 from dashboard.pinpoint import mann_whitney_u
 from dashboard.pinpoint.models import attempt as attempt_module
 from dashboard.pinpoint.models import change as change_module
 from dashboard.pinpoint.models import quest as quest_module
+from dashboard.services import issue_tracker_service
 
 
 # We want this to be fast to minimize overhead while waiting for tasks to
 # finish, but don't want to consume too many resources.
 _TASK_INTERVAL = 10
 
 
 _DEFAULT_MAX_ATTEMPTS = 2
 _SIGNIFICANCE_LEVEL = 0.5
 
@@ skipping 31 matching lines @@
   # Request parameters.
   configuration = ndb.StringProperty(required=True)
   test_suite = ndb.StringProperty()
   test = ndb.StringProperty()
   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()

[perezju, 2017/06/29 09:03:30]

Note that, probably, we would still want to maintain some relation between bugs
and pinpoint jobs; but yeah, this is something to flesh out in the future.

+
   state = ndb.PickleProperty(required=True)
 
   @classmethod
-  def New(cls, configuration, test_suite, test, metric, auto_explore):
+  def New(cls, configuration, test_suite, test, metric, 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))
     if metric:
       quests.append(quest_module.ReadValue(metric, test))
 
     # Create job.
     return cls(
         configuration=configuration,
         test_suite=test_suite,
         test=test,
         metric=metric,
         auto_explore=auto_explore,
+        bug_id=bug_id,
         state=_JobState(quests, _DEFAULT_MAX_ATTEMPTS))
 
   @property
   def job_id(self):
     return self.key.urlsafe()
 
   @property
   def status(self):
     if self.task:
       return 'Running'
 
     if self.exception:
       return 'Failed'
 
     return 'Completed'
 
+  @property
+  def url(self):
+    return 'https://%s/job/%s' % (os.environ['HTTP_HOST'], self.job_id)
+
   def AddChange(self, change):
     self.state.AddChange(change)
 
   def Start(self):
+    self.Schedule()
+
+    comment = 'Pinpoint job started.\n' + self.url
+    issue_tracker = issue_tracker_service.IssueTrackerService(
+        utils.ServiceAccountHttp())
+    issue_tracker.AddBugComment(self.bug_id, comment, send_email=False)
+
+  def Complete(self):
+    comment = 'Pinpoint job complete!\n' + self.url
+    issue_tracker = issue_tracker_service.IssueTrackerService(
+        utils.ServiceAccountHttp())
+    issue_tracker.AddBugComment(self.bug_id, comment, send_email=False)
+
+  def Schedule(self):
     task = taskqueue.add(queue_name='job-queue', url='/api/run/' + self.job_id,
                          countdown=_TASK_INTERVAL)
     self.task = task.name
 
   def Run(self):
     self.exception = None  # In case the Job succeeds on retry.
     self.task = None  # In case an exception is thrown.
 
     try:
       if self.auto_explore:
         self.state.Explore()
       work_left = self.state.ScheduleWork()
 
       # Schedule moar task.
       if work_left:
-        self.Start()
+        self.Schedule()
+      else:
+        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,
@@ skipping 185 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)