android_skp_capture Namespace Reference

Classes
class	App
class	DragAction
class	PressAction

Functions
	parse_action (action_dict)
	check_output (cmd)
	adb_shell (cmd)
	remote_file_exists (filename)
	capture_skp (skp_file, package, device)
	load_app (filename)
	main ()

Variables
int	WAIT_FOR_SKP_CAPTURE = 1

Function Documentation

adb_shell()

android_skp_capture.adb_shell

(

cmd

)

Run the given ADB shell command and emulate the exit code.

Definition at line 90 of file android_skp_capture.py.

def adb_shell(cmd):
  """Run the given ADB shell command and emulate the exit code."""
  output = check_output(['adb', 'shell', cmd + '; echo $?']).strip()
  lines = output.splitlines()
  if lines[-1] != '0':
    raise Exception('ADB command failed: %s\n\nOutput:\n%s' % (cmd, output))
  return '\n'.join(lines[:-1])
 
 

capture_skp()

android_skp_capture.capture_skp	(		skp_file,
			package,
			device
	)

Capture an SKP.

Definition at line 108 of file android_skp_capture.py.

def capture_skp(skp_file, package, device):
  """Capture an SKP."""
  remote_path = '/data/data/%s/cache/%s' % (package, os.path.basename(skp_file))
  try:
    adb_shell('rm %s' % remote_path)
  except Exception:
    if remote_file_exists(remote_path):
      raise
 
  adb_shell('setprop debug.hwui.capture_frame_as_skp %s' % remote_path)
  try:
    # Spin, wait for the SKP to be written.
    timeout = 10  # Seconds
    start = time.time()
    device.drag((300, 300), (300, 350), 1, 10)  # Arbitrary action to force a draw.
    while not remote_file_exists(remote_path):
      if time.time() - start > timeout:
        raise Exception('Timed out waiting for SKP capture.')
      time.sleep(1)
 
    # Pull the SKP from the device.
    cmd = ['adb', 'pull', remote_path, skp_file]
    check_output(cmd)
 
  finally:
    adb_shell('setprop debug.hwui.capture_frame_as_skp ""')
 
 

check_output()

android_skp_capture.check_output

(

cmd

)

Convenience implementation of subprocess.check_output.

Definition at line 82 of file android_skp_capture.py.

def check_output(cmd):
  """Convenience implementation of subprocess.check_output."""
  proc = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
  if proc.wait() != 0:
    raise Exception('Command failed: %s' % ' '.join(cmd))
  return proc.communicate()[0]
 
 

load_app()

android_skp_capture.load_app

(

filename

)

Load the JSON file describing an app and return an App instance.

Definition at line 136 of file android_skp_capture.py.

def load_app(filename):
  """Load the JSON file describing an app and return an App instance."""
  with open(filename) as f:
    app_dict = ast.literal_eval(f.read())
  return App(app_dict['name'],
             app_dict['package'],
             app_dict['activity'],
             app_dict['app_launch_delay'],
             app_dict['actions'])
 
 

main()

android_skp_capture.main

(

)

Capture SKPs for all apps.

Definition at line 147 of file android_skp_capture.py.

def main():
  """Capture SKPs for all apps."""
  device = MonkeyRunner.waitForConnection()
 
  # TODO(borenet): Kill all apps.
  device.wake()
  device.drag((600, 600), (10, 10), 0.2, 10)
 
  apps_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'apps')
  app_files = [os.path.join(apps_dir, app) for app in os.listdir(apps_dir)]
 
  for app_file in app_files:
    app = load_app(app_file)
    print(app.name)
    print('  Package %s' % app.package)
    app.launch(device)
    print('  Launched activity %s' % app.activity)
 
    for action in app.actions:
      print('  %s' % action.__class__.__name__)
      action.run(device)
 
    time.sleep(WAIT_FOR_SKP_CAPTURE)
    print('  Capturing SKP.')
    skp_file = '%s.skp' % app.name
    capture_skp(skp_file, app.package, device)
    print('  Wrote SKP to %s' % skp_file)
    print
    app.kill()
 
 

parse_action()

android_skp_capture.parse_action

(

action_dict

)

Parse a dict describing an action and return an Action object.

Definition at line 49 of file android_skp_capture.py.

def parse_action(action_dict):
  """Parse a dict describing an action and return an Action object."""
  if action_dict['type'] == 'drag':
    return DragAction(tuple(action_dict['start']),
                      tuple(action_dict['end']),
                      action_dict['duration'],
                      action_dict['points'])
  elif action_dict['type'] == 'press':
    return PressAction(action_dict['button'], action_dict['press_type'])
  else:
    raise TypeError('Unsupported action type: %s' % action_dict['type'])
 
 

remote_file_exists()

android_skp_capture.remote_file_exists

(

filename

)

Return True if the given file exists on the device and False otherwise.

Definition at line 99 of file android_skp_capture.py.

def remote_file_exists(filename):
  """Return True if the given file exists on the device and False otherwise."""
  try:
    adb_shell('test -f %s' % filename)
    return True
  except Exception:
    return False
 
 

Variable Documentation

WAIT_FOR_SKP_CAPTURE

int android_skp_capture.WAIT_FOR_SKP_CAPTURE = 1

Definition at line 22 of file android_skp_capture.py.