[Findit] Hook up analysis for CQ flakes.

appengine/findit/waterfall/flake/flake_analysis_service.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 logging
 
-def ScheduleAnalysisForFlake(
-    _request, _user_email, _is_admin):  # pragma: no cover.
+from common import constants
+from model.flake.flake_analysis_request import FlakeAnalysisRequest
+from waterfall.flake import initialize_flake_pipeline
+from waterfall.flake import step_mapper
+
+
+def _CheckFlakeSwarmedAndSupported(request):
+  """Checks if the flake is Swarmed and supported in any build step.
+
+  Args:
+    request (FlakeAnalysisRequest): The request to analyze a flake.
+
+  Returns:
+    (swarmed, supported, build_step)
+    swarmed(bool): True if any step is Swarmed.
+    supported(bool): True if any step is supported (Swarmed Gtest).
+    build_step(BuildStep): The representative step that is Swarmed Gtest.
+  """
+  build_step = None
+  swarmed = False
+  supported = False
+  for step in request.build_steps:
+    swarmed = swarmed or step.swarmed
+    supported = supported or step.supported
+    if step.supported:
+      build_step = step
+      break
+  return swarmed, supported, build_step
+
+
+def _MergeNewRequestIntoExistingOne(new_request, previous_request):
+  """Merges the new request into the previous request.
+
+  Args:
+    new_request (FlakeAnalysisRequest): The request to analyze a flake.
+    previous_request (FlakeAnalysisRequest): The previous request in record.
+
+  Returns:
+    (version_number, build_step)
+    version_number (int): The version of the FlakeAnalysisRequest if a new
+        analysis is needed; otherwise 0.
+    build_step (BuildStep): a BuildStep instance if a new analysis is needed;
+        otherwise None.
+  """
+  # If no bug is attached to the previous analysis or the new request, or both
+  # are attached to the same bug, start a new analysis with a different
+  # configuration. For a configuration that was analyzed 7 days ago, reset it
+  # to use the new reported step of the same configuration.
+  # TODO: move this setting to config.
+  seconds_n_days = 7 * 24 * 60 * 60  # 7 days.
+  candidate_supported_steps = []
+  need_updating = False
+  for step in new_request.build_steps:
+    existing_step = None
+    for s in previous_request.build_steps:
+      if (step.master_name == s.master_name and
+          step.builder_name == s.builder_name):
+        existing_step = s
+        break
+
+    if existing_step:
+      # If last reported flake at the existing step was too long ago, drop it
+      # so that the new one is recorded.
+      time_diff = step.reported_time - existing_step.reported_time
+      if time_diff.total_seconds() > seconds_n_days:
+        previous_request.build_steps.remove(existing_step)
+        existing_step = None
+
+    if not existing_step:
+      need_updating = True
+      previous_request.build_steps.append(step)
+      if step.supported:
+        candidate_supported_steps.append(step)
+
+  if not candidate_supported_steps:
+    # Find some existing configuration that is not analyzed yet.
+    for s in previous_request.build_steps:
+      if not s.scheduled and s.supported:
+        candidate_supported_steps.append(s)
+
+  supported_build_step = None
+  if candidate_supported_steps:
+    supported_build_step = candidate_supported_steps[0]
+    previous_request.swarmed = (previous_request.swarmed or
+                                supported_build_step.swarmed)
+    previous_request.supported = True
+    need_updating = True
+
+  if supported_build_step and not previous_request.is_step:
+    supported_build_step.scheduled = True  # This will be analyzed.
+
+  if not previous_request.bug_id:  # No bug was attached before.
+    previous_request.bug_id = new_request.bug_id
+    need_updating = True
+
+  previous_request.user_emails = sorted(
+      set(previous_request.user_emails + new_request.user_emails))
+
+  if need_updating:
+    # TODO: update in a transaction.
+    previous_request.put()
+
+  if not supported_build_step or previous_request.is_step:
+    # No new analysis if:
+    # 1. All analyzed steps are fresh enough and cover all the steps in the
+    #    request.
+    # 2. No representative step is Swarmed Gtest.
+    # 3. The flake is a step-level one.
+    return 0, None
+
+  return previous_request.version_number, supported_build_step
+
+
+def _CheckForNewAnalysis(request):
+  """Checks if a new analysis is needed for the requested flake.
+
+  Args:
+    request (FlakeAnalysisRequest): The request to analyze a flake.
+
+  Returns:
+    (version_number, build_step)
+    version_number (int): The version of the FlakeAnalysisRequest if a new
+        analysis is needed; otherwise 0.
+    build_step (BuildStep): a BuildStep instance if a new analysis is needed;
+        otherwise None.
+  """
+  previous_request = FlakeAnalysisRequest.GetVersion(key=request.name)
+  if not previous_request or (previous_request.bug_id and request.bug_id and
+                              previous_request.bug_id != request.bug_id):
+    # If no existing analysis or last analysis was for a different bug, randomly
+    # pick one configuration for a new analysis.
+    if previous_request:
+      # Make a copy to preserve the version number of previous analysis and
+      # prevent concurrent analyses of the same flake.
+      previous_request.CopyFrom(request)
+      request = previous_request
+
+    swarmed, supported, supported_build_step = _CheckFlakeSwarmedAndSupported(
+        request)
+    request.swarmed = swarmed
+    request.supported = supported
+
+    if supported_build_step and not request.is_step:
+      supported_build_step.scheduled = True  # This step will be analyzed.
+
+    # For unsupported or step-level flakes, still save them for monitoring.
+    _, saved = request.Save(retry_on_conflict=False)  # Create a new version.
+
+    if not saved or not supported_build_step or request.is_step:
+      # No new analysis if:
+      # 1. Another analysis was just triggered.
+      # 2. No representative step is Swarmed Gtest.
+      # 3. The flake is a step-level one.
+      return 0, None
+
+    return request.version_number, supported_build_step
+  else:
+    # If no bug is attached to the previous analysis or the new request, or both
+    # are attached to the same bug, start a new analysis with a different
+    # configuration. For a configuration that was analyzed 7 days ago, reset it
+    # to use the new reported step of the same configuration.
+    # TODO: move this setting to config.
+    return _MergeNewRequestIntoExistingOne(request, previous_request)
+
+
+def _IsAuthorizedUser(user_email):
+  """Returns True if the given user email account  is authorized for access."""
+  return user_email and (
+      user_email in constants.WHITELISTED_APP_ACCOUNTS or
+      user_email.endswith('@google.com'))
+
+
+def ScheduleAnalysisForFlake(request, user_email, is_admin):
   """Schedules an analysis on the flake in the given request if needed.
 
   Args:
     request (FlakeAnalysisRequest): The request to analyze a flake.
     user_email (str): The email of the requester.
     is_admin (bool): Whether the requester is an admin.
 
   Returns:
-    An instance of MasterFlakeAnalysis if an analysis was scheduled; otherwise
-    None if no analysis was scheduled before and the user has no permission to.
+    True if an analysis was scheduled; False if a new analysis is not needed;
+    None if the user has no permission to.
   """
