Context TearDown should not invoke ADB if process receives SIGTERM.

The TearDown method on several contexts will invokes ADB. In some instances
[e.g. on receiving a SIGTERM due to timeout] there's a high probability that ADB
is non-responsive. In these cases, sending an ADB command will potentially take
a long time to time out. Before this happens, the process will be hard-killed
for not responding to SIGTERM fast enough.

This CL makes the test_runner.py SIGTERM handler set
allow_adb_on_teardown=False. This prevents these contexts from invoking ADB,
increasing the likelihood that SIGTERM will handled within the 30 second limit
and emit JSON test results.

Bug: 895027
Change-Id: Ic30cff73a82a5415c5f531eae5c8f62fb4c953aa
Reviewed-on: https://chromium-review.googlesource.com/c/1311259Reviewed-by: John Budorick <jbudorick@chromium.org>
Commit-Queue: Erik Chen <erikchen@chromium.org>
Cr-Commit-Position: refs/heads/master@{#604584}

build/android/pylib/base/environment.py

@@ -25,6 +25,9 @@ class Environment(object):
     """
     self._output_manager = output_manager
 
+    # Some subclasses have different teardown behavior on receiving SIGTERM.
+    self._received_sigterm = False
+
   def SetUp(self):
     raise NotImplementedError
 
@@ -41,3 +44,6 @@ class Environment(object):
   @property
   def output_manager(self):
     return self._output_manager
+
+  def ReceivedSigterm(self):
+    self._received_sigterm = True

build/android/pylib/base/test_run.py

@@ -18,6 +18,9 @@ class TestRun(object):
     self._env = env
     self._test_instance = test_instance
 
+    # Some subclasses have different teardown behavior on receiving SIGTERM.
+    self._received_sigterm = False
+
   def TestPackage(self):
     raise NotImplementedError
 
@@ -42,3 +45,6 @@ class TestRun(object):
 
   def __exit__(self, exc_type, exc_val, exc_tb):
     self.TearDown()
+
+  def ReceivedSigterm(self):
+    self._received_sigterm = True

build/android/pylib/local/device/local_device_environment.py

@@ -212,6 +212,14 @@ class LocalDeviceEnvironment(environment.Environment):
     elif self.trace_output:
       self.DisableTracing()
 
+    # By default, teardown will invoke ADB. When receiving SIGTERM due to a
+    # timeout, there's a high probability that ADB is non-responsive. In these
+    # cases, sending an ADB command will potentially take a long time to time
+    # out. Before this happens, the process will be hard-killed for not
+    # responding to SIGTERM fast enough.
+    if self._received_sigterm:
+      return
+
     if not self._devices:
       return
 

build/android/pylib/local/device/local_device_gtest_run.py

@@ -603,6 +603,14 @@ class LocalDeviceGtestRun(local_device_test_run.LocalDeviceTestRun):
 
   #override
   def TearDown(self):
+    # By default, teardown will invoke ADB. When receiving SIGTERM due to a
+    # timeout, there's a high probability that ADB is non-responsive. In these
+    # cases, sending an ADB command will potentially take a long time to time
+    # out. Before this happens, the process will be hard-killed for not
+    # responding to SIGTERM fast enough.
+    if self._received_sigterm:
+      return
+
     @local_device_environment.handle_shard_failures
     @trace_event.traced
     def individual_device_tear_down(dev):

build/android/pylib/local/device/local_device_instrumentation_test_run.py

@@ -305,6 +305,14 @@ class LocalDeviceInstrumentationTestRun(
 
   #override
   def TearDown(self):
+    # By default, teardown will invoke ADB. When receiving SIGTERM due to a
+    # timeout, there's a high probability that ADB is non-responsive. In these
+    # cases, sending an ADB command will potentially take a long time to time
+    # out. Before this happens, the process will be hard-killed for not
+    # responding to SIGTERM fast enough.
+    if self._received_sigterm:
+      return
+
     @local_device_environment.handle_shard_failures_with(
         self._env.BlacklistDevice)
     @trace_event.traced

build/android/test_runner.py

@@ -742,6 +742,7 @@ def RunTestsInPlatformMode(args):
 
   ### Set up sigterm handler.
 
+  contexts_to_notify_on_sigterm = []
   def unexpected_sigterm(_signum, _frame):
     msg = [
       'Received SIGTERM. Shutting down.',
@@ -755,6 +756,9 @@ def RunTestsInPlatformMode(args):
             live_thread.name, live_thread.ident),
         thread_stack])
 
+    for context in contexts_to_notify_on_sigterm:
+      context.ReceivedSigterm()
+
     infra_error('\n'.join(msg))
 
   signal.signal(signal.SIGTERM, unexpected_sigterm)
@@ -834,6 +838,9 @@ def RunTestsInPlatformMode(args):
   test_run = test_run_factory.CreateTestRun(
       args, env, test_instance, infra_error)
 
+  contexts_to_notify_on_sigterm.append(env)
+  contexts_to_notify_on_sigterm.append(test_run)
+
   ### Run.
   with out_manager, json_finalizer():
     with json_writer(), logcats_uploader, env, test_instance, test_run: