[Findit] Fix flaky tests due to importing pytz.

appengine/findit/waterfall/flake/test/recursive_flake_pipeline_test.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 datetime import datetime
-
-import pytz
+import mock
 
 from common import constants
 from common.pipeline_wrapper import pipeline_handlers
 from model import analysis_status
 from model.flake.flake_swarming_task import FlakeSwarmingTask
 from model.flake.master_flake_analysis import DataPoint
 from model.flake.master_flake_analysis import MasterFlakeAnalysis
 from waterfall.flake import recursive_flake_pipeline
 from waterfall.flake.recursive_flake_pipeline import get_next_run
 from waterfall.flake.recursive_flake_pipeline import NextBuildNumberPipeline
@@ skipping 30 matching lines @@
       data_points.append(data_point)
     return data_points
 
   def testGetETAToStartAnalysisWhenManuallyTriggered(self):
     mocked_utcnow = datetime.utcnow()
     self.MockUTCNow(mocked_utcnow)
     self.assertEqual(mocked_utcnow,
                      recursive_flake_pipeline._GetETAToStartAnalysis(True))
 
   def testGetETAToStartAnalysisWhenTriggeredOnPSTWeekend(self):
-    # Sunday 1pm in PST.
-    mocked_utcnow = datetime(2016, 9, 04, 20, 0, 0, 0, pytz.utc)
-    self.MockUTCNow(mocked_utcnow)
-    self.MockUTCNowWithTimezone(mocked_utcnow)
-    self.assertEqual(mocked_utcnow,
-                     recursive_flake_pipeline._GetETAToStartAnalysis(False))
+    # Sunday 1pm in PST, and Sunday 8pm in UTC.
+    mocked_pst_now = datetime(2016, 9, 04, 13, 0, 0, 0)
+    mocked_utc_now = datetime(2016, 9, 04, 20, 0, 0, 0)
+    self.MockUTCNow(mocked_utc_now)
+    self.MockUTCNowWithTimezone(mocked_utc_now)
+    with mock.patch('common.time_util.GetDatetimeInTimezone') as timezone_func:
+      timezone_func.side_effect = [mocked_pst_now, None]
+      self.assertEqual(mocked_utc_now,
+                       recursive_flake_pipeline._GetETAToStartAnalysis(False))
 
   def testGetETAToStartAnalysisWhenTriggeredOffPeakHoursOnPSTWeekday(self):
-    # Tuesday 1am in PST.
-    mocked_utcnow = datetime(2016, 9, 20, 8, 0, 0, 0, pytz.utc)
-    self.MockUTCNow(mocked_utcnow)
-    self.MockUTCNowWithTimezone(mocked_utcnow)
-    self.assertEqual(mocked_utcnow,
-                     recursive_flake_pipeline._GetETAToStartAnalysis(False))
+    # Tuesday 1am in PST, and Tuesday 8am in UTC.
+    mocked_pst_now = datetime(2016, 9, 20, 1, 0, 0, 0)
+    mocked_utc_now = datetime(2016, 9, 20, 8, 0, 0, 0)
+    self.MockUTCNow(mocked_utc_now)
+    self.MockUTCNowWithTimezone(mocked_utc_now)
+    with mock.patch('common.time_util.GetDatetimeInTimezone') as timezone_func:
+      timezone_func.side_effect = [mocked_pst_now, None]
+      self.assertEqual(mocked_utc_now,
+                       recursive_flake_pipeline._GetETAToStartAnalysis(False))
 
   def testGetETAToStartAnalysisWhenTriggeredInPeakHoursOnPSTWeekday(self):
-    # Tuesday 1pm in PST.
-    mocked_utcnow = datetime(2016, 9, 20, 20, 0, 0, 0, pytz.utc)
-    self.MockUTCNow(mocked_utcnow)
-    self.MockUTCNowWithTimezone(mocked_utcnow)
-    eta = recursive_flake_pipeline._GetETAToStartAnalysis(False)
-    self.assertEqual(2016, eta.year)
-    self.assertEqual(9, eta.month)
-    self.assertEqual(21, eta.day)
-    self.assertEqual(1, eta.hour)
-    seconds = eta.minute * 60 + eta.second
-    self.assertTrue(seconds >= 0 and seconds <= 30 * 60)
+    # Tuesday 1pm in PST, and Tuesday 8pm in UTC.
+    mocked_pst_now = datetime(2016, 9, 20, 13, 0, 0, 0)
+    mocked_utc_now = datetime(2016, 9, 20, 20, 0, 0, 0)
+    mocked_pst_eta = datetime(2016, 9, 20, 18, 0, 10, 0)  # With random delay.

[lijeffrey, 2016/10/04 18:17:49]

nit: instead of saying "random" delay which makes it sound like it should be
generated randomly at run time when it's actually hard-coded, how about say
"with arbitrary delay of 10 seconds."?

Same with the other comment below.

[stgao, 2016/10/04 18:27:28]

Done.

+    mocked_utc_eta = datetime(2016, 9, 21, 1, 0, 0, 0)  # Without random delay.
+    self.MockUTCNow(mocked_utc_now)
+    self.MockUTCNowWithTimezone(mocked_utc_now)
+    with mock.patch('common.time_util.GetDatetimeInTimezone') as (
+        timezone_func), mock.patch('random.randint') as random_func:
+      timezone_func.side_effect = [mocked_pst_now, mocked_utc_eta]
+      random_func.side_effect = [10, None]

[lijeffrey, 2016/10/04 18:17:49]

nit: is this 10 the same "random" delay as in 82? If so, how about factor it out
into a variable to make this test more clear?

[stgao, 2016/10/04 18:27:28]

Done.

+      self.assertEqual(mocked_utc_eta,
+                       recursive_flake_pipeline._GetETAToStartAnalysis(False))
+      self.assertEqual(2, timezone_func.call_count)
+      self.assertEqual(mock.call('US/Pacific', mocked_utc_now),
+                       timezone_func.call_args_list[0])
+      self.assertEqual(mock.call('UTC', mocked_pst_eta),
+                       timezone_func.call_args_list[1])
 
   def testRecursiveFlakePipeline(self):
     master_name = 'm'
     builder_name = 'b'
     master_build_number = 100
     build_number = 100
     run_build_number = 100
     step_name = 's'
     test_name = 't'
     test_result_future = 'test_result_future'
@@ skipping 44 matching lines @@
         expected_kwargs={'manually_triggered': False})
 
     rfp = RecursiveFlakePipeline(
         master_name, builder_name, build_number, step_name, test_name,
         analysis.version_number, master_build_number,
         flakiness_algorithm_results_dict=flakiness_algorithm_results_dict)
 
     rfp.start(queue_name=queue_name)
     self.execute_queued_tasks()
 