-  # TODO (stgao): hook up with analysis.
+  assert len(request.build_steps) > 0, 'At least 1 build step is needed!'
+
+  if not is_admin and not _IsAuthorizedUser(user_email):
+    return None
+  request.user_emails = [user_email]
+
+  manually_triggered = user_email.endswith('@google.com')
+
+  for build_step in request.build_steps:
+    step_mapper.FindMatchingWaterfallStep(build_step)
+
+  version_number, build_step = _CheckForNewAnalysis(request)
+  if version_number and build_step:
+    # A new analysis is needed.
+    logging.info('A new analysis is needed for: %s', build_step)
+    analysis = initialize_flake_pipeline.ScheduleAnalysisIfNeeded(
+        build_step.wf_master_name, build_step.wf_builder_name,
+        build_step.wf_build_number, build_step.wf_step_name,
+        request.name, allow_new_analysis=True,
+        manually_triggered=manually_triggered,
+        queue_name=constants.WATERFALL_ANALYSIS_QUEUE)
+    if analysis:
+      # TODO: put this in a transaction.
+      request = FlakeAnalysisRequest.GetVersion(
+          key=request.name, version=version_number)
+      request.analyses.append(analysis.key)
+      request.put()
+      logging.info('A new analysis was triggered successfully: %s',
+                   analysis.key)
+      return True
+    else:
+      logging.info('But no new analysis was not triggered!')
+  else:
+    logging.info('No new analysis is needed: %s', request)
+
   return False