9278d96e77
The install escaping test fails if the device supports exit codes. This fixes the test to ignore the exit code since we expect the install to fail. Change-Id: I37bb39552a6e9068ac088a25d831f45d81b28155
563 lines
20 KiB
Python
563 lines
20 KiB
Python
#!/usr/bin/env python
|
|
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright (C) 2015 The Android Open Source Project
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
from __future__ import print_function
|
|
|
|
import hashlib
|
|
import os
|
|
import posixpath
|
|
import random
|
|
import shlex
|
|
import shutil
|
|
import signal
|
|
import subprocess
|
|
import tempfile
|
|
import unittest
|
|
|
|
import mock
|
|
|
|
import adb
|
|
|
|
|
|
def requires_root(func):
|
|
def wrapper(self, *args):
|
|
if self.device.get_prop('ro.debuggable') != '1':
|
|
raise unittest.SkipTest('requires rootable build')
|
|
|
|
was_root = self.device.shell(['id', '-un'])[0].strip() == 'root'
|
|
if not was_root:
|
|
self.device.root()
|
|
self.device.wait()
|
|
|
|
try:
|
|
func(self, *args)
|
|
finally:
|
|
if not was_root:
|
|
self.device.unroot()
|
|
self.device.wait()
|
|
|
|
return wrapper
|
|
|
|
|
|
class GetDeviceTest(unittest.TestCase):
|
|
def setUp(self):
|
|
self.android_serial = os.getenv('ANDROID_SERIAL')
|
|
if 'ANDROID_SERIAL' in os.environ:
|
|
del os.environ['ANDROID_SERIAL']
|
|
|
|
def tearDown(self):
|
|
if self.android_serial is not None:
|
|
os.environ['ANDROID_SERIAL'] = self.android_serial
|
|
else:
|
|
if 'ANDROID_SERIAL' in os.environ:
|
|
del os.environ['ANDROID_SERIAL']
|
|
|
|
@mock.patch('adb.device.get_devices')
|
|
def test_explicit(self, mock_get_devices):
|
|
mock_get_devices.return_value = ['foo', 'bar']
|
|
device = adb.get_device('foo')
|
|
self.assertEqual(device.serial, 'foo')
|
|
|
|
@mock.patch('adb.device.get_devices')
|
|
def test_from_env(self, mock_get_devices):
|
|
mock_get_devices.return_value = ['foo', 'bar']
|
|
os.environ['ANDROID_SERIAL'] = 'foo'
|
|
device = adb.get_device()
|
|
self.assertEqual(device.serial, 'foo')
|
|
|
|
@mock.patch('adb.device.get_devices')
|
|
def test_arg_beats_env(self, mock_get_devices):
|
|
mock_get_devices.return_value = ['foo', 'bar']
|
|
os.environ['ANDROID_SERIAL'] = 'bar'
|
|
device = adb.get_device('foo')
|
|
self.assertEqual(device.serial, 'foo')
|
|
|
|
@mock.patch('adb.device.get_devices')
|
|
def test_no_such_device(self, mock_get_devices):
|
|
mock_get_devices.return_value = ['foo', 'bar']
|
|
self.assertRaises(adb.DeviceNotFoundError, adb.get_device, ['baz'])
|
|
|
|
os.environ['ANDROID_SERIAL'] = 'baz'
|
|
self.assertRaises(adb.DeviceNotFoundError, adb.get_device)
|
|
|
|
@mock.patch('adb.device.get_devices')
|
|
def test_unique_device(self, mock_get_devices):
|
|
mock_get_devices.return_value = ['foo']
|
|
device = adb.get_device()
|
|
self.assertEqual(device.serial, 'foo')
|
|
|
|
@mock.patch('adb.device.get_devices')
|
|
def test_no_unique_device(self, mock_get_devices):
|
|
mock_get_devices.return_value = ['foo', 'bar']
|
|
self.assertRaises(adb.NoUniqueDeviceError, adb.get_device)
|
|
|
|
|
|
class DeviceTest(unittest.TestCase):
|
|
def setUp(self):
|
|
self.device = adb.get_device()
|
|
|
|
|
|
class ShellTest(DeviceTest):
|
|
def _interactive_shell(self, shell_args, input):
|
|
"""Runs an interactive adb shell.
|
|
|
|
Args:
|
|
shell_args: List of string arguments to `adb shell`.
|
|
input: String input to send to the interactive shell.
|
|
|
|
Returns:
|
|
The remote exit code.
|
|
|
|
Raises:
|
|
unittest.SkipTest: The device doesn't support exit codes.
|
|
"""
|
|
if self.device.SHELL_PROTOCOL_FEATURE not in self.device.features:
|
|
raise unittest.SkipTest('exit codes are unavailable on this device')
|
|
|
|
proc = subprocess.Popen(
|
|
self.device.adb_cmd + ['shell'] + shell_args,
|
|
stdin=subprocess.PIPE, stdout=subprocess.PIPE,
|
|
stderr=subprocess.PIPE)
|
|
# Closing host-side stdin doesn't currently trigger the interactive
|
|
# shell to exit so we need to explicitly add an exit command to
|
|
# close the session from the device side, and append linesep to complete
|
|
# the interactive command.
|
|
proc.communicate('{}; exit{}'.format(input, self.device.linesep))
|
|
return proc.returncode
|
|
|
|
def test_cat(self):
|
|
"""Check that we can at least cat a file."""
|
|
out = self.device.shell(['cat', '/proc/uptime'])[0].strip()
|
|
elements = out.split()
|
|
self.assertEqual(len(elements), 2)
|
|
|
|
uptime, idle = elements
|
|
self.assertGreater(float(uptime), 0.0)
|
|
self.assertGreater(float(idle), 0.0)
|
|
|
|
def test_throws_on_failure(self):
|
|
self.assertRaises(adb.ShellError, self.device.shell, ['false'])
|
|
|
|
def test_output_not_stripped(self):
|
|
out = self.device.shell(['echo', 'foo'])[0]
|
|
self.assertEqual(out, 'foo' + self.device.linesep)
|
|
|
|
def test_shell_nocheck_failure(self):
|
|
rc, out, _ = self.device.shell_nocheck(['false'])
|
|
self.assertNotEqual(rc, 0)
|
|
self.assertEqual(out, '')
|
|
|
|
def test_shell_nocheck_output_not_stripped(self):
|
|
rc, out, _ = self.device.shell_nocheck(['echo', 'foo'])
|
|
self.assertEqual(rc, 0)
|
|
self.assertEqual(out, 'foo' + self.device.linesep)
|
|
|
|
def test_can_distinguish_tricky_results(self):
|
|
# If result checking on ADB shell is naively implemented as
|
|
# `adb shell <cmd>; echo $?`, we would be unable to distinguish the
|
|
# output from the result for a cmd of `echo -n 1`.
|
|
rc, out, _ = self.device.shell_nocheck(['echo', '-n', '1'])
|
|
self.assertEqual(rc, 0)
|
|
self.assertEqual(out, '1')
|
|
|
|
def test_line_endings(self):
|
|
"""Ensure that line ending translation is not happening in the pty.
|
|
|
|
Bug: http://b/19735063
|
|
"""
|
|
output = self.device.shell(['uname'])[0]
|
|
self.assertEqual(output, 'Linux' + self.device.linesep)
|
|
|
|
def test_default_pty_logic(self):
|
|
"""Verify default PTY logic for shells.
|
|
|
|
Interactive shells should use a PTY, non-interactive should not.
|
|
|
|
Bug: http://b/21215503
|
|
"""
|
|
# [ -t 0 ] is used (rather than `tty`) to provide portability. This
|
|
# gives an exit code of 0 iff stdin is connected to a terminal.
|
|
self.assertEqual(0, self._interactive_shell([], '[ -t 0 ]'))
|
|
self.assertEqual(1, self.device.shell_nocheck(['[ -t 0 ]'])[0])
|
|
|
|
def test_pty_arguments(self):
|
|
"""Tests the -T and -t arguments to manually control PTY."""
|
|
if self.device.SHELL_PROTOCOL_FEATURE not in self.device.features:
|
|
raise unittest.SkipTest('PTY arguments unsupported on this device')
|
|
|
|
self.assertEqual(0, self._interactive_shell(['-t'], '[ -t 0 ]'))
|
|
self.assertEqual(1, self._interactive_shell(['-T'], '[ -t 0 ]'))
|
|
self.assertEqual(0, self.device.shell_nocheck(['-t', '[ -t 0 ]'])[0])
|
|
self.assertEqual(1, self.device.shell_nocheck(['-T', '[ -t 0 ]'])[0])
|
|
|
|
def test_shell_protocol(self):
|
|
"""Tests the shell protocol on the device.
|
|
|
|
If the device supports shell protocol, this gives us the ability
|
|
to separate stdout/stderr and return the exit code directly.
|
|
|
|
Bug: http://b/19734861
|
|
"""
|
|
if self.device.SHELL_PROTOCOL_FEATURE not in self.device.features:
|
|
raise unittest.SkipTest('shell protocol unsupported on this device')
|
|
|
|
result = self.device.shell_nocheck(
|
|
shlex.split('echo foo; echo bar >&2; exit 17'))
|
|
self.assertEqual(17, result[0])
|
|
self.assertEqual('foo' + self.device.linesep, result[1])
|
|
self.assertEqual('bar' + self.device.linesep, result[2])
|
|
|
|
def test_non_interactive_sigint(self):
|
|
"""Tests that SIGINT in a non-interactive shell kills the process.
|
|
|
|
This requires the shell protocol in order to detect the broken
|
|
pipe; raw data transfer mode will only see the break once the
|
|
subprocess tries to read or write.
|
|
|
|
Bug: http://b/23825725
|
|
"""
|
|
if self.device.SHELL_PROTOCOL_FEATURE not in self.device.features:
|
|
raise unittest.SkipTest('shell protocol unsupported on this device')
|
|
|
|
# Start a long-running process.
|
|
sleep_proc = subprocess.Popen(
|
|
self.device.adb_cmd + shlex.split('shell echo $$; sleep 60'),
|
|
stdin=subprocess.PIPE, stdout=subprocess.PIPE,
|
|
stderr=subprocess.STDOUT)
|
|
remote_pid = sleep_proc.stdout.readline().strip()
|
|
self.assertIsNone(sleep_proc.returncode, 'subprocess terminated early')
|
|
proc_query = shlex.split('ps {0} | grep {0}'.format(remote_pid))
|
|
|
|
# Verify that the process is running, send signal, verify it stopped.
|
|
self.device.shell(proc_query)
|
|
os.kill(sleep_proc.pid, signal.SIGINT)
|
|
sleep_proc.communicate()
|
|
self.assertEqual(1, self.device.shell_nocheck(proc_query)[0],
|
|
'subprocess failed to terminate')
|
|
|
|
|
|
class ArgumentEscapingTest(DeviceTest):
|
|
def test_shell_escaping(self):
|
|
"""Make sure that argument escaping is somewhat sane."""
|
|
|
|
# http://b/19734868
|
|
# Note that this actually matches ssh(1)'s behavior --- it's
|
|
# converted to `sh -c echo hello; echo world` which sh interprets
|
|
# as `sh -c echo` (with an argument to that shell of "hello"),
|
|
# and then `echo world` back in the first shell.
|
|
result = self.device.shell(
|
|
shlex.split("sh -c 'echo hello; echo world'"))[0]
|
|
result = result.splitlines()
|
|
self.assertEqual(['', 'world'], result)
|
|
# If you really wanted "hello" and "world", here's what you'd do:
|
|
result = self.device.shell(
|
|
shlex.split(r'echo hello\;echo world'))[0].splitlines()
|
|
self.assertEqual(['hello', 'world'], result)
|
|
|
|
# http://b/15479704
|
|
result = self.device.shell(shlex.split("'true && echo t'"))[0].strip()
|
|
self.assertEqual('t', result)
|
|
result = self.device.shell(
|
|
shlex.split("sh -c 'true && echo t'"))[0].strip()
|
|
self.assertEqual('t', result)
|
|
|
|
# http://b/20564385
|
|
result = self.device.shell(shlex.split('FOO=a BAR=b echo t'))[0].strip()
|
|
self.assertEqual('t', result)
|
|
result = self.device.shell(
|
|
shlex.split(r'echo -n 123\;uname'))[0].strip()
|
|
self.assertEqual('123Linux', result)
|
|
|
|
def test_install_argument_escaping(self):
|
|
"""Make sure that install argument escaping works."""
|
|
# http://b/20323053, http://b/3090932.
|
|
for file_suffix in ('-text;ls;1.apk', "-Live Hold'em.apk"):
|
|
tf = tempfile.NamedTemporaryFile('wb', suffix=file_suffix,
|
|
delete=False)
|
|
tf.close()
|
|
|
|
# Installing bogus .apks fails if the device supports exit codes.
|
|
try:
|
|
output = self.device.install(tf.name)
|
|
except subprocess.CalledProcessError as e:
|
|
output = e.output
|
|
|
|
self.assertIn(file_suffix, output)
|
|
os.remove(tf.name)
|
|
|
|
|
|
class RootUnrootTest(DeviceTest):
|
|
def _test_root(self):
|
|
message = self.device.root()
|
|
if 'adbd cannot run as root in production builds' in message:
|
|
return
|
|
self.device.wait()
|
|
self.assertEqual('root', self.device.shell(['id', '-un'])[0].strip())
|
|
|
|
def _test_unroot(self):
|
|
self.device.unroot()
|
|
self.device.wait()
|
|
self.assertEqual('shell', self.device.shell(['id', '-un'])[0].strip())
|
|
|
|
def test_root_unroot(self):
|
|
"""Make sure that adb root and adb unroot work, using id(1)."""
|
|
if self.device.get_prop('ro.debuggable') != '1':
|
|
raise unittest.SkipTest('requires rootable build')
|
|
|
|
original_user = self.device.shell(['id', '-un'])[0].strip()
|
|
try:
|
|
if original_user == 'root':
|
|
self._test_unroot()
|
|
self._test_root()
|
|
elif original_user == 'shell':
|
|
self._test_root()
|
|
self._test_unroot()
|
|
finally:
|
|
if original_user == 'root':
|
|
self.device.root()
|
|
else:
|
|
self.device.unroot()
|
|
self.device.wait()
|
|
|
|
|
|
class TcpIpTest(DeviceTest):
|
|
def test_tcpip_failure_raises(self):
|
|
"""adb tcpip requires a port.
|
|
|
|
Bug: http://b/22636927
|
|
"""
|
|
self.assertRaises(
|
|
subprocess.CalledProcessError, self.device.tcpip, '')
|
|
self.assertRaises(
|
|
subprocess.CalledProcessError, self.device.tcpip, 'foo')
|
|
|
|
|
|
class SystemPropertiesTest(DeviceTest):
|
|
def test_get_prop(self):
|
|
self.assertEqual(self.device.get_prop('init.svc.adbd'), 'running')
|
|
|
|
@requires_root
|
|
def test_set_prop(self):
|
|
prop_name = 'foo.bar'
|
|
self.device.shell(['setprop', prop_name, '""'])
|
|
|
|
self.device.set_prop(prop_name, 'qux')
|
|
self.assertEqual(
|
|
self.device.shell(['getprop', prop_name])[0].strip(), 'qux')
|
|
|
|
|
|
def compute_md5(string):
|
|
hsh = hashlib.md5()
|
|
hsh.update(string)
|
|
return hsh.hexdigest()
|
|
|
|
|
|
def get_md5_prog(device):
|
|
"""Older platforms (pre-L) had the name md5 rather than md5sum."""
|
|
try:
|
|
device.shell(['md5sum', '/proc/uptime'])
|
|
return 'md5sum'
|
|
except subprocess.CalledProcessError:
|
|
return 'md5'
|
|
|
|
|
|
class HostFile(object):
|
|
def __init__(self, handle, checksum):
|
|
self.handle = handle
|
|
self.checksum = checksum
|
|
self.full_path = handle.name
|
|
self.base_name = os.path.basename(self.full_path)
|
|
|
|
|
|
class DeviceFile(object):
|
|
def __init__(self, checksum, full_path):
|
|
self.checksum = checksum
|
|
self.full_path = full_path
|
|
self.base_name = posixpath.basename(self.full_path)
|
|
|
|
|
|
def make_random_host_files(in_dir, num_files):
|
|
min_size = 1 * (1 << 10)
|
|
max_size = 16 * (1 << 10)
|
|
|
|
files = []
|
|
for _ in xrange(num_files):
|
|
file_handle = tempfile.NamedTemporaryFile(dir=in_dir, delete=False)
|
|
|
|
size = random.randrange(min_size, max_size, 1024)
|
|
rand_str = os.urandom(size)
|
|
file_handle.write(rand_str)
|
|
file_handle.flush()
|
|
file_handle.close()
|
|
|
|
md5 = compute_md5(rand_str)
|
|
files.append(HostFile(file_handle, md5))
|
|
return files
|
|
|
|
|
|
def make_random_device_files(device, in_dir, num_files):
|
|
min_size = 1 * (1 << 10)
|
|
max_size = 16 * (1 << 10)
|
|
|
|
files = []
|
|
for file_num in xrange(num_files):
|
|
size = random.randrange(min_size, max_size, 1024)
|
|
|
|
base_name = 'device_tmpfile' + str(file_num)
|
|
full_path = posixpath.join(in_dir, base_name)
|
|
|
|
device.shell(['dd', 'if=/dev/urandom', 'of={}'.format(full_path),
|
|
'bs={}'.format(size), 'count=1'])
|
|
dev_md5, _ = device.shell([get_md5_prog(device), full_path])[0].split()
|
|
|
|
files.append(DeviceFile(dev_md5, full_path))
|
|
return files
|
|
|
|
|
|
class FileOperationsTest(DeviceTest):
|
|
SCRATCH_DIR = '/data/local/tmp'
|
|
DEVICE_TEMP_FILE = SCRATCH_DIR + '/adb_test_file'
|
|
DEVICE_TEMP_DIR = SCRATCH_DIR + '/adb_test_dir'
|
|
|
|
def _test_push(self, local_file, checksum):
|
|
self.device.shell(['rm', '-rf', self.DEVICE_TEMP_FILE])
|
|
self.device.push(local=local_file, remote=self.DEVICE_TEMP_FILE)
|
|
dev_md5, _ = self.device.shell([get_md5_prog(self.device),
|
|
self.DEVICE_TEMP_FILE])[0].split()
|
|
self.assertEqual(checksum, dev_md5)
|
|
self.device.shell(['rm', '-f', self.DEVICE_TEMP_FILE])
|
|
|
|
def test_push(self):
|
|
"""Push a randomly generated file to specified device."""
|
|
kbytes = 512
|
|
tmp = tempfile.NamedTemporaryFile(mode='wb', delete=False)
|
|
rand_str = os.urandom(1024 * kbytes)
|
|
tmp.write(rand_str)
|
|
tmp.close()
|
|
self._test_push(tmp.name, compute_md5(rand_str))
|
|
os.remove(tmp.name)
|
|
|
|
# TODO: write push directory test.
|
|
|
|
def _test_pull(self, remote_file, checksum):
|
|
tmp_write = tempfile.NamedTemporaryFile(mode='wb', delete=False)
|
|
tmp_write.close()
|
|
self.device.pull(remote=remote_file, local=tmp_write.name)
|
|
with open(tmp_write.name, 'rb') as tmp_read:
|
|
host_contents = tmp_read.read()
|
|
host_md5 = compute_md5(host_contents)
|
|
self.assertEqual(checksum, host_md5)
|
|
os.remove(tmp_write.name)
|
|
|
|
def test_pull(self):
|
|
"""Pull a randomly generated file from specified device."""
|
|
kbytes = 512
|
|
self.device.shell(['rm', '-rf', self.DEVICE_TEMP_FILE])
|
|
cmd = ['dd', 'if=/dev/urandom',
|
|
'of={}'.format(self.DEVICE_TEMP_FILE), 'bs=1024',
|
|
'count={}'.format(kbytes)]
|
|
self.device.shell(cmd)
|
|
dev_md5, _ = self.device.shell(
|
|
[get_md5_prog(self.device), self.DEVICE_TEMP_FILE])[0].split()
|
|
self._test_pull(self.DEVICE_TEMP_FILE, dev_md5)
|
|
self.device.shell_nocheck(['rm', self.DEVICE_TEMP_FILE])
|
|
|
|
def test_pull_dir(self):
|
|
"""Pull a randomly generated directory of files from the device."""
|
|
host_dir = tempfile.mkdtemp()
|
|
self.device.shell(['rm', '-rf', self.DEVICE_TEMP_DIR])
|
|
self.device.shell(['mkdir', '-p', self.DEVICE_TEMP_DIR])
|
|
|
|
# Populate device directory with random files.
|
|
temp_files = make_random_device_files(
|
|
self.device, in_dir=self.DEVICE_TEMP_DIR, num_files=32)
|
|
|
|
self.device.pull(remote=self.DEVICE_TEMP_DIR, local=host_dir)
|
|
|
|
for temp_file in temp_files:
|
|
host_path = os.path.join(host_dir, temp_file.base_name)
|
|
with open(host_path, 'rb') as host_file:
|
|
host_md5 = compute_md5(host_file.read())
|
|
self.assertEqual(host_md5, temp_file.checksum)
|
|
|
|
self.device.shell(['rm', '-rf', self.DEVICE_TEMP_DIR])
|
|
if host_dir is not None:
|
|
shutil.rmtree(host_dir)
|
|
|
|
def test_sync(self):
|
|
"""Sync a randomly generated directory of files to specified device."""
|
|
base_dir = tempfile.mkdtemp()
|
|
|
|
# Create mirror device directory hierarchy within base_dir.
|
|
full_dir_path = base_dir + self.DEVICE_TEMP_DIR
|
|
os.makedirs(full_dir_path)
|
|
|
|
# Create 32 random files within the host mirror.
|
|
temp_files = make_random_host_files(in_dir=full_dir_path, num_files=32)
|
|
|
|
# Clean up any trash on the device.
|
|
device = adb.get_device(product=base_dir)
|
|
device.shell(['rm', '-rf', self.DEVICE_TEMP_DIR])
|
|
|
|
device.sync('data')
|
|
|
|
# Confirm that every file on the device mirrors that on the host.
|
|
for temp_file in temp_files:
|
|
device_full_path = posixpath.join(self.DEVICE_TEMP_DIR,
|
|
temp_file.base_name)
|
|
dev_md5, _ = device.shell(
|
|
[get_md5_prog(self.device), device_full_path])[0].split()
|
|
self.assertEqual(temp_file.checksum, dev_md5)
|
|
|
|
self.device.shell(['rm', '-rf', self.DEVICE_TEMP_DIR])
|
|
if base_dir is not None:
|
|
shutil.rmtree(base_dir)
|
|
|
|
def test_unicode_paths(self):
|
|
"""Ensure that we can support non-ASCII paths, even on Windows."""
|
|
name = u'로보카 폴리'
|
|
|
|
## push.
|
|
tf = tempfile.NamedTemporaryFile('wb', suffix=name, delete=False)
|
|
tf.close()
|
|
self.device.push(tf.name, u'/data/local/tmp/adb-test-{}'.format(name))
|
|
os.remove(tf.name)
|
|
self.device.shell(['rm', '-f', '/data/local/tmp/adb-test-*'])
|
|
|
|
# pull.
|
|
cmd = ['touch', u'"/data/local/tmp/adb-test-{}"'.format(name)]
|
|
self.device.shell(cmd)
|
|
|
|
tf = tempfile.NamedTemporaryFile('wb', suffix=name, delete=False)
|
|
tf.close()
|
|
self.device.pull(u'/data/local/tmp/adb-test-{}'.format(name), tf.name)
|
|
os.remove(tf.name)
|
|
self.device.shell(['rm', '-f', '/data/local/tmp/adb-test-*'])
|
|
|
|
|
|
def main():
|
|
random.seed(0)
|
|
if len(adb.get_devices()) > 0:
|
|
suite = unittest.TestLoader().loadTestsFromName(__name__)
|
|
unittest.TextTestRunner(verbosity=3).run(suite)
|
|
else:
|
|
print('Test suite must be run with attached devices')
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|