-  def testNextBuildPipelineForNewRecursionFirstFlake(self):
+  @mock.patch.object(
+      recursive_flake_pipeline, '_GetETAToStartAnalysis', return_value=None)
+  def testNextBuildPipelineForNewRecursionFirstFlake(self, _mocked_eta_func):
     master_name = 'm'
     builder_name = 'b'
     master_build_number = 100
     build_number = 100
     step_name = 's'
     test_name = 't'
     test_result_future = 'trf'
     flakiness_algorithm_results_dict = {
         'flakes_in_a_row': 0,
         'stable_in_a_row': 0,
@@ skipping 23 matching lines @@
     analysis.data_points.append(data_point)
     analysis.put()
 
     NextBuildNumberPipeline.run(
         NextBuildNumberPipeline(), master_name, builder_name,
         master_build_number, build_number, step_name, test_name,
         analysis.version_number, test_result_future,
         flakiness_algorithm_results_dict)
     self.assertEquals(flakiness_algorithm_results_dict['flakes_in_a_row'], 1)
 
-  def testNextBuildPipelineForNewRecursionFirstStable(self):
+  @mock.patch.object(
+      recursive_flake_pipeline, '_GetETAToStartAnalysis', return_value=None)
+  def testNextBuildPipelineForNewRecursionFirstStable(self, _mocked_eta_func):
     master_name = 'm'
     builder_name = 'b'
     master_build_number = 100
     build_number = 100
     step_name = 's'
     test_name = 't'
     test_result_future = 'trf'
     flakiness_algorithm_results_dict = {
         'flakes_in_a_row': 0,
         'stable_in_a_row': 0,
@@ skipping 21 matching lines @@
     analysis.data_points.append(data_point)
     analysis.put()
 
     NextBuildNumberPipeline.run(
         NextBuildNumberPipeline(), master_name, builder_name,
         master_build_number, build_number, step_name,
         test_name, analysis.version_number, test_result_future,
         flakiness_algorithm_results_dict)
     self.assertEquals(flakiness_algorithm_results_dict['stable_in_a_row'], 1)
 
-  def testNextBuildPipelineForNewRecursionFlakeInARow(self):
+  @mock.patch.object(
+      recursive_flake_pipeline, '_GetETAToStartAnalysis', return_value=None)
+  def testNextBuildPipelineForNewRecursionFlakeInARow(self, _mocked_eta_func):
     master_name = 'm'
     builder_name = 'b'
     master_build_number = 100
     build_number = 100
     step_name = 's'
     test_name = 't'
     test_result_future = 'trf'
     flakiness_algorithm_results_dict = {
         'flakes_in_a_row': 0,
         'stable_in_a_row': 4,
@@ skipping 22 matching lines @@
     analysis.data_points.append(data_point)
     analysis.put()
 
     NextBuildNumberPipeline.run(
         NextBuildNumberPipeline(), master_name, builder_name,
         master_build_number, build_number, step_name,
         test_name, analysis.version_number, test_result_future,
         flakiness_algorithm_results_dict)
     self.assertEquals(flakiness_algorithm_results_dict['stabled_out'], True)
 
-  def testNextBuildPipelineForNewRecursionStableInARow(self):
+  @mock.patch.object(
+      recursive_flake_pipeline, '_GetETAToStartAnalysis', return_value=None)
+  def testNextBuildPipelineForNewRecursionStableInARow(self, _mocked_eta_func):
     master_name = 'm'
     builder_name = 'b'
     master_build_number = 100
     build_number = 100
     step_name = 's'
     test_name = 't'
     test_result_future = 'trf'
     flakiness_algorithm_results_dict = {
         'flakes_in_a_row': 4,
         'stable_in_a_row': 0,
@@ skipping 22 matching lines @@
     analysis.data_points.append(data_point)
     analysis.put()
 
     NextBuildNumberPipeline.run(
         NextBuildNumberPipeline(), master_name, builder_name,
         master_build_number, build_number, step_name,
         test_name, analysis.version_number, test_result_future,
         flakiness_algorithm_results_dict)
     self.assertEquals(flakiness_algorithm_results_dict['flaked_out'], True)
 
-  def testNextBuildPipelineForNewRecursionLessThanLastBuildNumber(self):
+  @mock.patch.object(
+      recursive_flake_pipeline, '_GetETAToStartAnalysis', return_value=None)
+  def testNextBuildPipelineForNewRecursionLessThanLastBuildNumber(
+      self, _mocked_eta_func):
     master_name = 'm'
     builder_name = 'b'
     master_build_number = 100
     build_number = 100
     step_name = 's'
     test_name = 't'
     test_result_future = 'trf'
     flakiness_algorithm_results_dict = {
         'flakes_in_a_row': 0,
         'stable_in_a_row': 0,
@@ skipping 27 matching lines @@
 
     self.mock(
         recursive_flake_pipeline.RecursiveFlakePipeline, 'start', my_mocked_run)
     NextBuildNumberPipeline.run(
         NextBuildNumberPipeline(), master_name, builder_name,
         master_build_number, build_number, step_name, test_name,
         analysis.version_number, test_result_future,
         flakiness_algorithm_results_dict)
     self.assertFalse(queue_name['x'])
 
-  def testNextBuildPipelineForFailedSwarmingTask(self):
+  @mock.patch.object(
+      recursive_flake_pipeline, '_GetETAToStartAnalysis', return_value=None)
+  def testNextBuildPipelineForFailedSwarmingTask(self, _mocked_eta_func):
     master_name = 'm'
     builder_name = 'b'
     master_build_number = 100
     build_number = 100
     step_name = 's'
     test_name = 't'
     test_result_future = 'trf'
     flakiness_algorithm_results_dict = {
         'flakes_in_a_row': 0,
         'stable_in_a_row': 0,
@@ skipping 27 matching lines @@
       queue_name['x'] = True  # pragma: no cover
 
     self.mock(
         recursive_flake_pipeline.RecursiveFlakePipeline, 'start', my_mocked_run)
     NextBuildNumberPipeline.run(
         NextBuildNumberPipeline(), master_name, builder_name,
         master_build_number, build_number, step_name, test_name, 1,
         test_result_future, flakiness_algorithm_results_dict)
     self.assertFalse(queue_name['x'])
 
-  def testNextBuildPipelineForNewRecursionStabledFlakedOut(self):
+  @mock.patch.object(
+      recursive_flake_pipeline, '_GetETAToStartAnalysis', return_value=None)
+  def testNextBuildPipelineForNewRecursionStabledFlakedOut(
+      self, _mocked_eta_func):
     master_name = 'm'
     builder_name = 'b'
     master_build_number = 100
     build_number = 100
     step_name = 's'
     test_name = 't'
     test_result_future = 'trf'
     queue_name = constants.DEFAULT_QUEUE
     flakiness_algorithm_results_dict = {
         'flakes_in_a_row': 4,
@@ skipping 230 matching lines @@
         'last_build_number': 0,
         'lower_boundary': 100,
         'upper_boundary': 110,
         'lower_boundary_result': 'STABLE',
         'sequential_run_index': 1
     }
     next_run = sequential_next_run(analysis, flakiness_algorithm_results_dict)
     self.assertEqual(next_run, 102)
     self.assertEqual(analysis.suspected_flake_build_number, None)
 
-  def testNextBuildPipelineStabledOutFlakedOutFirstTime(self):
+  @mock.patch.object(
+      recursive_flake_pipeline, '_GetETAToStartAnalysis', return_value=None)
+  def testNextBuildPipelineStabledOutFlakedOutFirstTime(self, _mocked_eta_func):
     master_name = 'm'
     builder_name = 'b'
     master_build_number = 100
     build_number = 100
     step_name = 's'
     test_name = 't'
     test_result_future = 'trf'
     flakiness_algorithm_results_dict = {
         'flakes_in_a_row': 0,
         'stable_in_a_row': 0,
@@ skipping 155 matching lines @@
     pipeline = NextBuildNumberPipeline()
     pipeline.run(
         master_name, builder_name,
         master_build_number, build_number, step_name, test_name,
         analysis.version_number, test_result_future,
         flakiness_algorithm_results_dict)
 
     analysis = MasterFlakeAnalysis.GetVersion(
         master_name, builder_name, master_build_number, step_name, test_name)
     self.assertEqual(analysis_status.COMPLETED, analysis.status)