[pylib/devil] Create devil.android.base_tool and derive valgrind_tools classes from it

build/android/pylib/valgrind_tools.py

 # Copyright (c) 2012 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.
 
-"""
-Classes in this file define additional actions that need to be taken to run a
-test under some kind of runtime error detection tool.
-
-The interface is intended to be used as follows.
-
-1. For tests that simply run a native process (i.e. no activity is spawned):
-
-Call tool.CopyFiles(device).
-Prepend test command line with tool.GetTestWrapper().
-
-2. For tests that spawn an activity:
-
-Call tool.CopyFiles(device).
-Call tool.SetupEnvironment().
-Run the test as usual.
-Call tool.CleanUpEnvironment().
-"""
 # pylint: disable=R0201
 
 import glob
 import logging
 import os.path
 import subprocess
 import sys
 
 from devil.android import device_errors
+from devil.android.valgrind_tools import base_tool
 from pylib.constants import DIR_SOURCE_ROOT
 
 
 def SetChromeTimeoutScale(device, scale):
   """Sets the timeout scale in /data/local/tmp/chrome_timeout_scale to scale."""
   path = '/data/local/tmp/chrome_timeout_scale'
   if not scale or scale == 1.0:
     # Delete if scale is None/0.0/1.0 since the default timeout scale is 1.0
     device.RunShellCommand('rm %s' % path)
   else:
     device.WriteFile(path, '%f' % scale, as_root=True)
 
 
-class BaseTool(object):
-  """A tool that does nothing."""
 
-  def __init__(self):
-    """Does nothing."""
-    pass
-
-  def GetTestWrapper(self):
-    """Returns a string that is to be prepended to the test command line."""
-    return ''
-
-  def GetUtilWrapper(self):
-    """Returns the wrapper name for the utilities.
-
-    Returns:
-       A string that is to be prepended to the command line of utility
-    processes (forwarder, etc.).
-    """
-    return ''
-
-  @classmethod
-  def CopyFiles(cls, device):
-    """Copies tool-specific files to the device, create directories, etc."""
-    pass
-
-  def SetupEnvironment(self):
-    """Sets up the system environment for a test.
-
-    This is a good place to set system properties.
-    """
-    pass
-
-  def CleanUpEnvironment(self):
-    """Cleans up environment."""
-    pass
-
-  def GetTimeoutScale(self):
-    """Returns a multiplier that should be applied to timeout values."""
-    return 1.0
-
-  def NeedsDebugInfo(self):
-    """Whether this tool requires debug info.
-
-    Returns:
-      True if this tool can not work with stripped binaries.
-    """
-    return False
-
-
-class AddressSanitizerTool(BaseTool):
+class AddressSanitizerTool(base_tool.BaseTool):
   """AddressSanitizer tool."""
 
   WRAPPER_NAME = '/system/bin/asanwrapper'
   # Disable memcmp overlap check.There are blobs (gl drivers)
   # on some android devices that use memcmp on overlapping regions,
   # nothing we can do about that.
   EXTRA_OPTIONS = 'strict_memcmp=0,use_sigaltstack=1'
 
   def __init__(self, device):
     super(AddressSanitizerTool, self).__init__()
@@ skipping 38 matching lines @@
     SetChromeTimeoutScale(self._device, self.GetTimeoutScale())
 
   def CleanUpEnvironment(self):
     SetChromeTimeoutScale(self._device, None)
 
   def GetTimeoutScale(self):
     # Very slow startup.
     return 20.0
 
 
-class ValgrindTool(BaseTool):
+class ValgrindTool(base_tool.BaseTool):
   """Base abstract class for Valgrind tools."""
 
   VG_DIR = '/data/local/tmp/valgrind'
   VGLOGS_DIR = '/data/local/tmp/vglogs'
 
   def __init__(self, device):
     super(ValgrindTool, self).__init__()
     self._device = device
     # exactly 31 chars, SystemProperties::PROP_NAME_MAX
     self._wrap_properties = ['wrap.com.google.android.apps.ch',
@@ skipping 99 matching lines @@
 def CreateTool(tool_name, device):
   """Creates a tool with the specified tool name.
 
   Args:
     tool_name: Name of the tool to create.
     device: A DeviceUtils instance.
   Returns:
     A tool for the specified tool_name.
   """
   if not tool_name:
-    return BaseTool()
+    return base_tool.BaseTool()
 
   ctor = TOOL_REGISTRY.get(tool_name)
   if ctor:
     return ctor(device)
   else:
     print 'Unknown tool %s, available tools: %s' % (
         tool_name, ', '.join(sorted(TOOL_REGISTRY.keys())))
     sys.exit(1)
 
 def PushFilesForTool(tool_name, device):
   """Pushes the files required for |tool_name| to |device|.
 
   Args:
     tool_name: Name of the tool to create.
     device: A DeviceUtils instance.
   """
   if not tool_name:
     return
 
   clazz = TOOL_REGISTRY.get(tool_name)
   if clazz:
     clazz.CopyFiles(device)
   else:
     print 'Unknown tool %s, available tools: %s' % (
         tool_name, ', '.join(sorted(TOOL_REGISTRY.keys())))
     sys.exit(1)