Waterfall components of regression range finder.

appengine/findit/waterfall/process_base_swarming_task_result_pipeline.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.
 
 from collections import defaultdict
 import datetime
 import logging
 import time
 
 from common.http_client_appengine import HttpClientAppengine as HttpClient
 from common.pipeline_wrapper import BasePipeline
 from model import analysis_status
 from model.wf_swarming_task import WfSwarmingTask
 from waterfall import swarming_util
 from waterfall import waterfall_config
 
 
-def _CheckTestsRunStatuses(output_json):
-  """Checks result status for each test run and saves the numbers accordingly.
-
-  Args:
-    output_json (dict): A dict of all test results in the swarming task.
-
-  Returns:
-    tests_statuses (dict): A dict of different statuses for each test.
-
-  Currently for each test, we are saving number of total runs,
-  number of succeeded runs and number of failed runs.
-  """
-  tests_statuses = defaultdict(lambda: defaultdict(int))
-  if output_json:
-    for iteration in output_json.get('per_iteration_data'):
-      for test_name, tests in iteration.iteritems():
-        tests_statuses[test_name]['total_run'] += len(tests)
-        for test in tests:
-          tests_statuses[test_name][test['status']] += 1
-
-  return tests_statuses
-
-
-def _ConvertDateTime(time_string):
-  """Convert UTC time string to datetime.datetime."""
-  # Match the time convertion with swarming.py.
-  # According to swarming.py,
-  # when microseconds are 0, the '.123456' suffix is elided.
-  if not time_string:
-    return None
-  for fmt in ('%Y-%m-%dT%H:%M:%S.%f', '%Y-%m-%dT%H:%M:%S'):
-    try:
-      return datetime.datetime.strptime(time_string, fmt)
-    except ValueError:
-      pass
-  raise ValueError('Failed to parse %s' % time_string)  # pragma: no cover
-
-
-class ProcessSwarmingTaskResultPipeline(BasePipeline):
+class ProcessBaseSwarmingTaskResultPipeline(BasePipeline): # pragma: no cover

[lijeffrey, 2016/07/26 20:49:02]

are you sure you want to no cover this whole class?

[caiw, 2016/07/26 21:09:01]

Yes - the problem is that it's basically impossible to actually to test this
class on its own, so I am just testing it in the process_flake..._test.py file,
but the check for test coverage doesn't count that. 

   """A pipeline for monitoring swarming task and processing task result.
 
   This pipeline waits for result for a swarming task and processes the result to
   generate a dict for statuses for each test run.
   """
 
   HTTP_CLIENT = HttpClient()
+
+  def _CheckTestsRunStatuses(self, output_json):
+    # Checks result status for each test run and saves the numbers accordingly.
+    # Should be overridden by subclass.
+    raise NotImplementedError
+
+  def _ConvertDateTime(self, time_string):

[lijeffrey, 2016/07/26 20:49:02]

is there a reason for moving this into the class? In this case it probably
doesn't matter, just wondering why you've designed it this way

[caiw, 2016/07/26 21:09:01]

Yes - it makes it easier to extend the class, which is the point of refactoring
into base.

+    """Convert UTC time string to datetime.datetime."""
+    # Match the time convertion with swarming.py.
+    # According to swarming.py,
+    # when microseconds are 0, the '.123456' suffix is elided.
+    if not time_string:
+      return None
+    for fmt in ('%Y-%m-%dT%H:%M:%S.%f', '%Y-%m-%dT%H:%M:%S'):
+      try:
+        return datetime.datetime.strptime(time_string, fmt)
+      except ValueError:
+        pass
+    raise ValueError('Failed to parse %s' % time_string)  # pragma: no cover
+
+  def _GetSwarmingTask(self):
+    # Get the appropriate kind of Swarming Task (Wf or Flake).
+    # Should be overwritten by subclass.
+    raise NotImplementedError

[lijeffrey, 2016/07/26 20:49:02]

you should be able to do

raise NotImplementedError('some message where it should be implemented instead')

[caiw, 2016/07/26 21:09:01]

Done.

+
+  def _GetArgs(self):
+    # Return list of arguments to call _CheckTestsRunStatuses with - output_json
+    # Should be overwritten by subclass.
+    raise NotImplementedError
+
   # Arguments number differs from overridden method - pylint: disable=W0221
-  def run(self, master_name, builder_name, build_number, step_name, task_id):
+  def run(self, master_name, builder_name, build_number,
+          step_name, task_id, *args):
     """
     Args:
       master_name (str): The master name.
       builder_name (str): The builder name.
       build_number (str): The build number.
       step_name (str): The failed test step name.
       task_id (str): Id for the swarming task which is triggered by Findit.
 
     Returns:
       A dict of lists for reliable/flaky tests.
     """
-
+    call_args = self._GetArgs(master_name, builder_name, build_number,
+                              step_name, *args)
     assert task_id
     timeout_hours = waterfall_config.GetSwarmingSettings().get(
         'task_timeout_hours')
     deadline = time.time() + timeout_hours * 60 * 60
     server_query_interval_seconds = waterfall_config.GetSwarmingSettings().get(
         'server_query_interval_seconds')
-
     task_started = False
     task_completed = False
     tests_statuses = {}
     step_name_no_platform = None
 
     while not task_completed:
       # Keeps monitoring the swarming task, waits for it to complete.
       data = swarming_util.GetSwarmingTaskResultById(
           task_id, self.HTTP_CLIENT)
       task_state = data['state']
       step_name_no_platform = swarming_util.GetTagValue(
           data.get('tags', {}), 'ref_name')
       if task_state not in swarming_util.STATES_RUNNING:
         task_completed = True
-        task = WfSwarmingTask.Get(
-            master_name, builder_name, build_number, step_name)
+        task = self._GetSwarmingTask(*call_args)
         if task_state == swarming_util.STATE_COMPLETED:
           outputs_ref = data.get('outputs_ref')
           output_json = swarming_util.GetSwarmingTaskFailureLog(
               outputs_ref, self.HTTP_CLIENT)
-          tests_statuses = _CheckTestsRunStatuses(output_json)
-
+          # This following line will not be compatible!

[lijeffrey, 2016/07/26 20:49:02]

why not? Should there be a TODO here to fix it?

[caiw, 2016/07/26 21:09:01]

oops - I think that was just a comment I forgot to delete.  I think it should be
Ok.

+          tests_statuses = self._CheckTestsRunStatuses(
+              output_json, *call_args)
           task.status = analysis_status.COMPLETED
           task.tests_statuses = tests_statuses
         else:
           task.status = analysis_status.ERROR
           logging.error('Swarming task stopped with status: %s' % (
               task_state))
         priority_str = swarming_util.GetTagValue(
             data.get('tags', {}), 'priority')
         if priority_str:
           task.parameters['priority'] = int(priority_str)
         task.put()
       else:  # pragma: no cover
         if task_state == 'RUNNING' and not task_started:
           # swarming task just starts, update status.
           task_started = True
-          task = WfSwarmingTask.Get(
-              master_name, builder_name, build_number, step_name)
+          task = self._GetSwarmingTask(*call_args)
           task.status = analysis_status.RUNNING
           task.put()
-
         time.sleep(server_query_interval_seconds)
-
       if time.time() > deadline:
         # Updates status as ERROR.
-        task = WfSwarmingTask.Get(
-            master_name, builder_name, build_number, step_name)
+        task = self._GetSwarmingTask(*call_args)
         task.status = analysis_status.ERROR
         task.put()
         logging.error('Swarming task timed out after %d hours.' % timeout_hours)
         break  # Stops the loop and return.
-
     # Update swarming task metadate.
-    task = WfSwarmingTask.Get(
-        master_name, builder_name, build_number, step_name)
-    task.created_time = _ConvertDateTime(data.get('created_ts'))
-    task.started_time = _ConvertDateTime(data.get('started_ts'))
-    task.completed_time = _ConvertDateTime(data.get('completed_ts'))
+    task = self._GetSwarmingTask(*call_args)
+    task.created_time = self._ConvertDateTime(data.get('created_ts'))
+    task.started_time = self._ConvertDateTime(data.get('started_ts'))
+    task.completed_time = self._ConvertDateTime(data.get('completed_ts'))
     task.put()
 
-    return step_name, (step_name_no_platform, task.classified_tests)
+    return step_name, step_name_no_platform